xref: /titanic_41/usr/src/uts/intel/sys/acpi/acoutput.h (revision 2b4a78020b9c38d1b95e2f3fefa6d6e4be382d1f)
1 /******************************************************************************
2  *
3  * Name: acoutput.h -- debug output
4  *       $Revision: 1.102 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2008, 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_CA_DEBUGGER            0x00000200
138 #define ACPI_OS_SERVICES            0x00000400
139 #define ACPI_CA_DISASSEMBLER        0x00000800
140 
141 /* Component IDs for ACPI tools and utilities */
142 
143 #define ACPI_COMPILER               0x00001000
144 #define ACPI_TOOLS                  0x00002000
145 
146 #define ACPI_ALL_COMPONENTS         0x00003FFF
147 #define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)
148 
149 /* Component IDs reserved for ACPI drivers */
150 
151 #define ACPI_ALL_DRIVERS            0xFFFF0000
152 
153 
154 /*
155  * Raw debug output levels, do not use these in the DEBUG_PRINT macros
156  */
157 #define ACPI_LV_INIT                0x00000001
158 #define ACPI_LV_DEBUG_OBJECT        0x00000002
159 #define ACPI_LV_INFO                0x00000004
160 #define ACPI_LV_ALL_EXCEPTIONS      0x00000007
161 
162 /* Trace verbosity level 1 [Standard Trace Level] */
163 
164 #define ACPI_LV_INIT_NAMES          0x00000020
165 #define ACPI_LV_PARSE               0x00000040
166 #define ACPI_LV_LOAD                0x00000080
167 #define ACPI_LV_DISPATCH            0x00000100
168 #define ACPI_LV_EXEC                0x00000200
169 #define ACPI_LV_NAMES               0x00000400
170 #define ACPI_LV_OPREGION            0x00000800
171 #define ACPI_LV_BFIELD              0x00001000
172 #define ACPI_LV_TABLES              0x00002000
173 #define ACPI_LV_VALUES              0x00004000
174 #define ACPI_LV_OBJECTS             0x00008000
175 #define ACPI_LV_RESOURCES           0x00010000
176 #define ACPI_LV_USER_REQUESTS       0x00020000
177 #define ACPI_LV_PACKAGE             0x00040000
178 #define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
179 
180 /* Trace verbosity level 2 [Function tracing and memory allocation] */
181 
182 #define ACPI_LV_ALLOCATIONS         0x00100000
183 #define ACPI_LV_FUNCTIONS           0x00200000
184 #define ACPI_LV_OPTIMIZATIONS       0x00400000
185 #define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
186 #define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2
187 
188 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
189 
190 #define ACPI_LV_MUTEX               0x01000000
191 #define ACPI_LV_THREADS             0x02000000
192 #define ACPI_LV_IO                  0x04000000
193 #define ACPI_LV_INTERRUPTS          0x08000000
194 #define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2
195 
196 /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
197 
198 #define ACPI_LV_AML_DISASSEMBLE     0x10000000
199 #define ACPI_LV_VERBOSE_INFO        0x20000000
200 #define ACPI_LV_FULL_TABLES         0x40000000
201 #define ACPI_LV_EVENTS              0x80000000
202 #define ACPI_LV_VERBOSE             0xF0000000
203 
204 
205 /*
206  * Debug level macros that are used in the DEBUG_PRINT macros
207  */
208 #define ACPI_DEBUG_LEVEL(dl)        (UINT32) dl,ACPI_DEBUG_PARAMETERS
209 
210 /*
211  * Exception level -- used in the global "DebugLevel"
212  *
213  * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
214  * For warnings, use ACPI_WARNING.
215  */
216 #define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
217 #define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
218 #define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
219 #define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
220 
221 /* Trace level -- also used in the global "DebugLevel" */
222 
223 #define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
224 #define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
225 #define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
226 #define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
227 #define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
228 #define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
229 #define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
230 #define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
231 #define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
232 #define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
233 #define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
234 #define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
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_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
245 
246 #define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
247 
248 
249 /* Defaults for DebugLevel, debug and normal */
250 
251 #define ACPI_DEBUG_DEFAULT          (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT)
252 #define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT)
253 #define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
254 
255 
256 #endif /* __ACOUTPUT_H__ */
257