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