xref: /freebsd/sys/contrib/dev/acpica/include/amlcode.h (revision 3f0275a0331d5d477f9d8dc5accbba3533ac4cbf)
1a9f12690SJung-uk Kim /******************************************************************************
2a9f12690SJung-uk Kim  *
3a9f12690SJung-uk Kim  * Name: amlcode.h - Definitions for AML, as included in "definition blocks"
4a9f12690SJung-uk Kim  *                   Declarations and definitions contained herein are derived
5a9f12690SJung-uk Kim  *                   directly from the ACPI specification.
6a9f12690SJung-uk Kim  *
7a9f12690SJung-uk Kim  *****************************************************************************/
8a9f12690SJung-uk Kim 
9d244b227SJung-uk Kim /*
10d244b227SJung-uk Kim  * Copyright (C) 2000 - 2011, Intel Corp.
11a9f12690SJung-uk Kim  * All rights reserved.
12a9f12690SJung-uk Kim  *
13d244b227SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
14d244b227SJung-uk Kim  * modification, are permitted provided that the following conditions
15d244b227SJung-uk Kim  * are met:
16d244b227SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
17d244b227SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
18d244b227SJung-uk Kim  *    without modification.
19d244b227SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
20d244b227SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
21d244b227SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
22d244b227SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
23d244b227SJung-uk Kim  *    binary redistribution.
24d244b227SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
25d244b227SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
26d244b227SJung-uk Kim  *    from this software without specific prior written permission.
27a9f12690SJung-uk Kim  *
28d244b227SJung-uk Kim  * Alternatively, this software may be distributed under the terms of the
29d244b227SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
30d244b227SJung-uk Kim  * Software Foundation.
31a9f12690SJung-uk Kim  *
32d244b227SJung-uk Kim  * NO WARRANTY
33d244b227SJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34d244b227SJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35d244b227SJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
36d244b227SJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37d244b227SJung-uk Kim  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38d244b227SJung-uk Kim  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39d244b227SJung-uk Kim  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40d244b227SJung-uk Kim  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41d244b227SJung-uk Kim  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42d244b227SJung-uk Kim  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43d244b227SJung-uk Kim  * POSSIBILITY OF SUCH DAMAGES.
44d244b227SJung-uk Kim  */
45a9f12690SJung-uk Kim 
46a9f12690SJung-uk Kim #ifndef __AMLCODE_H__
47a9f12690SJung-uk Kim #define __AMLCODE_H__
48a9f12690SJung-uk Kim 
49a9f12690SJung-uk Kim /* primary opcodes */
50a9f12690SJung-uk Kim 
51a9f12690SJung-uk Kim #define AML_NULL_CHAR               (UINT16) 0x00
52a9f12690SJung-uk Kim 
53a9f12690SJung-uk Kim #define AML_ZERO_OP                 (UINT16) 0x00
54a9f12690SJung-uk Kim #define AML_ONE_OP                  (UINT16) 0x01
55a9f12690SJung-uk Kim #define AML_UNASSIGNED              (UINT16) 0x02
56a9f12690SJung-uk Kim #define AML_ALIAS_OP                (UINT16) 0x06
57a9f12690SJung-uk Kim #define AML_NAME_OP                 (UINT16) 0x08
58a9f12690SJung-uk Kim #define AML_BYTE_OP                 (UINT16) 0x0a
59a9f12690SJung-uk Kim #define AML_WORD_OP                 (UINT16) 0x0b
60a9f12690SJung-uk Kim #define AML_DWORD_OP                (UINT16) 0x0c
61a9f12690SJung-uk Kim #define AML_STRING_OP               (UINT16) 0x0d
62a9f12690SJung-uk Kim #define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
63a9f12690SJung-uk Kim #define AML_SCOPE_OP                (UINT16) 0x10
64a9f12690SJung-uk Kim #define AML_BUFFER_OP               (UINT16) 0x11
65a9f12690SJung-uk Kim #define AML_PACKAGE_OP              (UINT16) 0x12
66a9f12690SJung-uk Kim #define AML_VAR_PACKAGE_OP          (UINT16) 0x13     /* ACPI 2.0 */
67a9f12690SJung-uk Kim #define AML_METHOD_OP               (UINT16) 0x14
68a9f12690SJung-uk Kim #define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
69a9f12690SJung-uk Kim #define AML_MULTI_NAME_PREFIX_OP    (UINT16) 0x2f
70a9f12690SJung-uk Kim #define AML_NAME_CHAR_SUBSEQ        (UINT16) 0x30
71a9f12690SJung-uk Kim #define AML_NAME_CHAR_FIRST         (UINT16) 0x41
72a9f12690SJung-uk Kim #define AML_EXTENDED_OP_PREFIX      (UINT16) 0x5b
73a9f12690SJung-uk Kim #define AML_ROOT_PREFIX             (UINT16) 0x5c
74a9f12690SJung-uk Kim #define AML_PARENT_PREFIX           (UINT16) 0x5e
75a9f12690SJung-uk Kim #define AML_LOCAL_OP                (UINT16) 0x60
76a9f12690SJung-uk Kim #define AML_LOCAL0                  (UINT16) 0x60
77a9f12690SJung-uk Kim #define AML_LOCAL1                  (UINT16) 0x61
78a9f12690SJung-uk Kim #define AML_LOCAL2                  (UINT16) 0x62
79a9f12690SJung-uk Kim #define AML_LOCAL3                  (UINT16) 0x63
80a9f12690SJung-uk Kim #define AML_LOCAL4                  (UINT16) 0x64
81a9f12690SJung-uk Kim #define AML_LOCAL5                  (UINT16) 0x65
82a9f12690SJung-uk Kim #define AML_LOCAL6                  (UINT16) 0x66
83a9f12690SJung-uk Kim #define AML_LOCAL7                  (UINT16) 0x67
84a9f12690SJung-uk Kim #define AML_ARG_OP                  (UINT16) 0x68
85a9f12690SJung-uk Kim #define AML_ARG0                    (UINT16) 0x68
86a9f12690SJung-uk Kim #define AML_ARG1                    (UINT16) 0x69
87a9f12690SJung-uk Kim #define AML_ARG2                    (UINT16) 0x6a
88a9f12690SJung-uk Kim #define AML_ARG3                    (UINT16) 0x6b
89a9f12690SJung-uk Kim #define AML_ARG4                    (UINT16) 0x6c
90a9f12690SJung-uk Kim #define AML_ARG5                    (UINT16) 0x6d
91a9f12690SJung-uk Kim #define AML_ARG6                    (UINT16) 0x6e
92a9f12690SJung-uk Kim #define AML_STORE_OP                (UINT16) 0x70
93a9f12690SJung-uk Kim #define AML_REF_OF_OP               (UINT16) 0x71
94a9f12690SJung-uk Kim #define AML_ADD_OP                  (UINT16) 0x72
95a9f12690SJung-uk Kim #define AML_CONCAT_OP               (UINT16) 0x73
96a9f12690SJung-uk Kim #define AML_SUBTRACT_OP             (UINT16) 0x74
97a9f12690SJung-uk Kim #define AML_INCREMENT_OP            (UINT16) 0x75
98a9f12690SJung-uk Kim #define AML_DECREMENT_OP            (UINT16) 0x76
99a9f12690SJung-uk Kim #define AML_MULTIPLY_OP             (UINT16) 0x77
100a9f12690SJung-uk Kim #define AML_DIVIDE_OP               (UINT16) 0x78
101a9f12690SJung-uk Kim #define AML_SHIFT_LEFT_OP           (UINT16) 0x79
102a9f12690SJung-uk Kim #define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
103a9f12690SJung-uk Kim #define AML_BIT_AND_OP              (UINT16) 0x7b
104a9f12690SJung-uk Kim #define AML_BIT_NAND_OP             (UINT16) 0x7c
105a9f12690SJung-uk Kim #define AML_BIT_OR_OP               (UINT16) 0x7d
106a9f12690SJung-uk Kim #define AML_BIT_NOR_OP              (UINT16) 0x7e
107a9f12690SJung-uk Kim #define AML_BIT_XOR_OP              (UINT16) 0x7f
108a9f12690SJung-uk Kim #define AML_BIT_NOT_OP              (UINT16) 0x80
109a9f12690SJung-uk Kim #define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
110a9f12690SJung-uk Kim #define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
111a9f12690SJung-uk Kim #define AML_DEREF_OF_OP             (UINT16) 0x83
112a9f12690SJung-uk Kim #define AML_CONCAT_RES_OP           (UINT16) 0x84     /* ACPI 2.0 */
113a9f12690SJung-uk Kim #define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
114a9f12690SJung-uk Kim #define AML_NOTIFY_OP               (UINT16) 0x86
115a9f12690SJung-uk Kim #define AML_SIZE_OF_OP              (UINT16) 0x87
116a9f12690SJung-uk Kim #define AML_INDEX_OP                (UINT16) 0x88
117a9f12690SJung-uk Kim #define AML_MATCH_OP                (UINT16) 0x89
118a9f12690SJung-uk Kim #define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
119a9f12690SJung-uk Kim #define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
120a9f12690SJung-uk Kim #define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
121a9f12690SJung-uk Kim #define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
122a9f12690SJung-uk Kim #define AML_TYPE_OP                 (UINT16) 0x8e
123a9f12690SJung-uk Kim #define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
124a9f12690SJung-uk Kim #define AML_LAND_OP                 (UINT16) 0x90
125a9f12690SJung-uk Kim #define AML_LOR_OP                  (UINT16) 0x91
126a9f12690SJung-uk Kim #define AML_LNOT_OP                 (UINT16) 0x92
127a9f12690SJung-uk Kim #define AML_LEQUAL_OP               (UINT16) 0x93
128a9f12690SJung-uk Kim #define AML_LGREATER_OP             (UINT16) 0x94
129a9f12690SJung-uk Kim #define AML_LLESS_OP                (UINT16) 0x95
130a9f12690SJung-uk Kim #define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
131a9f12690SJung-uk Kim #define AML_TO_DECSTRING_OP         (UINT16) 0x97     /* ACPI 2.0 */
132a9f12690SJung-uk Kim #define AML_TO_HEXSTRING_OP         (UINT16) 0x98     /* ACPI 2.0 */
133a9f12690SJung-uk Kim #define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
134a9f12690SJung-uk Kim #define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
135a9f12690SJung-uk Kim #define AML_COPY_OP                 (UINT16) 0x9d     /* ACPI 2.0 */
136a9f12690SJung-uk Kim #define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
137a9f12690SJung-uk Kim #define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
138a9f12690SJung-uk Kim #define AML_IF_OP                   (UINT16) 0xa0
139a9f12690SJung-uk Kim #define AML_ELSE_OP                 (UINT16) 0xa1
140a9f12690SJung-uk Kim #define AML_WHILE_OP                (UINT16) 0xa2
141a9f12690SJung-uk Kim #define AML_NOOP_OP                 (UINT16) 0xa3
142a9f12690SJung-uk Kim #define AML_RETURN_OP               (UINT16) 0xa4
143a9f12690SJung-uk Kim #define AML_BREAK_OP                (UINT16) 0xa5
144a9f12690SJung-uk Kim #define AML_BREAK_POINT_OP          (UINT16) 0xcc
145a9f12690SJung-uk Kim #define AML_ONES_OP                 (UINT16) 0xff
146a9f12690SJung-uk Kim 
147a9f12690SJung-uk Kim /* prefixed opcodes */
148a9f12690SJung-uk Kim 
149a9f12690SJung-uk Kim #define AML_EXTENDED_OPCODE         (UINT16) 0x5b00     /* prefix for 2-byte opcodes */
150a9f12690SJung-uk Kim 
151a9f12690SJung-uk Kim #define AML_MUTEX_OP                (UINT16) 0x5b01
152a9f12690SJung-uk Kim #define AML_EVENT_OP                (UINT16) 0x5b02
153a9f12690SJung-uk Kim #define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10
154a9f12690SJung-uk Kim #define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11
155a9f12690SJung-uk Kim #define AML_COND_REF_OF_OP          (UINT16) 0x5b12
156a9f12690SJung-uk Kim #define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
157a9f12690SJung-uk Kim #define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
158a9f12690SJung-uk Kim #define AML_LOAD_OP                 (UINT16) 0x5b20
159a9f12690SJung-uk Kim #define AML_STALL_OP                (UINT16) 0x5b21
160a9f12690SJung-uk Kim #define AML_SLEEP_OP                (UINT16) 0x5b22
161a9f12690SJung-uk Kim #define AML_ACQUIRE_OP              (UINT16) 0x5b23
162a9f12690SJung-uk Kim #define AML_SIGNAL_OP               (UINT16) 0x5b24
163a9f12690SJung-uk Kim #define AML_WAIT_OP                 (UINT16) 0x5b25
164a9f12690SJung-uk Kim #define AML_RESET_OP                (UINT16) 0x5b26
165a9f12690SJung-uk Kim #define AML_RELEASE_OP              (UINT16) 0x5b27
166a9f12690SJung-uk Kim #define AML_FROM_BCD_OP             (UINT16) 0x5b28
167a9f12690SJung-uk Kim #define AML_TO_BCD_OP               (UINT16) 0x5b29
168a9f12690SJung-uk Kim #define AML_UNLOAD_OP               (UINT16) 0x5b2a
169a9f12690SJung-uk Kim #define AML_REVISION_OP             (UINT16) 0x5b30
170a9f12690SJung-uk Kim #define AML_DEBUG_OP                (UINT16) 0x5b31
171a9f12690SJung-uk Kim #define AML_FATAL_OP                (UINT16) 0x5b32
172a9f12690SJung-uk Kim #define AML_TIMER_OP                (UINT16) 0x5b33     /* ACPI 3.0 */
173a9f12690SJung-uk Kim #define AML_REGION_OP               (UINT16) 0x5b80
174a9f12690SJung-uk Kim #define AML_FIELD_OP                (UINT16) 0x5b81
175a9f12690SJung-uk Kim #define AML_DEVICE_OP               (UINT16) 0x5b82
176a9f12690SJung-uk Kim #define AML_PROCESSOR_OP            (UINT16) 0x5b83
177a9f12690SJung-uk Kim #define AML_POWER_RES_OP            (UINT16) 0x5b84
178a9f12690SJung-uk Kim #define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
179a9f12690SJung-uk Kim #define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
180a9f12690SJung-uk Kim #define AML_BANK_FIELD_OP           (UINT16) 0x5b87
181a9f12690SJung-uk Kim #define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
182a9f12690SJung-uk Kim 
183a9f12690SJung-uk Kim 
184a9f12690SJung-uk Kim /*
185a9f12690SJung-uk Kim  * Combination opcodes (actually two one-byte opcodes)
186a9f12690SJung-uk Kim  * Used by the disassembler and iASL compiler
187a9f12690SJung-uk Kim  */
188a9f12690SJung-uk Kim #define AML_LGREATEREQUAL_OP        (UINT16) 0x9295
189a9f12690SJung-uk Kim #define AML_LLESSEQUAL_OP           (UINT16) 0x9294
190a9f12690SJung-uk Kim #define AML_LNOTEQUAL_OP            (UINT16) 0x9293
191a9f12690SJung-uk Kim 
192a9f12690SJung-uk Kim 
193a9f12690SJung-uk Kim /*
194*3f0275a0SJung-uk Kim  * Opcodes for "Field" operators
195*3f0275a0SJung-uk Kim  */
196*3f0275a0SJung-uk Kim #define AML_FIELD_OFFSET_OP         (UINT8) 0x00
197*3f0275a0SJung-uk Kim #define AML_FIELD_ACCESS_OP         (UINT8) 0x01
198*3f0275a0SJung-uk Kim #define AML_FIELD_CONNECTION_OP     (UINT8) 0x02        /* ACPI 5.0 */
199*3f0275a0SJung-uk Kim #define AML_FIELD_EXT_ACCESS_OP     (UINT8) 0x03        /* ACPI 5.0 */
200*3f0275a0SJung-uk Kim 
201*3f0275a0SJung-uk Kim 
202*3f0275a0SJung-uk Kim /*
203a9f12690SJung-uk Kim  * Internal opcodes
204a9f12690SJung-uk Kim  * Use only "Unknown" AML opcodes, don't attempt to use
205a9f12690SJung-uk Kim  * any valid ACPI ASCII values (A-Z, 0-9, '-')
206a9f12690SJung-uk Kim  */
207a9f12690SJung-uk Kim #define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
208a9f12690SJung-uk Kim #define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
209a9f12690SJung-uk Kim #define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
210a9f12690SJung-uk Kim #define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
211a9f12690SJung-uk Kim #define AML_INT_BYTELIST_OP         (UINT16) 0x0033
212a9f12690SJung-uk Kim #define AML_INT_STATICSTRING_OP     (UINT16) 0x0034
213a9f12690SJung-uk Kim #define AML_INT_METHODCALL_OP       (UINT16) 0x0035
214a9f12690SJung-uk Kim #define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
215a9f12690SJung-uk Kim #define AML_INT_EVAL_SUBTREE_OP     (UINT16) 0x0037
216*3f0275a0SJung-uk Kim #define AML_INT_CONNECTION_OP       (UINT16) 0x0038
217*3f0275a0SJung-uk Kim #define AML_INT_EXTACCESSFIELD_OP   (UINT16) 0x0039
218a9f12690SJung-uk Kim 
219a9f12690SJung-uk Kim #define ARG_NONE                    0x0
220a9f12690SJung-uk Kim 
221a9f12690SJung-uk Kim /*
222a9f12690SJung-uk Kim  * Argument types for the AML Parser
223a9f12690SJung-uk Kim  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
224a9f12690SJung-uk Kim  * There can be up to 31 unique argument types
225a9f12690SJung-uk Kim  * Zero is reserved as end-of-list indicator
226a9f12690SJung-uk Kim  */
227a9f12690SJung-uk Kim #define ARGP_BYTEDATA               0x01
228a9f12690SJung-uk Kim #define ARGP_BYTELIST               0x02
229a9f12690SJung-uk Kim #define ARGP_CHARLIST               0x03
230a9f12690SJung-uk Kim #define ARGP_DATAOBJ                0x04
231a9f12690SJung-uk Kim #define ARGP_DATAOBJLIST            0x05
232a9f12690SJung-uk Kim #define ARGP_DWORDDATA              0x06
233a9f12690SJung-uk Kim #define ARGP_FIELDLIST              0x07
234a9f12690SJung-uk Kim #define ARGP_NAME                   0x08
235a9f12690SJung-uk Kim #define ARGP_NAMESTRING             0x09
236a9f12690SJung-uk Kim #define ARGP_OBJLIST                0x0A
237a9f12690SJung-uk Kim #define ARGP_PKGLENGTH              0x0B
238a9f12690SJung-uk Kim #define ARGP_SUPERNAME              0x0C
239a9f12690SJung-uk Kim #define ARGP_TARGET                 0x0D
240a9f12690SJung-uk Kim #define ARGP_TERMARG                0x0E
241a9f12690SJung-uk Kim #define ARGP_TERMLIST               0x0F
242a9f12690SJung-uk Kim #define ARGP_WORDDATA               0x10
243a9f12690SJung-uk Kim #define ARGP_QWORDDATA              0x11
244a9f12690SJung-uk Kim #define ARGP_SIMPLENAME             0x12
245a9f12690SJung-uk Kim 
246a9f12690SJung-uk Kim /*
247a9f12690SJung-uk Kim  * Resolved argument types for the AML Interpreter
248a9f12690SJung-uk Kim  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
249a9f12690SJung-uk Kim  * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
250a9f12690SJung-uk Kim  *
251a9f12690SJung-uk Kim  * Note1: These values are completely independent from the ACPI_TYPEs
252a9f12690SJung-uk Kim  *        i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
253a9f12690SJung-uk Kim  *
254a9f12690SJung-uk Kim  * Note2: If and when 5 bits becomes insufficient, it would probably be best
255a9f12690SJung-uk Kim  * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
256a9f12690SJung-uk Kim  */
257a9f12690SJung-uk Kim 
258a9f12690SJung-uk Kim /* Single, simple types */
259a9f12690SJung-uk Kim 
260a9f12690SJung-uk Kim #define ARGI_ANYTYPE                0x01    /* Don't care */
261a9f12690SJung-uk Kim #define ARGI_PACKAGE                0x02
262a9f12690SJung-uk Kim #define ARGI_EVENT                  0x03
263a9f12690SJung-uk Kim #define ARGI_MUTEX                  0x04
264a9f12690SJung-uk Kim #define ARGI_DDBHANDLE              0x05
265a9f12690SJung-uk Kim 
266a9f12690SJung-uk Kim /* Interchangeable types (via implicit conversion) */
267a9f12690SJung-uk Kim 
268a9f12690SJung-uk Kim #define ARGI_INTEGER                0x06
269a9f12690SJung-uk Kim #define ARGI_STRING                 0x07
270a9f12690SJung-uk Kim #define ARGI_BUFFER                 0x08
271a9f12690SJung-uk Kim #define ARGI_BUFFER_OR_STRING       0x09    /* Used by MID op only */
272a9f12690SJung-uk Kim #define ARGI_COMPUTEDATA            0x0A    /* Buffer, String, or Integer */
273a9f12690SJung-uk Kim 
274a9f12690SJung-uk Kim /* Reference objects */
275a9f12690SJung-uk Kim 
276a9f12690SJung-uk Kim #define ARGI_INTEGER_REF            0x0B
277a9f12690SJung-uk Kim #define ARGI_OBJECT_REF             0x0C
278a9f12690SJung-uk Kim #define ARGI_DEVICE_REF             0x0D
279a9f12690SJung-uk Kim #define ARGI_REFERENCE              0x0E
280a9f12690SJung-uk Kim #define ARGI_TARGETREF              0x0F    /* Target, subject to implicit conversion */
281a9f12690SJung-uk Kim #define ARGI_FIXED_TARGET           0x10    /* Target, no implicit conversion */
282a9f12690SJung-uk Kim #define ARGI_SIMPLE_TARGET          0x11    /* Name, Local, Arg -- no implicit conversion */
283a9f12690SJung-uk Kim 
284a9f12690SJung-uk Kim /* Multiple/complex types */
285a9f12690SJung-uk Kim 
286a9f12690SJung-uk Kim #define ARGI_DATAOBJECT             0x12    /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
287a9f12690SJung-uk Kim #define ARGI_COMPLEXOBJ             0x13    /* Buffer, String, or package (Used by INDEX op only) */
288a9f12690SJung-uk Kim #define ARGI_REF_OR_STRING          0x14    /* Reference or String (Used by DEREFOF op only) */
289a9f12690SJung-uk Kim #define ARGI_REGION_OR_BUFFER       0x15    /* Used by LOAD op only */
290a9f12690SJung-uk Kim #define ARGI_DATAREFOBJ             0x16
291a9f12690SJung-uk Kim 
292a9f12690SJung-uk Kim /* Note: types above can expand to 0x1F maximum */
293a9f12690SJung-uk Kim 
294a9f12690SJung-uk Kim #define ARGI_INVALID_OPCODE         0xFFFFFFFF
295a9f12690SJung-uk Kim 
296a9f12690SJung-uk Kim 
297a9f12690SJung-uk Kim /*
298a9f12690SJung-uk Kim  * hash offsets
299a9f12690SJung-uk Kim  */
300a9f12690SJung-uk Kim #define AML_EXTOP_HASH_OFFSET       22
301a9f12690SJung-uk Kim #define AML_LNOT_HASH_OFFSET        19
302a9f12690SJung-uk Kim 
303a9f12690SJung-uk Kim 
304a9f12690SJung-uk Kim /*
305a9f12690SJung-uk Kim  * opcode groups and types
306a9f12690SJung-uk Kim  */
307a9f12690SJung-uk Kim #define OPGRP_NAMED                 0x01
308a9f12690SJung-uk Kim #define OPGRP_FIELD                 0x02
309a9f12690SJung-uk Kim #define OPGRP_BYTELIST              0x04
310a9f12690SJung-uk Kim 
311a9f12690SJung-uk Kim 
312a9f12690SJung-uk Kim /*
313a9f12690SJung-uk Kim  * Opcode information
314a9f12690SJung-uk Kim  */
315a9f12690SJung-uk Kim 
316a9f12690SJung-uk Kim /* Opcode flags */
317a9f12690SJung-uk Kim 
318a9f12690SJung-uk Kim #define AML_LOGICAL                 0x0001
319a9f12690SJung-uk Kim #define AML_LOGICAL_NUMERIC         0x0002
320a9f12690SJung-uk Kim #define AML_MATH                    0x0004
321a9f12690SJung-uk Kim #define AML_CREATE                  0x0008
322a9f12690SJung-uk Kim #define AML_FIELD                   0x0010
323a9f12690SJung-uk Kim #define AML_DEFER                   0x0020
324a9f12690SJung-uk Kim #define AML_NAMED                   0x0040
325a9f12690SJung-uk Kim #define AML_NSNODE                  0x0080
326a9f12690SJung-uk Kim #define AML_NSOPCODE                0x0100
327a9f12690SJung-uk Kim #define AML_NSOBJECT                0x0200
328a9f12690SJung-uk Kim #define AML_HAS_RETVAL              0x0400
329a9f12690SJung-uk Kim #define AML_HAS_TARGET              0x0800
330a9f12690SJung-uk Kim #define AML_HAS_ARGS                0x1000
331a9f12690SJung-uk Kim #define AML_CONSTANT                0x2000
332a9f12690SJung-uk Kim #define AML_NO_OPERAND_RESOLVE      0x4000
333a9f12690SJung-uk Kim 
334a9f12690SJung-uk Kim /* Convenient flag groupings */
335a9f12690SJung-uk Kim 
336a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_0A_0T_1R                                     AML_HAS_RETVAL
337a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_1A_0T_0R     AML_HAS_ARGS                                   /* Monadic1  */
338a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_1A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Monadic2  */
339a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_1A_1T_0R     AML_HAS_ARGS | AML_HAS_TARGET
340a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_1A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */
341a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_2A_0T_0R     AML_HAS_ARGS                                   /* Dyadic1   */
342a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_2A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Dyadic2   */
343a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_2A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R  */
344a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_2A_2T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
345a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_3A_0T_0R     AML_HAS_ARGS
346a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_3A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
347a9f12690SJung-uk Kim #define AML_FLAGS_EXEC_6A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL
348a9f12690SJung-uk Kim 
349a9f12690SJung-uk Kim 
350a9f12690SJung-uk Kim /*
351a9f12690SJung-uk Kim  * The opcode Type is used in a dispatch table, do not change
352a9f12690SJung-uk Kim  * without updating the table.
353a9f12690SJung-uk Kim  */
354a9f12690SJung-uk Kim #define AML_TYPE_EXEC_0A_0T_1R      0x00
355a9f12690SJung-uk Kim #define AML_TYPE_EXEC_1A_0T_0R      0x01 /* Monadic1  */
356a9f12690SJung-uk Kim #define AML_TYPE_EXEC_1A_0T_1R      0x02 /* Monadic2  */
357a9f12690SJung-uk Kim #define AML_TYPE_EXEC_1A_1T_0R      0x03
358a9f12690SJung-uk Kim #define AML_TYPE_EXEC_1A_1T_1R      0x04 /* Monadic2R */
359a9f12690SJung-uk Kim #define AML_TYPE_EXEC_2A_0T_0R      0x05 /* Dyadic1   */
360a9f12690SJung-uk Kim #define AML_TYPE_EXEC_2A_0T_1R      0x06 /* Dyadic2   */
361a9f12690SJung-uk Kim #define AML_TYPE_EXEC_2A_1T_1R      0x07 /* Dyadic2R  */
362a9f12690SJung-uk Kim #define AML_TYPE_EXEC_2A_2T_1R      0x08
363a9f12690SJung-uk Kim #define AML_TYPE_EXEC_3A_0T_0R      0x09
364a9f12690SJung-uk Kim #define AML_TYPE_EXEC_3A_1T_1R      0x0A
365a9f12690SJung-uk Kim #define AML_TYPE_EXEC_6A_0T_1R      0x0B
366a9f12690SJung-uk Kim /* End of types used in dispatch table */
367a9f12690SJung-uk Kim 
368a9f12690SJung-uk Kim #define AML_TYPE_LITERAL            0x0B
369a9f12690SJung-uk Kim #define AML_TYPE_CONSTANT           0x0C
370a9f12690SJung-uk Kim #define AML_TYPE_METHOD_ARGUMENT    0x0D
371a9f12690SJung-uk Kim #define AML_TYPE_LOCAL_VARIABLE     0x0E
372a9f12690SJung-uk Kim #define AML_TYPE_DATA_TERM          0x0F
373a9f12690SJung-uk Kim 
374a9f12690SJung-uk Kim /* Generic for an op that returns a value */
375a9f12690SJung-uk Kim 
376a9f12690SJung-uk Kim #define AML_TYPE_METHOD_CALL        0x10
377a9f12690SJung-uk Kim 
378a9f12690SJung-uk Kim /* Misc */
379a9f12690SJung-uk Kim 
380a9f12690SJung-uk Kim #define AML_TYPE_CREATE_FIELD       0x11
381a9f12690SJung-uk Kim #define AML_TYPE_CREATE_OBJECT      0x12
382a9f12690SJung-uk Kim #define AML_TYPE_CONTROL            0x13
383a9f12690SJung-uk Kim #define AML_TYPE_NAMED_NO_OBJ       0x14
384a9f12690SJung-uk Kim #define AML_TYPE_NAMED_FIELD        0x15
385a9f12690SJung-uk Kim #define AML_TYPE_NAMED_SIMPLE       0x16
386a9f12690SJung-uk Kim #define AML_TYPE_NAMED_COMPLEX      0x17
387a9f12690SJung-uk Kim #define AML_TYPE_RETURN             0x18
388a9f12690SJung-uk Kim 
389a9f12690SJung-uk Kim #define AML_TYPE_UNDEFINED          0x19
390a9f12690SJung-uk Kim #define AML_TYPE_BOGUS              0x1A
391a9f12690SJung-uk Kim 
392a9f12690SJung-uk Kim /* AML Package Length encodings */
393a9f12690SJung-uk Kim 
394a9f12690SJung-uk Kim #define ACPI_AML_PACKAGE_TYPE1      0x40
395a9f12690SJung-uk Kim #define ACPI_AML_PACKAGE_TYPE2      0x4000
396a9f12690SJung-uk Kim #define ACPI_AML_PACKAGE_TYPE3      0x400000
397a9f12690SJung-uk Kim #define ACPI_AML_PACKAGE_TYPE4      0x40000000
398a9f12690SJung-uk Kim 
399a9f12690SJung-uk Kim /*
400a9f12690SJung-uk Kim  * Opcode classes
401a9f12690SJung-uk Kim  */
402a9f12690SJung-uk Kim #define AML_CLASS_EXECUTE           0x00
403a9f12690SJung-uk Kim #define AML_CLASS_CREATE            0x01
404a9f12690SJung-uk Kim #define AML_CLASS_ARGUMENT          0x02
405a9f12690SJung-uk Kim #define AML_CLASS_NAMED_OBJECT      0x03
406a9f12690SJung-uk Kim #define AML_CLASS_CONTROL           0x04
407a9f12690SJung-uk Kim #define AML_CLASS_ASCII             0x05
408a9f12690SJung-uk Kim #define AML_CLASS_PREFIX            0x06
409a9f12690SJung-uk Kim #define AML_CLASS_INTERNAL          0x07
410a9f12690SJung-uk Kim #define AML_CLASS_RETURN_VALUE      0x08
411a9f12690SJung-uk Kim #define AML_CLASS_METHOD_CALL       0x09
412a9f12690SJung-uk Kim #define AML_CLASS_UNKNOWN           0x0A
413a9f12690SJung-uk Kim 
414a9f12690SJung-uk Kim 
415a9f12690SJung-uk Kim /* Comparison operation codes for MatchOp operator */
416a9f12690SJung-uk Kim 
417a9f12690SJung-uk Kim typedef enum
418a9f12690SJung-uk Kim {
419a9f12690SJung-uk Kim     MATCH_MTR                       = 0,
420a9f12690SJung-uk Kim     MATCH_MEQ                       = 1,
421a9f12690SJung-uk Kim     MATCH_MLE                       = 2,
422a9f12690SJung-uk Kim     MATCH_MLT                       = 3,
423a9f12690SJung-uk Kim     MATCH_MGE                       = 4,
424a9f12690SJung-uk Kim     MATCH_MGT                       = 5
425a9f12690SJung-uk Kim 
426a9f12690SJung-uk Kim } AML_MATCH_OPERATOR;
427a9f12690SJung-uk Kim 
428a9f12690SJung-uk Kim #define MAX_MATCH_OPERATOR          5
429a9f12690SJung-uk Kim 
430a9f12690SJung-uk Kim 
431a9f12690SJung-uk Kim /*
432a9f12690SJung-uk Kim  * FieldFlags
433a9f12690SJung-uk Kim  *
434a9f12690SJung-uk Kim  * This byte is extracted from the AML and includes three separate
435a9f12690SJung-uk Kim  * pieces of information about the field:
436a9f12690SJung-uk Kim  * 1) The field access type
437a9f12690SJung-uk Kim  * 2) The field update rule
438a9f12690SJung-uk Kim  * 3) The lock rule for the field
439a9f12690SJung-uk Kim  *
440a9f12690SJung-uk Kim  * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
441a9f12690SJung-uk Kim  *      04      : LockRule (1 == Lock)
442a9f12690SJung-uk Kim  *      05 - 06 : UpdateRule
443a9f12690SJung-uk Kim  */
444a9f12690SJung-uk Kim #define AML_FIELD_ACCESS_TYPE_MASK  0x0F
445a9f12690SJung-uk Kim #define AML_FIELD_LOCK_RULE_MASK    0x10
446a9f12690SJung-uk Kim #define AML_FIELD_UPDATE_RULE_MASK  0x60
447a9f12690SJung-uk Kim 
448a9f12690SJung-uk Kim 
449a9f12690SJung-uk Kim /* 1) Field Access Types */
450a9f12690SJung-uk Kim 
451a9f12690SJung-uk Kim typedef enum
452a9f12690SJung-uk Kim {
453a9f12690SJung-uk Kim     AML_FIELD_ACCESS_ANY            = 0x00,
454a9f12690SJung-uk Kim     AML_FIELD_ACCESS_BYTE           = 0x01,
455a9f12690SJung-uk Kim     AML_FIELD_ACCESS_WORD           = 0x02,
456a9f12690SJung-uk Kim     AML_FIELD_ACCESS_DWORD          = 0x03,
457a9f12690SJung-uk Kim     AML_FIELD_ACCESS_QWORD          = 0x04,    /* ACPI 2.0 */
458a9f12690SJung-uk Kim     AML_FIELD_ACCESS_BUFFER         = 0x05     /* ACPI 2.0 */
459a9f12690SJung-uk Kim 
460a9f12690SJung-uk Kim } AML_ACCESS_TYPE;
461a9f12690SJung-uk Kim 
462a9f12690SJung-uk Kim 
463a9f12690SJung-uk Kim /* 2) Field Lock Rules */
464a9f12690SJung-uk Kim 
465a9f12690SJung-uk Kim typedef enum
466a9f12690SJung-uk Kim {
467a9f12690SJung-uk Kim     AML_FIELD_LOCK_NEVER            = 0x00,
468a9f12690SJung-uk Kim     AML_FIELD_LOCK_ALWAYS           = 0x10
469a9f12690SJung-uk Kim 
470a9f12690SJung-uk Kim } AML_LOCK_RULE;
471a9f12690SJung-uk Kim 
472a9f12690SJung-uk Kim 
473a9f12690SJung-uk Kim /* 3) Field Update Rules */
474a9f12690SJung-uk Kim 
475a9f12690SJung-uk Kim typedef enum
476a9f12690SJung-uk Kim {
477a9f12690SJung-uk Kim     AML_FIELD_UPDATE_PRESERVE       = 0x00,
478a9f12690SJung-uk Kim     AML_FIELD_UPDATE_WRITE_AS_ONES  = 0x20,
479a9f12690SJung-uk Kim     AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
480a9f12690SJung-uk Kim 
481a9f12690SJung-uk Kim } AML_UPDATE_RULE;
482a9f12690SJung-uk Kim 
483a9f12690SJung-uk Kim 
484a9f12690SJung-uk Kim /*
485a9f12690SJung-uk Kim  * Field Access Attributes.
486a9f12690SJung-uk Kim  * This byte is extracted from the AML via the
487a9f12690SJung-uk Kim  * AccessAs keyword
488a9f12690SJung-uk Kim  */
489a9f12690SJung-uk Kim typedef enum
490a9f12690SJung-uk Kim {
491*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_QUICK          = 0x02,
492*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_SEND_RCV       = 0x04,
493*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_BYTE           = 0x06,
494*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_WORD           = 0x08,
495*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_BLOCK          = 0x0A,
496*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_MULTIBYTE      = 0x0B,
497*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_WORD_CALL      = 0x0C,
498*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_BLOCK_CALL     = 0x0D,
499*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_RAW_BYTES      = 0x0E,
500*3f0275a0SJung-uk Kim     AML_FIELD_ATTRIB_RAW_PROCESS    = 0x0F
501a9f12690SJung-uk Kim 
502a9f12690SJung-uk Kim } AML_ACCESS_ATTRIBUTE;
503a9f12690SJung-uk Kim 
504a9f12690SJung-uk Kim 
505d244b227SJung-uk Kim /* Bit fields in the AML MethodFlags byte */
506a9f12690SJung-uk Kim 
507a9f12690SJung-uk Kim #define AML_METHOD_ARG_COUNT        0x07
508a9f12690SJung-uk Kim #define AML_METHOD_SERIALIZED       0x08
509a9f12690SJung-uk Kim #define AML_METHOD_SYNC_LEVEL       0xF0
510a9f12690SJung-uk Kim 
511a9f12690SJung-uk Kim 
512a9f12690SJung-uk Kim #endif /* __AMLCODE_H__ */
513