1 /*******************************************************************************
3 * Module Name: uterror - Various internal error/warning output functions
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
153 #include "accommon.h"
154 #include "acnamesp.h"
157 #define _COMPONENT ACPI_UTILITIES
158 ACPI_MODULE_NAME ("uterror")
162 * This module contains internal error functions that may
165 #if !defined (ACPI_NO_ERROR_MESSAGES)
167 /*******************************************************************************
169 * FUNCTION: AcpiUtPredefinedWarning
171 * PARAMETERS: ModuleName - Caller's module name (for error output)
172 * LineNumber - Caller's line number (for error output)
173 * Pathname - Full pathname to the node
174 * NodeFlags - From Namespace node for the method/object
175 * Format - Printf format string + additional args
179 * DESCRIPTION: Warnings for the predefined validation module. Messages are
180 * only emitted the first time a problem with a particular
181 * method/object is detected. This prevents a flood of error
182 * messages for methods that are repeatedly evaluated.
184 ******************************************************************************/
186 void ACPI_INTERNAL_VAR_XFACE
187 AcpiUtPredefinedWarning (
188 const char *ModuleName,
199 * Warning messages for this method/object will be disabled after the
200 * first time a validation fails or an object is successfully repaired.
202 if (NodeFlags & ANOBJ_EVALUATED)
207 AcpiOsPrintf (ACPI_MSG_WARNING "%s: ", Pathname);
209 va_start (ArgList, Format);
210 AcpiOsVprintf (Format, ArgList);
216 /*******************************************************************************
218 * FUNCTION: AcpiUtPredefinedInfo
220 * PARAMETERS: ModuleName - Caller's module name (for error output)
221 * LineNumber - Caller's line number (for error output)
222 * Pathname - Full pathname to the node
223 * NodeFlags - From Namespace node for the method/object
224 * Format - Printf format string + additional args
228 * DESCRIPTION: Info messages for the predefined validation module. Messages
229 * are only emitted the first time a problem with a particular
230 * method/object is detected. This prevents a flood of
231 * messages for methods that are repeatedly evaluated.
233 ******************************************************************************/
235 void ACPI_INTERNAL_VAR_XFACE
236 AcpiUtPredefinedInfo (
237 const char *ModuleName,
248 * Warning messages for this method/object will be disabled after the
249 * first time a validation fails or an object is successfully repaired.
251 if (NodeFlags & ANOBJ_EVALUATED)
256 AcpiOsPrintf (ACPI_MSG_INFO "%s: ", Pathname);
258 va_start (ArgList, Format);
259 AcpiOsVprintf (Format, ArgList);
265 /*******************************************************************************
267 * FUNCTION: AcpiUtPredefinedBiosError
269 * PARAMETERS: ModuleName - Caller's module name (for error output)
270 * LineNumber - Caller's line number (for error output)
271 * Pathname - Full pathname to the node
272 * NodeFlags - From Namespace node for the method/object
273 * Format - Printf format string + additional args
277 * DESCRIPTION: BIOS error message for predefined names. Messages
278 * are only emitted the first time a problem with a particular
279 * method/object is detected. This prevents a flood of
280 * messages for methods that are repeatedly evaluated.
282 ******************************************************************************/
284 void ACPI_INTERNAL_VAR_XFACE
285 AcpiUtPredefinedBiosError (
286 const char *ModuleName,
297 * Warning messages for this method/object will be disabled after the
298 * first time a validation fails or an object is successfully repaired.
300 if (NodeFlags & ANOBJ_EVALUATED)
305 AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s: ", Pathname);
307 va_start (ArgList, Format);
308 AcpiOsVprintf (Format, ArgList);
314 /*******************************************************************************
316 * FUNCTION: AcpiUtPrefixedNamespaceError
318 * PARAMETERS: ModuleName - Caller's module name (for error output)
319 * LineNumber - Caller's line number (for error output)
320 * PrefixScope - Scope/Path that prefixes the internal path
321 * InternalPath - Name or path of the namespace node
322 * LookupStatus - Exception code from NS lookup
326 * DESCRIPTION: Print error message with the full pathname constructed this way:
328 * PrefixScopeNodeFullPath.ExternalizedInternalPath
330 * NOTE: 10/2017: Treat the major NsLookup errors as firmware errors
332 ******************************************************************************/
335 AcpiUtPrefixedNamespaceError (
336 const char *ModuleName,
338 ACPI_GENERIC_STATE *PrefixScope,
339 const char *InternalPath,
340 ACPI_STATUS LookupStatus)
348 * 1) Object creation, object must not already exist
349 * 2) Object lookup, object must exist
351 switch (LookupStatus)
353 case AE_ALREADY_EXISTS:
355 AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
356 Message = "Failure creating named object";
361 AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
362 Message = "Could not resolve symbol";
367 AcpiOsPrintf (ACPI_MSG_ERROR);
368 Message = "Failure resolving symbol";
372 /* Concatenate the prefix path and the internal path */
374 FullPath = AcpiNsBuildPrefixedPathname (PrefixScope, InternalPath);
376 AcpiOsPrintf ("%s [%s], %s", Message,
377 FullPath ? FullPath : "Could not get pathname",
378 AcpiFormatException (LookupStatus));
382 ACPI_FREE (FullPath);
389 #ifdef __OBSOLETE_FUNCTION
390 /*******************************************************************************
392 * FUNCTION: AcpiUtNamespaceError
394 * PARAMETERS: ModuleName - Caller's module name (for error output)
395 * LineNumber - Caller's line number (for error output)
396 * InternalName - Name or path of the namespace node
397 * LookupStatus - Exception code from NS lookup
401 * DESCRIPTION: Print error message with the full pathname for the NS node.
403 ******************************************************************************/
406 AcpiUtNamespaceError (
407 const char *ModuleName,
409 const char *InternalName,
410 ACPI_STATUS LookupStatus)
417 ACPI_MSG_REDIRECT_BEGIN;
418 AcpiOsPrintf (ACPI_MSG_ERROR);
420 if (LookupStatus == AE_BAD_CHARACTER)
422 /* There is a non-ascii character in the name */
424 ACPI_MOVE_32_TO_32 (&BadName, ACPI_CAST_PTR (UINT32, InternalName));
425 AcpiOsPrintf ("[0x%.8X] (NON-ASCII)", BadName);
429 /* Convert path to external format */
431 Status = AcpiNsExternalizeName (
432 ACPI_UINT32_MAX, InternalName, NULL, &Name);
434 /* Print target name */
436 if (ACPI_SUCCESS (Status))
438 AcpiOsPrintf ("[%s]", Name);
442 AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");
451 AcpiOsPrintf (" Namespace lookup failure, %s",
452 AcpiFormatException (LookupStatus));
455 ACPI_MSG_REDIRECT_END;
459 /*******************************************************************************
461 * FUNCTION: AcpiUtMethodError
463 * PARAMETERS: ModuleName - Caller's module name (for error output)
464 * LineNumber - Caller's line number (for error output)
465 * Message - Error message to use on failure
466 * PrefixNode - Prefix relative to the path
467 * Path - Path to the node (optional)
468 * MethodStatus - Execution status
472 * DESCRIPTION: Print error message with the full pathname for the method.
474 ******************************************************************************/
478 const char *ModuleName,
481 ACPI_NAMESPACE_NODE *PrefixNode,
483 ACPI_STATUS MethodStatus)
486 ACPI_NAMESPACE_NODE *Node = PrefixNode;
489 ACPI_MSG_REDIRECT_BEGIN;
490 AcpiOsPrintf (ACPI_MSG_ERROR);
494 Status = AcpiNsGetNode (PrefixNode, Path,
495 ACPI_NS_NO_UPSEARCH, &Node);
496 if (ACPI_FAILURE (Status))
498 AcpiOsPrintf ("[Could not get node by pathname]");
502 AcpiNsPrintNodePathname (Node, Message);
503 AcpiOsPrintf (" due to previous error (%s)",
504 AcpiFormatException (MethodStatus));
507 ACPI_MSG_REDIRECT_END;
510 #endif /* ACPI_NO_ERROR_MESSAGES */