acoutput.h revision 83174 
1/******************************************************************************
2 *
3 * Name: acoutput.h -- debug output
4 *       $Revision: 84 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#ifndef __ACOUTPUT_H__
118#define __ACOUTPUT_H__
119
120/*
121 * Debug levels and component IDs.  These are used to control the
122 * granularity of the output of the DEBUG_PRINT macro -- on a per-
123 * component basis and a per-exception-type basis.
124 */
125
126/* Component IDs are used in the global "DebugLayer" */
127
128#define ACPI_UTILITIES              0x00000001
129#define ACPI_HARDWARE               0x00000002
130#define ACPI_EVENTS                 0x00000004
131#define ACPI_TABLES                 0x00000008
132#define ACPI_NAMESPACE              0x00000010
133#define ACPI_PARSER                 0x00000020
134#define ACPI_DISPATCHER             0x00000040
135#define ACPI_EXECUTER               0x00000080
136#define ACPI_RESOURCES              0x00000100
137#define ACPI_DEBUGGER               0x00000200
138#define ACPI_OS_SERVICES            0x00000400
139
140#define ACPI_BUS                    0x00010000
141#define ACPI_SYSTEM                 0x00020000
142#define ACPI_POWER                  0x00040000
143#define ACPI_EC                     0x00080000
144#define ACPI_AC_ADAPTER             0x00100000
145#define ACPI_BATTERY                0x00200000
146#define ACPI_BUTTON                 0x00400000
147#define ACPI_PROCESSOR              0x00800000
148#define ACPI_THERMAL                0x01000000
149#define ACPI_FAN                    0x02000000
150
151#define ACPI_ALL_COMPONENTS         0x0FFFFFFF
152
153#define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
154
155
156#define ACPI_COMPILER               0x10000000
157#define ACPI_TOOLS                  0x20000000
158
159
160/*
161 * Raw debug output levels, do not use these in the DEBUG_PRINT macros
162 */
163
164#define ACPI_LV_OK                  0x00000001
165#define ACPI_LV_INFO                0x00000002
166#define ACPI_LV_WARN                0x00000004
167#define ACPI_LV_ERROR               0x00000008
168#define ACPI_LV_FATAL               0x00000010
169#define ACPI_LV_DEBUG_OBJECT        0x00000020
170#define ACPI_LV_ALL_EXCEPTIONS      0x0000003F
171
172
173/* Trace verbosity level 1 [Standard Trace Level] */
174
175#define ACPI_LV_PARSE               0x00000040
176#define ACPI_LV_LOAD                0x00000080
177#define ACPI_LV_DISPATCH            0x00000100
178#define ACPI_LV_EXEC                0x00000200
179#define ACPI_LV_NAMES               0x00000400
180#define ACPI_LV_OPREGION            0x00000800
181#define ACPI_LV_BFIELD              0x00001000
182#define ACPI_LV_TABLES              0x00002000
183#define ACPI_LV_VALUES              0x00004000
184#define ACPI_LV_OBJECTS             0x00008000
185#define ACPI_LV_RESOURCES           0x00010000
186#define ACPI_LV_USER_REQUESTS       0x00020000
187#define ACPI_LV_PACKAGE             0x00040000
188#define ACPI_LV_INIT                0x00080000
189#define ACPI_LV_VERBOSITY1          0x000FFF40 | ACPI_LV_ALL_EXCEPTIONS
190
191/* Trace verbosity level 2 [Function tracing and memory allocation] */
192
193#define ACPI_LV_ALLOCATIONS         0x00100000
194#define ACPI_LV_FUNCTIONS           0x00200000
195#define ACPI_LV_VERBOSITY2          0x00300000 | ACPI_LV_VERBOSITY1
196#define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
197
198/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
199
200#define ACPI_LV_MUTEX               0x01000000
201#define ACPI_LV_THREADS             0x02000000
202#define ACPI_LV_IO                  0x04000000
203#define ACPI_LV_INTERRUPTS          0x08000000
204#define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
205
206/*
207 * Debug level macros that are used in the DEBUG_PRINT macros
208 */
209
210#define ACPI_DEBUG_LEVEL(dl)       dl,__LINE__,&_Dbg
211
212/* Exception level -- used in the global "DebugLevel" */
213
214#define ACPI_DB_OK                  ACPI_DEBUG_LEVEL (ACPI_LV_OK)
215#define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
216#define ACPI_DB_WARN                ACPI_DEBUG_LEVEL (ACPI_LV_WARN)
217#define ACPI_DB_ERROR               ACPI_DEBUG_LEVEL (ACPI_LV_ERROR)
218#define ACPI_DB_FATAL               ACPI_DEBUG_LEVEL (ACPI_LV_FATAL)
219#define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
220#define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
221
222
223/* Trace level -- also used in the global "DebugLevel" */
224
225#define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
226#define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
227#define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
228#define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
229#define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
230#define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
231#define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
232#define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
233#define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
234#define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
235#define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
236#define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
237#define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
238#define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
239#define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
240#define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
241#define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
242#define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
243#define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
244#define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
245
246#define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (0x0FFFFF80)
247
248
249/* Exceptionally verbose output -- also used in the global "DebugLevel"  */
250
251#define ACPI_DB_AML_DISASSEMBLE     0x10000000
252#define ACPI_DB_VERBOSE_INFO        0x20000000
253#define ACPI_DB_FULL_TABLES         0x40000000
254#define ACPI_DB_EVENTS              0x80000000
255
256#define ACPI_DB_VERBOSE             0xF0000000
257
258
259/* Defaults for DebugLevel, debug and normal */
260
261#define DEBUG_DEFAULT               (ACPI_LV_OK | ACPI_LV_WARN | ACPI_LV_ERROR | ACPI_LV_DEBUG_OBJECT)
262#define NORMAL_DEFAULT              (ACPI_LV_OK | ACPI_LV_WARN | ACPI_LV_ERROR | ACPI_LV_DEBUG_OBJECT)
263#define DEBUG_ALL                   (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
264
265/* Misc defines */
266
267#define HEX                         0x01
268#define ASCII                       0x02
269#define FULL_ADDRESS                0x04
270#define CHARS_PER_LINE              16          /* used in DumpBuf function */
271
272
273#endif /* __ACOUTPUT_H__ */
274