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