include/acpi/acoutput.h

   1 /******************************************************************************
   2  *
   3  * Name: acoutput.h -- debug output
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2010, 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
  75 #define ACPI_ALL_COMPONENTS         0x0000FFFF
  76 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
  77
  78 /* Component IDs reserved for ACPI drivers */
  79
  80 #define ACPI_ALL_DRIVERS            0xFFFF0000
  81
  82 /*
  83  * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
  84  */
  85 #define ACPI_LV_INIT                0x00000001
  86 #define ACPI_LV_DEBUG_OBJECT        0x00000002
  87 #define ACPI_LV_INFO                0x00000004
  88 #define ACPI_LV_REPAIR              0x00000008
  89 #define ACPI_LV_ALL_EXCEPTIONS      0x0000000F
  90
  91 /* Trace verbosity level 1 [Standard Trace Level] */
  92
  93 #define ACPI_LV_INIT_NAMES          0x00000020
  94 #define ACPI_LV_PARSE               0x00000040
  95 #define ACPI_LV_LOAD                0x00000080
  96 #define ACPI_LV_DISPATCH            0x00000100
  97 #define ACPI_LV_EXEC                0x00000200
  98 #define ACPI_LV_NAMES               0x00000400
  99 #define ACPI_LV_OPREGION            0x00000800
 100 #define ACPI_LV_BFIELD              0x00001000
 101 #define ACPI_LV_TABLES              0x00002000
 102 #define ACPI_LV_VALUES              0x00004000
 103 #define ACPI_LV_OBJECTS             0x00008000
 104 #define ACPI_LV_RESOURCES           0x00010000
 105 #define ACPI_LV_USER_REQUESTS       0x00020000
 106 #define ACPI_LV_PACKAGE             0x00040000
 107 #define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
 108
 109 /* Trace verbosity level 2 [Function tracing and memory allocation] */
 110
 111 #define ACPI_LV_ALLOCATIONS         0x00100000
 112 #define ACPI_LV_FUNCTIONS           0x00200000
 113 #define ACPI_LV_OPTIMIZATIONS       0x00400000
 114 #define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
 115 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
 116
 117 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
 118
 119 #define ACPI_LV_MUTEX               0x01000000
 120 #define ACPI_LV_THREADS             0x02000000
 121 #define ACPI_LV_IO                  0x04000000
 122 #define ACPI_LV_INTERRUPTS          0x08000000
 123 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
 124
 125 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
 126
 127 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
 128 #define ACPI_LV_VERBOSE_INFO        0x20000000
 129 #define ACPI_LV_FULL_TABLES         0x40000000
 130 #define ACPI_LV_EVENTS              0x80000000
 131 #define ACPI_LV_VERBOSE             0xF0000000
 132
 133 /*
 134  * Debug level macros that are used in the DEBUG_PRINT macros
 135  */
 136 #define ACPI_DEBUG_LEVEL(dl)        (u32) dl,ACPI_DEBUG_PARAMETERS
 137
 138 /*
 139  * Exception level -- used in the global "DebugLevel"
 140  *
 141  * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
 142  * For warnings, use ACPI_WARNING.
 143  */
 144 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
 145 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
 146 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
 147 #define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
 148 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
 149
 150 /* Trace level -- also used in the global "DebugLevel" */
 151
 152 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
 153 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
 154 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
 155 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
 156 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
 157 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
 158 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
 159 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
 160 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
 161 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
 162 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
 163 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
 164 #define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
 165 #define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
 166 #define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
 167 #define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
 168 #define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
 169 #define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
 170 #define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
 171 #define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
 172 #define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
 173 #define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
 174
 175 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
 176
 177 /* Defaults for debug_level, debug and normal */
 178
 179 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INFO | ACPI_LV_REPAIR)
 180 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
 181 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
 182
 183 #if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
 184 /*
 185  * Module name is included in both debug and non-debug versions primarily for
 186  * error messages. The __FILE__ macro is not very useful for this, because it
 187  * often includes the entire pathname to the module
 188  */
 189 #define ACPI_MODULE_NAME(name)          static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
 190 #else
 191 #define ACPI_MODULE_NAME(name)
 192 #endif
 193
 194 /*
 195  * Ascii error messages can be configured out
 196  */
 197 #ifndef ACPI_NO_ERROR_MESSAGES
 198 #define AE_INFO                         _acpi_module_name, __LINE__
 199
 200 /*
 201  * Error reporting. Callers module and line number are inserted by AE_INFO,
 202  * the plist contains a set of parens to allow variable-length lists.
 203  * These macros are used for both the debug and non-debug versions of the code.
 204  */
 205 #define ACPI_INFO(plist)                acpi_info plist
 206 #define ACPI_WARNING(plist)             acpi_warning plist
 207 #define ACPI_EXCEPTION(plist)           acpi_exception plist
 208 #define ACPI_ERROR(plist)               acpi_error plist
 209 #define ACPI_DEBUG_OBJECT(obj,l,i)      acpi_ex_do_debug_object(obj,l,i)
 210
 211 #else
 212
 213 /* No error messages */
 214
 215 #define ACPI_INFO(plist)
 216 #define ACPI_WARNING(plist)
 217 #define ACPI_EXCEPTION(plist)
 218 #define ACPI_ERROR(plist)
 219 #define ACPI_DEBUG_OBJECT(obj,l,i)
 220
 221 #endif                          /* ACPI_NO_ERROR_MESSAGES */
 222
 223 /*
 224  * Debug macros that are conditionally compiled
 225  */
 226 #ifdef ACPI_DEBUG_OUTPUT
 227
 228 /*
 229  * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
 230  * define it now. This is the case where there the compiler does not support
 231  * a __FUNCTION__ macro or equivalent.
 232  */
 233 #ifndef ACPI_GET_FUNCTION_NAME
 234 #define ACPI_GET_FUNCTION_NAME          _acpi_function_name
 235
 236 /*
 237  * The Name parameter should be the procedure name as a quoted string.
 238  * The function name is also used by the function exit macros below.
 239  * Note: (const char) is used to be compatible with the debug interfaces
 240  * and macros such as __FUNCTION__.
 241  */
 242 #define ACPI_FUNCTION_NAME(name)        static const char _acpi_function_name[] = #name;
 243
 244 #else
 245 /* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
 246
 247 #define ACPI_FUNCTION_NAME(name)
 248 #endif                          /* ACPI_GET_FUNCTION_NAME */
 249
 250 /*
 251  * Common parameters used for debug output functions:
 252  * line number, function name, module(file) name, component ID
 253  */
 254 #define ACPI_DEBUG_PARAMETERS           __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
 255
 256 /*
 257  * Master debug print macros
 258  * Print message if and only if:
 259  *    1) Debug print for the current component is enabled
 260  *    2) Debug error level or trace level for the print statement is enabled
 261  */
 262 #define ACPI_DEBUG_PRINT(plist)         acpi_debug_print plist
 263 #define ACPI_DEBUG_PRINT_RAW(plist)     acpi_debug_print_raw plist
 264
 265 #else
 266 /*
 267  * This is the non-debug case -- make everything go away,
 268  * leaving no executable debug code!
 269  */
 270 #define ACPI_FUNCTION_NAME(a)
 271 #define ACPI_DEBUG_PRINT(pl)
 272 #define ACPI_DEBUG_PRINT_RAW(pl)
 273
 274 #endif                          /* ACPI_DEBUG_OUTPUT */
 275
 276 #endif                          /* __ACOUTPUT_H__ */