[deliverable/linux.git] / drivers / acpi / acpica / utexcep.c

/*******************************************************************************
 *
 * Module Name: utexcep - Exception code support
 *
 ******************************************************************************/

/*
 * Copyright (C) 2000 - 2016, 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.
 */

#define EXPORT_ACPI_INTERFACES

#define ACPI_DEFINE_EXCEPTION_TABLE
#include <acpi/acpi.h>
#include "accommon.h"

#define _COMPONENT          ACPI_UTILITIES
ACPI_MODULE_NAME("utexcep")

/*******************************************************************************
 *
 * FUNCTION:    acpi_format_exception
 *
 * PARAMETERS:  status              - The acpi_status code to be formatted
 *
 * RETURN:      A string containing the exception text. A valid pointer is
 *              always returned.
 *
 * DESCRIPTION: This function translates an ACPI exception into an ASCII
 *              string. Returns "unknown status" string for invalid codes.
 *
 ******************************************************************************/
const char *acpi_format_exception(acpi_status status)
{
	const struct acpi_exception_info *exception;

	ACPI_FUNCTION_ENTRY();

	exception = acpi_ut_validate_exception(status);
	if (!exception) {

		/* Exception code was not recognized */

		ACPI_ERROR((AE_INFO,
			    "Unknown exception code: 0x%8.8X", status));

		return ("UNKNOWN_STATUS_CODE");
	}

	return (exception->name);
}

ACPI_EXPORT_SYMBOL(acpi_format_exception)

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_validate_exception
 *
 * PARAMETERS:  status              - The acpi_status code to be formatted
 *
 * RETURN:      A string containing the exception text. NULL if exception is
 *              not valid.
 *
 * DESCRIPTION: This function validates and translates an ACPI exception into
 *              an ASCII string.
 *
 ******************************************************************************/
const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status status)
{
	u32 sub_status;
	const struct acpi_exception_info *exception = NULL;

	ACPI_FUNCTION_ENTRY();

	/*
	 * Status is composed of two parts, a "type" and an actual code
	 */
	sub_status = (status & ~AE_CODE_MASK);

	switch (status & AE_CODE_MASK) {
	case AE_CODE_ENVIRONMENTAL:

		if (sub_status <= AE_CODE_ENV_MAX) {
			exception = &acpi_gbl_exception_names_env[sub_status];
		}
		break;

	case AE_CODE_PROGRAMMER:

		if (sub_status <= AE_CODE_PGM_MAX) {
			exception = &acpi_gbl_exception_names_pgm[sub_status];
		}
		break;

	case AE_CODE_ACPI_TABLES:

		if (sub_status <= AE_CODE_TBL_MAX) {
			exception = &acpi_gbl_exception_names_tbl[sub_status];
		}
		break;

	case AE_CODE_AML:

		if (sub_status <= AE_CODE_AML_MAX) {
			exception = &acpi_gbl_exception_names_aml[sub_status];
		}
		break;

	case AE_CODE_CONTROL:

		if (sub_status <= AE_CODE_CTRL_MAX) {
			exception = &acpi_gbl_exception_names_ctrl[sub_status];
		}
		break;

	default:

		break;
	}

	if (!exception || !exception->name) {
		return (NULL);
	}

	return (exception);
}
Commit	Line	Data
bc7db145 BM	1	/*******************************************************************************
	2	*
	3	* Module Name: utexcep - Exception code support
	4	*
	5	******************************************************************************/
	6
	7	/*
c8100dc4	8	* Copyright (C) 2000 - 2016, Intel Corp.
bc7db145 BM	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
839e928f LZ	44	#define EXPORT_ACPI_INTERFACES
839e928f LZ	45
bc7db145	46	#define ACPI_DEFINE_EXCEPTION_TABLE
bc7db145 BM	47	#include <acpi/acpi.h>
	48	#include "accommon.h"
	49
	50	#define _COMPONENT ACPI_UTILITIES
	51	ACPI_MODULE_NAME("utexcep")
	52
	53	/*******************************************************************************
	54	*
	55	* FUNCTION: acpi_format_exception
	56	*
	57	* PARAMETERS: status - The acpi_status code to be formatted
	58	*
	59	* RETURN: A string containing the exception text. A valid pointer is
	60	* always returned.
	61	*
	62	* DESCRIPTION: This function translates an ACPI exception into an ASCII
	63	* string. Returns "unknown status" string for invalid codes.
	64	*
	65	******************************************************************************/
	66	const char *acpi_format_exception(acpi_status status)
	67	{
ae1b4769	68	const struct acpi_exception_info *exception;
bc7db145 BM	69
	70	ACPI_FUNCTION_ENTRY();
	71
	72	exception = acpi_ut_validate_exception(status);
	73	if (!exception) {
	74
	75	/* Exception code was not recognized */
	76
	77	ACPI_ERROR((AE_INFO,
	78	"Unknown exception code: 0x%8.8X", status));
	79
ae1b4769	80	return ("UNKNOWN_STATUS_CODE");
bc7db145 BM	81	}
bc7db145 BM	82
ae1b4769	83	return (exception->name);
bc7db145 BM	84	}
	85
	86	ACPI_EXPORT_SYMBOL(acpi_format_exception)
	87
	88	/*******************************************************************************
	89	*
	90	* FUNCTION: acpi_ut_validate_exception
	91	*
	92	* PARAMETERS: status - The acpi_status code to be formatted
	93	*
	94	* RETURN: A string containing the exception text. NULL if exception is
	95	* not valid.
	96	*
	97	* DESCRIPTION: This function validates and translates an ACPI exception into
	98	* an ASCII string.
	99	*
	100	******************************************************************************/
ae1b4769	101	const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status status)
bc7db145 BM	102	{
bc7db145 BM	103	u32 sub_status;
ae1b4769	104	const struct acpi_exception_info *exception = NULL;
bc7db145 BM	105
	106	ACPI_FUNCTION_ENTRY();
	107
	108	/*
	109	* Status is composed of two parts, a "type" and an actual code
	110	*/
	111	sub_status = (status & ~AE_CODE_MASK);
	112
	113	switch (status & AE_CODE_MASK) {
	114	case AE_CODE_ENVIRONMENTAL:
	115
	116	if (sub_status <= AE_CODE_ENV_MAX) {
ae1b4769	117	exception = &acpi_gbl_exception_names_env[sub_status];
bc7db145 BM	118	}
	119	break;
	120
	121	case AE_CODE_PROGRAMMER:
	122
	123	if (sub_status <= AE_CODE_PGM_MAX) {
ae1b4769	124	exception = &acpi_gbl_exception_names_pgm[sub_status];
bc7db145 BM	125	}
	126	break;
	127
	128	case AE_CODE_ACPI_TABLES:
	129
	130	if (sub_status <= AE_CODE_TBL_MAX) {
ae1b4769	131	exception = &acpi_gbl_exception_names_tbl[sub_status];
bc7db145 BM	132	}
	133	break;
	134
	135	case AE_CODE_AML:
	136
	137	if (sub_status <= AE_CODE_AML_MAX) {
ae1b4769	138	exception = &acpi_gbl_exception_names_aml[sub_status];
bc7db145 BM	139	}
	140	break;
	141
	142	case AE_CODE_CONTROL:
	143
	144	if (sub_status <= AE_CODE_CTRL_MAX) {
ae1b4769	145	exception = &acpi_gbl_exception_names_ctrl[sub_status];
bc7db145 BM	146	}
	147	break;
	148
	149	default:
1d1ea1b7	150
bc7db145 BM	151	break;
	152	}
	153
ae1b4769 BM	154	if (!exception \|\| !exception->name) {
	155	return (NULL);
	156	}
	157
	158	return (exception);
bc7db145	159	}