reactos/drivers/bus/acpi/acpica/parser/psopinfo.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psopinfo - AML opcode information functions and dispatch tables
   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 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "acparser.h"
 120 #include "acopcode.h"
 121 #include "amlcode.h"
 122
 123
 124 #define _COMPONENT          ACPI_PARSER
 125         ACPI_MODULE_NAME    ("psopinfo")
 126
 127
 128 extern const UINT8      AcpiGbl_ShortOpIndex[];
 129 extern const UINT8      AcpiGbl_LongOpIndex[];
 130
 131 static const UINT8      AcpiGbl_ArgumentCount[] = {0,1,1,1,1,2,2,2,2,3,3,6};
 132
 133
 134 /*******************************************************************************
 135  *
 136  * FUNCTION:    AcpiPsGetOpcodeInfo
 137  *
 138  * PARAMETERS:  Opcode              - The AML opcode
 139  *
 140  * RETURN:      A pointer to the info about the opcode.
 141  *
 142  * DESCRIPTION: Find AML opcode description based on the opcode.
 143  *              NOTE: This procedure must ALWAYS return a valid pointer!
 144  *
 145  ******************************************************************************/
 146
 147 const ACPI_OPCODE_INFO *
 148 AcpiPsGetOpcodeInfo (
 149     UINT16                  Opcode)
 150 {
 151 #ifdef ACPI_DEBUG_OUTPUT
 152     const char              *OpcodeName = "Unknown AML opcode";
 153 #endif
 154
 155     ACPI_FUNCTION_NAME (PsGetOpcodeInfo);
 156
 157
 158     /*
 159      * Detect normal 8-bit opcode or extended 16-bit opcode
 160      */
 161     if (!(Opcode & 0xFF00))
 162     {
 163         /* Simple (8-bit) opcode: 0-255, can't index beyond table  */
 164
 165         return (&AcpiGbl_AmlOpInfo [AcpiGbl_ShortOpIndex [(UINT8) Opcode]]);
 166     }
 167
 168     if (((Opcode & 0xFF00) == AML_EXTENDED_OPCODE) &&
 169         (((UINT8) Opcode) <= MAX_EXTENDED_OPCODE))
 170     {
 171         /* Valid extended (16-bit) opcode */
 172
 173         return (&AcpiGbl_AmlOpInfo [AcpiGbl_LongOpIndex [(UINT8) Opcode]]);
 174     }
 175
 176 #if defined ACPI_ASL_COMPILER && defined ACPI_DEBUG_OUTPUT
 177 #include "asldefine.h"
 178
 179     switch (Opcode)
 180     {
 181     case AML_RAW_DATA_BYTE:
 182         OpcodeName = "-Raw Data Byte-";
 183         break;
 184
 185     case AML_RAW_DATA_WORD:
 186         OpcodeName = "-Raw Data Word-";
 187         break;
 188
 189     case AML_RAW_DATA_DWORD:
 190         OpcodeName = "-Raw Data Dword-";
 191         break;
 192
 193     case AML_RAW_DATA_QWORD:
 194         OpcodeName = "-Raw Data Qword-";
 195         break;
 196
 197     case AML_RAW_DATA_BUFFER:
 198         OpcodeName = "-Raw Data Buffer-";
 199         break;
 200
 201     case AML_RAW_DATA_CHAIN:
 202         OpcodeName = "-Raw Data Buffer Chain-";
 203         break;
 204
 205     case AML_PACKAGE_LENGTH:
 206         OpcodeName = "-Package Length-";
 207         break;
 208
 209     case AML_UNASSIGNED_OPCODE:
 210         OpcodeName = "-Unassigned Opcode-";
 211         break;
 212
 213     case AML_DEFAULT_ARG_OP:
 214         OpcodeName = "-Default Arg-";
 215         break;
 216
 217     default:
 218         break;
 219     }
 220 #endif
 221
 222     /* Unknown AML opcode */
 223
 224     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 225         "%s [%4.4X]\n", OpcodeName, Opcode));
 226
 227     return (&AcpiGbl_AmlOpInfo [_UNK]);
 228 }
 229
 230
 231 /*******************************************************************************
 232  *
 233  * FUNCTION:    AcpiPsGetOpcodeName
 234  *
 235  * PARAMETERS:  Opcode              - The AML opcode
 236  *
 237  * RETURN:      A pointer to the name of the opcode (ASCII String)
 238  *              Note: Never returns NULL.
 239  *
 240  * DESCRIPTION: Translate an opcode into a human-readable string
 241  *
 242  ******************************************************************************/
 243
 244 char *
 245 AcpiPsGetOpcodeName (
 246     UINT16                  Opcode)
 247 {
 248 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
 249
 250     const ACPI_OPCODE_INFO  *Op;
 251
 252
 253     Op = AcpiPsGetOpcodeInfo (Opcode);
 254
 255     /* Always guaranteed to return a valid pointer */
 256
 257     return (Op->Name);
 258
 259 #else
 260     return ("OpcodeName unavailable");
 261
 262 #endif
 263 }
 264
 265
 266 /*******************************************************************************
 267  *
 268  * FUNCTION:    AcpiPsGetArgumentCount
 269  *
 270  * PARAMETERS:  OpType              - Type associated with the AML opcode
 271  *
 272  * RETURN:      Argument count
 273  *
 274  * DESCRIPTION: Obtain the number of expected arguments for an AML opcode
 275  *
 276  ******************************************************************************/
 277
 278 UINT8
 279 AcpiPsGetArgumentCount (
 280     UINT32                  OpType)
 281 {
 282
 283     if (OpType <= AML_TYPE_EXEC_6A_0T_1R)
 284     {
 285         return (AcpiGbl_ArgumentCount[OpType]);
 286     }
 287
 288     return (0);
 289 }
 290
 291
 292 /*
 293  * This table is directly indexed by the opcodes It returns
 294  * an index into the opcode table (AcpiGbl_AmlOpInfo)
 295  */
 296 const UINT8 AcpiGbl_ShortOpIndex[256] =
 297 {
 298 /*              0     1     2     3     4     5     6     7  */
 299 /*              8     9     A     B     C     D     E     F  */
 300 /* 0x00 */    0x00, 0x01, _UNK, _UNK, _UNK, _UNK, 0x02, _UNK,
 301 /* 0x08 */    0x03, _UNK, 0x04, 0x05, 0x06, 0x07, 0x6E, _UNK,
 302 /* 0x10 */    0x08, 0x09, 0x0a, 0x6F, 0x0b, _UNK, _UNK, _UNK,
 303 /* 0x18 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 304 /* 0x20 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 305 /* 0x28 */    _UNK, _UNK, _UNK, _UNK, _UNK, 0x63, _PFX, _PFX,
 306 /* 0x30 */    0x67, 0x66, 0x68, 0x65, 0x69, 0x64, 0x6A, 0x7D,
 307 /* 0x38 */    0x7F, 0x80, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 308 /* 0x40 */    _UNK, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
 309 /* 0x48 */    _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
 310 /* 0x50 */    _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
 311 /* 0x58 */    _ASC, _ASC, _ASC, _UNK, _PFX, _UNK, _PFX, _ASC,
 312 /* 0x60 */    0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13,
 313 /* 0x68 */    0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, _UNK,
 314 /* 0x70 */    0x1b, 0x1c, 0x1d, 0x1e, 0x1f, 0x20, 0x21, 0x22,
 315 /* 0x78 */    0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a,
 316 /* 0x80 */    0x2b, 0x2c, 0x2d, 0x2e, 0x70, 0x71, 0x2f, 0x30,
 317 /* 0x88 */    0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x72,
 318 /* 0x90 */    0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x73, 0x74,
 319 /* 0x98 */    0x75, 0x76, _UNK, _UNK, 0x77, 0x78, 0x79, 0x7A,
 320 /* 0xA0 */    0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x60, 0x61,
 321 /* 0xA8 */    0x62, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 322 /* 0xB0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 323 /* 0xB8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 324 /* 0xC0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 325 /* 0xC8 */    _UNK, _UNK, _UNK, _UNK, 0x44, _UNK, _UNK, _UNK,
 326 /* 0xD0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 327 /* 0xD8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 328 /* 0xE0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 329 /* 0xE8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 330 /* 0xF0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 331 /* 0xF8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, 0x45,
 332 };
 333
 334 /*
 335  * This table is indexed by the second opcode of the extended opcode
 336  * pair. It returns an index into the opcode table (AcpiGbl_AmlOpInfo)
 337  */
 338 const UINT8 AcpiGbl_LongOpIndex[NUM_EXTENDED_OPCODE] =
 339 {
 340 /*              0     1     2     3     4     5     6     7  */
 341 /*              8     9     A     B     C     D     E     F  */
 342 /* 0x00 */    _UNK, 0x46, 0x47, _UNK, _UNK, _UNK, _UNK, _UNK,
 343 /* 0x08 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 344 /* 0x10 */    _UNK, _UNK, 0x48, 0x49, _UNK, _UNK, _UNK, _UNK,
 345 /* 0x18 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, 0x7B,
 346 /* 0x20 */    0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51,
 347 /* 0x28 */    0x52, 0x53, 0x54, _UNK, _UNK, _UNK, _UNK, _UNK,
 348 /* 0x30 */    0x55, 0x56, 0x57, 0x7e, _UNK, _UNK, _UNK, _UNK,
 349 /* 0x38 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 350 /* 0x40 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 351 /* 0x48 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 352 /* 0x50 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 353 /* 0x58 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 354 /* 0x60 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 355 /* 0x68 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 356 /* 0x70 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 357 /* 0x78 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
 358 /* 0x80 */    0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
 359 /* 0x88 */    0x7C,
 360 };