src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utxferror.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: utxferror - Various error/warning output functions
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #define __UTXFERROR_C__
 117 #define EXPORT_ACPI_INTERFACES
 118
 119 #include "acpi.h"
 120 #include "accommon.h"
 121
 122
 123 #define _COMPONENT          ACPI_UTILITIES
 124         ACPI_MODULE_NAME    ("utxferror")
 125
 126 /*
 127  * This module is used for the in-kernel ACPICA as well as the ACPICA
 128  * tools/applications.
 129  */
 130
 131 #ifndef ACPI_NO_ERROR_MESSAGES /* Entire module */
 132
 133 /*******************************************************************************
 134  *
 135  * FUNCTION:    AcpiError
 136  *
 137  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 138  *              LineNumber          - Caller's line number (for error output)
 139  *              Format              - Printf format string + additional args
 140  *
 141  * RETURN:      None
 142  *
 143  * DESCRIPTION: Print "ACPI Error" message with module/line/version info
 144  *
 145  ******************************************************************************/
 146
 147 void ACPI_INTERNAL_VAR_XFACE
 148 AcpiError (
 149     const char              *ModuleName,
 150     UINT32                  LineNumber,
 151     const char              *Format,
 152     ...)
 153 {
 154     va_list                 ArgList;
 155
 156
 157     ACPI_MSG_REDIRECT_BEGIN;
 158     AcpiOsPrintf (ACPI_MSG_ERROR);
 159
 160     va_start (ArgList, Format);
 161     AcpiOsVprintf (Format, ArgList);
 162     ACPI_MSG_SUFFIX;
 163     va_end (ArgList);
 164
 165     ACPI_MSG_REDIRECT_END;
 166 }
 167
 168 ACPI_EXPORT_SYMBOL (AcpiError)
 169
 170
 171 /*******************************************************************************
 172  *
 173  * FUNCTION:    AcpiException
 174  *
 175  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 176  *              LineNumber          - Caller's line number (for error output)
 177  *              Status              - Status to be formatted
 178  *              Format              - Printf format string + additional args
 179  *
 180  * RETURN:      None
 181  *
 182  * DESCRIPTION: Print "ACPI Exception" message with module/line/version info
 183  *              and decoded ACPI_STATUS.
 184  *
 185  ******************************************************************************/
 186
 187 void ACPI_INTERNAL_VAR_XFACE
 188 AcpiException (
 189     const char              *ModuleName,
 190     UINT32                  LineNumber,
 191     ACPI_STATUS             Status,
 192     const char              *Format,
 193     ...)
 194 {
 195     va_list                 ArgList;
 196
 197
 198     ACPI_MSG_REDIRECT_BEGIN;
 199     AcpiOsPrintf (ACPI_MSG_EXCEPTION "%s, ", AcpiFormatException (Status));
 200
 201     va_start (ArgList, Format);
 202     AcpiOsVprintf (Format, ArgList);
 203     ACPI_MSG_SUFFIX;
 204     va_end (ArgList);
 205
 206     ACPI_MSG_REDIRECT_END;
 207 }
 208
 209 ACPI_EXPORT_SYMBOL (AcpiException)
 210
 211
 212 /*******************************************************************************
 213  *
 214  * FUNCTION:    AcpiWarning
 215  *
 216  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 217  *              LineNumber          - Caller's line number (for error output)
 218  *              Format              - Printf format string + additional args
 219  *
 220  * RETURN:      None
 221  *
 222  * DESCRIPTION: Print "ACPI Warning" message with module/line/version info
 223  *
 224  ******************************************************************************/
 225
 226 void ACPI_INTERNAL_VAR_XFACE
 227 AcpiWarning (
 228     const char              *ModuleName,
 229     UINT32                  LineNumber,
 230     const char              *Format,
 231     ...)
 232 {
 233     va_list                 ArgList;
 234
 235
 236     ACPI_MSG_REDIRECT_BEGIN;
 237     AcpiOsPrintf (ACPI_MSG_WARNING);
 238
 239     va_start (ArgList, Format);
 240     AcpiOsVprintf (Format, ArgList);
 241     ACPI_MSG_SUFFIX;
 242     va_end (ArgList);
 243
 244     ACPI_MSG_REDIRECT_END;
 245 }
 246
 247 ACPI_EXPORT_SYMBOL (AcpiWarning)
 248
 249
 250 /*******************************************************************************
 251  *
 252  * FUNCTION:    AcpiInfo
 253  *
 254  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 255  *              LineNumber          - Caller's line number (for error output)
 256  *              Format              - Printf format string + additional args
 257  *
 258  * RETURN:      None
 259  *
 260  * DESCRIPTION: Print generic "ACPI:" information message. There is no
 261  *              module/line/version info in order to keep the message simple.
 262  *
 263  * TBD: ModuleName and LineNumber args are not needed, should be removed.
 264  *
 265  ******************************************************************************/
 266
 267 void ACPI_INTERNAL_VAR_XFACE
 268 AcpiInfo (
 269     const char              *ModuleName,
 270     UINT32                  LineNumber,
 271     const char              *Format,
 272     ...)
 273 {
 274     va_list                 ArgList;
 275
 276
 277     ACPI_MSG_REDIRECT_BEGIN;
 278     AcpiOsPrintf (ACPI_MSG_INFO);
 279
 280     va_start (ArgList, Format);
 281     AcpiOsVprintf (Format, ArgList);
 282     AcpiOsPrintf ("\n");
 283     va_end (ArgList);
 284
 285     ACPI_MSG_REDIRECT_END;
 286 }
 287
 288 ACPI_EXPORT_SYMBOL (AcpiInfo)
 289
 290
 291 /*******************************************************************************
 292  *
 293  * FUNCTION:    AcpiBiosError
 294  *
 295  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 296  *              LineNumber          - Caller's line number (for error output)
 297  *              Format              - Printf format string + additional args
 298  *
 299  * RETURN:      None
 300  *
 301  * DESCRIPTION: Print "ACPI Firmware Error" message with module/line/version
 302  *              info
 303  *
 304  ******************************************************************************/
 305
 306 void ACPI_INTERNAL_VAR_XFACE
 307 AcpiBiosError (
 308     const char              *ModuleName,
 309     UINT32                  LineNumber,
 310     const char              *Format,
 311     ...)
 312 {
 313     va_list                 ArgList;
 314
 315
 316     ACPI_MSG_REDIRECT_BEGIN;
 317     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
 318
 319     va_start (ArgList, Format);
 320     AcpiOsVprintf (Format, ArgList);
 321     ACPI_MSG_SUFFIX;
 322     va_end (ArgList);
 323
 324     ACPI_MSG_REDIRECT_END;
 325 }
 326
 327 ACPI_EXPORT_SYMBOL (AcpiBiosError)
 328
 329
 330 /*******************************************************************************
 331  *
 332  * FUNCTION:    AcpiBiosWarning
 333  *
 334  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 335  *              LineNumber          - Caller's line number (for error output)
 336  *              Format              - Printf format string + additional args
 337  *
 338  * RETURN:      None
 339  *
 340  * DESCRIPTION: Print "ACPI Firmware Warning" message with module/line/version
 341  *              info
 342  *
 343  ******************************************************************************/
 344
 345 void ACPI_INTERNAL_VAR_XFACE
 346 AcpiBiosWarning (
 347     const char              *ModuleName,
 348     UINT32                  LineNumber,
 349     const char              *Format,
 350     ...)
 351 {
 352     va_list                 ArgList;
 353
 354
 355     ACPI_MSG_REDIRECT_BEGIN;
 356     AcpiOsPrintf (ACPI_MSG_BIOS_WARNING);
 357
 358     va_start (ArgList, Format);
 359     AcpiOsVprintf (Format, ArgList);
 360     ACPI_MSG_SUFFIX;
 361     va_end (ArgList);
 362
 363     ACPI_MSG_REDIRECT_END;
 364 }
 365
 366 ACPI_EXPORT_SYMBOL (AcpiBiosWarning)
 367
 368 #endif /* ACPI_NO_ERROR_MESSAGES */