35efd522b023d27e91f38977b205a7a59afa2d9c
[reactos.git] / reactos / drivers / bus / acpi / acpica / utilities / utxferror.c
1 /*******************************************************************************
2 *
3 * Module Name: utxferror - Various error/warning output functions
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 #include "acpi.h"
47 #include "accommon.h"
48
49
50 #define _COMPONENT ACPI_UTILITIES
51 ACPI_MODULE_NAME ("utxferror")
52
53 /*
54 * This module is used for the in-kernel ACPICA as well as the ACPICA
55 * tools/applications.
56 */
57
58 #ifndef ACPI_NO_ERROR_MESSAGES /* Entire module */
59
60 /*******************************************************************************
61 *
62 * FUNCTION: AcpiError
63 *
64 * PARAMETERS: ModuleName - Caller's module name (for error output)
65 * LineNumber - Caller's line number (for error output)
66 * Format - Printf format string + additional args
67 *
68 * RETURN: None
69 *
70 * DESCRIPTION: Print "ACPI Error" message with module/line/version info
71 *
72 ******************************************************************************/
73
74 void ACPI_INTERNAL_VAR_XFACE
75 AcpiError (
76 const char *ModuleName,
77 UINT32 LineNumber,
78 const char *Format,
79 ...)
80 {
81 va_list ArgList;
82
83
84 ACPI_MSG_REDIRECT_BEGIN;
85 AcpiOsPrintf (ACPI_MSG_ERROR);
86
87 va_start (ArgList, Format);
88 AcpiOsVprintf (Format, ArgList);
89 ACPI_MSG_SUFFIX;
90 va_end (ArgList);
91
92 ACPI_MSG_REDIRECT_END;
93 }
94
95 ACPI_EXPORT_SYMBOL (AcpiError)
96
97
98 /*******************************************************************************
99 *
100 * FUNCTION: AcpiException
101 *
102 * PARAMETERS: ModuleName - Caller's module name (for error output)
103 * LineNumber - Caller's line number (for error output)
104 * Status - Status to be formatted
105 * Format - Printf format string + additional args
106 *
107 * RETURN: None
108 *
109 * DESCRIPTION: Print "ACPI Exception" message with module/line/version info
110 * and decoded ACPI_STATUS.
111 *
112 ******************************************************************************/
113
114 void ACPI_INTERNAL_VAR_XFACE
115 AcpiException (
116 const char *ModuleName,
117 UINT32 LineNumber,
118 ACPI_STATUS Status,
119 const char *Format,
120 ...)
121 {
122 va_list ArgList;
123
124
125 ACPI_MSG_REDIRECT_BEGIN;
126
127 /* For AE_OK, just print the message */
128
129 if (ACPI_SUCCESS (Status))
130 {
131 AcpiOsPrintf (ACPI_MSG_EXCEPTION);
132
133 }
134 else
135 {
136 AcpiOsPrintf (ACPI_MSG_EXCEPTION "%s, ",
137 AcpiFormatException (Status));
138 }
139
140 va_start (ArgList, Format);
141 AcpiOsVprintf (Format, ArgList);
142 ACPI_MSG_SUFFIX;
143 va_end (ArgList);
144
145 ACPI_MSG_REDIRECT_END;
146 }
147
148 ACPI_EXPORT_SYMBOL (AcpiException)
149
150
151 /*******************************************************************************
152 *
153 * FUNCTION: AcpiWarning
154 *
155 * PARAMETERS: ModuleName - Caller's module name (for error output)
156 * LineNumber - Caller's line number (for error output)
157 * Format - Printf format string + additional args
158 *
159 * RETURN: None
160 *
161 * DESCRIPTION: Print "ACPI Warning" message with module/line/version info
162 *
163 ******************************************************************************/
164
165 void ACPI_INTERNAL_VAR_XFACE
166 AcpiWarning (
167 const char *ModuleName,
168 UINT32 LineNumber,
169 const char *Format,
170 ...)
171 {
172 va_list ArgList;
173
174
175 ACPI_MSG_REDIRECT_BEGIN;
176 AcpiOsPrintf (ACPI_MSG_WARNING);
177
178 va_start (ArgList, Format);
179 AcpiOsVprintf (Format, ArgList);
180 ACPI_MSG_SUFFIX;
181 va_end (ArgList);
182
183 ACPI_MSG_REDIRECT_END;
184 }
185
186 ACPI_EXPORT_SYMBOL (AcpiWarning)
187
188
189 /*******************************************************************************
190 *
191 * FUNCTION: AcpiInfo
192 *
193 * PARAMETERS: ModuleName - Caller's module name (for error output)
194 * LineNumber - Caller's line number (for error output)
195 * Format - Printf format string + additional args
196 *
197 * RETURN: None
198 *
199 * DESCRIPTION: Print generic "ACPI:" information message. There is no
200 * module/line/version info in order to keep the message simple.
201 *
202 * TBD: ModuleName and LineNumber args are not needed, should be removed.
203 *
204 ******************************************************************************/
205
206 void ACPI_INTERNAL_VAR_XFACE
207 AcpiInfo (
208 const char *ModuleName,
209 UINT32 LineNumber,
210 const char *Format,
211 ...)
212 {
213 va_list ArgList;
214
215
216 ACPI_MSG_REDIRECT_BEGIN;
217 AcpiOsPrintf (ACPI_MSG_INFO);
218
219 va_start (ArgList, Format);
220 AcpiOsVprintf (Format, ArgList);
221 AcpiOsPrintf ("\n");
222 va_end (ArgList);
223
224 ACPI_MSG_REDIRECT_END;
225 }
226
227 ACPI_EXPORT_SYMBOL (AcpiInfo)
228
229
230 /*******************************************************************************
231 *
232 * FUNCTION: AcpiBiosError
233 *
234 * PARAMETERS: ModuleName - Caller's module name (for error output)
235 * LineNumber - Caller's line number (for error output)
236 * Format - Printf format string + additional args
237 *
238 * RETURN: None
239 *
240 * DESCRIPTION: Print "ACPI Firmware Error" message with module/line/version
241 * info
242 *
243 ******************************************************************************/
244
245 void ACPI_INTERNAL_VAR_XFACE
246 AcpiBiosError (
247 const char *ModuleName,
248 UINT32 LineNumber,
249 const char *Format,
250 ...)
251 {
252 va_list ArgList;
253
254
255 ACPI_MSG_REDIRECT_BEGIN;
256 AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
257
258 va_start (ArgList, Format);
259 AcpiOsVprintf (Format, ArgList);
260 ACPI_MSG_SUFFIX;
261 va_end (ArgList);
262
263 ACPI_MSG_REDIRECT_END;
264 }
265
266 ACPI_EXPORT_SYMBOL (AcpiBiosError)
267
268
269 /*******************************************************************************
270 *
271 * FUNCTION: AcpiBiosWarning
272 *
273 * PARAMETERS: ModuleName - Caller's module name (for error output)
274 * LineNumber - Caller's line number (for error output)
275 * Format - Printf format string + additional args
276 *
277 * RETURN: None
278 *
279 * DESCRIPTION: Print "ACPI Firmware Warning" message with module/line/version
280 * info
281 *
282 ******************************************************************************/
283
284 void ACPI_INTERNAL_VAR_XFACE
285 AcpiBiosWarning (
286 const char *ModuleName,
287 UINT32 LineNumber,
288 const char *Format,
289 ...)
290 {
291 va_list ArgList;
292
293
294 ACPI_MSG_REDIRECT_BEGIN;
295 AcpiOsPrintf (ACPI_MSG_BIOS_WARNING);
296
297 va_start (ArgList, Format);
298 AcpiOsVprintf (Format, ArgList);
299 ACPI_MSG_SUFFIX;
300 va_end (ArgList);
301
302 ACPI_MSG_REDIRECT_END;
303 }
304
305 ACPI_EXPORT_SYMBOL (AcpiBiosWarning)
306
307 #endif /* ACPI_NO_ERROR_MESSAGES */