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