acoutput.h 16 KB

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