LXR linux/include/acpi/acoutput.h

   1/******************************************************************************
   2 *
   3 * Name: acoutput.h -- debug output
   4 *
   5 *****************************************************************************/
   6
   7/*
   8 * Copyright (C) 2000 - 2012, Intel Corp.
   9 * All rights reserved.
  10 *
  11 * Redistribution and use in source and binary forms, with or without
  12 * modification, are permitted provided that the following conditions
  13 * are met:
  14 * 1. Redistributions of source code must retain the above copyright
  15 *    notice, this list of conditions, and the following disclaimer,
  16 *    without modification.
  17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18 *    substantially similar to the "NO WARRANTY" disclaimer below
  19 *    ("Disclaimer") and any redistribution must be conditioned upon
  20 *    including a substantially similar Disclaimer requirement for further
  21 *    binary redistribution.
  22 * 3. Neither the names of the above-listed copyright holders nor the names
  23 *    of any contributors may be used to endorse or promote products derived
  24 *    from this software without specific prior written permission.
  25 *
  26 * Alternatively, this software may be distributed under the terms of the
  27 * GNU General Public License ("GPL") version 2 as published by the Free
  28 * Software Foundation.
  29 *
  30 * NO WARRANTY
  31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41 * POSSIBILITY OF SUCH DAMAGES.
  42 */
  43
  44#ifndef __ACOUTPUT_H__
  45#define __ACOUTPUT_H__
  46
  47/*
  48 * Debug levels and component IDs. These are used to control the
  49 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
  50 * per-component basis and a per-exception-type basis.
  51 */
  52
  53/* Component IDs are used in the global "DebugLayer" */
  54
  55#define ACPI_UTILITIES              0x00000001
  56#define ACPI_HARDWARE               0x00000002
  57#define ACPI_EVENTS                 0x00000004
  58#define ACPI_TABLES                 0x00000008
  59#define ACPI_NAMESPACE              0x00000010
  60#define ACPI_PARSER                 0x00000020
  61#define ACPI_DISPATCHER             0x00000040
  62#define ACPI_EXECUTER               0x00000080
  63#define ACPI_RESOURCES              0x00000100
  64#define ACPI_CA_DEBUGGER            0x00000200
  65#define ACPI_OS_SERVICES            0x00000400
  66#define ACPI_CA_DISASSEMBLER        0x00000800
  67
  68/* Component IDs for ACPI tools and utilities */
  69
  70#define ACPI_COMPILER               0x00001000
  71#define ACPI_TOOLS                  0x00002000
  72#define ACPI_EXAMPLE                0x00004000
  73#define ACPI_DRIVER                 0x00008000
  74#define DT_COMPILER                 0x00010000
  75
  76#define ACPI_ALL_COMPONENTS         0x0001FFFF
  77#define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
  78
  79/* Component IDs reserved for ACPI drivers */
  80
  81#define ACPI_ALL_DRIVERS            0xFFFF0000
  82
  83/*
  84 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
  85 */
  86#define ACPI_LV_INIT                0x00000001
  87#define ACPI_LV_DEBUG_OBJECT        0x00000002
  88#define ACPI_LV_INFO                0x00000004
  89#define ACPI_LV_REPAIR              0x00000008
  90#define ACPI_LV_ALL_EXCEPTIONS      0x0000000F
  91
  92/* Trace verbosity level 1 [Standard Trace Level] */
  93
  94#define ACPI_LV_INIT_NAMES          0x00000020
  95#define ACPI_LV_PARSE               0x00000040
  96#define ACPI_LV_LOAD                0x00000080
  97#define ACPI_LV_DISPATCH            0x00000100
  98#define ACPI_LV_EXEC                0x00000200
  99#define ACPI_LV_NAMES               0x00000400
 100#define ACPI_LV_OPREGION            0x00000800
 101#define ACPI_LV_BFIELD              0x00001000
 102#define ACPI_LV_TABLES              0x00002000
 103#define ACPI_LV_VALUES              0x00004000
 104#define ACPI_LV_OBJECTS             0x00008000
 105#define ACPI_LV_RESOURCES           0x00010000
 106#define ACPI_LV_USER_REQUESTS       0x00020000
 107#define ACPI_LV_PACKAGE             0x00040000
 108#define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
 109
 110/* Trace verbosity level 2 [Function tracing and memory allocation] */
 111
 112#define ACPI_LV_ALLOCATIONS         0x00100000
 113#define ACPI_LV_FUNCTIONS           0x00200000
 114#define ACPI_LV_OPTIMIZATIONS       0x00400000
 115#define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
 116#define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
 117
 118/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
 119
 120#define ACPI_LV_MUTEX               0x01000000
 121#define ACPI_LV_THREADS             0x02000000
 122#define ACPI_LV_IO                  0x04000000
 123#define ACPI_LV_INTERRUPTS          0x08000000
 124#define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
 125
 126/* Exceptionally verbose output -- also used in the global "DebugLevel"  */
 127
 128#define ACPI_LV_AML_DISASSEMBLE     0x10000000
 129#define ACPI_LV_VERBOSE_INFO        0x20000000
 130#define ACPI_LV_FULL_TABLES         0x40000000
 131#define ACPI_LV_EVENTS              0x80000000
 132#define ACPI_LV_VERBOSE             0xF0000000
 133
 134/*
 135 * Debug level macros that are used in the DEBUG_PRINT macros
 136 */
 137#define ACPI_DEBUG_LEVEL(dl)        (u32) dl,ACPI_DEBUG_PARAMETERS
 138
 139/*
 140 * Exception level -- used in the global "DebugLevel"
 141 *
 142 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
 143 * For warnings, use ACPI_WARNING.
 144 */
 145#define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
 146#define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
 147#define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
 148#define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
 149#define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
 150
 151/* Trace level -- also used in the global "DebugLevel" */
 152
 153#define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
 154#define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
 155#define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
 156#define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
 157#define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
 158#define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
 159#define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
 160#define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
 161#define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
 162#define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
 163#define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
 164#define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
 165#define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
 166#define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
 167#define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
 168#define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
 169#define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
 170#define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
 171#define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
 172#define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
 173#define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
 174#define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
 175
 176#define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
 177
 178/* Defaults for debug_level, debug and normal */
 179
 180#define ACPI_DEBUG_DEFAULT          (ACPI_LV_INFO | ACPI_LV_REPAIR)
 181#define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
 182#define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
 183
 184#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
 185/*
 186 * The module name is used primarily for error and debug messages.
 187 * The __FILE__ macro is not very useful for this, because it
 188 * usually includes the entire pathname to the module making the
 189 * debug output difficult to read.
 190 */
 191#define ACPI_MODULE_NAME(name)          static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
 192#else
 193/*
 194 * For the no-debug and no-error-msg cases, we must at least define
 195 * a null module name.
 196 */
 197#define ACPI_MODULE_NAME(name)
 198#define _acpi_module_name ""
 199#endif
 200
 201/*
 202 * Ascii error messages can be configured out
 203 */
 204#ifndef ACPI_NO_ERROR_MESSAGES
 205#define AE_INFO                         _acpi_module_name, __LINE__
 206
 207/*
 208 * Error reporting. Callers module and line number are inserted by AE_INFO,
 209 * the plist contains a set of parens to allow variable-length lists.
 210 * These macros are used for both the debug and non-debug versions of the code.
 211 */
 212#define ACPI_INFO(plist)                acpi_info plist
 213#define ACPI_WARNING(plist)             acpi_warning plist
 214#define ACPI_EXCEPTION(plist)           acpi_exception plist
 215#define ACPI_ERROR(plist)               acpi_error plist
 216#define ACPI_BIOS_WARNING(plist)        acpi_bios_warning plist
 217#define ACPI_BIOS_ERROR(plist)          acpi_bios_error plist
 218#define ACPI_DEBUG_OBJECT(obj,l,i)      acpi_ex_do_debug_object(obj,l,i)
 219
 220#else
 221
 222/* No error messages */
 223
 224#define ACPI_INFO(plist)
 225#define ACPI_WARNING(plist)
 226#define ACPI_EXCEPTION(plist)
 227#define ACPI_ERROR(plist)
 228#define ACPI_BIOS_WARNING(plist)
 229#define ACPI_BIOS_ERROR(plist)
 230#define ACPI_DEBUG_OBJECT(obj,l,i)
 231
 232#endif                          /* ACPI_NO_ERROR_MESSAGES */
 233
 234/*
 235 * Debug macros that are conditionally compiled
 236 */
 237#ifdef ACPI_DEBUG_OUTPUT
 238
 239/*
 240 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
 241 * define it now. This is the case where there the compiler does not support
 242 * a __FUNCTION__ macro or equivalent.
 243 */
 244#ifndef ACPI_GET_FUNCTION_NAME
 245#define ACPI_GET_FUNCTION_NAME          _acpi_function_name
 246
 247/*
 248 * The Name parameter should be the procedure name as a quoted string.
 249 * The function name is also used by the function exit macros below.
 250 * Note: (const char) is used to be compatible with the debug interfaces
 251 * and macros such as __FUNCTION__.
 252 */
 253#define ACPI_FUNCTION_NAME(name)        static const char _acpi_function_name[] = #name;
 254
 255#else
 256/* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
 257
 258#define ACPI_FUNCTION_NAME(name)
 259#endif                          /* ACPI_GET_FUNCTION_NAME */
 260
 261/*
 262 * Common parameters used for debug output functions:
 263 * line number, function name, module(file) name, component ID
 264 */
 265#define ACPI_DEBUG_PARAMETERS           __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
 266
 267/*
 268 * Master debug print macros
 269 * Print message if and only if:
 270 *    1) Debug print for the current component is enabled
 271 *    2) Debug error level or trace level for the print statement is enabled
 272 */
 273#define ACPI_DEBUG_PRINT(plist)         acpi_debug_print plist
 274#define ACPI_DEBUG_PRINT_RAW(plist)     acpi_debug_print_raw plist
 275
 276#else
 277/*
 278 * This is the non-debug case -- make everything go away,
 279 * leaving no executable debug code!
 280 */
 281#define ACPI_FUNCTION_NAME(a)
 282#define ACPI_DEBUG_PRINT(pl)
 283#define ACPI_DEBUG_PRINT_RAW(pl)
 284
 285#endif                          /* ACPI_DEBUG_OUTPUT */
 286
 287#endif                          /* __ACOUTPUT_H__ */
 288