acexcep.h revision 77424 
11539Srgrimes/******************************************************************************
21539Srgrimes *
31539Srgrimes * Name: acexcep.h - Exception codes returned by the ACPI subsystem
41539Srgrimes *       $Revision: 46 $
51539Srgrimes *
61539Srgrimes *****************************************************************************/
71539Srgrimes
81539Srgrimes/******************************************************************************
91539Srgrimes *
101539Srgrimes * 1. Copyright Notice
111539Srgrimes *
121539Srgrimes * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
131539Srgrimes * All rights reserved.
141539Srgrimes *
151539Srgrimes * 2. License
161539Srgrimes *
171539Srgrimes * 2.1. This is your license from Intel Corp. under its intellectual property
181539Srgrimes * rights.  You may have additional license terms from the party that provided
191539Srgrimes * you this software, covering your right to use that party's intellectual
201539Srgrimes * property rights.
211539Srgrimes *
221539Srgrimes * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
231539Srgrimes * copy of the source code appearing in this file ("Covered Code") an
241539Srgrimes * irrevocable, perpetual, worldwide license under Intel's copyrights in the
251539Srgrimes * base code distributed originally by Intel ("Original Intel Code") to copy,
261539Srgrimes * make derivatives, distribute, use and display any portion of the Covered
271539Srgrimes * Code in any form, with the right to sublicense such rights; and
281539Srgrimes *
291539Srgrimes * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
301539Srgrimes * license (with the right to sublicense), under only those claims of Intel
311539Srgrimes * patents that are infringed by the Original Intel Code, to make, use, sell,
321539Srgrimes * offer to sell, and import the Covered Code and derivative works thereof
331539Srgrimes * solely to the minimum extent necessary to exercise the above copyright
3493032Simp * license, and in no event shall the patent license extend to any additions
351539Srgrimes * to or modifications of the Original Intel Code.  No other license or right
361539Srgrimes * is granted directly or by implication, estoppel or otherwise;
371539Srgrimes *
381539Srgrimes * The above copyright and patent license is granted only if the following
391539Srgrimes * conditions are met:
401539Srgrimes *
411539Srgrimes * 3. Conditions
421539Srgrimes *
431539Srgrimes * 3.1. Redistribution of Source with Rights to Further Distribute Source.
441539Srgrimes * Redistribution of source code of any substantial portion of the Covered
451539Srgrimes * Code or modification with rights to further distribute source must include
461539Srgrimes * the above Copyright Notice, the above License, this list of Conditions,
471539Srgrimes * and the following Disclaimer and Export Compliance provision.  In addition,
481539Srgrimes * Licensee must cause all Covered Code to which Licensee contributes to
491539Srgrimes * contain a file documenting the changes Licensee made to create that Covered
501539Srgrimes * Code and the date of any change.  Licensee must include in that file the
511539Srgrimes * documentation of any changes made by any predecessor Licensee.  Licensee
521539Srgrimes * must include a prominent statement that the modification is derived,
531539Srgrimes * directly or indirectly, from Original Intel Code.
541539Srgrimes *
551539Srgrimes * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
561539Srgrimes * Redistribution of source code of any substantial portion of the Covered
571539Srgrimes * Code or modification without rights to further distribute source must
581539Srgrimes * include the following Disclaimer and Export Compliance provision in the
591539Srgrimes * documentation and/or other materials provided with distribution.  In
601539Srgrimes * addition, Licensee may not authorize further sublicense of source of any
611539Srgrimes * portion of the Covered Code, and must include terms to the effect that the
621539Srgrimes * license from Licensee to its licensee is limited to the intellectual
631539Srgrimes * property embodied in the software Licensee provides to its licensee, and
641539Srgrimes * not to intellectual property embodied in modifications its licensee may
651539Srgrimes * make.
661539Srgrimes *
6722051Smpp * 3.3. Redistribution of Executable. Redistribution in executable form of any
681539Srgrimes * substantial portion of the Covered Code or modification must reproduce the
691539Srgrimes * above Copyright Notice, and the following Disclaimer and Export Compliance
701539Srgrimes * provision in the documentation and/or other materials provided with the
711539Srgrimes * distribution.
721539Srgrimes *
7393032Simp * 3.4. Intel retains all right, title, and interest in and to the Original
7493032Simp * Intel Code.
7593032Simp *
7693032Simp * 3.5. Neither the name Intel nor any other trademark owned or controlled by
7793032Simp * Intel shall be used in advertising or otherwise to promote the sale, use or
78113219Smdodd * other dealings in products derived from or relating to the Covered Code
79113219Smdodd * without prior written authorization from Intel.
801539Srgrimes *
811539Srgrimes * 4. Disclaimer and Export Compliance
821539Srgrimes *
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 __ACEXCEP_H__
118#define __ACEXCEP_H__
119
120
121/*
122 * Exceptions returned by external ACPI interfaces
123 */
124
125#define AE_CODE_ENVIRONMENTAL           0x0000
126#define AE_CODE_PROGRAMMER              0x1000
127#define AE_CODE_ACPI_TABLES             0x2000
128#define AE_CODE_AML                     0x3000
129#define AE_CODE_CONTROL                 0x4000
130#define AE_CODE_MASK                    0xF000
131
132
133#define ACPI_SUCCESS(a)                 (!(a))
134#define ACPI_FAILURE(a)                 (a)
135
136
137#define AE_OK                           (ACPI_STATUS) 0x0000
138
139/*
140 * Environmental exceptions
141 */
142#define AE_ERROR                        (ACPI_STATUS) (0x0001 | AE_CODE_ENVIRONMENTAL)
143#define AE_NO_ACPI_TABLES               (ACPI_STATUS) (0x0002 | AE_CODE_ENVIRONMENTAL)
144#define AE_NO_NAMESPACE                 (ACPI_STATUS) (0x0003 | AE_CODE_ENVIRONMENTAL)
145#define AE_NO_MEMORY                    (ACPI_STATUS) (0x0004 | AE_CODE_ENVIRONMENTAL)
146#define AE_NOT_FOUND                    (ACPI_STATUS) (0x0005 | AE_CODE_ENVIRONMENTAL)
147#define AE_NOT_EXIST                    (ACPI_STATUS) (0x0006 | AE_CODE_ENVIRONMENTAL)
148#define AE_EXIST                        (ACPI_STATUS) (0x0007 | AE_CODE_ENVIRONMENTAL)
149#define AE_TYPE                         (ACPI_STATUS) (0x0008 | AE_CODE_ENVIRONMENTAL)
150#define AE_NULL_OBJECT                  (ACPI_STATUS) (0x0009 | AE_CODE_ENVIRONMENTAL)
151#define AE_NULL_ENTRY                   (ACPI_STATUS) (0x000A | AE_CODE_ENVIRONMENTAL)
152#define AE_BUFFER_OVERFLOW              (ACPI_STATUS) (0x000B | AE_CODE_ENVIRONMENTAL)
153#define AE_STACK_OVERFLOW               (ACPI_STATUS) (0x000C | AE_CODE_ENVIRONMENTAL)
154#define AE_STACK_UNDERFLOW              (ACPI_STATUS) (0x000D | AE_CODE_ENVIRONMENTAL)
155#define AE_NOT_IMPLEMENTED              (ACPI_STATUS) (0x000E | AE_CODE_ENVIRONMENTAL)
156#define AE_VERSION_MISMATCH             (ACPI_STATUS) (0x000F | AE_CODE_ENVIRONMENTAL)
157#define AE_SUPPORT                      (ACPI_STATUS) (0x0010 | AE_CODE_ENVIRONMENTAL)
158#define AE_SHARE                        (ACPI_STATUS) (0x0011 | AE_CODE_ENVIRONMENTAL)
159#define AE_LIMIT                        (ACPI_STATUS) (0x0012 | AE_CODE_ENVIRONMENTAL)
160#define AE_TIME                         (ACPI_STATUS) (0x0013 | AE_CODE_ENVIRONMENTAL)
161#define AE_UNKNOWN_STATUS               (ACPI_STATUS) (0x0014 | AE_CODE_ENVIRONMENTAL)
162#define AE_ACQUIRE_DEADLOCK             (ACPI_STATUS) (0x0015 | AE_CODE_ENVIRONMENTAL)
163#define AE_RELEASE_DEADLOCK             (ACPI_STATUS) (0x0016 | AE_CODE_ENVIRONMENTAL)
164#define AE_NOT_ACQUIRED                 (ACPI_STATUS) (0x0017 | AE_CODE_ENVIRONMENTAL)
165#define AE_ALREADY_ACQUIRED             (ACPI_STATUS) (0x0018 | AE_CODE_ENVIRONMENTAL)
166#define AE_NO_HARDWARE_RESPONSE         (ACPI_STATUS) (0x0019 | AE_CODE_ENVIRONMENTAL)
167#define AE_NO_GLOBAL_LOCK               (ACPI_STATUS) (0x001A | AE_CODE_ENVIRONMENTAL)
168
169#define AE_CODE_ENV_MAX                 0x001A
170
171/*
172 * Programmer exceptions
173 */
174#define AE_BAD_PARAMETER                (ACPI_STATUS) (0x0001 | AE_CODE_PROGRAMMER)
175#define AE_BAD_CHARACTER                (ACPI_STATUS) (0x0002 | AE_CODE_PROGRAMMER)
176#define AE_BAD_PATHNAME                 (ACPI_STATUS) (0x0003 | AE_CODE_PROGRAMMER)
177#define AE_BAD_DATA                     (ACPI_STATUS) (0x0004 | AE_CODE_PROGRAMMER)
178#define AE_BAD_ADDRESS                  (ACPI_STATUS) (0x0005 | AE_CODE_PROGRAMMER)
179
180#define AE_CODE_PGM_MAX                 0x0005
181
182
183/*
184 * Acpi table exceptions
185 */
186#define AE_BAD_SIGNATURE                (ACPI_STATUS) (0x0001 | AE_CODE_ACPI_TABLES)
187#define AE_BAD_HEADER                   (ACPI_STATUS) (0x0002 | AE_CODE_ACPI_TABLES)
188#define AE_BAD_CHECKSUM                 (ACPI_STATUS) (0x0003 | AE_CODE_ACPI_TABLES)
189#define AE_BAD_VALUE                    (ACPI_STATUS) (0x0004 | AE_CODE_ACPI_TABLES)
190
191#define AE_CODE_TBL_MAX                 0x0003
192
193
194/*
195 * AML exceptions.  These are caused by problems with
196 * the actual AML byte stream
197 */
198#define AE_AML_ERROR                    (ACPI_STATUS) (0x0001 | AE_CODE_AML)
199#define AE_AML_PARSE                    (ACPI_STATUS) (0x0002 | AE_CODE_AML)
200#define AE_AML_BAD_OPCODE               (ACPI_STATUS) (0x0003 | AE_CODE_AML)
201#define AE_AML_NO_OPERAND               (ACPI_STATUS) (0x0004 | AE_CODE_AML)
202#define AE_AML_OPERAND_TYPE             (ACPI_STATUS) (0x0005 | AE_CODE_AML)
203#define AE_AML_OPERAND_VALUE            (ACPI_STATUS) (0x0006 | AE_CODE_AML)
204#define AE_AML_UNINITIALIZED_LOCAL      (ACPI_STATUS) (0x0007 | AE_CODE_AML)
205#define AE_AML_UNINITIALIZED_ARG        (ACPI_STATUS) (0x0008 | AE_CODE_AML)
206#define AE_AML_UNINITIALIZED_ELEMENT    (ACPI_STATUS) (0x0009 | AE_CODE_AML)
207#define AE_AML_NUMERIC_OVERFLOW         (ACPI_STATUS) (0x000A | AE_CODE_AML)
208#define AE_AML_REGION_LIMIT             (ACPI_STATUS) (0x000B | AE_CODE_AML)
209#define AE_AML_BUFFER_LIMIT             (ACPI_STATUS) (0x000C | AE_CODE_AML)
210#define AE_AML_PACKAGE_LIMIT            (ACPI_STATUS) (0x000D | AE_CODE_AML)
211#define AE_AML_DIVIDE_BY_ZERO           (ACPI_STATUS) (0x000E | AE_CODE_AML)
212#define AE_AML_BAD_NAME                 (ACPI_STATUS) (0x000F | AE_CODE_AML)
213#define AE_AML_NAME_NOT_FOUND           (ACPI_STATUS) (0x0010 | AE_CODE_AML)
214#define AE_AML_INTERNAL                 (ACPI_STATUS) (0x0011 | AE_CODE_AML)
215#define AE_AML_INVALID_SPACE_ID         (ACPI_STATUS) (0x0012 | AE_CODE_AML)
216#define AE_AML_STRING_LIMIT             (ACPI_STATUS) (0x0013 | AE_CODE_AML)
217#define AE_AML_NO_RETURN_VALUE          (ACPI_STATUS) (0x0014 | AE_CODE_AML)
218#define AE_AML_METHOD_LIMIT             (ACPI_STATUS) (0x0015 | AE_CODE_AML)
219#define AE_AML_NOT_OWNER                (ACPI_STATUS) (0x0016 | AE_CODE_AML)
220#define AE_AML_MUTEX_ORDER              (ACPI_STATUS) (0x0017 | AE_CODE_AML)
221#define AE_AML_MUTEX_NOT_ACQUIRED       (ACPI_STATUS) (0x0018 | AE_CODE_AML)
222#define AE_AML_INVALID_RESOURCE_TYPE    (ACPI_STATUS) (0x0019 | AE_CODE_AML)
223
224#define AE_CODE_AML_MAX                 0x0019
225
226/*
227 * Internal exceptions used for control
228 */
229#define AE_CTRL_RETURN_VALUE            (ACPI_STATUS) (0x0001 | AE_CODE_CONTROL)
230#define AE_CTRL_PENDING                 (ACPI_STATUS) (0x0002 | AE_CODE_CONTROL)
231#define AE_CTRL_TERMINATE               (ACPI_STATUS) (0x0003 | AE_CODE_CONTROL)
232#define AE_CTRL_TRUE                    (ACPI_STATUS) (0x0004 | AE_CODE_CONTROL)
233#define AE_CTRL_FALSE                   (ACPI_STATUS) (0x0005 | AE_CODE_CONTROL)
234#define AE_CTRL_DEPTH                   (ACPI_STATUS) (0x0006 | AE_CODE_CONTROL)
235#define AE_CTRL_END                     (ACPI_STATUS) (0x0007 | AE_CODE_CONTROL)
236#define AE_CTRL_TRANSFER                (ACPI_STATUS) (0x0008 | AE_CODE_CONTROL)
237
238#define AE_CODE_CTRL_MAX                0x0008
239
240
241#ifdef DEFINE_ACPI_GLOBALS
242
243/*
244 * String versions of the exception codes above
245 * These strings must match the corresponding defines exactly
246 */
247static NATIVE_CHAR          *AcpiGbl_ExceptionNames_Env[] =
248{
249    "AE_OK",
250    "AE_ERROR",
251    "AE_NO_ACPI_TABLES",
252    "AE_NO_NAMESPACE",
253    "AE_NO_MEMORY",
254    "AE_NOT_FOUND",
255    "AE_NOT_EXIST",
256    "AE_EXIST",
257    "AE_TYPE",
258    "AE_NULL_OBJECT",
259    "AE_NULL_ENTRY",
260    "AE_BUFFER_OVERFLOW",
261    "AE_STACK_OVERFLOW",
262    "AE_STACK_UNDERFLOW",
263    "AE_NOT_IMPLEMENTED",
264    "AE_VERSION_MISMATCH",
265    "AE_SUPPORT",
266    "AE_SHARE",
267    "AE_LIMIT",
268    "AE_TIME",
269    "AE_UNKNOWN_STATUS",
270    "AE_ACQUIRE_DEADLOCK",
271    "AE_RELEASE_DEADLOCK",
272    "AE_NOT_ACQUIRED",
273    "AE_ALREADY_ACQUIRED",
274    "AE_NO_HARDWARE_RESPONSE",
275    "AE_NO_GLOBAL_LOCK",
276};
277
278static NATIVE_CHAR          *AcpiGbl_ExceptionNames_Pgm[] =
279{
280    "AE_BAD_PARAMETER",
281    "AE_BAD_CHARACTER",
282    "AE_BAD_PATHNAME",
283    "AE_BAD_DATA",
284    "AE_BAD_ADDRESS",
285};
286
287static NATIVE_CHAR          *AcpiGbl_ExceptionNames_Tbl[] =
288{
289    "AE_BAD_SIGNATURE",
290    "AE_BAD_HEADER",
291    "AE_BAD_CHECKSUM",
292    "AE_BAD_VALUE",
293};
294
295static NATIVE_CHAR          *AcpiGbl_ExceptionNames_Aml[] =
296{
297    "AE_AML_ERROR",
298    "AE_AML_PARSE",
299    "AE_AML_BAD_OPCODE",
300    "AE_AML_NO_OPERAND",
301    "AE_AML_OPERAND_TYPE",
302    "AE_AML_OPERAND_VALUE",
303    "AE_AML_UNINITIALIZED_LOCAL",
304    "AE_AML_UNINITIALIZED_ARG",
305    "AE_AML_UNINITIALIZED_ELEMENT",
306    "AE_AML_NUMERIC_OVERFLOW",
307    "AE_AML_REGION_LIMIT",
308    "AE_AML_BUFFER_LIMIT",
309    "AE_AML_PACKAGE_LIMIT",
310    "AE_AML_DIVIDE_BY_ZERO",
311    "AE_AML_BAD_NAME",
312    "AE_AML_NAME_NOT_FOUND",
313    "AE_AML_INTERNAL",
314    "AE_AML_INVALID_SPACE_ID",
315    "AE_AML_STRING_LIMIT",
316    "AE_AML_NO_RETURN_VALUE",
317    "AE_AML_METHOD_LIMIT",
318    "AE_AML_NOT_OWNER",
319    "AE_AML_MUTEX_ORDER",
320    "AE_AML_MUTEX_NOT_ACQUIRED",
321    "AE_AML_INVALID_RESOURCE_TYPE",
322};
323
324static NATIVE_CHAR          *AcpiGbl_ExceptionNames_Ctrl[] =
325{
326    "AE_CTRL_RETURN_VALUE",
327    "AE_CTRL_PENDING",
328    "AE_CTRL_TERMINATE",
329    "AE_CTRL_TRUE",
330    "AE_CTRL_FALSE",
331    "AE_CTRL_DEPTH",
332    "AE_CTRL_END",
333    "AE_CTRL_TRANSFER",
334};
335
336
337#endif /* DEFINE_ACPI_GLOBALS */
338
339
340#endif /* __ACEXCEP_H__ */
341