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