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