:pserver:cvsanon@mok.lvcm.com:/CVS/ReactOS reactos
[reactos.git] / drivers / bus / acpi / include / acexcep.h
1 /******************************************************************************
2  *
3  * Name: acexcep.h - Exception codes returned by the ACPI subsystem
4  *       $Revision$
5  *
6  *****************************************************************************/
7
8 /*
9  *  Copyright (C) 2000, 2001 R. Byron Moore
10  *
11  *  This program is free software; you can redistribute it and/or modify
12  *  it under the terms of the GNU General Public License as published by
13  *  the Free Software Foundation; either version 2 of the License, or
14  *  (at your option) any later version.
15  *
16  *  This program is distributed in the hope that it will be useful,
17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  *  GNU General Public License for more details.
20  *
21  *  You should have received a copy of the GNU General Public License
22  *  along with this program; if not, write to the Free Software
23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24  */
25
26 #ifndef __ACEXCEP_H__
27 #define __ACEXCEP_H__
28
29
30 /*
31  * Exceptions returned by external ACPI interfaces
32  */
33
34 #define AE_CODE_ENVIRONMENTAL           0x0000
35 #define AE_CODE_PROGRAMMER              0x1000
36 #define AE_CODE_ACPI_TABLES             0x2000
37 #define AE_CODE_AML                     0x3000
38 #define AE_CODE_CONTROL                 0x4000
39 #define AE_CODE_MASK                    0xF000
40
41
42 #define ACPI_SUCCESS(a)                 (!(a))
43 #define ACPI_FAILURE(a)                 (a)
44
45
46 #define AE_OK                           (ACPI_STATUS) 0x0000
47
48 /*
49  * Environmental exceptions
50  */
51 #define AE_ERROR                        (ACPI_STATUS) (0x0001 | AE_CODE_ENVIRONMENTAL)
52 #define AE_NO_ACPI_TABLES               (ACPI_STATUS) (0x0002 | AE_CODE_ENVIRONMENTAL)
53 #define AE_NO_NAMESPACE                 (ACPI_STATUS) (0x0003 | AE_CODE_ENVIRONMENTAL)
54 #define AE_NO_MEMORY                    (ACPI_STATUS) (0x0004 | AE_CODE_ENVIRONMENTAL)
55 #define AE_NOT_FOUND                    (ACPI_STATUS) (0x0005 | AE_CODE_ENVIRONMENTAL)
56 #define AE_NOT_EXIST                    (ACPI_STATUS) (0x0006 | AE_CODE_ENVIRONMENTAL)
57 #define AE_EXIST                        (ACPI_STATUS) (0x0007 | AE_CODE_ENVIRONMENTAL)
58 #define AE_TYPE                         (ACPI_STATUS) (0x0008 | AE_CODE_ENVIRONMENTAL)
59 #define AE_NULL_OBJECT                  (ACPI_STATUS) (0x0009 | AE_CODE_ENVIRONMENTAL)
60 #define AE_NULL_ENTRY                   (ACPI_STATUS) (0x000A | AE_CODE_ENVIRONMENTAL)
61 #define AE_BUFFER_OVERFLOW              (ACPI_STATUS) (0x000B | AE_CODE_ENVIRONMENTAL)
62 #define AE_STACK_OVERFLOW               (ACPI_STATUS) (0x000C | AE_CODE_ENVIRONMENTAL)
63 #define AE_STACK_UNDERFLOW              (ACPI_STATUS) (0x000D | AE_CODE_ENVIRONMENTAL)
64 #define AE_NOT_IMPLEMENTED              (ACPI_STATUS) (0x000E | AE_CODE_ENVIRONMENTAL)
65 #define AE_VERSION_MISMATCH             (ACPI_STATUS) (0x000F | AE_CODE_ENVIRONMENTAL)
66 #define AE_SUPPORT                      (ACPI_STATUS) (0x0010 | AE_CODE_ENVIRONMENTAL)
67 #define AE_SHARE                        (ACPI_STATUS) (0x0011 | AE_CODE_ENVIRONMENTAL)
68 #define AE_LIMIT                        (ACPI_STATUS) (0x0012 | AE_CODE_ENVIRONMENTAL)
69 #define AE_TIME                         (ACPI_STATUS) (0x0013 | AE_CODE_ENVIRONMENTAL)
70 #define AE_UNKNOWN_STATUS               (ACPI_STATUS) (0x0014 | AE_CODE_ENVIRONMENTAL)
71 #define AE_ACQUIRE_DEADLOCK             (ACPI_STATUS) (0x0015 | AE_CODE_ENVIRONMENTAL)
72 #define AE_RELEASE_DEADLOCK             (ACPI_STATUS) (0x0016 | AE_CODE_ENVIRONMENTAL)
73 #define AE_NOT_ACQUIRED                 (ACPI_STATUS) (0x0017 | AE_CODE_ENVIRONMENTAL)
74 #define AE_ALREADY_ACQUIRED             (ACPI_STATUS) (0x0018 | AE_CODE_ENVIRONMENTAL)
75 #define AE_NO_HARDWARE_RESPONSE         (ACPI_STATUS) (0x0019 | AE_CODE_ENVIRONMENTAL)
76 #define AE_NO_GLOBAL_LOCK               (ACPI_STATUS) (0x001A | AE_CODE_ENVIRONMENTAL)
77
78 #define AE_CODE_ENV_MAX                 0x001A
79
80 /*
81  * Programmer exceptions
82  */
83 #define AE_BAD_PARAMETER                (ACPI_STATUS) (0x0001 | AE_CODE_PROGRAMMER)
84 #define AE_BAD_CHARACTER                (ACPI_STATUS) (0x0002 | AE_CODE_PROGRAMMER)
85 #define AE_BAD_PATHNAME                 (ACPI_STATUS) (0x0003 | AE_CODE_PROGRAMMER)
86 #define AE_BAD_DATA                     (ACPI_STATUS) (0x0004 | AE_CODE_PROGRAMMER)
87 #define AE_BAD_ADDRESS                  (ACPI_STATUS) (0x0005 | AE_CODE_PROGRAMMER)
88
89 #define AE_CODE_PGM_MAX                 0x0005
90
91
92 /*
93  * Acpi table exceptions
94  */
95 #define AE_BAD_SIGNATURE                (ACPI_STATUS) (0x0001 | AE_CODE_ACPI_TABLES)
96 #define AE_BAD_HEADER                   (ACPI_STATUS) (0x0002 | AE_CODE_ACPI_TABLES)
97 #define AE_BAD_CHECKSUM                 (ACPI_STATUS) (0x0003 | AE_CODE_ACPI_TABLES)
98 #define AE_BAD_VALUE                    (ACPI_STATUS) (0x0004 | AE_CODE_ACPI_TABLES)
99
100 #define AE_CODE_TBL_MAX                 0x0003
101
102
103 /*
104  * AML exceptions.  These are caused by problems with
105  * the actual AML byte stream
106  */
107 #define AE_AML_ERROR                    (ACPI_STATUS) (0x0001 | AE_CODE_AML)
108 #define AE_AML_PARSE                    (ACPI_STATUS) (0x0002 | AE_CODE_AML)
109 #define AE_AML_BAD_OPCODE               (ACPI_STATUS) (0x0003 | AE_CODE_AML)
110 #define AE_AML_NO_OPERAND               (ACPI_STATUS) (0x0004 | AE_CODE_AML)
111 #define AE_AML_OPERAND_TYPE             (ACPI_STATUS) (0x0005 | AE_CODE_AML)
112 #define AE_AML_OPERAND_VALUE            (ACPI_STATUS) (0x0006 | AE_CODE_AML)
113 #define AE_AML_UNINITIALIZED_LOCAL      (ACPI_STATUS) (0x0007 | AE_CODE_AML)
114 #define AE_AML_UNINITIALIZED_ARG        (ACPI_STATUS) (0x0008 | AE_CODE_AML)
115 #define AE_AML_UNINITIALIZED_ELEMENT    (ACPI_STATUS) (0x0009 | AE_CODE_AML)
116 #define AE_AML_NUMERIC_OVERFLOW         (ACPI_STATUS) (0x000A | AE_CODE_AML)
117 #define AE_AML_REGION_LIMIT             (ACPI_STATUS) (0x000B | AE_CODE_AML)
118 #define AE_AML_BUFFER_LIMIT             (ACPI_STATUS) (0x000C | AE_CODE_AML)
119 #define AE_AML_PACKAGE_LIMIT            (ACPI_STATUS) (0x000D | AE_CODE_AML)
120 #define AE_AML_DIVIDE_BY_ZERO           (ACPI_STATUS) (0x000E | AE_CODE_AML)
121 #define AE_AML_BAD_NAME                 (ACPI_STATUS) (0x000F | AE_CODE_AML)
122 #define AE_AML_NAME_NOT_FOUND           (ACPI_STATUS) (0x0010 | AE_CODE_AML)
123 #define AE_AML_INTERNAL                 (ACPI_STATUS) (0x0011 | AE_CODE_AML)
124 #define AE_AML_INVALID_SPACE_ID         (ACPI_STATUS) (0x0012 | AE_CODE_AML)
125 #define AE_AML_STRING_LIMIT             (ACPI_STATUS) (0x0013 | AE_CODE_AML)
126 #define AE_AML_NO_RETURN_VALUE          (ACPI_STATUS) (0x0014 | AE_CODE_AML)
127 #define AE_AML_METHOD_LIMIT             (ACPI_STATUS) (0x0015 | AE_CODE_AML)
128 #define AE_AML_NOT_OWNER                (ACPI_STATUS) (0x0016 | AE_CODE_AML)
129 #define AE_AML_MUTEX_ORDER              (ACPI_STATUS) (0x0017 | AE_CODE_AML)
130 #define AE_AML_MUTEX_NOT_ACQUIRED       (ACPI_STATUS) (0x0018 | AE_CODE_AML)
131
132 #define AE_CODE_AML_MAX                 0x0018
133
134 /*
135  * Internal exceptions used for control
136  */
137 #define AE_CTRL_RETURN_VALUE            (ACPI_STATUS) (0x0001 | AE_CODE_CONTROL)
138 #define AE_CTRL_PENDING                 (ACPI_STATUS) (0x0002 | AE_CODE_CONTROL)
139 #define AE_CTRL_TERMINATE               (ACPI_STATUS) (0x0003 | AE_CODE_CONTROL)
140 #define AE_CTRL_TRUE                    (ACPI_STATUS) (0x0004 | AE_CODE_CONTROL)
141 #define AE_CTRL_FALSE                   (ACPI_STATUS) (0x0005 | AE_CODE_CONTROL)
142 #define AE_CTRL_DEPTH                   (ACPI_STATUS) (0x0006 | AE_CODE_CONTROL)
143 #define AE_CTRL_END                     (ACPI_STATUS) (0x0007 | AE_CODE_CONTROL)
144 #define AE_CTRL_TRANSFER                (ACPI_STATUS) (0x0008 | AE_CODE_CONTROL)
145
146 #define AE_CODE_CTRL_MAX                0x0008
147
148
149 #ifdef DEFINE_ACPI_GLOBALS
150
151 /*
152  * String versions of the exception codes above
153  * These strings must match the corresponding defines exactly
154  */
155 static NATIVE_CHAR          *acpi_gbl_exception_names_env[] =
156 {
157         "AE_OK",
158         "AE_ERROR",
159         "AE_NO_ACPI_TABLES",
160         "AE_NO_NAMESPACE",
161         "AE_NO_MEMORY",
162         "AE_NOT_FOUND",
163         "AE_NOT_EXIST",
164         "AE_EXIST",
165         "AE_TYPE",
166         "AE_NULL_OBJECT",
167         "AE_NULL_ENTRY",
168         "AE_BUFFER_OVERFLOW",
169         "AE_STACK_OVERFLOW",
170         "AE_STACK_UNDERFLOW",
171         "AE_NOT_IMPLEMENTED",
172         "AE_VERSION_MISMATCH",
173         "AE_SUPPORT",
174         "AE_SHARE",
175         "AE_LIMIT",
176         "AE_TIME",
177         "AE_UNKNOWN_STATUS",
178         "AE_ACQUIRE_DEADLOCK",
179         "AE_RELEASE_DEADLOCK",
180         "AE_NOT_ACQUIRED",
181         "AE_ALREADY_ACQUIRED",
182         "AE_NO_HARDWARE_RESPONSE",
183         "AE_NO_GLOBAL_LOCK",
184 };
185
186 static NATIVE_CHAR          *acpi_gbl_exception_names_pgm[] =
187 {
188         "AE_BAD_PARAMETER",
189         "AE_BAD_CHARACTER",
190         "AE_BAD_PATHNAME",
191         "AE_BAD_DATA",
192         "AE_BAD_ADDRESS",
193 };
194
195 static NATIVE_CHAR          *acpi_gbl_exception_names_tbl[] =
196 {
197         "AE_BAD_SIGNATURE",
198         "AE_BAD_HEADER",
199         "AE_BAD_CHECKSUM",
200         "AE_BAD_VALUE",
201 };
202
203 static NATIVE_CHAR          *acpi_gbl_exception_names_aml[] =
204 {
205         "AE_AML_ERROR",
206         "AE_AML_PARSE",
207         "AE_AML_BAD_OPCODE",
208         "AE_AML_NO_OPERAND",
209         "AE_AML_OPERAND_TYPE",
210         "AE_AML_OPERAND_VALUE",
211         "AE_AML_UNINITIALIZED_LOCAL",
212         "AE_AML_UNINITIALIZED_ARG",
213         "AE_AML_UNINITIALIZED_ELEMENT",
214         "AE_AML_NUMERIC_OVERFLOW",
215         "AE_AML_REGION_LIMIT",
216         "AE_AML_BUFFER_LIMIT",
217         "AE_AML_PACKAGE_LIMIT",
218         "AE_AML_DIVIDE_BY_ZERO",
219         "AE_AML_BAD_NAME",
220         "AE_AML_NAME_NOT_FOUND",
221         "AE_AML_INTERNAL",
222         "AE_AML_INVALID_SPACE_ID",
223         "AE_AML_STRING_LIMIT",
224         "AE_AML_NO_RETURN_VALUE",
225         "AE_AML_METHOD_LIMIT",
226         "AE_AML_NOT_OWNER",
227         "AE_AML_MUTEX_ORDER",
228         "AE_AML_MUTEX_NOT_ACQUIRED",
229 };
230
231 static NATIVE_CHAR          *acpi_gbl_exception_names_ctrl[] =
232 {
233         "AE_CTRL_RETURN_VALUE",
234         "AE_CTRL_PENDING",
235         "AE_CTRL_TERMINATE",
236         "AE_CTRL_TRUE",
237         "AE_CTRL_FALSE",
238         "AE_CTRL_DEPTH",
239         "AE_CTRL_END",
240         "AE_CTRL_TRANSFER",
241 };
242
243
244 #endif /* DEFINE_ACPI_GLOBALS */
245
246
247 #endif /* __ACEXCEP_H__ */