1 /* SPDX-License-Identifier: BSD-3-Clause OR GP 1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /********************************************* 2 /******************************************************************************
3 * 3 *
4 * Name: acoutput.h -- debug output 4 * Name: acoutput.h -- debug output
5 * 5 *
6 * Copyright (C) 2000 - 2023, Intel Corp. !! 6 * Copyright (C) 2000 - 2018, Intel Corp.
7 * 7 *
8 ********************************************* 8 *****************************************************************************/
9 9
10 #ifndef __ACOUTPUT_H__ 10 #ifndef __ACOUTPUT_H__
11 #define __ACOUTPUT_H__ 11 #define __ACOUTPUT_H__
12 12
13 /* 13 /*
14 * Debug levels and component IDs. These are u 14 * Debug levels and component IDs. These are used to control the
15 * granularity of the output of the ACPI_DEBUG 15 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
16 * per-component basis and a per-exception-typ 16 * per-component basis and a per-exception-type basis.
17 */ 17 */
18 18
19 /* Component IDs are used in the global "Debug 19 /* Component IDs are used in the global "DebugLayer" */
20 20
21 #define ACPI_UTILITIES 0x00000001 21 #define ACPI_UTILITIES 0x00000001
22 #define ACPI_HARDWARE 0x00000002 22 #define ACPI_HARDWARE 0x00000002
23 #define ACPI_EVENTS 0x00000004 23 #define ACPI_EVENTS 0x00000004
24 #define ACPI_TABLES 0x00000008 24 #define ACPI_TABLES 0x00000008
25 #define ACPI_NAMESPACE 0x00000010 25 #define ACPI_NAMESPACE 0x00000010
26 #define ACPI_PARSER 0x00000020 26 #define ACPI_PARSER 0x00000020
27 #define ACPI_DISPATCHER 0x00000040 27 #define ACPI_DISPATCHER 0x00000040
28 #define ACPI_EXECUTER 0x00000080 28 #define ACPI_EXECUTER 0x00000080
29 #define ACPI_RESOURCES 0x00000100 29 #define ACPI_RESOURCES 0x00000100
30 #define ACPI_CA_DEBUGGER 0x00000200 30 #define ACPI_CA_DEBUGGER 0x00000200
31 #define ACPI_OS_SERVICES 0x00000400 31 #define ACPI_OS_SERVICES 0x00000400
32 #define ACPI_CA_DISASSEMBLER 0x00000800 32 #define ACPI_CA_DISASSEMBLER 0x00000800
33 33
34 /* Component IDs for ACPI tools and utilities 34 /* Component IDs for ACPI tools and utilities */
35 35
36 #define ACPI_COMPILER 0x00001000 36 #define ACPI_COMPILER 0x00001000
37 #define ACPI_TOOLS 0x00002000 37 #define ACPI_TOOLS 0x00002000
38 #define ACPI_EXAMPLE 0x00004000 38 #define ACPI_EXAMPLE 0x00004000
39 #define ACPI_DRIVER 0x00008000 39 #define ACPI_DRIVER 0x00008000
40 #define DT_COMPILER 0x00010000 40 #define DT_COMPILER 0x00010000
41 #define ASL_PREPROCESSOR 0x00020000 41 #define ASL_PREPROCESSOR 0x00020000
42 42
43 #define ACPI_ALL_COMPONENTS 0x0001FFFF 43 #define ACPI_ALL_COMPONENTS 0x0001FFFF
44 #define ACPI_COMPONENT_DEFAULT (ACPI_ALL_ 44 #define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
45 45
46 /* Component IDs reserved for ACPI drivers */ 46 /* Component IDs reserved for ACPI drivers */
47 47
48 #define ACPI_ALL_DRIVERS 0xFFFF0000 48 #define ACPI_ALL_DRIVERS 0xFFFF0000
49 49
50 /* 50 /*
51 * Raw debug output levels, do not use these i 51 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
52 */ 52 */
53 #define ACPI_LV_INIT 0x00000001 53 #define ACPI_LV_INIT 0x00000001
54 #define ACPI_LV_DEBUG_OBJECT 0x00000002 54 #define ACPI_LV_DEBUG_OBJECT 0x00000002
55 #define ACPI_LV_INFO 0x00000004 55 #define ACPI_LV_INFO 0x00000004
56 #define ACPI_LV_REPAIR 0x00000008 56 #define ACPI_LV_REPAIR 0x00000008
57 #define ACPI_LV_TRACE_POINT 0x00000010 57 #define ACPI_LV_TRACE_POINT 0x00000010
58 #define ACPI_LV_ALL_EXCEPTIONS 0x0000001F 58 #define ACPI_LV_ALL_EXCEPTIONS 0x0000001F
59 59
60 /* Trace verbosity level 1 [Standard Trace Lev 60 /* Trace verbosity level 1 [Standard Trace Level] */
61 61
62 #define ACPI_LV_INIT_NAMES 0x00000020 62 #define ACPI_LV_INIT_NAMES 0x00000020
63 #define ACPI_LV_PARSE 0x00000040 63 #define ACPI_LV_PARSE 0x00000040
64 #define ACPI_LV_LOAD 0x00000080 64 #define ACPI_LV_LOAD 0x00000080
65 #define ACPI_LV_DISPATCH 0x00000100 65 #define ACPI_LV_DISPATCH 0x00000100
66 #define ACPI_LV_EXEC 0x00000200 66 #define ACPI_LV_EXEC 0x00000200
67 #define ACPI_LV_NAMES 0x00000400 67 #define ACPI_LV_NAMES 0x00000400
68 #define ACPI_LV_OPREGION 0x00000800 68 #define ACPI_LV_OPREGION 0x00000800
69 #define ACPI_LV_BFIELD 0x00001000 69 #define ACPI_LV_BFIELD 0x00001000
70 #define ACPI_LV_TABLES 0x00002000 70 #define ACPI_LV_TABLES 0x00002000
71 #define ACPI_LV_VALUES 0x00004000 71 #define ACPI_LV_VALUES 0x00004000
72 #define ACPI_LV_OBJECTS 0x00008000 72 #define ACPI_LV_OBJECTS 0x00008000
73 #define ACPI_LV_RESOURCES 0x00010000 73 #define ACPI_LV_RESOURCES 0x00010000
74 #define ACPI_LV_USER_REQUESTS 0x00020000 74 #define ACPI_LV_USER_REQUESTS 0x00020000
75 #define ACPI_LV_PACKAGE 0x00040000 75 #define ACPI_LV_PACKAGE 0x00040000
76 #define ACPI_LV_EVALUATION 0x00080000 !! 76 #define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
77 #define ACPI_LV_VERBOSITY1 0x000FFF40 <<
78 77
79 /* Trace verbosity level 2 [Function tracing a 78 /* Trace verbosity level 2 [Function tracing and memory allocation] */
80 79
81 #define ACPI_LV_ALLOCATIONS 0x00100000 80 #define ACPI_LV_ALLOCATIONS 0x00100000
82 #define ACPI_LV_FUNCTIONS 0x00200000 81 #define ACPI_LV_FUNCTIONS 0x00200000
83 #define ACPI_LV_OPTIMIZATIONS 0x00400000 82 #define ACPI_LV_OPTIMIZATIONS 0x00400000
84 #define ACPI_LV_PARSE_TREES 0x00800000 83 #define ACPI_LV_PARSE_TREES 0x00800000
85 #define ACPI_LV_VERBOSITY2 0x00F00000 84 #define ACPI_LV_VERBOSITY2 0x00F00000 | ACPI_LV_VERBOSITY1
86 #define ACPI_LV_ALL ACPI_LV_VE 85 #define ACPI_LV_ALL ACPI_LV_VERBOSITY2
87 86
88 /* Trace verbosity level 3 [Threading, I/O, an 87 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
89 88
90 #define ACPI_LV_MUTEX 0x01000000 89 #define ACPI_LV_MUTEX 0x01000000
91 #define ACPI_LV_THREADS 0x02000000 90 #define ACPI_LV_THREADS 0x02000000
92 #define ACPI_LV_IO 0x04000000 91 #define ACPI_LV_IO 0x04000000
93 #define ACPI_LV_INTERRUPTS 0x08000000 92 #define ACPI_LV_INTERRUPTS 0x08000000
94 #define ACPI_LV_VERBOSITY3 0x0F000000 93 #define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
95 94
96 /* Exceptionally verbose output -- also used i 95 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
97 96
98 #define ACPI_LV_AML_DISASSEMBLE 0x10000000 97 #define ACPI_LV_AML_DISASSEMBLE 0x10000000
99 #define ACPI_LV_VERBOSE_INFO 0x20000000 98 #define ACPI_LV_VERBOSE_INFO 0x20000000
100 #define ACPI_LV_FULL_TABLES 0x40000000 99 #define ACPI_LV_FULL_TABLES 0x40000000
101 #define ACPI_LV_EVENTS 0x80000000 100 #define ACPI_LV_EVENTS 0x80000000
102 #define ACPI_LV_VERBOSE 0xF0000000 101 #define ACPI_LV_VERBOSE 0xF0000000
103 102
104 /* 103 /*
105 * Debug level macros that are used in the DEB 104 * Debug level macros that are used in the DEBUG_PRINT macros
106 */ 105 */
107 #define ACPI_DEBUG_LEVEL(dl) (u32) dl,A 106 #define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
108 107
109 /* 108 /*
110 * Exception level -- used in the global "Debu 109 * Exception level -- used in the global "DebugLevel"
111 * 110 *
112 * Note: For errors, use the ACPI_ERROR or ACP 111 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
113 * For warnings, use ACPI_WARNING. 112 * For warnings, use ACPI_WARNING.
114 */ 113 */
115 #define ACPI_DB_INIT ACPI_DEBUG 114 #define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
116 #define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG 115 #define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
117 #define ACPI_DB_INFO ACPI_DEBUG 116 #define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
118 #define ACPI_DB_REPAIR ACPI_DEBUG 117 #define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
119 #define ACPI_DB_TRACE_POINT ACPI_DEBUG 118 #define ACPI_DB_TRACE_POINT ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
120 #define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG 119 #define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
121 120
122 /* Trace level -- also used in the global "Deb 121 /* Trace level -- also used in the global "DebugLevel" */
123 122
124 #define ACPI_DB_INIT_NAMES ACPI_DEBUG 123 #define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
125 #define ACPI_DB_THREADS ACPI_DEBUG 124 #define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
126 #define ACPI_DB_PARSE ACPI_DEBUG 125 #define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
127 #define ACPI_DB_DISPATCH ACPI_DEBUG 126 #define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
128 #define ACPI_DB_LOAD ACPI_DEBUG 127 #define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
129 #define ACPI_DB_EXEC ACPI_DEBUG 128 #define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
130 #define ACPI_DB_NAMES ACPI_DEBUG 129 #define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
131 #define ACPI_DB_OPREGION ACPI_DEBUG 130 #define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
132 #define ACPI_DB_BFIELD ACPI_DEBUG 131 #define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
133 #define ACPI_DB_TABLES ACPI_DEBUG 132 #define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
134 #define ACPI_DB_FUNCTIONS ACPI_DEBUG 133 #define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
135 #define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG 134 #define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
136 #define ACPI_DB_PARSE_TREES ACPI_DEBUG 135 #define ACPI_DB_PARSE_TREES ACPI_DEBUG_LEVEL (ACPI_LV_PARSE_TREES)
137 #define ACPI_DB_VALUES ACPI_DEBUG 136 #define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
138 #define ACPI_DB_OBJECTS ACPI_DEBUG 137 #define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
139 #define ACPI_DB_ALLOCATIONS ACPI_DEBUG 138 #define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
140 #define ACPI_DB_RESOURCES ACPI_DEBUG 139 #define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
141 #define ACPI_DB_IO ACPI_DEBUG 140 #define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
142 #define ACPI_DB_INTERRUPTS ACPI_DEBUG 141 #define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
143 #define ACPI_DB_USER_REQUESTS ACPI_DEBUG 142 #define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
144 #define ACPI_DB_PACKAGE ACPI_DEBUG 143 #define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
145 #define ACPI_DB_EVALUATION ACPI_DEBUG <<
146 #define ACPI_DB_MUTEX ACPI_DEBUG 144 #define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
147 #define ACPI_DB_EVENTS ACPI_DEBUG 145 #define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
148 146
149 #define ACPI_DB_ALL ACPI_DEBUG 147 #define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
150 148
151 /* Defaults for debug_level, debug and normal 149 /* Defaults for debug_level, debug and normal */
152 150
153 #ifndef ACPI_DEBUG_DEFAULT !! 151 #define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR)
154 #define ACPI_DEBUG_DEFAULT (ACPI_LV_I <<
155 #endif <<
156 <<
157 #define ACPI_NORMAL_DEFAULT (ACPI_LV_I 152 #define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
158 #define ACPI_DEBUG_ALL (ACPI_LV_A 153 #define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
159 154
160 /* 155 /*
161 * Global trace flags 156 * Global trace flags
162 */ 157 */
163 #define ACPI_TRACE_ENABLED ((u32) 4) 158 #define ACPI_TRACE_ENABLED ((u32) 4)
164 #define ACPI_TRACE_ONESHOT ((u32) 2) 159 #define ACPI_TRACE_ONESHOT ((u32) 2)
165 #define ACPI_TRACE_OPCODE ((u32) 1) 160 #define ACPI_TRACE_OPCODE ((u32) 1)
166 161
167 /* Defaults for trace debugging level/layer */ 162 /* Defaults for trace debugging level/layer */
168 163
169 #define ACPI_TRACE_LEVEL_ALL ACPI_LV_AL 164 #define ACPI_TRACE_LEVEL_ALL ACPI_LV_ALL
170 #define ACPI_TRACE_LAYER_ALL 0x000001FF 165 #define ACPI_TRACE_LAYER_ALL 0x000001FF
171 #define ACPI_TRACE_LEVEL_DEFAULT ACPI_LV_TR 166 #define ACPI_TRACE_LEVEL_DEFAULT ACPI_LV_TRACE_POINT
172 #define ACPI_TRACE_LAYER_DEFAULT ACPI_EXECU 167 #define ACPI_TRACE_LAYER_DEFAULT ACPI_EXECUTER
173 168
174 #if defined (ACPI_DEBUG_OUTPUT) || !defined (A 169 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
175 /* 170 /*
176 * The module name is used primarily for error 171 * The module name is used primarily for error and debug messages.
177 * The __FILE__ macro is not very useful for t 172 * The __FILE__ macro is not very useful for this, because it
178 * usually includes the entire pathname to the 173 * usually includes the entire pathname to the module making the
179 * debug output difficult to read. 174 * debug output difficult to read.
180 */ 175 */
181 #define ACPI_MODULE_NAME(name) static 176 #define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
182 #else 177 #else
183 /* 178 /*
184 * For the no-debug and no-error-msg cases, we 179 * For the no-debug and no-error-msg cases, we must at least define
185 * a null module name. 180 * a null module name.
186 */ 181 */
187 #define ACPI_MODULE_NAME(name) 182 #define ACPI_MODULE_NAME(name)
188 #define _acpi_module_name "" 183 #define _acpi_module_name ""
189 #endif 184 #endif
190 185
191 /* 186 /*
192 * Ascii error messages can be configured out 187 * Ascii error messages can be configured out
193 */ 188 */
194 #ifndef ACPI_NO_ERROR_MESSAGES 189 #ifndef ACPI_NO_ERROR_MESSAGES
195 #define AE_INFO _acpi_ 190 #define AE_INFO _acpi_module_name, __LINE__
196 #define ACPI_ONCE(_fn, _plist) <<
197 191
198 /* 192 /*
199 * Error reporting. Callers module and line nu 193 * Error reporting. Callers module and line number are inserted by AE_INFO,
200 * the plist contains a set of parens to allow 194 * the plist contains a set of parens to allow variable-length lists.
201 * These macros are used for both the debug an 195 * These macros are used for both the debug and non-debug versions of the code.
202 */ 196 */
203 #define ACPI_INFO(plist) acpi_i 197 #define ACPI_INFO(plist) acpi_info plist
204 #define ACPI_WARNING(plist) acpi_w 198 #define ACPI_WARNING(plist) acpi_warning plist
205 #define ACPI_WARNING_ONCE(plist) ACPI_O <<
206 #define ACPI_EXCEPTION(plist) acpi_e 199 #define ACPI_EXCEPTION(plist) acpi_exception plist
207 #define ACPI_ERROR(plist) acpi_e 200 #define ACPI_ERROR(plist) acpi_error plist
208 #define ACPI_ERROR_ONCE(plist) ACPI_O <<
209 #define ACPI_BIOS_WARNING(plist) acpi_b 201 #define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
210 #define ACPI_BIOS_EXCEPTION(plist) acpi_b <<
211 #define ACPI_BIOS_ERROR(plist) acpi_b 202 #define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
212 #define ACPI_DEBUG_OBJECT(obj,l,i) acpi_e 203 #define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
213 204
214 #else 205 #else
215 206
216 /* No error messages */ 207 /* No error messages */
217 208
218 #define ACPI_INFO(plist) 209 #define ACPI_INFO(plist)
219 #define ACPI_WARNING(plist) 210 #define ACPI_WARNING(plist)
220 #define ACPI_WARNING_ONCE(plist) <<
221 #define ACPI_EXCEPTION(plist) 211 #define ACPI_EXCEPTION(plist)
222 #define ACPI_ERROR(plist) 212 #define ACPI_ERROR(plist)
223 #define ACPI_ERROR_ONCE(plist) <<
224 #define ACPI_BIOS_WARNING(plist) 213 #define ACPI_BIOS_WARNING(plist)
225 #define ACPI_BIOS_EXCEPTION(plist) <<
226 #define ACPI_BIOS_ERROR(plist) 214 #define ACPI_BIOS_ERROR(plist)
227 #define ACPI_DEBUG_OBJECT(obj,l,i) 215 #define ACPI_DEBUG_OBJECT(obj,l,i)
228 216
229 #endif /* ACPI_NO_ERR 217 #endif /* ACPI_NO_ERROR_MESSAGES */
230 218
231 /* 219 /*
232 * Debug macros that are conditionally compile 220 * Debug macros that are conditionally compiled
233 */ 221 */
234 #ifdef ACPI_DEBUG_OUTPUT 222 #ifdef ACPI_DEBUG_OUTPUT
235 223
236 /* 224 /*
237 * If ACPI_GET_FUNCTION_NAME was not defined i 225 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
238 * define it now. This is the case where there 226 * define it now. This is the case where there the compiler does not support
239 * a __func__ macro or equivalent. 227 * a __func__ macro or equivalent.
240 */ 228 */
241 #ifndef ACPI_GET_FUNCTION_NAME 229 #ifndef ACPI_GET_FUNCTION_NAME
242 #define ACPI_GET_FUNCTION_NAME _acpi_ 230 #define ACPI_GET_FUNCTION_NAME _acpi_function_name
243 231
244 /* 232 /*
245 * The Name parameter should be the procedure 233 * The Name parameter should be the procedure name as a non-quoted string.
246 * The function name is also used by the funct 234 * The function name is also used by the function exit macros below.
247 * Note: (const char) is used to be compatible 235 * Note: (const char) is used to be compatible with the debug interfaces
248 * and macros such as __func__. 236 * and macros such as __func__.
249 */ 237 */
250 #define ACPI_FUNCTION_NAME(name) static 238 #define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
251 239
252 #else 240 #else
253 /* Compiler supports __func__ (or equivalent) 241 /* Compiler supports __func__ (or equivalent) -- Ignore this macro */
254 242
255 #define ACPI_FUNCTION_NAME(name) 243 #define ACPI_FUNCTION_NAME(name)
256 #endif /* ACPI_GET_FU 244 #endif /* ACPI_GET_FUNCTION_NAME */
257 245
258 /* 246 /*
259 * Common parameters used for debug output fun 247 * Common parameters used for debug output functions:
260 * line number, function name, module(file) na 248 * line number, function name, module(file) name, component ID
261 */ 249 */
262 #define ACPI_DEBUG_PARAMETERS \ 250 #define ACPI_DEBUG_PARAMETERS \
263 __LINE__, ACPI_GET_FUNCTION_NAME, _acp 251 __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
264 252
265 /* Check if debug output is currently dynamica 253 /* Check if debug output is currently dynamically enabled */
266 254
267 #define ACPI_IS_DEBUG_ENABLED(level, component 255 #define ACPI_IS_DEBUG_ENABLED(level, component) \
268 ((level & acpi_dbg_level) && (componen 256 ((level & acpi_dbg_level) && (component & acpi_dbg_layer))
269 257
270 /* 258 /*
271 * Master debug print macros 259 * Master debug print macros
272 * Print message if and only if: 260 * Print message if and only if:
273 * 1) Debug print for the current component 261 * 1) Debug print for the current component is enabled
274 * 2) Debug error level or trace level for 262 * 2) Debug error level or trace level for the print statement is enabled
275 * 263 *
276 * November 2012: Moved the runtime check for 264 * November 2012: Moved the runtime check for whether to actually emit the
277 * debug message outside of the print function 265 * debug message outside of the print function itself. This improves overall
278 * performance at a relatively small code cost 266 * performance at a relatively small code cost. Implementation involves the
279 * use of variadic macros supported by C99. 267 * use of variadic macros supported by C99.
280 * 268 *
281 * Note: the ACPI_DO_WHILE0 macro is used to p 269 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
282 * complaining about these constructs. On othe 270 * complaining about these constructs. On other compilers the do...while
283 * adds some extra code, so this feature is op 271 * adds some extra code, so this feature is optional.
284 */ 272 */
285 #ifdef ACPI_USE_DO_WHILE_0 273 #ifdef ACPI_USE_DO_WHILE_0
286 #define ACPI_DO_WHILE0(a) do a w 274 #define ACPI_DO_WHILE0(a) do a while(0)
287 #else 275 #else
288 #define ACPI_DO_WHILE0(a) a 276 #define ACPI_DO_WHILE0(a) a
289 #endif 277 #endif
290 278
291 /* DEBUG_PRINT functions */ 279 /* DEBUG_PRINT functions */
292 280
293 #ifndef COMPILER_VA_MACRO 281 #ifndef COMPILER_VA_MACRO
294 282
295 #define ACPI_DEBUG_PRINT(plist) acpi_d 283 #define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
296 #define ACPI_DEBUG_PRINT_RAW(plist) acpi_d 284 #define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
297 285
298 #else 286 #else
299 287
300 /* Helper macros for DEBUG_PRINT */ 288 /* Helper macros for DEBUG_PRINT */
301 289
302 #define ACPI_DO_DEBUG_PRINT(function, level, l 290 #define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
303 ACPI_DO_WHILE0 ({ \ 291 ACPI_DO_WHILE0 ({ \
304 if (ACPI_IS_DEBUG_ENABLED (lev 292 if (ACPI_IS_DEBUG_ENABLED (level, component)) \
305 { \ 293 { \
306 function (level, line, 294 function (level, line, filename, modulename, component, __VA_ARGS__); \
307 } \ 295 } \
308 }) 296 })
309 297
310 #define ACPI_ACTUAL_DEBUG(level, line, filenam 298 #define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
311 ACPI_DO_DEBUG_PRINT (acpi_debug_print, 299 ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
312 filename, modulename, componen 300 filename, modulename, component, __VA_ARGS__)
313 301
314 #define ACPI_ACTUAL_DEBUG_RAW(level, line, fil 302 #define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
315 ACPI_DO_DEBUG_PRINT (acpi_debug_print_ 303 ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
316 filename, modulename, componen 304 filename, modulename, component, __VA_ARGS__)
317 305
318 #define ACPI_DEBUG_PRINT(plist) ACPI_A 306 #define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
319 #define ACPI_DEBUG_PRINT_RAW(plist) ACPI_A 307 #define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
320 308
321 #endif 309 #endif
322 310
323 /* 311 /*
324 * Function entry tracing 312 * Function entry tracing
325 * 313 *
326 * The name of the function is emitted as a lo 314 * The name of the function is emitted as a local variable that is
327 * intended to be used by both the entry trace 315 * intended to be used by both the entry trace and the exit trace.
328 */ 316 */
329 317
330 /* Helper macro */ 318 /* Helper macro */
331 319
332 #define ACPI_TRACE_ENTRY(name, function, type, 320 #define ACPI_TRACE_ENTRY(name, function, type, param) \
333 ACPI_FUNCTION_NAME (name) \ 321 ACPI_FUNCTION_NAME (name) \
334 function (ACPI_DEBUG_PARAMETERS, (type 322 function (ACPI_DEBUG_PARAMETERS, (type) (param))
335 323
336 /* The actual entry trace macros */ 324 /* The actual entry trace macros */
337 325
338 #define ACPI_FUNCTION_TRACE(name) \ 326 #define ACPI_FUNCTION_TRACE(name) \
339 ACPI_FUNCTION_NAME(name) \ 327 ACPI_FUNCTION_NAME(name) \
340 acpi_ut_trace (ACPI_DEBUG_PARAMETERS) 328 acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
341 329
342 #define ACPI_FUNCTION_TRACE_PTR(name, pointer) 330 #define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
343 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ 331 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
344 332
345 #define ACPI_FUNCTION_TRACE_U32(name, value) \ 333 #define ACPI_FUNCTION_TRACE_U32(name, value) \
346 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ 334 ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
347 335
348 #define ACPI_FUNCTION_TRACE_STR(name, string) 336 #define ACPI_FUNCTION_TRACE_STR(name, string) \
349 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ 337 ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, const char *, string)
350 338
351 #define ACPI_FUNCTION_ENTRY() \ 339 #define ACPI_FUNCTION_ENTRY() \
352 acpi_ut_track_stack_ptr() 340 acpi_ut_track_stack_ptr()
353 341
354 /* 342 /*
355 * Function exit tracing 343 * Function exit tracing
356 * 344 *
357 * These macros include a return statement. Th 345 * These macros include a return statement. This is usually considered
358 * bad form, but having a separate exit macro 346 * bad form, but having a separate exit macro before the actual return
359 * is very ugly and difficult to maintain. 347 * is very ugly and difficult to maintain.
360 * 348 *
361 * One of the FUNCTION_TRACE macros above must 349 * One of the FUNCTION_TRACE macros above must be used in conjunction
362 * with these macros so that "_AcpiFunctionNam 350 * with these macros so that "_AcpiFunctionName" is defined.
363 * 351 *
364 * There are two versions of most of the retur 352 * There are two versions of most of the return macros. The default version is
365 * safer, since it avoids side-effects by guar 353 * safer, since it avoids side-effects by guaranteeing that the argument will
366 * not be evaluated twice. 354 * not be evaluated twice.
367 * 355 *
368 * A less-safe version of the macros is provid 356 * A less-safe version of the macros is provided for optional use if the
369 * compiler uses excessive CPU stack (for exam 357 * compiler uses excessive CPU stack (for example, this may happen in the
370 * debug case if code optimization is disabled !! 358 * debug case if code optimzation is disabled.)
371 */ 359 */
372 360
373 /* Exit trace helper macro */ 361 /* Exit trace helper macro */
374 362
375 #ifndef ACPI_SIMPLE_RETURN_MACROS 363 #ifndef ACPI_SIMPLE_RETURN_MACROS
376 364
377 #define ACPI_TRACE_EXIT(function, type, param) 365 #define ACPI_TRACE_EXIT(function, type, param) \
378 ACPI_DO_WHILE0 ({ \ 366 ACPI_DO_WHILE0 ({ \
379 register type _param = (type) 367 register type _param = (type) (param); \
380 function (ACPI_DEBUG_PARAMETER 368 function (ACPI_DEBUG_PARAMETERS, _param); \
381 return (_param); \ 369 return (_param); \
382 }) 370 })
383 371
384 #else /* Use origina 372 #else /* Use original less-safe macros */
385 373
386 #define ACPI_TRACE_EXIT(function, type, param) 374 #define ACPI_TRACE_EXIT(function, type, param) \
387 ACPI_DO_WHILE0 ({ \ 375 ACPI_DO_WHILE0 ({ \
388 function (ACPI_DEBUG_PARAMETER 376 function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
389 return (param); \ 377 return (param); \
390 }) 378 })
391 379
392 #endif /* ACPI_SIMPLE 380 #endif /* ACPI_SIMPLE_RETURN_MACROS */
393 381
394 /* The actual exit macros */ 382 /* The actual exit macros */
395 383
396 #define return_VOID \ 384 #define return_VOID \
397 ACPI_DO_WHILE0 ({ \ 385 ACPI_DO_WHILE0 ({ \
398 acpi_ut_exit (ACPI_DEBUG_PARAM 386 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
399 return; \ 387 return; \
400 }) 388 })
401 389
402 #define return_ACPI_STATUS(status) \ 390 #define return_ACPI_STATUS(status) \
403 ACPI_TRACE_EXIT (acpi_ut_status_exit, 391 ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
404 392
405 #define return_PTR(pointer) \ 393 #define return_PTR(pointer) \
406 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, voi 394 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
407 395
408 #define return_STR(string) \ 396 #define return_STR(string) \
409 ACPI_TRACE_EXIT (acpi_ut_str_exit, con 397 ACPI_TRACE_EXIT (acpi_ut_str_exit, const char *, string)
410 398
411 #define return_VALUE(value) \ 399 #define return_VALUE(value) \
412 ACPI_TRACE_EXIT (acpi_ut_value_exit, u 400 ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
413 401
414 #define return_UINT32(value) \ 402 #define return_UINT32(value) \
415 ACPI_TRACE_EXIT (acpi_ut_value_exit, u 403 ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
416 404
417 #define return_UINT8(value) \ 405 #define return_UINT8(value) \
418 ACPI_TRACE_EXIT (acpi_ut_value_exit, u 406 ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
419 407
420 /* Conditional execution */ 408 /* Conditional execution */
421 409
422 #define ACPI_DEBUG_EXEC(a) a 410 #define ACPI_DEBUG_EXEC(a) a
423 #define ACPI_DEBUG_ONLY_MEMBERS(a) a !! 411 #define ACPI_DEBUG_ONLY_MEMBERS(a) a;
424 #define _VERBOSE_STRUCTURES 412 #define _VERBOSE_STRUCTURES
425 413
426 /* Various object display routines for debug * 414 /* Various object display routines for debug */
427 415
428 #define ACPI_DUMP_STACK_ENTRY(a) acpi_e 416 #define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
429 #define ACPI_DUMP_OPERANDS(a, b ,c) acpi_e 417 #define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
430 #define ACPI_DUMP_ENTRY(a, b) acpi_n 418 #define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
431 #define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_n 419 #define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
432 #define ACPI_DUMP_BUFFER(a, b) acpi_u 420 #define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
433 421
434 #define ACPI_TRACE_POINT(a, b, c, d) acpi_t 422 #define ACPI_TRACE_POINT(a, b, c, d) acpi_trace_point (a, b, c, d)
435 423
436 #else /* ACPI_DEBUG_ 424 #else /* ACPI_DEBUG_OUTPUT */
437 /* 425 /*
438 * This is the non-debug case -- make everythi 426 * This is the non-debug case -- make everything go away,
439 * leaving no executable debug code! 427 * leaving no executable debug code!
440 */ 428 */
441 #define ACPI_DEBUG_PRINT(pl) 429 #define ACPI_DEBUG_PRINT(pl)
442 #define ACPI_DEBUG_PRINT_RAW(pl) 430 #define ACPI_DEBUG_PRINT_RAW(pl)
443 #define ACPI_DEBUG_EXEC(a) 431 #define ACPI_DEBUG_EXEC(a)
444 #define ACPI_DEBUG_ONLY_MEMBERS(a) 432 #define ACPI_DEBUG_ONLY_MEMBERS(a)
445 #define ACPI_FUNCTION_NAME(a) 433 #define ACPI_FUNCTION_NAME(a)
446 #define ACPI_FUNCTION_TRACE(a) 434 #define ACPI_FUNCTION_TRACE(a)
447 #define ACPI_FUNCTION_TRACE_PTR(a, b) 435 #define ACPI_FUNCTION_TRACE_PTR(a, b)
448 #define ACPI_FUNCTION_TRACE_U32(a, b) 436 #define ACPI_FUNCTION_TRACE_U32(a, b)
449 #define ACPI_FUNCTION_TRACE_STR(a, b) 437 #define ACPI_FUNCTION_TRACE_STR(a, b)
450 #define ACPI_FUNCTION_ENTRY() 438 #define ACPI_FUNCTION_ENTRY()
451 #define ACPI_DUMP_STACK_ENTRY(a) 439 #define ACPI_DUMP_STACK_ENTRY(a)
452 #define ACPI_DUMP_OPERANDS(a, b, c) 440 #define ACPI_DUMP_OPERANDS(a, b, c)
453 #define ACPI_DUMP_ENTRY(a, b) 441 #define ACPI_DUMP_ENTRY(a, b)
454 #define ACPI_DUMP_PATHNAME(a, b, c, d) 442 #define ACPI_DUMP_PATHNAME(a, b, c, d)
455 #define ACPI_DUMP_BUFFER(a, b) 443 #define ACPI_DUMP_BUFFER(a, b)
456 #define ACPI_IS_DEBUG_ENABLED(level, component 444 #define ACPI_IS_DEBUG_ENABLED(level, component) 0
457 #define ACPI_TRACE_POINT(a, b, c, d) 445 #define ACPI_TRACE_POINT(a, b, c, d)
458 446
459 /* Return macros must have a return statement 447 /* Return macros must have a return statement at the minimum */
460 448
461 #define return_VOID return 449 #define return_VOID return
462 #define return_ACPI_STATUS(s) return 450 #define return_ACPI_STATUS(s) return(s)
463 #define return_PTR(s) return 451 #define return_PTR(s) return(s)
464 #define return_STR(s) return 452 #define return_STR(s) return(s)
465 #define return_VALUE(s) return 453 #define return_VALUE(s) return(s)
466 #define return_UINT8(s) return 454 #define return_UINT8(s) return(s)
467 #define return_UINT32(s) return 455 #define return_UINT32(s) return(s)
468 456
469 #endif /* ACPI_DEBUG_ 457 #endif /* ACPI_DEBUG_OUTPUT */
470 458
471 #endif /* __ACOUTPUT_ 459 #endif /* __ACOUTPUT_H__ */
472 460
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.