1 /******************************************************************************
3 * Name: acoutput.h -- debug output
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACOUTPUT_H__
45 #define __ACOUTPUT_H__
48 * Debug levels and component IDs. These are used to control the
49 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
50 * per-component basis and a per-exception-type basis.
53 /* Component IDs are used in the global "DebugLayer" */
55 #define ACPI_UTILITIES 0x00000001
56 #define ACPI_HARDWARE 0x00000002
57 #define ACPI_EVENTS 0x00000004
58 #define ACPI_TABLES 0x00000008
59 #define ACPI_NAMESPACE 0x00000010
60 #define ACPI_PARSER 0x00000020
61 #define ACPI_DISPATCHER 0x00000040
62 #define ACPI_EXECUTER 0x00000080
63 #define ACPI_RESOURCES 0x00000100
64 #define ACPI_CA_DEBUGGER 0x00000200
65 #define ACPI_OS_SERVICES 0x00000400
66 #define ACPI_CA_DISASSEMBLER 0x00000800
68 /* Component IDs for ACPI tools and utilities */
70 #define ACPI_COMPILER 0x00001000
71 #define ACPI_TOOLS 0x00002000
72 #define ACPI_EXAMPLE 0x00004000
73 #define ACPI_DRIVER 0x00008000
74 #define DT_COMPILER 0x00010000
75 #define ASL_PREPROCESSOR 0x00020000
77 #define ACPI_ALL_COMPONENTS 0x0001FFFF
78 #define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
80 /* Component IDs reserved for ACPI drivers */
82 #define ACPI_ALL_DRIVERS 0xFFFF0000
85 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
87 #define ACPI_LV_INIT 0x00000001
88 #define ACPI_LV_DEBUG_OBJECT 0x00000002
89 #define ACPI_LV_INFO 0x00000004
90 #define ACPI_LV_REPAIR 0x00000008
91 #define ACPI_LV_TRACE_POINT 0x00000010
92 #define ACPI_LV_ALL_EXCEPTIONS 0x0000001F
94 /* Trace verbosity level 1 [Standard Trace Level] */
96 #define ACPI_LV_INIT_NAMES 0x00000020
97 #define ACPI_LV_PARSE 0x00000040
98 #define ACPI_LV_LOAD 0x00000080
99 #define ACPI_LV_DISPATCH 0x00000100
100 #define ACPI_LV_EXEC 0x00000200
101 #define ACPI_LV_NAMES 0x00000400
102 #define ACPI_LV_OPREGION 0x00000800
103 #define ACPI_LV_BFIELD 0x00001000
104 #define ACPI_LV_TABLES 0x00002000
105 #define ACPI_LV_VALUES 0x00004000
106 #define ACPI_LV_OBJECTS 0x00008000
107 #define ACPI_LV_RESOURCES 0x00010000
108 #define ACPI_LV_USER_REQUESTS 0x00020000
109 #define ACPI_LV_PACKAGE 0x00040000
110 #define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
112 /* Trace verbosity level 2 [Function tracing and memory allocation] */
114 #define ACPI_LV_ALLOCATIONS 0x00100000
115 #define ACPI_LV_FUNCTIONS 0x00200000
116 #define ACPI_LV_OPTIMIZATIONS 0x00400000
117 #define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1
118 #define ACPI_LV_ALL ACPI_LV_VERBOSITY2
120 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
122 #define ACPI_LV_MUTEX 0x01000000
123 #define ACPI_LV_THREADS 0x02000000
124 #define ACPI_LV_IO 0x04000000
125 #define ACPI_LV_INTERRUPTS 0x08000000
126 #define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
128 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
130 #define ACPI_LV_AML_DISASSEMBLE 0x10000000
131 #define ACPI_LV_VERBOSE_INFO 0x20000000
132 #define ACPI_LV_FULL_TABLES 0x40000000
133 #define ACPI_LV_EVENTS 0x80000000
134 #define ACPI_LV_VERBOSE 0xF0000000
137 * Debug level macros that are used in the DEBUG_PRINT macros
139 #define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
142 * Exception level -- used in the global "DebugLevel"
144 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
145 * For warnings, use ACPI_WARNING.
147 #define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
148 #define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
149 #define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
150 #define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
151 #define ACPI_DB_TRACE_POINT ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
152 #define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
154 /* Trace level -- also used in the global "DebugLevel" */
156 #define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
157 #define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
158 #define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
159 #define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
160 #define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
161 #define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
162 #define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
163 #define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
164 #define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
165 #define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
166 #define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
167 #define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
168 #define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
169 #define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
170 #define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
171 #define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
172 #define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
173 #define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
174 #define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
175 #define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
176 #define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
177 #define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
179 #define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
181 /* Defaults for debug_level, debug and normal */
183 #define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR)
184 #define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
185 #define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
187 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
189 * The module name is used primarily for error and debug messages.
190 * The __FILE__ macro is not very useful for this, because it
191 * usually includes the entire pathname to the module making the
192 * debug output difficult to read.
194 #define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
197 * For the no-debug and no-error-msg cases, we must at least define
198 * a null module name.
200 #define ACPI_MODULE_NAME(name)
201 #define _acpi_module_name ""
205 * Ascii error messages can be configured out
207 #ifndef ACPI_NO_ERROR_MESSAGES
208 #define AE_INFO _acpi_module_name, __LINE__
211 * Error reporting. Callers module and line number are inserted by AE_INFO,
212 * the plist contains a set of parens to allow variable-length lists.
213 * These macros are used for both the debug and non-debug versions of the code.
215 #define ACPI_INFO(plist) acpi_info plist
216 #define ACPI_WARNING(plist) acpi_warning plist
217 #define ACPI_EXCEPTION(plist) acpi_exception plist
218 #define ACPI_ERROR(plist) acpi_error plist
219 #define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
220 #define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
221 #define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
225 /* No error messages */
227 #define ACPI_INFO(plist)
228 #define ACPI_WARNING(plist)
229 #define ACPI_EXCEPTION(plist)
230 #define ACPI_ERROR(plist)
231 #define ACPI_BIOS_WARNING(plist)
232 #define ACPI_BIOS_ERROR(plist)
233 #define ACPI_DEBUG_OBJECT(obj,l,i)
235 #endif /* ACPI_NO_ERROR_MESSAGES */
238 * Debug macros that are conditionally compiled
240 #ifdef ACPI_DEBUG_OUTPUT
243 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
244 * define it now. This is the case where there the compiler does not support
245 * a __func__ macro or equivalent.
247 #ifndef ACPI_GET_FUNCTION_NAME
248 #define ACPI_GET_FUNCTION_NAME _acpi_function_name
251 * The Name parameter should be the procedure name as a quoted string.
252 * The function name is also used by the function exit macros below.
253 * Note: (const char) is used to be compatible with the debug interfaces
254 * and macros such as __func__.
256 #define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
259 /* Compiler supports __func__ (or equivalent) -- Ignore this macro */
261 #define ACPI_FUNCTION_NAME(name)
262 #endif /* ACPI_GET_FUNCTION_NAME */
265 * Common parameters used for debug output functions:
266 * line number, function name, module(file) name, component ID
268 #define ACPI_DEBUG_PARAMETERS \
269 __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
271 /* Check if debug output is currently dynamically enabled */
273 #define ACPI_IS_DEBUG_ENABLED(level, component) \
274 ((level & acpi_dbg_level) && (component & acpi_dbg_layer))
277 * Master debug print macros
278 * Print message if and only if:
279 * 1) Debug print for the current component is enabled
280 * 2) Debug error level or trace level for the print statement is enabled
282 * November 2012: Moved the runtime check for whether to actually emit the
283 * debug message outside of the print function itself. This improves overall
284 * performance at a relatively small code cost. Implementation involves the
285 * use of variadic macros supported by C99.
287 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
288 * complaining about these constructs. On other compilers the do...while
289 * adds some extra code, so this feature is optional.
291 #ifdef ACPI_USE_DO_WHILE_0
292 #define ACPI_DO_WHILE0(a) do a while(0)
294 #define ACPI_DO_WHILE0(a) a
297 /* DEBUG_PRINT functions */
299 #ifndef COMPILER_VA_MACRO
301 #define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
302 #define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
306 /* Helper macros for DEBUG_PRINT */
308 #define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
310 if (ACPI_IS_DEBUG_ENABLED (level, component)) \
312 function (level, line, filename, modulename, component, __VA_ARGS__); \
316 #define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
317 ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
318 filename, modulename, component, __VA_ARGS__)
320 #define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
321 ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
322 filename, modulename, component, __VA_ARGS__)
324 #define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
325 #define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
330 * Function entry tracing
332 * The name of the function is emitted as a local variable that is
333 * intended to be used by both the entry trace and the exit trace.
338 #define ACPI_TRACE_ENTRY(name, function, type, param) \
339 ACPI_FUNCTION_NAME (name) \
340 function (ACPI_DEBUG_PARAMETERS, (type) (param))
342 /* The actual entry trace macros */
344 #define ACPI_FUNCTION_TRACE(name) \
345 ACPI_FUNCTION_NAME(name) \
346 acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
348 #define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
349 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
351 #define ACPI_FUNCTION_TRACE_U32(name, value) \
352 ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
354 #define ACPI_FUNCTION_TRACE_STR(name, string) \
355 ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, char *, string)
357 #define ACPI_FUNCTION_ENTRY() \
358 acpi_ut_track_stack_ptr()
361 * Function exit tracing
363 * These macros include a return statement. This is usually considered
364 * bad form, but having a separate exit macro before the actual return
365 * is very ugly and difficult to maintain.
367 * One of the FUNCTION_TRACE macros above must be used in conjunction
368 * with these macros so that "_AcpiFunctionName" is defined.
370 * There are two versions of most of the return macros. The default version is
371 * safer, since it avoids side-effects by guaranteeing that the argument will
372 * not be evaluated twice.
374 * A less-safe version of the macros is provided for optional use if the
375 * compiler uses excessive CPU stack (for example, this may happen in the
376 * debug case if code optimzation is disabled.)
379 /* Exit trace helper macro */
381 #ifndef ACPI_SIMPLE_RETURN_MACROS
383 #define ACPI_TRACE_EXIT(function, type, param) \
385 register type _param = (type) (param); \
386 function (ACPI_DEBUG_PARAMETERS, _param); \
390 #else /* Use original less-safe macros */
392 #define ACPI_TRACE_EXIT(function, type, param) \
394 function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
398 #endif /* ACPI_SIMPLE_RETURN_MACROS */
400 /* The actual exit macros */
402 #define return_VOID \
404 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
408 #define return_ACPI_STATUS(status) \
409 ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
411 #define return_PTR(pointer) \
412 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
414 #define return_VALUE(value) \
415 ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
417 #define return_UINT32(value) \
418 ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
420 #define return_UINT8(value) \
421 ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
423 /* Conditional execution */
425 #define ACPI_DEBUG_EXEC(a) a
426 #define ACPI_DEBUG_ONLY_MEMBERS(a) a;
427 #define _VERBOSE_STRUCTURES
429 /* Various object display routines for debug */
431 #define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
432 #define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
433 #define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
434 #define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
435 #define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
437 #else /* ACPI_DEBUG_OUTPUT */
439 * This is the non-debug case -- make everything go away,
440 * leaving no executable debug code!
442 #define ACPI_DEBUG_PRINT(pl)
443 #define ACPI_DEBUG_PRINT_RAW(pl)
444 #define ACPI_DEBUG_EXEC(a)
445 #define ACPI_DEBUG_ONLY_MEMBERS(a)
446 #define ACPI_FUNCTION_NAME(a)
447 #define ACPI_FUNCTION_TRACE(a)
448 #define ACPI_FUNCTION_TRACE_PTR(a, b)
449 #define ACPI_FUNCTION_TRACE_U32(a, b)
450 #define ACPI_FUNCTION_TRACE_STR(a, b)
451 #define ACPI_FUNCTION_ENTRY()
452 #define ACPI_DUMP_STACK_ENTRY(a)
453 #define ACPI_DUMP_OPERANDS(a, b, c)
454 #define ACPI_DUMP_ENTRY(a, b)
455 #define ACPI_DUMP_PATHNAME(a, b, c, d)
456 #define ACPI_DUMP_BUFFER(a, b)
457 #define ACPI_IS_DEBUG_ENABLED(level, component) 0
459 /* Return macros must have a return statement at the minimum */
461 #define return_VOID return
462 #define return_ACPI_STATUS(s) return(s)
463 #define return_PTR(s) return(s)
464 #define return_VALUE(s) return(s)
465 #define return_UINT8(s) return(s)
466 #define return_UINT32(s) return(s)
468 #endif /* ACPI_DEBUG_OUTPUT */
470 #endif /* __ACOUTPUT_H__ */