drivers/acpi/components/utilities/uterror.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: uterror - Various internal error/warning output functions
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, 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 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acnamesp.h"
 119
 120
 121 #define _COMPONENT          ACPI_UTILITIES
 122         ACPI_MODULE_NAME    ("uterror")
 123
 124
 125 /*
 126  * This module contains internal error functions that may
 127  * be configured out.
 128  */
 129 #if !defined (ACPI_NO_ERROR_MESSAGES)
 130
 131 /*******************************************************************************
 132  *
 133  * FUNCTION:    AcpiUtPredefinedWarning
 134  *
 135  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
 136  *              LineNumber      - Caller's line number (for error output)
 137  *              Pathname        - Full pathname to the node
 138  *              NodeFlags       - From Namespace node for the method/object
 139  *              Format          - Printf format string + additional args
 140  *
 141  * RETURN:      None
 142  *
 143  * DESCRIPTION: Warnings for the predefined validation module. Messages are
 144  *              only emitted the first time a problem with a particular
 145  *              method/object is detected. This prevents a flood of error
 146  *              messages for methods that are repeatedly evaluated.
 147  *
 148  ******************************************************************************/
 149
 150 void ACPI_INTERNAL_VAR_XFACE
 151 AcpiUtPredefinedWarning (
 152     const char              *ModuleName,
 153     UINT32                  LineNumber,
 154     char                    *Pathname,
 155     UINT8                   NodeFlags,
 156     const char              *Format,
 157     ...)
 158 {
 159     va_list                 ArgList;
 160
 161
 162     /*
 163      * Warning messages for this method/object will be disabled after the
 164      * first time a validation fails or an object is successfully repaired.
 165      */
 166     if (NodeFlags & ANOBJ_EVALUATED)
 167     {
 168         return;
 169     }
 170
 171     AcpiOsPrintf (ACPI_MSG_WARNING "%s: ", Pathname);
 172
 173     va_start (ArgList, Format);
 174     AcpiOsVprintf (Format, ArgList);
 175     ACPI_MSG_SUFFIX;
 176     va_end (ArgList);
 177 }
 178
 179
 180 /*******************************************************************************
 181  *
 182  * FUNCTION:    AcpiUtPredefinedInfo
 183  *
 184  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
 185  *              LineNumber      - Caller's line number (for error output)
 186  *              Pathname        - Full pathname to the node
 187  *              NodeFlags       - From Namespace node for the method/object
 188  *              Format          - Printf format string + additional args
 189  *
 190  * RETURN:      None
 191  *
 192  * DESCRIPTION: Info messages for the predefined validation module. Messages
 193  *              are only emitted the first time a problem with a particular
 194  *              method/object is detected. This prevents a flood of
 195  *              messages for methods that are repeatedly evaluated.
 196  *
 197  ******************************************************************************/
 198
 199 void ACPI_INTERNAL_VAR_XFACE
 200 AcpiUtPredefinedInfo (
 201     const char              *ModuleName,
 202     UINT32                  LineNumber,
 203     char                    *Pathname,
 204     UINT8                   NodeFlags,
 205     const char              *Format,
 206     ...)
 207 {
 208     va_list                 ArgList;
 209
 210
 211     /*
 212      * Warning messages for this method/object will be disabled after the
 213      * first time a validation fails or an object is successfully repaired.
 214      */
 215     if (NodeFlags & ANOBJ_EVALUATED)
 216     {
 217         return;
 218     }
 219
 220     AcpiOsPrintf (ACPI_MSG_INFO "%s: ", Pathname);
 221
 222     va_start (ArgList, Format);
 223     AcpiOsVprintf (Format, ArgList);
 224     ACPI_MSG_SUFFIX;
 225     va_end (ArgList);
 226 }
 227
 228
 229 /*******************************************************************************
 230  *
 231  * FUNCTION:    AcpiUtPredefinedBiosError
 232  *
 233  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
 234  *              LineNumber      - Caller's line number (for error output)
 235  *              Pathname        - Full pathname to the node
 236  *              NodeFlags       - From Namespace node for the method/object
 237  *              Format          - Printf format string + additional args
 238  *
 239  * RETURN:      None
 240  *
 241  * DESCRIPTION: BIOS error message for predefined names. Messages
 242  *              are only emitted the first time a problem with a particular
 243  *              method/object is detected. This prevents a flood of
 244  *              messages for methods that are repeatedly evaluated.
 245  *
 246  ******************************************************************************/
 247
 248 void ACPI_INTERNAL_VAR_XFACE
 249 AcpiUtPredefinedBiosError (
 250     const char              *ModuleName,
 251     UINT32                  LineNumber,
 252     char                    *Pathname,
 253     UINT8                   NodeFlags,
 254     const char              *Format,
 255     ...)
 256 {
 257     va_list                 ArgList;
 258
 259
 260     /*
 261      * Warning messages for this method/object will be disabled after the
 262      * first time a validation fails or an object is successfully repaired.
 263      */
 264     if (NodeFlags & ANOBJ_EVALUATED)
 265     {
 266         return;
 267     }
 268
 269     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s: ", Pathname);
 270
 271     va_start (ArgList, Format);
 272     AcpiOsVprintf (Format, ArgList);
 273     ACPI_MSG_SUFFIX;
 274     va_end (ArgList);
 275 }
 276
 277
 278 /*******************************************************************************
 279  *
 280  * FUNCTION:    AcpiUtNamespaceError
 281  *
 282  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 283  *              LineNumber          - Caller's line number (for error output)
 284  *              InternalName        - Name or path of the namespace node
 285  *              LookupStatus        - Exception code from NS lookup
 286  *
 287  * RETURN:      None
 288  *
 289  * DESCRIPTION: Print error message with the full pathname for the NS node.
 290  *
 291  ******************************************************************************/
 292
 293 void
 294 AcpiUtNamespaceError (
 295     const char              *ModuleName,
 296     UINT32                  LineNumber,
 297     const char              *InternalName,
 298     ACPI_STATUS             LookupStatus)
 299 {
 300     ACPI_STATUS             Status;
 301     UINT32                  BadName;
 302     char                    *Name = NULL;
 303
 304
 305     ACPI_MSG_REDIRECT_BEGIN;
 306     AcpiOsPrintf (ACPI_MSG_ERROR);
 307
 308     if (LookupStatus == AE_BAD_CHARACTER)
 309     {
 310         /* There is a non-ascii character in the name */
 311
 312         ACPI_MOVE_32_TO_32 (&BadName, ACPI_CAST_PTR (UINT32, InternalName));
 313         AcpiOsPrintf ("[0x%.8X] (NON-ASCII)", BadName);
 314     }
 315     else
 316     {
 317         /* Convert path to external format */
 318
 319         Status = AcpiNsExternalizeName (ACPI_UINT32_MAX,
 320                     InternalName, NULL, &Name);
 321
 322         /* Print target name */
 323
 324         if (ACPI_SUCCESS (Status))
 325         {
 326             AcpiOsPrintf ("[%s]", Name);
 327         }
 328         else
 329         {
 330             AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");
 331         }
 332
 333         if (Name)
 334         {
 335             ACPI_FREE (Name);
 336         }
 337     }
 338
 339     AcpiOsPrintf (" Namespace lookup failure, %s",
 340         AcpiFormatException (LookupStatus));
 341
 342     ACPI_MSG_SUFFIX;
 343     ACPI_MSG_REDIRECT_END;
 344 }
 345
 346
 347 /*******************************************************************************
 348  *
 349  * FUNCTION:    AcpiUtMethodError
 350  *
 351  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 352  *              LineNumber          - Caller's line number (for error output)
 353  *              Message             - Error message to use on failure
 354  *              PrefixNode          - Prefix relative to the path
 355  *              Path                - Path to the node (optional)
 356  *              MethodStatus        - Execution status
 357  *
 358  * RETURN:      None
 359  *
 360  * DESCRIPTION: Print error message with the full pathname for the method.
 361  *
 362  ******************************************************************************/
 363
 364 void
 365 AcpiUtMethodError (
 366     const char              *ModuleName,
 367     UINT32                  LineNumber,
 368     const char              *Message,
 369     ACPI_NAMESPACE_NODE     *PrefixNode,
 370     const char              *Path,
 371     ACPI_STATUS             MethodStatus)
 372 {
 373     ACPI_STATUS             Status;
 374     ACPI_NAMESPACE_NODE     *Node = PrefixNode;
 375
 376
 377     ACPI_MSG_REDIRECT_BEGIN;
 378     AcpiOsPrintf (ACPI_MSG_ERROR);
 379
 380     if (Path)
 381     {
 382         Status = AcpiNsGetNode (PrefixNode, Path, ACPI_NS_NO_UPSEARCH,
 383                     &Node);
 384         if (ACPI_FAILURE (Status))
 385         {
 386             AcpiOsPrintf ("[Could not get node by pathname]");
 387         }
 388     }
 389
 390     AcpiNsPrintNodePathname (Node, Message);
 391     AcpiOsPrintf (", %s", AcpiFormatException (MethodStatus));
 392
 393     ACPI_MSG_SUFFIX;
 394     ACPI_MSG_REDIRECT_END;
 395 }
 396
 397 #endif /* ACPI_NO_ERROR_MESSAGES */