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