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