1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: acoutput.h -- debug output
5 *
6 * Copyright (C) 2000 - 2025, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef __ACOUTPUT_H__
11#define __ACOUTPUT_H__
12
13/*
14 * Debug levels and component IDs. These are used to control the
15 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
16 * per-component basis and a per-exception-type basis.
17 */
18
19/* Component IDs are used in the global "DebugLayer" */
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_COMPONENTS)
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 in the ACPI_DEBUG_PRINT macros
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 Level] */
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 | ACPI_LV_ALL_EXCEPTIONS
78
79/* Trace verbosity level 2 [Function tracing and memory allocation] */
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 | ACPI_LV_VERBOSITY1
86#define ACPI_LV_ALL ACPI_LV_VERBOSITY2
87
88/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
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 | ACPI_LV_VERBOSITY2
95
96/* Exceptionally verbose output -- also used in the global "DebugLevel" */
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 DEBUG_PRINT macros
106 */
107#define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
108
109/*
110 * Exception level -- used in the global "DebugLevel"
111 *
112 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
113 * For warnings, use ACPI_WARNING.
114 */
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)
121
122/* Trace level -- also used in the global "DebugLevel" */
123
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)
148
149#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
150
151/* Defaults for debug_level, debug and normal */
152
153#ifndef ACPI_DEBUG_DEFAULT
154#define ACPI_DEBUG_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_EVALUATION | ACPI_LV_REPAIR)
155#endif
156
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)
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_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
173
174#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
175/*
176 * The module name is used primarily for error and debug messages.
177 * The __FILE__ macro is not very useful for this, because it
178 * usually includes the entire pathname to the module making the
179 * debug output difficult to read.
180 */
181#define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
182#else
183/*
184 * For the no-debug and no-error-msg cases, we must at least define
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_module_name, __LINE__
196#define ACPI_ONCE(_fn, _plist) { static char _done; if (!_done) { _done = 1; _fn _plist; } }
197
198/*
199 * Error reporting. Callers module and line number are inserted by AE_INFO,
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.
202 */
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)
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_ERROR_MESSAGES */
230
231/*
232 * Debug macros that are conditionally compiled
233 */
234#ifdef ACPI_DEBUG_OUTPUT
235
236/*
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
239 * a __func__ macro or equivalent.
240 */
241#ifndef ACPI_GET_FUNCTION_NAME
242#define ACPI_GET_FUNCTION_NAME _acpi_function_name
243
244/*
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.
247 * Note: (const char) is used to be compatible with the debug interfaces
248 * and macros such as __func__.
249 */
250#define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
251
252#else
253/* Compiler supports __func__ (or equivalent) -- Ignore this macro */
254
255#define ACPI_FUNCTION_NAME(name)
256#endif /* ACPI_GET_FUNCTION_NAME */
257
258/*
259 * Common parameters used for debug output functions:
260 * line number, function name, module(file) name, component ID
261 */
262#define ACPI_DEBUG_PARAMETERS \
263 __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
264
265/* Check if debug output is currently dynamically enabled */
266
267#define ACPI_IS_DEBUG_ENABLED(level, component) \
268 ((level & acpi_dbg_level) && (component & acpi_dbg_layer))
269
270/*
271 * Master debug print macros
272 * Print message if and only if:
273 * 1) Debug print for the current component is enabled
274 * 2) Debug error level or trace level for the print statement is enabled
275 *
276 * November 2012: Moved the runtime check for whether to actually emit the
277 * debug message outside of the print function itself. This improves overall
278 * performance at a relatively small code cost. Implementation involves the
279 * use of variadic macros supported by C99.
280 *
281 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
282 * complaining about these constructs. On other compilers the do...while
283 * adds some extra code, so this feature is optional.
284 */
285#ifdef ACPI_USE_DO_WHILE_0
286#define ACPI_DO_WHILE0(a) do a while(0)
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_debug_print plist
296#define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
297
298#else
299
300/* Helper macros for DEBUG_PRINT */
301
302#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
303 ACPI_DO_WHILE0 ({ \
304 if (ACPI_IS_DEBUG_ENABLED (level, component)) \
305 { \
306 function (level, line, filename, modulename, component, __VA_ARGS__); \
307 } \
308 })
309
310#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
311 ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
312 filename, modulename, component, __VA_ARGS__)
313
314#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
315 ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
316 filename, modulename, component, __VA_ARGS__)
317
318#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
319#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
320
321#endif
322
323/*
324 * Function entry tracing
325 *
326 * The name of the function is emitted as a local variable that is
327 * intended to be used by both the entry trace and the exit trace.
328 */
329
330/* Helper macro */
331
332#define ACPI_TRACE_ENTRY(name, function, type, param) \
333 ACPI_FUNCTION_NAME (name) \
334 function (ACPI_DEBUG_PARAMETERS, (type) (param))
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_ptr, void *, pointer)
344
345#define ACPI_FUNCTION_TRACE_U32(name, value) \
346 ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
347
348#define ACPI_FUNCTION_TRACE_STR(name, string) \
349 ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, const char *, string)
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. This is usually considered
358 * bad form, but having a separate exit macro before the actual return
359 * is very ugly and difficult to maintain.
360 *
361 * One of the FUNCTION_TRACE macros above must be used in conjunction
362 * with these macros so that "_AcpiFunctionName" is defined.
363 *
364 * There are two versions of most of the return macros. The default version is
365 * safer, since it avoids side-effects by guaranteeing that the argument will
366 * not be evaluated twice.
367 *
368 * A less-safe version of the macros is provided for optional use if the
369 * compiler uses excessive CPU stack (for example, this may happen in the
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) (param); \
380 function (ACPI_DEBUG_PARAMETERS, _param); \
381 return (_param); \
382 })
383
384#else /* Use original less-safe macros */
385
386#define ACPI_TRACE_EXIT(function, type, param) \
387 ACPI_DO_WHILE0 ({ \
388 function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
389 return (param); \
390 })
391
392#endif /* ACPI_SIMPLE_RETURN_MACROS */
393
394/* The actual exit macros */
395
396#define return_VOID \
397 ACPI_DO_WHILE0 ({ \
398 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
399 return; \
400 })
401
402#define return_ACPI_STATUS(status) \
403 ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
404
405#define return_PTR(pointer) \
406 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
407
408#define return_STR(string) \
409 ACPI_TRACE_EXIT (acpi_ut_str_exit, const char *, string)
410
411#define return_VALUE(value) \
412 ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
413
414#define return_UINT32(value) \
415 ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
416
417#define return_UINT8(value) \
418 ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
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_ex_dump_operand((a), 0)
429#define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
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)
432#define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
433
434#define ACPI_TRACE_POINT(a, b, c, d) acpi_trace_point (a, b, c, d)
435
436#else /* ACPI_DEBUG_OUTPUT */
437/*
438 * This is the non-debug case -- make everything go away,
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) 0
457#define ACPI_TRACE_POINT(a, b, c, d)
458
459/* Return macros must have a return statement at the minimum */
460
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)
468
469#endif /* ACPI_DEBUG_OUTPUT */
470
471#endif /* __ACOUTPUT_H__ */
472