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