tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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/* 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 AE_OK (acpi_status) 0x0000
95
96/*
97 * Environmental exceptions
98 */
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
130#define AE_CODE_ENV_MAX 0x001E
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#define AE_AML_UNINITIALIZED_NODE EXCEP_AML (0x0022)
196#define AE_AML_TARGET_TYPE EXCEP_AML (0x0023)
197
198#define AE_CODE_AML_MAX 0x0023
199
200/*
201 * Internal exceptions used for control
202 */
203#define AE_CTRL_RETURN_VALUE EXCEP_CTL (0x0001)
204#define AE_CTRL_PENDING EXCEP_CTL (0x0002)
205#define AE_CTRL_TERMINATE EXCEP_CTL (0x0003)
206#define AE_CTRL_TRUE EXCEP_CTL (0x0004)
207#define AE_CTRL_FALSE EXCEP_CTL (0x0005)
208#define AE_CTRL_DEPTH EXCEP_CTL (0x0006)
209#define AE_CTRL_END EXCEP_CTL (0x0007)
210#define AE_CTRL_TRANSFER EXCEP_CTL (0x0008)
211#define AE_CTRL_BREAK EXCEP_CTL (0x0009)
212#define AE_CTRL_CONTINUE EXCEP_CTL (0x000A)
213#define AE_CTRL_PARSE_CONTINUE EXCEP_CTL (0x000B)
214#define AE_CTRL_PARSE_PENDING EXCEP_CTL (0x000C)
215
216#define AE_CODE_CTRL_MAX 0x000C
217
218/* Exception strings for acpi_format_exception */
219
220#ifdef ACPI_DEFINE_EXCEPTION_TABLE
221
222/*
223 * String versions of the exception codes above
224 * These strings must match the corresponding defines exactly
225 */
226static const struct acpi_exception_info acpi_gbl_exception_names_env[] = {
227 EXCEP_TXT("AE_OK", "No error"),
228 EXCEP_TXT("AE_ERROR", "Unspecified error"),
229 EXCEP_TXT("AE_NO_ACPI_TABLES", "ACPI tables could not be found"),
230 EXCEP_TXT("AE_NO_NAMESPACE", "A namespace has not been loaded"),
231 EXCEP_TXT("AE_NO_MEMORY", "Insufficient dynamic memory"),
232 EXCEP_TXT("AE_NOT_FOUND", "A requested entity is not found"),
233 EXCEP_TXT("AE_NOT_EXIST", "A required entity does not exist"),
234 EXCEP_TXT("AE_ALREADY_EXISTS", "An entity already exists"),
235 EXCEP_TXT("AE_TYPE", "The object type is incorrect"),
236 EXCEP_TXT("AE_NULL_OBJECT", "A required object was missing"),
237 EXCEP_TXT("AE_NULL_ENTRY", "The requested object does not exist"),
238 EXCEP_TXT("AE_BUFFER_OVERFLOW", "The buffer provided is too small"),
239 EXCEP_TXT("AE_STACK_OVERFLOW", "An internal stack overflowed"),
240 EXCEP_TXT("AE_STACK_UNDERFLOW", "An internal stack underflowed"),
241 EXCEP_TXT("AE_NOT_IMPLEMENTED", "The feature is not implemented"),
242 EXCEP_TXT("AE_SUPPORT", "The feature is not supported"),
243 EXCEP_TXT("AE_LIMIT", "A predefined limit was exceeded"),
244 EXCEP_TXT("AE_TIME", "A time limit or timeout expired"),
245 EXCEP_TXT("AE_ACQUIRE_DEADLOCK",
246 "Internal error, attempt was made to acquire a mutex in improper order"),
247 EXCEP_TXT("AE_RELEASE_DEADLOCK",
248 "Internal error, attempt was made to release a mutex in improper order"),
249 EXCEP_TXT("AE_NOT_ACQUIRED",
250 "An attempt to release a mutex or Global Lock without a previous acquire"),
251 EXCEP_TXT("AE_ALREADY_ACQUIRED",
252 "Internal error, attempt was made to acquire a mutex twice"),
253 EXCEP_TXT("AE_NO_HARDWARE_RESPONSE",
254 "Hardware did not respond after an I/O operation"),
255 EXCEP_TXT("AE_NO_GLOBAL_LOCK", "There is no FACS Global Lock"),
256 EXCEP_TXT("AE_ABORT_METHOD", "A control method was aborted"),
257 EXCEP_TXT("AE_SAME_HANDLER",
258 "Attempt was made to install the same handler that is already installed"),
259 EXCEP_TXT("AE_NO_HANDLER",
260 "A handler for the operation is not installed"),
261 EXCEP_TXT("AE_OWNER_ID_LIMIT",
262 "There are no more Owner IDs available for ACPI tables or control methods"),
263 EXCEP_TXT("AE_NOT_CONFIGURED",
264 "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
269static const struct acpi_exception_info acpi_gbl_exception_names_pgm[] = {
270 EXCEP_TXT(NULL, NULL),
271 EXCEP_TXT("AE_BAD_PARAMETER", "A parameter is out of range or invalid"),
272 EXCEP_TXT("AE_BAD_CHARACTER",
273 "An invalid character was found in a name"),
274 EXCEP_TXT("AE_BAD_PATHNAME",
275 "An invalid character was found in a pathname"),
276 EXCEP_TXT("AE_BAD_DATA",
277 "A package or buffer contained incorrect data"),
278 EXCEP_TXT("AE_BAD_HEX_CONSTANT", "Invalid character in a Hex constant"),
279 EXCEP_TXT("AE_BAD_OCTAL_CONSTANT",
280 "Invalid character in an Octal constant"),
281 EXCEP_TXT("AE_BAD_DECIMAL_CONSTANT",
282 "Invalid character in a Decimal constant"),
283 EXCEP_TXT("AE_MISSING_ARGUMENTS",
284 "Too few arguments were passed to a control method"),
285 EXCEP_TXT("AE_BAD_ADDRESS", "An illegal null I/O address")
286};
287
288static const struct acpi_exception_info acpi_gbl_exception_names_tbl[] = {
289 EXCEP_TXT(NULL, NULL),
290 EXCEP_TXT("AE_BAD_SIGNATURE", "An ACPI table has an invalid signature"),
291 EXCEP_TXT("AE_BAD_HEADER", "Invalid field in an ACPI table header"),
292 EXCEP_TXT("AE_BAD_CHECKSUM", "An ACPI table checksum is not correct"),
293 EXCEP_TXT("AE_BAD_VALUE", "An invalid value was found in a table"),
294 EXCEP_TXT("AE_INVALID_TABLE_LENGTH",
295 "The FADT or FACS has improper length")
296};
297
298static const struct acpi_exception_info acpi_gbl_exception_names_aml[] = {
299 EXCEP_TXT(NULL, NULL),
300 EXCEP_TXT("AE_AML_BAD_OPCODE", "Invalid AML opcode encountered"),
301 EXCEP_TXT("AE_AML_NO_OPERAND", "A required operand is missing"),
302 EXCEP_TXT("AE_AML_OPERAND_TYPE",
303 "An operand of an incorrect type was encountered"),
304 EXCEP_TXT("AE_AML_OPERAND_VALUE",
305 "The operand had an inappropriate or invalid value"),
306 EXCEP_TXT("AE_AML_UNINITIALIZED_LOCAL",
307 "Method tried to use an uninitialized local variable"),
308 EXCEP_TXT("AE_AML_UNINITIALIZED_ARG",
309 "Method tried to use an uninitialized argument"),
310 EXCEP_TXT("AE_AML_UNINITIALIZED_ELEMENT",
311 "Method tried to use an empty package element"),
312 EXCEP_TXT("AE_AML_NUMERIC_OVERFLOW",
313 "Overflow during BCD conversion or other"),
314 EXCEP_TXT("AE_AML_REGION_LIMIT",
315 "Tried to access beyond the end of an Operation Region"),
316 EXCEP_TXT("AE_AML_BUFFER_LIMIT",
317 "Tried to access beyond the end of a buffer"),
318 EXCEP_TXT("AE_AML_PACKAGE_LIMIT",
319 "Tried to access beyond the end of a package"),
320 EXCEP_TXT("AE_AML_DIVIDE_BY_ZERO",
321 "During execution of AML Divide operator"),
322 EXCEP_TXT("AE_AML_BAD_NAME",
323 "An ACPI name contains invalid character(s)"),
324 EXCEP_TXT("AE_AML_NAME_NOT_FOUND",
325 "Could not resolve a named reference"),
326 EXCEP_TXT("AE_AML_INTERNAL", "An internal error within the interprete"),
327 EXCEP_TXT("AE_AML_INVALID_SPACE_ID",
328 "An Operation Region SpaceID is invalid"),
329 EXCEP_TXT("AE_AML_STRING_LIMIT",
330 "String is longer than 200 characters"),
331 EXCEP_TXT("AE_AML_NO_RETURN_VALUE",
332 "A method did not return a required value"),
333 EXCEP_TXT("AE_AML_METHOD_LIMIT",
334 "A control method reached the maximum reentrancy limit of 255"),
335 EXCEP_TXT("AE_AML_NOT_OWNER",
336 "A thread tried to release a mutex that it does not own"),
337 EXCEP_TXT("AE_AML_MUTEX_ORDER", "Mutex SyncLevel release mismatch"),
338 EXCEP_TXT("AE_AML_MUTEX_NOT_ACQUIRED",
339 "Attempt to release a mutex that was not previously acquired"),
340 EXCEP_TXT("AE_AML_INVALID_RESOURCE_TYPE",
341 "Invalid resource type in resource list"),
342 EXCEP_TXT("AE_AML_INVALID_INDEX",
343 "Invalid Argx or Localx (x too large)"),
344 EXCEP_TXT("AE_AML_REGISTER_LIMIT",
345 "Bank value or Index value beyond range of register"),
346 EXCEP_TXT("AE_AML_NO_WHILE", "Break or Continue without a While"),
347 EXCEP_TXT("AE_AML_ALIGNMENT",
348 "Non-aligned memory transfer on platform that does not support this"),
349 EXCEP_TXT("AE_AML_NO_RESOURCE_END_TAG",
350 "No End Tag in a resource list"),
351 EXCEP_TXT("AE_AML_BAD_RESOURCE_VALUE",
352 "Invalid value of a resource element"),
353 EXCEP_TXT("AE_AML_CIRCULAR_REFERENCE",
354 "Two references refer to each other"),
355 EXCEP_TXT("AE_AML_BAD_RESOURCE_LENGTH",
356 "The length of a Resource Descriptor in the AML is incorrect"),
357 EXCEP_TXT("AE_AML_ILLEGAL_ADDRESS",
358 "A memory, I/O, or PCI configuration address is invalid"),
359 EXCEP_TXT("AE_AML_INFINITE_LOOP",
360 "An apparent infinite AML While loop, method was aborted"),
361 EXCEP_TXT("AE_AML_UNINITIALIZED_NODE",
362 "A namespace node is uninitialized or unresolved"),
363 EXCEP_TXT("AE_AML_TARGET_TYPE",
364 "A target operand of an incorrect type was encountered")
365};
366
367static const struct acpi_exception_info acpi_gbl_exception_names_ctrl[] = {
368 EXCEP_TXT(NULL, NULL),
369 EXCEP_TXT("AE_CTRL_RETURN_VALUE", "A Method returned a value"),
370 EXCEP_TXT("AE_CTRL_PENDING", "Method is calling another method"),
371 EXCEP_TXT("AE_CTRL_TERMINATE", "Terminate the executing method"),
372 EXCEP_TXT("AE_CTRL_TRUE", "An If or While predicate result"),
373 EXCEP_TXT("AE_CTRL_FALSE", "An If or While predicate result"),
374 EXCEP_TXT("AE_CTRL_DEPTH", "Maximum search depth has been reached"),
375 EXCEP_TXT("AE_CTRL_END", "An If or While predicate is false"),
376 EXCEP_TXT("AE_CTRL_TRANSFER", "Transfer control to called method"),
377 EXCEP_TXT("AE_CTRL_BREAK", "A Break has been executed"),
378 EXCEP_TXT("AE_CTRL_CONTINUE", "A Continue has been executed"),
379 EXCEP_TXT("AE_CTRL_PARSE_CONTINUE", "Used to skip over bad opcodes"),
380 EXCEP_TXT("AE_CTRL_PARSE_PENDING", "Used to implement AML While loops")
381};
382
383#endif /* EXCEPTION_TABLE */
384
385#endif /* __ACEXCEP_H__ */