354 lines
15 KiB
C
354 lines
15 KiB
C
/******************************************************************************
|
|
*
|
|
* Name: acoutput.h -- debug output
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/******************************************************************************
|
|
*
|
|
* 1. Copyright Notice
|
|
*
|
|
* Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
|
|
* All rights reserved.
|
|
*
|
|
* 2. License
|
|
*
|
|
* 2.1. This is your license from Intel Corp. under its intellectual property
|
|
* rights. You may have additional license terms from the party that provided
|
|
* you this software, covering your right to use that party's intellectual
|
|
* property rights.
|
|
*
|
|
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
|
|
* copy of the source code appearing in this file ("Covered Code") an
|
|
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
|
|
* base code distributed originally by Intel ("Original Intel Code") to copy,
|
|
* make derivatives, distribute, use and display any portion of the Covered
|
|
* Code in any form, with the right to sublicense such rights; and
|
|
*
|
|
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
|
|
* license (with the right to sublicense), under only those claims of Intel
|
|
* patents that are infringed by the Original Intel Code, to make, use, sell,
|
|
* offer to sell, and import the Covered Code and derivative works thereof
|
|
* solely to the minimum extent necessary to exercise the above copyright
|
|
* license, and in no event shall the patent license extend to any additions
|
|
* to or modifications of the Original Intel Code. No other license or right
|
|
* is granted directly or by implication, estoppel or otherwise;
|
|
*
|
|
* The above copyright and patent license is granted only if the following
|
|
* conditions are met:
|
|
*
|
|
* 3. Conditions
|
|
*
|
|
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
|
|
* Redistribution of source code of any substantial portion of the Covered
|
|
* Code or modification with rights to further distribute source must include
|
|
* the above Copyright Notice, the above License, this list of Conditions,
|
|
* and the following Disclaimer and Export Compliance provision. In addition,
|
|
* Licensee must cause all Covered Code to which Licensee contributes to
|
|
* contain a file documenting the changes Licensee made to create that Covered
|
|
* Code and the date of any change. Licensee must include in that file the
|
|
* documentation of any changes made by any predecessor Licensee. Licensee
|
|
* must include a prominent statement that the modification is derived,
|
|
* directly or indirectly, from Original Intel Code.
|
|
*
|
|
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
|
|
* Redistribution of source code of any substantial portion of the Covered
|
|
* Code or modification without rights to further distribute source must
|
|
* include the following Disclaimer and Export Compliance provision in the
|
|
* documentation and/or other materials provided with distribution. In
|
|
* addition, Licensee may not authorize further sublicense of source of any
|
|
* portion of the Covered Code, and must include terms to the effect that the
|
|
* license from Licensee to its licensee is limited to the intellectual
|
|
* property embodied in the software Licensee provides to its licensee, and
|
|
* not to intellectual property embodied in modifications its licensee may
|
|
* make.
|
|
*
|
|
* 3.3. Redistribution of Executable. Redistribution in executable form of any
|
|
* substantial portion of the Covered Code or modification must reproduce the
|
|
* above Copyright Notice, and the following Disclaimer and Export Compliance
|
|
* provision in the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* 3.4. Intel retains all right, title, and interest in and to the Original
|
|
* Intel Code.
|
|
*
|
|
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
|
|
* Intel shall be used in advertising or otherwise to promote the sale, use or
|
|
* other dealings in products derived from or relating to the Covered Code
|
|
* without prior written authorization from Intel.
|
|
*
|
|
* 4. Disclaimer and Export Compliance
|
|
*
|
|
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
|
|
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
|
|
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
|
|
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
|
|
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
|
|
* PARTICULAR PURPOSE.
|
|
*
|
|
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
|
|
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
|
|
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
|
|
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
|
|
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
|
|
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
|
|
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
|
|
* LIMITED REMEDY.
|
|
*
|
|
* 4.3. Licensee shall not export, either directly or indirectly, any of this
|
|
* software or system incorporating such software without first obtaining any
|
|
* required license or other approval from the U. S. Department of Commerce or
|
|
* any other agency or department of the United States Government. In the
|
|
* event Licensee exports any such software from the United States or
|
|
* re-exports any such software from a foreign destination, Licensee shall
|
|
* ensure that the distribution and export/re-export of the software is in
|
|
* compliance with all laws, regulations, orders, or other restrictions of the
|
|
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
|
|
* any of its subsidiaries will export/re-export any technical data, process,
|
|
* software, or service, directly or indirectly, to any country for which the
|
|
* United States government or any agency thereof requires an export license,
|
|
* other governmental approval, or letter of assurance, without first obtaining
|
|
* such license, approval or letter.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
#ifndef __ACOUTPUT_H__
|
|
#define __ACOUTPUT_H__
|
|
|
|
/*
|
|
* Debug levels and component IDs. These are used to control the
|
|
* granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
|
|
* per-component basis and a per-exception-type basis.
|
|
*/
|
|
|
|
/* Component IDs are used in the global "DebugLayer" */
|
|
|
|
#define ACPI_UTILITIES 0x00000001
|
|
#define ACPI_HARDWARE 0x00000002
|
|
#define ACPI_EVENTS 0x00000004
|
|
#define ACPI_TABLES 0x00000008
|
|
#define ACPI_NAMESPACE 0x00000010
|
|
#define ACPI_PARSER 0x00000020
|
|
#define ACPI_DISPATCHER 0x00000040
|
|
#define ACPI_EXECUTER 0x00000080
|
|
#define ACPI_RESOURCES 0x00000100
|
|
#define ACPI_CA_DEBUGGER 0x00000200
|
|
#define ACPI_OS_SERVICES 0x00000400
|
|
#define ACPI_CA_DISASSEMBLER 0x00000800
|
|
|
|
/* Component IDs for ACPI tools and utilities */
|
|
|
|
#define ACPI_COMPILER 0x00001000
|
|
#define ACPI_TOOLS 0x00002000
|
|
#define ACPI_EXAMPLE 0x00004000
|
|
#define ACPI_DRIVER 0x00008000
|
|
|
|
#define ACPI_ALL_COMPONENTS 0x0000FFFF
|
|
#define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
|
|
|
|
/* Component IDs reserved for ACPI drivers */
|
|
|
|
#define ACPI_ALL_DRIVERS 0xFFFF0000
|
|
|
|
|
|
/*
|
|
* Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
|
|
*/
|
|
#define ACPI_LV_INIT 0x00000001
|
|
#define ACPI_LV_DEBUG_OBJECT 0x00000002
|
|
#define ACPI_LV_INFO 0x00000004
|
|
#define ACPI_LV_REPAIR 0x00000008
|
|
#define ACPI_LV_ALL_EXCEPTIONS 0x0000000F
|
|
|
|
/* Trace verbosity level 1 [Standard Trace Level] */
|
|
|
|
#define ACPI_LV_INIT_NAMES 0x00000020
|
|
#define ACPI_LV_PARSE 0x00000040
|
|
#define ACPI_LV_LOAD 0x00000080
|
|
#define ACPI_LV_DISPATCH 0x00000100
|
|
#define ACPI_LV_EXEC 0x00000200
|
|
#define ACPI_LV_NAMES 0x00000400
|
|
#define ACPI_LV_OPREGION 0x00000800
|
|
#define ACPI_LV_BFIELD 0x00001000
|
|
#define ACPI_LV_TABLES 0x00002000
|
|
#define ACPI_LV_VALUES 0x00004000
|
|
#define ACPI_LV_OBJECTS 0x00008000
|
|
#define ACPI_LV_RESOURCES 0x00010000
|
|
#define ACPI_LV_USER_REQUESTS 0x00020000
|
|
#define ACPI_LV_PACKAGE 0x00040000
|
|
#define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
|
|
|
|
/* Trace verbosity level 2 [Function tracing and memory allocation] */
|
|
|
|
#define ACPI_LV_ALLOCATIONS 0x00100000
|
|
#define ACPI_LV_FUNCTIONS 0x00200000
|
|
#define ACPI_LV_OPTIMIZATIONS 0x00400000
|
|
#define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1
|
|
#define ACPI_LV_ALL ACPI_LV_VERBOSITY2
|
|
|
|
/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
|
|
|
|
#define ACPI_LV_MUTEX 0x01000000
|
|
#define ACPI_LV_THREADS 0x02000000
|
|
#define ACPI_LV_IO 0x04000000
|
|
#define ACPI_LV_INTERRUPTS 0x08000000
|
|
#define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
|
|
|
|
/* Exceptionally verbose output -- also used in the global "DebugLevel" */
|
|
|
|
#define ACPI_LV_AML_DISASSEMBLE 0x10000000
|
|
#define ACPI_LV_VERBOSE_INFO 0x20000000
|
|
#define ACPI_LV_FULL_TABLES 0x40000000
|
|
#define ACPI_LV_EVENTS 0x80000000
|
|
#define ACPI_LV_VERBOSE 0xF0000000
|
|
|
|
|
|
/*
|
|
* Debug level macros that are used in the DEBUG_PRINT macros
|
|
*/
|
|
#define ACPI_DEBUG_LEVEL(dl) (UINT32) dl,ACPI_DEBUG_PARAMETERS
|
|
|
|
/*
|
|
* Exception level -- used in the global "DebugLevel"
|
|
*
|
|
* Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
|
|
* For warnings, use ACPI_WARNING.
|
|
*/
|
|
#define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
|
|
#define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
|
|
#define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
|
|
#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
|
|
#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
|
|
|
|
/* Trace level -- also used in the global "DebugLevel" */
|
|
|
|
#define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
|
|
#define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
|
|
#define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
|
|
#define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
|
|
#define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
|
|
#define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
|
|
#define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
|
|
#define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
|
|
#define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
|
|
#define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
|
|
#define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
|
|
#define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
|
|
#define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
|
|
#define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
|
|
#define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
|
|
#define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
|
|
#define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
|
|
#define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
|
|
#define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
|
|
#define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
|
|
#define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
|
|
#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
|
|
|
|
#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
|
|
|
|
/* Defaults for DebugLevel, debug and normal */
|
|
|
|
#define ACPI_DEBUG_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
|
|
#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
|
|
#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
|
|
|
|
|
|
#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
|
|
/*
|
|
* Module name is included in both debug and non-debug versions primarily for
|
|
* error messages. The __FILE__ macro is not very useful for this, because it
|
|
* often includes the entire pathname to the module
|
|
*/
|
|
#define ACPI_MODULE_NAME(Name) static const char ACPI_UNUSED_VAR _AcpiModuleName[] = Name;
|
|
#else
|
|
#define ACPI_MODULE_NAME(Name)
|
|
#endif
|
|
|
|
/*
|
|
* Ascii error messages can be configured out
|
|
*/
|
|
#ifndef ACPI_NO_ERROR_MESSAGES
|
|
#define AE_INFO _AcpiModuleName, __LINE__
|
|
|
|
/*
|
|
* Error reporting. Callers module and line number are inserted by AE_INFO,
|
|
* the plist contains a set of parens to allow variable-length lists.
|
|
* These macros are used for both the debug and non-debug versions of the code.
|
|
*/
|
|
#define ACPI_INFO(plist) AcpiInfo plist
|
|
#define ACPI_WARNING(plist) AcpiWarning plist
|
|
#define ACPI_EXCEPTION(plist) AcpiException plist
|
|
#define ACPI_ERROR(plist) AcpiError plist
|
|
#define ACPI_DEBUG_OBJECT(obj,l,i) AcpiExDoDebugObject(obj,l,i)
|
|
|
|
#else
|
|
|
|
/* No error messages */
|
|
|
|
#define ACPI_INFO(plist)
|
|
#define ACPI_WARNING(plist)
|
|
#define ACPI_EXCEPTION(plist)
|
|
#define ACPI_ERROR(plist)
|
|
#define ACPI_DEBUG_OBJECT(obj,l,i)
|
|
|
|
#endif /* ACPI_NO_ERROR_MESSAGES */
|
|
|
|
|
|
/*
|
|
* Debug macros that are conditionally compiled
|
|
*/
|
|
#ifdef ACPI_DEBUG_OUTPUT
|
|
|
|
/*
|
|
* If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
|
|
* define it now. This is the case where there the compiler does not support
|
|
* a __FUNCTION__ macro or equivalent.
|
|
*/
|
|
#ifndef ACPI_GET_FUNCTION_NAME
|
|
#define ACPI_GET_FUNCTION_NAME _AcpiFunctionName
|
|
|
|
/*
|
|
* The Name parameter should be the procedure name as a quoted string.
|
|
* The function name is also used by the function exit macros below.
|
|
* Note: (const char) is used to be compatible with the debug interfaces
|
|
* and macros such as __FUNCTION__.
|
|
*/
|
|
#define ACPI_FUNCTION_NAME(Name) static const char _AcpiFunctionName[] = #Name;
|
|
|
|
#else
|
|
/* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
|
|
|
|
#define ACPI_FUNCTION_NAME(Name)
|
|
#endif /* ACPI_GET_FUNCTION_NAME */
|
|
|
|
/*
|
|
* Common parameters used for debug output functions:
|
|
* line number, function name, module(file) name, component ID
|
|
*/
|
|
#define ACPI_DEBUG_PARAMETERS __LINE__, ACPI_GET_FUNCTION_NAME, _AcpiModuleName, _COMPONENT
|
|
|
|
/*
|
|
* Master debug print macros
|
|
* Print message if and only if:
|
|
* 1) Debug print for the current component is enabled
|
|
* 2) Debug error level or trace level for the print statement is enabled
|
|
*/
|
|
#define ACPI_DEBUG_PRINT(plist) AcpiDebugPrint plist
|
|
#define ACPI_DEBUG_PRINT_RAW(plist) AcpiDebugPrintRaw plist
|
|
|
|
#else
|
|
/*
|
|
* This is the non-debug case -- make everything go away,
|
|
* leaving no executable debug code!
|
|
*/
|
|
#define ACPI_FUNCTION_NAME(a)
|
|
#define ACPI_DEBUG_PRINT(pl)
|
|
#define ACPI_DEBUG_PRINT_RAW(pl)
|
|
|
|
#endif /* ACPI_DEBUG_OUTPUT */
|
|
|
|
|
|
#endif /* __ACOUTPUT_H__ */
|