xref: /freebsd/sys/contrib/dev/acpica/include/acexcep.h (revision f5f7c05209ca2c3748fd8b27c5e80ffad49120eb)
1 /******************************************************************************
2  *
3  * Name: acexcep.h - Exception codes returned by the ACPI subsystem
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2013, 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 /*
49  * Exceptions returned by external ACPI interfaces
50  */
51 #define AE_CODE_ENVIRONMENTAL           0x0000
52 #define AE_CODE_PROGRAMMER              0x1000
53 #define AE_CODE_ACPI_TABLES             0x2000
54 #define AE_CODE_AML                     0x3000
55 #define AE_CODE_CONTROL                 0x4000
56 #define AE_CODE_MAX                     0x4000
57 #define AE_CODE_MASK                    0xF000
58 
59 
60 #define ACPI_SUCCESS(a)                 (!(a))
61 #define ACPI_FAILURE(a)                 (a)
62 
63 
64 #define AE_OK                           (ACPI_STATUS) 0x0000
65 
66 /*
67  * Environmental exceptions
68  */
69 #define AE_ERROR                        (ACPI_STATUS) (0x0001 | AE_CODE_ENVIRONMENTAL)
70 #define AE_NO_ACPI_TABLES               (ACPI_STATUS) (0x0002 | AE_CODE_ENVIRONMENTAL)
71 #define AE_NO_NAMESPACE                 (ACPI_STATUS) (0x0003 | AE_CODE_ENVIRONMENTAL)
72 #define AE_NO_MEMORY                    (ACPI_STATUS) (0x0004 | AE_CODE_ENVIRONMENTAL)
73 #define AE_NOT_FOUND                    (ACPI_STATUS) (0x0005 | AE_CODE_ENVIRONMENTAL)
74 #define AE_NOT_EXIST                    (ACPI_STATUS) (0x0006 | AE_CODE_ENVIRONMENTAL)
75 #define AE_ALREADY_EXISTS               (ACPI_STATUS) (0x0007 | AE_CODE_ENVIRONMENTAL)
76 #define AE_TYPE                         (ACPI_STATUS) (0x0008 | AE_CODE_ENVIRONMENTAL)
77 #define AE_NULL_OBJECT                  (ACPI_STATUS) (0x0009 | AE_CODE_ENVIRONMENTAL)
78 #define AE_NULL_ENTRY                   (ACPI_STATUS) (0x000A | AE_CODE_ENVIRONMENTAL)
79 #define AE_BUFFER_OVERFLOW              (ACPI_STATUS) (0x000B | AE_CODE_ENVIRONMENTAL)
80 #define AE_STACK_OVERFLOW               (ACPI_STATUS) (0x000C | AE_CODE_ENVIRONMENTAL)
81 #define AE_STACK_UNDERFLOW              (ACPI_STATUS) (0x000D | AE_CODE_ENVIRONMENTAL)
82 #define AE_NOT_IMPLEMENTED              (ACPI_STATUS) (0x000E | AE_CODE_ENVIRONMENTAL)
83 #define AE_SUPPORT                      (ACPI_STATUS) (0x000F | AE_CODE_ENVIRONMENTAL)
84 #define AE_LIMIT                        (ACPI_STATUS) (0x0010 | AE_CODE_ENVIRONMENTAL)
85 #define AE_TIME                         (ACPI_STATUS) (0x0011 | AE_CODE_ENVIRONMENTAL)
86 #define AE_ACQUIRE_DEADLOCK             (ACPI_STATUS) (0x0012 | AE_CODE_ENVIRONMENTAL)
87 #define AE_RELEASE_DEADLOCK             (ACPI_STATUS) (0x0013 | AE_CODE_ENVIRONMENTAL)
88 #define AE_NOT_ACQUIRED                 (ACPI_STATUS) (0x0014 | AE_CODE_ENVIRONMENTAL)
89 #define AE_ALREADY_ACQUIRED             (ACPI_STATUS) (0x0015 | AE_CODE_ENVIRONMENTAL)
90 #define AE_NO_HARDWARE_RESPONSE         (ACPI_STATUS) (0x0016 | AE_CODE_ENVIRONMENTAL)
91 #define AE_NO_GLOBAL_LOCK               (ACPI_STATUS) (0x0017 | AE_CODE_ENVIRONMENTAL)
92 #define AE_ABORT_METHOD                 (ACPI_STATUS) (0x0018 | AE_CODE_ENVIRONMENTAL)
93 #define AE_SAME_HANDLER                 (ACPI_STATUS) (0x0019 | AE_CODE_ENVIRONMENTAL)
94 #define AE_NO_HANDLER                   (ACPI_STATUS) (0x001A | AE_CODE_ENVIRONMENTAL)
95 #define AE_OWNER_ID_LIMIT               (ACPI_STATUS) (0x001B | AE_CODE_ENVIRONMENTAL)
96 #define AE_NOT_CONFIGURED               (ACPI_STATUS) (0x001C | AE_CODE_ENVIRONMENTAL)
97 
98 #define AE_CODE_ENV_MAX                 0x001C
99 
100 
101 /*
102  * Programmer exceptions
103  */
104 #define AE_BAD_PARAMETER                (ACPI_STATUS) (0x0001 | AE_CODE_PROGRAMMER)
105 #define AE_BAD_CHARACTER                (ACPI_STATUS) (0x0002 | AE_CODE_PROGRAMMER)
106 #define AE_BAD_PATHNAME                 (ACPI_STATUS) (0x0003 | AE_CODE_PROGRAMMER)
107 #define AE_BAD_DATA                     (ACPI_STATUS) (0x0004 | AE_CODE_PROGRAMMER)
108 #define AE_BAD_HEX_CONSTANT             (ACPI_STATUS) (0x0005 | AE_CODE_PROGRAMMER)
109 #define AE_BAD_OCTAL_CONSTANT           (ACPI_STATUS) (0x0006 | AE_CODE_PROGRAMMER)
110 #define AE_BAD_DECIMAL_CONSTANT         (ACPI_STATUS) (0x0007 | AE_CODE_PROGRAMMER)
111 #define AE_MISSING_ARGUMENTS            (ACPI_STATUS) (0x0008 | AE_CODE_PROGRAMMER)
112 #define AE_BAD_ADDRESS                  (ACPI_STATUS) (0x0009 | AE_CODE_PROGRAMMER)
113 
114 #define AE_CODE_PGM_MAX                 0x0009
115 
116 
117 /*
118  * Acpi table exceptions
119  */
120 #define AE_BAD_SIGNATURE                (ACPI_STATUS) (0x0001 | AE_CODE_ACPI_TABLES)
121 #define AE_BAD_HEADER                   (ACPI_STATUS) (0x0002 | AE_CODE_ACPI_TABLES)
122 #define AE_BAD_CHECKSUM                 (ACPI_STATUS) (0x0003 | AE_CODE_ACPI_TABLES)
123 #define AE_BAD_VALUE                    (ACPI_STATUS) (0x0004 | AE_CODE_ACPI_TABLES)
124 #define AE_INVALID_TABLE_LENGTH         (ACPI_STATUS) (0x0005 | AE_CODE_ACPI_TABLES)
125 
126 #define AE_CODE_TBL_MAX                 0x0005
127 
128 
129 /*
130  * AML exceptions. These are caused by problems with
131  * the actual AML byte stream
132  */
133 #define AE_AML_BAD_OPCODE               (ACPI_STATUS) (0x0001 | AE_CODE_AML)
134 #define AE_AML_NO_OPERAND               (ACPI_STATUS) (0x0002 | AE_CODE_AML)
135 #define AE_AML_OPERAND_TYPE             (ACPI_STATUS) (0x0003 | AE_CODE_AML)
136 #define AE_AML_OPERAND_VALUE            (ACPI_STATUS) (0x0004 | AE_CODE_AML)
137 #define AE_AML_UNINITIALIZED_LOCAL      (ACPI_STATUS) (0x0005 | AE_CODE_AML)
138 #define AE_AML_UNINITIALIZED_ARG        (ACPI_STATUS) (0x0006 | AE_CODE_AML)
139 #define AE_AML_UNINITIALIZED_ELEMENT    (ACPI_STATUS) (0x0007 | AE_CODE_AML)
140 #define AE_AML_NUMERIC_OVERFLOW         (ACPI_STATUS) (0x0008 | AE_CODE_AML)
141 #define AE_AML_REGION_LIMIT             (ACPI_STATUS) (0x0009 | AE_CODE_AML)
142 #define AE_AML_BUFFER_LIMIT             (ACPI_STATUS) (0x000A | AE_CODE_AML)
143 #define AE_AML_PACKAGE_LIMIT            (ACPI_STATUS) (0x000B | AE_CODE_AML)
144 #define AE_AML_DIVIDE_BY_ZERO           (ACPI_STATUS) (0x000C | AE_CODE_AML)
145 #define AE_AML_BAD_NAME                 (ACPI_STATUS) (0x000D | AE_CODE_AML)
146 #define AE_AML_NAME_NOT_FOUND           (ACPI_STATUS) (0x000E | AE_CODE_AML)
147 #define AE_AML_INTERNAL                 (ACPI_STATUS) (0x000F | AE_CODE_AML)
148 #define AE_AML_INVALID_SPACE_ID         (ACPI_STATUS) (0x0010 | AE_CODE_AML)
149 #define AE_AML_STRING_LIMIT             (ACPI_STATUS) (0x0011 | AE_CODE_AML)
150 #define AE_AML_NO_RETURN_VALUE          (ACPI_STATUS) (0x0012 | AE_CODE_AML)
151 #define AE_AML_METHOD_LIMIT             (ACPI_STATUS) (0x0013 | AE_CODE_AML)
152 #define AE_AML_NOT_OWNER                (ACPI_STATUS) (0x0014 | AE_CODE_AML)
153 #define AE_AML_MUTEX_ORDER              (ACPI_STATUS) (0x0015 | AE_CODE_AML)
154 #define AE_AML_MUTEX_NOT_ACQUIRED       (ACPI_STATUS) (0x0016 | AE_CODE_AML)
155 #define AE_AML_INVALID_RESOURCE_TYPE    (ACPI_STATUS) (0x0017 | AE_CODE_AML)
156 #define AE_AML_INVALID_INDEX            (ACPI_STATUS) (0x0018 | AE_CODE_AML)
157 #define AE_AML_REGISTER_LIMIT           (ACPI_STATUS) (0x0019 | AE_CODE_AML)
158 #define AE_AML_NO_WHILE                 (ACPI_STATUS) (0x001A | AE_CODE_AML)
159 #define AE_AML_ALIGNMENT                (ACPI_STATUS) (0x001B | AE_CODE_AML)
160 #define AE_AML_NO_RESOURCE_END_TAG      (ACPI_STATUS) (0x001C | AE_CODE_AML)
161 #define AE_AML_BAD_RESOURCE_VALUE       (ACPI_STATUS) (0x001D | AE_CODE_AML)
162 #define AE_AML_CIRCULAR_REFERENCE       (ACPI_STATUS) (0x001E | AE_CODE_AML)
163 #define AE_AML_BAD_RESOURCE_LENGTH      (ACPI_STATUS) (0x001F | AE_CODE_AML)
164 #define AE_AML_ILLEGAL_ADDRESS          (ACPI_STATUS) (0x0020 | AE_CODE_AML)
165 #define AE_AML_INFINITE_LOOP            (ACPI_STATUS) (0x0021 | AE_CODE_AML)
166 
167 #define AE_CODE_AML_MAX                 0x0021
168 
169 
170 /*
171  * Internal exceptions used for control
172  */
173 #define AE_CTRL_RETURN_VALUE            (ACPI_STATUS) (0x0001 | AE_CODE_CONTROL)
174 #define AE_CTRL_PENDING                 (ACPI_STATUS) (0x0002 | AE_CODE_CONTROL)
175 #define AE_CTRL_TERMINATE               (ACPI_STATUS) (0x0003 | AE_CODE_CONTROL)
176 #define AE_CTRL_TRUE                    (ACPI_STATUS) (0x0004 | AE_CODE_CONTROL)
177 #define AE_CTRL_FALSE                   (ACPI_STATUS) (0x0005 | AE_CODE_CONTROL)
178 #define AE_CTRL_DEPTH                   (ACPI_STATUS) (0x0006 | AE_CODE_CONTROL)
179 #define AE_CTRL_END                     (ACPI_STATUS) (0x0007 | AE_CODE_CONTROL)
180 #define AE_CTRL_TRANSFER                (ACPI_STATUS) (0x0008 | AE_CODE_CONTROL)
181 #define AE_CTRL_BREAK                   (ACPI_STATUS) (0x0009 | AE_CODE_CONTROL)
182 #define AE_CTRL_CONTINUE                (ACPI_STATUS) (0x000A | AE_CODE_CONTROL)
183 #define AE_CTRL_SKIP                    (ACPI_STATUS) (0x000B | AE_CODE_CONTROL)
184 #define AE_CTRL_PARSE_CONTINUE          (ACPI_STATUS) (0x000C | AE_CODE_CONTROL)
185 #define AE_CTRL_PARSE_PENDING           (ACPI_STATUS) (0x000D | AE_CODE_CONTROL)
186 
187 #define AE_CODE_CTRL_MAX                0x000D
188 
189 
190 /* Exception strings for AcpiFormatException */
191 
192 #ifdef ACPI_DEFINE_EXCEPTION_TABLE
193 
194 /*
195  * String versions of the exception codes above
196  * These strings must match the corresponding defines exactly
197  */
198 char const   *AcpiGbl_ExceptionNames_Env[] =
199 {
200     "AE_OK",
201     "AE_ERROR",
202     "AE_NO_ACPI_TABLES",
203     "AE_NO_NAMESPACE",
204     "AE_NO_MEMORY",
205     "AE_NOT_FOUND",
206     "AE_NOT_EXIST",
207     "AE_ALREADY_EXISTS",
208     "AE_TYPE",
209     "AE_NULL_OBJECT",
210     "AE_NULL_ENTRY",
211     "AE_BUFFER_OVERFLOW",
212     "AE_STACK_OVERFLOW",
213     "AE_STACK_UNDERFLOW",
214     "AE_NOT_IMPLEMENTED",
215     "AE_SUPPORT",
216     "AE_LIMIT",
217     "AE_TIME",
218     "AE_ACQUIRE_DEADLOCK",
219     "AE_RELEASE_DEADLOCK",
220     "AE_NOT_ACQUIRED",
221     "AE_ALREADY_ACQUIRED",
222     "AE_NO_HARDWARE_RESPONSE",
223     "AE_NO_GLOBAL_LOCK",
224     "AE_ABORT_METHOD",
225     "AE_SAME_HANDLER",
226     "AE_NO_HANDLER",
227     "AE_OWNER_ID_LIMIT",
228     "AE_NOT_CONFIGURED"
229 };
230 
231 char const   *AcpiGbl_ExceptionNames_Pgm[] =
232 {
233     NULL,
234     "AE_BAD_PARAMETER",
235     "AE_BAD_CHARACTER",
236     "AE_BAD_PATHNAME",
237     "AE_BAD_DATA",
238     "AE_BAD_HEX_CONSTANT",
239     "AE_BAD_OCTAL_CONSTANT",
240     "AE_BAD_DECIMAL_CONSTANT",
241     "AE_MISSING_ARGUMENTS",
242     "AE_BAD_ADDRESS"
243 };
244 
245 char const   *AcpiGbl_ExceptionNames_Tbl[] =
246 {
247     NULL,
248     "AE_BAD_SIGNATURE",
249     "AE_BAD_HEADER",
250     "AE_BAD_CHECKSUM",
251     "AE_BAD_VALUE",
252     "AE_INVALID_TABLE_LENGTH"
253 };
254 
255 char const   *AcpiGbl_ExceptionNames_Aml[] =
256 {
257     NULL,
258     "AE_AML_BAD_OPCODE",
259     "AE_AML_NO_OPERAND",
260     "AE_AML_OPERAND_TYPE",
261     "AE_AML_OPERAND_VALUE",
262     "AE_AML_UNINITIALIZED_LOCAL",
263     "AE_AML_UNINITIALIZED_ARG",
264     "AE_AML_UNINITIALIZED_ELEMENT",
265     "AE_AML_NUMERIC_OVERFLOW",
266     "AE_AML_REGION_LIMIT",
267     "AE_AML_BUFFER_LIMIT",
268     "AE_AML_PACKAGE_LIMIT",
269     "AE_AML_DIVIDE_BY_ZERO",
270     "AE_AML_BAD_NAME",
271     "AE_AML_NAME_NOT_FOUND",
272     "AE_AML_INTERNAL",
273     "AE_AML_INVALID_SPACE_ID",
274     "AE_AML_STRING_LIMIT",
275     "AE_AML_NO_RETURN_VALUE",
276     "AE_AML_METHOD_LIMIT",
277     "AE_AML_NOT_OWNER",
278     "AE_AML_MUTEX_ORDER",
279     "AE_AML_MUTEX_NOT_ACQUIRED",
280     "AE_AML_INVALID_RESOURCE_TYPE",
281     "AE_AML_INVALID_INDEX",
282     "AE_AML_REGISTER_LIMIT",
283     "AE_AML_NO_WHILE",
284     "AE_AML_ALIGNMENT",
285     "AE_AML_NO_RESOURCE_END_TAG",
286     "AE_AML_BAD_RESOURCE_VALUE",
287     "AE_AML_CIRCULAR_REFERENCE",
288     "AE_AML_BAD_RESOURCE_LENGTH",
289     "AE_AML_ILLEGAL_ADDRESS",
290     "AE_AML_INFINITE_LOOP"
291 };
292 
293 char const   *AcpiGbl_ExceptionNames_Ctrl[] =
294 {
295     NULL,
296     "AE_CTRL_RETURN_VALUE",
297     "AE_CTRL_PENDING",
298     "AE_CTRL_TERMINATE",
299     "AE_CTRL_TRUE",
300     "AE_CTRL_FALSE",
301     "AE_CTRL_DEPTH",
302     "AE_CTRL_END",
303     "AE_CTRL_TRANSFER",
304     "AE_CTRL_BREAK",
305     "AE_CTRL_CONTINUE",
306     "AE_CTRL_SKIP",
307     "AE_CTRL_PARSE_CONTINUE",
308     "AE_CTRL_PARSE_PENDING"
309 };
310 
311 #endif /* EXCEPTION_TABLE */
312 
313 #endif /* __ACEXCEP_H__ */
314