| blob | 61884f14d22554feb34dea8f93f4bde090c7c9fc |
1 /******************************************************************************
2 *
3 * Name: acoutput.h -- debug output
4 *
5 *****************************************************************************/
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2010, 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 *****************************************************************************/
116 #ifndef __ACOUTPUT_H__
117 #define __ACOUTPUT_H__
119 /*
120 * Debug levels and component IDs. These are used to control the
121 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
122 * per-component basis and a per-exception-type basis.
123 */
125 /* Component IDs are used in the global "DebugLayer" */
127 #define ACPI_UTILITIES 0x00000001
128 #define ACPI_HARDWARE 0x00000002
129 #define ACPI_EVENTS 0x00000004
130 #define ACPI_TABLES 0x00000008
131 #define ACPI_NAMESPACE 0x00000010
132 #define ACPI_PARSER 0x00000020
133 #define ACPI_DISPATCHER 0x00000040
134 #define ACPI_EXECUTER 0x00000080
135 #define ACPI_RESOURCES 0x00000100
136 #define ACPI_CA_DEBUGGER 0x00000200
137 #define ACPI_OS_SERVICES 0x00000400
138 #define ACPI_CA_DISASSEMBLER 0x00000800
140 /* Component IDs for ACPI tools and utilities */
142 #define ACPI_COMPILER 0x00001000
143 #define ACPI_TOOLS 0x00002000
144 #define ACPI_EXAMPLE 0x00004000
145 #define ACPI_DRIVER 0x00008000
146 #define DT_COMPILER 0x00010000
148 #define ACPI_ALL_COMPONENTS 0x0001FFFF
149 #define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
151 /* Component IDs reserved for ACPI drivers */
153 #define ACPI_ALL_DRIVERS 0xFFFF0000
156 /*
157 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
158 */
159 #define ACPI_LV_INIT 0x00000001
160 #define ACPI_LV_DEBUG_OBJECT 0x00000002
161 #define ACPI_LV_INFO 0x00000004
162 #define ACPI_LV_REPAIR 0x00000008
163 #define ACPI_LV_ALL_EXCEPTIONS 0x0000000F
165 /* Trace verbosity level 1 [Standard Trace Level] */
167 #define ACPI_LV_INIT_NAMES 0x00000020
168 #define ACPI_LV_PARSE 0x00000040
169 #define ACPI_LV_LOAD 0x00000080
170 #define ACPI_LV_DISPATCH 0x00000100
171 #define ACPI_LV_EXEC 0x00000200
172 #define ACPI_LV_NAMES 0x00000400
173 #define ACPI_LV_OPREGION 0x00000800
174 #define ACPI_LV_BFIELD 0x00001000
175 #define ACPI_LV_TABLES 0x00002000
176 #define ACPI_LV_VALUES 0x00004000
177 #define ACPI_LV_OBJECTS 0x00008000
178 #define ACPI_LV_RESOURCES 0x00010000
179 #define ACPI_LV_USER_REQUESTS 0x00020000
180 #define ACPI_LV_PACKAGE 0x00040000
181 #define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
183 /* Trace verbosity level 2 [Function tracing and memory allocation] */
185 #define ACPI_LV_ALLOCATIONS 0x00100000
186 #define ACPI_LV_FUNCTIONS 0x00200000
187 #define ACPI_LV_OPTIMIZATIONS 0x00400000
188 #define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1
189 #define ACPI_LV_ALL ACPI_LV_VERBOSITY2
191 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
193 #define ACPI_LV_MUTEX 0x01000000
194 #define ACPI_LV_THREADS 0x02000000
195 #define ACPI_LV_IO 0x04000000
196 #define ACPI_LV_INTERRUPTS 0x08000000
197 #define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
199 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
201 #define ACPI_LV_AML_DISASSEMBLE 0x10000000
202 #define ACPI_LV_VERBOSE_INFO 0x20000000
203 #define ACPI_LV_FULL_TABLES 0x40000000
204 #define ACPI_LV_EVENTS 0x80000000
205 #define ACPI_LV_VERBOSE 0xF0000000
208 /*
209 * Debug level macros that are used in the DEBUG_PRINT macros
210 */
211 #define ACPI_DEBUG_LEVEL(dl) (UINT32) dl,ACPI_DEBUG_PARAMETERS
213 /*
214 * Exception level -- used in the global "DebugLevel"
215 *
216 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
217 * For warnings, use ACPI_WARNING.
218 */
219 #define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
220 #define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
221 #define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
222 #define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
223 #define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
225 /* Trace level -- also used in the global "DebugLevel" */
227 #define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
228 #define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
229 #define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
230 #define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
231 #define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
232 #define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
233 #define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
234 #define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
235 #define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
236 #define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
237 #define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
238 #define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
239 #define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
240 #define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
241 #define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
242 #define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
243 #define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
244 #define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
245 #define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
246 #define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
247 #define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
248 #define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
250 #define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
252 /* Defaults for DebugLevel, debug and normal */
254 #define ACPI_DEBUG_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
255 #define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
256 #define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
259 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
260 /*
261 * Module name is included in both debug and non-debug versions primarily for
262 * error messages. The __FILE__ macro is not very useful for this, because it
263 * often includes the entire pathname to the module
264 */
265 #define ACPI_MODULE_NAME(Name) static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name;
266 #else
267 #define ACPI_MODULE_NAME(Name)
268 #endif
270 /*
271 * Ascii error messages can be configured out
272 */
273 #ifndef ACPI_NO_ERROR_MESSAGES
274 #define AE_INFO _AcpiModuleName, __LINE__
276 /*
277 * Error reporting. Callers module and line number are inserted by AE_INFO,
278 * the plist contains a set of parens to allow variable-length lists.
279 * These macros are used for both the debug and non-debug versions of the code.
280 */
281 #define ACPI_INFO(plist) AcpiInfo plist
282 #define ACPI_WARNING(plist) AcpiWarning plist
283 #define ACPI_EXCEPTION(plist) AcpiException plist
284 #define ACPI_ERROR(plist) AcpiError plist
285 #define ACPI_DEBUG_OBJECT(obj,l,i) AcpiExDoDebugObject(obj,l,i)
287 #else
289 /* No error messages */
291 #define ACPI_INFO(plist)
292 #define ACPI_WARNING(plist)
293 #define ACPI_EXCEPTION(plist)
294 #define ACPI_ERROR(plist)
295 #define ACPI_DEBUG_OBJECT(obj,l,i)
300 /*
301 * Debug macros that are conditionally compiled
302 */
303 #ifdef ACPI_DEBUG_OUTPUT
305 /*
306 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
307 * define it now. This is the case where there the compiler does not support
308 * a __FUNCTION__ macro or equivalent.
309 */
310 #ifndef ACPI_GET_FUNCTION_NAME
311 #define ACPI_GET_FUNCTION_NAME _AcpiFunctionName
313 /*
314 * The Name parameter should be the procedure name as a quoted string.
315 * The function name is also used by the function exit macros below.
316 * Note: (const char) is used to be compatible with the debug interfaces
317 * and macros such as __FUNCTION__.
318 */
319 #define ACPI_FUNCTION_NAME(Name) static const char _AcpiFunctionName[] = #Name;
321 #else
322 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
324 #define ACPI_FUNCTION_NAME(Name)
327 /*
328 * Common parameters used for debug output functions:
329 * line number, function name, module(file) name, component ID
330 */
331 #define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT
333 /*
334 * Master debug print macros
335 * Print message if and only if:
336 * 1) Debug print for the current component is enabled
337 * 2) Debug error level or trace level for the print statement is enabled
338 */
339 #define ACPI_DEBUG_PRINT(plist) AcpiDebugPrint plist
340 #define ACPI_DEBUG_PRINT_RAW(plist) AcpiDebugPrintRaw plist
342 #else
343 /*
344 * This is the non-debug case -- make everything go away,
345 * leaving no executable debug code!
346 */
347 #define ACPI_FUNCTION_NAME(a)
348 #define ACPI_DEBUG_PRINT(pl)
349 #define ACPI_DEBUG_PRINT_RAW(pl)