reactos/drivers/bus/acpi/acpica/include/acoutput.h

   1 /******************************************************************************
   2  *
   3  * Name: acoutput.h -- debug output
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #ifndef __ACOUTPUT_H__
 117 #define __ACOUTPUT_H__
 118
 119 /*
 120  * Debug levels and component IDs. These are used to control the
 121  * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
 122  * per-component basis and a per-exception-type basis.
 123  */
 124
 125 /* Component IDs are used in the global "DebugLayer" */
 126
 127 #define ACPI_UTILITIES              0x00000001
 128 #define ACPI_HARDWARE               0x00000002
 129 #define ACPI_EVENTS                 0x00000004
 130 #define ACPI_TABLES                 0x00000008
 131 #define ACPI_NAMESPACE              0x00000010
 132 #define ACPI_PARSER                 0x00000020
 133 #define ACPI_DISPATCHER             0x00000040
 134 #define ACPI_EXECUTER               0x00000080
 135 #define ACPI_RESOURCES              0x00000100
 136 #define ACPI_CA_DEBUGGER            0x00000200
 137 #define ACPI_OS_SERVICES            0x00000400
 138 #define ACPI_CA_DISASSEMBLER        0x00000800
 139
 140 /* Component IDs for ACPI tools and utilities */
 141
 142 #define ACPI_COMPILER               0x00001000
 143 #define ACPI_TOOLS                  0x00002000
 144 #define ACPI_EXAMPLE                0x00004000
 145 #define ACPI_DRIVER                 0x00008000
 146 #define DT_COMPILER                 0x00010000
 147 #define ASL_PREPROCESSOR            0x00020000
 148
 149 #define ACPI_ALL_COMPONENTS         0x0001FFFF
 150 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
 151
 152 /* Component IDs reserved for ACPI drivers */
 153
 154 #define ACPI_ALL_DRIVERS            0xFFFF0000
 155
 156
 157 /*
 158  * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
 159  */
 160 #define ACPI_LV_INIT                0x00000001
 161 #define ACPI_LV_DEBUG_OBJECT        0x00000002
 162 #define ACPI_LV_INFO                0x00000004
 163 #define ACPI_LV_REPAIR              0x00000008
 164 #define ACPI_LV_ALL_EXCEPTIONS      0x0000000F
 165
 166 /* Trace verbosity level 1 [Standard Trace Level] */
 167
 168 #define ACPI_LV_INIT_NAMES          0x00000020
 169 #define ACPI_LV_PARSE               0x00000040
 170 #define ACPI_LV_LOAD                0x00000080
 171 #define ACPI_LV_DISPATCH            0x00000100
 172 #define ACPI_LV_EXEC                0x00000200
 173 #define ACPI_LV_NAMES               0x00000400
 174 #define ACPI_LV_OPREGION            0x00000800
 175 #define ACPI_LV_BFIELD              0x00001000
 176 #define ACPI_LV_TABLES              0x00002000
 177 #define ACPI_LV_VALUES              0x00004000
 178 #define ACPI_LV_OBJECTS             0x00008000
 179 #define ACPI_LV_RESOURCES           0x00010000
 180 #define ACPI_LV_USER_REQUESTS       0x00020000
 181 #define ACPI_LV_PACKAGE             0x00040000
 182 #define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
 183
 184 /* Trace verbosity level 2 [Function tracing and memory allocation] */
 185
 186 #define ACPI_LV_ALLOCATIONS         0x00100000
 187 #define ACPI_LV_FUNCTIONS           0x00200000
 188 #define ACPI_LV_OPTIMIZATIONS       0x00400000
 189 #define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
 190 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
 191
 192 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
 193
 194 #define ACPI_LV_MUTEX               0x01000000
 195 #define ACPI_LV_THREADS             0x02000000
 196 #define ACPI_LV_IO                  0x04000000
 197 #define ACPI_LV_INTERRUPTS          0x08000000
 198 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
 199
 200 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
 201
 202 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
 203 #define ACPI_LV_VERBOSE_INFO        0x20000000
 204 #define ACPI_LV_FULL_TABLES         0x40000000
 205 #define ACPI_LV_EVENTS              0x80000000
 206 #define ACPI_LV_VERBOSE             0xF0000000
 207
 208
 209 /*
 210  * Debug level macros that are used in the DEBUG_PRINT macros
 211  */
 212 #define ACPI_DEBUG_LEVEL(dl)        (UINT32) dl,ACPI_DEBUG_PARAMETERS
 213
 214 /*
 215  * Exception level -- used in the global "DebugLevel"
 216  *
 217  * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
 218  * For warnings, use ACPI_WARNING.
 219  */
 220 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
 221 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
 222 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
 223 #define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
 224 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
 225
 226 /* Trace level -- also used in the global "DebugLevel" */
 227
 228 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
 229 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
 230 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
 231 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
 232 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
 233 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
 234 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
 235 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
 236 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
 237 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
 238 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
 239 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
 240 #define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
 241 #define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
 242 #define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
 243 #define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
 244 #define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
 245 #define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
 246 #define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
 247 #define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
 248 #define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
 249 #define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
 250
 251 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
 252
 253 /* Defaults for DebugLevel, debug and normal */
 254
 255 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
 256 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
 257 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
 258
 259
 260 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
 261 /*
 262  * The module name is used primarily for error and debug messages.
 263  * The __FILE__ macro is not very useful for this, because it
 264  * usually includes the entire pathname to the module making the
 265  * debug output difficult to read.
 266  */
 267 #define ACPI_MODULE_NAME(Name)          static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name;
 268 #else
 269 /*
 270  * For the no-debug and no-error-msg cases, we must at least define
 271  * a null module name.
 272  */
 273 #define ACPI_MODULE_NAME(Name)
 274 #define _AcpiModuleName ""
 275 #endif
 276
 277 /*
 278  * Ascii error messages can be configured out
 279  */
 280 #ifndef ACPI_NO_ERROR_MESSAGES
 281 #define AE_INFO                         _AcpiModuleName, __LINE__
 282
 283 /*
 284  * Error reporting. Callers module and line number are inserted by AE_INFO,
 285  * the plist contains a set of parens to allow variable-length lists.
 286  * These macros are used for both the debug and non-debug versions of the code.
 287  */
 288 #define ACPI_INFO(plist)                AcpiInfo plist
 289 #define ACPI_WARNING(plist)             AcpiWarning plist
 290 #define ACPI_EXCEPTION(plist)           AcpiException plist
 291 #define ACPI_ERROR(plist)               AcpiError plist
 292 #define ACPI_BIOS_WARNING(plist)        AcpiBiosWarning plist
 293 #define ACPI_BIOS_ERROR(plist)          AcpiBiosError plist
 294 #define ACPI_DEBUG_OBJECT(obj,l,i)      AcpiExDoDebugObject(obj,l,i)
 295
 296 #else
 297
 298 /* No error messages */
 299
 300 #define ACPI_INFO(plist)
 301 #define ACPI_WARNING(plist)
 302 #define ACPI_EXCEPTION(plist)
 303 #define ACPI_ERROR(plist)
 304 #define ACPI_BIOS_WARNING(plist)
 305 #define ACPI_BIOS_ERROR(plist)
 306 #define ACPI_DEBUG_OBJECT(obj,l,i)
 307
 308 #endif /* ACPI_NO_ERROR_MESSAGES */
 309
 310
 311 /*
 312  * Debug macros that are conditionally compiled
 313  */
 314 #ifdef ACPI_DEBUG_OUTPUT
 315
 316 /*
 317  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
 318  * define it now. This is the case where there the compiler does not support
 319  * a __FUNCTION__ macro or equivalent.
 320  */
 321 #ifndef ACPI_GET_FUNCTION_NAME
 322 #define ACPI_GET_FUNCTION_NAME          _AcpiFunctionName
 323
 324 /*
 325  * The Name parameter should be the procedure name as a quoted string.
 326  * The function name is also used by the function exit macros below.
 327  * Note: (const char) is used to be compatible with the debug interfaces
 328  * and macros such as __FUNCTION__.
 329  */
 330 #define ACPI_FUNCTION_NAME(Name)        static const char _AcpiFunctionName[] = #Name;
 331
 332 #else
 333 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
 334
 335 #define ACPI_FUNCTION_NAME(Name)
 336 #endif /* ACPI_GET_FUNCTION_NAME */
 337
 338 /*
 339  * Common parameters used for debug output functions:
 340  * line number, function name, module(file) name, component ID
 341  */
 342 #define ACPI_DEBUG_PARAMETERS \
 343     __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT
 344
 345 /* Check if debug output is currently dynamically enabled */
 346
 347 #define ACPI_IS_DEBUG_ENABLED(Level, Component) \
 348     ((Level & AcpiDbgLevel) && (Component & AcpiDbgLayer))
 349
 350 /*
 351  * Master debug print macros
 352  * Print message if and only if:
 353  *    1) Debug print for the current component is enabled
 354  *    2) Debug error level or trace level for the print statement is enabled
 355  *
 356  * November 2012: Moved the runtime check for whether to actually emit the
 357  * debug message outside of the print function itself. This improves overall
 358  * performance at a relatively small code cost. Implementation involves the
 359  * use of variadic macros supported by C99.
 360  *
 361  * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
 362  * complaining about these constructs. On other compilers the do...while
 363  * adds some extra code, so this feature is optional.
 364  */
 365 #ifdef ACPI_USE_DO_WHILE_0
 366 #define ACPI_DO_WHILE0(a)               do a while(0)
 367 #else
 368 #define ACPI_DO_WHILE0(a)               a
 369 #endif
 370
 371 /* DEBUG_PRINT functions */
 372
 373 #define ACPI_DEBUG_PRINT(plist)         ACPI_ACTUAL_DEBUG plist
 374 #define ACPI_DEBUG_PRINT_RAW(plist)     ACPI_ACTUAL_DEBUG_RAW plist
 375
 376 /* Helper macros for DEBUG_PRINT */
 377
 378 #define ACPI_DO_DEBUG_PRINT(Function, Level, Line, Filename, Modulename, Component, ...) \
 379     ACPI_DO_WHILE0 ({ \
 380         if (ACPI_IS_DEBUG_ENABLED (Level, Component)) \
 381         { \
 382             Function (Level, Line, Filename, Modulename, Component, __VA_ARGS__); \
 383         } \
 384     })
 385
 386 #define ACPI_ACTUAL_DEBUG(Level, Line, Filename, Modulename, Component, ...) \
 387     ACPI_DO_DEBUG_PRINT (AcpiDebugPrint, Level, Line, \
 388         Filename, Modulename, Component, __VA_ARGS__)
 389
 390 #define ACPI_ACTUAL_DEBUG_RAW(Level, Line, Filename, Modulename, Component, ...) \
 391     ACPI_DO_DEBUG_PRINT (AcpiDebugPrintRaw, Level, Line, \
 392         Filename, Modulename, Component, __VA_ARGS__)
 393
 394
 395 /*
 396  * Function entry tracing
 397  *
 398  * The name of the function is emitted as a local variable that is
 399  * intended to be used by both the entry trace and the exit trace.
 400  */
 401
 402 /* Helper macro */
 403
 404 #define ACPI_TRACE_ENTRY(Name, Function, Type, Param) \
 405     ACPI_FUNCTION_NAME (Name) \
 406     Function (ACPI_DEBUG_PARAMETERS, (Type) (Param))
 407
 408 /* The actual entry trace macros */
 409
 410 #define ACPI_FUNCTION_TRACE(Name) \
 411     ACPI_FUNCTION_NAME(Name) \
 412     AcpiUtTrace (ACPI_DEBUG_PARAMETERS)
 413
 414 #define ACPI_FUNCTION_TRACE_PTR(Name, Pointer) \
 415     ACPI_TRACE_ENTRY (Name, AcpiUtTracePtr, void *, Pointer)
 416
 417 #define ACPI_FUNCTION_TRACE_U32(Name, Value) \
 418     ACPI_TRACE_ENTRY (Name, AcpiUtTraceU32, UINT32, Value)
 419
 420 #define ACPI_FUNCTION_TRACE_STR(Name, String) \
 421     ACPI_TRACE_ENTRY (Name, AcpiUtTraceStr, char *, String)
 422
 423 #define ACPI_FUNCTION_ENTRY() \
 424     AcpiUtTrackStackPtr()
 425
 426
 427 /*
 428  * Function exit tracing
 429  *
 430  * These macros include a return statement. This is usually considered
 431  * bad form, but having a separate exit macro before the actual return
 432  * is very ugly and difficult to maintain.
 433  *
 434  * One of the FUNCTION_TRACE macros above must be used in conjunction
 435  * with these macros so that "_AcpiFunctionName" is defined.
 436  *
 437  * There are two versions of most of the return macros. The default version is
 438  * safer, since it avoids side-effects by guaranteeing that the argument will
 439  * not be evaluated twice.
 440  *
 441  * A less-safe version of the macros is provided for optional use if the
 442  * compiler uses excessive CPU stack (for example, this may happen in the
 443  * debug case if code optimzation is disabled.)
 444  */
 445
 446 /* Exit trace helper macro */
 447
 448 #ifndef ACPI_SIMPLE_RETURN_MACROS
 449
 450 #define ACPI_TRACE_EXIT(Function, Type, Param) \
 451     ACPI_DO_WHILE0 ({ \
 452         register Type _Param = (Type) (Param); \
 453         Function (ACPI_DEBUG_PARAMETERS, _Param); \
 454         return (_Param); \
 455     })
 456
 457 #else /* Use original less-safe macros */
 458
 459 #define ACPI_TRACE_EXIT(Function, Type, Param) \
 460     ACPI_DO_WHILE0 ({ \
 461         Function (ACPI_DEBUG_PARAMETERS, (Type) (Param)); \
 462         return (Param); \
 463     })
 464
 465 #endif /* ACPI_SIMPLE_RETURN_MACROS */
 466
 467 /* The actual exit macros */
 468
 469 #define return_VOID \
 470     ACPI_DO_WHILE0 ({ \
 471         AcpiUtExit (ACPI_DEBUG_PARAMETERS); \
 472         return; \
 473     })
 474
 475 #define return_ACPI_STATUS(Status) \
 476     ACPI_TRACE_EXIT (AcpiUtStatusExit, ACPI_STATUS, Status)
 477
 478 #define return_PTR(Pointer) \
 479     ACPI_TRACE_EXIT (AcpiUtPtrExit, void *, Pointer)
 480
 481 #define return_VALUE(Value) \
 482     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT64, Value)
 483
 484 #define return_UINT32(Value) \
 485     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT32, Value)
 486
 487 #define return_UINT8(Value) \
 488     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT8, Value)
 489
 490 /* Conditional execution */
 491
 492 #define ACPI_DEBUG_EXEC(a)              a
 493 #define ACPI_DEBUG_ONLY_MEMBERS(a)      a;
 494 #define _VERBOSE_STRUCTURES
 495
 496
 497 /* Various object display routines for debug */
 498
 499 #define ACPI_DUMP_STACK_ENTRY(a)        AcpiExDumpOperand((a), 0)
 500 #define ACPI_DUMP_OPERANDS(a, b ,c)     AcpiExDumpOperands(a, b, c)
 501 #define ACPI_DUMP_ENTRY(a, b)           AcpiNsDumpEntry (a, b)
 502 #define ACPI_DUMP_PATHNAME(a, b, c, d)  AcpiNsDumpPathname(a, b, c, d)
 503 #define ACPI_DUMP_BUFFER(a, b)          AcpiUtDebugDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
 504
 505 #else /* ACPI_DEBUG_OUTPUT */
 506 /*
 507  * This is the non-debug case -- make everything go away,
 508  * leaving no executable debug code!
 509  */
 510 #define ACPI_DEBUG_PRINT(pl)
 511 #define ACPI_DEBUG_PRINT_RAW(pl)
 512 #define ACPI_DEBUG_EXEC(a)
 513 #define ACPI_DEBUG_ONLY_MEMBERS(a)
 514 #define ACPI_FUNCTION_NAME(a)
 515 #define ACPI_FUNCTION_TRACE(a)
 516 #define ACPI_FUNCTION_TRACE_PTR(a, b)
 517 #define ACPI_FUNCTION_TRACE_U32(a, b)
 518 #define ACPI_FUNCTION_TRACE_STR(a, b)
 519 #define ACPI_FUNCTION_ENTRY()
 520 #define ACPI_DUMP_STACK_ENTRY(a)
 521 #define ACPI_DUMP_OPERANDS(a, b, c)
 522 #define ACPI_DUMP_ENTRY(a, b)
 523 #define ACPI_DUMP_PATHNAME(a, b, c, d)
 524 #define ACPI_DUMP_BUFFER(a, b)
 525 #define ACPI_IS_DEBUG_ENABLED(Level, Component) 0
 526
 527 /* Return macros must have a return statement at the minimum */
 528
 529 #define return_VOID                     return
 530 #define return_ACPI_STATUS(s)           return(s)
 531 #define return_PTR(s)                   return(s)
 532 #define return_VALUE(s)                 return(s)
 533 #define return_UINT8(s)                 return(s)
 534 #define return_UINT32(s)                return(s)
 535
 536 #endif /* ACPI_DEBUG_OUTPUT */
 537
 538
 539 #endif /* __ACOUTPUT_H__ */