psopinfo.c revision 281687 
1/******************************************************************************
2 *
3 * Module Name: psopinfo - AML opcode information functions and dispatch tables
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions, and the following disclaimer,
16 *    without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 *    substantially similar to the "NO WARRANTY" disclaimer below
19 *    ("Disclaimer") and any redistribution must be conditioned upon
20 *    including a substantially similar Disclaimer requirement for further
21 *    binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 *    of any contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include <contrib/dev/acpica/include/acpi.h>
45#include <contrib/dev/acpica/include/accommon.h>
46#include <contrib/dev/acpica/include/acparser.h>
47#include <contrib/dev/acpica/include/acopcode.h>
48#include <contrib/dev/acpica/include/amlcode.h>
49
50
51#define _COMPONENT          ACPI_PARSER
52        ACPI_MODULE_NAME    ("psopinfo")
53
54
55extern const UINT8      AcpiGbl_ShortOpIndex[];
56extern const UINT8      AcpiGbl_LongOpIndex[];
57
58static const UINT8      AcpiGbl_ArgumentCount[] = {0,1,1,1,1,2,2,2,2,3,3,6};
59
60
61/*******************************************************************************
62 *
63 * FUNCTION:    AcpiPsGetOpcodeInfo
64 *
65 * PARAMETERS:  Opcode              - The AML opcode
66 *
67 * RETURN:      A pointer to the info about the opcode.
68 *
69 * DESCRIPTION: Find AML opcode description based on the opcode.
70 *              NOTE: This procedure must ALWAYS return a valid pointer!
71 *
72 ******************************************************************************/
73
74const ACPI_OPCODE_INFO *
75AcpiPsGetOpcodeInfo (
76    UINT16                  Opcode)
77{
78#ifdef ACPI_DEBUG_OUTPUT
79    const char              *OpcodeName = "Unknown AML opcode";
80#endif
81
82    ACPI_FUNCTION_NAME (PsGetOpcodeInfo);
83
84
85    /*
86     * Detect normal 8-bit opcode or extended 16-bit opcode
87     */
88    if (!(Opcode & 0xFF00))
89    {
90        /* Simple (8-bit) opcode: 0-255, can't index beyond table  */
91
92        return (&AcpiGbl_AmlOpInfo [AcpiGbl_ShortOpIndex [(UINT8) Opcode]]);
93    }
94
95    if (((Opcode & 0xFF00) == AML_EXTENDED_OPCODE) &&
96        (((UINT8) Opcode) <= MAX_EXTENDED_OPCODE))
97    {
98        /* Valid extended (16-bit) opcode */
99
100        return (&AcpiGbl_AmlOpInfo [AcpiGbl_LongOpIndex [(UINT8) Opcode]]);
101    }
102
103#if defined ACPI_ASL_COMPILER && defined ACPI_DEBUG_OUTPUT
104#include <contrib/dev/acpica/compiler/asldefine.h>
105
106    switch (Opcode)
107    {
108    case AML_RAW_DATA_BYTE:
109        OpcodeName = "-Raw Data Byte-";
110        break;
111
112    case AML_RAW_DATA_WORD:
113        OpcodeName = "-Raw Data Word-";
114        break;
115
116    case AML_RAW_DATA_DWORD:
117        OpcodeName = "-Raw Data Dword-";
118        break;
119
120    case AML_RAW_DATA_QWORD:
121        OpcodeName = "-Raw Data Qword-";
122        break;
123
124    case AML_RAW_DATA_BUFFER:
125        OpcodeName = "-Raw Data Buffer-";
126        break;
127
128    case AML_RAW_DATA_CHAIN:
129        OpcodeName = "-Raw Data Buffer Chain-";
130        break;
131
132    case AML_PACKAGE_LENGTH:
133        OpcodeName = "-Package Length-";
134        break;
135
136    case AML_UNASSIGNED_OPCODE:
137        OpcodeName = "-Unassigned Opcode-";
138        break;
139
140    case AML_DEFAULT_ARG_OP:
141        OpcodeName = "-Default Arg-";
142        break;
143
144    default:
145        break;
146    }
147#endif
148
149    /* Unknown AML opcode */
150
151    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
152        "%s [%4.4X]\n", OpcodeName, Opcode));
153
154    return (&AcpiGbl_AmlOpInfo [_UNK]);
155}
156
157
158/*******************************************************************************
159 *
160 * FUNCTION:    AcpiPsGetOpcodeName
161 *
162 * PARAMETERS:  Opcode              - The AML opcode
163 *
164 * RETURN:      A pointer to the name of the opcode (ASCII String)
165 *              Note: Never returns NULL.
166 *
167 * DESCRIPTION: Translate an opcode into a human-readable string
168 *
169 ******************************************************************************/
170
171char *
172AcpiPsGetOpcodeName (
173    UINT16                  Opcode)
174{
175#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
176
177    const ACPI_OPCODE_INFO  *Op;
178
179
180    Op = AcpiPsGetOpcodeInfo (Opcode);
181
182    /* Always guaranteed to return a valid pointer */
183
184    return (Op->Name);
185
186#else
187    return ("OpcodeName unavailable");
188
189#endif
190}
191
192
193/*******************************************************************************
194 *
195 * FUNCTION:    AcpiPsGetArgumentCount
196 *
197 * PARAMETERS:  OpType              - Type associated with the AML opcode
198 *
199 * RETURN:      Argument count
200 *
201 * DESCRIPTION: Obtain the number of expected arguments for an AML opcode
202 *
203 ******************************************************************************/
204
205UINT8
206AcpiPsGetArgumentCount (
207    UINT32                  OpType)
208{
209
210    if (OpType <= AML_TYPE_EXEC_6A_0T_1R)
211    {
212        return (AcpiGbl_ArgumentCount[OpType]);
213    }
214
215    return (0);
216}
217
218
219/*
220 * This table is directly indexed by the opcodes It returns
221 * an index into the opcode table (AcpiGbl_AmlOpInfo)
222 */
223const UINT8 AcpiGbl_ShortOpIndex[256] =
224{
225/*              0     1     2     3     4     5     6     7  */
226/*              8     9     A     B     C     D     E     F  */
227/* 0x00 */    0x00, 0x01, _UNK, _UNK, _UNK, _UNK, 0x02, _UNK,
228/* 0x08 */    0x03, _UNK, 0x04, 0x05, 0x06, 0x07, 0x6E, _UNK,
229/* 0x10 */    0x08, 0x09, 0x0a, 0x6F, 0x0b, 0x81, _UNK, _UNK,
230/* 0x18 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
231/* 0x20 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
232/* 0x28 */    _UNK, _UNK, _UNK, _UNK, _UNK, 0x63, _PFX, _PFX,
233/* 0x30 */    0x67, 0x66, 0x68, 0x65, 0x69, 0x64, 0x6A, 0x7D,
234/* 0x38 */    0x7F, 0x80, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
235/* 0x40 */    _UNK, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
236/* 0x48 */    _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
237/* 0x50 */    _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
238/* 0x58 */    _ASC, _ASC, _ASC, _UNK, _PFX, _UNK, _PFX, _ASC,
239/* 0x60 */    0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13,
240/* 0x68 */    0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, _UNK,
241/* 0x70 */    0x1b, 0x1c, 0x1d, 0x1e, 0x1f, 0x20, 0x21, 0x22,
242/* 0x78 */    0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a,
243/* 0x80 */    0x2b, 0x2c, 0x2d, 0x2e, 0x70, 0x71, 0x2f, 0x30,
244/* 0x88 */    0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x72,
245/* 0x90 */    0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x73, 0x74,
246/* 0x98 */    0x75, 0x76, _UNK, _UNK, 0x77, 0x78, 0x79, 0x7A,
247/* 0xA0 */    0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x60, 0x61,
248/* 0xA8 */    0x62, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
249/* 0xB0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
250/* 0xB8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
251/* 0xC0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
252/* 0xC8 */    _UNK, _UNK, _UNK, _UNK, 0x44, _UNK, _UNK, _UNK,
253/* 0xD0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
254/* 0xD8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
255/* 0xE0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
256/* 0xE8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
257/* 0xF0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
258/* 0xF8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, 0x45,
259};
260
261/*
262 * This table is indexed by the second opcode of the extended opcode
263 * pair. It returns an index into the opcode table (AcpiGbl_AmlOpInfo)
264 */
265const UINT8 AcpiGbl_LongOpIndex[NUM_EXTENDED_OPCODE] =
266{
267/*              0     1     2     3     4     5     6     7  */
268/*              8     9     A     B     C     D     E     F  */
269/* 0x00 */    _UNK, 0x46, 0x47, _UNK, _UNK, _UNK, _UNK, _UNK,
270/* 0x08 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
271/* 0x10 */    _UNK, _UNK, 0x48, 0x49, _UNK, _UNK, _UNK, _UNK,
272/* 0x18 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, 0x7B,
273/* 0x20 */    0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51,
274/* 0x28 */    0x52, 0x53, 0x54, _UNK, _UNK, _UNK, _UNK, _UNK,
275/* 0x30 */    0x55, 0x56, 0x57, 0x7e, _UNK, _UNK, _UNK, _UNK,
276/* 0x38 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
277/* 0x40 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
278/* 0x48 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
279/* 0x50 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
280/* 0x58 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
281/* 0x60 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
282/* 0x68 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
283/* 0x70 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
284/* 0x78 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
285/* 0x80 */    0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
286/* 0x88 */    0x7C,
287};
288