1 /****************************************************************************** 2 * 3 * Name: acexcep.h - Exception codes returned by the ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #ifndef __ACEXCEP_H__ 117 #define __ACEXCEP_H__ 118 119 120 /* 121 * Exceptions returned by external ACPI interfaces 122 */ 123 #define AE_CODE_ENVIRONMENTAL 0x0000 124 #define AE_CODE_PROGRAMMER 0x1000 125 #define AE_CODE_ACPI_TABLES 0x2000 126 #define AE_CODE_AML 0x3000 127 #define AE_CODE_CONTROL 0x4000 128 #define AE_CODE_MAX 0x4000 129 #define AE_CODE_MASK 0xF000 130 131 132 #define ACPI_SUCCESS(a) (!(a)) 133 #define ACPI_FAILURE(a) (a) 134 135 136 #define AE_OK (ACPI_STATUS) 0x0000 137 138 /* 139 * Environmental exceptions 140 */ 141 #define AE_ERROR (ACPI_STATUS) (0x0001 | AE_CODE_ENVIRONMENTAL) 142 #define AE_NO_ACPI_TABLES (ACPI_STATUS) (0x0002 | AE_CODE_ENVIRONMENTAL) 143 #define AE_NO_NAMESPACE (ACPI_STATUS) (0x0003 | AE_CODE_ENVIRONMENTAL) 144 #define AE_NO_MEMORY (ACPI_STATUS) (0x0004 | AE_CODE_ENVIRONMENTAL) 145 #define AE_NOT_FOUND (ACPI_STATUS) (0x0005 | AE_CODE_ENVIRONMENTAL) 146 #define AE_NOT_EXIST (ACPI_STATUS) (0x0006 | AE_CODE_ENVIRONMENTAL) 147 #define AE_ALREADY_EXISTS (ACPI_STATUS) (0x0007 | AE_CODE_ENVIRONMENTAL) 148 #define AE_TYPE (ACPI_STATUS) (0x0008 | AE_CODE_ENVIRONMENTAL) 149 #define AE_NULL_OBJECT (ACPI_STATUS) (0x0009 | AE_CODE_ENVIRONMENTAL) 150 #define AE_NULL_ENTRY (ACPI_STATUS) (0x000A | AE_CODE_ENVIRONMENTAL) 151 #define AE_BUFFER_OVERFLOW (ACPI_STATUS) (0x000B | AE_CODE_ENVIRONMENTAL) 152 #define AE_STACK_OVERFLOW (ACPI_STATUS) (0x000C | AE_CODE_ENVIRONMENTAL) 153 #define AE_STACK_UNDERFLOW (ACPI_STATUS) (0x000D | AE_CODE_ENVIRONMENTAL) 154 #define AE_NOT_IMPLEMENTED (ACPI_STATUS) (0x000E | AE_CODE_ENVIRONMENTAL) 155 #define AE_SUPPORT (ACPI_STATUS) (0x000F | AE_CODE_ENVIRONMENTAL) 156 #define AE_LIMIT (ACPI_STATUS) (0x0010 | AE_CODE_ENVIRONMENTAL) 157 #define AE_TIME (ACPI_STATUS) (0x0011 | AE_CODE_ENVIRONMENTAL) 158 #define AE_ACQUIRE_DEADLOCK (ACPI_STATUS) (0x0012 | AE_CODE_ENVIRONMENTAL) 159 #define AE_RELEASE_DEADLOCK (ACPI_STATUS) (0x0013 | AE_CODE_ENVIRONMENTAL) 160 #define AE_NOT_ACQUIRED (ACPI_STATUS) (0x0014 | AE_CODE_ENVIRONMENTAL) 161 #define AE_ALREADY_ACQUIRED (ACPI_STATUS) (0x0015 | AE_CODE_ENVIRONMENTAL) 162 #define AE_NO_HARDWARE_RESPONSE (ACPI_STATUS) (0x0016 | AE_CODE_ENVIRONMENTAL) 163 #define AE_NO_GLOBAL_LOCK (ACPI_STATUS) (0x0017 | AE_CODE_ENVIRONMENTAL) 164 #define AE_ABORT_METHOD (ACPI_STATUS) (0x0018 | AE_CODE_ENVIRONMENTAL) 165 #define AE_SAME_HANDLER (ACPI_STATUS) (0x0019 | AE_CODE_ENVIRONMENTAL) 166 #define AE_NO_HANDLER (ACPI_STATUS) (0x001A | AE_CODE_ENVIRONMENTAL) 167 #define AE_OWNER_ID_LIMIT (ACPI_STATUS) (0x001B | AE_CODE_ENVIRONMENTAL) 168 #define AE_NOT_CONFIGURED (ACPI_STATUS) (0x001C | AE_CODE_ENVIRONMENTAL) 169 170 #define AE_CODE_ENV_MAX 0x001C 171 172 173 /* 174 * Programmer exceptions 175 */ 176 #define AE_BAD_PARAMETER (ACPI_STATUS) (0x0001 | AE_CODE_PROGRAMMER) 177 #define AE_BAD_CHARACTER (ACPI_STATUS) (0x0002 | AE_CODE_PROGRAMMER) 178 #define AE_BAD_PATHNAME (ACPI_STATUS) (0x0003 | AE_CODE_PROGRAMMER) 179 #define AE_BAD_DATA (ACPI_STATUS) (0x0004 | AE_CODE_PROGRAMMER) 180 #define AE_BAD_HEX_CONSTANT (ACPI_STATUS) (0x0005 | AE_CODE_PROGRAMMER) 181 #define AE_BAD_OCTAL_CONSTANT (ACPI_STATUS) (0x0006 | AE_CODE_PROGRAMMER) 182 #define AE_BAD_DECIMAL_CONSTANT (ACPI_STATUS) (0x0007 | AE_CODE_PROGRAMMER) 183 #define AE_MISSING_ARGUMENTS (ACPI_STATUS) (0x0008 | AE_CODE_PROGRAMMER) 184 #define AE_BAD_ADDRESS (ACPI_STATUS) (0x0009 | AE_CODE_PROGRAMMER) 185 186 #define AE_CODE_PGM_MAX 0x0009 187 188 189 /* 190 * Acpi table exceptions 191 */ 192 #define AE_BAD_SIGNATURE (ACPI_STATUS) (0x0001 | AE_CODE_ACPI_TABLES) 193 #define AE_BAD_HEADER (ACPI_STATUS) (0x0002 | AE_CODE_ACPI_TABLES) 194 #define AE_BAD_CHECKSUM (ACPI_STATUS) (0x0003 | AE_CODE_ACPI_TABLES) 195 #define AE_BAD_VALUE (ACPI_STATUS) (0x0004 | AE_CODE_ACPI_TABLES) 196 #define AE_INVALID_TABLE_LENGTH (ACPI_STATUS) (0x0005 | AE_CODE_ACPI_TABLES) 197 198 #define AE_CODE_TBL_MAX 0x0005 199 200 201 /* 202 * AML exceptions. These are caused by problems with 203 * the actual AML byte stream 204 */ 205 #define AE_AML_BAD_OPCODE (ACPI_STATUS) (0x0001 | AE_CODE_AML) 206 #define AE_AML_NO_OPERAND (ACPI_STATUS) (0x0002 | AE_CODE_AML) 207 #define AE_AML_OPERAND_TYPE (ACPI_STATUS) (0x0003 | AE_CODE_AML) 208 #define AE_AML_OPERAND_VALUE (ACPI_STATUS) (0x0004 | AE_CODE_AML) 209 #define AE_AML_UNINITIALIZED_LOCAL (ACPI_STATUS) (0x0005 | AE_CODE_AML) 210 #define AE_AML_UNINITIALIZED_ARG (ACPI_STATUS) (0x0006 | AE_CODE_AML) 211 #define AE_AML_UNINITIALIZED_ELEMENT (ACPI_STATUS) (0x0007 | AE_CODE_AML) 212 #define AE_AML_NUMERIC_OVERFLOW (ACPI_STATUS) (0x0008 | AE_CODE_AML) 213 #define AE_AML_REGION_LIMIT (ACPI_STATUS) (0x0009 | AE_CODE_AML) 214 #define AE_AML_BUFFER_LIMIT (ACPI_STATUS) (0x000A | AE_CODE_AML) 215 #define AE_AML_PACKAGE_LIMIT (ACPI_STATUS) (0x000B | AE_CODE_AML) 216 #define AE_AML_DIVIDE_BY_ZERO (ACPI_STATUS) (0x000C | AE_CODE_AML) 217 #define AE_AML_BAD_NAME (ACPI_STATUS) (0x000D | AE_CODE_AML) 218 #define AE_AML_NAME_NOT_FOUND (ACPI_STATUS) (0x000E | AE_CODE_AML) 219 #define AE_AML_INTERNAL (ACPI_STATUS) (0x000F | AE_CODE_AML) 220 #define AE_AML_INVALID_SPACE_ID (ACPI_STATUS) (0x0010 | AE_CODE_AML) 221 #define AE_AML_STRING_LIMIT (ACPI_STATUS) (0x0011 | AE_CODE_AML) 222 #define AE_AML_NO_RETURN_VALUE (ACPI_STATUS) (0x0012 | AE_CODE_AML) 223 #define AE_AML_METHOD_LIMIT (ACPI_STATUS) (0x0013 | AE_CODE_AML) 224 #define AE_AML_NOT_OWNER (ACPI_STATUS) (0x0014 | AE_CODE_AML) 225 #define AE_AML_MUTEX_ORDER (ACPI_STATUS) (0x0015 | AE_CODE_AML) 226 #define AE_AML_MUTEX_NOT_ACQUIRED (ACPI_STATUS) (0x0016 | AE_CODE_AML) 227 #define AE_AML_INVALID_RESOURCE_TYPE (ACPI_STATUS) (0x0017 | AE_CODE_AML) 228 #define AE_AML_INVALID_INDEX (ACPI_STATUS) (0x0018 | AE_CODE_AML) 229 #define AE_AML_REGISTER_LIMIT (ACPI_STATUS) (0x0019 | AE_CODE_AML) 230 #define AE_AML_NO_WHILE (ACPI_STATUS) (0x001A | AE_CODE_AML) 231 #define AE_AML_ALIGNMENT (ACPI_STATUS) (0x001B | AE_CODE_AML) 232 #define AE_AML_NO_RESOURCE_END_TAG (ACPI_STATUS) (0x001C | AE_CODE_AML) 233 #define AE_AML_BAD_RESOURCE_VALUE (ACPI_STATUS) (0x001D | AE_CODE_AML) 234 #define AE_AML_CIRCULAR_REFERENCE (ACPI_STATUS) (0x001E | AE_CODE_AML) 235 #define AE_AML_BAD_RESOURCE_LENGTH (ACPI_STATUS) (0x001F | AE_CODE_AML) 236 #define AE_AML_ILLEGAL_ADDRESS (ACPI_STATUS) (0x0020 | AE_CODE_AML) 237 #define AE_AML_INFINITE_LOOP (ACPI_STATUS) (0x0021 | AE_CODE_AML) 238 239 #define AE_CODE_AML_MAX 0x0021 240 241 242 /* 243 * Internal exceptions used for control 244 */ 245 #define AE_CTRL_RETURN_VALUE (ACPI_STATUS) (0x0001 | AE_CODE_CONTROL) 246 #define AE_CTRL_PENDING (ACPI_STATUS) (0x0002 | AE_CODE_CONTROL) 247 #define AE_CTRL_TERMINATE (ACPI_STATUS) (0x0003 | AE_CODE_CONTROL) 248 #define AE_CTRL_TRUE (ACPI_STATUS) (0x0004 | AE_CODE_CONTROL) 249 #define AE_CTRL_FALSE (ACPI_STATUS) (0x0005 | AE_CODE_CONTROL) 250 #define AE_CTRL_DEPTH (ACPI_STATUS) (0x0006 | AE_CODE_CONTROL) 251 #define AE_CTRL_END (ACPI_STATUS) (0x0007 | AE_CODE_CONTROL) 252 #define AE_CTRL_TRANSFER (ACPI_STATUS) (0x0008 | AE_CODE_CONTROL) 253 #define AE_CTRL_BREAK (ACPI_STATUS) (0x0009 | AE_CODE_CONTROL) 254 #define AE_CTRL_CONTINUE (ACPI_STATUS) (0x000A | AE_CODE_CONTROL) 255 #define AE_CTRL_SKIP (ACPI_STATUS) (0x000B | AE_CODE_CONTROL) 256 #define AE_CTRL_PARSE_CONTINUE (ACPI_STATUS) (0x000C | AE_CODE_CONTROL) 257 #define AE_CTRL_PARSE_PENDING (ACPI_STATUS) (0x000D | AE_CODE_CONTROL) 258 259 #define AE_CODE_CTRL_MAX 0x000D 260 261 262 /* Exception strings for AcpiFormatException */ 263 264 #ifdef ACPI_DEFINE_EXCEPTION_TABLE 265 266 /* 267 * String versions of the exception codes above 268 * These strings must match the corresponding defines exactly 269 */ 270 char const *AcpiGbl_ExceptionNames_Env[] = 271 { 272 "AE_OK", 273 "AE_ERROR", 274 "AE_NO_ACPI_TABLES", 275 "AE_NO_NAMESPACE", 276 "AE_NO_MEMORY", 277 "AE_NOT_FOUND", 278 "AE_NOT_EXIST", 279 "AE_ALREADY_EXISTS", 280 "AE_TYPE", 281 "AE_NULL_OBJECT", 282 "AE_NULL_ENTRY", 283 "AE_BUFFER_OVERFLOW", 284 "AE_STACK_OVERFLOW", 285 "AE_STACK_UNDERFLOW", 286 "AE_NOT_IMPLEMENTED", 287 "AE_SUPPORT", 288 "AE_LIMIT", 289 "AE_TIME", 290 "AE_ACQUIRE_DEADLOCK", 291 "AE_RELEASE_DEADLOCK", 292 "AE_NOT_ACQUIRED", 293 "AE_ALREADY_ACQUIRED", 294 "AE_NO_HARDWARE_RESPONSE", 295 "AE_NO_GLOBAL_LOCK", 296 "AE_ABORT_METHOD", 297 "AE_SAME_HANDLER", 298 "AE_NO_HANDLER", 299 "AE_OWNER_ID_LIMIT", 300 "AE_NOT_CONFIGURED" 301 }; 302 303 char const *AcpiGbl_ExceptionNames_Pgm[] = 304 { 305 NULL, 306 "AE_BAD_PARAMETER", 307 "AE_BAD_CHARACTER", 308 "AE_BAD_PATHNAME", 309 "AE_BAD_DATA", 310 "AE_BAD_HEX_CONSTANT", 311 "AE_BAD_OCTAL_CONSTANT", 312 "AE_BAD_DECIMAL_CONSTANT", 313 "AE_MISSING_ARGUMENTS", 314 "AE_BAD_ADDRESS" 315 }; 316 317 char const *AcpiGbl_ExceptionNames_Tbl[] = 318 { 319 NULL, 320 "AE_BAD_SIGNATURE", 321 "AE_BAD_HEADER", 322 "AE_BAD_CHECKSUM", 323 "AE_BAD_VALUE", 324 "AE_INVALID_TABLE_LENGTH" 325 }; 326 327 char const *AcpiGbl_ExceptionNames_Aml[] = 328 { 329 NULL, 330 "AE_AML_BAD_OPCODE", 331 "AE_AML_NO_OPERAND", 332 "AE_AML_OPERAND_TYPE", 333 "AE_AML_OPERAND_VALUE", 334 "AE_AML_UNINITIALIZED_LOCAL", 335 "AE_AML_UNINITIALIZED_ARG", 336 "AE_AML_UNINITIALIZED_ELEMENT", 337 "AE_AML_NUMERIC_OVERFLOW", 338 "AE_AML_REGION_LIMIT", 339 "AE_AML_BUFFER_LIMIT", 340 "AE_AML_PACKAGE_LIMIT", 341 "AE_AML_DIVIDE_BY_ZERO", 342 "AE_AML_BAD_NAME", 343 "AE_AML_NAME_NOT_FOUND", 344 "AE_AML_INTERNAL", 345 "AE_AML_INVALID_SPACE_ID", 346 "AE_AML_STRING_LIMIT", 347 "AE_AML_NO_RETURN_VALUE", 348 "AE_AML_METHOD_LIMIT", 349 "AE_AML_NOT_OWNER", 350 "AE_AML_MUTEX_ORDER", 351 "AE_AML_MUTEX_NOT_ACQUIRED", 352 "AE_AML_INVALID_RESOURCE_TYPE", 353 "AE_AML_INVALID_INDEX", 354 "AE_AML_REGISTER_LIMIT", 355 "AE_AML_NO_WHILE", 356 "AE_AML_ALIGNMENT", 357 "AE_AML_NO_RESOURCE_END_TAG", 358 "AE_AML_BAD_RESOURCE_VALUE", 359 "AE_AML_CIRCULAR_REFERENCE", 360 "AE_AML_BAD_RESOURCE_LENGTH", 361 "AE_AML_ILLEGAL_ADDRESS", 362 "AE_AML_INFINITE_LOOP" 363 }; 364 365 char const *AcpiGbl_ExceptionNames_Ctrl[] = 366 { 367 NULL, 368 "AE_CTRL_RETURN_VALUE", 369 "AE_CTRL_PENDING", 370 "AE_CTRL_TERMINATE", 371 "AE_CTRL_TRUE", 372 "AE_CTRL_FALSE", 373 "AE_CTRL_DEPTH", 374 "AE_CTRL_END", 375 "AE_CTRL_TRANSFER", 376 "AE_CTRL_BREAK", 377 "AE_CTRL_CONTINUE", 378 "AE_CTRL_SKIP", 379 "AE_CTRL_PARSE_CONTINUE", 380 "AE_CTRL_PARSE_PENDING" 381 }; 382 383 #endif /* EXCEPTION_TABLE */ 384 385 #endif /* __ACEXCEP_H__ */ 386