acpica/utilities/utxferror.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: utxferror - Various error/warning output functions
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #define EXPORT_ACPI_INTERFACES
0153
0154 #include "acpi.h"
0155 #include "accommon.h"
0156
0157
0158 #define _COMPONENT          ACPI_UTILITIES
0159         ACPI_MODULE_NAME    ("utxferror")
0160
0161 /*
0162  * This module is used for the in-kernel ACPICA as well as the ACPICA
0163  * tools/applications.
0164  */
0165
0166 #ifndef ACPI_NO_ERROR_MESSAGES /* Entire module */
0167
0168 /*******************************************************************************
0169  *
0170  * FUNCTION:    AcpiError
0171  *
0172  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0173  *              LineNumber          - Caller's line number (for error output)
0174  *              Format              - Printf format string + additional args
0175  *
0176  * RETURN:      None
0177  *
0178  * DESCRIPTION: Print "ACPI Error" message with module/line/version info
0179  *
0180  ******************************************************************************/
0181
0182 void ACPI_INTERNAL_VAR_XFACE
0183 AcpiError (
0184     const char              *ModuleName,
0185     UINT32                  LineNumber,
0186     const char              *Format,
0187     ...)
0188 {
0189     va_list                 ArgList;
0190
0191
0192     ACPI_MSG_REDIRECT_BEGIN;
0193     AcpiOsPrintf (ACPI_MSG_ERROR);
0194
0195     va_start (ArgList, Format);
0196     AcpiOsVprintf (Format, ArgList);
0197     ACPI_MSG_SUFFIX;
0198     va_end (ArgList);
0199
0200     ACPI_MSG_REDIRECT_END;
0201 }
0202
0203 ACPI_EXPORT_SYMBOL (AcpiError)
0204
0205
0206 /*******************************************************************************
0207  *
0208  * FUNCTION:    AcpiException
0209  *
0210  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0211  *              LineNumber          - Caller's line number (for error output)
0212  *              Status              - Status value to be decoded/formatted
0213  *              Format              - Printf format string + additional args
0214  *
0215  * RETURN:      None
0216  *
0217  * DESCRIPTION: Print an "ACPI Error" message with module/line/version
0218  *              info as well as decoded ACPI_STATUS.
0219  *
0220  ******************************************************************************/
0221
0222 void ACPI_INTERNAL_VAR_XFACE
0223 AcpiException (
0224     const char              *ModuleName,
0225     UINT32                  LineNumber,
0226     ACPI_STATUS             Status,
0227     const char              *Format,
0228     ...)
0229 {
0230     va_list                 ArgList;
0231
0232
0233     ACPI_MSG_REDIRECT_BEGIN;
0234
0235     /* For AE_OK, just print the message */
0236
0237     if (ACPI_SUCCESS (Status))
0238     {
0239         AcpiOsPrintf (ACPI_MSG_ERROR);
0240
0241     }
0242     else
0243     {
0244         AcpiOsPrintf (ACPI_MSG_ERROR "%s, ",
0245             AcpiFormatException (Status));
0246     }
0247
0248     va_start (ArgList, Format);
0249     AcpiOsVprintf (Format, ArgList);
0250     ACPI_MSG_SUFFIX;
0251     va_end (ArgList);
0252
0253     ACPI_MSG_REDIRECT_END;
0254 }
0255
0256 ACPI_EXPORT_SYMBOL (AcpiException)
0257
0258
0259 /*******************************************************************************
0260  *
0261  * FUNCTION:    AcpiWarning
0262  *
0263  * PARAMETERS:  ModuleName          - Caller's module name (for warning output)
0264  *              LineNumber          - Caller's line number (for warning output)
0265  *              Format              - Printf format string + additional args
0266  *
0267  * RETURN:      None
0268  *
0269  * DESCRIPTION: Print "ACPI Warning" message with module/line/version info
0270  *
0271  ******************************************************************************/
0272
0273 void ACPI_INTERNAL_VAR_XFACE
0274 AcpiWarning (
0275     const char              *ModuleName,
0276     UINT32                  LineNumber,
0277     const char              *Format,
0278     ...)
0279 {
0280     va_list                 ArgList;
0281
0282
0283     ACPI_MSG_REDIRECT_BEGIN;
0284     AcpiOsPrintf (ACPI_MSG_WARNING);
0285
0286     va_start (ArgList, Format);
0287     AcpiOsVprintf (Format, ArgList);
0288     ACPI_MSG_SUFFIX;
0289     va_end (ArgList);
0290
0291     ACPI_MSG_REDIRECT_END;
0292 }
0293
0294 ACPI_EXPORT_SYMBOL (AcpiWarning)
0295
0296
0297 /*******************************************************************************
0298  *
0299  * FUNCTION:    AcpiInfo
0300  *
0301  * PARAMETERS:  Format              - Printf format string + additional args
0302  *
0303  * RETURN:      None
0304  *
0305  * DESCRIPTION: Print generic "ACPI:" information message. There is no
0306  *              module/line/version info in order to keep the message simple.
0307  *
0308  ******************************************************************************/
0309
0310 void ACPI_INTERNAL_VAR_XFACE
0311 AcpiInfo (
0312     const char              *Format,
0313     ...)
0314 {
0315     va_list                 ArgList;
0316
0317
0318     ACPI_MSG_REDIRECT_BEGIN;
0319     AcpiOsPrintf (ACPI_MSG_INFO);
0320
0321     va_start (ArgList, Format);
0322     AcpiOsVprintf (Format, ArgList);
0323     AcpiOsPrintf ("\n");
0324     va_end (ArgList);
0325
0326     ACPI_MSG_REDIRECT_END;
0327 }
0328
0329 ACPI_EXPORT_SYMBOL (AcpiInfo)
0330
0331
0332 /*******************************************************************************
0333  *
0334  * FUNCTION:    AcpiBiosError
0335  *
0336  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0337  *              LineNumber          - Caller's line number (for error output)
0338  *              Format              - Printf format string + additional args
0339  *
0340  * RETURN:      None
0341  *
0342  * DESCRIPTION: Print "ACPI Firmware Error" message with module/line/version
0343  *              info
0344  *
0345  ******************************************************************************/
0346
0347 void ACPI_INTERNAL_VAR_XFACE
0348 AcpiBiosError (
0349     const char              *ModuleName,
0350     UINT32                  LineNumber,
0351     const char              *Format,
0352     ...)
0353 {
0354     va_list                 ArgList;
0355
0356
0357     ACPI_MSG_REDIRECT_BEGIN;
0358     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
0359
0360     va_start (ArgList, Format);
0361     AcpiOsVprintf (Format, ArgList);
0362     ACPI_MSG_SUFFIX;
0363     va_end (ArgList);
0364
0365     ACPI_MSG_REDIRECT_END;
0366 }
0367
0368 ACPI_EXPORT_SYMBOL (AcpiBiosError)
0369
0370
0371 /*******************************************************************************
0372  *
0373  * FUNCTION:    AcpiBiosException
0374  *
0375  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0376  *              LineNumber          - Caller's line number (for error output)
0377  *              Status              - Status value to be decoded/formatted
0378  *              Format              - Printf format string + additional args
0379  *
0380  * RETURN:      None
0381  *
0382  * DESCRIPTION: Print an "ACPI Firmware Error" message with module/line/version
0383  *              info as well as decoded ACPI_STATUS.
0384  *
0385  ******************************************************************************/
0386
0387 void ACPI_INTERNAL_VAR_XFACE
0388 AcpiBiosException (
0389     const char              *ModuleName,
0390     UINT32                  LineNumber,
0391     ACPI_STATUS             Status,
0392     const char              *Format,
0393     ...)
0394 {
0395     va_list                 ArgList;
0396
0397
0398     ACPI_MSG_REDIRECT_BEGIN;
0399
0400     /* For AE_OK, just print the message */
0401
0402     if (ACPI_SUCCESS (Status))
0403     {
0404         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
0405
0406     }
0407     else
0408     {
0409         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s, ",
0410             AcpiFormatException (Status));
0411     }
0412
0413     va_start (ArgList, Format);
0414     AcpiOsVprintf (Format, ArgList);
0415     ACPI_MSG_SUFFIX;
0416     va_end (ArgList);
0417
0418     ACPI_MSG_REDIRECT_END;
0419 }
0420
0421 ACPI_EXPORT_SYMBOL (AcpiBiosException)
0422
0423
0424 /*******************************************************************************
0425  *
0426  * FUNCTION:    AcpiBiosWarning
0427  *
0428  * PARAMETERS:  ModuleName          - Caller's module name (for warning output)
0429  *              LineNumber          - Caller's line number (for warning output)
0430  *              Format              - Printf format string + additional args
0431  *
0432  * RETURN:      None
0433  *
0434  * DESCRIPTION: Print "ACPI Firmware Warning" message with module/line/version
0435  *              info
0436  *
0437  ******************************************************************************/
0438
0439 void ACPI_INTERNAL_VAR_XFACE
0440 AcpiBiosWarning (
0441     const char              *ModuleName,
0442     UINT32                  LineNumber,
0443     const char              *Format,
0444     ...)
0445 {
0446     va_list                 ArgList;
0447
0448
0449     ACPI_MSG_REDIRECT_BEGIN;
0450     AcpiOsPrintf (ACPI_MSG_BIOS_WARNING);
0451
0452     va_start (ArgList, Format);
0453     AcpiOsVprintf (Format, ArgList);
0454     ACPI_MSG_SUFFIX;
0455     va_end (ArgList);
0456
0457     ACPI_MSG_REDIRECT_END;
0458 }
0459
0460 ACPI_EXPORT_SYMBOL (AcpiBiosWarning)
0461
0462 #endif /* ACPI_NO_ERROR_MESSAGES */