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