drivers/acpi/include/acexcep.h

   1 /******************************************************************************
   2  *
   3  * Name: acexcep.h - Exception codes returned by the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  *  Copyright (C) 2000 - 2003, R. Byron Moore
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #ifndef __ACEXCEP_H__
  26 #define __ACEXCEP_H__
  27
  28
  29 /*
  30  * Exceptions returned by external ACPI interfaces
  31  */
  32
  33 #define AE_CODE_ENVIRONMENTAL           0x0000
  34 #define AE_CODE_PROGRAMMER              0x1000
  35 #define AE_CODE_ACPI_TABLES             0x2000
  36 #define AE_CODE_AML                     0x3000
  37 #define AE_CODE_CONTROL                 0x4000
  38 #define AE_CODE_MASK                    0xF000
  39
  40
  41 #define ACPI_SUCCESS(a)                 (!(a))
  42 #define ACPI_FAILURE(a)                 (a)
  43
  44
  45 #define AE_OK                           (acpi_status) 0x0000
  46
  47 /*
  48  * Environmental exceptions
  49  */
  50 #define AE_ERROR                        (acpi_status) (0x0001 | AE_CODE_ENVIRONMENTAL)
  51 #define AE_NO_ACPI_TABLES               (acpi_status) (0x0002 | AE_CODE_ENVIRONMENTAL)
  52 #define AE_NO_NAMESPACE                 (acpi_status) (0x0003 | AE_CODE_ENVIRONMENTAL)
  53 #define AE_NO_MEMORY                    (acpi_status) (0x0004 | AE_CODE_ENVIRONMENTAL)
  54 #define AE_NOT_FOUND                    (acpi_status) (0x0005 | AE_CODE_ENVIRONMENTAL)
  55 #define AE_NOT_EXIST                    (acpi_status) (0x0006 | AE_CODE_ENVIRONMENTAL)
  56 #define AE_ALREADY_EXISTS               (acpi_status) (0x0007 | AE_CODE_ENVIRONMENTAL)
  57 #define AE_TYPE                         (acpi_status) (0x0008 | AE_CODE_ENVIRONMENTAL)
  58 #define AE_NULL_OBJECT                  (acpi_status) (0x0009 | AE_CODE_ENVIRONMENTAL)
  59 #define AE_NULL_ENTRY                   (acpi_status) (0x000A | AE_CODE_ENVIRONMENTAL)
  60 #define AE_BUFFER_OVERFLOW              (acpi_status) (0x000B | AE_CODE_ENVIRONMENTAL)
  61 #define AE_STACK_OVERFLOW               (acpi_status) (0x000C | AE_CODE_ENVIRONMENTAL)
  62 #define AE_STACK_UNDERFLOW              (acpi_status) (0x000D | AE_CODE_ENVIRONMENTAL)
  63 #define AE_NOT_IMPLEMENTED              (acpi_status) (0x000E | AE_CODE_ENVIRONMENTAL)
  64 #define AE_VERSION_MISMATCH             (acpi_status) (0x000F | AE_CODE_ENVIRONMENTAL)
  65 #define AE_SUPPORT                      (acpi_status) (0x0010 | AE_CODE_ENVIRONMENTAL)
  66 #define AE_SHARE                        (acpi_status) (0x0011 | AE_CODE_ENVIRONMENTAL)
  67 #define AE_LIMIT                        (acpi_status) (0x0012 | AE_CODE_ENVIRONMENTAL)
  68 #define AE_TIME                         (acpi_status) (0x0013 | AE_CODE_ENVIRONMENTAL)
  69 #define AE_UNKNOWN_STATUS               (acpi_status) (0x0014 | AE_CODE_ENVIRONMENTAL)
  70 #define AE_ACQUIRE_DEADLOCK             (acpi_status) (0x0015 | AE_CODE_ENVIRONMENTAL)
  71 #define AE_RELEASE_DEADLOCK             (acpi_status) (0x0016 | AE_CODE_ENVIRONMENTAL)
  72 #define AE_NOT_ACQUIRED                 (acpi_status) (0x0017 | AE_CODE_ENVIRONMENTAL)
  73 #define AE_ALREADY_ACQUIRED             (acpi_status) (0x0018 | AE_CODE_ENVIRONMENTAL)
  74 #define AE_NO_HARDWARE_RESPONSE         (acpi_status) (0x0019 | AE_CODE_ENVIRONMENTAL)
  75 #define AE_NO_GLOBAL_LOCK               (acpi_status) (0x001A | AE_CODE_ENVIRONMENTAL)
  76 #define AE_LOGICAL_ADDRESS              (acpi_status) (0x001B | AE_CODE_ENVIRONMENTAL)
  77 #define AE_ABORT_METHOD                 (acpi_status) (0x001C | AE_CODE_ENVIRONMENTAL)
  78
  79 #define AE_CODE_ENV_MAX                 0x001C
  80
  81 /*
  82  * Programmer exceptions
  83  */
  84 #define AE_BAD_PARAMETER                (acpi_status) (0x0001 | AE_CODE_PROGRAMMER)
  85 #define AE_BAD_CHARACTER                (acpi_status) (0x0002 | AE_CODE_PROGRAMMER)
  86 #define AE_BAD_PATHNAME                 (acpi_status) (0x0003 | AE_CODE_PROGRAMMER)
  87 #define AE_BAD_DATA                     (acpi_status) (0x0004 | AE_CODE_PROGRAMMER)
  88 #define AE_BAD_ADDRESS                  (acpi_status) (0x0005 | AE_CODE_PROGRAMMER)
  89 #define AE_ALIGNMENT                    (acpi_status) (0x0006 | AE_CODE_PROGRAMMER)
  90 #define AE_BAD_HEX_CONSTANT             (acpi_status) (0x0007 | AE_CODE_PROGRAMMER)
  91 #define AE_BAD_OCTAL_CONSTANT           (acpi_status) (0x0008 | AE_CODE_PROGRAMMER)
  92 #define AE_BAD_DECIMAL_CONSTANT         (acpi_status) (0x0009 | AE_CODE_PROGRAMMER)
  93
  94 #define AE_CODE_PGM_MAX                 0x0009
  95
  96
  97 /*
  98  * Acpi table exceptions
  99  */
 100 #define AE_BAD_SIGNATURE                (acpi_status) (0x0001 | AE_CODE_ACPI_TABLES)
 101 #define AE_BAD_HEADER                   (acpi_status) (0x0002 | AE_CODE_ACPI_TABLES)
 102 #define AE_BAD_CHECKSUM                 (acpi_status) (0x0003 | AE_CODE_ACPI_TABLES)
 103 #define AE_BAD_VALUE                    (acpi_status) (0x0004 | AE_CODE_ACPI_TABLES)
 104 #define AE_TABLE_NOT_SUPPORTED          (acpi_status) (0x0005 | AE_CODE_ACPI_TABLES)
 105 #define AE_INVALID_TABLE_LENGTH         (acpi_status) (0x0006 | AE_CODE_ACPI_TABLES)
 106
 107 #define AE_CODE_TBL_MAX                 0x0006
 108
 109
 110 /*
 111  * AML exceptions.  These are caused by problems with
 112  * the actual AML byte stream
 113  */
 114 #define AE_AML_ERROR                    (acpi_status) (0x0001 | AE_CODE_AML)
 115 #define AE_AML_PARSE                    (acpi_status) (0x0002 | AE_CODE_AML)
 116 #define AE_AML_BAD_OPCODE               (acpi_status) (0x0003 | AE_CODE_AML)
 117 #define AE_AML_NO_OPERAND               (acpi_status) (0x0004 | AE_CODE_AML)
 118 #define AE_AML_OPERAND_TYPE             (acpi_status) (0x0005 | AE_CODE_AML)
 119 #define AE_AML_OPERAND_VALUE            (acpi_status) (0x0006 | AE_CODE_AML)
 120 #define AE_AML_UNINITIALIZED_LOCAL      (acpi_status) (0x0007 | AE_CODE_AML)
 121 #define AE_AML_UNINITIALIZED_ARG        (acpi_status) (0x0008 | AE_CODE_AML)
 122 #define AE_AML_UNINITIALIZED_ELEMENT    (acpi_status) (0x0009 | AE_CODE_AML)
 123 #define AE_AML_NUMERIC_OVERFLOW         (acpi_status) (0x000A | AE_CODE_AML)
 124 #define AE_AML_REGION_LIMIT             (acpi_status) (0x000B | AE_CODE_AML)
 125 #define AE_AML_BUFFER_LIMIT             (acpi_status) (0x000C | AE_CODE_AML)
 126 #define AE_AML_PACKAGE_LIMIT            (acpi_status) (0x000D | AE_CODE_AML)
 127 #define AE_AML_DIVIDE_BY_ZERO           (acpi_status) (0x000E | AE_CODE_AML)
 128 #define AE_AML_BAD_NAME                 (acpi_status) (0x000F | AE_CODE_AML)
 129 #define AE_AML_NAME_NOT_FOUND           (acpi_status) (0x0010 | AE_CODE_AML)
 130 #define AE_AML_INTERNAL                 (acpi_status) (0x0011 | AE_CODE_AML)
 131 #define AE_AML_INVALID_SPACE_ID         (acpi_status) (0x0012 | AE_CODE_AML)
 132 #define AE_AML_STRING_LIMIT             (acpi_status) (0x0013 | AE_CODE_AML)
 133 #define AE_AML_NO_RETURN_VALUE          (acpi_status) (0x0014 | AE_CODE_AML)
 134 #define AE_AML_METHOD_LIMIT             (acpi_status) (0x0015 | AE_CODE_AML)
 135 #define AE_AML_NOT_OWNER                (acpi_status) (0x0016 | AE_CODE_AML)
 136 #define AE_AML_MUTEX_ORDER              (acpi_status) (0x0017 | AE_CODE_AML)
 137 #define AE_AML_MUTEX_NOT_ACQUIRED       (acpi_status) (0x0018 | AE_CODE_AML)
 138 #define AE_AML_INVALID_RESOURCE_TYPE    (acpi_status) (0x0019 | AE_CODE_AML)
 139 #define AE_AML_INVALID_INDEX            (acpi_status) (0x001A | AE_CODE_AML)
 140 #define AE_AML_REGISTER_LIMIT           (acpi_status) (0x001B | AE_CODE_AML)
 141 #define AE_AML_NO_WHILE                 (acpi_status) (0x001C | AE_CODE_AML)
 142 #define AE_AML_ALIGNMENT                (acpi_status) (0x001D | AE_CODE_AML)
 143 #define AE_AML_NO_RESOURCE_END_TAG      (acpi_status) (0x001E | AE_CODE_AML)
 144 #define AE_AML_BAD_RESOURCE_VALUE       (acpi_status) (0x001F | AE_CODE_AML)
 145 #define AE_AML_CIRCULAR_REFERENCE       (acpi_status) (0x0020 | AE_CODE_AML)
 146
 147 #define AE_CODE_AML_MAX                 0x0020
 148
 149 /*
 150  * Internal exceptions used for control
 151  */
 152 #define AE_CTRL_RETURN_VALUE            (acpi_status) (0x0001 | AE_CODE_CONTROL)
 153 #define AE_CTRL_PENDING                 (acpi_status) (0x0002 | AE_CODE_CONTROL)
 154 #define AE_CTRL_TERMINATE               (acpi_status) (0x0003 | AE_CODE_CONTROL)
 155 #define AE_CTRL_TRUE                    (acpi_status) (0x0004 | AE_CODE_CONTROL)
 156 #define AE_CTRL_FALSE                   (acpi_status) (0x0005 | AE_CODE_CONTROL)
 157 #define AE_CTRL_DEPTH                   (acpi_status) (0x0006 | AE_CODE_CONTROL)
 158 #define AE_CTRL_END                     (acpi_status) (0x0007 | AE_CODE_CONTROL)
 159 #define AE_CTRL_TRANSFER                (acpi_status) (0x0008 | AE_CODE_CONTROL)
 160 #define AE_CTRL_BREAK                   (acpi_status) (0x0009 | AE_CODE_CONTROL)
 161 #define AE_CTRL_CONTINUE                (acpi_status) (0x000A | AE_CODE_CONTROL)
 162 #define AE_CTRL_SKIP                    (acpi_status) (0x000B | AE_CODE_CONTROL)
 163
 164 #define AE_CODE_CTRL_MAX                0x000B
 165
 166
 167 #ifdef DEFINE_ACPI_GLOBALS
 168
 169 /*
 170  * String versions of the exception codes above
 171  * These strings must match the corresponding defines exactly
 172  */
 173 char const   *acpi_gbl_exception_names_env[] =
 174 {
 175         "AE_OK",
 176         "AE_ERROR",
 177         "AE_NO_ACPI_TABLES",
 178         "AE_NO_NAMESPACE",
 179         "AE_NO_MEMORY",
 180         "AE_NOT_FOUND",
 181         "AE_NOT_EXIST",
 182         "AE_ALREADY_EXISTS",
 183         "AE_TYPE",
 184         "AE_NULL_OBJECT",
 185         "AE_NULL_ENTRY",
 186         "AE_BUFFER_OVERFLOW",
 187         "AE_STACK_OVERFLOW",
 188         "AE_STACK_UNDERFLOW",
 189         "AE_NOT_IMPLEMENTED",
 190         "AE_VERSION_MISMATCH",
 191         "AE_SUPPORT",
 192         "AE_SHARE",
 193         "AE_LIMIT",
 194         "AE_TIME",
 195         "AE_UNKNOWN_STATUS",
 196         "AE_ACQUIRE_DEADLOCK",
 197         "AE_RELEASE_DEADLOCK",
 198         "AE_NOT_ACQUIRED",
 199         "AE_ALREADY_ACQUIRED",
 200         "AE_NO_HARDWARE_RESPONSE",
 201         "AE_NO_GLOBAL_LOCK",
 202         "AE_LOGICAL_ADDRESS",
 203         "AE_ABORT_METHOD"
 204 };
 205
 206 char const   *acpi_gbl_exception_names_pgm[] =
 207 {
 208         "AE_BAD_PARAMETER",
 209         "AE_BAD_CHARACTER",
 210         "AE_BAD_PATHNAME",
 211         "AE_BAD_DATA",
 212         "AE_BAD_ADDRESS",
 213         "AE_ALIGNMENT",
 214         "AE_BAD_HEX_CONSTANT",
 215         "AE_BAD_OCTAL_CONSTANT",
 216         "AE_BAD_DECIMAL_CONSTANT"
 217 };
 218
 219 char const   *acpi_gbl_exception_names_tbl[] =
 220 {
 221         "AE_BAD_SIGNATURE",
 222         "AE_BAD_HEADER",
 223         "AE_BAD_CHECKSUM",
 224         "AE_BAD_VALUE",
 225         "AE_TABLE_NOT_SUPPORTED",
 226         "AE_INVALID_TABLE_LENGTH"
 227 };
 228
 229 char const   *acpi_gbl_exception_names_aml[] =
 230 {
 231         "AE_AML_ERROR",
 232         "AE_AML_PARSE",
 233         "AE_AML_BAD_OPCODE",
 234         "AE_AML_NO_OPERAND",
 235         "AE_AML_OPERAND_TYPE",
 236         "AE_AML_OPERAND_VALUE",
 237         "AE_AML_UNINITIALIZED_LOCAL",
 238         "AE_AML_UNINITIALIZED_ARG",
 239         "AE_AML_UNINITIALIZED_ELEMENT",
 240         "AE_AML_NUMERIC_OVERFLOW",
 241         "AE_AML_REGION_LIMIT",
 242         "AE_AML_BUFFER_LIMIT",
 243         "AE_AML_PACKAGE_LIMIT",
 244         "AE_AML_DIVIDE_BY_ZERO",
 245         "AE_AML_BAD_NAME",
 246         "AE_AML_NAME_NOT_FOUND",
 247         "AE_AML_INTERNAL",
 248         "AE_AML_INVALID_SPACE_ID",
 249         "AE_AML_STRING_LIMIT",
 250         "AE_AML_NO_RETURN_VALUE",
 251         "AE_AML_METHOD_LIMIT",
 252         "AE_AML_NOT_OWNER",
 253         "AE_AML_MUTEX_ORDER",
 254         "AE_AML_MUTEX_NOT_ACQUIRED",
 255         "AE_AML_INVALID_RESOURCE_TYPE",
 256         "AE_AML_INVALID_INDEX",
 257         "AE_AML_REGISTER_LIMIT",
 258         "AE_AML_NO_WHILE",
 259         "AE_AML_ALIGNMENT",
 260         "AE_AML_NO_RESOURCE_END_TAG",
 261         "AE_AML_BAD_RESOURCE_VALUE",
 262         "AE_AML_CIRCULAR_REFERENCE"
 263 };
 264
 265 char const   *acpi_gbl_exception_names_ctrl[] =
 266 {
 267         "AE_CTRL_RETURN_VALUE",
 268         "AE_CTRL_PENDING",
 269         "AE_CTRL_TERMINATE",
 270         "AE_CTRL_TRUE",
 271         "AE_CTRL_FALSE",
 272         "AE_CTRL_DEPTH",
 273         "AE_CTRL_END",
 274         "AE_CTRL_TRANSFER",
 275         "AE_CTRL_BREAK",
 276         "AE_CTRL_CONTINUE",
 277         "AE_CTRL_SKIP"
 278 };
 279
 280 #endif /* ACPI GLOBALS */
 281
 282
 283 #endif /* __ACEXCEP_H__ */