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