acoutput.h revision 204773
1256381Smarkm/****************************************************************************** 272671Smarkm * 372671Smarkm * Name: acoutput.h -- debug output 472671Smarkm * 572671Smarkm *****************************************************************************/ 672671Smarkm 772671Smarkm/****************************************************************************** 872671Smarkm * 972671Smarkm * 1. Copyright Notice 1072671Smarkm * 1172671Smarkm * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp. 1272671Smarkm * All rights reserved. 1372671Smarkm * 1472671Smarkm * 2. License 1572671Smarkm * 1672671Smarkm * 2.1. This is your license from Intel Corp. under its intellectual property 1772671Smarkm * rights. You may have additional license terms from the party that provided 1872671Smarkm * you this software, covering your right to use that party's intellectual 1972671Smarkm * property rights. 2072671Smarkm * 2172671Smarkm * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2272671Smarkm * copy of the source code appearing in this file ("Covered Code") an 2372671Smarkm * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2472671Smarkm * base code distributed originally by Intel ("Original Intel Code") to copy, 2572671Smarkm * make derivatives, distribute, use and display any portion of the Covered 26256381Smarkm * Code in any form, with the right to sublicense such rights; and 2772671Smarkm * 2872671Smarkm * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 2972671Smarkm * license (with the right to sublicense), under only those claims of Intel 3072671Smarkm * patents that are infringed by the Original Intel Code, to make, use, sell, 3172671Smarkm * offer to sell, and import the Covered Code and derivative works thereof 32136085Ssimon * solely to the minimum extent necessary to exercise the above copyright 33136085Ssimon * license, and in no event shall the patent license extend to any additions 3472671Smarkm * to or modifications of the Original Intel Code. No other license or right 3572671Smarkm * is granted directly or by implication, estoppel or otherwise; 3672671Smarkm * 37130582Sru * The above copyright and patent license is granted only if the following 38128061Smarkm * conditions are met: 39128061Smarkm * 40128061Smarkm * 3. Conditions 41128061Smarkm * 42128061Smarkm * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43128061Smarkm * Redistribution of source code of any substantial portion of the Covered 44128061Smarkm * Code or modification with rights to further distribute source must include 45128061Smarkm * the above Copyright Notice, the above License, this list of Conditions, 4672671Smarkm * and the following Disclaimer and Export Compliance provision. In addition, 47256381Smarkm * Licensee must cause all Covered Code to which Licensee contributes to 48256381Smarkm * contain a file documenting the changes Licensee made to create that Covered 49256381Smarkm * Code and the date of any change. Licensee must include in that file the 50256381Smarkm * documentation of any changes made by any predecessor Licensee. Licensee 51256381Smarkm * must include a prominent statement that the modification is derived, 52256381Smarkm * directly or indirectly, from Original Intel Code. 53256381Smarkm * 54256381Smarkm * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55256381Smarkm * Redistribution of source code of any substantial portion of the Covered 56256381Smarkm * Code or modification without rights to further distribute source must 57256381Smarkm * include the following Disclaimer and Export Compliance provision in the 58256381Smarkm * documentation and/or other materials provided with distribution. In 59256381Smarkm * addition, Licensee may not authorize further sublicense of source of any 60256381Smarkm * portion of the Covered Code, and must include terms to the effect that the 61256381Smarkm * license from Licensee to its licensee is limited to the intellectual 62256381Smarkm * property embodied in the software Licensee provides to its licensee, and 63256381Smarkm * not to intellectual property embodied in modifications its licensee may 64256381Smarkm * make. 65256381Smarkm * 66256381Smarkm * 3.3. Redistribution of Executable. Redistribution in executable form of any 67256381Smarkm * substantial portion of the Covered Code or modification must reproduce the 68256381Smarkm * above Copyright Notice, and the following Disclaimer and Export Compliance 69256381Smarkm * provision in the documentation and/or other materials provided with the 70256381Smarkm * distribution. 71256381Smarkm * 72256381Smarkm * 3.4. Intel retains all right, title, and interest in and to the Original 73256381Smarkm * Intel Code. 74256381Smarkm * 75256381Smarkm * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76256381Smarkm * Intel shall be used in advertising or otherwise to promote the sale, use or 77256381Smarkm * other dealings in products derived from or relating to the Covered Code 78256381Smarkm * without prior written authorization from Intel. 7972671Smarkm * 80256381Smarkm * 4. Disclaimer and Export Compliance 81256381Smarkm * 82256381Smarkm * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83256381Smarkm * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84256381Smarkm * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85256381Smarkm * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86256381Smarkm * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87256381Smarkm * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8872671Smarkm * PARTICULAR PURPOSE. 89139214Skeramida * 90139214Skeramida * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91139214Skeramida * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9272671Smarkm * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9372671Smarkm * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9472671Smarkm * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9572708Smarkm * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9672671Smarkm * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97256381Smarkm * LIMITED REMEDY. 98256381Smarkm * 99256381Smarkm * 4.3. Licensee shall not export, either directly or indirectly, any of this 100256381Smarkm * software or system incorporating such software without first obtaining any 101256381Smarkm * required license or other approval from the U. S. Department of Commerce or 102256381Smarkm * any other agency or department of the United States Government. In the 103256381Smarkm * event Licensee exports any such software from the United States or 10472671Smarkm * re-exports any such software from a foreign destination, Licensee shall 105160496Sbrueffer * ensure that the distribution and export/re-export of the software is in 106160496Sbrueffer * compliance with all laws, regulations, orders, or other restrictions of the 107160496Sbrueffer * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108256381Smarkm * any of its subsidiaries will export/re-export any technical data, process, 10972671Smarkm * software, or service, directly or indirectly, to any country for which the 110130582Sru * United States government or any agency thereof requires an export license, 111254147Sobrien * other governmental approval, or letter of assurance, without first obtaining 112254147Sobrien * such license, approval or letter. 113254147Sobrien * 11472671Smarkm *****************************************************************************/ 11572671Smarkm 11672708Smarkm#ifndef __ACOUTPUT_H__ 11772671Smarkm#define __ACOUTPUT_H__ 11872671Smarkm 11972671Smarkm/* 12072671Smarkm * Debug levels and component IDs. These are used to control the 121256381Smarkm * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a 122256381Smarkm * per-component basis and a per-exception-type basis. 123256381Smarkm */ 124256381Smarkm 12572671Smarkm/* Component IDs are used in the global "DebugLayer" */ 12672671Smarkm 12772671Smarkm#define ACPI_UTILITIES 0x00000001 12874077Smarkm#define ACPI_HARDWARE 0x00000002 12972671Smarkm#define ACPI_EVENTS 0x00000004 130124759Sschweikh#define ACPI_TABLES 0x00000008 13172671Smarkm#define ACPI_NAMESPACE 0x00000010 132124759Sschweikh#define ACPI_PARSER 0x00000020 13372671Smarkm#define ACPI_DISPATCHER 0x00000040 13472671Smarkm#define ACPI_EXECUTER 0x00000080 13572671Smarkm#define ACPI_RESOURCES 0x00000100 13674077Smarkm#define ACPI_CA_DEBUGGER 0x00000200 13772671Smarkm#define ACPI_OS_SERVICES 0x00000400 13872671Smarkm#define ACPI_CA_DISASSEMBLER 0x00000800 139124759Sschweikh 14072671Smarkm/* Component IDs for ACPI tools and utilities */ 141124759Sschweikh 14272671Smarkm#define ACPI_COMPILER 0x00001000 14372671Smarkm#define ACPI_TOOLS 0x00002000 14472671Smarkm#define ACPI_EXAMPLE 0x00004000 14574077Smarkm#define ACPI_DRIVER 0x00008000 14672671Smarkm 14772671Smarkm#define ACPI_ALL_COMPONENTS 0x0000FFFF 148160496Sbrueffer#define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS) 14972671Smarkm 150124759Sschweikh/* Component IDs reserved for ACPI drivers */ 15172671Smarkm 152162404Sru#define ACPI_ALL_DRIVERS 0xFFFF0000 15373378Smarkm 15472671Smarkm 155160496Sbrueffer/* 156160496Sbrueffer * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros 157160496Sbrueffer */ 158160496Sbrueffer#define ACPI_LV_INIT 0x00000001 159160496Sbrueffer#define ACPI_LV_DEBUG_OBJECT 0x00000002 160160496Sbrueffer#define ACPI_LV_INFO 0x00000004 161160496Sbrueffer#define ACPI_LV_REPAIR 0x00000008 162160496Sbrueffer#define ACPI_LV_ALL_EXCEPTIONS 0x0000000F 163160496Sbrueffer 16472671Smarkm/* Trace verbosity level 1 [Standard Trace Level] */ 16572671Smarkm 16672671Smarkm#define ACPI_LV_INIT_NAMES 0x00000020 167240205Szeising#define ACPI_LV_PARSE 0x00000040 16874077Smarkm#define ACPI_LV_LOAD 0x00000080 16974077Smarkm#define ACPI_LV_DISPATCH 0x00000100 17074077Smarkm#define ACPI_LV_EXEC 0x00000200 17174077Smarkm#define ACPI_LV_NAMES 0x00000400 17274077Smarkm#define ACPI_LV_OPREGION 0x00000800 17374153Sru#define ACPI_LV_BFIELD 0x00001000 17474077Smarkm#define ACPI_LV_TABLES 0x00002000 17574153Sru#define ACPI_LV_VALUES 0x00004000 17674077Smarkm#define ACPI_LV_OBJECTS 0x00008000 17774153Sru#define ACPI_LV_RESOURCES 0x00010000 17874077Smarkm#define ACPI_LV_USER_REQUESTS 0x00020000 17974153Sru#define ACPI_LV_PACKAGE 0x00040000 18074077Smarkm#define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS 18174153Sru 18274077Smarkm/* Trace verbosity level 2 [Function tracing and memory allocation] */ 18374077Smarkm 18474077Smarkm#define ACPI_LV_ALLOCATIONS 0x00100000 18574153Sru#define ACPI_LV_FUNCTIONS 0x00200000 18674077Smarkm#define ACPI_LV_OPTIMIZATIONS 0x00400000 18774077Smarkm#define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1 188111320Sdwmalone#define ACPI_LV_ALL ACPI_LV_VERBOSITY2 189111320Sdwmalone 190111320Sdwmalone/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */ 191111320Sdwmalone 192111320Sdwmalone#define ACPI_LV_MUTEX 0x01000000 193111320Sdwmalone#define ACPI_LV_THREADS 0x02000000 194111320Sdwmalone#define ACPI_LV_IO 0x04000000 195111320Sdwmalone#define ACPI_LV_INTERRUPTS 0x08000000 196111320Sdwmalone#define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2 197111320Sdwmalone 198111320Sdwmalone/* Exceptionally verbose output -- also used in the global "DebugLevel" */ 199111320Sdwmalone 200111320Sdwmalone#define ACPI_LV_AML_DISASSEMBLE 0x10000000 201111320Sdwmalone#define ACPI_LV_VERBOSE_INFO 0x20000000 202111320Sdwmalone#define ACPI_LV_FULL_TABLES 0x40000000 203111326Sdwmalone#define ACPI_LV_EVENTS 0x80000000 204111320Sdwmalone#define ACPI_LV_VERBOSE 0xF0000000 205111320Sdwmalone 206111320Sdwmalone 207111320Sdwmalone/* 208111320Sdwmalone * Debug level macros that are used in the DEBUG_PRINT macros 209111320Sdwmalone */ 210111320Sdwmalone#define ACPI_DEBUG_LEVEL(dl) (UINT32) dl,ACPI_DEBUG_PARAMETERS 211111320Sdwmalone 212111320Sdwmalone/* 213111320Sdwmalone * Exception level -- used in the global "DebugLevel" 214111320Sdwmalone * 215111326Sdwmalone * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces. 216111326Sdwmalone * For warnings, use ACPI_WARNING. 217111326Sdwmalone */ 218111326Sdwmalone#define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT) 219111326Sdwmalone#define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT) 220111326Sdwmalone#define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO) 221111326Sdwmalone#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR) 222111326Sdwmalone#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS) 223111320Sdwmalone 224111320Sdwmalone/* Trace level -- also used in the global "DebugLevel" */ 225111320Sdwmalone 226111320Sdwmalone#define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES) 227111320Sdwmalone#define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS) 228111320Sdwmalone#define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE) 229111320Sdwmalone#define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH) 230111320Sdwmalone#define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD) 231111320Sdwmalone#define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC) 232111320Sdwmalone#define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES) 233111447Sru#define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION) 234111320Sdwmalone#define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD) 235111320Sdwmalone#define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES) 236111320Sdwmalone#define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS) 237111320Sdwmalone#define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS) 238111320Sdwmalone#define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES) 239111447Sru#define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS) 240111320Sdwmalone#define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS) 241111320Sdwmalone#define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES) 242131530Sru#define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO) 243131530Sru#define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS) 244111320Sdwmalone#define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS) 245111320Sdwmalone#define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE) 246111447Sru#define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX) 247111320Sdwmalone#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS) 248111320Sdwmalone 249111320Sdwmalone#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL) 250111320Sdwmalone 251111447Sru/* Defaults for DebugLevel, debug and normal */ 252111320Sdwmalone 253111320Sdwmalone#define ACPI_DEBUG_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR) 254111320Sdwmalone#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR) 255111447Sru#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL) 256111447Sru 257111320Sdwmalone 258111320Sdwmalone#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES) 259111320Sdwmalone/* 260111320Sdwmalone * Module name is included in both debug and non-debug versions primarily for 261111320Sdwmalone * error messages. The __FILE__ macro is not very useful for this, because it 262111320Sdwmalone * often includes the entire pathname to the module 263111320Sdwmalone */ 264111320Sdwmalone#define ACPI_MODULE_NAME(Name) static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name; 265111320Sdwmalone#else 266111320Sdwmalone#define ACPI_MODULE_NAME(Name) 267111320Sdwmalone#endif 268111320Sdwmalone 269111320Sdwmalone/* 270111320Sdwmalone * Ascii error messages can be configured out 271111326Sdwmalone */ 272111320Sdwmalone#ifndef ACPI_NO_ERROR_MESSAGES 273111320Sdwmalone#define AE_INFO _AcpiModuleName, __LINE__ 274111320Sdwmalone 275111320Sdwmalone/* 276111320Sdwmalone * Error reporting. Callers module and line number are inserted by AE_INFO, 277111320Sdwmalone * the plist contains a set of parens to allow variable-length lists. 278111320Sdwmalone * These macros are used for both the debug and non-debug versions of the code. 279111447Sru */ 280111447Sru#define ACPI_INFO(plist) AcpiInfo plist 281111320Sdwmalone#define ACPI_WARNING(plist) AcpiWarning plist 282111320Sdwmalone#define ACPI_EXCEPTION(plist) AcpiException plist 283111320Sdwmalone#define ACPI_ERROR(plist) AcpiError plist 284111320Sdwmalone#define ACPI_DEBUG_OBJECT(obj,l,i) AcpiExDoDebugObject(obj,l,i) 285111320Sdwmalone 286111320Sdwmalone#else 287111320Sdwmalone 288111320Sdwmalone/* No error messages */ 289111320Sdwmalone 290111320Sdwmalone#define ACPI_INFO(plist) 291111320Sdwmalone#define ACPI_WARNING(plist) 292111320Sdwmalone#define ACPI_EXCEPTION(plist) 293111320Sdwmalone#define ACPI_ERROR(plist) 294111320Sdwmalone#define ACPI_DEBUG_OBJECT(obj,l,i) 295111320Sdwmalone 296111320Sdwmalone#endif /* ACPI_NO_ERROR_MESSAGES */ 297111320Sdwmalone 298111320Sdwmalone 299111320Sdwmalone/* 30072671Smarkm * Debug macros that are conditionally compiled 301111447Sru */ 30272671Smarkm#ifdef ACPI_DEBUG_OUTPUT 30372671Smarkm 30473378Smarkm/* 305111320Sdwmalone * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header, 306111320Sdwmalone * define it now. This is the case where there the compiler does not support 307111320Sdwmalone * a __FUNCTION__ macro or equivalent. 308111447Sru */ 309111447Sru#ifndef ACPI_GET_FUNCTION_NAME 310131594Sru#define ACPI_GET_FUNCTION_NAME _AcpiFunctionName 31173378Smarkm 31272671Smarkm/* 31372671Smarkm * The Name parameter should be the procedure name as a quoted string. 31472671Smarkm * The function name is also used by the function exit macros below. 31572671Smarkm * Note: (const char) is used to be compatible with the debug interfaces 31672671Smarkm * and macros such as __FUNCTION__. 31772671Smarkm */ 318128061Smarkm#define ACPI_FUNCTION_NAME(Name) static const char _AcpiFunctionName[] = #Name; 31972671Smarkm 32072671Smarkm#else 32172671Smarkm/* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */ 32273378Smarkm 32372671Smarkm#define ACPI_FUNCTION_NAME(Name) 32472671Smarkm#endif /* ACPI_GET_FUNCTION_NAME */ 32572671Smarkm 32672671Smarkm/* 327256381Smarkm * Common parameters used for debug output functions: 328128061Smarkm * line number, function name, module(file) name, component ID 329128061Smarkm */ 330128061Smarkm#define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT 331 332/* 333 * Master debug print macros 334 * Print message if and only if: 335 * 1) Debug print for the current component is enabled 336 * 2) Debug error level or trace level for the print statement is enabled 337 */ 338#define ACPI_DEBUG_PRINT(plist) AcpiDebugPrint plist 339#define ACPI_DEBUG_PRINT_RAW(plist) AcpiDebugPrintRaw plist 340 341#else 342/* 343 * This is the non-debug case -- make everything go away, 344 * leaving no executable debug code! 345 */ 346#define ACPI_FUNCTION_NAME(a) 347#define ACPI_DEBUG_PRINT(pl) 348#define ACPI_DEBUG_PRINT_RAW(pl) 349 350#endif /* ACPI_DEBUG_OUTPUT */ 351 352 353#endif /* __ACOUTPUT_H__ */ 354