acoutput.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. /******************************************************************************
  2. *
  3. * Name: acoutput.h -- debug output
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2011, Intel Corp.
  8. * All rights reserved.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions, and the following disclaimer,
  15. * without modification.
  16. * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  17. * substantially similar to the "NO WARRANTY" disclaimer below
  18. * ("Disclaimer") and any redistribution must be conditioned upon
  19. * including a substantially similar Disclaimer requirement for further
  20. * binary redistribution.
  21. * 3. Neither the names of the above-listed copyright holders nor the names
  22. * of any contributors may be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * Alternatively, this software may be distributed under the terms of the
  26. * GNU General Public License ("GPL") version 2 as published by the Free
  27. * Software Foundation.
  28. *
  29. * NO WARRANTY
  30. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  33. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34. * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  38. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  39. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40. * POSSIBILITY OF SUCH DAMAGES.
  41. */
  42. #ifndef __ACOUTPUT_H__
  43. #define __ACOUTPUT_H__
  44. /*
  45. * Debug levels and component IDs. These are used to control the
  46. * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
  47. * per-component basis and a per-exception-type basis.
  48. */
  49. /* Component IDs are used in the global "DebugLayer" */
  50. #define ACPI_UTILITIES 0x00000001
  51. #define ACPI_HARDWARE 0x00000002
  52. #define ACPI_EVENTS 0x00000004
  53. #define ACPI_TABLES 0x00000008
  54. #define ACPI_NAMESPACE 0x00000010
  55. #define ACPI_PARSER 0x00000020
  56. #define ACPI_DISPATCHER 0x00000040
  57. #define ACPI_EXECUTER 0x00000080
  58. #define ACPI_RESOURCES 0x00000100
  59. #define ACPI_CA_DEBUGGER 0x00000200
  60. #define ACPI_OS_SERVICES 0x00000400
  61. #define ACPI_CA_DISASSEMBLER 0x00000800
  62. /* Component IDs for ACPI tools and utilities */
  63. #define ACPI_COMPILER 0x00001000
  64. #define ACPI_TOOLS 0x00002000
  65. #define ACPI_EXAMPLE 0x00004000
  66. #define ACPI_DRIVER 0x00008000
  67. #define DT_COMPILER 0x00010000
  68. #define ACPI_ALL_COMPONENTS 0x0001FFFF
  69. #define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
  70. /* Component IDs reserved for ACPI drivers */
  71. #define ACPI_ALL_DRIVERS 0xFFFF0000
  72. /*
  73. * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
  74. */
  75. #define ACPI_LV_INIT 0x00000001
  76. #define ACPI_LV_DEBUG_OBJECT 0x00000002
  77. #define ACPI_LV_INFO 0x00000004
  78. #define ACPI_LV_REPAIR 0x00000008
  79. #define ACPI_LV_ALL_EXCEPTIONS 0x0000000F
  80. /* Trace verbosity level 1 [Standard Trace Level] */
  81. #define ACPI_LV_INIT_NAMES 0x00000020
  82. #define ACPI_LV_PARSE 0x00000040
  83. #define ACPI_LV_LOAD 0x00000080
  84. #define ACPI_LV_DISPATCH 0x00000100
  85. #define ACPI_LV_EXEC 0x00000200
  86. #define ACPI_LV_NAMES 0x00000400
  87. #define ACPI_LV_OPREGION 0x00000800
  88. #define ACPI_LV_BFIELD 0x00001000
  89. #define ACPI_LV_TABLES 0x00002000
  90. #define ACPI_LV_VALUES 0x00004000
  91. #define ACPI_LV_OBJECTS 0x00008000
  92. #define ACPI_LV_RESOURCES 0x00010000
  93. #define ACPI_LV_USER_REQUESTS 0x00020000
  94. #define ACPI_LV_PACKAGE 0x00040000
  95. #define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
  96. /* Trace verbosity level 2 [Function tracing and memory allocation] */
  97. #define ACPI_LV_ALLOCATIONS 0x00100000
  98. #define ACPI_LV_FUNCTIONS 0x00200000
  99. #define ACPI_LV_OPTIMIZATIONS 0x00400000
  100. #define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1
  101. #define ACPI_LV_ALL ACPI_LV_VERBOSITY2
  102. /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
  103. #define ACPI_LV_MUTEX 0x01000000
  104. #define ACPI_LV_THREADS 0x02000000
  105. #define ACPI_LV_IO 0x04000000
  106. #define ACPI_LV_INTERRUPTS 0x08000000
  107. #define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
  108. /* Exceptionally verbose output -- also used in the global "DebugLevel" */
  109. #define ACPI_LV_AML_DISASSEMBLE 0x10000000
  110. #define ACPI_LV_VERBOSE_INFO 0x20000000
  111. #define ACPI_LV_FULL_TABLES 0x40000000
  112. #define ACPI_LV_EVENTS 0x80000000
  113. #define ACPI_LV_VERBOSE 0xF0000000
  114. /*
  115. * Debug level macros that are used in the DEBUG_PRINT macros
  116. */
  117. #define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
  118. /*
  119. * Exception level -- used in the global "DebugLevel"
  120. *
  121. * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
  122. * For warnings, use ACPI_WARNING.
  123. */
  124. #define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
  125. #define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
  126. #define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
  127. #define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
  128. #define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
  129. /* Trace level -- also used in the global "DebugLevel" */
  130. #define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
  131. #define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
  132. #define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
  133. #define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
  134. #define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
  135. #define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
  136. #define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
  137. #define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
  138. #define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
  139. #define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
  140. #define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
  141. #define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
  142. #define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
  143. #define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
  144. #define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
  145. #define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
  146. #define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
  147. #define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
  148. #define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
  149. #define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
  150. #define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
  151. #define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
  152. #define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
  153. /* Defaults for debug_level, debug and normal */
  154. #define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR)
  155. #define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
  156. #define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
  157. #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
  158. /*
  159. * The module name is used primarily for error and debug messages.
  160. * The __FILE__ macro is not very useful for this, because it
  161. * usually includes the entire pathname to the module making the
  162. * debug output difficult to read.
  163. */
  164. #define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
  165. #else
  166. /*
  167. * For the no-debug and no-error-msg cases, we must at least define
  168. * a null module name.
  169. */
  170. #define ACPI_MODULE_NAME(name)
  171. #define _acpi_module_name ""
  172. #endif
  173. /*
  174. * Ascii error messages can be configured out
  175. */
  176. #ifndef ACPI_NO_ERROR_MESSAGES
  177. #define AE_INFO _acpi_module_name, __LINE__
  178. /*
  179. * Error reporting. Callers module and line number are inserted by AE_INFO,
  180. * the plist contains a set of parens to allow variable-length lists.
  181. * These macros are used for both the debug and non-debug versions of the code.
  182. */
  183. #define ACPI_INFO(plist) acpi_info plist
  184. #define ACPI_WARNING(plist) acpi_warning plist
  185. #define ACPI_EXCEPTION(plist) acpi_exception plist
  186. #define ACPI_ERROR(plist) acpi_error plist
  187. #define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
  188. #else
  189. /* No error messages */
  190. #define ACPI_INFO(plist)
  191. #define ACPI_WARNING(plist)
  192. #define ACPI_EXCEPTION(plist)
  193. #define ACPI_ERROR(plist)
  194. #define ACPI_DEBUG_OBJECT(obj,l,i)
  195. #endif /* ACPI_NO_ERROR_MESSAGES */
  196. /*
  197. * Debug macros that are conditionally compiled
  198. */
  199. #ifdef ACPI_DEBUG_OUTPUT
  200. /*
  201. * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
  202. * define it now. This is the case where there the compiler does not support
  203. * a __FUNCTION__ macro or equivalent.
  204. */
  205. #ifndef ACPI_GET_FUNCTION_NAME
  206. #define ACPI_GET_FUNCTION_NAME _acpi_function_name
  207. /*
  208. * The Name parameter should be the procedure name as a quoted string.
  209. * The function name is also used by the function exit macros below.
  210. * Note: (const char) is used to be compatible with the debug interfaces
  211. * and macros such as __FUNCTION__.
  212. */
  213. #define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
  214. #else
  215. /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
  216. #define ACPI_FUNCTION_NAME(name)
  217. #endif /* ACPI_GET_FUNCTION_NAME */
  218. /*
  219. * Common parameters used for debug output functions:
  220. * line number, function name, module(file) name, component ID
  221. */
  222. #define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
  223. /*
  224. * Master debug print macros
  225. * Print message if and only if:
  226. * 1) Debug print for the current component is enabled
  227. * 2) Debug error level or trace level for the print statement is enabled
  228. */
  229. #define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
  230. #define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
  231. #else
  232. /*
  233. * This is the non-debug case -- make everything go away,
  234. * leaving no executable debug code!
  235. */
  236. #define ACPI_FUNCTION_NAME(a)
  237. #define ACPI_DEBUG_PRINT(pl)
  238. #define ACPI_DEBUG_PRINT_RAW(pl)
  239. #endif /* ACPI_DEBUG_OUTPUT */
  240. #endif /* __ACOUTPUT_H__ */