xref: /freebsd/sys/contrib/dev/acpica/components/parser/psopinfo.c (revision 2710751bc309af25c6dea1171781678258e83840)
1 /******************************************************************************
2  *
3  * Module Name: psopinfo - AML opcode information functions and dispatch tables
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2013, 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 
45 #include <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
47 #include <contrib/dev/acpica/include/acparser.h>
48 #include <contrib/dev/acpica/include/acopcode.h>
49 #include <contrib/dev/acpica/include/amlcode.h>
50 
51 
52 #define _COMPONENT          ACPI_PARSER
53         ACPI_MODULE_NAME    ("psopinfo")
54 
55 
56 extern const UINT8      AcpiGbl_ShortOpIndex[];
57 extern const UINT8      AcpiGbl_LongOpIndex[];
58 
59 static const UINT8      AcpiGbl_ArgumentCount[] = {0,1,1,1,1,2,2,2,2,3,3,6};
60 
61 
62 /*******************************************************************************
63  *
64  * FUNCTION:    AcpiPsGetOpcodeInfo
65  *
66  * PARAMETERS:  Opcode              - The AML opcode
67  *
68  * RETURN:      A pointer to the info about the opcode.
69  *
70  * DESCRIPTION: Find AML opcode description based on the opcode.
71  *              NOTE: This procedure must ALWAYS return a valid pointer!
72  *
73  ******************************************************************************/
74 
75 const ACPI_OPCODE_INFO *
76 AcpiPsGetOpcodeInfo (
77     UINT16                  Opcode)
78 {
79     ACPI_FUNCTION_NAME (PsGetOpcodeInfo);
80 
81 
82     /*
83      * Detect normal 8-bit opcode or extended 16-bit opcode
84      */
85     if (!(Opcode & 0xFF00))
86     {
87         /* Simple (8-bit) opcode: 0-255, can't index beyond table  */
88 
89         return (&AcpiGbl_AmlOpInfo [AcpiGbl_ShortOpIndex [(UINT8) Opcode]]);
90     }
91 
92     if (((Opcode & 0xFF00) == AML_EXTENDED_OPCODE) &&
93         (((UINT8) Opcode) <= MAX_EXTENDED_OPCODE))
94     {
95         /* Valid extended (16-bit) opcode */
96 
97         return (&AcpiGbl_AmlOpInfo [AcpiGbl_LongOpIndex [(UINT8) Opcode]]);
98     }
99 
100     /* Unknown AML opcode */
101 
102     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
103         "Unknown AML opcode [%4.4X]\n", Opcode));
104 
105     return (&AcpiGbl_AmlOpInfo [_UNK]);
106 }
107 
108 
109 /*******************************************************************************
110  *
111  * FUNCTION:    AcpiPsGetOpcodeName
112  *
113  * PARAMETERS:  Opcode              - The AML opcode
114  *
115  * RETURN:      A pointer to the name of the opcode (ASCII String)
116  *              Note: Never returns NULL.
117  *
118  * DESCRIPTION: Translate an opcode into a human-readable string
119  *
120  ******************************************************************************/
121 
122 char *
123 AcpiPsGetOpcodeName (
124     UINT16                  Opcode)
125 {
126 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
127 
128     const ACPI_OPCODE_INFO  *Op;
129 
130 
131     Op = AcpiPsGetOpcodeInfo (Opcode);
132 
133     /* Always guaranteed to return a valid pointer */
134 
135     return (Op->Name);
136 
137 #else
138     return ("OpcodeName unavailable");
139 
140 #endif
141 }
142 
143 
144 /*******************************************************************************
145  *
146  * FUNCTION:    AcpiPsGetArgumentCount
147  *
148  * PARAMETERS:  OpType              - Type associated with the AML opcode
149  *
150  * RETURN:      Argument count
151  *
152  * DESCRIPTION: Obtain the number of expected arguments for an AML opcode
153  *
154  ******************************************************************************/
155 
156 UINT8
157 AcpiPsGetArgumentCount (
158     UINT32                  OpType)
159 {
160 
161     if (OpType <= AML_TYPE_EXEC_6A_0T_1R)
162     {
163         return (AcpiGbl_ArgumentCount[OpType]);
164     }
165 
166     return (0);
167 }
168 
169 
170 /*
171  * This table is directly indexed by the opcodes It returns
172  * an index into the opcode table (AcpiGbl_AmlOpInfo)
173  */
174 const UINT8 AcpiGbl_ShortOpIndex[256] =
175 {
176 /*              0     1     2     3     4     5     6     7  */
177 /*              8     9     A     B     C     D     E     F  */
178 /* 0x00 */    0x00, 0x01, _UNK, _UNK, _UNK, _UNK, 0x02, _UNK,
179 /* 0x08 */    0x03, _UNK, 0x04, 0x05, 0x06, 0x07, 0x6E, _UNK,
180 /* 0x10 */    0x08, 0x09, 0x0a, 0x6F, 0x0b, _UNK, _UNK, _UNK,
181 /* 0x18 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
182 /* 0x20 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
183 /* 0x28 */    _UNK, _UNK, _UNK, _UNK, _UNK, 0x63, _PFX, _PFX,
184 /* 0x30 */    0x67, 0x66, 0x68, 0x65, 0x69, 0x64, 0x6A, 0x7D,
185 /* 0x38 */    0x7F, 0x80, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
186 /* 0x40 */    _UNK, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
187 /* 0x48 */    _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
188 /* 0x50 */    _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC, _ASC,
189 /* 0x58 */    _ASC, _ASC, _ASC, _UNK, _PFX, _UNK, _PFX, _ASC,
190 /* 0x60 */    0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13,
191 /* 0x68 */    0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, _UNK,
192 /* 0x70 */    0x1b, 0x1c, 0x1d, 0x1e, 0x1f, 0x20, 0x21, 0x22,
193 /* 0x78 */    0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a,
194 /* 0x80 */    0x2b, 0x2c, 0x2d, 0x2e, 0x70, 0x71, 0x2f, 0x30,
195 /* 0x88 */    0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x72,
196 /* 0x90 */    0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x73, 0x74,
197 /* 0x98 */    0x75, 0x76, _UNK, _UNK, 0x77, 0x78, 0x79, 0x7A,
198 /* 0xA0 */    0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x60, 0x61,
199 /* 0xA8 */    0x62, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
200 /* 0xB0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
201 /* 0xB8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
202 /* 0xC0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
203 /* 0xC8 */    _UNK, _UNK, _UNK, _UNK, 0x44, _UNK, _UNK, _UNK,
204 /* 0xD0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
205 /* 0xD8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
206 /* 0xE0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
207 /* 0xE8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
208 /* 0xF0 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
209 /* 0xF8 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, 0x45,
210 };
211 
212 /*
213  * This table is indexed by the second opcode of the extended opcode
214  * pair. It returns an index into the opcode table (AcpiGbl_AmlOpInfo)
215  */
216 const UINT8 AcpiGbl_LongOpIndex[NUM_EXTENDED_OPCODE] =
217 {
218 /*              0     1     2     3     4     5     6     7  */
219 /*              8     9     A     B     C     D     E     F  */
220 /* 0x00 */    _UNK, 0x46, 0x47, _UNK, _UNK, _UNK, _UNK, _UNK,
221 /* 0x08 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
222 /* 0x10 */    _UNK, _UNK, 0x48, 0x49, _UNK, _UNK, _UNK, _UNK,
223 /* 0x18 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, 0x7B,
224 /* 0x20 */    0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51,
225 /* 0x28 */    0x52, 0x53, 0x54, _UNK, _UNK, _UNK, _UNK, _UNK,
226 /* 0x30 */    0x55, 0x56, 0x57, 0x7e, _UNK, _UNK, _UNK, _UNK,
227 /* 0x38 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
228 /* 0x40 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
229 /* 0x48 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
230 /* 0x50 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
231 /* 0x58 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
232 /* 0x60 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
233 /* 0x68 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
234 /* 0x70 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
235 /* 0x78 */    _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK, _UNK,
236 /* 0x80 */    0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
237 /* 0x88 */    0x7C,
238 };
239