1 /* SPDX-License-Identifier: BSD-3-Clause OR GP 1
2 /*********************************************
3 *
4 * Name: acoutput.h -- debug output
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *********************************************
9
10 #ifndef __ACOUTPUT_H__
11 #define __ACOUTPUT_H__
12
13 /*
14 * Debug levels and component IDs. These are u
15 * granularity of the output of the ACPI_DEBUG
16 * per-component basis and a per-exception-typ
17 */
18
19 /* Component IDs are used in the global "Debug
20
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
33
34 /* Component IDs for ACPI tools and utilities
35
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
42
43 #define ACPI_ALL_COMPONENTS 0x0001FFFF
44 #define ACPI_COMPONENT_DEFAULT (ACPI_ALL_
45
46 /* Component IDs reserved for ACPI drivers */
47
48 #define ACPI_ALL_DRIVERS 0xFFFF0000
49
50 /*
51 * Raw debug output levels, do not use these i
52 */
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
59
60 /* Trace verbosity level 1 [Standard Trace Lev
61
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
78
79 /* Trace verbosity level 2 [Function tracing a
80
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
86 #define ACPI_LV_ALL ACPI_LV_VE
87
88 /* Trace verbosity level 3 [Threading, I/O, an
89
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
95
96 /* Exceptionally verbose output -- also used i
97
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
103
104 /*
105 * Debug level macros that are used in the DEB
106 */
107 #define ACPI_DEBUG_LEVEL(dl) (u32) dl,A
108
109 /*
110 * Exception level -- used in the global "Debu
111 *
112 * Note: For errors, use the ACPI_ERROR or ACP
113 * For warnings, use ACPI_WARNING.
114 */
115 #define ACPI_DB_INIT ACPI_DEBUG
116 #define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG
117 #define ACPI_DB_INFO ACPI_DEBUG
118 #define ACPI_DB_REPAIR ACPI_DEBUG
119 #define ACPI_DB_TRACE_POINT ACPI_DEBUG
120 #define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG
121
122 /* Trace level -- also used in the global "Deb
123
124 #define ACPI_DB_INIT_NAMES ACPI_DEBUG
125 #define ACPI_DB_THREADS ACPI_DEBUG
126 #define ACPI_DB_PARSE ACPI_DEBUG
127 #define ACPI_DB_DISPATCH ACPI_DEBUG
128 #define ACPI_DB_LOAD ACPI_DEBUG
129 #define ACPI_DB_EXEC ACPI_DEBUG
130 #define ACPI_DB_NAMES ACPI_DEBUG
131 #define ACPI_DB_OPREGION ACPI_DEBUG
132 #define ACPI_DB_BFIELD ACPI_DEBUG
133 #define ACPI_DB_TABLES ACPI_DEBUG
134 #define ACPI_DB_FUNCTIONS ACPI_DEBUG
135 #define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG
136 #define ACPI_DB_PARSE_TREES ACPI_DEBUG
137 #define ACPI_DB_VALUES ACPI_DEBUG
138 #define ACPI_DB_OBJECTS ACPI_DEBUG
139 #define ACPI_DB_ALLOCATIONS ACPI_DEBUG
140 #define ACPI_DB_RESOURCES ACPI_DEBUG
141 #define ACPI_DB_IO ACPI_DEBUG
142 #define ACPI_DB_INTERRUPTS ACPI_DEBUG
143 #define ACPI_DB_USER_REQUESTS ACPI_DEBUG
144 #define ACPI_DB_PACKAGE ACPI_DEBUG
145 #define ACPI_DB_EVALUATION ACPI_DEBUG
146 #define ACPI_DB_MUTEX ACPI_DEBUG
147 #define ACPI_DB_EVENTS ACPI_DEBUG
148
149 #define ACPI_DB_ALL ACPI_DEBUG
150
151 /* Defaults for debug_level, debug and normal
152
153 #ifndef ACPI_DEBUG_DEFAULT
154 #define ACPI_DEBUG_DEFAULT (ACPI_LV_I
155 #endif
156
157 #define ACPI_NORMAL_DEFAULT (ACPI_LV_I
158 #define ACPI_DEBUG_ALL (ACPI_LV_A
159
160 /*
161 * Global trace flags
162 */
163 #define ACPI_TRACE_ENABLED ((u32) 4)
164 #define ACPI_TRACE_ONESHOT ((u32) 2)
165 #define ACPI_TRACE_OPCODE ((u32) 1)
166
167 /* Defaults for trace debugging level/layer */
168
169 #define ACPI_TRACE_LEVEL_ALL ACPI_LV_AL
170 #define ACPI_TRACE_LAYER_ALL 0x000001FF
171 #define ACPI_TRACE_LEVEL_DEFAULT ACPI_LV_TR
172 #define ACPI_TRACE_LAYER_DEFAULT ACPI_EXECU
173
174 #if defined (ACPI_DEBUG_OUTPUT) || !defined (A
175 /*
176 * The module name is used primarily for error
177 * The __FILE__ macro is not very useful for t
178 * usually includes the entire pathname to the
179 * debug output difficult to read.
180 */
181 #define ACPI_MODULE_NAME(name) static
182 #else
183 /*
184 * For the no-debug and no-error-msg cases, we
185 * a null module name.
186 */
187 #define ACPI_MODULE_NAME(name)
188 #define _acpi_module_name ""
189 #endif
190
191 /*
192 * Ascii error messages can be configured out
193 */
194 #ifndef ACPI_NO_ERROR_MESSAGES
195 #define AE_INFO _acpi_
196 #define ACPI_ONCE(_fn, _plist)
197
198 /*
199 * Error reporting. Callers module and line nu
200 * the plist contains a set of parens to allow
201 * These macros are used for both the debug an
202 */
203 #define ACPI_INFO(plist) acpi_i
204 #define ACPI_WARNING(plist) acpi_w
205 #define ACPI_WARNING_ONCE(plist) ACPI_O
206 #define ACPI_EXCEPTION(plist) acpi_e
207 #define ACPI_ERROR(plist) acpi_e
208 #define ACPI_ERROR_ONCE(plist) ACPI_O
209 #define ACPI_BIOS_WARNING(plist) acpi_b
210 #define ACPI_BIOS_EXCEPTION(plist) acpi_b
211 #define ACPI_BIOS_ERROR(plist) acpi_b
212 #define ACPI_DEBUG_OBJECT(obj,l,i) acpi_e
213
214 #else
215
216 /* No error messages */
217
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)
228
229 #endif /* ACPI_NO_ERR
230
231 /*
232 * Debug macros that are conditionally compile
233 */
234 #ifdef ACPI_DEBUG_OUTPUT
235
236 /*
237 * If ACPI_GET_FUNCTION_NAME was not defined i
238 * define it now. This is the case where there
239 * a __func__ macro or equivalent.
240 */
241 #ifndef ACPI_GET_FUNCTION_NAME
242 #define ACPI_GET_FUNCTION_NAME _acpi_
243
244 /*
245 * The Name parameter should be the procedure
246 * The function name is also used by the funct
247 * Note: (const char) is used to be compatible
248 * and macros such as __func__.
249 */
250 #define ACPI_FUNCTION_NAME(name) static
251
252 #else
253 /* Compiler supports __func__ (or equivalent)
254
255 #define ACPI_FUNCTION_NAME(name)
256 #endif /* ACPI_GET_FU
257
258 /*
259 * Common parameters used for debug output fun
260 * line number, function name, module(file) na
261 */
262 #define ACPI_DEBUG_PARAMETERS \
263 __LINE__, ACPI_GET_FUNCTION_NAME, _acp
264
265 /* Check if debug output is currently dynamica
266
267 #define ACPI_IS_DEBUG_ENABLED(level, component
268 ((level & acpi_dbg_level) && (componen
269
270 /*
271 * Master debug print macros
272 * Print message if and only if:
273 * 1) Debug print for the current component
274 * 2) Debug error level or trace level for
275 *
276 * November 2012: Moved the runtime check for
277 * debug message outside of the print function
278 * performance at a relatively small code cost
279 * use of variadic macros supported by C99.
280 *
281 * Note: the ACPI_DO_WHILE0 macro is used to p
282 * complaining about these constructs. On othe
283 * adds some extra code, so this feature is op
284 */
285 #ifdef ACPI_USE_DO_WHILE_0
286 #define ACPI_DO_WHILE0(a) do a w
287 #else
288 #define ACPI_DO_WHILE0(a) a
289 #endif
290
291 /* DEBUG_PRINT functions */
292
293 #ifndef COMPILER_VA_MACRO
294
295 #define ACPI_DEBUG_PRINT(plist) acpi_d
296 #define ACPI_DEBUG_PRINT_RAW(plist) acpi_d
297
298 #else
299
300 /* Helper macros for DEBUG_PRINT */
301
302 #define ACPI_DO_DEBUG_PRINT(function, level, l
303 ACPI_DO_WHILE0 ({ \
304 if (ACPI_IS_DEBUG_ENABLED (lev
305 { \
306 function (level, line,
307 } \
308 })
309
310 #define ACPI_ACTUAL_DEBUG(level, line, filenam
311 ACPI_DO_DEBUG_PRINT (acpi_debug_print,
312 filename, modulename, componen
313
314 #define ACPI_ACTUAL_DEBUG_RAW(level, line, fil
315 ACPI_DO_DEBUG_PRINT (acpi_debug_print_
316 filename, modulename, componen
317
318 #define ACPI_DEBUG_PRINT(plist) ACPI_A
319 #define ACPI_DEBUG_PRINT_RAW(plist) ACPI_A
320
321 #endif
322
323 /*
324 * Function entry tracing
325 *
326 * The name of the function is emitted as a lo
327 * intended to be used by both the entry trace
328 */
329
330 /* Helper macro */
331
332 #define ACPI_TRACE_ENTRY(name, function, type,
333 ACPI_FUNCTION_NAME (name) \
334 function (ACPI_DEBUG_PARAMETERS, (type
335
336 /* The actual entry trace macros */
337
338 #define ACPI_FUNCTION_TRACE(name) \
339 ACPI_FUNCTION_NAME(name) \
340 acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
341
342 #define ACPI_FUNCTION_TRACE_PTR(name, pointer)
343 ACPI_TRACE_ENTRY (name, acpi_ut_trace_
344
345 #define ACPI_FUNCTION_TRACE_U32(name, value) \
346 ACPI_TRACE_ENTRY (name, acpi_ut_trace_
347
348 #define ACPI_FUNCTION_TRACE_STR(name, string)
349 ACPI_TRACE_ENTRY (name, acpi_ut_trace_
350
351 #define ACPI_FUNCTION_ENTRY() \
352 acpi_ut_track_stack_ptr()
353
354 /*
355 * Function exit tracing
356 *
357 * These macros include a return statement. Th
358 * bad form, but having a separate exit macro
359 * is very ugly and difficult to maintain.
360 *
361 * One of the FUNCTION_TRACE macros above must
362 * with these macros so that "_AcpiFunctionNam
363 *
364 * There are two versions of most of the retur
365 * safer, since it avoids side-effects by guar
366 * not be evaluated twice.
367 *
368 * A less-safe version of the macros is provid
369 * compiler uses excessive CPU stack (for exam
370 * debug case if code optimization is disabled
371 */
372
373 /* Exit trace helper macro */
374
375 #ifndef ACPI_SIMPLE_RETURN_MACROS
376
377 #define ACPI_TRACE_EXIT(function, type, param)
378 ACPI_DO_WHILE0 ({ \
379 register type _param = (type)
380 function (ACPI_DEBUG_PARAMETER
381 return (_param); \
382 })
383
384 #else /* Use origina
385
386 #define ACPI_TRACE_EXIT(function, type, param)
387 ACPI_DO_WHILE0 ({ \
388 function (ACPI_DEBUG_PARAMETER
389 return (param); \
390 })
391
392 #endif /* ACPI_SIMPLE
393
394 /* The actual exit macros */
395
396 #define return_VOID \
397 ACPI_DO_WHILE0 ({ \
398 acpi_ut_exit (ACPI_DEBUG_PARAM
399 return; \
400 })
401
402 #define return_ACPI_STATUS(status) \
403 ACPI_TRACE_EXIT (acpi_ut_status_exit,
404
405 #define return_PTR(pointer) \
406 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, voi
407
408 #define return_STR(string) \
409 ACPI_TRACE_EXIT (acpi_ut_str_exit, con
410
411 #define return_VALUE(value) \
412 ACPI_TRACE_EXIT (acpi_ut_value_exit, u
413
414 #define return_UINT32(value) \
415 ACPI_TRACE_EXIT (acpi_ut_value_exit, u
416
417 #define return_UINT8(value) \
418 ACPI_TRACE_EXIT (acpi_ut_value_exit, u
419
420 /* Conditional execution */
421
422 #define ACPI_DEBUG_EXEC(a) a
423 #define ACPI_DEBUG_ONLY_MEMBERS(a) a
424 #define _VERBOSE_STRUCTURES
425
426 /* Various object display routines for debug *
427
428 #define ACPI_DUMP_STACK_ENTRY(a) acpi_e
429 #define ACPI_DUMP_OPERANDS(a, b ,c) acpi_e
430 #define ACPI_DUMP_ENTRY(a, b) acpi_n
431 #define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_n
432 #define ACPI_DUMP_BUFFER(a, b) acpi_u
433
434 #define ACPI_TRACE_POINT(a, b, c, d) acpi_t
435
436 #else /* ACPI_DEBUG_
437 /*
438 * This is the non-debug case -- make everythi
439 * leaving no executable debug code!
440 */
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)
453 #define ACPI_DUMP_ENTRY(a, b)
454 #define ACPI_DUMP_PATHNAME(a, b, c, d)
455 #define ACPI_DUMP_BUFFER(a, b)
456 #define ACPI_IS_DEBUG_ENABLED(level, component
457 #define ACPI_TRACE_POINT(a, b, c, d)
458
459 /* Return macros must have a return statement
460
461 #define return_VOID return
462 #define return_ACPI_STATUS(s) return
463 #define return_PTR(s) return
464 #define return_STR(s) return
465 #define return_VALUE(s) return
466 #define return_UINT8(s) return
467 #define return_UINT32(s) return
468
469 #endif /* ACPI_DEBUG_
470
471 #endif /* __ACOUTPUT_
472
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.