1*29492bb7SDavid van Moolenbroek /*******************************************************************************
2*29492bb7SDavid van Moolenbroek *
3*29492bb7SDavid van Moolenbroek * Module Name: utexcep - Exception code support
4*29492bb7SDavid van Moolenbroek *
5*29492bb7SDavid van Moolenbroek ******************************************************************************/
6*29492bb7SDavid van Moolenbroek
7*29492bb7SDavid van Moolenbroek /*
8*29492bb7SDavid van Moolenbroek * Copyright (C) 2000 - 2014, Intel Corp.
9*29492bb7SDavid van Moolenbroek * All rights reserved.
10*29492bb7SDavid van Moolenbroek *
11*29492bb7SDavid van Moolenbroek * Redistribution and use in source and binary forms, with or without
12*29492bb7SDavid van Moolenbroek * modification, are permitted provided that the following conditions
13*29492bb7SDavid van Moolenbroek * are met:
14*29492bb7SDavid van Moolenbroek * 1. Redistributions of source code must retain the above copyright
15*29492bb7SDavid van Moolenbroek * notice, this list of conditions, and the following disclaimer,
16*29492bb7SDavid van Moolenbroek * without modification.
17*29492bb7SDavid van Moolenbroek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18*29492bb7SDavid van Moolenbroek * substantially similar to the "NO WARRANTY" disclaimer below
19*29492bb7SDavid van Moolenbroek * ("Disclaimer") and any redistribution must be conditioned upon
20*29492bb7SDavid van Moolenbroek * including a substantially similar Disclaimer requirement for further
21*29492bb7SDavid van Moolenbroek * binary redistribution.
22*29492bb7SDavid van Moolenbroek * 3. Neither the names of the above-listed copyright holders nor the names
23*29492bb7SDavid van Moolenbroek * of any contributors may be used to endorse or promote products derived
24*29492bb7SDavid van Moolenbroek * from this software without specific prior written permission.
25*29492bb7SDavid van Moolenbroek *
26*29492bb7SDavid van Moolenbroek * Alternatively, this software may be distributed under the terms of the
27*29492bb7SDavid van Moolenbroek * GNU General Public License ("GPL") version 2 as published by the Free
28*29492bb7SDavid van Moolenbroek * Software Foundation.
29*29492bb7SDavid van Moolenbroek *
30*29492bb7SDavid van Moolenbroek * NO WARRANTY
31*29492bb7SDavid van Moolenbroek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32*29492bb7SDavid van Moolenbroek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33*29492bb7SDavid van Moolenbroek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34*29492bb7SDavid van Moolenbroek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35*29492bb7SDavid van Moolenbroek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36*29492bb7SDavid van Moolenbroek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37*29492bb7SDavid van Moolenbroek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38*29492bb7SDavid van Moolenbroek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39*29492bb7SDavid van Moolenbroek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40*29492bb7SDavid van Moolenbroek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41*29492bb7SDavid van Moolenbroek * POSSIBILITY OF SUCH DAMAGES.
42*29492bb7SDavid van Moolenbroek */
43*29492bb7SDavid van Moolenbroek
44*29492bb7SDavid van Moolenbroek #define EXPORT_ACPI_INTERFACES
45*29492bb7SDavid van Moolenbroek
46*29492bb7SDavid van Moolenbroek #define ACPI_DEFINE_EXCEPTION_TABLE
47*29492bb7SDavid van Moolenbroek #include "acpi.h"
48*29492bb7SDavid van Moolenbroek #include "accommon.h"
49*29492bb7SDavid van Moolenbroek
50*29492bb7SDavid van Moolenbroek
51*29492bb7SDavid van Moolenbroek #define _COMPONENT ACPI_UTILITIES
52*29492bb7SDavid van Moolenbroek ACPI_MODULE_NAME ("utexcep")
53*29492bb7SDavid van Moolenbroek
54*29492bb7SDavid van Moolenbroek
55*29492bb7SDavid van Moolenbroek /*******************************************************************************
56*29492bb7SDavid van Moolenbroek *
57*29492bb7SDavid van Moolenbroek * FUNCTION: AcpiFormatException
58*29492bb7SDavid van Moolenbroek *
59*29492bb7SDavid van Moolenbroek * PARAMETERS: Status - The ACPI_STATUS code to be formatted
60*29492bb7SDavid van Moolenbroek *
61*29492bb7SDavid van Moolenbroek * RETURN: A string containing the exception text. A valid pointer is
62*29492bb7SDavid van Moolenbroek * always returned.
63*29492bb7SDavid van Moolenbroek *
64*29492bb7SDavid van Moolenbroek * DESCRIPTION: This function translates an ACPI exception into an ASCII
65*29492bb7SDavid van Moolenbroek * string. Returns "unknown status" string for invalid codes.
66*29492bb7SDavid van Moolenbroek *
67*29492bb7SDavid van Moolenbroek ******************************************************************************/
68*29492bb7SDavid van Moolenbroek
69*29492bb7SDavid van Moolenbroek const char *
AcpiFormatException(ACPI_STATUS Status)70*29492bb7SDavid van Moolenbroek AcpiFormatException (
71*29492bb7SDavid van Moolenbroek ACPI_STATUS Status)
72*29492bb7SDavid van Moolenbroek {
73*29492bb7SDavid van Moolenbroek const ACPI_EXCEPTION_INFO *Exception;
74*29492bb7SDavid van Moolenbroek
75*29492bb7SDavid van Moolenbroek
76*29492bb7SDavid van Moolenbroek ACPI_FUNCTION_ENTRY ();
77*29492bb7SDavid van Moolenbroek
78*29492bb7SDavid van Moolenbroek
79*29492bb7SDavid van Moolenbroek Exception = AcpiUtValidateException (Status);
80*29492bb7SDavid van Moolenbroek if (!Exception)
81*29492bb7SDavid van Moolenbroek {
82*29492bb7SDavid van Moolenbroek /* Exception code was not recognized */
83*29492bb7SDavid van Moolenbroek
84*29492bb7SDavid van Moolenbroek ACPI_ERROR ((AE_INFO,
85*29492bb7SDavid van Moolenbroek "Unknown exception code: 0x%8.8X", Status));
86*29492bb7SDavid van Moolenbroek
87*29492bb7SDavid van Moolenbroek return ("UNKNOWN_STATUS_CODE");
88*29492bb7SDavid van Moolenbroek }
89*29492bb7SDavid van Moolenbroek
90*29492bb7SDavid van Moolenbroek return (Exception->Name);
91*29492bb7SDavid van Moolenbroek }
92*29492bb7SDavid van Moolenbroek
ACPI_EXPORT_SYMBOL(AcpiFormatException)93*29492bb7SDavid van Moolenbroek ACPI_EXPORT_SYMBOL (AcpiFormatException)
94*29492bb7SDavid van Moolenbroek
95*29492bb7SDavid van Moolenbroek
96*29492bb7SDavid van Moolenbroek /*******************************************************************************
97*29492bb7SDavid van Moolenbroek *
98*29492bb7SDavid van Moolenbroek * FUNCTION: AcpiUtValidateException
99*29492bb7SDavid van Moolenbroek *
100*29492bb7SDavid van Moolenbroek * PARAMETERS: Status - The ACPI_STATUS code to be formatted
101*29492bb7SDavid van Moolenbroek *
102*29492bb7SDavid van Moolenbroek * RETURN: A string containing the exception text. NULL if exception is
103*29492bb7SDavid van Moolenbroek * not valid.
104*29492bb7SDavid van Moolenbroek *
105*29492bb7SDavid van Moolenbroek * DESCRIPTION: This function validates and translates an ACPI exception into
106*29492bb7SDavid van Moolenbroek * an ASCII string.
107*29492bb7SDavid van Moolenbroek *
108*29492bb7SDavid van Moolenbroek ******************************************************************************/
109*29492bb7SDavid van Moolenbroek
110*29492bb7SDavid van Moolenbroek const ACPI_EXCEPTION_INFO *
111*29492bb7SDavid van Moolenbroek AcpiUtValidateException (
112*29492bb7SDavid van Moolenbroek ACPI_STATUS Status)
113*29492bb7SDavid van Moolenbroek {
114*29492bb7SDavid van Moolenbroek UINT32 SubStatus;
115*29492bb7SDavid van Moolenbroek const ACPI_EXCEPTION_INFO *Exception = NULL;
116*29492bb7SDavid van Moolenbroek
117*29492bb7SDavid van Moolenbroek
118*29492bb7SDavid van Moolenbroek ACPI_FUNCTION_ENTRY ();
119*29492bb7SDavid van Moolenbroek
120*29492bb7SDavid van Moolenbroek
121*29492bb7SDavid van Moolenbroek /*
122*29492bb7SDavid van Moolenbroek * Status is composed of two parts, a "type" and an actual code
123*29492bb7SDavid van Moolenbroek */
124*29492bb7SDavid van Moolenbroek SubStatus = (Status & ~AE_CODE_MASK);
125*29492bb7SDavid van Moolenbroek
126*29492bb7SDavid van Moolenbroek switch (Status & AE_CODE_MASK)
127*29492bb7SDavid van Moolenbroek {
128*29492bb7SDavid van Moolenbroek case AE_CODE_ENVIRONMENTAL:
129*29492bb7SDavid van Moolenbroek
130*29492bb7SDavid van Moolenbroek if (SubStatus <= AE_CODE_ENV_MAX)
131*29492bb7SDavid van Moolenbroek {
132*29492bb7SDavid van Moolenbroek Exception = &AcpiGbl_ExceptionNames_Env [SubStatus];
133*29492bb7SDavid van Moolenbroek }
134*29492bb7SDavid van Moolenbroek break;
135*29492bb7SDavid van Moolenbroek
136*29492bb7SDavid van Moolenbroek case AE_CODE_PROGRAMMER:
137*29492bb7SDavid van Moolenbroek
138*29492bb7SDavid van Moolenbroek if (SubStatus <= AE_CODE_PGM_MAX)
139*29492bb7SDavid van Moolenbroek {
140*29492bb7SDavid van Moolenbroek Exception = &AcpiGbl_ExceptionNames_Pgm [SubStatus];
141*29492bb7SDavid van Moolenbroek }
142*29492bb7SDavid van Moolenbroek break;
143*29492bb7SDavid van Moolenbroek
144*29492bb7SDavid van Moolenbroek case AE_CODE_ACPI_TABLES:
145*29492bb7SDavid van Moolenbroek
146*29492bb7SDavid van Moolenbroek if (SubStatus <= AE_CODE_TBL_MAX)
147*29492bb7SDavid van Moolenbroek {
148*29492bb7SDavid van Moolenbroek Exception = &AcpiGbl_ExceptionNames_Tbl [SubStatus];
149*29492bb7SDavid van Moolenbroek }
150*29492bb7SDavid van Moolenbroek break;
151*29492bb7SDavid van Moolenbroek
152*29492bb7SDavid van Moolenbroek case AE_CODE_AML:
153*29492bb7SDavid van Moolenbroek
154*29492bb7SDavid van Moolenbroek if (SubStatus <= AE_CODE_AML_MAX)
155*29492bb7SDavid van Moolenbroek {
156*29492bb7SDavid van Moolenbroek Exception = &AcpiGbl_ExceptionNames_Aml [SubStatus];
157*29492bb7SDavid van Moolenbroek }
158*29492bb7SDavid van Moolenbroek break;
159*29492bb7SDavid van Moolenbroek
160*29492bb7SDavid van Moolenbroek case AE_CODE_CONTROL:
161*29492bb7SDavid van Moolenbroek
162*29492bb7SDavid van Moolenbroek if (SubStatus <= AE_CODE_CTRL_MAX)
163*29492bb7SDavid van Moolenbroek {
164*29492bb7SDavid van Moolenbroek Exception = &AcpiGbl_ExceptionNames_Ctrl [SubStatus];
165*29492bb7SDavid van Moolenbroek }
166*29492bb7SDavid van Moolenbroek break;
167*29492bb7SDavid van Moolenbroek
168*29492bb7SDavid van Moolenbroek default:
169*29492bb7SDavid van Moolenbroek
170*29492bb7SDavid van Moolenbroek break;
171*29492bb7SDavid van Moolenbroek }
172*29492bb7SDavid van Moolenbroek
173*29492bb7SDavid van Moolenbroek if (!Exception || !Exception->Name)
174*29492bb7SDavid van Moolenbroek {
175*29492bb7SDavid van Moolenbroek return (NULL);
176*29492bb7SDavid van Moolenbroek }
177*29492bb7SDavid van Moolenbroek
178*29492bb7SDavid van Moolenbroek return (Exception);
179*29492bb7SDavid van Moolenbroek }
180