Merge branch 'vendor/OPENSSL'
[dragonfly.git] / sys / contrib / dev / acpica / source / include / acoutput.h
1 /******************************************************************************
2  *
3  * Name: acoutput.h -- debug output
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2014, 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 #pragma pack(push) /* Set default struct packing */
48
49 /*
50  * Debug levels and component IDs. These are used to control the
51  * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
52  * per-component basis and a per-exception-type basis.
53  */
54
55 /* Component IDs are used in the global "DebugLayer" */
56
57 #define ACPI_UTILITIES              0x00000001
58 #define ACPI_HARDWARE               0x00000002
59 #define ACPI_EVENTS                 0x00000004
60 #define ACPI_TABLES                 0x00000008
61 #define ACPI_NAMESPACE              0x00000010
62 #define ACPI_PARSER                 0x00000020
63 #define ACPI_DISPATCHER             0x00000040
64 #define ACPI_EXECUTER               0x00000080
65 #define ACPI_RESOURCES              0x00000100
66 #define ACPI_CA_DEBUGGER            0x00000200
67 #define ACPI_OS_SERVICES            0x00000400
68 #define ACPI_CA_DISASSEMBLER        0x00000800
69
70 /* Component IDs for ACPI tools and utilities */
71
72 #define ACPI_COMPILER               0x00001000
73 #define ACPI_TOOLS                  0x00002000
74 #define ACPI_EXAMPLE                0x00004000
75 #define ACPI_DRIVER                 0x00008000
76 #define DT_COMPILER                 0x00010000
77 #define ASL_PREPROCESSOR            0x00020000
78
79 #define ACPI_ALL_COMPONENTS         0x0001FFFF
80 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
81
82 /* Component IDs reserved for ACPI drivers */
83
84 #define ACPI_ALL_DRIVERS            0xFFFF0000
85
86
87 /*
88  * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
89  */
90 #define ACPI_LV_INIT                0x00000001
91 #define ACPI_LV_DEBUG_OBJECT        0x00000002
92 #define ACPI_LV_INFO                0x00000004
93 #define ACPI_LV_REPAIR              0x00000008
94 #define ACPI_LV_ALL_EXCEPTIONS      0x0000000F
95
96 /* Trace verbosity level 1 [Standard Trace Level] */
97
98 #define ACPI_LV_INIT_NAMES          0x00000020
99 #define ACPI_LV_PARSE               0x00000040
100 #define ACPI_LV_LOAD                0x00000080
101 #define ACPI_LV_DISPATCH            0x00000100
102 #define ACPI_LV_EXEC                0x00000200
103 #define ACPI_LV_NAMES               0x00000400
104 #define ACPI_LV_OPREGION            0x00000800
105 #define ACPI_LV_BFIELD              0x00001000
106 #define ACPI_LV_TABLES              0x00002000
107 #define ACPI_LV_VALUES              0x00004000
108 #define ACPI_LV_OBJECTS             0x00008000
109 #define ACPI_LV_RESOURCES           0x00010000
110 #define ACPI_LV_USER_REQUESTS       0x00020000
111 #define ACPI_LV_PACKAGE             0x00040000
112 #define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
113
114 /* Trace verbosity level 2 [Function tracing and memory allocation] */
115
116 #define ACPI_LV_ALLOCATIONS         0x00100000
117 #define ACPI_LV_FUNCTIONS           0x00200000
118 #define ACPI_LV_OPTIMIZATIONS       0x00400000
119 #define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
120 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
121
122 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
123
124 #define ACPI_LV_MUTEX               0x01000000
125 #define ACPI_LV_THREADS             0x02000000
126 #define ACPI_LV_IO                  0x04000000
127 #define ACPI_LV_INTERRUPTS          0x08000000
128 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
129
130 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
131
132 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
133 #define ACPI_LV_VERBOSE_INFO        0x20000000
134 #define ACPI_LV_FULL_TABLES         0x40000000
135 #define ACPI_LV_EVENTS              0x80000000
136 #define ACPI_LV_VERBOSE             0xF0000000
137
138
139 /*
140  * Debug level macros that are used in the DEBUG_PRINT macros
141  */
142 #define ACPI_DEBUG_LEVEL(dl)        (UINT32) dl,ACPI_DEBUG_PARAMETERS
143
144 /*
145  * Exception level -- used in the global "DebugLevel"
146  *
147  * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
148  * For warnings, use ACPI_WARNING.
149  */
150 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
151 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
152 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
153 #define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
154 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
155
156 /* Trace level -- also used in the global "DebugLevel" */
157
158 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
159 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
160 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
161 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
162 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
163 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
164 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
165 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
166 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
167 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
168 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
169 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
170 #define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
171 #define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
172 #define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
173 #define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
174 #define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
175 #define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
176 #define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
177 #define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
178 #define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
179 #define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
180
181 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
182
183 /* Defaults for DebugLevel, debug and normal */
184
185 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
186 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
187 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
188
189
190 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
191 /*
192  * The module name is used primarily for error and debug messages.
193  * The __FILE__ macro is not very useful for this, because it
194  * usually includes the entire pathname to the module making the
195  * debug output difficult to read.
196  */
197 #define ACPI_MODULE_NAME(Name)          static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name;
198 #else
199 /*
200  * For the no-debug and no-error-msg cases, we must at least define
201  * a null module name.
202  */
203 #define ACPI_MODULE_NAME(Name)
204 #define _AcpiModuleName ""
205 #endif
206
207 /*
208  * Ascii error messages can be configured out
209  */
210 #ifndef ACPI_NO_ERROR_MESSAGES
211 #define AE_INFO                         _AcpiModuleName, __LINE__
212
213 /*
214  * Error reporting. Callers module and line number are inserted by AE_INFO,
215  * the plist contains a set of parens to allow variable-length lists.
216  * These macros are used for both the debug and non-debug versions of the code.
217  */
218 #define ACPI_INFO(plist)                AcpiInfo plist
219 #define ACPI_WARNING(plist)             AcpiWarning plist
220 #define ACPI_EXCEPTION(plist)           AcpiException plist
221 #define ACPI_ERROR(plist)               AcpiError plist
222 #define ACPI_BIOS_WARNING(plist)        AcpiBiosWarning plist
223 #define ACPI_BIOS_ERROR(plist)          AcpiBiosError plist
224
225 #else
226
227 /* No error messages */
228
229 #define ACPI_INFO(plist)
230 #define ACPI_WARNING(plist)
231 #define ACPI_EXCEPTION(plist)
232 #define ACPI_ERROR(plist)
233 #define ACPI_BIOS_WARNING(plist)
234 #define ACPI_BIOS_ERROR(plist)
235
236 #endif /* ACPI_NO_ERROR_MESSAGES */
237
238 #ifdef ACPI_DEBUG_MESSAGE
239 #define ACPI_DEBUG_OBJECT(obj,l,i)      AcpiExDoDebugObject(obj,l,i)
240 #else
241 #define ACPI_DEBUG_OBJECT(obj,l,i)
242 #endif
243
244
245 /*
246  * Debug macros that are conditionally compiled
247  */
248 #ifdef ACPI_DEBUG_OUTPUT
249
250 /*
251  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
252  * define it now. This is the case where there the compiler does not support
253  * a __FUNCTION__ macro or equivalent.
254  */
255 #ifndef ACPI_GET_FUNCTION_NAME
256 #define ACPI_GET_FUNCTION_NAME          _AcpiFunctionName
257
258 /*
259  * The Name parameter should be the procedure name as a quoted string.
260  * The function name is also used by the function exit macros below.
261  * Note: (const char) is used to be compatible with the debug interfaces
262  * and macros such as __FUNCTION__.
263  */
264 #define ACPI_FUNCTION_NAME(Name)        static const char _AcpiFunctionName[] = #Name;
265
266 #else
267 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
268
269 #define ACPI_FUNCTION_NAME(Name)
270 #endif /* ACPI_GET_FUNCTION_NAME */
271
272 /*
273  * Common parameters used for debug output functions:
274  * line number, function name, module(file) name, component ID
275  */
276 #define ACPI_DEBUG_PARAMETERS \
277     __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT
278
279 /* Check if debug output is currently dynamically enabled */
280
281 #define ACPI_IS_DEBUG_ENABLED(Level, Component) \
282     ((Level & AcpiDbgLevel) && (Component & AcpiDbgLayer))
283
284 /*
285  * Master debug print macros
286  * Print message if and only if:
287  *    1) Debug print for the current component is enabled
288  *    2) Debug error level or trace level for the print statement is enabled
289  *
290  * November 2012: Moved the runtime check for whether to actually emit the
291  * debug message outside of the print function itself. This improves overall
292  * performance at a relatively small code cost. Implementation involves the
293  * use of variadic macros supported by C99.
294  *
295  * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
296  * complaining about these constructs. On other compilers the do...while
297  * adds some extra code, so this feature is optional.
298  */
299 #ifdef ACPI_USE_DO_WHILE_0
300 #define ACPI_DO_WHILE0(a)               do a while(0)
301 #else
302 #define ACPI_DO_WHILE0(a)               a
303 #endif
304
305 /* DEBUG_PRINT functions */
306
307 #define ACPI_DEBUG_PRINT(plist)         ACPI_ACTUAL_DEBUG plist
308 #define ACPI_DEBUG_PRINT_RAW(plist)     ACPI_ACTUAL_DEBUG_RAW plist
309
310 /* Helper macros for DEBUG_PRINT */
311
312 #define ACPI_DO_DEBUG_PRINT(Function, Level, Line, Filename, Modulename, Component, ...) \
313     ACPI_DO_WHILE0 ({ \
314         if (ACPI_IS_DEBUG_ENABLED (Level, Component)) \
315         { \
316             Function (Level, Line, Filename, Modulename, Component, __VA_ARGS__); \
317         } \
318     })
319
320 #define ACPI_ACTUAL_DEBUG(Level, Line, Filename, Modulename, Component, ...) \
321     ACPI_DO_DEBUG_PRINT (AcpiDebugPrint, Level, Line, \
322         Filename, Modulename, Component, __VA_ARGS__)
323
324 #define ACPI_ACTUAL_DEBUG_RAW(Level, Line, Filename, Modulename, Component, ...) \
325     ACPI_DO_DEBUG_PRINT (AcpiDebugPrintRaw, Level, Line, \
326         Filename, Modulename, Component, __VA_ARGS__)
327
328
329 /*
330  * Function entry tracing
331  *
332  * The name of the function is emitted as a local variable that is
333  * intended to be used by both the entry trace and the exit trace.
334  */
335
336 /* Helper macro */
337
338 #define ACPI_TRACE_ENTRY(Name, Function, Type, Param) \
339     ACPI_FUNCTION_NAME (Name) \
340     Function (ACPI_DEBUG_PARAMETERS, (Type) (Param))
341
342 /* The actual entry trace macros */
343
344 #define ACPI_FUNCTION_TRACE(Name) \
345     ACPI_FUNCTION_NAME(Name) \
346     AcpiUtTrace (ACPI_DEBUG_PARAMETERS)
347
348 #define ACPI_FUNCTION_TRACE_PTR(Name, Pointer) \
349     ACPI_TRACE_ENTRY (Name, AcpiUtTracePtr, void *, Pointer)
350
351 #define ACPI_FUNCTION_TRACE_U32(Name, Value) \
352     ACPI_TRACE_ENTRY (Name, AcpiUtTraceU32, UINT32, Value)
353
354 #define ACPI_FUNCTION_TRACE_STR(Name, String) \
355     ACPI_TRACE_ENTRY (Name, AcpiUtTraceStr, char *, String)
356
357 #define ACPI_FUNCTION_ENTRY() \
358     AcpiUtTrackStackPtr()
359
360
361 /*
362  * Function exit tracing
363  *
364  * These macros include a return statement. This is usually considered
365  * bad form, but having a separate exit macro before the actual return
366  * is very ugly and difficult to maintain.
367  *
368  * One of the FUNCTION_TRACE macros above must be used in conjunction
369  * with these macros so that "_AcpiFunctionName" is defined.
370  *
371  * There are two versions of most of the return macros. The default version is
372  * safer, since it avoids side-effects by guaranteeing that the argument will
373  * not be evaluated twice.
374  *
375  * A less-safe version of the macros is provided for optional use if the
376  * compiler uses excessive CPU stack (for example, this may happen in the
377  * debug case if code optimzation is disabled.)
378  */
379
380 /* Exit trace helper macro */
381
382 #ifndef ACPI_SIMPLE_RETURN_MACROS
383
384 #define ACPI_TRACE_EXIT(Function, Type, Param) \
385     ACPI_DO_WHILE0 ({ \
386         register Type _Param = (Type) (Param); \
387         Function (ACPI_DEBUG_PARAMETERS, _Param); \
388         return (_Param); \
389     })
390
391 #else /* Use original less-safe macros */
392
393 #define ACPI_TRACE_EXIT(Function, Type, Param) \
394     ACPI_DO_WHILE0 ({ \
395         Function (ACPI_DEBUG_PARAMETERS, (Type) (Param)); \
396         return (Param); \
397     })
398
399 #endif /* ACPI_SIMPLE_RETURN_MACROS */
400
401 /* The actual exit macros */
402
403 #define return_VOID \
404     ACPI_DO_WHILE0 ({ \
405         AcpiUtExit (ACPI_DEBUG_PARAMETERS); \
406         return; \
407     })
408
409 #define return_ACPI_STATUS(Status) \
410     ACPI_TRACE_EXIT (AcpiUtStatusExit, ACPI_STATUS, Status)
411
412 #define return_PTR(Pointer) \
413     ACPI_TRACE_EXIT (AcpiUtPtrExit, void *, Pointer)
414
415 #define return_VALUE(Value) \
416     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT64, Value)
417
418 #define return_UINT32(Value) \
419     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT32, Value)
420
421 #define return_UINT8(Value) \
422     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT8, Value)
423
424 /* Conditional execution */
425
426 #define ACPI_DEBUG_EXEC(a)              a
427 #define ACPI_DEBUG_ONLY_MEMBERS(a)      a;
428 #define _VERBOSE_STRUCTURES
429
430
431 /* Various object display routines for debug */
432
433 #define ACPI_DUMP_STACK_ENTRY(a)        AcpiExDumpOperand((a), 0)
434 #define ACPI_DUMP_OPERANDS(a, b ,c)     AcpiExDumpOperands(a, b, c)
435 #define ACPI_DUMP_ENTRY(a, b)           AcpiNsDumpEntry (a, b)
436 #define ACPI_DUMP_PATHNAME(a, b, c, d)  AcpiNsDumpPathname(a, b, c, d)
437 #define ACPI_DUMP_BUFFER(a, b)          AcpiUtDebugDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
438
439 #else /* ACPI_DEBUG_OUTPUT */
440 /*
441  * This is the non-debug case -- make everything go away,
442  * leaving no executable debug code!
443  */
444 #define ACPI_DEBUG_PRINT(pl)
445 #define ACPI_DEBUG_PRINT_RAW(pl)
446 #define ACPI_DEBUG_EXEC(a)
447 #define ACPI_DEBUG_ONLY_MEMBERS(a)
448 #define ACPI_FUNCTION_NAME(a)
449 #define ACPI_FUNCTION_TRACE(a)
450 #define ACPI_FUNCTION_TRACE_PTR(a, b)
451 #define ACPI_FUNCTION_TRACE_U32(a, b)
452 #define ACPI_FUNCTION_TRACE_STR(a, b)
453 #define ACPI_FUNCTION_ENTRY()
454 #define ACPI_DUMP_STACK_ENTRY(a)
455 #define ACPI_DUMP_OPERANDS(a, b, c)
456 #define ACPI_DUMP_ENTRY(a, b)
457 #define ACPI_DUMP_PATHNAME(a, b, c, d)
458 #define ACPI_DUMP_BUFFER(a, b)
459 #define ACPI_IS_DEBUG_ENABLED(Level, Component) 0
460
461 /* Return macros must have a return statement at the minimum */
462
463 #define return_VOID                     return
464 #define return_ACPI_STATUS(s)           return(s)
465 #define return_PTR(s)                   return(s)
466 #define return_VALUE(s)                 return(s)
467 #define return_UINT8(s)                 return(s)
468 #define return_UINT32(s)                return(s)
469
470 #endif /* ACPI_DEBUG_OUTPUT */
471
472
473 #pragma pack(pop) /* Restore original struct packing */
474
475 #endif /* __ACOUTPUT_H__ */