blob: 48a3e331b72d7e7c8214969217d4e57e3c535d3e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
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/*
Bob Moore25f044e2013-01-25 05:38:56 +000010 * Copyright (C) 2000 - 2013, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * 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
Len Brown4be44fc2005-08-05 00:44:28 -040062#define AML_QWORD_OP (u16) 0x0e /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#define AML_SCOPE_OP (u16) 0x10
64#define AML_BUFFER_OP (u16) 0x11
65#define AML_PACKAGE_OP (u16) 0x12
Len Brown4be44fc2005-08-05 00:44:28 -040066#define AML_VAR_PACKAGE_OP (u16) 0x13 /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#define AML_METHOD_OP (u16) 0x14
68#define AML_DUAL_NAME_PREFIX (u16) 0x2e
69#define AML_MULTI_NAME_PREFIX_OP (u16) 0x2f
70#define AML_NAME_CHAR_SUBSEQ (u16) 0x30
71#define AML_NAME_CHAR_FIRST (u16) 0x41
Robert Moore73459f72005-06-24 00:00:00 -040072#define AML_EXTENDED_OP_PREFIX (u16) 0x5b
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#define AML_ROOT_PREFIX (u16) 0x5c
74#define AML_PARENT_PREFIX (u16) 0x5e
75#define AML_LOCAL_OP (u16) 0x60
76#define AML_LOCAL0 (u16) 0x60
77#define AML_LOCAL1 (u16) 0x61
78#define AML_LOCAL2 (u16) 0x62
79#define AML_LOCAL3 (u16) 0x63
80#define AML_LOCAL4 (u16) 0x64
81#define AML_LOCAL5 (u16) 0x65
82#define AML_LOCAL6 (u16) 0x66
83#define AML_LOCAL7 (u16) 0x67
84#define AML_ARG_OP (u16) 0x68
85#define AML_ARG0 (u16) 0x68
86#define AML_ARG1 (u16) 0x69
87#define AML_ARG2 (u16) 0x6a
88#define AML_ARG3 (u16) 0x6b
89#define AML_ARG4 (u16) 0x6c
90#define AML_ARG5 (u16) 0x6d
91#define AML_ARG6 (u16) 0x6e
92#define AML_STORE_OP (u16) 0x70
93#define AML_REF_OF_OP (u16) 0x71
94#define AML_ADD_OP (u16) 0x72
95#define AML_CONCAT_OP (u16) 0x73
96#define AML_SUBTRACT_OP (u16) 0x74
97#define AML_INCREMENT_OP (u16) 0x75
98#define AML_DECREMENT_OP (u16) 0x76
99#define AML_MULTIPLY_OP (u16) 0x77
100#define AML_DIVIDE_OP (u16) 0x78
101#define AML_SHIFT_LEFT_OP (u16) 0x79
102#define AML_SHIFT_RIGHT_OP (u16) 0x7a
103#define AML_BIT_AND_OP (u16) 0x7b
104#define AML_BIT_NAND_OP (u16) 0x7c
105#define AML_BIT_OR_OP (u16) 0x7d
106#define AML_BIT_NOR_OP (u16) 0x7e
107#define AML_BIT_XOR_OP (u16) 0x7f
108#define AML_BIT_NOT_OP (u16) 0x80
109#define AML_FIND_SET_LEFT_BIT_OP (u16) 0x81
110#define AML_FIND_SET_RIGHT_BIT_OP (u16) 0x82
111#define AML_DEREF_OF_OP (u16) 0x83
Len Brown4be44fc2005-08-05 00:44:28 -0400112#define AML_CONCAT_RES_OP (u16) 0x84 /* ACPI 2.0 */
113#define AML_MOD_OP (u16) 0x85 /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114#define AML_NOTIFY_OP (u16) 0x86
115#define AML_SIZE_OF_OP (u16) 0x87
116#define AML_INDEX_OP (u16) 0x88
117#define AML_MATCH_OP (u16) 0x89
118#define AML_CREATE_DWORD_FIELD_OP (u16) 0x8a
119#define AML_CREATE_WORD_FIELD_OP (u16) 0x8b
120#define AML_CREATE_BYTE_FIELD_OP (u16) 0x8c
121#define AML_CREATE_BIT_FIELD_OP (u16) 0x8d
122#define AML_TYPE_OP (u16) 0x8e
Len Brown4be44fc2005-08-05 00:44:28 -0400123#define AML_CREATE_QWORD_FIELD_OP (u16) 0x8f /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#define AML_LAND_OP (u16) 0x90
125#define AML_LOR_OP (u16) 0x91
126#define AML_LNOT_OP (u16) 0x92
127#define AML_LEQUAL_OP (u16) 0x93
128#define AML_LGREATER_OP (u16) 0x94
129#define AML_LLESS_OP (u16) 0x95
Len Brown4be44fc2005-08-05 00:44:28 -0400130#define AML_TO_BUFFER_OP (u16) 0x96 /* ACPI 2.0 */
131#define AML_TO_DECSTRING_OP (u16) 0x97 /* ACPI 2.0 */
132#define AML_TO_HEXSTRING_OP (u16) 0x98 /* ACPI 2.0 */
133#define AML_TO_INTEGER_OP (u16) 0x99 /* ACPI 2.0 */
134#define AML_TO_STRING_OP (u16) 0x9c /* ACPI 2.0 */
135#define AML_COPY_OP (u16) 0x9d /* ACPI 2.0 */
136#define AML_MID_OP (u16) 0x9e /* ACPI 2.0 */
137#define AML_CONTINUE_OP (u16) 0x9f /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138#define AML_IF_OP (u16) 0xa0
139#define AML_ELSE_OP (u16) 0xa1
140#define AML_WHILE_OP (u16) 0xa2
141#define AML_NOOP_OP (u16) 0xa3
142#define AML_RETURN_OP (u16) 0xa4
143#define AML_BREAK_OP (u16) 0xa5
144#define AML_BREAK_POINT_OP (u16) 0xcc
145#define AML_ONES_OP (u16) 0xff
146
147/* prefixed opcodes */
148
Len Brown4be44fc2005-08-05 00:44:28 -0400149#define AML_EXTENDED_OPCODE (u16) 0x5b00 /* prefix for 2-byte opcodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151#define AML_MUTEX_OP (u16) 0x5b01
152#define AML_EVENT_OP (u16) 0x5b02
153#define AML_SHIFT_RIGHT_BIT_OP (u16) 0x5b10
154#define AML_SHIFT_LEFT_BIT_OP (u16) 0x5b11
155#define AML_COND_REF_OF_OP (u16) 0x5b12
156#define AML_CREATE_FIELD_OP (u16) 0x5b13
Len Brown4be44fc2005-08-05 00:44:28 -0400157#define AML_LOAD_TABLE_OP (u16) 0x5b1f /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158#define AML_LOAD_OP (u16) 0x5b20
159#define AML_STALL_OP (u16) 0x5b21
160#define AML_SLEEP_OP (u16) 0x5b22
161#define AML_ACQUIRE_OP (u16) 0x5b23
162#define AML_SIGNAL_OP (u16) 0x5b24
163#define AML_WAIT_OP (u16) 0x5b25
164#define AML_RESET_OP (u16) 0x5b26
165#define AML_RELEASE_OP (u16) 0x5b27
166#define AML_FROM_BCD_OP (u16) 0x5b28
167#define AML_TO_BCD_OP (u16) 0x5b29
168#define AML_UNLOAD_OP (u16) 0x5b2a
169#define AML_REVISION_OP (u16) 0x5b30
170#define AML_DEBUG_OP (u16) 0x5b31
171#define AML_FATAL_OP (u16) 0x5b32
Len Brown4be44fc2005-08-05 00:44:28 -0400172#define AML_TIMER_OP (u16) 0x5b33 /* ACPI 3.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173#define AML_REGION_OP (u16) 0x5b80
174#define AML_FIELD_OP (u16) 0x5b81
175#define AML_DEVICE_OP (u16) 0x5b82
176#define AML_PROCESSOR_OP (u16) 0x5b83
177#define AML_POWER_RES_OP (u16) 0x5b84
178#define AML_THERMAL_ZONE_OP (u16) 0x5b85
179#define AML_INDEX_FIELD_OP (u16) 0x5b86
180#define AML_BANK_FIELD_OP (u16) 0x5b87
Len Brown4be44fc2005-08-05 00:44:28 -0400181#define AML_DATA_REGION_OP (u16) 0x5b88 /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Bob Moore958dd242006-05-12 17:12:00 -0400183/*
184 * Combination opcodes (actually two one-byte opcodes)
Bob Mooreba494be2012-07-12 09:40:10 +0800185 * Used by the disassembler and iASL compiler
Bob Moore958dd242006-05-12 17:12:00 -0400186 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187#define AML_LGREATEREQUAL_OP (u16) 0x9295
188#define AML_LLESSEQUAL_OP (u16) 0x9294
189#define AML_LNOTEQUAL_OP (u16) 0x9293
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191/*
Bob Moore9ce81782011-11-16 13:39:07 +0800192 * Opcodes for "Field" operators
193 */
194#define AML_FIELD_OFFSET_OP (u8) 0x00
195#define AML_FIELD_ACCESS_OP (u8) 0x01
196#define AML_FIELD_CONNECTION_OP (u8) 0x02 /* ACPI 5.0 */
197#define AML_FIELD_EXT_ACCESS_OP (u8) 0x03 /* ACPI 5.0 */
198
199/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * Internal opcodes
201 * Use only "Unknown" AML opcodes, don't attempt to use
202 * any valid ACPI ASCII values (A-Z, 0-9, '-')
203 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204#define AML_INT_NAMEPATH_OP (u16) 0x002d
205#define AML_INT_NAMEDFIELD_OP (u16) 0x0030
206#define AML_INT_RESERVEDFIELD_OP (u16) 0x0031
207#define AML_INT_ACCESSFIELD_OP (u16) 0x0032
208#define AML_INT_BYTELIST_OP (u16) 0x0033
209#define AML_INT_STATICSTRING_OP (u16) 0x0034
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
Bob Moore9ce81782011-11-16 13:39:07 +0800213#define AML_INT_CONNECTION_OP (u16) 0x0038
214#define AML_INT_EXTACCESSFIELD_OP (u16) 0x0039
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#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
242
243/*
244 * Resolved argument types for the AML Interpreter
245 * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.
246 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
247 *
248 * Note1: These values are completely independent from the ACPI_TYPEs
249 * i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
250 *
251 * Note2: If and when 5 bits becomes insufficient, it would probably be best
252 * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
253 */
254
255/* Single, simple types */
256
Len Brown4be44fc2005-08-05 00:44:28 -0400257#define ARGI_ANYTYPE 0x01 /* Don't care */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#define ARGI_PACKAGE 0x02
259#define ARGI_EVENT 0x03
260#define ARGI_MUTEX 0x04
261#define ARGI_DDBHANDLE 0x05
262
263/* Interchangeable types (via implicit conversion) */
264
265#define ARGI_INTEGER 0x06
266#define ARGI_STRING 0x07
267#define ARGI_BUFFER 0x08
Len Brown4be44fc2005-08-05 00:44:28 -0400268#define ARGI_BUFFER_OR_STRING 0x09 /* Used by MID op only */
269#define ARGI_COMPUTEDATA 0x0A /* Buffer, String, or Integer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271/* Reference objects */
272
273#define ARGI_INTEGER_REF 0x0B
274#define ARGI_OBJECT_REF 0x0C
275#define ARGI_DEVICE_REF 0x0D
276#define ARGI_REFERENCE 0x0E
Len Brown4be44fc2005-08-05 00:44:28 -0400277#define ARGI_TARGETREF 0x0F /* Target, subject to implicit conversion */
278#define ARGI_FIXED_TARGET 0x10 /* Target, no implicit conversion */
279#define ARGI_SIMPLE_TARGET 0x11 /* Name, Local, Arg -- no implicit conversion */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281/* Multiple/complex types */
282
Bob Mooreba494be2012-07-12 09:40:10 +0800283#define ARGI_DATAOBJECT 0x12 /* Buffer, String, package or reference to a node - Used only by size_of operator */
Len Brown4be44fc2005-08-05 00:44:28 -0400284#define ARGI_COMPLEXOBJ 0x13 /* Buffer, String, or package (Used by INDEX op only) */
285#define ARGI_REF_OR_STRING 0x14 /* Reference or String (Used by DEREFOF op only) */
Alexey Starikovskiya6823e12007-02-02 19:48:22 +0300286#define ARGI_REGION_OR_BUFFER 0x15 /* Used by LOAD op only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287#define ARGI_DATAREFOBJ 0x16
288
289/* Note: types above can expand to 0x1F maximum */
290
291#define ARGI_INVALID_OPCODE 0xFFFFFFFF
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293/*
294 * hash offsets
295 */
296#define AML_EXTOP_HASH_OFFSET 22
297#define AML_LNOT_HASH_OFFSET 19
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299/*
300 * opcode groups and types
301 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302#define OPGRP_NAMED 0x01
303#define OPGRP_FIELD 0x02
304#define OPGRP_BYTELIST 0x04
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306/*
307 * Opcode information
308 */
309
310/* Opcode flags */
311
312#define AML_LOGICAL 0x0001
313#define AML_LOGICAL_NUMERIC 0x0002
314#define AML_MATH 0x0004
315#define AML_CREATE 0x0008
316#define AML_FIELD 0x0010
317#define AML_DEFER 0x0020
318#define AML_NAMED 0x0040
319#define AML_NSNODE 0x0080
320#define AML_NSOPCODE 0x0100
321#define AML_NSOBJECT 0x0200
322#define AML_HAS_RETVAL 0x0400
323#define AML_HAS_TARGET 0x0800
324#define AML_HAS_ARGS 0x1000
325#define AML_CONSTANT 0x2000
326#define AML_NO_OPERAND_RESOLVE 0x4000
327
328/* Convenient flag groupings */
329
330#define AML_FLAGS_EXEC_0A_0T_1R AML_HAS_RETVAL
Len Brown4be44fc2005-08-05 00:44:28 -0400331#define AML_FLAGS_EXEC_1A_0T_0R AML_HAS_ARGS /* Monadic1 */
332#define AML_FLAGS_EXEC_1A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Monadic2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333#define AML_FLAGS_EXEC_1A_1T_0R AML_HAS_ARGS | AML_HAS_TARGET
Len Brown4be44fc2005-08-05 00:44:28 -0400334#define AML_FLAGS_EXEC_1A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* monadic2_r */
335#define AML_FLAGS_EXEC_2A_0T_0R AML_HAS_ARGS /* Dyadic1 */
336#define AML_FLAGS_EXEC_2A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Dyadic2 */
337#define AML_FLAGS_EXEC_2A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* dyadic2_r */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338#define AML_FLAGS_EXEC_2A_2T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
339#define AML_FLAGS_EXEC_3A_0T_0R AML_HAS_ARGS
340#define AML_FLAGS_EXEC_3A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
341#define AML_FLAGS_EXEC_6A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343/*
344 * The opcode Type is used in a dispatch table, do not change
345 * without updating the table.
346 */
347#define AML_TYPE_EXEC_0A_0T_1R 0x00
Len Brown4be44fc2005-08-05 00:44:28 -0400348#define AML_TYPE_EXEC_1A_0T_0R 0x01 /* Monadic1 */
349#define AML_TYPE_EXEC_1A_0T_1R 0x02 /* Monadic2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350#define AML_TYPE_EXEC_1A_1T_0R 0x03
Len Brown4be44fc2005-08-05 00:44:28 -0400351#define AML_TYPE_EXEC_1A_1T_1R 0x04 /* monadic2_r */
352#define AML_TYPE_EXEC_2A_0T_0R 0x05 /* Dyadic1 */
353#define AML_TYPE_EXEC_2A_0T_1R 0x06 /* Dyadic2 */
354#define AML_TYPE_EXEC_2A_1T_1R 0x07 /* dyadic2_r */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355#define AML_TYPE_EXEC_2A_2T_1R 0x08
356#define AML_TYPE_EXEC_3A_0T_0R 0x09
357#define AML_TYPE_EXEC_3A_1T_1R 0x0A
358#define AML_TYPE_EXEC_6A_0T_1R 0x0B
359/* End of types used in dispatch table */
360
361#define AML_TYPE_LITERAL 0x0B
362#define AML_TYPE_CONSTANT 0x0C
363#define AML_TYPE_METHOD_ARGUMENT 0x0D
364#define AML_TYPE_LOCAL_VARIABLE 0x0E
365#define AML_TYPE_DATA_TERM 0x0F
366
367/* Generic for an op that returns a value */
368
369#define AML_TYPE_METHOD_CALL 0x10
370
371/* Misc */
372
373#define AML_TYPE_CREATE_FIELD 0x11
374#define AML_TYPE_CREATE_OBJECT 0x12
375#define AML_TYPE_CONTROL 0x13
376#define AML_TYPE_NAMED_NO_OBJ 0x14
377#define AML_TYPE_NAMED_FIELD 0x15
378#define AML_TYPE_NAMED_SIMPLE 0x16
379#define AML_TYPE_NAMED_COMPLEX 0x17
380#define AML_TYPE_RETURN 0x18
381
382#define AML_TYPE_UNDEFINED 0x19
383#define AML_TYPE_BOGUS 0x1A
384
Robert Moore44f6c012005-04-18 22:49:35 -0400385/* AML Package Length encodings */
386
387#define ACPI_AML_PACKAGE_TYPE1 0x40
388#define ACPI_AML_PACKAGE_TYPE2 0x4000
389#define ACPI_AML_PACKAGE_TYPE3 0x400000
390#define ACPI_AML_PACKAGE_TYPE4 0x40000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392/*
393 * Opcode classes
394 */
395#define AML_CLASS_EXECUTE 0x00
396#define AML_CLASS_CREATE 0x01
397#define AML_CLASS_ARGUMENT 0x02
398#define AML_CLASS_NAMED_OBJECT 0x03
399#define AML_CLASS_CONTROL 0x04
400#define AML_CLASS_ASCII 0x05
401#define AML_CLASS_PREFIX 0x06
402#define AML_CLASS_INTERNAL 0x07
403#define AML_CLASS_RETURN_VALUE 0x08
404#define AML_CLASS_METHOD_CALL 0x09
405#define AML_CLASS_UNKNOWN 0x0A
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/* Comparison operation codes for match_op operator */
408
Len Brown4be44fc2005-08-05 00:44:28 -0400409typedef enum {
410 MATCH_MTR = 0,
411 MATCH_MEQ = 1,
412 MATCH_MLE = 2,
413 MATCH_MLT = 3,
414 MATCH_MGE = 4,
415 MATCH_MGT = 5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416} AML_MATCH_OPERATOR;
417
418#define MAX_MATCH_OPERATOR 5
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420/*
421 * field_flags
422 *
423 * This byte is extracted from the AML and includes three separate
424 * pieces of information about the field:
425 * 1) The field access type
426 * 2) The field update rule
427 * 3) The lock rule for the field
428 *
429 * Bits 00 - 03 : access_type (any_acc, byte_acc, etc.)
430 * 04 : lock_rule (1 == Lock)
431 * 05 - 06 : update_rule
432 */
433#define AML_FIELD_ACCESS_TYPE_MASK 0x0F
434#define AML_FIELD_LOCK_RULE_MASK 0x10
435#define AML_FIELD_UPDATE_RULE_MASK 0x60
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437/* 1) Field Access Types */
438
Len Brown4be44fc2005-08-05 00:44:28 -0400439typedef enum {
440 AML_FIELD_ACCESS_ANY = 0x00,
441 AML_FIELD_ACCESS_BYTE = 0x01,
442 AML_FIELD_ACCESS_WORD = 0x02,
443 AML_FIELD_ACCESS_DWORD = 0x03,
444 AML_FIELD_ACCESS_QWORD = 0x04, /* ACPI 2.0 */
445 AML_FIELD_ACCESS_BUFFER = 0x05 /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446} AML_ACCESS_TYPE;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448/* 2) Field Lock Rules */
449
Len Brown4be44fc2005-08-05 00:44:28 -0400450typedef enum {
451 AML_FIELD_LOCK_NEVER = 0x00,
452 AML_FIELD_LOCK_ALWAYS = 0x10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453} AML_LOCK_RULE;
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455/* 3) Field Update Rules */
456
Len Brown4be44fc2005-08-05 00:44:28 -0400457typedef enum {
458 AML_FIELD_UPDATE_PRESERVE = 0x00,
459 AML_FIELD_UPDATE_WRITE_AS_ONES = 0x20,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461} AML_UPDATE_RULE;
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463/*
464 * Field Access Attributes.
465 * This byte is extracted from the AML via the
466 * access_as keyword
467 */
Len Brown4be44fc2005-08-05 00:44:28 -0400468typedef enum {
Bob Moore2da120b2011-11-16 14:14:32 +0800469 AML_FIELD_ATTRIB_QUICK = 0x02,
470 AML_FIELD_ATTRIB_SEND_RCV = 0x04,
471 AML_FIELD_ATTRIB_BYTE = 0x06,
472 AML_FIELD_ATTRIB_WORD = 0x08,
473 AML_FIELD_ATTRIB_BLOCK = 0x0A,
474 AML_FIELD_ATTRIB_MULTIBYTE = 0x0B,
475 AML_FIELD_ATTRIB_WORD_CALL = 0x0C,
476 AML_FIELD_ATTRIB_BLOCK_CALL = 0x0D,
477 AML_FIELD_ATTRIB_RAW_BYTES = 0x0E,
478 AML_FIELD_ATTRIB_RAW_PROCESS = 0x0F
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479} AML_ACCESS_ATTRIBUTE;
480
Lin Ming26294842011-01-12 09:19:43 +0800481/* Bit fields in the AML method_flags byte */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483#define AML_METHOD_ARG_COUNT 0x07
484#define AML_METHOD_SERIALIZED 0x08
Lin Mingb2f7ddc2009-05-21 10:42:09 +0800485#define AML_METHOD_SYNC_LEVEL 0xF0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Len Brown4be44fc2005-08-05 00:44:28 -0400487#endif /* __AMLCODE_H__ */