[mirror_ubuntu-zesty-kernel.git] / include / acpi / acexcep.h

/******************************************************************************
 *
 * Name: acexcep.h - Exception codes returned by the ACPI subsystem
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2015, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACEXCEP_H__
#define __ACEXCEP_H__

/* This module contains all possible exception codes for acpi_status */

/*
 * Exception code classes
 */
#define AE_CODE_ENVIRONMENTAL           0x0000	/* General ACPICA environment */
#define AE_CODE_PROGRAMMER              0x1000	/* External ACPICA interface caller */
#define AE_CODE_ACPI_TABLES             0x2000	/* ACPI tables */
#define AE_CODE_AML                     0x3000	/* From executing AML code */
#define AE_CODE_CONTROL                 0x4000	/* Internal control codes */

#define AE_CODE_MAX                     0x4000
#define AE_CODE_MASK                    0xF000

/*
 * Macros to insert the exception code classes
 */
#define EXCEP_ENV(code)                 ((acpi_status) (code | AE_CODE_ENVIRONMENTAL))
#define EXCEP_PGM(code)                 ((acpi_status) (code | AE_CODE_PROGRAMMER))
#define EXCEP_TBL(code)                 ((acpi_status) (code | AE_CODE_ACPI_TABLES))
#define EXCEP_AML(code)                 ((acpi_status) (code | AE_CODE_AML))
#define EXCEP_CTL(code)                 ((acpi_status) (code | AE_CODE_CONTROL))

/*
 * Exception info table. The "Description" field is used only by the
 * ACPICA help application (acpihelp).
 */
struct acpi_exception_info {
	char *name;

#ifdef ACPI_HELP_APP
	char *description;
#endif
};

#ifdef ACPI_HELP_APP
#define EXCEP_TXT(name,description)     {name, description}
#else
#define EXCEP_TXT(name,description)     {name}
#endif

/*
 * Success is always zero, failure is non-zero
 */
#define ACPI_SUCCESS(a)                 (!(a))
#define ACPI_FAILURE(a)                 (a)

#define ACPI_SKIP(a)                    (a == AE_CTRL_SKIP)
#define AE_OK                           (acpi_status) 0x0000

/*
 * Environmental exceptions
 */
#define AE_ERROR                        EXCEP_ENV (0x0001)
#define AE_NO_ACPI_TABLES               EXCEP_ENV (0x0002)
#define AE_NO_NAMESPACE                 EXCEP_ENV (0x0003)
#define AE_NO_MEMORY                    EXCEP_ENV (0x0004)
#define AE_NOT_FOUND                    EXCEP_ENV (0x0005)
#define AE_NOT_EXIST                    EXCEP_ENV (0x0006)
#define AE_ALREADY_EXISTS               EXCEP_ENV (0x0007)
#define AE_TYPE                         EXCEP_ENV (0x0008)
#define AE_NULL_OBJECT                  EXCEP_ENV (0x0009)
#define AE_NULL_ENTRY                   EXCEP_ENV (0x000A)
#define AE_BUFFER_OVERFLOW              EXCEP_ENV (0x000B)
#define AE_STACK_OVERFLOW               EXCEP_ENV (0x000C)
#define AE_STACK_UNDERFLOW              EXCEP_ENV (0x000D)
#define AE_NOT_IMPLEMENTED              EXCEP_ENV (0x000E)
#define AE_SUPPORT                      EXCEP_ENV (0x000F)
#define AE_LIMIT                        EXCEP_ENV (0x0010)
#define AE_TIME                         EXCEP_ENV (0x0011)
#define AE_ACQUIRE_DEADLOCK             EXCEP_ENV (0x0012)
#define AE_RELEASE_DEADLOCK             EXCEP_ENV (0x0013)
#define AE_NOT_ACQUIRED                 EXCEP_ENV (0x0014)
#define AE_ALREADY_ACQUIRED             EXCEP_ENV (0x0015)
#define AE_NO_HARDWARE_RESPONSE         EXCEP_ENV (0x0016)
#define AE_NO_GLOBAL_LOCK               EXCEP_ENV (0x0017)
#define AE_ABORT_METHOD                 EXCEP_ENV (0x0018)
#define AE_SAME_HANDLER                 EXCEP_ENV (0x0019)
#define AE_NO_HANDLER                   EXCEP_ENV (0x001A)
#define AE_OWNER_ID_LIMIT               EXCEP_ENV (0x001B)
#define AE_NOT_CONFIGURED               EXCEP_ENV (0x001C)
#define AE_ACCESS                       EXCEP_ENV (0x001D)

#define AE_CODE_ENV_MAX                 0x001D

/*
 * Programmer exceptions
 */
#define AE_BAD_PARAMETER                EXCEP_PGM (0x0001)
#define AE_BAD_CHARACTER                EXCEP_PGM (0x0002)
#define AE_BAD_PATHNAME                 EXCEP_PGM (0x0003)
#define AE_BAD_DATA                     EXCEP_PGM (0x0004)
#define AE_BAD_HEX_CONSTANT             EXCEP_PGM (0x0005)
#define AE_BAD_OCTAL_CONSTANT           EXCEP_PGM (0x0006)
#define AE_BAD_DECIMAL_CONSTANT         EXCEP_PGM (0x0007)
#define AE_MISSING_ARGUMENTS            EXCEP_PGM (0x0008)
#define AE_BAD_ADDRESS                  EXCEP_PGM (0x0009)

#define AE_CODE_PGM_MAX                 0x0009

/*
 * Acpi table exceptions
 */
#define AE_BAD_SIGNATURE                EXCEP_TBL (0x0001)
#define AE_BAD_HEADER                   EXCEP_TBL (0x0002)
#define AE_BAD_CHECKSUM                 EXCEP_TBL (0x0003)
#define AE_BAD_VALUE                    EXCEP_TBL (0x0004)
#define AE_INVALID_TABLE_LENGTH         EXCEP_TBL (0x0005)

#define AE_CODE_TBL_MAX                 0x0005

/*
 * AML exceptions. These are caused by problems with
 * the actual AML byte stream
 */
#define AE_AML_BAD_OPCODE               EXCEP_AML (0x0001)
#define AE_AML_NO_OPERAND               EXCEP_AML (0x0002)
#define AE_AML_OPERAND_TYPE             EXCEP_AML (0x0003)
#define AE_AML_OPERAND_VALUE            EXCEP_AML (0x0004)
#define AE_AML_UNINITIALIZED_LOCAL      EXCEP_AML (0x0005)
#define AE_AML_UNINITIALIZED_ARG        EXCEP_AML (0x0006)
#define AE_AML_UNINITIALIZED_ELEMENT    EXCEP_AML (0x0007)
#define AE_AML_NUMERIC_OVERFLOW         EXCEP_AML (0x0008)
#define AE_AML_REGION_LIMIT             EXCEP_AML (0x0009)
#define AE_AML_BUFFER_LIMIT             EXCEP_AML (0x000A)
#define AE_AML_PACKAGE_LIMIT            EXCEP_AML (0x000B)
#define AE_AML_DIVIDE_BY_ZERO           EXCEP_AML (0x000C)
#define AE_AML_BAD_NAME                 EXCEP_AML (0x000D)
#define AE_AML_NAME_NOT_FOUND           EXCEP_AML (0x000E)
#define AE_AML_INTERNAL                 EXCEP_AML (0x000F)
#define AE_AML_INVALID_SPACE_ID         EXCEP_AML (0x0010)
#define AE_AML_STRING_LIMIT             EXCEP_AML (0x0011)
#define AE_AML_NO_RETURN_VALUE          EXCEP_AML (0x0012)
#define AE_AML_METHOD_LIMIT             EXCEP_AML (0x0013)
#define AE_AML_NOT_OWNER                EXCEP_AML (0x0014)
#define AE_AML_MUTEX_ORDER              EXCEP_AML (0x0015)
#define AE_AML_MUTEX_NOT_ACQUIRED       EXCEP_AML (0x0016)
#define AE_AML_INVALID_RESOURCE_TYPE    EXCEP_AML (0x0017)
#define AE_AML_INVALID_INDEX            EXCEP_AML (0x0018)
#define AE_AML_REGISTER_LIMIT           EXCEP_AML (0x0019)
#define AE_AML_NO_WHILE                 EXCEP_AML (0x001A)
#define AE_AML_ALIGNMENT                EXCEP_AML (0x001B)
#define AE_AML_NO_RESOURCE_END_TAG      EXCEP_AML (0x001C)
#define AE_AML_BAD_RESOURCE_VALUE       EXCEP_AML (0x001D)
#define AE_AML_CIRCULAR_REFERENCE       EXCEP_AML (0x001E)
#define AE_AML_BAD_RESOURCE_LENGTH      EXCEP_AML (0x001F)
#define AE_AML_ILLEGAL_ADDRESS          EXCEP_AML (0x0020)
#define AE_AML_INFINITE_LOOP            EXCEP_AML (0x0021)
#define AE_AML_UNINITIALIZED_NODE       EXCEP_AML (0x0022)

#define AE_CODE_AML_MAX                 0x0022

/*
 * Internal exceptions used for control
 */
#define AE_CTRL_RETURN_VALUE            EXCEP_CTL (0x0001)
#define AE_CTRL_PENDING                 EXCEP_CTL (0x0002)
#define AE_CTRL_TERMINATE               EXCEP_CTL (0x0003)
#define AE_CTRL_TRUE                    EXCEP_CTL (0x0004)
#define AE_CTRL_FALSE                   EXCEP_CTL (0x0005)
#define AE_CTRL_DEPTH                   EXCEP_CTL (0x0006)
#define AE_CTRL_END                     EXCEP_CTL (0x0007)
#define AE_CTRL_TRANSFER                EXCEP_CTL (0x0008)
#define AE_CTRL_BREAK                   EXCEP_CTL (0x0009)
#define AE_CTRL_CONTINUE                EXCEP_CTL (0x000A)
#define AE_CTRL_SKIP                    EXCEP_CTL (0x000B)
#define AE_CTRL_PARSE_CONTINUE          EXCEP_CTL (0x000C)
#define AE_CTRL_PARSE_PENDING           EXCEP_CTL (0x000D)

#define AE_CODE_CTRL_MAX                0x000D

/* Exception strings for acpi_format_exception */

#ifdef ACPI_DEFINE_EXCEPTION_TABLE

/*
 * String versions of the exception codes above
 * These strings must match the corresponding defines exactly
 */
static const struct acpi_exception_info acpi_gbl_exception_names_env[] = {
	EXCEP_TXT("AE_OK", "No error"),
	EXCEP_TXT("AE_ERROR", "Unspecified error"),
	EXCEP_TXT("AE_NO_ACPI_TABLES", "ACPI tables could not be found"),
	EXCEP_TXT("AE_NO_NAMESPACE", "A namespace has not been loaded"),
	EXCEP_TXT("AE_NO_MEMORY", "Insufficient dynamic memory"),
	EXCEP_TXT("AE_NOT_FOUND", "A requested entity is not found"),
	EXCEP_TXT("AE_NOT_EXIST", "A required entity does not exist"),
	EXCEP_TXT("AE_ALREADY_EXISTS", "An entity already exists"),
	EXCEP_TXT("AE_TYPE", "The object type is incorrect"),
	EXCEP_TXT("AE_NULL_OBJECT", "A required object was missing"),
	EXCEP_TXT("AE_NULL_ENTRY", "The requested object does not exist"),
	EXCEP_TXT("AE_BUFFER_OVERFLOW", "The buffer provided is too small"),
	EXCEP_TXT("AE_STACK_OVERFLOW", "An internal stack overflowed"),
	EXCEP_TXT("AE_STACK_UNDERFLOW", "An internal stack underflowed"),
	EXCEP_TXT("AE_NOT_IMPLEMENTED", "The feature is not implemented"),
	EXCEP_TXT("AE_SUPPORT", "The feature is not supported"),
	EXCEP_TXT("AE_LIMIT", "A predefined limit was exceeded"),
	EXCEP_TXT("AE_TIME", "A time limit or timeout expired"),
	EXCEP_TXT("AE_ACQUIRE_DEADLOCK",
		  "Internal error, attempt was made to acquire a mutex in improper order"),
	EXCEP_TXT("AE_RELEASE_DEADLOCK",
		  "Internal error, attempt was made to release a mutex in improper order"),
	EXCEP_TXT("AE_NOT_ACQUIRED",
		  "An attempt to release a mutex or Global Lock without a previous acquire"),
	EXCEP_TXT("AE_ALREADY_ACQUIRED",
		  "Internal error, attempt was made to acquire a mutex twice"),
	EXCEP_TXT("AE_NO_HARDWARE_RESPONSE",
		  "Hardware did not respond after an I/O operation"),
	EXCEP_TXT("AE_NO_GLOBAL_LOCK", "There is no FACS Global Lock"),
	EXCEP_TXT("AE_ABORT_METHOD", "A control method was aborted"),
	EXCEP_TXT("AE_SAME_HANDLER",
		  "Attempt was made to install the same handler that is already installed"),
	EXCEP_TXT("AE_NO_HANDLER",
		  "A handler for the operation is not installed"),
	EXCEP_TXT("AE_OWNER_ID_LIMIT",
		  "There are no more Owner IDs available for ACPI tables or control methods"),
	EXCEP_TXT("AE_NOT_CONFIGURED",
		  "The interface is not part of the current subsystem configuration"),
	EXCEP_TXT("AE_ACCESS", "Permission denied for the requested operation")
};

static const struct acpi_exception_info acpi_gbl_exception_names_pgm[] = {
	EXCEP_TXT(NULL, NULL),
	EXCEP_TXT("AE_BAD_PARAMETER", "A parameter is out of range or invalid"),
	EXCEP_TXT("AE_BAD_CHARACTER",
		  "An invalid character was found in a name"),
	EXCEP_TXT("AE_BAD_PATHNAME",
		  "An invalid character was found in a pathname"),
	EXCEP_TXT("AE_BAD_DATA",
		  "A package or buffer contained incorrect data"),
	EXCEP_TXT("AE_BAD_HEX_CONSTANT", "Invalid character in a Hex constant"),
	EXCEP_TXT("AE_BAD_OCTAL_CONSTANT",
		  "Invalid character in an Octal constant"),
	EXCEP_TXT("AE_BAD_DECIMAL_CONSTANT",
		  "Invalid character in a Decimal constant"),
	EXCEP_TXT("AE_MISSING_ARGUMENTS",
		  "Too few arguments were passed to a control method"),
	EXCEP_TXT("AE_BAD_ADDRESS", "An illegal null I/O address")
};

static const struct acpi_exception_info acpi_gbl_exception_names_tbl[] = {
	EXCEP_TXT(NULL, NULL),
	EXCEP_TXT("AE_BAD_SIGNATURE", "An ACPI table has an invalid signature"),
	EXCEP_TXT("AE_BAD_HEADER", "Invalid field in an ACPI table header"),
	EXCEP_TXT("AE_BAD_CHECKSUM", "An ACPI table checksum is not correct"),
	EXCEP_TXT("AE_BAD_VALUE", "An invalid value was found in a table"),
	EXCEP_TXT("AE_INVALID_TABLE_LENGTH",
		  "The FADT or FACS has improper length")
};

static const struct acpi_exception_info acpi_gbl_exception_names_aml[] = {
	EXCEP_TXT(NULL, NULL),
	EXCEP_TXT("AE_AML_BAD_OPCODE", "Invalid AML opcode encountered"),
	EXCEP_TXT("AE_AML_NO_OPERAND", "A required operand is missing"),
	EXCEP_TXT("AE_AML_OPERAND_TYPE",
		  "An operand of an incorrect type was encountered"),
	EXCEP_TXT("AE_AML_OPERAND_VALUE",
		  "The operand had an inappropriate or invalid value"),
	EXCEP_TXT("AE_AML_UNINITIALIZED_LOCAL",
		  "Method tried to use an uninitialized local variable"),
	EXCEP_TXT("AE_AML_UNINITIALIZED_ARG",
		  "Method tried to use an uninitialized argument"),
	EXCEP_TXT("AE_AML_UNINITIALIZED_ELEMENT",
		  "Method tried to use an empty package element"),
	EXCEP_TXT("AE_AML_NUMERIC_OVERFLOW",
		  "Overflow during BCD conversion or other"),
	EXCEP_TXT("AE_AML_REGION_LIMIT",
		  "Tried to access beyond the end of an Operation Region"),
	EXCEP_TXT("AE_AML_BUFFER_LIMIT",
		  "Tried to access beyond the end of a buffer"),
	EXCEP_TXT("AE_AML_PACKAGE_LIMIT",
		  "Tried to access beyond the end of a package"),
	EXCEP_TXT("AE_AML_DIVIDE_BY_ZERO",
		  "During execution of AML Divide operator"),
	EXCEP_TXT("AE_AML_BAD_NAME",
		  "An ACPI name contains invalid character(s)"),
	EXCEP_TXT("AE_AML_NAME_NOT_FOUND",
		  "Could not resolve a named reference"),
	EXCEP_TXT("AE_AML_INTERNAL", "An internal error within the interprete"),
	EXCEP_TXT("AE_AML_INVALID_SPACE_ID",
		  "An Operation Region SpaceID is invalid"),
	EXCEP_TXT("AE_AML_STRING_LIMIT",
		  "String is longer than 200 characters"),
	EXCEP_TXT("AE_AML_NO_RETURN_VALUE",
		  "A method did not return a required value"),
	EXCEP_TXT("AE_AML_METHOD_LIMIT",
		  "A control method reached the maximum reentrancy limit of 255"),
	EXCEP_TXT("AE_AML_NOT_OWNER",
		  "A thread tried to release a mutex that it does not own"),
	EXCEP_TXT("AE_AML_MUTEX_ORDER", "Mutex SyncLevel release mismatch"),
	EXCEP_TXT("AE_AML_MUTEX_NOT_ACQUIRED",
		  "Attempt to release a mutex that was not previously acquired"),
	EXCEP_TXT("AE_AML_INVALID_RESOURCE_TYPE",
		  "Invalid resource type in resource list"),
	EXCEP_TXT("AE_AML_INVALID_INDEX",
		  "Invalid Argx or Localx (x too large)"),
	EXCEP_TXT("AE_AML_REGISTER_LIMIT",
		  "Bank value or Index value beyond range of register"),
	EXCEP_TXT("AE_AML_NO_WHILE", "Break or Continue without a While"),
	EXCEP_TXT("AE_AML_ALIGNMENT",
		  "Non-aligned memory transfer on platform that does not support this"),
	EXCEP_TXT("AE_AML_NO_RESOURCE_END_TAG",
		  "No End Tag in a resource list"),
	EXCEP_TXT("AE_AML_BAD_RESOURCE_VALUE",
		  "Invalid value of a resource element"),
	EXCEP_TXT("AE_AML_CIRCULAR_REFERENCE",
		  "Two references refer to each other"),
	EXCEP_TXT("AE_AML_BAD_RESOURCE_LENGTH",
		  "The length of a Resource Descriptor in the AML is incorrect"),
	EXCEP_TXT("AE_AML_ILLEGAL_ADDRESS",
		  "A memory, I/O, or PCI configuration address is invalid"),
	EXCEP_TXT("AE_AML_INFINITE_LOOP",
		  "An apparent infinite AML While loop, method was aborted"),
	EXCEP_TXT("AE_AML_UNINITIALIZED_NODE",
		  "A namespace node is uninitialized or unresolved")
};

static const struct acpi_exception_info acpi_gbl_exception_names_ctrl[] = {
	EXCEP_TXT(NULL, NULL),
	EXCEP_TXT("AE_CTRL_RETURN_VALUE", "A Method returned a value"),
	EXCEP_TXT("AE_CTRL_PENDING", "Method is calling another method"),
	EXCEP_TXT("AE_CTRL_TERMINATE", "Terminate the executing method"),
	EXCEP_TXT("AE_CTRL_TRUE", "An If or While predicate result"),
	EXCEP_TXT("AE_CTRL_FALSE", "An If or While predicate result"),
	EXCEP_TXT("AE_CTRL_DEPTH", "Maximum search depth has been reached"),
	EXCEP_TXT("AE_CTRL_END", "An If or While predicate is false"),
	EXCEP_TXT("AE_CTRL_TRANSFER", "Transfer control to called method"),
	EXCEP_TXT("AE_CTRL_BREAK", "A Break has been executed"),
	EXCEP_TXT("AE_CTRL_CONTINUE", "A Continue has been executed"),
	EXCEP_TXT("AE_CTRL_SKIP", "Not currently used"),
	EXCEP_TXT("AE_CTRL_PARSE_CONTINUE", "Used to skip over bad opcodes"),
	EXCEP_TXT("AE_CTRL_PARSE_PENDING", "Used to implement AML While loops")
};

#endif				/* EXCEPTION_TABLE */

#endif				/* __ACEXCEP_H__ */
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acexcep.h - Exception codes returned by the ACPI subsystem
	4	*
	5	*****************************************************************************/
	6
	7	/*
82a80941	8	* Copyright (C) 2000 - 2015, Intel Corp.
1da177e4 LT	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
995b9a9d BM	47	/* This module contains all possible exception codes for acpi_status */
995b9a9d BM	48
1da177e4	49	/*
995b9a9d	50	* Exception code classes
1da177e4	51	*/
ae1b4769 BM	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
bc7db145	58	#define AE_CODE_MAX 0x4000
1da177e4 LT	59	#define AE_CODE_MASK 0xF000
1da177e4 LT	60
995b9a9d BM	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
ae1b4769 BM	70	/*
	71	* Exception info table. The "Description" field is used only by the
	72	* ACPICA help application (acpihelp).
	73	*/
	74	struct 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
995b9a9d BM	88	/*
	89	* Success is always zero, failure is non-zero
	90	*/
1da177e4 LT	91	#define ACPI_SUCCESS(a) (!(a))
	92	#define ACPI_FAILURE(a) (a)
	93
09f98a82	94	#define ACPI_SKIP(a) (a == AE_CTRL_SKIP)
1da177e4 LT	95	#define AE_OK (acpi_status) 0x0000
	96
	97	/*
	98	* Environmental exceptions
	99	*/
995b9a9d BM	100	#define AE_ERROR EXCEP_ENV (0x0001)
	101	#define AE_NO_ACPI_TABLES EXCEP_ENV (0x0002)
	102	#define AE_NO_NAMESPACE EXCEP_ENV (0x0003)
	103	#define AE_NO_MEMORY EXCEP_ENV (0x0004)
	104	#define AE_NOT_FOUND EXCEP_ENV (0x0005)
	105	#define AE_NOT_EXIST EXCEP_ENV (0x0006)
	106	#define AE_ALREADY_EXISTS EXCEP_ENV (0x0007)
	107	#define AE_TYPE EXCEP_ENV (0x0008)
	108	#define AE_NULL_OBJECT EXCEP_ENV (0x0009)
	109	#define AE_NULL_ENTRY EXCEP_ENV (0x000A)
	110	#define AE_BUFFER_OVERFLOW EXCEP_ENV (0x000B)
	111	#define AE_STACK_OVERFLOW EXCEP_ENV (0x000C)
	112	#define AE_STACK_UNDERFLOW EXCEP_ENV (0x000D)
	113	#define AE_NOT_IMPLEMENTED EXCEP_ENV (0x000E)
	114	#define AE_SUPPORT EXCEP_ENV (0x000F)
	115	#define AE_LIMIT EXCEP_ENV (0x0010)
	116	#define AE_TIME EXCEP_ENV (0x0011)
	117	#define AE_ACQUIRE_DEADLOCK EXCEP_ENV (0x0012)
	118	#define AE_RELEASE_DEADLOCK EXCEP_ENV (0x0013)
	119	#define AE_NOT_ACQUIRED EXCEP_ENV (0x0014)
	120	#define AE_ALREADY_ACQUIRED EXCEP_ENV (0x0015)
	121	#define AE_NO_HARDWARE_RESPONSE EXCEP_ENV (0x0016)
	122	#define AE_NO_GLOBAL_LOCK EXCEP_ENV (0x0017)
	123	#define AE_ABORT_METHOD EXCEP_ENV (0x0018)
	124	#define AE_SAME_HANDLER EXCEP_ENV (0x0019)
	125	#define AE_NO_HANDLER EXCEP_ENV (0x001A)
	126	#define AE_OWNER_ID_LIMIT EXCEP_ENV (0x001B)
	127	#define AE_NOT_CONFIGURED EXCEP_ENV (0x001C)
31e93a16	128	#define AE_ACCESS EXCEP_ENV (0x001D)
1da177e4	129
31e93a16	130	#define AE_CODE_ENV_MAX 0x001D
1da177e4 LT	131
	132	/*
	133	* Programmer exceptions
	134	*/
995b9a9d BM	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)
1da177e4	144
ac0c8450	145	#define AE_CODE_PGM_MAX 0x0009
1da177e4	146
1da177e4 LT	147	/*
	148	* Acpi table exceptions
	149	*/
995b9a9d BM	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)
1da177e4	155
65f4692c	156	#define AE_CODE_TBL_MAX 0x0005
1da177e4	157
1da177e4	158	/*
73a3090a	159	* AML exceptions. These are caused by problems with
1da177e4 LT	160	* the actual AML byte stream
1da177e4 LT	161	*/
995b9a9d BM	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)
4712f71b	195	#define AE_AML_UNINITIALIZED_NODE EXCEP_AML (0x0022)
1da177e4	196
4712f71b	197	#define AE_CODE_AML_MAX 0x0022
1da177e4 LT	198
	199	/*
	200	* Internal exceptions used for control
	201	*/
995b9a9d BM	202	#define AE_CTRL_RETURN_VALUE EXCEP_CTL (0x0001)
	203	#define AE_CTRL_PENDING EXCEP_CTL (0x0002)
	204	#define AE_CTRL_TERMINATE EXCEP_CTL (0x0003)
	205	#define AE_CTRL_TRUE EXCEP_CTL (0x0004)
	206	#define AE_CTRL_FALSE EXCEP_CTL (0x0005)
	207	#define AE_CTRL_DEPTH EXCEP_CTL (0x0006)
	208	#define AE_CTRL_END EXCEP_CTL (0x0007)
	209	#define AE_CTRL_TRANSFER EXCEP_CTL (0x0008)
	210	#define AE_CTRL_BREAK EXCEP_CTL (0x0009)
	211	#define AE_CTRL_CONTINUE EXCEP_CTL (0x000A)
	212	#define AE_CTRL_SKIP EXCEP_CTL (0x000B)
	213	#define AE_CTRL_PARSE_CONTINUE EXCEP_CTL (0x000C)
	214	#define AE_CTRL_PARSE_PENDING EXCEP_CTL (0x000D)
1da177e4	215
4d0b4af9	216	#define AE_CODE_CTRL_MAX 0x000D
1da177e4	217
50df4d8b BM	218	/* Exception strings for acpi_format_exception */
50df4d8b BM	219
bc7db145	220	#ifdef ACPI_DEFINE_EXCEPTION_TABLE
1da177e4 LT	221
	222	/*
	223	* String versions of the exception codes above
	224	* These strings must match the corresponding defines exactly
	225	*/
ae1b4769 BM	226	static 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"),
31e93a16	232	EXCEP_TXT("AE_NOT_FOUND", "A requested entity is not found"),
ae1b4769 BM	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",
31e93a16 LZ	264	"The interface is not part of the current subsystem configuration"),
31e93a16 LZ	265	EXCEP_TXT("AE_ACCESS", "Permission denied for the requested operation")
1da177e4 LT	266	};
1da177e4 LT	267
ae1b4769 BM	268	static const struct acpi_exception_info acpi_gbl_exception_names_pgm[] = {
	269	EXCEP_TXT(NULL, NULL),
	270	EXCEP_TXT("AE_BAD_PARAMETER", "A parameter is out of range or invalid"),
	271	EXCEP_TXT("AE_BAD_CHARACTER",
	272	"An invalid character was found in a name"),
	273	EXCEP_TXT("AE_BAD_PATHNAME",
	274	"An invalid character was found in a pathname"),
	275	EXCEP_TXT("AE_BAD_DATA",
	276	"A package or buffer contained incorrect data"),
	277	EXCEP_TXT("AE_BAD_HEX_CONSTANT", "Invalid character in a Hex constant"),
	278	EXCEP_TXT("AE_BAD_OCTAL_CONSTANT",
	279	"Invalid character in an Octal constant"),
	280	EXCEP_TXT("AE_BAD_DECIMAL_CONSTANT",
	281	"Invalid character in a Decimal constant"),
	282	EXCEP_TXT("AE_MISSING_ARGUMENTS",
	283	"Too few arguments were passed to a control method"),
	284	EXCEP_TXT("AE_BAD_ADDRESS", "An illegal null I/O address")
1da177e4 LT	285	};
1da177e4 LT	286
ae1b4769 BM	287	static const struct acpi_exception_info acpi_gbl_exception_names_tbl[] = {
	288	EXCEP_TXT(NULL, NULL),
	289	EXCEP_TXT("AE_BAD_SIGNATURE", "An ACPI table has an invalid signature"),
	290	EXCEP_TXT("AE_BAD_HEADER", "Invalid field in an ACPI table header"),
	291	EXCEP_TXT("AE_BAD_CHECKSUM", "An ACPI table checksum is not correct"),
	292	EXCEP_TXT("AE_BAD_VALUE", "An invalid value was found in a table"),
	293	EXCEP_TXT("AE_INVALID_TABLE_LENGTH",
	294	"The FADT or FACS has improper length")
1da177e4 LT	295	};
1da177e4 LT	296
ae1b4769 BM	297	static const struct acpi_exception_info acpi_gbl_exception_names_aml[] = {
	298	EXCEP_TXT(NULL, NULL),
	299	EXCEP_TXT("AE_AML_BAD_OPCODE", "Invalid AML opcode encountered"),
	300	EXCEP_TXT("AE_AML_NO_OPERAND", "A required operand is missing"),
	301	EXCEP_TXT("AE_AML_OPERAND_TYPE",
	302	"An operand of an incorrect type was encountered"),
	303	EXCEP_TXT("AE_AML_OPERAND_VALUE",
	304	"The operand had an inappropriate or invalid value"),
	305	EXCEP_TXT("AE_AML_UNINITIALIZED_LOCAL",
	306	"Method tried to use an uninitialized local variable"),
	307	EXCEP_TXT("AE_AML_UNINITIALIZED_ARG",
	308	"Method tried to use an uninitialized argument"),
	309	EXCEP_TXT("AE_AML_UNINITIALIZED_ELEMENT",
	310	"Method tried to use an empty package element"),
	311	EXCEP_TXT("AE_AML_NUMERIC_OVERFLOW",
	312	"Overflow during BCD conversion or other"),
	313	EXCEP_TXT("AE_AML_REGION_LIMIT",
	314	"Tried to access beyond the end of an Operation Region"),
	315	EXCEP_TXT("AE_AML_BUFFER_LIMIT",
	316	"Tried to access beyond the end of a buffer"),
	317	EXCEP_TXT("AE_AML_PACKAGE_LIMIT",
	318	"Tried to access beyond the end of a package"),
	319	EXCEP_TXT("AE_AML_DIVIDE_BY_ZERO",
	320	"During execution of AML Divide operator"),
	321	EXCEP_TXT("AE_AML_BAD_NAME",
	322	"An ACPI name contains invalid character(s)"),
	323	EXCEP_TXT("AE_AML_NAME_NOT_FOUND",
	324	"Could not resolve a named reference"),
	325	EXCEP_TXT("AE_AML_INTERNAL", "An internal error within the interprete"),
	326	EXCEP_TXT("AE_AML_INVALID_SPACE_ID",
	327	"An Operation Region SpaceID is invalid"),
	328	EXCEP_TXT("AE_AML_STRING_LIMIT",
	329	"String is longer than 200 characters"),
	330	EXCEP_TXT("AE_AML_NO_RETURN_VALUE",
	331	"A method did not return a required value"),
	332	EXCEP_TXT("AE_AML_METHOD_LIMIT",
	333	"A control method reached the maximum reentrancy limit of 255"),
	334	EXCEP_TXT("AE_AML_NOT_OWNER",
	335	"A thread tried to release a mutex that it does not own"),
	336	EXCEP_TXT("AE_AML_MUTEX_ORDER", "Mutex SyncLevel release mismatch"),
	337	EXCEP_TXT("AE_AML_MUTEX_NOT_ACQUIRED",
	338	"Attempt to release a mutex that was not previously acquired"),
	339	EXCEP_TXT("AE_AML_INVALID_RESOURCE_TYPE",
	340	"Invalid resource type in resource list"),
	341	EXCEP_TXT("AE_AML_INVALID_INDEX",
	342	"Invalid Argx or Localx (x too large)"),
	343	EXCEP_TXT("AE_AML_REGISTER_LIMIT",
	344	"Bank value or Index value beyond range of register"),
	345	EXCEP_TXT("AE_AML_NO_WHILE", "Break or Continue without a While"),
	346	EXCEP_TXT("AE_AML_ALIGNMENT",
	347	"Non-aligned memory transfer on platform that does not support this"),
	348	EXCEP_TXT("AE_AML_NO_RESOURCE_END_TAG",
	349	"No End Tag in a resource list"),
	350	EXCEP_TXT("AE_AML_BAD_RESOURCE_VALUE",
	351	"Invalid value of a resource element"),
	352	EXCEP_TXT("AE_AML_CIRCULAR_REFERENCE",
	353	"Two references refer to each other"),
	354	EXCEP_TXT("AE_AML_BAD_RESOURCE_LENGTH",
	355	"The length of a Resource Descriptor in the AML is incorrect"),
	356	EXCEP_TXT("AE_AML_ILLEGAL_ADDRESS",
	357	"A memory, I/O, or PCI configuration address is invalid"),
	358	EXCEP_TXT("AE_AML_INFINITE_LOOP",
4712f71b BM	359	"An apparent infinite AML While loop, method was aborted"),
	360	EXCEP_TXT("AE_AML_UNINITIALIZED_NODE",
	361	"A namespace node is uninitialized or unresolved")
1da177e4 LT	362	};
1da177e4 LT	363
ae1b4769 BM	364	static const struct acpi_exception_info acpi_gbl_exception_names_ctrl[] = {
	365	EXCEP_TXT(NULL, NULL),
	366	EXCEP_TXT("AE_CTRL_RETURN_VALUE", "A Method returned a value"),
	367	EXCEP_TXT("AE_CTRL_PENDING", "Method is calling another method"),
	368	EXCEP_TXT("AE_CTRL_TERMINATE", "Terminate the executing method"),
	369	EXCEP_TXT("AE_CTRL_TRUE", "An If or While predicate result"),
	370	EXCEP_TXT("AE_CTRL_FALSE", "An If or While predicate result"),
	371	EXCEP_TXT("AE_CTRL_DEPTH", "Maximum search depth has been reached"),
	372	EXCEP_TXT("AE_CTRL_END", "An If or While predicate is false"),
	373	EXCEP_TXT("AE_CTRL_TRANSFER", "Transfer control to called method"),
	374	EXCEP_TXT("AE_CTRL_BREAK", "A Break has been executed"),
	375	EXCEP_TXT("AE_CTRL_CONTINUE", "A Continue has been executed"),
	376	EXCEP_TXT("AE_CTRL_SKIP", "Not currently used"),
	377	EXCEP_TXT("AE_CTRL_PARSE_CONTINUE", "Used to skip over bad opcodes"),
	378	EXCEP_TXT("AE_CTRL_PARSE_PENDING", "Used to implement AML While loops")
1da177e4 LT	379	};
1da177e4 LT	380
bc7db145	381	#endif /* EXCEPTION_TABLE */
1da177e4	382
4be44fcd	383	#endif /* __ACEXCEP_H__ */