1 /*******************************************************************************
3 * Module Name: utxferror - Various error/warning output functions
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, 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 #define __UTXFERROR_C__
119 #include "accommon.h"
120 #include "acnamesp.h"
123 #define _COMPONENT ACPI_UTILITIES
124 ACPI_MODULE_NAME ("utxferror")
127 * This module is used for the in-kernel ACPICA as well as the ACPICA
128 * tools/applications.
130 * For the iASL compiler case, the output is redirected to stderr so that
131 * any of the various ACPI errors and warnings do not appear in the output
132 * files, for either the compiler or disassembler portions of the tool.
134 #ifdef ACPI_ASL_COMPILER
137 extern FILE *AcpiGbl_OutputFile
;
139 #define ACPI_MSG_REDIRECT_BEGIN \
140 FILE *OutputFile = AcpiGbl_OutputFile; \
141 AcpiOsRedirectOutput (stderr);
143 #define ACPI_MSG_REDIRECT_END \
144 AcpiOsRedirectOutput (OutputFile);
148 * non-iASL case - no redirection, nothing to do
150 #define ACPI_MSG_REDIRECT_BEGIN
151 #define ACPI_MSG_REDIRECT_END
155 * Common message prefixes
157 #define ACPI_MSG_ERROR "ACPI Error: "
158 #define ACPI_MSG_EXCEPTION "ACPI Exception: "
159 #define ACPI_MSG_WARNING "ACPI Warning: "
160 #define ACPI_MSG_INFO "ACPI: "
163 * Common message suffix
165 #define ACPI_MSG_SUFFIX \
166 AcpiOsPrintf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, ModuleName, LineNumber)
169 /*******************************************************************************
171 * FUNCTION: AcpiError
173 * PARAMETERS: ModuleName - Caller's module name (for error output)
174 * LineNumber - Caller's line number (for error output)
175 * Format - Printf format string + additional args
179 * DESCRIPTION: Print "ACPI Error" message with module/line/version info
181 ******************************************************************************/
183 void ACPI_INTERNAL_VAR_XFACE
185 const char *ModuleName
,
193 ACPI_MSG_REDIRECT_BEGIN
;
194 AcpiOsPrintf (ACPI_MSG_ERROR
);
196 va_start (ArgList
, Format
);
197 AcpiOsVprintf (Format
, ArgList
);
201 ACPI_MSG_REDIRECT_END
;
204 ACPI_EXPORT_SYMBOL (AcpiError
)
207 /*******************************************************************************
209 * FUNCTION: AcpiException
211 * PARAMETERS: ModuleName - Caller's module name (for error output)
212 * LineNumber - Caller's line number (for error output)
213 * Status - Status to be formatted
214 * Format - Printf format string + additional args
218 * DESCRIPTION: Print "ACPI Exception" message with module/line/version info
219 * and decoded ACPI_STATUS.
221 ******************************************************************************/
223 void ACPI_INTERNAL_VAR_XFACE
225 const char *ModuleName
,
234 ACPI_MSG_REDIRECT_BEGIN
;
235 AcpiOsPrintf (ACPI_MSG_EXCEPTION
"%s, ", AcpiFormatException (Status
));
237 va_start (ArgList
, Format
);
238 AcpiOsVprintf (Format
, ArgList
);
242 ACPI_MSG_REDIRECT_END
;
245 ACPI_EXPORT_SYMBOL (AcpiException
)
248 /*******************************************************************************
250 * FUNCTION: AcpiWarning
252 * PARAMETERS: ModuleName - Caller's module name (for error output)
253 * LineNumber - Caller's line number (for error output)
254 * Format - Printf format string + additional args
258 * DESCRIPTION: Print "ACPI Warning" message with module/line/version info
260 ******************************************************************************/
262 void ACPI_INTERNAL_VAR_XFACE
264 const char *ModuleName
,
272 ACPI_MSG_REDIRECT_BEGIN
;
273 AcpiOsPrintf (ACPI_MSG_WARNING
);
275 va_start (ArgList
, Format
);
276 AcpiOsVprintf (Format
, ArgList
);
280 ACPI_MSG_REDIRECT_END
;
283 ACPI_EXPORT_SYMBOL (AcpiWarning
)
286 /*******************************************************************************
290 * PARAMETERS: ModuleName - Caller's module name (for error output)
291 * LineNumber - Caller's line number (for error output)
292 * Format - Printf format string + additional args
296 * DESCRIPTION: Print generic "ACPI:" information message. There is no
297 * module/line/version info in order to keep the message simple.
299 * TBD: ModuleName and LineNumber args are not needed, should be removed.
301 ******************************************************************************/
303 void ACPI_INTERNAL_VAR_XFACE
305 const char *ModuleName
,
313 ACPI_MSG_REDIRECT_BEGIN
;
314 AcpiOsPrintf (ACPI_MSG_INFO
);
316 va_start (ArgList
, Format
);
317 AcpiOsVprintf (Format
, ArgList
);
321 ACPI_MSG_REDIRECT_END
;
324 ACPI_EXPORT_SYMBOL (AcpiInfo
)
328 * The remainder of this module contains internal error functions that may
331 #if !defined (ACPI_NO_ERROR_MESSAGES) && !defined (ACPI_BIN_APP)
333 /*******************************************************************************
335 * FUNCTION: AcpiUtPredefinedWarning
337 * PARAMETERS: ModuleName - Caller's module name (for error output)
338 * LineNumber - Caller's line number (for error output)
339 * Pathname - Full pathname to the node
340 * NodeFlags - From Namespace node for the method/object
341 * Format - Printf format string + additional args
345 * DESCRIPTION: Warnings for the predefined validation module. Messages are
346 * only emitted the first time a problem with a particular
347 * method/object is detected. This prevents a flood of error
348 * messages for methods that are repeatedly evaluated.
350 ******************************************************************************/
352 void ACPI_INTERNAL_VAR_XFACE
353 AcpiUtPredefinedWarning (
354 const char *ModuleName
,
365 * Warning messages for this method/object will be disabled after the
366 * first time a validation fails or an object is successfully repaired.
368 if (NodeFlags
& ANOBJ_EVALUATED
)
373 AcpiOsPrintf (ACPI_MSG_WARNING
"For %s: ", Pathname
);
375 va_start (ArgList
, Format
);
376 AcpiOsVprintf (Format
, ArgList
);
382 /*******************************************************************************
384 * FUNCTION: AcpiUtPredefinedInfo
386 * PARAMETERS: ModuleName - Caller's module name (for error output)
387 * LineNumber - Caller's line number (for error output)
388 * Pathname - Full pathname to the node
389 * NodeFlags - From Namespace node for the method/object
390 * Format - Printf format string + additional args
394 * DESCRIPTION: Info messages for the predefined validation module. Messages
395 * are only emitted the first time a problem with a particular
396 * method/object is detected. This prevents a flood of
397 * messages for methods that are repeatedly evaluated.
399 ******************************************************************************/
401 void ACPI_INTERNAL_VAR_XFACE
402 AcpiUtPredefinedInfo (
403 const char *ModuleName
,
414 * Warning messages for this method/object will be disabled after the
415 * first time a validation fails or an object is successfully repaired.
417 if (NodeFlags
& ANOBJ_EVALUATED
)
422 AcpiOsPrintf (ACPI_MSG_INFO
"For %s: ", Pathname
);
424 va_start (ArgList
, Format
);
425 AcpiOsVprintf (Format
, ArgList
);
431 /*******************************************************************************
433 * FUNCTION: AcpiUtNamespaceError
435 * PARAMETERS: ModuleName - Caller's module name (for error output)
436 * LineNumber - Caller's line number (for error output)
437 * InternalName - Name or path of the namespace node
438 * LookupStatus - Exception code from NS lookup
442 * DESCRIPTION: Print error message with the full pathname for the NS node.
444 ******************************************************************************/
447 AcpiUtNamespaceError (
448 const char *ModuleName
,
450 const char *InternalName
,
451 ACPI_STATUS LookupStatus
)
458 ACPI_MSG_REDIRECT_BEGIN
;
459 AcpiOsPrintf (ACPI_MSG_ERROR
);
461 if (LookupStatus
== AE_BAD_CHARACTER
)
463 /* There is a non-ascii character in the name */
465 ACPI_MOVE_32_TO_32 (&BadName
, ACPI_CAST_PTR (UINT32
, InternalName
));
466 AcpiOsPrintf ("[0x%4.4X] (NON-ASCII)", BadName
);
470 /* Convert path to external format */
472 Status
= AcpiNsExternalizeName (ACPI_UINT32_MAX
,
473 InternalName
, NULL
, &Name
);
475 /* Print target name */
477 if (ACPI_SUCCESS (Status
))
479 AcpiOsPrintf ("[%s]", Name
);
483 AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");
492 AcpiOsPrintf (" Namespace lookup failure, %s",
493 AcpiFormatException (LookupStatus
));
496 ACPI_MSG_REDIRECT_END
;
500 /*******************************************************************************
502 * FUNCTION: AcpiUtMethodError
504 * PARAMETERS: ModuleName - Caller's module name (for error output)
505 * LineNumber - Caller's line number (for error output)
506 * Message - Error message to use on failure
507 * PrefixNode - Prefix relative to the path
508 * Path - Path to the node (optional)
509 * MethodStatus - Execution status
513 * DESCRIPTION: Print error message with the full pathname for the method.
515 ******************************************************************************/
519 const char *ModuleName
,
522 ACPI_NAMESPACE_NODE
*PrefixNode
,
524 ACPI_STATUS MethodStatus
)
527 ACPI_NAMESPACE_NODE
*Node
= PrefixNode
;
530 ACPI_MSG_REDIRECT_BEGIN
;
531 AcpiOsPrintf (ACPI_MSG_ERROR
);
535 Status
= AcpiNsGetNode (PrefixNode
, Path
, ACPI_NS_NO_UPSEARCH
,
537 if (ACPI_FAILURE (Status
))
539 AcpiOsPrintf ("[Could not get node by pathname]");
543 AcpiNsPrintNodePathname (Node
, Message
);
544 AcpiOsPrintf (", %s", AcpiFormatException (MethodStatus
));
547 ACPI_MSG_REDIRECT_END
;
550 #endif /* ACPI_NO_ERROR_MESSAGES */