1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
4  * Name: acoutput.h -- debug output
6  * Copyright (C) 2000 - 2023, Intel Corp.
11 #define __ACOUTPUT_H__
15  * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
16  * per-component basis and a per-exception-type basis.
21 #define ACPI_UTILITIES              0x00000001
22 #define ACPI_HARDWARE               0x00000002
23 #define ACPI_EVENTS                 0x00000004
24 #define ACPI_TABLES                 0x00000008
25 #define ACPI_NAMESPACE              0x00000010
26 #define ACPI_PARSER                 0x00000020
27 #define ACPI_DISPATCHER             0x00000040
28 #define ACPI_EXECUTER               0x00000080
29 #define ACPI_RESOURCES              0x00000100
30 #define ACPI_CA_DEBUGGER            0x00000200
31 #define ACPI_OS_SERVICES            0x00000400
32 #define ACPI_CA_DISASSEMBLER        0x00000800
36 #define ACPI_COMPILER               0x00001000
37 #define ACPI_TOOLS                  0x00002000
38 #define ACPI_EXAMPLE                0x00004000
39 #define ACPI_DRIVER                 0x00008000
40 #define DT_COMPILER                 0x00010000
41 #define ASL_PREPROCESSOR            0x00020000
43 #define ACPI_ALL_COMPONENTS         0x0001FFFF
44 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
48 #define ACPI_ALL_DRIVERS            0xFFFF0000
53 #define ACPI_LV_INIT                0x00000001
54 #define ACPI_LV_DEBUG_OBJECT        0x00000002
55 #define ACPI_LV_INFO                0x00000004
56 #define ACPI_LV_REPAIR              0x00000008
57 #define ACPI_LV_TRACE_POINT         0x00000010
58 #define ACPI_LV_ALL_EXCEPTIONS      0x0000001F
62 #define ACPI_LV_INIT_NAMES          0x00000020
63 #define ACPI_LV_PARSE               0x00000040
64 #define ACPI_LV_LOAD                0x00000080
65 #define ACPI_LV_DISPATCH            0x00000100
66 #define ACPI_LV_EXEC                0x00000200
67 #define ACPI_LV_NAMES               0x00000400
68 #define ACPI_LV_OPREGION            0x00000800
69 #define ACPI_LV_BFIELD              0x00001000
70 #define ACPI_LV_TABLES              0x00002000
71 #define ACPI_LV_VALUES              0x00004000
72 #define ACPI_LV_OBJECTS             0x00008000
73 #define ACPI_LV_RESOURCES           0x00010000
74 #define ACPI_LV_USER_REQUESTS       0x00020000
75 #define ACPI_LV_PACKAGE             0x00040000
76 #define ACPI_LV_EVALUATION          0x00080000
77 #define ACPI_LV_VERBOSITY1          0x000FFF40 | ACPI_LV_ALL_EXCEPTIONS
81 #define ACPI_LV_ALLOCATIONS         0x00100000
82 #define ACPI_LV_FUNCTIONS           0x00200000
83 #define ACPI_LV_OPTIMIZATIONS       0x00400000
84 #define ACPI_LV_PARSE_TREES         0x00800000
85 #define ACPI_LV_VERBOSITY2          0x00F00000 | ACPI_LV_VERBOSITY1
86 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
90 #define ACPI_LV_MUTEX               0x01000000
91 #define ACPI_LV_THREADS             0x02000000
92 #define ACPI_LV_IO                  0x04000000
93 #define ACPI_LV_INTERRUPTS          0x08000000
94 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
96 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
98 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
99 #define ACPI_LV_VERBOSE_INFO        0x20000000
100 #define ACPI_LV_FULL_TABLES         0x40000000
101 #define ACPI_LV_EVENTS              0x80000000
102 #define ACPI_LV_VERBOSE             0xF0000000
107 #define ACPI_DEBUG_LEVEL(dl)        (u32) dl,ACPI_DEBUG_PARAMETERS
110  * Exception level -- used in the global "DebugLevel"
115 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
116 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
117 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
118 #define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
119 #define ACPI_DB_TRACE_POINT         ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
120 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
122 /* Trace level -- also used in the global "DebugLevel" */
124 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
125 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
126 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
127 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
128 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
129 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
130 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
131 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
132 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
133 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
134 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
135 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
136 #define ACPI_DB_PARSE_TREES         ACPI_DEBUG_LEVEL (ACPI_LV_PARSE_TREES)
137 #define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
138 #define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
139 #define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
140 #define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
141 #define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
142 #define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
143 #define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
144 #define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
145 #define ACPI_DB_EVALUATION          ACPI_DEBUG_LEVEL (ACPI_LV_EVALUATION)
146 #define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
147 #define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
149 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
154 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_EVALUATION | ACP…
157 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
158 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
163 #define ACPI_TRACE_ENABLED          ((u32) 4)
164 #define ACPI_TRACE_ONESHOT          ((u32) 2)
165 #define ACPI_TRACE_OPCODE           ((u32) 1)
169 #define ACPI_TRACE_LEVEL_ALL        ACPI_LV_ALL
170 #define ACPI_TRACE_LAYER_ALL        0x000001FF
171 #define ACPI_TRACE_LEVEL_DEFAULT    ACPI_LV_TRACE_POINT
172 #define ACPI_TRACE_LAYER_DEFAULT    ACPI_EXECUTER
176  * The module name is used primarily for error and debug messages.
181 #define ACPI_MODULE_NAME(name)          static const char ACPI_UNUSED_VAR _acpi_module_name[] = nam…  argument
184  * For the no-debug and no-error-msg cases, we must at least define
185  * a null module name.
187 #define ACPI_MODULE_NAME(name)  argument
188 #define _acpi_module_name ""
195 #define AE_INFO                         _acpi_module_name, __LINE__
196 #define ACPI_ONCE(_fn, _plist)                  { static char _done; if (!_done) { _done = 1; _fn _…
200  * the plist contains a set of parens to allow variable-length lists.
201  * These macros are used for both the debug and non-debug versions of the code.
203 #define ACPI_INFO(plist)                acpi_info plist
204 #define ACPI_WARNING(plist)             acpi_warning plist
205 #define ACPI_WARNING_ONCE(plist)        ACPI_ONCE(acpi_warning, plist)
206 #define ACPI_EXCEPTION(plist)           acpi_exception plist
207 #define ACPI_ERROR(plist)               acpi_error plist
208 #define ACPI_ERROR_ONCE(plist)          ACPI_ONCE(acpi_error, plist)
209 #define ACPI_BIOS_WARNING(plist)        acpi_bios_warning plist
210 #define ACPI_BIOS_EXCEPTION(plist)      acpi_bios_exception plist
211 #define ACPI_BIOS_ERROR(plist)          acpi_bios_error plist
212 #define ACPI_DEBUG_OBJECT(obj,l,i)      acpi_ex_do_debug_object(obj,l,i)
218 #define ACPI_INFO(plist)
219 #define ACPI_WARNING(plist)
220 #define ACPI_WARNING_ONCE(plist)
221 #define ACPI_EXCEPTION(plist)
222 #define ACPI_ERROR(plist)
223 #define ACPI_ERROR_ONCE(plist)
224 #define ACPI_BIOS_WARNING(plist)
225 #define ACPI_BIOS_EXCEPTION(plist)
226 #define ACPI_BIOS_ERROR(plist)
227 #define ACPI_DEBUG_OBJECT(obj,l,i)
237  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
238  * define it now. This is the case where there the compiler does not support
242 #define ACPI_GET_FUNCTION_NAME          _acpi_function_name
245  * The Name parameter should be the procedure name as a non-quoted string.
246  * The function name is also used by the function exit macros below.
250 #define ACPI_FUNCTION_NAME(name)        static const char _acpi_function_name[] = #name;  argument
253 /* Compiler supports __func__ (or equivalent) -- Ignore this macro */
255 #define ACPI_FUNCTION_NAME(name)  argument
260  * line number, function name, module(file) name, component ID
262 #define ACPI_DEBUG_PARAMETERS \
267 #define ACPI_IS_DEBUG_ENABLED(level, component) \
286 #define ACPI_DO_WHILE0(a)               do a while(0)
288 #define ACPI_DO_WHILE0(a)               a
295 #define ACPI_DEBUG_PRINT(plist)         acpi_debug_print plist
296 #define ACPI_DEBUG_PRINT_RAW(plist)     acpi_debug_print_raw plist
302 #define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
310 #define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
314 #define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
318 #define ACPI_DEBUG_PRINT(plist)         ACPI_ACTUAL_DEBUG plist
319 #define ACPI_DEBUG_PRINT_RAW(plist)     ACPI_ACTUAL_DEBUG_RAW plist
326  * The name of the function is emitted as a local variable that is
332 #define ACPI_TRACE_ENTRY(name, function, type, param) \  argument
333 	ACPI_FUNCTION_NAME (name) \
338 #define ACPI_FUNCTION_TRACE(name) \  argument
339 	ACPI_FUNCTION_NAME(name) \
342 #define ACPI_FUNCTION_TRACE_PTR(name, pointer) \  argument
343 	ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
345 #define ACPI_FUNCTION_TRACE_U32(name, value) \  argument
346 	ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
348 #define ACPI_FUNCTION_TRACE_STR(name, string) \  argument
349 	ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, const char *, string)
351 #define ACPI_FUNCTION_ENTRY() \
365  * safer, since it avoids side-effects by guaranteeing that the argument will
368  * A less-safe version of the macros is provided for optional use if the
377 #define ACPI_TRACE_EXIT(function, type, param) \
384 #else				/* Use original less-safe macros */
386 #define ACPI_TRACE_EXIT(function, type, param) \
396 #define return_VOID \
402 #define return_ACPI_STATUS(status) \
405 #define return_PTR(pointer) \
408 #define return_STR(string) \
411 #define return_VALUE(value) \
414 #define return_UINT32(value) \
417 #define return_UINT8(value) \
422 #define ACPI_DEBUG_EXEC(a)              a
423 #define ACPI_DEBUG_ONLY_MEMBERS(a)      a
424 #define _VERBOSE_STRUCTURES
428 #define ACPI_DUMP_STACK_ENTRY(a)        acpi_ex_dump_operand((a), 0)
429 #define ACPI_DUMP_OPERANDS(a, b ,c)     acpi_ex_dump_operands(a, b, c)  argument
430 #define ACPI_DUMP_ENTRY(a, b)           acpi_ns_dump_entry (a, b)
431 #define ACPI_DUMP_PATHNAME(a, b, c, d)  acpi_ns_dump_pathname(a, b, c, d)  argument
432 #define ACPI_DUMP_BUFFER(a, b)          acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _CO…
434 #define ACPI_TRACE_POINT(a, b, c, d)    acpi_trace_point (a, b, c, d)  argument
438  * This is the non-debug case -- make everything go away,
441 #define ACPI_DEBUG_PRINT(pl)
442 #define ACPI_DEBUG_PRINT_RAW(pl)
443 #define ACPI_DEBUG_EXEC(a)
444 #define ACPI_DEBUG_ONLY_MEMBERS(a)
445 #define ACPI_FUNCTION_NAME(a)
446 #define ACPI_FUNCTION_TRACE(a)
447 #define ACPI_FUNCTION_TRACE_PTR(a, b)
448 #define ACPI_FUNCTION_TRACE_U32(a, b)
449 #define ACPI_FUNCTION_TRACE_STR(a, b)
450 #define ACPI_FUNCTION_ENTRY()
451 #define ACPI_DUMP_STACK_ENTRY(a)
452 #define ACPI_DUMP_OPERANDS(a, b, c)  argument
453 #define ACPI_DUMP_ENTRY(a, b)
454 #define ACPI_DUMP_PATHNAME(a, b, c, d)  argument
455 #define ACPI_DUMP_BUFFER(a, b)
456 #define ACPI_IS_DEBUG_ENABLED(level, component) 0
457 #define ACPI_TRACE_POINT(a, b, c, d)  argument
461 #define return_VOID                     return
462 #define return_ACPI_STATUS(s)           return(s)
463 #define return_PTR(s)                   return(s)
464 #define return_STR(s)                   return(s)
465 #define return_VALUE(s)                 return(s)
466 #define return_UINT8(s)                 return(s)
467 #define return_UINT32(s)                return(s)