Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:23:41

0001 /******************************************************************************
0002  *
0003  * Name: acoutput.h -- debug output
0004  *
0005  *****************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151 
0152 #ifndef __ACOUTPUT_H__
0153 #define __ACOUTPUT_H__
0154 
0155 /*
0156  * Debug levels and component IDs. These are used to control the
0157  * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
0158  * per-component basis and a per-exception-type basis.
0159  */
0160 
0161 /* Component IDs are used in the global "DebugLayer" */
0162 
0163 #define ACPI_UTILITIES              0x00000001
0164 #define ACPI_HARDWARE               0x00000002
0165 #define ACPI_EVENTS                 0x00000004
0166 #define ACPI_TABLES                 0x00000008
0167 #define ACPI_NAMESPACE              0x00000010
0168 #define ACPI_PARSER                 0x00000020
0169 #define ACPI_DISPATCHER             0x00000040
0170 #define ACPI_EXECUTER               0x00000080
0171 #define ACPI_RESOURCES              0x00000100
0172 #define ACPI_CA_DEBUGGER            0x00000200
0173 #define ACPI_OS_SERVICES            0x00000400
0174 #define ACPI_CA_DISASSEMBLER        0x00000800
0175 
0176 /* Component IDs for ACPI tools and utilities */
0177 
0178 #define ACPI_COMPILER               0x00001000
0179 #define ACPI_TOOLS                  0x00002000
0180 #define ACPI_EXAMPLE                0x00004000
0181 #define ACPI_DRIVER                 0x00008000
0182 #define DT_COMPILER                 0x00010000
0183 #define ASL_PREPROCESSOR            0x00020000
0184 
0185 #define ACPI_ALL_COMPONENTS         0x0001FFFF
0186 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
0187 
0188 /* Component IDs reserved for ACPI drivers */
0189 
0190 #define ACPI_ALL_DRIVERS            0xFFFF0000
0191 
0192 
0193 /*
0194  * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
0195  */
0196 #define ACPI_LV_INIT                0x00000001
0197 #define ACPI_LV_DEBUG_OBJECT        0x00000002
0198 #define ACPI_LV_INFO                0x00000004
0199 #define ACPI_LV_REPAIR              0x00000008
0200 #define ACPI_LV_TRACE_POINT         0x00000010
0201 #define ACPI_LV_ALL_EXCEPTIONS      0x0000001F
0202 
0203 /* Trace verbosity level 1 [Standard Trace Level] */
0204 
0205 #define ACPI_LV_INIT_NAMES          0x00000020
0206 #define ACPI_LV_PARSE               0x00000040
0207 #define ACPI_LV_LOAD                0x00000080
0208 #define ACPI_LV_DISPATCH            0x00000100
0209 #define ACPI_LV_EXEC                0x00000200
0210 #define ACPI_LV_NAMES               0x00000400
0211 #define ACPI_LV_OPREGION            0x00000800
0212 #define ACPI_LV_BFIELD              0x00001000
0213 #define ACPI_LV_TABLES              0x00002000
0214 #define ACPI_LV_VALUES              0x00004000
0215 #define ACPI_LV_OBJECTS             0x00008000
0216 #define ACPI_LV_RESOURCES           0x00010000
0217 #define ACPI_LV_USER_REQUESTS       0x00020000
0218 #define ACPI_LV_PACKAGE             0x00040000
0219 #define ACPI_LV_EVALUATION          0x00080000
0220 #define ACPI_LV_VERBOSITY1          0x000FFF40 | ACPI_LV_ALL_EXCEPTIONS
0221 
0222 /* Trace verbosity level 2 [Function tracing and memory allocation] */
0223 
0224 #define ACPI_LV_ALLOCATIONS         0x00100000
0225 #define ACPI_LV_FUNCTIONS           0x00200000
0226 #define ACPI_LV_OPTIMIZATIONS       0x00400000
0227 #define ACPI_LV_PARSE_TREES         0x00800000
0228 #define ACPI_LV_VERBOSITY2          0x00F00000 | ACPI_LV_VERBOSITY1
0229 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
0230 
0231 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
0232 
0233 #define ACPI_LV_MUTEX               0x01000000
0234 #define ACPI_LV_THREADS             0x02000000
0235 #define ACPI_LV_IO                  0x04000000
0236 #define ACPI_LV_INTERRUPTS          0x08000000
0237 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
0238 
0239 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
0240 
0241 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
0242 #define ACPI_LV_VERBOSE_INFO        0x20000000
0243 #define ACPI_LV_FULL_TABLES         0x40000000
0244 #define ACPI_LV_EVENTS              0x80000000
0245 #define ACPI_LV_VERBOSE             0xF0000000
0246 
0247 
0248 /*
0249  * Debug level macros that are used in the DEBUG_PRINT macros
0250  */
0251 #define ACPI_DEBUG_LEVEL(dl)        (UINT32) dl,ACPI_DEBUG_PARAMETERS
0252 
0253 /*
0254  * Exception level -- used in the global "DebugLevel"
0255  *
0256  * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
0257  * For warnings, use ACPI_WARNING.
0258  */
0259 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
0260 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
0261 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
0262 #define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
0263 #define ACPI_DB_TRACE_POINT         ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
0264 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
0265 
0266 /* Trace level -- also used in the global "DebugLevel" */
0267 
0268 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
0269 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
0270 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
0271 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
0272 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
0273 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
0274 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
0275 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
0276 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
0277 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
0278 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
0279 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
0280 #define ACPI_DB_PARSE_TREES         ACPI_DEBUG_LEVEL (ACPI_LV_PARSE_TREES)
0281 #define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
0282 #define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
0283 #define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
0284 #define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
0285 #define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
0286 #define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
0287 #define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
0288 #define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
0289 #define ACPI_DB_EVALUATION          ACPI_DEBUG_LEVEL (ACPI_LV_EVALUATION)
0290 #define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
0291 #define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
0292 
0293 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
0294 
0295 /* Defaults for DebugLevel, debug and normal */
0296 
0297 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_EVALUATION | ACPI_LV_REPAIR)
0298 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
0299 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
0300 
0301 
0302 /*
0303  * Global trace flags
0304  */
0305 #define ACPI_TRACE_ENABLED          ((UINT32) 4)
0306 #define ACPI_TRACE_ONESHOT          ((UINT32) 2)
0307 #define ACPI_TRACE_OPCODE           ((UINT32) 1)
0308 
0309 /* Defaults for trace debugging level/layer */
0310 
0311 #define ACPI_TRACE_LEVEL_ALL        ACPI_LV_ALL
0312 #define ACPI_TRACE_LAYER_ALL        0x000001FF
0313 #define ACPI_TRACE_LEVEL_DEFAULT    ACPI_LV_TRACE_POINT
0314 #define ACPI_TRACE_LAYER_DEFAULT    ACPI_EXECUTER
0315 
0316 
0317 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
0318 /*
0319  * The module name is used primarily for error and debug messages.
0320  * The __FILE__ macro is not very useful for this, because it
0321  * usually includes the entire pathname to the module making the
0322  * debug output difficult to read.
0323  */
0324 #define ACPI_MODULE_NAME(Name)          static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name;
0325 #else
0326 /*
0327  * For the no-debug and no-error-msg cases, we must at least define
0328  * a null module name.
0329  */
0330 #define ACPI_MODULE_NAME(Name)
0331 #define _AcpiModuleName ""
0332 #endif
0333 
0334 /*
0335  * Ascii error messages can be configured out
0336  */
0337 #ifndef ACPI_NO_ERROR_MESSAGES
0338 #define AE_INFO                         _AcpiModuleName, __LINE__
0339 #define ACPI_ONCE(_fn, _plist)                  { static char _done; if (!_done) { _done = 1; _fn _plist; } }
0340 
0341 /*
0342  * Error reporting. Callers module and line number are inserted by AE_INFO,
0343  * the plist contains a set of parens to allow variable-length lists.
0344  * These macros are used for both the debug and non-debug versions of the code.
0345  */
0346 #define ACPI_INFO(plist)                AcpiInfo plist
0347 #define ACPI_WARNING(plist)             AcpiWarning plist
0348 #define ACPI_WARNING_ONCE(plist)        ACPI_ONCE(AcpiWarning, plist)
0349 #define ACPI_EXCEPTION(plist)           AcpiException plist
0350 #define ACPI_ERROR(plist)               AcpiError plist
0351 #define ACPI_ERROR_ONCE(plist)          ACPI_ONCE(AcpiError, plist)
0352 #define ACPI_BIOS_WARNING(plist)        AcpiBiosWarning plist
0353 #define ACPI_BIOS_EXCEPTION(plist)      AcpiBiosException plist
0354 #define ACPI_BIOS_ERROR(plist)          AcpiBiosError plist
0355 #define ACPI_DEBUG_OBJECT(obj,l,i)      AcpiExDoDebugObject(obj,l,i)
0356 
0357 #else
0358 
0359 /* No error messages */
0360 
0361 #define ACPI_INFO(plist)
0362 #define ACPI_WARNING(plist)
0363 #define ACPI_WARNING_ONCE(plist)
0364 #define ACPI_EXCEPTION(plist)
0365 #define ACPI_ERROR(plist)
0366 #define ACPI_ERROR_ONCE(plist)
0367 #define ACPI_BIOS_WARNING(plist)
0368 #define ACPI_BIOS_EXCEPTION(plist)
0369 #define ACPI_BIOS_ERROR(plist)
0370 #define ACPI_DEBUG_OBJECT(obj,l,i)
0371 
0372 #endif /* ACPI_NO_ERROR_MESSAGES */
0373 
0374 
0375 /*
0376  * Debug macros that are conditionally compiled
0377  */
0378 #ifdef ACPI_DEBUG_OUTPUT
0379 
0380 /*
0381  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
0382  * define it now. This is the case where there the compiler does not support
0383  * a __FUNCTION__ macro or equivalent.
0384  */
0385 #ifndef ACPI_GET_FUNCTION_NAME
0386 #define ACPI_GET_FUNCTION_NAME          _AcpiFunctionName
0387 
0388 /*
0389  * The Name parameter should be the procedure name as a non-quoted string.
0390  * The function name is also used by the function exit macros below.
0391  * Note: (const char) is used to be compatible with the debug interfaces
0392  * and macros such as __FUNCTION__.
0393  */
0394 #define ACPI_FUNCTION_NAME(Name)        static const char _AcpiFunctionName[] = #Name;
0395 
0396 #else
0397 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
0398 
0399 #define ACPI_FUNCTION_NAME(Name)
0400 #endif /* ACPI_GET_FUNCTION_NAME */
0401 
0402 /*
0403  * Common parameters used for debug output functions:
0404  * line number, function name, module(file) name, component ID
0405  */
0406 #define ACPI_DEBUG_PARAMETERS \
0407     __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT
0408 
0409 /* Check if debug output is currently dynamically enabled */
0410 
0411 #define ACPI_IS_DEBUG_ENABLED(Level, Component) \
0412     ((Level & AcpiDbgLevel) && (Component & AcpiDbgLayer))
0413 
0414 /*
0415  * Master debug print macros
0416  * Print message if and only if:
0417  *    1) Debug print for the current component is enabled
0418  *    2) Debug error level or trace level for the print statement is enabled
0419  *
0420  * November 2012: Moved the runtime check for whether to actually emit the
0421  * debug message outside of the print function itself. This improves overall
0422  * performance at a relatively small code cost. Implementation involves the
0423  * use of variadic macros supported by C99.
0424  *
0425  * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
0426  * complaining about these constructs. On other compilers the do...while
0427  * adds some extra code, so this feature is optional.
0428  */
0429 #ifdef ACPI_USE_DO_WHILE_0
0430 #define ACPI_DO_WHILE0(a)               do a while(0)
0431 #else
0432 #define ACPI_DO_WHILE0(a)               a
0433 #endif
0434 
0435 /* DEBUG_PRINT functions */
0436 
0437 #ifndef COMPILER_VA_MACRO
0438 
0439 #define ACPI_DEBUG_PRINT(plist)         AcpiDebugPrint plist
0440 #define ACPI_DEBUG_PRINT_RAW(plist)     AcpiDebugPrintRaw plist
0441 
0442 #else
0443 
0444 /* Helper macros for DEBUG_PRINT */
0445 
0446 #define ACPI_DO_DEBUG_PRINT(Function, Level, Line, Filename, Modulename, Component, ...) \
0447     ACPI_DO_WHILE0 ({ \
0448         if (ACPI_IS_DEBUG_ENABLED (Level, Component)) \
0449         { \
0450             Function (Level, Line, Filename, Modulename, Component, __VA_ARGS__); \
0451         } \
0452     })
0453 
0454 #define ACPI_ACTUAL_DEBUG(Level, Line, Filename, Modulename, Component, ...) \
0455     ACPI_DO_DEBUG_PRINT (AcpiDebugPrint, Level, Line, \
0456         Filename, Modulename, Component, __VA_ARGS__)
0457 
0458 #define ACPI_ACTUAL_DEBUG_RAW(Level, Line, Filename, Modulename, Component, ...) \
0459     ACPI_DO_DEBUG_PRINT (AcpiDebugPrintRaw, Level, Line, \
0460         Filename, Modulename, Component, __VA_ARGS__)
0461 
0462 #define ACPI_DEBUG_PRINT(plist)         ACPI_ACTUAL_DEBUG plist
0463 #define ACPI_DEBUG_PRINT_RAW(plist)     ACPI_ACTUAL_DEBUG_RAW plist
0464 
0465 #endif
0466 
0467 
0468 /*
0469  * Function entry tracing
0470  *
0471  * The name of the function is emitted as a local variable that is
0472  * intended to be used by both the entry trace and the exit trace.
0473  */
0474 
0475 /* Helper macro */
0476 
0477 #define ACPI_TRACE_ENTRY(Name, Function, Type, Param) \
0478     ACPI_FUNCTION_NAME (Name) \
0479     Function (ACPI_DEBUG_PARAMETERS, (Type) (Param))
0480 
0481 /* The actual entry trace macros */
0482 
0483 #define ACPI_FUNCTION_TRACE(Name) \
0484     ACPI_FUNCTION_NAME(Name) \
0485     AcpiUtTrace (ACPI_DEBUG_PARAMETERS)
0486 
0487 #define ACPI_FUNCTION_TRACE_PTR(Name, Pointer) \
0488     ACPI_TRACE_ENTRY (Name, AcpiUtTracePtr, void *, Pointer)
0489 
0490 #define ACPI_FUNCTION_TRACE_U32(Name, Value) \
0491     ACPI_TRACE_ENTRY (Name, AcpiUtTraceU32, UINT32, Value)
0492 
0493 #define ACPI_FUNCTION_TRACE_STR(Name, String) \
0494     ACPI_TRACE_ENTRY (Name, AcpiUtTraceStr, const char *, String)
0495 
0496 #define ACPI_FUNCTION_ENTRY() \
0497     AcpiUtTrackStackPtr()
0498 
0499 
0500 /*
0501  * Function exit tracing
0502  *
0503  * These macros include a return statement. This is usually considered
0504  * bad form, but having a separate exit macro before the actual return
0505  * is very ugly and difficult to maintain.
0506  *
0507  * One of the FUNCTION_TRACE macros above must be used in conjunction
0508  * with these macros so that "_AcpiFunctionName" is defined.
0509  *
0510  * There are two versions of most of the return macros. The default version is
0511  * safer, since it avoids side-effects by guaranteeing that the argument will
0512  * not be evaluated twice.
0513  *
0514  * A less-safe version of the macros is provided for optional use if the
0515  * compiler uses excessive CPU stack (for example, this may happen in the
0516  * debug case if code optimization is disabled.)
0517  */
0518 
0519 /* Exit trace helper macro */
0520 
0521 #ifndef ACPI_SIMPLE_RETURN_MACROS
0522 
0523 #define ACPI_TRACE_EXIT(Function, Type, Param) \
0524     ACPI_DO_WHILE0 ({ \
0525         register Type _Param = (Type) (Param); \
0526         Function (ACPI_DEBUG_PARAMETERS, _Param); \
0527         return (_Param); \
0528     })
0529 
0530 #else /* Use original less-safe macros */
0531 
0532 #define ACPI_TRACE_EXIT(Function, Type, Param) \
0533     ACPI_DO_WHILE0 ({ \
0534         Function (ACPI_DEBUG_PARAMETERS, (Type) (Param)); \
0535         return (Param); \
0536     })
0537 
0538 #endif /* ACPI_SIMPLE_RETURN_MACROS */
0539 
0540 /* The actual exit macros */
0541 
0542 #define return_VOID \
0543     ACPI_DO_WHILE0 ({ \
0544         AcpiUtExit (ACPI_DEBUG_PARAMETERS); \
0545         return; \
0546     })
0547 
0548 #define return_ACPI_STATUS(Status) \
0549     ACPI_TRACE_EXIT (AcpiUtStatusExit, ACPI_STATUS, Status)
0550 
0551 #define return_PTR(Pointer) \
0552     ACPI_TRACE_EXIT (AcpiUtPtrExit, void *, Pointer)
0553 
0554 #define return_STR(String) \
0555     ACPI_TRACE_EXIT (AcpiUtStrExit, const char *, String)
0556 
0557 #define return_VALUE(Value) \
0558     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT64, Value)
0559 
0560 #define return_UINT32(Value) \
0561     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT32, Value)
0562 
0563 #define return_UINT8(Value) \
0564     ACPI_TRACE_EXIT (AcpiUtValueExit, UINT8, Value)
0565 
0566 /* Conditional execution */
0567 
0568 #define ACPI_DEBUG_EXEC(a)              a
0569 #define ACPI_DEBUG_ONLY_MEMBERS(a)      a
0570 #define _VERBOSE_STRUCTURES
0571 
0572 
0573 /* Various object display routines for debug */
0574 
0575 #define ACPI_DUMP_STACK_ENTRY(a)        AcpiExDumpOperand((a), 0)
0576 #define ACPI_DUMP_OPERANDS(a, b ,c)     AcpiExDumpOperands(a, b, c)
0577 #define ACPI_DUMP_ENTRY(a, b)           AcpiNsDumpEntry (a, b)
0578 #define ACPI_DUMP_PATHNAME(a, b, c, d)  AcpiNsDumpPathname(a, b, c, d)
0579 #define ACPI_DUMP_BUFFER(a, b)          AcpiUtDebugDumpBuffer((UINT8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
0580 
0581 #define ACPI_TRACE_POINT(a, b, c, d)    AcpiTracePoint (a, b, c, d)
0582 
0583 #else /* ACPI_DEBUG_OUTPUT */
0584 /*
0585  * This is the non-debug case -- make everything go away,
0586  * leaving no executable debug code!
0587  */
0588 #define ACPI_DEBUG_PRINT(pl)
0589 #define ACPI_DEBUG_PRINT_RAW(pl)
0590 #define ACPI_DEBUG_EXEC(a)
0591 #define ACPI_DEBUG_ONLY_MEMBERS(a)
0592 #define ACPI_FUNCTION_NAME(a)
0593 #define ACPI_FUNCTION_TRACE(a)
0594 #define ACPI_FUNCTION_TRACE_PTR(a, b)
0595 #define ACPI_FUNCTION_TRACE_U32(a, b)
0596 #define ACPI_FUNCTION_TRACE_STR(a, b)
0597 #define ACPI_FUNCTION_ENTRY()
0598 #define ACPI_DUMP_STACK_ENTRY(a)
0599 #define ACPI_DUMP_OPERANDS(a, b, c)
0600 #define ACPI_DUMP_ENTRY(a, b)
0601 #define ACPI_DUMP_PATHNAME(a, b, c, d)
0602 #define ACPI_DUMP_BUFFER(a, b)
0603 #define ACPI_IS_DEBUG_ENABLED(Level, Component) 0
0604 #define ACPI_TRACE_POINT(a, b, c, d)
0605 
0606 /* Return macros must have a return statement at the minimum */
0607 
0608 #define return_VOID                     return
0609 #define return_ACPI_STATUS(s)           return(s)
0610 #define return_PTR(s)                   return(s)
0611 #define return_STR(s)                   return(s)
0612 #define return_VALUE(s)                 return(s)
0613 #define return_UINT8(s)                 return(s)
0614 #define return_UINT32(s)                return(s)
0615 
0616 #endif /* ACPI_DEBUG_OUTPUT */
0617 
0618 
0619 #endif /* __ACOUTPUT_H__ */