xref: /openbmc/linux/drivers/acpi/acpica/utxferror.c (revision 94cdda6b)
1 /*******************************************************************************
2  *
3  * Module Name: utxferror - Various error/warning output functions
4  *
5  ******************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2015, 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 #include <acpi/acpi.h>
47 #include "accommon.h"
48 
49 #define _COMPONENT          ACPI_UTILITIES
50 ACPI_MODULE_NAME("utxferror")
51 
52 /*
53  * This module is used for the in-kernel ACPICA as well as the ACPICA
54  * tools/applications.
55  */
56 #ifndef ACPI_NO_ERROR_MESSAGES	/* Entire module */
57 /*******************************************************************************
58  *
59  * FUNCTION:    acpi_error
60  *
61  * PARAMETERS:  module_name         - Caller's module name (for error output)
62  *              line_number         - Caller's line number (for error output)
63  *              format              - Printf format string + additional args
64  *
65  * RETURN:      None
66  *
67  * DESCRIPTION: Print "ACPI Error" message with module/line/version info
68  *
69  ******************************************************************************/
70 void ACPI_INTERNAL_VAR_XFACE
71 acpi_error(const char *module_name, u32 line_number, const char *format, ...)
72 {
73 	va_list arg_list;
74 
75 	ACPI_MSG_REDIRECT_BEGIN;
76 	acpi_os_printf(ACPI_MSG_ERROR);
77 
78 	va_start(arg_list, format);
79 	acpi_os_vprintf(format, arg_list);
80 	ACPI_MSG_SUFFIX;
81 	va_end(arg_list);
82 
83 	ACPI_MSG_REDIRECT_END;
84 }
85 
86 ACPI_EXPORT_SYMBOL(acpi_error)
87 
88 /*******************************************************************************
89  *
90  * FUNCTION:    acpi_exception
91  *
92  * PARAMETERS:  module_name         - Caller's module name (for error output)
93  *              line_number         - Caller's line number (for error output)
94  *              status              - Status to be formatted
95  *              format              - Printf format string + additional args
96  *
97  * RETURN:      None
98  *
99  * DESCRIPTION: Print "ACPI Exception" message with module/line/version info
100  *              and decoded acpi_status.
101  *
102  ******************************************************************************/
103 void ACPI_INTERNAL_VAR_XFACE
104 acpi_exception(const char *module_name,
105 	       u32 line_number, acpi_status status, const char *format, ...)
106 {
107 	va_list arg_list;
108 
109 	ACPI_MSG_REDIRECT_BEGIN;
110 	acpi_os_printf(ACPI_MSG_EXCEPTION "%s, ",
111 		       acpi_format_exception(status));
112 
113 	va_start(arg_list, format);
114 	acpi_os_vprintf(format, arg_list);
115 	ACPI_MSG_SUFFIX;
116 	va_end(arg_list);
117 
118 	ACPI_MSG_REDIRECT_END;
119 }
120 
121 ACPI_EXPORT_SYMBOL(acpi_exception)
122 
123 /*******************************************************************************
124  *
125  * FUNCTION:    acpi_warning
126  *
127  * PARAMETERS:  module_name         - Caller's module name (for error output)
128  *              line_number         - Caller's line number (for error output)
129  *              format              - Printf format string + additional args
130  *
131  * RETURN:      None
132  *
133  * DESCRIPTION: Print "ACPI Warning" message with module/line/version info
134  *
135  ******************************************************************************/
136 void ACPI_INTERNAL_VAR_XFACE
137 acpi_warning(const char *module_name, u32 line_number, const char *format, ...)
138 {
139 	va_list arg_list;
140 
141 	ACPI_MSG_REDIRECT_BEGIN;
142 	acpi_os_printf(ACPI_MSG_WARNING);
143 
144 	va_start(arg_list, format);
145 	acpi_os_vprintf(format, arg_list);
146 	ACPI_MSG_SUFFIX;
147 	va_end(arg_list);
148 
149 	ACPI_MSG_REDIRECT_END;
150 }
151 
152 ACPI_EXPORT_SYMBOL(acpi_warning)
153 
154 /*******************************************************************************
155  *
156  * FUNCTION:    acpi_info
157  *
158  * PARAMETERS:  module_name         - Caller's module name (for error output)
159  *              line_number         - Caller's line number (for error output)
160  *              format              - Printf format string + additional args
161  *
162  * RETURN:      None
163  *
164  * DESCRIPTION: Print generic "ACPI:" information message. There is no
165  *              module/line/version info in order to keep the message simple.
166  *
167  * TBD: module_name and line_number args are not needed, should be removed.
168  *
169  ******************************************************************************/
170 void ACPI_INTERNAL_VAR_XFACE
171 acpi_info(const char *module_name, u32 line_number, const char *format, ...)
172 {
173 	va_list arg_list;
174 
175 	ACPI_MSG_REDIRECT_BEGIN;
176 	acpi_os_printf(ACPI_MSG_INFO);
177 
178 	va_start(arg_list, format);
179 	acpi_os_vprintf(format, arg_list);
180 	acpi_os_printf("\n");
181 	va_end(arg_list);
182 
183 	ACPI_MSG_REDIRECT_END;
184 }
185 
186 ACPI_EXPORT_SYMBOL(acpi_info)
187 
188 /*******************************************************************************
189  *
190  * FUNCTION:    acpi_bios_error
191  *
192  * PARAMETERS:  module_name         - Caller's module name (for error output)
193  *              line_number         - Caller's line number (for error output)
194  *              format              - Printf format string + additional args
195  *
196  * RETURN:      None
197  *
198  * DESCRIPTION: Print "ACPI Firmware Error" message with module/line/version
199  *              info
200  *
201  ******************************************************************************/
202 void ACPI_INTERNAL_VAR_XFACE
203 acpi_bios_error(const char *module_name,
204 		u32 line_number, const char *format, ...)
205 {
206 	va_list arg_list;
207 
208 	ACPI_MSG_REDIRECT_BEGIN;
209 	acpi_os_printf(ACPI_MSG_BIOS_ERROR);
210 
211 	va_start(arg_list, format);
212 	acpi_os_vprintf(format, arg_list);
213 	ACPI_MSG_SUFFIX;
214 	va_end(arg_list);
215 
216 	ACPI_MSG_REDIRECT_END;
217 }
218 
219 ACPI_EXPORT_SYMBOL(acpi_bios_error)
220 
221 /*******************************************************************************
222  *
223  * FUNCTION:    acpi_bios_warning
224  *
225  * PARAMETERS:  module_name         - Caller's module name (for error output)
226  *              line_number         - Caller's line number (for error output)
227  *              format              - Printf format string + additional args
228  *
229  * RETURN:      None
230  *
231  * DESCRIPTION: Print "ACPI Firmware Warning" message with module/line/version
232  *              info
233  *
234  ******************************************************************************/
235 void ACPI_INTERNAL_VAR_XFACE
236 acpi_bios_warning(const char *module_name,
237 		  u32 line_number, const char *format, ...)
238 {
239 	va_list arg_list;
240 
241 	ACPI_MSG_REDIRECT_BEGIN;
242 	acpi_os_printf(ACPI_MSG_BIOS_WARNING);
243 
244 	va_start(arg_list, format);
245 	acpi_os_vprintf(format, arg_list);
246 	ACPI_MSG_SUFFIX;
247 	va_end(arg_list);
248 
249 	ACPI_MSG_REDIRECT_END;
250 }
251 
252 ACPI_EXPORT_SYMBOL(acpi_bios_warning)
253 #endif				/* ACPI_NO_ERROR_MESSAGES */
254