17b1019a6SJerry Jelinek /*******************************************************************************
27b1019a6SJerry Jelinek  *
37b1019a6SJerry Jelinek  * Module Name: utexcep - Exception code support
47b1019a6SJerry Jelinek  *
57b1019a6SJerry Jelinek  ******************************************************************************/
67b1019a6SJerry Jelinek 
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi  *
9*35786f68SRobert Mustacchi  * 1. Copyright Notice
10*35786f68SRobert Mustacchi  *
11*35786f68SRobert Mustacchi  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
127b1019a6SJerry Jelinek  * All rights reserved.
137b1019a6SJerry Jelinek  *
14*35786f68SRobert Mustacchi  * 2. License
15*35786f68SRobert Mustacchi  *
16*35786f68SRobert Mustacchi  * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi  * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi  * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi  * property rights.
20*35786f68SRobert Mustacchi  *
21*35786f68SRobert Mustacchi  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi  * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi  * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi  * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi  *
28*35786f68SRobert Mustacchi  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi  * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi  * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi  * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi  * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi  * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi  * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi  *
37*35786f68SRobert Mustacchi  * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi  * conditions are met:
39*35786f68SRobert Mustacchi  *
40*35786f68SRobert Mustacchi  * 3. Conditions
41*35786f68SRobert Mustacchi  *
42*35786f68SRobert Mustacchi  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi  * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi  * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi  * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi  * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi  * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi  * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi  * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi  * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi  * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi  *
54*35786f68SRobert Mustacchi  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi  * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi  * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi  * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi  * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi  * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi  * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi  * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi  * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi  * make.
65*35786f68SRobert Mustacchi  *
66*35786f68SRobert Mustacchi  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi  * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi  * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi  * distribution.
71*35786f68SRobert Mustacchi  *
72*35786f68SRobert Mustacchi  * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi  * Intel Code.
74*35786f68SRobert Mustacchi  *
75*35786f68SRobert Mustacchi  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi  * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi  * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi  *
80*35786f68SRobert Mustacchi  * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi  *
82*35786f68SRobert Mustacchi  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi  * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi  *
90*35786f68SRobert Mustacchi  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi  * LIMITED REMEDY.
98*35786f68SRobert Mustacchi  *
99*35786f68SRobert Mustacchi  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi  * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi  * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi  * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi  * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi  * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi  * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi  * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi  * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi  * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi  * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi  * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi  * such license, approval or letter.
113*35786f68SRobert Mustacchi  *
114*35786f68SRobert Mustacchi  *****************************************************************************
115*35786f68SRobert Mustacchi  *
116*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi  * following license:
118*35786f68SRobert Mustacchi  *
1197b1019a6SJerry Jelinek  * Redistribution and use in source and binary forms, with or without
1207b1019a6SJerry Jelinek  * modification, are permitted provided that the following conditions
1217b1019a6SJerry Jelinek  * are met:
1227b1019a6SJerry Jelinek  * 1. Redistributions of source code must retain the above copyright
1237b1019a6SJerry Jelinek  *    notice, this list of conditions, and the following disclaimer,
1247b1019a6SJerry Jelinek  *    without modification.
1257b1019a6SJerry Jelinek  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1267b1019a6SJerry Jelinek  *    substantially similar to the "NO WARRANTY" disclaimer below
1277b1019a6SJerry Jelinek  *    ("Disclaimer") and any redistribution must be conditioned upon
1287b1019a6SJerry Jelinek  *    including a substantially similar Disclaimer requirement for further
1297b1019a6SJerry Jelinek  *    binary redistribution.
1307b1019a6SJerry Jelinek  * 3. Neither the names of the above-listed copyright holders nor the names
1317b1019a6SJerry Jelinek  *    of any contributors may be used to endorse or promote products derived
1327b1019a6SJerry Jelinek  *    from this software without specific prior written permission.
1337b1019a6SJerry Jelinek  *
1347b1019a6SJerry Jelinek  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1357b1019a6SJerry Jelinek  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1377b1019a6SJerry Jelinek  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi  *
146*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi  * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi  * Software Foundation.
149*35786f68SRobert Mustacchi  *
150*35786f68SRobert Mustacchi  *****************************************************************************/
1517b1019a6SJerry Jelinek 
1527b1019a6SJerry Jelinek #define EXPORT_ACPI_INTERFACES
1537b1019a6SJerry Jelinek 
1547b1019a6SJerry Jelinek #define ACPI_DEFINE_EXCEPTION_TABLE
1557b1019a6SJerry Jelinek #include "acpi.h"
1567b1019a6SJerry Jelinek #include "accommon.h"
1577b1019a6SJerry Jelinek 
1587b1019a6SJerry Jelinek 
1597b1019a6SJerry Jelinek #define _COMPONENT          ACPI_UTILITIES
1607b1019a6SJerry Jelinek         ACPI_MODULE_NAME    ("utexcep")
1617b1019a6SJerry Jelinek 
1627b1019a6SJerry Jelinek 
1637b1019a6SJerry Jelinek /*******************************************************************************
1647b1019a6SJerry Jelinek  *
1657b1019a6SJerry Jelinek  * FUNCTION:    AcpiFormatException
1667b1019a6SJerry Jelinek  *
1677b1019a6SJerry Jelinek  * PARAMETERS:  Status              - The ACPI_STATUS code to be formatted
1687b1019a6SJerry Jelinek  *
1697b1019a6SJerry Jelinek  * RETURN:      A string containing the exception text. A valid pointer is
1707b1019a6SJerry Jelinek  *              always returned.
1717b1019a6SJerry Jelinek  *
1727b1019a6SJerry Jelinek  * DESCRIPTION: This function translates an ACPI exception into an ASCII
1737b1019a6SJerry Jelinek  *              string. Returns "unknown status" string for invalid codes.
1747b1019a6SJerry Jelinek  *
1757b1019a6SJerry Jelinek  ******************************************************************************/
1767b1019a6SJerry Jelinek 
1777b1019a6SJerry Jelinek const char *
AcpiFormatException(ACPI_STATUS Status)1787b1019a6SJerry Jelinek AcpiFormatException (
1797b1019a6SJerry Jelinek     ACPI_STATUS             Status)
1807b1019a6SJerry Jelinek {
1817b1019a6SJerry Jelinek     const ACPI_EXCEPTION_INFO   *Exception;
1827b1019a6SJerry Jelinek 
1837b1019a6SJerry Jelinek 
1847b1019a6SJerry Jelinek     ACPI_FUNCTION_ENTRY ();
1857b1019a6SJerry Jelinek 
1867b1019a6SJerry Jelinek 
1877b1019a6SJerry Jelinek     Exception = AcpiUtValidateException (Status);
1887b1019a6SJerry Jelinek     if (!Exception)
1897b1019a6SJerry Jelinek     {
1907b1019a6SJerry Jelinek         /* Exception code was not recognized */
1917b1019a6SJerry Jelinek 
1927b1019a6SJerry Jelinek         ACPI_ERROR ((AE_INFO,
1937b1019a6SJerry Jelinek             "Unknown exception code: 0x%8.8X", Status));
1947b1019a6SJerry Jelinek 
1957b1019a6SJerry Jelinek         return ("UNKNOWN_STATUS_CODE");
1967b1019a6SJerry Jelinek     }
1977b1019a6SJerry Jelinek 
1987b1019a6SJerry Jelinek     return (Exception->Name);
1997b1019a6SJerry Jelinek }
2007b1019a6SJerry Jelinek 
ACPI_EXPORT_SYMBOL(AcpiFormatException)2017b1019a6SJerry Jelinek ACPI_EXPORT_SYMBOL (AcpiFormatException)
2027b1019a6SJerry Jelinek 
2037b1019a6SJerry Jelinek 
2047b1019a6SJerry Jelinek /*******************************************************************************
2057b1019a6SJerry Jelinek  *
2067b1019a6SJerry Jelinek  * FUNCTION:    AcpiUtValidateException
2077b1019a6SJerry Jelinek  *
2087b1019a6SJerry Jelinek  * PARAMETERS:  Status              - The ACPI_STATUS code to be formatted
2097b1019a6SJerry Jelinek  *
2107b1019a6SJerry Jelinek  * RETURN:      A string containing the exception text. NULL if exception is
2117b1019a6SJerry Jelinek  *              not valid.
2127b1019a6SJerry Jelinek  *
2137b1019a6SJerry Jelinek  * DESCRIPTION: This function validates and translates an ACPI exception into
2147b1019a6SJerry Jelinek  *              an ASCII string.
2157b1019a6SJerry Jelinek  *
2167b1019a6SJerry Jelinek  ******************************************************************************/
2177b1019a6SJerry Jelinek 
2187b1019a6SJerry Jelinek const ACPI_EXCEPTION_INFO *
2197b1019a6SJerry Jelinek AcpiUtValidateException (
2207b1019a6SJerry Jelinek     ACPI_STATUS             Status)
2217b1019a6SJerry Jelinek {
2227b1019a6SJerry Jelinek     UINT32                      SubStatus;
2237b1019a6SJerry Jelinek     const ACPI_EXCEPTION_INFO   *Exception = NULL;
2247b1019a6SJerry Jelinek 
2257b1019a6SJerry Jelinek 
2267b1019a6SJerry Jelinek     ACPI_FUNCTION_ENTRY ();
2277b1019a6SJerry Jelinek 
2287b1019a6SJerry Jelinek 
2297b1019a6SJerry Jelinek     /*
2307b1019a6SJerry Jelinek      * Status is composed of two parts, a "type" and an actual code
2317b1019a6SJerry Jelinek      */
2327b1019a6SJerry Jelinek     SubStatus = (Status & ~AE_CODE_MASK);
2337b1019a6SJerry Jelinek 
2347b1019a6SJerry Jelinek     switch (Status & AE_CODE_MASK)
2357b1019a6SJerry Jelinek     {
2367b1019a6SJerry Jelinek     case AE_CODE_ENVIRONMENTAL:
2377b1019a6SJerry Jelinek 
2387b1019a6SJerry Jelinek         if (SubStatus <= AE_CODE_ENV_MAX)
2397b1019a6SJerry Jelinek         {
2407b1019a6SJerry Jelinek             Exception = &AcpiGbl_ExceptionNames_Env [SubStatus];
2417b1019a6SJerry Jelinek         }
2427b1019a6SJerry Jelinek         break;
2437b1019a6SJerry Jelinek 
2447b1019a6SJerry Jelinek     case AE_CODE_PROGRAMMER:
2457b1019a6SJerry Jelinek 
2467b1019a6SJerry Jelinek         if (SubStatus <= AE_CODE_PGM_MAX)
2477b1019a6SJerry Jelinek         {
2487b1019a6SJerry Jelinek             Exception = &AcpiGbl_ExceptionNames_Pgm [SubStatus];
2497b1019a6SJerry Jelinek         }
2507b1019a6SJerry Jelinek         break;
2517b1019a6SJerry Jelinek 
2527b1019a6SJerry Jelinek     case AE_CODE_ACPI_TABLES:
2537b1019a6SJerry Jelinek 
2547b1019a6SJerry Jelinek         if (SubStatus <= AE_CODE_TBL_MAX)
2557b1019a6SJerry Jelinek         {
2567b1019a6SJerry Jelinek             Exception = &AcpiGbl_ExceptionNames_Tbl [SubStatus];
2577b1019a6SJerry Jelinek         }
2587b1019a6SJerry Jelinek         break;
2597b1019a6SJerry Jelinek 
2607b1019a6SJerry Jelinek     case AE_CODE_AML:
2617b1019a6SJerry Jelinek 
2627b1019a6SJerry Jelinek         if (SubStatus <= AE_CODE_AML_MAX)
2637b1019a6SJerry Jelinek         {
2647b1019a6SJerry Jelinek             Exception = &AcpiGbl_ExceptionNames_Aml [SubStatus];
2657b1019a6SJerry Jelinek         }
2667b1019a6SJerry Jelinek         break;
2677b1019a6SJerry Jelinek 
2687b1019a6SJerry Jelinek     case AE_CODE_CONTROL:
2697b1019a6SJerry Jelinek 
2707b1019a6SJerry Jelinek         if (SubStatus <= AE_CODE_CTRL_MAX)
2717b1019a6SJerry Jelinek         {
2727b1019a6SJerry Jelinek             Exception = &AcpiGbl_ExceptionNames_Ctrl [SubStatus];
2737b1019a6SJerry Jelinek         }
2747b1019a6SJerry Jelinek         break;
2757b1019a6SJerry Jelinek 
2767b1019a6SJerry Jelinek     default:
2777b1019a6SJerry Jelinek 
2787b1019a6SJerry Jelinek         break;
2797b1019a6SJerry Jelinek     }
2807b1019a6SJerry Jelinek 
2817b1019a6SJerry Jelinek     if (!Exception || !Exception->Name)
2827b1019a6SJerry Jelinek     {
2837b1019a6SJerry Jelinek         return (NULL);
2847b1019a6SJerry Jelinek     }
2857b1019a6SJerry Jelinek 
2867b1019a6SJerry Jelinek     return (Exception);
2877b1019a6SJerry Jelinek }
288