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