src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utexcep.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: utexcep - Exception code support
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, 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
 117 #define __UTEXCEP_C__
 118 #define EXPORT_ACPI_INTERFACES
 119
 120 #define ACPI_DEFINE_EXCEPTION_TABLE
 121 #include "acpi.h"
 122 #include "accommon.h"
 123
 124
 125 #define _COMPONENT          ACPI_UTILITIES
 126         ACPI_MODULE_NAME    ("utexcep")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiFormatException
 132  *
 133  * PARAMETERS:  Status              - The ACPI_STATUS code to be formatted
 134  *
 135  * RETURN:      A string containing the exception text. A valid pointer is
 136  *              always returned.
 137  *
 138  * DESCRIPTION: This function translates an ACPI exception into an ASCII
 139  *              string. Returns "unknown status" string for invalid codes.
 140  *
 141  ******************************************************************************/
 142
 143 const char *
 144 AcpiFormatException (
 145     ACPI_STATUS             Status)
 146 {
 147     const ACPI_EXCEPTION_INFO   *Exception;
 148
 149
 150     ACPI_FUNCTION_ENTRY ();
 151
 152
 153     Exception = AcpiUtValidateException (Status);
 154     if (!Exception)
 155     {
 156         /* Exception code was not recognized */
 157
 158         ACPI_ERROR ((AE_INFO,
 159             "Unknown exception code: 0x%8.8X", Status));
 160
 161         return ("UNKNOWN_STATUS_CODE");
 162     }
 163
 164     return (Exception->Name);
 165 }
 166
 167 ACPI_EXPORT_SYMBOL (AcpiFormatException)
 168
 169
 170 /*******************************************************************************
 171  *
 172  * FUNCTION:    AcpiUtValidateException
 173  *
 174  * PARAMETERS:  Status              - The ACPI_STATUS code to be formatted
 175  *
 176  * RETURN:      A string containing the exception text. NULL if exception is
 177  *              not valid.
 178  *
 179  * DESCRIPTION: This function validates and translates an ACPI exception into
 180  *              an ASCII string.
 181  *
 182  ******************************************************************************/
 183
 184 const ACPI_EXCEPTION_INFO *
 185 AcpiUtValidateException (
 186     ACPI_STATUS             Status)
 187 {
 188     UINT32                      SubStatus;
 189     const ACPI_EXCEPTION_INFO   *Exception = NULL;
 190
 191
 192     ACPI_FUNCTION_ENTRY ();
 193
 194
 195     /*
 196      * Status is composed of two parts, a "type" and an actual code
 197      */
 198     SubStatus = (Status & ~AE_CODE_MASK);
 199
 200     switch (Status & AE_CODE_MASK)
 201     {
 202     case AE_CODE_ENVIRONMENTAL:
 203
 204         if (SubStatus <= AE_CODE_ENV_MAX)
 205         {
 206             Exception = &AcpiGbl_ExceptionNames_Env [SubStatus];
 207         }
 208         break;
 209
 210     case AE_CODE_PROGRAMMER:
 211
 212         if (SubStatus <= AE_CODE_PGM_MAX)
 213         {
 214             Exception = &AcpiGbl_ExceptionNames_Pgm [SubStatus];
 215         }
 216         break;
 217
 218     case AE_CODE_ACPI_TABLES:
 219
 220         if (SubStatus <= AE_CODE_TBL_MAX)
 221         {
 222             Exception = &AcpiGbl_ExceptionNames_Tbl [SubStatus];
 223         }
 224         break;
 225
 226     case AE_CODE_AML:
 227
 228         if (SubStatus <= AE_CODE_AML_MAX)
 229         {
 230             Exception = &AcpiGbl_ExceptionNames_Aml [SubStatus];
 231         }
 232         break;
 233
 234     case AE_CODE_CONTROL:
 235
 236         if (SubStatus <= AE_CODE_CTRL_MAX)
 237         {
 238             Exception = &AcpiGbl_ExceptionNames_Ctrl [SubStatus];
 239         }
 240         break;
 241
 242     default:
 243
 244         break;
 245     }
 246
 247     if (!Exception || !Exception->Name)
 248     {
 249         return (NULL);
 250     }
 251
 252     return (Exception);
 253 }