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