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 *
11 * 1. Copyright Notice
12 *
13 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
14 * All rights reserved.
15 *
16 * 2. License
17 *
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
21 * property rights.
22 *
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
29 *
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
38 *
39 * The above copyright and patent license is granted only if the following
40 * conditions are met:
41 *
42 * 3. Conditions
43 *
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
55 *
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
66 * make.
67 *
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
72 * distribution.
73 *
74 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * Intel Code.
76 *
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
81 *
82 * 4. Disclaimer and Export Compliance
83 *
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118#ifndef __AMLCODE_H__
119#define __AMLCODE_H__
120
121/* primary opcodes */
122
123#define AML_NULL_CHAR               (UINT16) 0x00
124
125#define AML_ZERO_OP                 (UINT16) 0x00
126#define AML_ONE_OP                  (UINT16) 0x01
127#define AML_UNASSIGNED              (UINT16) 0x02
128#define AML_ALIAS_OP                (UINT16) 0x06
129#define AML_NAME_OP                 (UINT16) 0x08
130#define AML_BYTE_OP                 (UINT16) 0x0a
131#define AML_WORD_OP                 (UINT16) 0x0b
132#define AML_DWORD_OP                (UINT16) 0x0c
133#define AML_STRING_OP               (UINT16) 0x0d
134#define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
135#define AML_SCOPE_OP                (UINT16) 0x10
136#define AML_BUFFER_OP               (UINT16) 0x11
137#define AML_PACKAGE_OP              (UINT16) 0x12
138#define AML_VAR_PACKAGE_OP          (UINT16) 0x13     /* ACPI 2.0 */
139#define AML_METHOD_OP               (UINT16) 0x14
140#define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
141#define AML_MULTI_NAME_PREFIX_OP    (UINT16) 0x2f
142#define AML_NAME_CHAR_SUBSEQ        (UINT16) 0x30
143#define AML_NAME_CHAR_FIRST         (UINT16) 0x41
144#define AML_EXTENDED_OP_PREFIX      (UINT16) 0x5b
145#define AML_ROOT_PREFIX             (UINT16) 0x5c
146#define AML_PARENT_PREFIX           (UINT16) 0x5e
147#define AML_LOCAL_OP                (UINT16) 0x60
148#define AML_LOCAL0                  (UINT16) 0x60
149#define AML_LOCAL1                  (UINT16) 0x61
150#define AML_LOCAL2                  (UINT16) 0x62
151#define AML_LOCAL3                  (UINT16) 0x63
152#define AML_LOCAL4                  (UINT16) 0x64
153#define AML_LOCAL5                  (UINT16) 0x65
154#define AML_LOCAL6                  (UINT16) 0x66
155#define AML_LOCAL7                  (UINT16) 0x67
156#define AML_ARG_OP                  (UINT16) 0x68
157#define AML_ARG0                    (UINT16) 0x68
158#define AML_ARG1                    (UINT16) 0x69
159#define AML_ARG2                    (UINT16) 0x6a
160#define AML_ARG3                    (UINT16) 0x6b
161#define AML_ARG4                    (UINT16) 0x6c
162#define AML_ARG5                    (UINT16) 0x6d
163#define AML_ARG6                    (UINT16) 0x6e
164#define AML_STORE_OP                (UINT16) 0x70
165#define AML_REF_OF_OP               (UINT16) 0x71
166#define AML_ADD_OP                  (UINT16) 0x72
167#define AML_CONCAT_OP               (UINT16) 0x73
168#define AML_SUBTRACT_OP             (UINT16) 0x74
169#define AML_INCREMENT_OP            (UINT16) 0x75
170#define AML_DECREMENT_OP            (UINT16) 0x76
171#define AML_MULTIPLY_OP             (UINT16) 0x77
172#define AML_DIVIDE_OP               (UINT16) 0x78
173#define AML_SHIFT_LEFT_OP           (UINT16) 0x79
174#define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
175#define AML_BIT_AND_OP              (UINT16) 0x7b
176#define AML_BIT_NAND_OP             (UINT16) 0x7c
177#define AML_BIT_OR_OP               (UINT16) 0x7d
178#define AML_BIT_NOR_OP              (UINT16) 0x7e
179#define AML_BIT_XOR_OP              (UINT16) 0x7f
180#define AML_BIT_NOT_OP              (UINT16) 0x80
181#define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
182#define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
183#define AML_DEREF_OF_OP             (UINT16) 0x83
184#define AML_CONCAT_RES_OP           (UINT16) 0x84     /* ACPI 2.0 */
185#define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
186#define AML_NOTIFY_OP               (UINT16) 0x86
187#define AML_SIZE_OF_OP              (UINT16) 0x87
188#define AML_INDEX_OP                (UINT16) 0x88
189#define AML_MATCH_OP                (UINT16) 0x89
190#define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
191#define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
192#define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
193#define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
194#define AML_TYPE_OP                 (UINT16) 0x8e
195#define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
196#define AML_LAND_OP                 (UINT16) 0x90
197#define AML_LOR_OP                  (UINT16) 0x91
198#define AML_LNOT_OP                 (UINT16) 0x92
199#define AML_LEQUAL_OP               (UINT16) 0x93
200#define AML_LGREATER_OP             (UINT16) 0x94
201#define AML_LLESS_OP                (UINT16) 0x95
202#define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
203#define AML_TO_DECSTRING_OP         (UINT16) 0x97     /* ACPI 2.0 */
204#define AML_TO_HEXSTRING_OP         (UINT16) 0x98     /* ACPI 2.0 */
205#define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
206#define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
207#define AML_COPY_OP                 (UINT16) 0x9d     /* ACPI 2.0 */
208#define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
209#define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
210#define AML_IF_OP                   (UINT16) 0xa0
211#define AML_ELSE_OP                 (UINT16) 0xa1
212#define AML_WHILE_OP                (UINT16) 0xa2
213#define AML_NOOP_OP                 (UINT16) 0xa3
214#define AML_RETURN_OP               (UINT16) 0xa4
215#define AML_BREAK_OP                (UINT16) 0xa5
216#define AML_BREAK_POINT_OP          (UINT16) 0xcc
217#define AML_ONES_OP                 (UINT16) 0xff
218
219/* prefixed opcodes */
220
221#define AML_EXTENDED_OPCODE         (UINT16) 0x5b00     /* prefix for 2-byte opcodes */
222
223#define AML_MUTEX_OP                (UINT16) 0x5b01
224#define AML_EVENT_OP                (UINT16) 0x5b02
225#define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10
226#define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11
227#define AML_COND_REF_OF_OP          (UINT16) 0x5b12
228#define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
229#define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
230#define AML_LOAD_OP                 (UINT16) 0x5b20
231#define AML_STALL_OP                (UINT16) 0x5b21
232#define AML_SLEEP_OP                (UINT16) 0x5b22
233#define AML_ACQUIRE_OP              (UINT16) 0x5b23
234#define AML_SIGNAL_OP               (UINT16) 0x5b24
235#define AML_WAIT_OP                 (UINT16) 0x5b25
236#define AML_RESET_OP                (UINT16) 0x5b26
237#define AML_RELEASE_OP              (UINT16) 0x5b27
238#define AML_FROM_BCD_OP             (UINT16) 0x5b28
239#define AML_TO_BCD_OP               (UINT16) 0x5b29
240#define AML_UNLOAD_OP               (UINT16) 0x5b2a
241#define AML_REVISION_OP             (UINT16) 0x5b30
242#define AML_DEBUG_OP                (UINT16) 0x5b31
243#define AML_FATAL_OP                (UINT16) 0x5b32
244#define AML_TIMER_OP                (UINT16) 0x5b33     /* ACPI 3.0 */
245#define AML_REGION_OP               (UINT16) 0x5b80
246#define AML_FIELD_OP                (UINT16) 0x5b81
247#define AML_DEVICE_OP               (UINT16) 0x5b82
248#define AML_PROCESSOR_OP            (UINT16) 0x5b83
249#define AML_POWER_RES_OP            (UINT16) 0x5b84
250#define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
251#define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
252#define AML_BANK_FIELD_OP           (UINT16) 0x5b87
253#define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
254
255
256/*
257 * Combination opcodes (actually two one-byte opcodes)
258 * Used by the disassembler and iASL compiler
259 */
260#define AML_LGREATEREQUAL_OP        (UINT16) 0x9295
261#define AML_LLESSEQUAL_OP           (UINT16) 0x9294
262#define AML_LNOTEQUAL_OP            (UINT16) 0x9293
263
264
265/*
266 * Opcodes for "Field" operators
267 */
268#define AML_FIELD_OFFSET_OP         (UINT8) 0x00
269#define AML_FIELD_ACCESS_OP         (UINT8) 0x01
270#define AML_FIELD_CONNECTION_OP     (UINT8) 0x02        /* ACPI 5.0 */
271#define AML_FIELD_EXT_ACCESS_OP     (UINT8) 0x03        /* ACPI 5.0 */
272
273
274/*
275 * Internal opcodes
276 * Use only "Unknown" AML opcodes, don't attempt to use
277 * any valid ACPI ASCII values (A-Z, 0-9, '-')
278 */
279#define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
280#define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
281#define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
282#define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
283#define AML_INT_BYTELIST_OP         (UINT16) 0x0033
284#define AML_INT_STATICSTRING_OP     (UINT16) 0x0034
285#define AML_INT_METHODCALL_OP       (UINT16) 0x0035
286#define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
287#define AML_INT_EVAL_SUBTREE_OP     (UINT16) 0x0037
288#define AML_INT_CONNECTION_OP       (UINT16) 0x0038
289#define AML_INT_EXTACCESSFIELD_OP   (UINT16) 0x0039
290
291#define ARG_NONE                    0x0
292
293/*
294 * Argument types for the AML Parser
295 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
296 * There can be up to 31 unique argument types
297 * Zero is reserved as end-of-list indicator
298 */
299#define ARGP_BYTEDATA               0x01
300#define ARGP_BYTELIST               0x02
301#define ARGP_CHARLIST               0x03
302#define ARGP_DATAOBJ                0x04
303#define ARGP_DATAOBJLIST            0x05
304#define ARGP_DWORDDATA              0x06
305#define ARGP_FIELDLIST              0x07
306#define ARGP_NAME                   0x08
307#define ARGP_NAMESTRING             0x09
308#define ARGP_OBJLIST                0x0A
309#define ARGP_PKGLENGTH              0x0B
310#define ARGP_SUPERNAME              0x0C
311#define ARGP_TARGET                 0x0D
312#define ARGP_TERMARG                0x0E
313#define ARGP_TERMLIST               0x0F
314#define ARGP_WORDDATA               0x10
315#define ARGP_QWORDDATA              0x11
316#define ARGP_SIMPLENAME             0x12
317
318/*
319 * Resolved argument types for the AML Interpreter
320 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
321 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
322 *
323 * Note1: These values are completely independent from the ACPI_TYPEs
324 *        i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
325 *
326 * Note2: If and when 5 bits becomes insufficient, it would probably be best
327 * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
328 */
329
330/* Single, simple types */
331
332#define ARGI_ANYTYPE                0x01    /* Don't care */
333#define ARGI_PACKAGE                0x02
334#define ARGI_EVENT                  0x03
335#define ARGI_MUTEX                  0x04
336#define ARGI_DDBHANDLE              0x05
337
338/* Interchangeable types (via implicit conversion) */
339
340#define ARGI_INTEGER                0x06
341#define ARGI_STRING                 0x07
342#define ARGI_BUFFER                 0x08
343#define ARGI_BUFFER_OR_STRING       0x09    /* Used by MID op only */
344#define ARGI_COMPUTEDATA            0x0A    /* Buffer, String, or Integer */
345
346/* Reference objects */
347
348#define ARGI_INTEGER_REF            0x0B
349#define ARGI_OBJECT_REF             0x0C
350#define ARGI_DEVICE_REF             0x0D
351#define ARGI_REFERENCE              0x0E
352#define ARGI_TARGETREF              0x0F    /* Target, subject to implicit conversion */
353#define ARGI_FIXED_TARGET           0x10    /* Target, no implicit conversion */
354#define ARGI_SIMPLE_TARGET          0x11    /* Name, Local, Arg -- no implicit conversion */
355
356/* Multiple/complex types */
357
358#define ARGI_DATAOBJECT             0x12    /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
359#define ARGI_COMPLEXOBJ             0x13    /* Buffer, String, or package (Used by INDEX op only) */
360#define ARGI_REF_OR_STRING          0x14    /* Reference or String (Used by DEREFOF op only) */
361#define ARGI_REGION_OR_BUFFER       0x15    /* Used by LOAD op only */
362#define ARGI_DATAREFOBJ             0x16
363
364/* Note: types above can expand to 0x1F maximum */
365
366#define ARGI_INVALID_OPCODE         0xFFFFFFFF
367
368
369/*
370 * hash offsets
371 */
372#define AML_EXTOP_HASH_OFFSET       22
373#define AML_LNOT_HASH_OFFSET        19
374
375
376/*
377 * opcode groups and types
378 */
379#define OPGRP_NAMED                 0x01
380#define OPGRP_FIELD                 0x02
381#define OPGRP_BYTELIST              0x04
382
383
384/*
385 * Opcode information
386 */
387
388/* Opcode flags */
389
390#define AML_LOGICAL                 0x0001
391#define AML_LOGICAL_NUMERIC         0x0002
392#define AML_MATH                    0x0004
393#define AML_CREATE                  0x0008
394#define AML_FIELD                   0x0010
395#define AML_DEFER                   0x0020
396#define AML_NAMED                   0x0040
397#define AML_NSNODE                  0x0080
398#define AML_NSOPCODE                0x0100
399#define AML_NSOBJECT                0x0200
400#define AML_HAS_RETVAL              0x0400
401#define AML_HAS_TARGET              0x0800
402#define AML_HAS_ARGS                0x1000
403#define AML_CONSTANT                0x2000
404#define AML_NO_OPERAND_RESOLVE      0x4000
405
406/* Convenient flag groupings */
407
408#define AML_FLAGS_EXEC_0A_0T_1R                                     AML_HAS_RETVAL
409#define AML_FLAGS_EXEC_1A_0T_0R     AML_HAS_ARGS                                   /* Monadic1  */
410#define AML_FLAGS_EXEC_1A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Monadic2  */
411#define AML_FLAGS_EXEC_1A_1T_0R     AML_HAS_ARGS | AML_HAS_TARGET
412#define AML_FLAGS_EXEC_1A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */
413#define AML_FLAGS_EXEC_2A_0T_0R     AML_HAS_ARGS                                   /* Dyadic1   */
414#define AML_FLAGS_EXEC_2A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Dyadic2   */
415#define AML_FLAGS_EXEC_2A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R  */
416#define AML_FLAGS_EXEC_2A_2T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
417#define AML_FLAGS_EXEC_3A_0T_0R     AML_HAS_ARGS
418#define AML_FLAGS_EXEC_3A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
419#define AML_FLAGS_EXEC_6A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL
420
421
422/*
423 * The opcode Type is used in a dispatch table, do not change
424 * without updating the table.
425 */
426#define AML_TYPE_EXEC_0A_0T_1R      0x00
427#define AML_TYPE_EXEC_1A_0T_0R      0x01 /* Monadic1  */
428#define AML_TYPE_EXEC_1A_0T_1R      0x02 /* Monadic2  */
429#define AML_TYPE_EXEC_1A_1T_0R      0x03
430#define AML_TYPE_EXEC_1A_1T_1R      0x04 /* Monadic2R */
431#define AML_TYPE_EXEC_2A_0T_0R      0x05 /* Dyadic1   */
432#define AML_TYPE_EXEC_2A_0T_1R      0x06 /* Dyadic2   */
433#define AML_TYPE_EXEC_2A_1T_1R      0x07 /* Dyadic2R  */
434#define AML_TYPE_EXEC_2A_2T_1R      0x08
435#define AML_TYPE_EXEC_3A_0T_0R      0x09
436#define AML_TYPE_EXEC_3A_1T_1R      0x0A
437#define AML_TYPE_EXEC_6A_0T_1R      0x0B
438/* End of types used in dispatch table */
439
440#define AML_TYPE_LITERAL            0x0B
441#define AML_TYPE_CONSTANT           0x0C
442#define AML_TYPE_METHOD_ARGUMENT    0x0D
443#define AML_TYPE_LOCAL_VARIABLE     0x0E
444#define AML_TYPE_DATA_TERM          0x0F
445
446/* Generic for an op that returns a value */
447
448#define AML_TYPE_METHOD_CALL        0x10
449
450/* Misc */
451
452#define AML_TYPE_CREATE_FIELD       0x11
453#define AML_TYPE_CREATE_OBJECT      0x12
454#define AML_TYPE_CONTROL            0x13
455#define AML_TYPE_NAMED_NO_OBJ       0x14
456#define AML_TYPE_NAMED_FIELD        0x15
457#define AML_TYPE_NAMED_SIMPLE       0x16
458#define AML_TYPE_NAMED_COMPLEX      0x17
459#define AML_TYPE_RETURN             0x18
460
461#define AML_TYPE_UNDEFINED          0x19
462#define AML_TYPE_BOGUS              0x1A
463
464/* AML Package Length encodings */
465
466#define ACPI_AML_PACKAGE_TYPE1      0x40
467#define ACPI_AML_PACKAGE_TYPE2      0x4000
468#define ACPI_AML_PACKAGE_TYPE3      0x400000
469#define ACPI_AML_PACKAGE_TYPE4      0x40000000
470
471/*
472 * Opcode classes
473 */
474#define AML_CLASS_EXECUTE           0x00
475#define AML_CLASS_CREATE            0x01
476#define AML_CLASS_ARGUMENT          0x02
477#define AML_CLASS_NAMED_OBJECT      0x03
478#define AML_CLASS_CONTROL           0x04
479#define AML_CLASS_ASCII             0x05
480#define AML_CLASS_PREFIX            0x06
481#define AML_CLASS_INTERNAL          0x07
482#define AML_CLASS_RETURN_VALUE      0x08
483#define AML_CLASS_METHOD_CALL       0x09
484#define AML_CLASS_UNKNOWN           0x0A
485
486
487/* Comparison operation codes for MatchOp operator */
488
489typedef enum
490{
491    MATCH_MTR                       = 0,
492    MATCH_MEQ                       = 1,
493    MATCH_MLE                       = 2,
494    MATCH_MLT                       = 3,
495    MATCH_MGE                       = 4,
496    MATCH_MGT                       = 5
497
498} AML_MATCH_OPERATOR;
499
500#define MAX_MATCH_OPERATOR          5
501
502
503/*
504 * FieldFlags
505 *
506 * This byte is extracted from the AML and includes three separate
507 * pieces of information about the field:
508 * 1) The field access type
509 * 2) The field update rule
510 * 3) The lock rule for the field
511 *
512 * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
513 *      04      : LockRule (1 == Lock)
514 *      05 - 06 : UpdateRule
515 */
516#define AML_FIELD_ACCESS_TYPE_MASK  0x0F
517#define AML_FIELD_LOCK_RULE_MASK    0x10
518#define AML_FIELD_UPDATE_RULE_MASK  0x60
519
520
521/* 1) Field Access Types */
522
523typedef enum
524{
525    AML_FIELD_ACCESS_ANY            = 0x00,
526    AML_FIELD_ACCESS_BYTE           = 0x01,
527    AML_FIELD_ACCESS_WORD           = 0x02,
528    AML_FIELD_ACCESS_DWORD          = 0x03,
529    AML_FIELD_ACCESS_QWORD          = 0x04,    /* ACPI 2.0 */
530    AML_FIELD_ACCESS_BUFFER         = 0x05     /* ACPI 2.0 */
531
532} AML_ACCESS_TYPE;
533
534
535/* 2) Field Lock Rules */
536
537typedef enum
538{
539    AML_FIELD_LOCK_NEVER            = 0x00,
540    AML_FIELD_LOCK_ALWAYS           = 0x10
541
542} AML_LOCK_RULE;
543
544
545/* 3) Field Update Rules */
546
547typedef enum
548{
549    AML_FIELD_UPDATE_PRESERVE       = 0x00,
550    AML_FIELD_UPDATE_WRITE_AS_ONES  = 0x20,
551    AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
552
553} AML_UPDATE_RULE;
554
555
556/*
557 * Field Access Attributes.
558 * This byte is extracted from the AML via the
559 * AccessAs keyword
560 */
561typedef enum
562{
563    AML_FIELD_ATTRIB_QUICK          = 0x02,
564    AML_FIELD_ATTRIB_SEND_RCV       = 0x04,
565    AML_FIELD_ATTRIB_BYTE           = 0x06,
566    AML_FIELD_ATTRIB_WORD           = 0x08,
567    AML_FIELD_ATTRIB_BLOCK          = 0x0A,
568    AML_FIELD_ATTRIB_MULTIBYTE      = 0x0B,
569    AML_FIELD_ATTRIB_WORD_CALL      = 0x0C,
570    AML_FIELD_ATTRIB_BLOCK_CALL     = 0x0D,
571    AML_FIELD_ATTRIB_RAW_BYTES      = 0x0E,
572    AML_FIELD_ATTRIB_RAW_PROCESS    = 0x0F
573
574} AML_ACCESS_ATTRIBUTE;
575
576
577/* Bit fields in the AML MethodFlags byte */
578
579#define AML_METHOD_ARG_COUNT        0x07
580#define AML_METHOD_SERIALIZED       0x08
581#define AML_METHOD_SYNC_LEVEL       0xF0
582
583
584#endif /* __AMLCODE_H__ */
585