Back to home page

Quest Cross Reference

 
 

    


Warning, cross-references for /kernel/include/drivers/acpi/acoutput.h need to be fixed.

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 - 2009, 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 #ifndef __ACOUTPUT_H__
0117 #define __ACOUTPUT_H__
0118 
0119 /*
0120  * Debug levels and component IDs. These are used to control the
0121  * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
0122  * per-component basis and a per-exception-type basis.
0123  */
0124 
0125 /* Component IDs are used in the global "DebugLayer" */
0126 
0127 #define ACPI_UTILITIES              0x00000001
0128 #define ACPI_HARDWARE               0x00000002
0129 #define ACPI_EVENTS                 0x00000004
0130 #define ACPI_TABLES                 0x00000008
0131 #define ACPI_NAMESPACE              0x00000010
0132 #define ACPI_PARSER                 0x00000020
0133 #define ACPI_DISPATCHER             0x00000040
0134 #define ACPI_EXECUTER               0x00000080
0135 #define ACPI_RESOURCES              0x00000100
0136 #define ACPI_CA_DEBUGGER            0x00000200
0137 #define ACPI_OS_SERVICES            0x00000400
0138 #define ACPI_CA_DISASSEMBLER        0x00000800
0139 
0140 /* Component IDs for ACPI tools and utilities */
0141 
0142 #define ACPI_COMPILER               0x00001000
0143 #define ACPI_TOOLS                  0x00002000
0144 #define ACPI_EXAMPLE                0x00004000
0145 #define ACPI_DRIVER                 0x00008000
0146 
0147 #define ACPI_ALL_COMPONENTS         0x0000FFFF
0148 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
0149 
0150 /* Component IDs reserved for ACPI drivers */
0151 
0152 #define ACPI_ALL_DRIVERS            0xFFFF0000
0153 
0154 
0155 /*
0156  * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
0157  */
0158 #define ACPI_LV_INIT                0x00000001
0159 #define ACPI_LV_DEBUG_OBJECT        0x00000002
0160 #define ACPI_LV_INFO                0x00000004
0161 #define ACPI_LV_ALL_EXCEPTIONS      0x00000007
0162 
0163 /* Trace verbosity level 1 [Standard Trace Level] */
0164 
0165 #define ACPI_LV_INIT_NAMES          0x00000020
0166 #define ACPI_LV_PARSE               0x00000040
0167 #define ACPI_LV_LOAD                0x00000080
0168 #define ACPI_LV_DISPATCH            0x00000100
0169 #define ACPI_LV_EXEC                0x00000200
0170 #define ACPI_LV_NAMES               0x00000400
0171 #define ACPI_LV_OPREGION            0x00000800
0172 #define ACPI_LV_BFIELD              0x00001000
0173 #define ACPI_LV_TABLES              0x00002000
0174 #define ACPI_LV_VALUES              0x00004000
0175 #define ACPI_LV_OBJECTS             0x00008000
0176 #define ACPI_LV_RESOURCES           0x00010000
0177 #define ACPI_LV_USER_REQUESTS       0x00020000
0178 #define ACPI_LV_PACKAGE             0x00040000
0179 #define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
0180 
0181 /* Trace verbosity level 2 [Function tracing and memory allocation] */
0182 
0183 #define ACPI_LV_ALLOCATIONS         0x00100000
0184 #define ACPI_LV_FUNCTIONS           0x00200000
0185 #define ACPI_LV_OPTIMIZATIONS       0x00400000
0186 #define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
0187 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
0188 
0189 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
0190 
0191 #define ACPI_LV_MUTEX               0x01000000
0192 #define ACPI_LV_THREADS             0x02000000
0193 #define ACPI_LV_IO                  0x04000000
0194 #define ACPI_LV_INTERRUPTS          0x08000000
0195 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
0196 
0197 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
0198 
0199 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
0200 #define ACPI_LV_VERBOSE_INFO        0x20000000
0201 #define ACPI_LV_FULL_TABLES         0x40000000
0202 #define ACPI_LV_EVENTS              0x80000000
0203 #define ACPI_LV_VERBOSE             0xF0000000
0204 
0205 
0206 /*
0207  * Debug level macros that are used in the DEBUG_PRINT macros
0208  */
0209 #define ACPI_DEBUG_LEVEL(dl)        (UINT32) dl,ACPI_DEBUG_PARAMETERS
0210 
0211 /*
0212  * Exception level -- used in the global "DebugLevel"
0213  *
0214  * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
0215  * For warnings, use ACPI_WARNING.
0216  */
0217 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
0218 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
0219 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
0220 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
0221 
0222 /* Trace level -- also used in the global "DebugLevel" */
0223 
0224 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
0225 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
0226 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
0227 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
0228 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
0229 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
0230 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
0231 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
0232 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
0233 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
0234 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
0235 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
0236 #define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
0237 #define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
0238 #define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
0239 #define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
0240 #define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
0241 #define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
0242 #define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
0243 #define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
0244 #define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
0245 #define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
0246 
0247 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
0248 
0249 /* Defaults for DebugLevel, debug and normal */
0250 
0251 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT)
0252 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT)
0253 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
0254 
0255 
0256 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
0257 /*
0258  * Module name is included in both debug and non-debug versions primarily for
0259  * error messages. The __FILE__ macro is not very useful for this, because it
0260  * often includes the entire pathname to the module
0261  */
0262 #define ACPI_MODULE_NAME(Name)          static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name;
0263 #else
0264 #define ACPI_MODULE_NAME(Name)
0265 #endif
0266 
0267 /*
0268  * Ascii error messages can be configured out
0269  */
0270 #ifndef ACPI_NO_ERROR_MESSAGES
0271 #define AE_INFO                         _AcpiModuleName, __LINE__
0272 
0273 /*
0274  * Error reporting. Callers module and line number are inserted by AE_INFO,
0275  * the plist contains a set of parens to allow variable-length lists.
0276  * These macros are used for both the debug and non-debug versions of the code.
0277  */
0278 #define ACPI_INFO(plist)                AcpiInfo plist
0279 #define ACPI_WARNING(plist)             AcpiWarning plist
0280 #define ACPI_EXCEPTION(plist)           AcpiException plist
0281 #define ACPI_ERROR(plist)               AcpiError plist
0282 
0283 #else
0284 
0285 /* No error messages */
0286 
0287 #define ACPI_INFO(plist)
0288 #define ACPI_WARNING(plist)
0289 #define ACPI_EXCEPTION(plist)
0290 #define ACPI_ERROR(plist)
0291 
0292 #endif /* ACPI_NO_ERROR_MESSAGES */
0293 
0294 
0295 /*
0296  * Debug macros that are conditionally compiled
0297  */
0298 #ifdef ACPI_DEBUG_OUTPUT
0299 
0300 /*
0301  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
0302  * define it now. This is the case where there the compiler does not support
0303  * a __FUNCTION__ macro or equivalent.
0304  */
0305 #ifndef ACPI_GET_FUNCTION_NAME
0306 #define ACPI_GET_FUNCTION_NAME          _AcpiFunctionName
0307 
0308 /*
0309  * The Name parameter should be the procedure name as a quoted string.
0310  * The function name is also used by the function exit macros below.
0311  * Note: (const char) is used to be compatible with the debug interfaces
0312  * and macros such as __FUNCTION__.
0313  */
0314 #define ACPI_FUNCTION_NAME(Name)        static const char _AcpiFunctionName[] = #Name;
0315 
0316 #else
0317 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
0318 
0319 #define ACPI_FUNCTION_NAME(Name)
0320 #endif /* ACPI_GET_FUNCTION_NAME */
0321 
0322 /*
0323  * Common parameters used for debug output functions:
0324  * line number, function name, module(file) name, component ID
0325  */
0326 #define ACPI_DEBUG_PARAMETERS           __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT
0327 
0328 /*
0329  * Master debug print macros
0330  * Print message if and only if:
0331  *    1) Debug print for the current component is enabled
0332  *    2) Debug error level or trace level for the print statement is enabled
0333  */
0334 #define ACPI_DEBUG_PRINT(plist)         AcpiDebugPrint plist
0335 #define ACPI_DEBUG_PRINT_RAW(plist)     AcpiDebugPrintRaw plist
0336 
0337 #else
0338 /*
0339  * This is the non-debug case -- make everything go away,
0340  * leaving no executable debug code!
0341  */
0342 #define ACPI_FUNCTION_NAME(a)
0343 #define ACPI_DEBUG_PRINT(pl)
0344 #define ACPI_DEBUG_PRINT_RAW(pl)
0345 
0346 #endif /* ACPI_DEBUG_OUTPUT */
0347 
0348 
0349 #endif /* __ACOUTPUT_H__ */