6bc741cb08dbff9e3b3b79a3fc555aae339cafec
[reactos.git] / drivers / bus / acpi / acpica / include / acexcep.h
1 /******************************************************************************
2 *
3 * Name: acexcep.h - Exception codes returned by the ACPI subsystem
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2017, 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 __ACEXCEP_H__
45 #define __ACEXCEP_H__
46
47
48 /* This module contains all possible exception codes for ACPI_STATUS */
49
50 /*
51 * Exception code classes
52 */
53 #define AE_CODE_ENVIRONMENTAL 0x0000 /* General ACPICA environment */
54 #define AE_CODE_PROGRAMMER 0x1000 /* External ACPICA interface caller */
55 #define AE_CODE_ACPI_TABLES 0x2000 /* ACPI tables */
56 #define AE_CODE_AML 0x3000 /* From executing AML code */
57 #define AE_CODE_CONTROL 0x4000 /* Internal control codes */
58
59 #define AE_CODE_MAX 0x4000
60 #define AE_CODE_MASK 0xF000
61
62 /*
63 * Macros to insert the exception code classes
64 */
65 #define EXCEP_ENV(code) ((ACPI_STATUS) (code | AE_CODE_ENVIRONMENTAL))
66 #define EXCEP_PGM(code) ((ACPI_STATUS) (code | AE_CODE_PROGRAMMER))
67 #define EXCEP_TBL(code) ((ACPI_STATUS) (code | AE_CODE_ACPI_TABLES))
68 #define EXCEP_AML(code) ((ACPI_STATUS) (code | AE_CODE_AML))
69 #define EXCEP_CTL(code) ((ACPI_STATUS) (code | AE_CODE_CONTROL))
70
71 /*
72 * Exception info table. The "Description" field is used only by the
73 * ACPICA help application (acpihelp).
74 */
75 typedef struct acpi_exception_info
76 {
77 char *Name;
78
79 #ifdef ACPI_HELP_APP
80 char *Description;
81 #endif
82 } ACPI_EXCEPTION_INFO;
83
84 #ifdef ACPI_HELP_APP
85 #define EXCEP_TXT(Name,Description) {Name, Description}
86 #else
87 #define EXCEP_TXT(Name,Description) {Name}
88 #endif
89
90
91 /*
92 * Success is always zero, failure is non-zero
93 */
94 #define ACPI_SUCCESS(a) (!(a))
95 #define ACPI_FAILURE(a) (a)
96
97 #define AE_OK (ACPI_STATUS) 0x0000
98
99 /*
100 * Environmental exceptions
101 */
102 #define AE_ERROR EXCEP_ENV (0x0001)
103 #define AE_NO_ACPI_TABLES EXCEP_ENV (0x0002)
104 #define AE_NO_NAMESPACE EXCEP_ENV (0x0003)
105 #define AE_NO_MEMORY EXCEP_ENV (0x0004)
106 #define AE_NOT_FOUND EXCEP_ENV (0x0005)
107 #define AE_NOT_EXIST EXCEP_ENV (0x0006)
108 #define AE_ALREADY_EXISTS EXCEP_ENV (0x0007)
109 #define AE_TYPE EXCEP_ENV (0x0008)
110 #define AE_NULL_OBJECT EXCEP_ENV (0x0009)
111 #define AE_NULL_ENTRY EXCEP_ENV (0x000A)
112 #define AE_BUFFER_OVERFLOW EXCEP_ENV (0x000B)
113 #define AE_STACK_OVERFLOW EXCEP_ENV (0x000C)
114 #define AE_STACK_UNDERFLOW EXCEP_ENV (0x000D)
115 #define AE_NOT_IMPLEMENTED EXCEP_ENV (0x000E)
116 #define AE_SUPPORT EXCEP_ENV (0x000F)
117 #define AE_LIMIT EXCEP_ENV (0x0010)
118 #define AE_TIME EXCEP_ENV (0x0011)
119 #define AE_ACQUIRE_DEADLOCK EXCEP_ENV (0x0012)
120 #define AE_RELEASE_DEADLOCK EXCEP_ENV (0x0013)
121 #define AE_NOT_ACQUIRED EXCEP_ENV (0x0014)
122 #define AE_ALREADY_ACQUIRED EXCEP_ENV (0x0015)
123 #define AE_NO_HARDWARE_RESPONSE EXCEP_ENV (0x0016)
124 #define AE_NO_GLOBAL_LOCK EXCEP_ENV (0x0017)
125 #define AE_ABORT_METHOD EXCEP_ENV (0x0018)
126 #define AE_SAME_HANDLER EXCEP_ENV (0x0019)
127 #define AE_NO_HANDLER EXCEP_ENV (0x001A)
128 #define AE_OWNER_ID_LIMIT EXCEP_ENV (0x001B)
129 #define AE_NOT_CONFIGURED EXCEP_ENV (0x001C)
130 #define AE_ACCESS EXCEP_ENV (0x001D)
131 #define AE_IO_ERROR EXCEP_ENV (0x001E)
132
133 #define AE_CODE_ENV_MAX 0x001E
134
135
136 /*
137 * Programmer exceptions
138 */
139 #define AE_BAD_PARAMETER EXCEP_PGM (0x0001)
140 #define AE_BAD_CHARACTER EXCEP_PGM (0x0002)
141 #define AE_BAD_PATHNAME EXCEP_PGM (0x0003)
142 #define AE_BAD_DATA EXCEP_PGM (0x0004)
143 #define AE_BAD_HEX_CONSTANT EXCEP_PGM (0x0005)
144 #define AE_BAD_OCTAL_CONSTANT EXCEP_PGM (0x0006)
145 #define AE_BAD_DECIMAL_CONSTANT EXCEP_PGM (0x0007)
146 #define AE_MISSING_ARGUMENTS EXCEP_PGM (0x0008)
147 #define AE_BAD_ADDRESS EXCEP_PGM (0x0009)
148
149 #define AE_CODE_PGM_MAX 0x0009
150
151
152 /*
153 * Acpi table exceptions
154 */
155 #define AE_BAD_SIGNATURE EXCEP_TBL (0x0001)
156 #define AE_BAD_HEADER EXCEP_TBL (0x0002)
157 #define AE_BAD_CHECKSUM EXCEP_TBL (0x0003)
158 #define AE_BAD_VALUE EXCEP_TBL (0x0004)
159 #define AE_INVALID_TABLE_LENGTH EXCEP_TBL (0x0005)
160
161 #define AE_CODE_TBL_MAX 0x0005
162
163
164 /*
165 * AML exceptions. These are caused by problems with
166 * the actual AML byte stream
167 */
168 #define AE_AML_BAD_OPCODE EXCEP_AML (0x0001)
169 #define AE_AML_NO_OPERAND EXCEP_AML (0x0002)
170 #define AE_AML_OPERAND_TYPE EXCEP_AML (0x0003)
171 #define AE_AML_OPERAND_VALUE EXCEP_AML (0x0004)
172 #define AE_AML_UNINITIALIZED_LOCAL EXCEP_AML (0x0005)
173 #define AE_AML_UNINITIALIZED_ARG EXCEP_AML (0x0006)
174 #define AE_AML_UNINITIALIZED_ELEMENT EXCEP_AML (0x0007)
175 #define AE_AML_NUMERIC_OVERFLOW EXCEP_AML (0x0008)
176 #define AE_AML_REGION_LIMIT EXCEP_AML (0x0009)
177 #define AE_AML_BUFFER_LIMIT EXCEP_AML (0x000A)
178 #define AE_AML_PACKAGE_LIMIT EXCEP_AML (0x000B)
179 #define AE_AML_DIVIDE_BY_ZERO EXCEP_AML (0x000C)
180 #define AE_AML_BAD_NAME EXCEP_AML (0x000D)
181 #define AE_AML_NAME_NOT_FOUND EXCEP_AML (0x000E)
182 #define AE_AML_INTERNAL EXCEP_AML (0x000F)
183 #define AE_AML_INVALID_SPACE_ID EXCEP_AML (0x0010)
184 #define AE_AML_STRING_LIMIT EXCEP_AML (0x0011)
185 #define AE_AML_NO_RETURN_VALUE EXCEP_AML (0x0012)
186 #define AE_AML_METHOD_LIMIT EXCEP_AML (0x0013)
187 #define AE_AML_NOT_OWNER EXCEP_AML (0x0014)
188 #define AE_AML_MUTEX_ORDER EXCEP_AML (0x0015)
189 #define AE_AML_MUTEX_NOT_ACQUIRED EXCEP_AML (0x0016)
190 #define AE_AML_INVALID_RESOURCE_TYPE EXCEP_AML (0x0017)
191 #define AE_AML_INVALID_INDEX EXCEP_AML (0x0018)
192 #define AE_AML_REGISTER_LIMIT EXCEP_AML (0x0019)
193 #define AE_AML_NO_WHILE EXCEP_AML (0x001A)
194 #define AE_AML_ALIGNMENT EXCEP_AML (0x001B)
195 #define AE_AML_NO_RESOURCE_END_TAG EXCEP_AML (0x001C)
196 #define AE_AML_BAD_RESOURCE_VALUE EXCEP_AML (0x001D)
197 #define AE_AML_CIRCULAR_REFERENCE EXCEP_AML (0x001E)
198 #define AE_AML_BAD_RESOURCE_LENGTH EXCEP_AML (0x001F)
199 #define AE_AML_ILLEGAL_ADDRESS EXCEP_AML (0x0020)
200 #define AE_AML_INFINITE_LOOP EXCEP_AML (0x0021)
201 #define AE_AML_UNINITIALIZED_NODE EXCEP_AML (0x0022)
202 #define AE_AML_TARGET_TYPE EXCEP_AML (0x0023)
203
204 #define AE_CODE_AML_MAX 0x0023
205
206
207 /*
208 * Internal exceptions used for control
209 */
210 #define AE_CTRL_RETURN_VALUE EXCEP_CTL (0x0001)
211 #define AE_CTRL_PENDING EXCEP_CTL (0x0002)
212 #define AE_CTRL_TERMINATE EXCEP_CTL (0x0003)
213 #define AE_CTRL_TRUE EXCEP_CTL (0x0004)
214 #define AE_CTRL_FALSE EXCEP_CTL (0x0005)
215 #define AE_CTRL_DEPTH EXCEP_CTL (0x0006)
216 #define AE_CTRL_END EXCEP_CTL (0x0007)
217 #define AE_CTRL_TRANSFER EXCEP_CTL (0x0008)
218 #define AE_CTRL_BREAK EXCEP_CTL (0x0009)
219 #define AE_CTRL_CONTINUE EXCEP_CTL (0x000A)
220 #define AE_CTRL_PARSE_CONTINUE EXCEP_CTL (0x000B)
221 #define AE_CTRL_PARSE_PENDING EXCEP_CTL (0x000C)
222
223 #define AE_CODE_CTRL_MAX 0x000C
224
225
226 /* Exception strings for AcpiFormatException */
227
228 #ifdef ACPI_DEFINE_EXCEPTION_TABLE
229
230 /*
231 * String versions of the exception codes above
232 * These strings must match the corresponding defines exactly
233 */
234 static const ACPI_EXCEPTION_INFO AcpiGbl_ExceptionNames_Env[] =
235 {
236 EXCEP_TXT ("AE_OK", "No error"),
237 EXCEP_TXT ("AE_ERROR", "Unspecified error"),
238 EXCEP_TXT ("AE_NO_ACPI_TABLES", "ACPI tables could not be found"),
239 EXCEP_TXT ("AE_NO_NAMESPACE", "A namespace has not been loaded"),
240 EXCEP_TXT ("AE_NO_MEMORY", "Insufficient dynamic memory"),
241 EXCEP_TXT ("AE_NOT_FOUND", "A requested entity is not found"),
242 EXCEP_TXT ("AE_NOT_EXIST", "A required entity does not exist"),
243 EXCEP_TXT ("AE_ALREADY_EXISTS", "An entity already exists"),
244 EXCEP_TXT ("AE_TYPE", "The object type is incorrect"),
245 EXCEP_TXT ("AE_NULL_OBJECT", "A required object was missing"),
246 EXCEP_TXT ("AE_NULL_ENTRY", "The requested object does not exist"),
247 EXCEP_TXT ("AE_BUFFER_OVERFLOW", "The buffer provided is too small"),
248 EXCEP_TXT ("AE_STACK_OVERFLOW", "An internal stack overflowed"),
249 EXCEP_TXT ("AE_STACK_UNDERFLOW", "An internal stack underflowed"),
250 EXCEP_TXT ("AE_NOT_IMPLEMENTED", "The feature is not implemented"),
251 EXCEP_TXT ("AE_SUPPORT", "The feature is not supported"),
252 EXCEP_TXT ("AE_LIMIT", "A predefined limit was exceeded"),
253 EXCEP_TXT ("AE_TIME", "A time limit or timeout expired"),
254 EXCEP_TXT ("AE_ACQUIRE_DEADLOCK", "Internal error, attempt was made to acquire a mutex in improper order"),
255 EXCEP_TXT ("AE_RELEASE_DEADLOCK", "Internal error, attempt was made to release a mutex in improper order"),
256 EXCEP_TXT ("AE_NOT_ACQUIRED", "An attempt to release a mutex or Global Lock without a previous acquire"),
257 EXCEP_TXT ("AE_ALREADY_ACQUIRED", "Internal error, attempt was made to acquire a mutex twice"),
258 EXCEP_TXT ("AE_NO_HARDWARE_RESPONSE", "Hardware did not respond after an I/O operation"),
259 EXCEP_TXT ("AE_NO_GLOBAL_LOCK", "There is no FACS Global Lock"),
260 EXCEP_TXT ("AE_ABORT_METHOD", "A control method was aborted"),
261 EXCEP_TXT ("AE_SAME_HANDLER", "Attempt was made to install the same handler that is already installed"),
262 EXCEP_TXT ("AE_NO_HANDLER", "A handler for the operation is not installed"),
263 EXCEP_TXT ("AE_OWNER_ID_LIMIT", "There are no more Owner IDs available for ACPI tables or control methods"),
264 EXCEP_TXT ("AE_NOT_CONFIGURED", "The interface is not part of the current subsystem configuration"),
265 EXCEP_TXT ("AE_ACCESS", "Permission denied for the requested operation"),
266 EXCEP_TXT ("AE_IO_ERROR", "An I/O error occurred")
267 };
268
269 static const ACPI_EXCEPTION_INFO AcpiGbl_ExceptionNames_Pgm[] =
270 {
271 EXCEP_TXT (NULL, NULL),
272 EXCEP_TXT ("AE_BAD_PARAMETER", "A parameter is out of range or invalid"),
273 EXCEP_TXT ("AE_BAD_CHARACTER", "An invalid character was found in a name"),
274 EXCEP_TXT ("AE_BAD_PATHNAME", "An invalid character was found in a pathname"),
275 EXCEP_TXT ("AE_BAD_DATA", "A package or buffer contained incorrect data"),
276 EXCEP_TXT ("AE_BAD_HEX_CONSTANT", "Invalid character in a Hex constant"),
277 EXCEP_TXT ("AE_BAD_OCTAL_CONSTANT", "Invalid character in an Octal constant"),
278 EXCEP_TXT ("AE_BAD_DECIMAL_CONSTANT", "Invalid character in a Decimal constant"),
279 EXCEP_TXT ("AE_MISSING_ARGUMENTS", "Too few arguments were passed to a control method"),
280 EXCEP_TXT ("AE_BAD_ADDRESS", "An illegal null I/O address")
281 };
282
283 static const ACPI_EXCEPTION_INFO AcpiGbl_ExceptionNames_Tbl[] =
284 {
285 EXCEP_TXT (NULL, NULL),
286 EXCEP_TXT ("AE_BAD_SIGNATURE", "An ACPI table has an invalid signature"),
287 EXCEP_TXT ("AE_BAD_HEADER", "Invalid field in an ACPI table header"),
288 EXCEP_TXT ("AE_BAD_CHECKSUM", "An ACPI table checksum is not correct"),
289 EXCEP_TXT ("AE_BAD_VALUE", "An invalid value was found in a table"),
290 EXCEP_TXT ("AE_INVALID_TABLE_LENGTH", "The FADT or FACS has improper length")
291 };
292
293 static const ACPI_EXCEPTION_INFO AcpiGbl_ExceptionNames_Aml[] =
294 {
295 EXCEP_TXT (NULL, NULL),
296 EXCEP_TXT ("AE_AML_BAD_OPCODE", "Invalid AML opcode encountered"),
297 EXCEP_TXT ("AE_AML_NO_OPERAND", "A required operand is missing"),
298 EXCEP_TXT ("AE_AML_OPERAND_TYPE", "An operand of an incorrect type was encountered"),
299 EXCEP_TXT ("AE_AML_OPERAND_VALUE", "The operand had an inappropriate or invalid value"),
300 EXCEP_TXT ("AE_AML_UNINITIALIZED_LOCAL", "Method tried to use an uninitialized local variable"),
301 EXCEP_TXT ("AE_AML_UNINITIALIZED_ARG", "Method tried to use an uninitialized argument"),
302 EXCEP_TXT ("AE_AML_UNINITIALIZED_ELEMENT", "Method tried to use an empty package element"),
303 EXCEP_TXT ("AE_AML_NUMERIC_OVERFLOW", "Overflow during BCD conversion or other"),
304 EXCEP_TXT ("AE_AML_REGION_LIMIT", "Tried to access beyond the end of an Operation Region"),
305 EXCEP_TXT ("AE_AML_BUFFER_LIMIT", "Tried to access beyond the end of a buffer"),
306 EXCEP_TXT ("AE_AML_PACKAGE_LIMIT", "Tried to access beyond the end of a package"),
307 EXCEP_TXT ("AE_AML_DIVIDE_BY_ZERO", "During execution of AML Divide operator"),
308 EXCEP_TXT ("AE_AML_BAD_NAME", "An ACPI name contains invalid character(s)"),
309 EXCEP_TXT ("AE_AML_NAME_NOT_FOUND", "Could not resolve a named reference"),
310 EXCEP_TXT ("AE_AML_INTERNAL", "An internal error within the interprete"),
311 EXCEP_TXT ("AE_AML_INVALID_SPACE_ID", "An Operation Region SpaceID is invalid"),
312 EXCEP_TXT ("AE_AML_STRING_LIMIT", "String is longer than 200 characters"),
313 EXCEP_TXT ("AE_AML_NO_RETURN_VALUE", "A method did not return a required value"),
314 EXCEP_TXT ("AE_AML_METHOD_LIMIT", "A control method reached the maximum reentrancy limit of 255"),
315 EXCEP_TXT ("AE_AML_NOT_OWNER", "A thread tried to release a mutex that it does not own"),
316 EXCEP_TXT ("AE_AML_MUTEX_ORDER", "Mutex SyncLevel release mismatch"),
317 EXCEP_TXT ("AE_AML_MUTEX_NOT_ACQUIRED", "Attempt to release a mutex that was not previously acquired"),
318 EXCEP_TXT ("AE_AML_INVALID_RESOURCE_TYPE", "Invalid resource type in resource list"),
319 EXCEP_TXT ("AE_AML_INVALID_INDEX", "Invalid Argx or Localx (x too large)"),
320 EXCEP_TXT ("AE_AML_REGISTER_LIMIT", "Bank value or Index value beyond range of register"),
321 EXCEP_TXT ("AE_AML_NO_WHILE", "Break or Continue without a While"),
322 EXCEP_TXT ("AE_AML_ALIGNMENT", "Non-aligned memory transfer on platform that does not support this"),
323 EXCEP_TXT ("AE_AML_NO_RESOURCE_END_TAG", "No End Tag in a resource list"),
324 EXCEP_TXT ("AE_AML_BAD_RESOURCE_VALUE", "Invalid value of a resource element"),
325 EXCEP_TXT ("AE_AML_CIRCULAR_REFERENCE", "Two references refer to each other"),
326 EXCEP_TXT ("AE_AML_BAD_RESOURCE_LENGTH", "The length of a Resource Descriptor in the AML is incorrect"),
327 EXCEP_TXT ("AE_AML_ILLEGAL_ADDRESS", "A memory, I/O, or PCI configuration address is invalid"),
328 EXCEP_TXT ("AE_AML_INFINITE_LOOP", "An apparent infinite AML While loop, method was aborted"),
329 EXCEP_TXT ("AE_AML_UNINITIALIZED_NODE", "A namespace node is uninitialized or unresolved"),
330 EXCEP_TXT ("AE_AML_TARGET_TYPE", "A target operand of an incorrect type was encountered")
331 };
332
333 static const ACPI_EXCEPTION_INFO AcpiGbl_ExceptionNames_Ctrl[] =
334 {
335 EXCEP_TXT (NULL, NULL),
336 EXCEP_TXT ("AE_CTRL_RETURN_VALUE", "A Method returned a value"),
337 EXCEP_TXT ("AE_CTRL_PENDING", "Method is calling another method"),
338 EXCEP_TXT ("AE_CTRL_TERMINATE", "Terminate the executing method"),
339 EXCEP_TXT ("AE_CTRL_TRUE", "An If or While predicate result"),
340 EXCEP_TXT ("AE_CTRL_FALSE", "An If or While predicate result"),
341 EXCEP_TXT ("AE_CTRL_DEPTH", "Maximum search depth has been reached"),
342 EXCEP_TXT ("AE_CTRL_END", "An If or While predicate is false"),
343 EXCEP_TXT ("AE_CTRL_TRANSFER", "Transfer control to called method"),
344 EXCEP_TXT ("AE_CTRL_BREAK", "A Break has been executed"),
345 EXCEP_TXT ("AE_CTRL_CONTINUE", "A Continue has been executed"),
346 EXCEP_TXT ("AE_CTRL_PARSE_CONTINUE", "Used to skip over bad opcodes"),
347 EXCEP_TXT ("AE_CTRL_PARSE_PENDING", "Used to implement AML While loops")
348 };
349
350 #endif /* EXCEPTION_TABLE */
351
352 #endif /* __ACEXCEP_H__ */