xref: /illumos-gate/usr/src/uts/intel/sys/acpi/amlcode.h (revision 35786f68)
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 - 2018, 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  * Alternatively, you may choose to be licensed under the terms of the
119  * following license:
120  *
121  * Redistribution and use in source and binary forms, with or without
122  * modification, are permitted provided that the following conditions
123  * are met:
124  * 1. Redistributions of source code must retain the above copyright
125  *    notice, this list of conditions, and the following disclaimer,
126  *    without modification.
127  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
128  *    substantially similar to the "NO WARRANTY" disclaimer below
129  *    ("Disclaimer") and any redistribution must be conditioned upon
130  *    including a substantially similar Disclaimer requirement for further
131  *    binary redistribution.
132  * 3. Neither the names of the above-listed copyright holders nor the names
133  *    of any contributors may be used to endorse or promote products derived
134  *    from this software without specific prior written permission.
135  *
136  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
137  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
138  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
139  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
140  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
141  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
142  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
143  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
144  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
145  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
146  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
147  *
148  * Alternatively, you may choose to be licensed under the terms of the
149  * GNU General Public License ("GPL") version 2 as published by the Free
150  * Software Foundation.
151  *
152  *****************************************************************************/
153 
154 #ifndef __AMLCODE_H__
155 #define __AMLCODE_H__
156 
157 /* primary opcodes */
158 
159 #define AML_ZERO_OP                 (UINT16) 0x00
160 #define AML_ONE_OP                  (UINT16) 0x01
161 #define AML_ALIAS_OP                (UINT16) 0x06
162 #define AML_NAME_OP                 (UINT16) 0x08
163 #define AML_BYTE_OP                 (UINT16) 0x0a
164 #define AML_WORD_OP                 (UINT16) 0x0b
165 #define AML_DWORD_OP                (UINT16) 0x0c
166 #define AML_STRING_OP               (UINT16) 0x0d
167 #define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
168 #define AML_SCOPE_OP                (UINT16) 0x10
169 #define AML_BUFFER_OP               (UINT16) 0x11
170 #define AML_PACKAGE_OP              (UINT16) 0x12
171 #define AML_VARIABLE_PACKAGE_OP     (UINT16) 0x13     /* ACPI 2.0 */
172 #define AML_METHOD_OP               (UINT16) 0x14
173 #define AML_EXTERNAL_OP             (UINT16) 0x15     /* ACPI 6.0 */
174 #define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
175 #define AML_MULTI_NAME_PREFIX       (UINT16) 0x2f
176 #define AML_EXTENDED_PREFIX         (UINT16) 0x5b
177 #define AML_ROOT_PREFIX             (UINT16) 0x5c
178 #define AML_PARENT_PREFIX           (UINT16) 0x5e
179 #define AML_FIRST_LOCAL_OP          (UINT16) 0x60     /* Used for Local op # calculations */
180 #define AML_LOCAL0                  (UINT16) 0x60
181 #define AML_LOCAL1                  (UINT16) 0x61
182 #define AML_LOCAL2                  (UINT16) 0x62
183 #define AML_LOCAL3                  (UINT16) 0x63
184 #define AML_LOCAL4                  (UINT16) 0x64
185 #define AML_LOCAL5                  (UINT16) 0x65
186 #define AML_LOCAL6                  (UINT16) 0x66
187 #define AML_LOCAL7                  (UINT16) 0x67
188 #define AML_FIRST_ARG_OP            (UINT16) 0x68     /* Used for Arg op # calculations */
189 #define AML_ARG0                    (UINT16) 0x68
190 #define AML_ARG1                    (UINT16) 0x69
191 #define AML_ARG2                    (UINT16) 0x6a
192 #define AML_ARG3                    (UINT16) 0x6b
193 #define AML_ARG4                    (UINT16) 0x6c
194 #define AML_ARG5                    (UINT16) 0x6d
195 #define AML_ARG6                    (UINT16) 0x6e
196 #define AML_STORE_OP                (UINT16) 0x70
197 #define AML_REF_OF_OP               (UINT16) 0x71
198 #define AML_ADD_OP                  (UINT16) 0x72
199 #define AML_CONCATENATE_OP          (UINT16) 0x73
200 #define AML_SUBTRACT_OP             (UINT16) 0x74
201 #define AML_INCREMENT_OP            (UINT16) 0x75
202 #define AML_DECREMENT_OP            (UINT16) 0x76
203 #define AML_MULTIPLY_OP             (UINT16) 0x77
204 #define AML_DIVIDE_OP               (UINT16) 0x78
205 #define AML_SHIFT_LEFT_OP           (UINT16) 0x79
206 #define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
207 #define AML_BIT_AND_OP              (UINT16) 0x7b
208 #define AML_BIT_NAND_OP             (UINT16) 0x7c
209 #define AML_BIT_OR_OP               (UINT16) 0x7d
210 #define AML_BIT_NOR_OP              (UINT16) 0x7e
211 #define AML_BIT_XOR_OP              (UINT16) 0x7f
212 #define AML_BIT_NOT_OP              (UINT16) 0x80
213 #define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
214 #define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
215 #define AML_DEREF_OF_OP             (UINT16) 0x83
216 #define AML_CONCATENATE_TEMPLATE_OP (UINT16) 0x84     /* ACPI 2.0 */
217 #define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
218 #define AML_NOTIFY_OP               (UINT16) 0x86
219 #define AML_SIZE_OF_OP              (UINT16) 0x87
220 #define AML_INDEX_OP                (UINT16) 0x88
221 #define AML_MATCH_OP                (UINT16) 0x89
222 #define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
223 #define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
224 #define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
225 #define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
226 #define AML_OBJECT_TYPE_OP          (UINT16) 0x8e
227 #define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
228 #define AML_LOGICAL_AND_OP          (UINT16) 0x90
229 #define AML_LOGICAL_OR_OP           (UINT16) 0x91
230 #define AML_LOGICAL_NOT_OP          (UINT16) 0x92
231 #define AML_LOGICAL_EQUAL_OP        (UINT16) 0x93
232 #define AML_LOGICAL_GREATER_OP      (UINT16) 0x94
233 #define AML_LOGICAL_LESS_OP         (UINT16) 0x95
234 #define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
235 #define AML_TO_DECIMAL_STRING_OP    (UINT16) 0x97     /* ACPI 2.0 */
236 #define AML_TO_HEX_STRING_OP        (UINT16) 0x98     /* ACPI 2.0 */
237 #define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
238 #define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
239 #define AML_COPY_OBJECT_OP          (UINT16) 0x9d     /* ACPI 2.0 */
240 #define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
241 #define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
242 #define AML_IF_OP                   (UINT16) 0xa0
243 #define AML_ELSE_OP                 (UINT16) 0xa1
244 #define AML_WHILE_OP                (UINT16) 0xa2
245 #define AML_NOOP_OP                 (UINT16) 0xa3
246 #define AML_RETURN_OP               (UINT16) 0xa4
247 #define AML_BREAK_OP                (UINT16) 0xa5
248 #define AML_COMMENT_OP              (UINT16) 0xa9
249 #define AML_BREAKPOINT_OP          (UINT16) 0xcc
250 #define AML_ONES_OP                 (UINT16) 0xff
251 
252 
253 /*
254  * Combination opcodes (actually two one-byte opcodes)
255  * Used by the disassembler and iASL compiler
256  */
257 #define AML_LOGICAL_GREATER_EQUAL_OP (UINT16) 0x9295    /* LNot (LLess) */
258 #define AML_LOGICAL_LESS_EQUAL_OP    (UINT16) 0x9294    /* LNot (LGreater) */
259 #define AML_LOGICAL_NOT_EQUAL_OP     (UINT16) 0x9293    /* LNot (LEqual) */
260 
261 
262 /* Prefixed (2-byte) opcodes (with AML_EXTENDED_PREFIX) */
263 
264 #define AML_EXTENDED_OPCODE         (UINT16) 0x5b00     /* Prefix for 2-byte opcodes */
265 
266 #define AML_MUTEX_OP                (UINT16) 0x5b01
267 #define AML_EVENT_OP                (UINT16) 0x5b02
268 #define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10     /* Obsolete, not in ACPI spec */
269 #define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11     /* Obsolete, not in ACPI spec */
270 #define AML_CONDITIONAL_REF_OF_OP   (UINT16) 0x5b12
271 #define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
272 #define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
273 #define AML_LOAD_OP                 (UINT16) 0x5b20
274 #define AML_STALL_OP                (UINT16) 0x5b21
275 #define AML_SLEEP_OP                (UINT16) 0x5b22
276 #define AML_ACQUIRE_OP              (UINT16) 0x5b23
277 #define AML_SIGNAL_OP               (UINT16) 0x5b24
278 #define AML_WAIT_OP                 (UINT16) 0x5b25
279 #define AML_RESET_OP                (UINT16) 0x5b26
280 #define AML_RELEASE_OP              (UINT16) 0x5b27
281 #define AML_FROM_BCD_OP             (UINT16) 0x5b28
282 #define AML_TO_BCD_OP               (UINT16) 0x5b29
283 #define AML_UNLOAD_OP               (UINT16) 0x5b2a
284 #define AML_REVISION_OP             (UINT16) 0x5b30
285 #define AML_DEBUG_OP                (UINT16) 0x5b31
286 #define AML_FATAL_OP                (UINT16) 0x5b32
287 #define AML_TIMER_OP                (UINT16) 0x5b33     /* ACPI 3.0 */
288 #define AML_REGION_OP               (UINT16) 0x5b80
289 #define AML_FIELD_OP                (UINT16) 0x5b81
290 #define AML_DEVICE_OP               (UINT16) 0x5b82
291 #define AML_PROCESSOR_OP            (UINT16) 0x5b83
292 #define AML_POWER_RESOURCE_OP       (UINT16) 0x5b84
293 #define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
294 #define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
295 #define AML_BANK_FIELD_OP           (UINT16) 0x5b87
296 #define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
297 
298 
299 /*
300  * Opcodes for "Field" operators
301  */
302 #define AML_FIELD_OFFSET_OP         (UINT8) 0x00
303 #define AML_FIELD_ACCESS_OP         (UINT8) 0x01
304 #define AML_FIELD_CONNECTION_OP     (UINT8) 0x02        /* ACPI 5.0 */
305 #define AML_FIELD_EXT_ACCESS_OP     (UINT8) 0x03        /* ACPI 5.0 */
306 
307 
308 /*
309  * Internal opcodes
310  * Use only "Unknown" AML opcodes, don't attempt to use
311  * any valid ACPI ASCII values (A-Z, 0-9, '-')
312  */
313 #define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
314 #define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
315 #define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
316 #define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
317 #define AML_INT_BYTELIST_OP         (UINT16) 0x0033
318 #define AML_INT_METHODCALL_OP       (UINT16) 0x0035
319 #define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
320 #define AML_INT_EVAL_SUBTREE_OP     (UINT16) 0x0037
321 #define AML_INT_CONNECTION_OP       (UINT16) 0x0038
322 #define AML_INT_EXTACCESSFIELD_OP   (UINT16) 0x0039
323 
324 #define ARG_NONE                    0x0
325 
326 /*
327  * Argument types for the AML Parser
328  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
329  * There can be up to 31 unique argument types
330  * Zero is reserved as end-of-list indicator
331  */
332 #define ARGP_BYTEDATA               0x01
333 #define ARGP_BYTELIST               0x02
334 #define ARGP_CHARLIST               0x03
335 #define ARGP_DATAOBJ                0x04
336 #define ARGP_DATAOBJLIST            0x05
337 #define ARGP_DWORDDATA              0x06
338 #define ARGP_FIELDLIST              0x07
339 #define ARGP_NAME                   0x08
340 #define ARGP_NAMESTRING             0x09
341 #define ARGP_OBJLIST                0x0A
342 #define ARGP_PKGLENGTH              0x0B
343 #define ARGP_SUPERNAME              0x0C
344 #define ARGP_TARGET                 0x0D
345 #define ARGP_TERMARG                0x0E
346 #define ARGP_TERMLIST               0x0F
347 #define ARGP_WORDDATA               0x10
348 #define ARGP_QWORDDATA              0x11
349 #define ARGP_SIMPLENAME             0x12 /* NameString | LocalTerm | ArgTerm */
350 #define ARGP_NAME_OR_REF            0x13 /* For ObjectType only */
351 #define ARGP_MAX                    0x13
352 #define ARGP_COMMENT                0x14
353 
354 /*
355  * Resolved argument types for the AML Interpreter
356  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
357  * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
358  *
359  * Note1: These values are completely independent from the ACPI_TYPEs
360  *        i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
361  *
362  * Note2: If and when 5 bits becomes insufficient, it would probably be best
363  * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
364  */
365 
366 /* Single, simple types */
367 
368 #define ARGI_ANYTYPE                0x01    /* Don't care */
369 #define ARGI_PACKAGE                0x02
370 #define ARGI_EVENT                  0x03
371 #define ARGI_MUTEX                  0x04
372 #define ARGI_DDBHANDLE              0x05
373 
374 /* Interchangeable types (via implicit conversion) */
375 
376 #define ARGI_INTEGER                0x06
377 #define ARGI_STRING                 0x07
378 #define ARGI_BUFFER                 0x08
379 #define ARGI_BUFFER_OR_STRING       0x09    /* Used by MID op only */
380 #define ARGI_COMPUTEDATA            0x0A    /* Buffer, String, or Integer */
381 
382 /* Reference objects */
383 
384 #define ARGI_INTEGER_REF            0x0B
385 #define ARGI_OBJECT_REF             0x0C
386 #define ARGI_DEVICE_REF             0x0D
387 #define ARGI_REFERENCE              0x0E
388 #define ARGI_TARGETREF              0x0F    /* Target, subject to implicit conversion */
389 #define ARGI_FIXED_TARGET           0x10    /* Target, no implicit conversion */
390 #define ARGI_SIMPLE_TARGET          0x11    /* Name, Local, Arg -- no implicit conversion */
391 #define ARGI_STORE_TARGET           0x12    /* Target for store is TARGETREF + package objects */
392 
393 /* Multiple/complex types */
394 
395 #define ARGI_DATAOBJECT             0x13    /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
396 #define ARGI_COMPLEXOBJ             0x14    /* Buffer, String, or package (Used by INDEX op only) */
397 #define ARGI_REF_OR_STRING          0x15    /* Reference or String (Used by DEREFOF op only) */
398 #define ARGI_REGION_OR_BUFFER       0x16    /* Used by LOAD op only */
399 #define ARGI_DATAREFOBJ             0x17
400 
401 /* Note: types above can expand to 0x1F maximum */
402 
403 #define ARGI_INVALID_OPCODE         0xFFFFFFFF
404 
405 
406 /*
407  * Some of the flags and types below are of the form:
408  *
409  * AML_FLAGS_EXEC_#A_#T,#R, or
410  * AML_TYPE_EXEC_#A_#T,#R where:
411  *
412  *      #A is the number of required arguments
413  *      #T is the number of target operands
414  *      #R indicates whether there is a return value
415  *
416  * These types are used for the top-level dispatch of the AML
417  * opcode. They group similar operators that can share common
418  * front-end code before dispatch to the final code that implements
419  * the operator.
420  */
421 
422 /*
423  * Opcode information flags
424  */
425 #define AML_LOGICAL                 0x0001
426 #define AML_LOGICAL_NUMERIC         0x0002
427 #define AML_MATH                    0x0004
428 #define AML_CREATE                  0x0008
429 #define AML_FIELD                   0x0010
430 #define AML_DEFER                   0x0020
431 #define AML_NAMED                   0x0040
432 #define AML_NSNODE                  0x0080
433 #define AML_NSOPCODE                0x0100
434 #define AML_NSOBJECT                0x0200
435 #define AML_HAS_RETVAL              0x0400
436 #define AML_HAS_TARGET              0x0800
437 #define AML_HAS_ARGS                0x1000
438 #define AML_CONSTANT                0x2000
439 #define AML_NO_OPERAND_RESOLVE      0x4000
440 
441 /* Convenient flag groupings of the flags above */
442 
443 #define AML_FLAGS_EXEC_0A_0T_1R                                     AML_HAS_RETVAL
444 #define AML_FLAGS_EXEC_1A_0T_0R     AML_HAS_ARGS                                   /* Monadic1  */
445 #define AML_FLAGS_EXEC_1A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Monadic2  */
446 #define AML_FLAGS_EXEC_1A_1T_0R     AML_HAS_ARGS | AML_HAS_TARGET
447 #define AML_FLAGS_EXEC_1A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */
448 #define AML_FLAGS_EXEC_2A_0T_0R     AML_HAS_ARGS                                   /* Dyadic1   */
449 #define AML_FLAGS_EXEC_2A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Dyadic2   */
450 #define AML_FLAGS_EXEC_2A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R  */
451 #define AML_FLAGS_EXEC_2A_2T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
452 #define AML_FLAGS_EXEC_3A_0T_0R     AML_HAS_ARGS
453 #define AML_FLAGS_EXEC_3A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
454 #define AML_FLAGS_EXEC_6A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL
455 
456 
457 /*
458  * The opcode Type is used in a dispatch table, do not change
459  * or add anything new without updating the table.
460  */
461 #define AML_TYPE_EXEC_0A_0T_1R      0x00 /* 0 Args, 0 Target, 1 RetVal */
462 #define AML_TYPE_EXEC_1A_0T_0R      0x01 /* 1 Args, 0 Target, 0 RetVal */
463 #define AML_TYPE_EXEC_1A_0T_1R      0x02 /* 1 Args, 0 Target, 1 RetVal */
464 #define AML_TYPE_EXEC_1A_1T_0R      0x03 /* 1 Args, 1 Target, 0 RetVal */
465 #define AML_TYPE_EXEC_1A_1T_1R      0x04 /* 1 Args, 1 Target, 1 RetVal */
466 #define AML_TYPE_EXEC_2A_0T_0R      0x05 /* 2 Args, 0 Target, 0 RetVal */
467 #define AML_TYPE_EXEC_2A_0T_1R      0x06 /* 2 Args, 0 Target, 1 RetVal */
468 #define AML_TYPE_EXEC_2A_1T_1R      0x07 /* 2 Args, 1 Target, 1 RetVal */
469 #define AML_TYPE_EXEC_2A_2T_1R      0x08 /* 2 Args, 2 Target, 1 RetVal */
470 #define AML_TYPE_EXEC_3A_0T_0R      0x09 /* 3 Args, 0 Target, 0 RetVal */
471 #define AML_TYPE_EXEC_3A_1T_1R      0x0A /* 3 Args, 1 Target, 1 RetVal */
472 #define AML_TYPE_EXEC_6A_0T_1R      0x0B /* 6 Args, 0 Target, 1 RetVal */
473 /* End of types used in dispatch table */
474 
475 #define AML_TYPE_LITERAL            0x0C
476 #define AML_TYPE_CONSTANT           0x0D
477 #define AML_TYPE_METHOD_ARGUMENT    0x0E
478 #define AML_TYPE_LOCAL_VARIABLE     0x0F
479 #define AML_TYPE_DATA_TERM          0x10
480 
481 /* Generic for an op that returns a value */
482 
483 #define AML_TYPE_METHOD_CALL        0x11
484 
485 /* Miscellaneous types */
486 
487 #define AML_TYPE_CREATE_FIELD       0x12
488 #define AML_TYPE_CREATE_OBJECT      0x13
489 #define AML_TYPE_CONTROL            0x14
490 #define AML_TYPE_NAMED_NO_OBJ       0x15
491 #define AML_TYPE_NAMED_FIELD        0x16
492 #define AML_TYPE_NAMED_SIMPLE       0x17
493 #define AML_TYPE_NAMED_COMPLEX      0x18
494 #define AML_TYPE_RETURN             0x19
495 #define AML_TYPE_UNDEFINED          0x1A
496 #define AML_TYPE_BOGUS              0x1B
497 
498 /* AML Package Length encodings */
499 
500 #define ACPI_AML_PACKAGE_TYPE1      0x40
501 #define ACPI_AML_PACKAGE_TYPE2      0x4000
502 #define ACPI_AML_PACKAGE_TYPE3      0x400000
503 #define ACPI_AML_PACKAGE_TYPE4      0x40000000
504 
505 /*
506  * Opcode classes
507  */
508 #define AML_CLASS_EXECUTE           0x00
509 #define AML_CLASS_CREATE            0x01
510 #define AML_CLASS_ARGUMENT          0x02
511 #define AML_CLASS_NAMED_OBJECT      0x03
512 #define AML_CLASS_CONTROL           0x04
513 #define AML_CLASS_ASCII             0x05
514 #define AML_CLASS_PREFIX            0x06
515 #define AML_CLASS_INTERNAL          0x07
516 #define AML_CLASS_RETURN_VALUE      0x08
517 #define AML_CLASS_METHOD_CALL       0x09
518 #define AML_CLASS_UNKNOWN           0x0A
519 
520 
521 /* Comparison operation codes for MatchOp operator */
522 
523 typedef enum
524 {
525     MATCH_MTR                       = 0,
526     MATCH_MEQ                       = 1,
527     MATCH_MLE                       = 2,
528     MATCH_MLT                       = 3,
529     MATCH_MGE                       = 4,
530     MATCH_MGT                       = 5
531 
532 } AML_MATCH_OPERATOR;
533 
534 #define MAX_MATCH_OPERATOR          5
535 
536 
537 /*
538  * FieldFlags
539  *
540  * This byte is extracted from the AML and includes three separate
541  * pieces of information about the field:
542  * 1) The field access type
543  * 2) The field update rule
544  * 3) The lock rule for the field
545  *
546  * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
547  *      04      : LockRule (1 == Lock)
548  *      05 - 06 : UpdateRule
549  */
550 #define AML_FIELD_ACCESS_TYPE_MASK  0x0F
551 #define AML_FIELD_LOCK_RULE_MASK    0x10
552 #define AML_FIELD_UPDATE_RULE_MASK  0x60
553 
554 
555 /* 1) Field Access Types */
556 
557 typedef enum
558 {
559     AML_FIELD_ACCESS_ANY            = 0x00,
560     AML_FIELD_ACCESS_BYTE           = 0x01,
561     AML_FIELD_ACCESS_WORD           = 0x02,
562     AML_FIELD_ACCESS_DWORD          = 0x03,
563     AML_FIELD_ACCESS_QWORD          = 0x04,    /* ACPI 2.0 */
564     AML_FIELD_ACCESS_BUFFER         = 0x05     /* ACPI 2.0 */
565 
566 } AML_ACCESS_TYPE;
567 
568 
569 /* 2) Field Lock Rules */
570 
571 typedef enum
572 {
573     AML_FIELD_LOCK_NEVER            = 0x00,
574     AML_FIELD_LOCK_ALWAYS           = 0x10
575 
576 } AML_LOCK_RULE;
577 
578 
579 /* 3) Field Update Rules */
580 
581 typedef enum
582 {
583     AML_FIELD_UPDATE_PRESERVE       = 0x00,
584     AML_FIELD_UPDATE_WRITE_AS_ONES  = 0x20,
585     AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
586 
587 } AML_UPDATE_RULE;
588 
589 
590 /*
591  * Field Access Attributes.
592  * This byte is extracted from the AML via the
593  * AccessAs keyword
594  */
595 typedef enum
596 {
597     AML_FIELD_ATTRIB_QUICK          = 0x02,
598     AML_FIELD_ATTRIB_SEND_RCV       = 0x04,
599     AML_FIELD_ATTRIB_BYTE           = 0x06,
600     AML_FIELD_ATTRIB_WORD           = 0x08,
601     AML_FIELD_ATTRIB_BLOCK          = 0x0A,
602     AML_FIELD_ATTRIB_MULTIBYTE      = 0x0B,
603     AML_FIELD_ATTRIB_WORD_CALL      = 0x0C,
604     AML_FIELD_ATTRIB_BLOCK_CALL     = 0x0D,
605     AML_FIELD_ATTRIB_RAW_BYTES      = 0x0E,
606     AML_FIELD_ATTRIB_RAW_PROCESS    = 0x0F
607 
608 } AML_ACCESS_ATTRIBUTE;
609 
610 
611 /* Bit fields in the AML MethodFlags byte */
612 
613 #define AML_METHOD_ARG_COUNT        0x07
614 #define AML_METHOD_SERIALIZED       0x08
615 #define AML_METHOD_SYNC_LEVEL       0xF0
616 
617 
618 #endif /* __AMLCODE_H__ */
619