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