1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: acoutput.h -- debug output
5 *
6 * Copyright (C) 2000 - 2019, 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#define ACPI_DEBUG_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_EVALUATION | ACPI_LV_REPAIR)
154#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
155#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
156
157/*
158 * Global trace flags
159 */
160#define ACPI_TRACE_ENABLED ((u32) 4)
161#define ACPI_TRACE_ONESHOT ((u32) 2)
162#define ACPI_TRACE_OPCODE ((u32) 1)
163
164/* Defaults for trace debugging level/layer */
165
166#define ACPI_TRACE_LEVEL_ALL ACPI_LV_ALL
167#define ACPI_TRACE_LAYER_ALL 0x000001FF
168#define ACPI_TRACE_LEVEL_DEFAULT ACPI_LV_TRACE_POINT
169#define ACPI_TRACE_LAYER_DEFAULT ACPI_EXECUTER
170
171#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
172/*
173 * The module name is used primarily for error and debug messages.
174 * The __FILE__ macro is not very useful for this, because it
175 * usually includes the entire pathname to the module making the
176 * debug output difficult to read.
177 */
178#define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
179#else
180/*
181 * For the no-debug and no-error-msg cases, we must at least define
182 * a null module name.
183 */
184#define ACPI_MODULE_NAME(name)
185#define _acpi_module_name ""
186#endif
187
188/*
189 * Ascii error messages can be configured out
190 */
191#ifndef ACPI_NO_ERROR_MESSAGES
192#define AE_INFO _acpi_module_name, __LINE__
193
194/*
195 * Error reporting. Callers module and line number are inserted by AE_INFO,
196 * the plist contains a set of parens to allow variable-length lists.
197 * These macros are used for both the debug and non-debug versions of the code.
198 */
199#define ACPI_INFO(plist) acpi_info plist
200#define ACPI_WARNING(plist) acpi_warning plist
201#define ACPI_EXCEPTION(plist) acpi_exception plist
202#define ACPI_ERROR(plist) acpi_error plist
203#define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
204#define ACPI_BIOS_EXCEPTION(plist) acpi_bios_exception plist
205#define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
206#define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
207
208#else
209
210/* No error messages */
211
212#define ACPI_INFO(plist)
213#define ACPI_WARNING(plist)
214#define ACPI_EXCEPTION(plist)
215#define ACPI_ERROR(plist)
216#define ACPI_BIOS_WARNING(plist)
217#define ACPI_BIOS_EXCEPTION(plist)
218#define ACPI_BIOS_ERROR(plist)
219#define ACPI_DEBUG_OBJECT(obj,l,i)
220
221#endif /* ACPI_NO_ERROR_MESSAGES */
222
223/*
224 * Debug macros that are conditionally compiled
225 */
226#ifdef ACPI_DEBUG_OUTPUT
227
228/*
229 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
230 * define it now. This is the case where there the compiler does not support
231 * a __func__ macro or equivalent.
232 */
233#ifndef ACPI_GET_FUNCTION_NAME
234#define ACPI_GET_FUNCTION_NAME _acpi_function_name
235
236/*
237 * The Name parameter should be the procedure name as a non-quoted string.
238 * The function name is also used by the function exit macros below.
239 * Note: (const char) is used to be compatible with the debug interfaces
240 * and macros such as __func__.
241 */
242#define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
243
244#else
245/* Compiler supports __func__ (or equivalent) -- Ignore this macro */
246
247#define ACPI_FUNCTION_NAME(name)
248#endif /* ACPI_GET_FUNCTION_NAME */
249
250/*
251 * Common parameters used for debug output functions:
252 * line number, function name, module(file) name, component ID
253 */
254#define ACPI_DEBUG_PARAMETERS \
255 __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
256
257/* Check if debug output is currently dynamically enabled */
258
259#define ACPI_IS_DEBUG_ENABLED(level, component) \
260 ((level & acpi_dbg_level) && (component & acpi_dbg_layer))
261
262/*
263 * Master debug print macros
264 * Print message if and only if:
265 * 1) Debug print for the current component is enabled
266 * 2) Debug error level or trace level for the print statement is enabled
267 *
268 * November 2012: Moved the runtime check for whether to actually emit the
269 * debug message outside of the print function itself. This improves overall
270 * performance at a relatively small code cost. Implementation involves the
271 * use of variadic macros supported by C99.
272 *
273 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
274 * complaining about these constructs. On other compilers the do...while
275 * adds some extra code, so this feature is optional.
276 */
277#ifdef ACPI_USE_DO_WHILE_0
278#define ACPI_DO_WHILE0(a) do a while(0)
279#else
280#define ACPI_DO_WHILE0(a) a
281#endif
282
283/* DEBUG_PRINT functions */
284
285#ifndef COMPILER_VA_MACRO
286
287#define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
288#define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
289
290#else
291
292/* Helper macros for DEBUG_PRINT */
293
294#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
295 ACPI_DO_WHILE0 ({ \
296 if (ACPI_IS_DEBUG_ENABLED (level, component)) \
297 { \
298 function (level, line, filename, modulename, component, __VA_ARGS__); \
299 } \
300 })
301
302#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
303 ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
304 filename, modulename, component, __VA_ARGS__)
305
306#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
307 ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
308 filename, modulename, component, __VA_ARGS__)
309
310#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
311#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
312
313#endif
314
315/*
316 * Function entry tracing
317 *
318 * The name of the function is emitted as a local variable that is
319 * intended to be used by both the entry trace and the exit trace.
320 */
321
322/* Helper macro */
323
324#define ACPI_TRACE_ENTRY(name, function, type, param) \
325 ACPI_FUNCTION_NAME (name) \
326 function (ACPI_DEBUG_PARAMETERS, (type) (param))
327
328/* The actual entry trace macros */
329
330#define ACPI_FUNCTION_TRACE(name) \
331 ACPI_FUNCTION_NAME(name) \
332 acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
333
334#define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
335 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
336
337#define ACPI_FUNCTION_TRACE_U32(name, value) \
338 ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
339
340#define ACPI_FUNCTION_TRACE_STR(name, string) \
341 ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, const char *, string)
342
343#define ACPI_FUNCTION_ENTRY() \
344 acpi_ut_track_stack_ptr()
345
346/*
347 * Function exit tracing
348 *
349 * These macros include a return statement. This is usually considered
350 * bad form, but having a separate exit macro before the actual return
351 * is very ugly and difficult to maintain.
352 *
353 * One of the FUNCTION_TRACE macros above must be used in conjunction
354 * with these macros so that "_AcpiFunctionName" is defined.
355 *
356 * There are two versions of most of the return macros. The default version is
357 * safer, since it avoids side-effects by guaranteeing that the argument will
358 * not be evaluated twice.
359 *
360 * A less-safe version of the macros is provided for optional use if the
361 * compiler uses excessive CPU stack (for example, this may happen in the
362 * debug case if code optimzation is disabled.)
363 */
364
365/* Exit trace helper macro */
366
367#ifndef ACPI_SIMPLE_RETURN_MACROS
368
369#define ACPI_TRACE_EXIT(function, type, param) \
370 ACPI_DO_WHILE0 ({ \
371 register type _param = (type) (param); \
372 function (ACPI_DEBUG_PARAMETERS, _param); \
373 return (_param); \
374 })
375
376#else /* Use original less-safe macros */
377
378#define ACPI_TRACE_EXIT(function, type, param) \
379 ACPI_DO_WHILE0 ({ \
380 function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
381 return (param); \
382 })
383
384#endif /* ACPI_SIMPLE_RETURN_MACROS */
385
386/* The actual exit macros */
387
388#define return_VOID \
389 ACPI_DO_WHILE0 ({ \
390 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
391 return; \
392 })
393
394#define return_ACPI_STATUS(status) \
395 ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
396
397#define return_PTR(pointer) \
398 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
399
400#define return_STR(string) \
401 ACPI_TRACE_EXIT (acpi_ut_str_exit, const char *, string)
402
403#define return_VALUE(value) \
404 ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
405
406#define return_UINT32(value) \
407 ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
408
409#define return_UINT8(value) \
410 ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
411
412/* Conditional execution */
413
414#define ACPI_DEBUG_EXEC(a) a
415#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
416#define _VERBOSE_STRUCTURES
417
418/* Various object display routines for debug */
419
420#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
421#define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
422#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
423#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
424#define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
425
426#define ACPI_TRACE_POINT(a, b, c, d) acpi_trace_point (a, b, c, d)
427
428#else /* ACPI_DEBUG_OUTPUT */
429/*
430 * This is the non-debug case -- make everything go away,
431 * leaving no executable debug code!
432 */
433#define ACPI_DEBUG_PRINT(pl)
434#define ACPI_DEBUG_PRINT_RAW(pl)
435#define ACPI_DEBUG_EXEC(a)
436#define ACPI_DEBUG_ONLY_MEMBERS(a)
437#define ACPI_FUNCTION_NAME(a)
438#define ACPI_FUNCTION_TRACE(a)
439#define ACPI_FUNCTION_TRACE_PTR(a, b)
440#define ACPI_FUNCTION_TRACE_U32(a, b)
441#define ACPI_FUNCTION_TRACE_STR(a, b)
442#define ACPI_FUNCTION_ENTRY()
443#define ACPI_DUMP_STACK_ENTRY(a)
444#define ACPI_DUMP_OPERANDS(a, b, c)
445#define ACPI_DUMP_ENTRY(a, b)
446#define ACPI_DUMP_PATHNAME(a, b, c, d)
447#define ACPI_DUMP_BUFFER(a, b)
448#define ACPI_IS_DEBUG_ENABLED(level, component) 0
449#define ACPI_TRACE_POINT(a, b, c, d)
450
451/* Return macros must have a return statement at the minimum */
452
453#define return_VOID return
454#define return_ACPI_STATUS(s) return(s)
455#define return_PTR(s) return(s)
456#define return_STR(s) return(s)
457#define return_VALUE(s) return(s)
458#define return_UINT8(s) return(s)
459#define return_UINT32(s) return(s)
460
461#endif /* ACPI_DEBUG_OUTPUT */
462
463#endif /* __ACOUTPUT_H__ */
464