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