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