xref: /freebsd/sys/contrib/dev/acpica/components/utilities/utxferror.c (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1 /*******************************************************************************
2  *
3  * Module Name: utxferror - Various error/warning output functions
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #define EXPORT_ACPI_INTERFACES
153 
154 #include <contrib/dev/acpica/include/acpi.h>
155 #include <contrib/dev/acpica/include/accommon.h>
156 
157 
158 #define _COMPONENT          ACPI_UTILITIES
159         ACPI_MODULE_NAME    ("utxferror")
160 
161 /*
162  * This module is used for the in-kernel ACPICA as well as the ACPICA
163  * tools/applications.
164  */
165 
166 #ifndef ACPI_NO_ERROR_MESSAGES /* Entire module */
167 
168 /*******************************************************************************
169  *
170  * FUNCTION:    AcpiError
171  *
172  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
173  *              LineNumber          - Caller's line number (for error output)
174  *              Format              - Printf format string + additional args
175  *
176  * RETURN:      None
177  *
178  * DESCRIPTION: Print "ACPI Error" message with module/line/version info
179  *
180  ******************************************************************************/
181 
182 void ACPI_INTERNAL_VAR_XFACE
183 AcpiError (
184     const char              *ModuleName,
185     UINT32                  LineNumber,
186     const char              *Format,
187     ...)
188 {
189     va_list                 ArgList;
190 
191 
192     ACPI_MSG_REDIRECT_BEGIN;
193     AcpiOsPrintf (ACPI_MSG_ERROR);
194 
195     va_start (ArgList, Format);
196     AcpiOsVprintf (Format, ArgList);
197     ACPI_MSG_SUFFIX;
198     va_end (ArgList);
199 
200     ACPI_MSG_REDIRECT_END;
201 }
202 
203 ACPI_EXPORT_SYMBOL (AcpiError)
204 
205 
206 /*******************************************************************************
207  *
208  * FUNCTION:    AcpiException
209  *
210  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
211  *              LineNumber          - Caller's line number (for error output)
212  *              Status              - Status value to be decoded/formatted
213  *              Format              - Printf format string + additional args
214  *
215  * RETURN:      None
216  *
217  * DESCRIPTION: Print an "ACPI Error" message with module/line/version
218  *              info as well as decoded ACPI_STATUS.
219  *
220  ******************************************************************************/
221 
222 void ACPI_INTERNAL_VAR_XFACE
223 AcpiException (
224     const char              *ModuleName,
225     UINT32                  LineNumber,
226     ACPI_STATUS             Status,
227     const char              *Format,
228     ...)
229 {
230     va_list                 ArgList;
231 
232 
233     ACPI_MSG_REDIRECT_BEGIN;
234 
235     /* For AE_OK, just print the message */
236 
237     if (ACPI_SUCCESS (Status))
238     {
239         AcpiOsPrintf (ACPI_MSG_ERROR);
240 
241     }
242     else
243     {
244         AcpiOsPrintf (ACPI_MSG_ERROR "%s, ",
245             AcpiFormatException (Status));
246     }
247 
248     va_start (ArgList, Format);
249     AcpiOsVprintf (Format, ArgList);
250     ACPI_MSG_SUFFIX;
251     va_end (ArgList);
252 
253     ACPI_MSG_REDIRECT_END;
254 }
255 
256 ACPI_EXPORT_SYMBOL (AcpiException)
257 
258 
259 /*******************************************************************************
260  *
261  * FUNCTION:    AcpiWarning
262  *
263  * PARAMETERS:  ModuleName          - Caller's module name (for warning output)
264  *              LineNumber          - Caller's line number (for warning output)
265  *              Format              - Printf format string + additional args
266  *
267  * RETURN:      None
268  *
269  * DESCRIPTION: Print "ACPI Warning" message with module/line/version info
270  *
271  ******************************************************************************/
272 
273 void ACPI_INTERNAL_VAR_XFACE
274 AcpiWarning (
275     const char              *ModuleName,
276     UINT32                  LineNumber,
277     const char              *Format,
278     ...)
279 {
280     va_list                 ArgList;
281 
282 
283     ACPI_MSG_REDIRECT_BEGIN;
284     AcpiOsPrintf (ACPI_MSG_WARNING);
285 
286     va_start (ArgList, Format);
287     AcpiOsVprintf (Format, ArgList);
288     ACPI_MSG_SUFFIX;
289     va_end (ArgList);
290 
291     ACPI_MSG_REDIRECT_END;
292 }
293 
294 ACPI_EXPORT_SYMBOL (AcpiWarning)
295 
296 
297 /*******************************************************************************
298  *
299  * FUNCTION:    AcpiInfo
300  *
301  * PARAMETERS:  Format              - Printf format string + additional args
302  *
303  * RETURN:      None
304  *
305  * DESCRIPTION: Print generic "ACPI:" information message. There is no
306  *              module/line/version info in order to keep the message simple.
307  *
308  ******************************************************************************/
309 
310 void ACPI_INTERNAL_VAR_XFACE
311 AcpiInfo (
312     const char              *Format,
313     ...)
314 {
315     va_list                 ArgList;
316 
317 #ifdef _KERNEL
318     /* Temporarily hide too verbose printfs. */
319     if (!bootverbose)
320 	return;
321 #endif
322 
323     ACPI_MSG_REDIRECT_BEGIN;
324     AcpiOsPrintf (ACPI_MSG_INFO);
325 
326     va_start (ArgList, Format);
327     AcpiOsVprintf (Format, ArgList);
328     AcpiOsPrintf ("\n");
329     va_end (ArgList);
330 
331     ACPI_MSG_REDIRECT_END;
332 }
333 
334 ACPI_EXPORT_SYMBOL (AcpiInfo)
335 
336 
337 /*******************************************************************************
338  *
339  * FUNCTION:    AcpiBiosError
340  *
341  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
342  *              LineNumber          - Caller's line number (for error output)
343  *              Format              - Printf format string + additional args
344  *
345  * RETURN:      None
346  *
347  * DESCRIPTION: Print "ACPI Firmware Error" message with module/line/version
348  *              info
349  *
350  ******************************************************************************/
351 
352 void ACPI_INTERNAL_VAR_XFACE
353 AcpiBiosError (
354     const char              *ModuleName,
355     UINT32                  LineNumber,
356     const char              *Format,
357     ...)
358 {
359     va_list                 ArgList;
360 
361 
362     ACPI_MSG_REDIRECT_BEGIN;
363     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
364 
365     va_start (ArgList, Format);
366     AcpiOsVprintf (Format, ArgList);
367     ACPI_MSG_SUFFIX;
368     va_end (ArgList);
369 
370     ACPI_MSG_REDIRECT_END;
371 }
372 
373 ACPI_EXPORT_SYMBOL (AcpiBiosError)
374 
375 
376 /*******************************************************************************
377  *
378  * FUNCTION:    AcpiBiosException
379  *
380  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
381  *              LineNumber          - Caller's line number (for error output)
382  *              Status              - Status value to be decoded/formatted
383  *              Format              - Printf format string + additional args
384  *
385  * RETURN:      None
386  *
387  * DESCRIPTION: Print an "ACPI Firmware Error" message with module/line/version
388  *              info as well as decoded ACPI_STATUS.
389  *
390  ******************************************************************************/
391 
392 void ACPI_INTERNAL_VAR_XFACE
393 AcpiBiosException (
394     const char              *ModuleName,
395     UINT32                  LineNumber,
396     ACPI_STATUS             Status,
397     const char              *Format,
398     ...)
399 {
400     va_list                 ArgList;
401 
402 
403     ACPI_MSG_REDIRECT_BEGIN;
404 
405     /* For AE_OK, just print the message */
406 
407     if (ACPI_SUCCESS (Status))
408     {
409         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
410 
411     }
412     else
413     {
414         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s, ",
415             AcpiFormatException (Status));
416     }
417 
418     va_start (ArgList, Format);
419     AcpiOsVprintf (Format, ArgList);
420     ACPI_MSG_SUFFIX;
421     va_end (ArgList);
422 
423     ACPI_MSG_REDIRECT_END;
424 }
425 
426 ACPI_EXPORT_SYMBOL (AcpiBiosException)
427 
428 
429 /*******************************************************************************
430  *
431  * FUNCTION:    AcpiBiosWarning
432  *
433  * PARAMETERS:  ModuleName          - Caller's module name (for warning output)
434  *              LineNumber          - Caller's line number (for warning output)
435  *              Format              - Printf format string + additional args
436  *
437  * RETURN:      None
438  *
439  * DESCRIPTION: Print "ACPI Firmware Warning" message with module/line/version
440  *              info
441  *
442  ******************************************************************************/
443 
444 void ACPI_INTERNAL_VAR_XFACE
445 AcpiBiosWarning (
446     const char              *ModuleName,
447     UINT32                  LineNumber,
448     const char              *Format,
449     ...)
450 {
451     va_list                 ArgList;
452 
453 
454     ACPI_MSG_REDIRECT_BEGIN;
455     AcpiOsPrintf (ACPI_MSG_BIOS_WARNING);
456 
457     va_start (ArgList, Format);
458     AcpiOsVprintf (Format, ArgList);
459     ACPI_MSG_SUFFIX;
460     va_end (ArgList);
461 
462     ACPI_MSG_REDIRECT_END;
463 }
464 
465 ACPI_EXPORT_SYMBOL (AcpiBiosWarning)
466 
467 #endif /* ACPI_NO_ERROR_MESSAGES */
468