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