xref: /freebsd/sys/contrib/edk2/Include/IndustryStandard/AcpiAml.h (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1 /** @file
2   This file contains AML code definition in the latest ACPI spec.
3 
4   Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
5   Copyright (c) 2019, ARM Limited. All rights reserved.<BR>
6   SPDX-License-Identifier: BSD-2-Clause-Patent
7 
8 **/
9 
10 #ifndef _ACPI_AML_H_
11 #define _ACPI_AML_H_
12 
13 //
14 // ACPI AML definition
15 //
16 
17 //
18 // Primary OpCode
19 //
20 #define AML_ZERO_OP                  0x00
21 #define AML_ONE_OP                   0x01
22 #define AML_ALIAS_OP                 0x06
23 #define AML_NAME_OP                  0x08
24 #define AML_BYTE_PREFIX              0x0a
25 #define AML_WORD_PREFIX              0x0b
26 #define AML_DWORD_PREFIX             0x0c
27 #define AML_STRING_PREFIX            0x0d
28 #define AML_QWORD_PREFIX             0x0e
29 #define AML_SCOPE_OP                 0x10
30 #define AML_BUFFER_OP                0x11
31 #define AML_PACKAGE_OP               0x12
32 #define AML_VAR_PACKAGE_OP           0x13
33 #define AML_METHOD_OP                0x14
34 #define AML_EXTERNAL_OP              0x15
35 #define AML_DUAL_NAME_PREFIX         0x2e
36 #define AML_MULTI_NAME_PREFIX        0x2f
37 #define AML_NAME_CHAR_A              0x41
38 #define AML_NAME_CHAR_B              0x42
39 #define AML_NAME_CHAR_C              0x43
40 #define AML_NAME_CHAR_D              0x44
41 #define AML_NAME_CHAR_E              0x45
42 #define AML_NAME_CHAR_F              0x46
43 #define AML_NAME_CHAR_G              0x47
44 #define AML_NAME_CHAR_H              0x48
45 #define AML_NAME_CHAR_I              0x49
46 #define AML_NAME_CHAR_J              0x4a
47 #define AML_NAME_CHAR_K              0x4b
48 #define AML_NAME_CHAR_L              0x4c
49 #define AML_NAME_CHAR_M              0x4d
50 #define AML_NAME_CHAR_N              0x4e
51 #define AML_NAME_CHAR_O              0x4f
52 #define AML_NAME_CHAR_P              0x50
53 #define AML_NAME_CHAR_Q              0x51
54 #define AML_NAME_CHAR_R              0x52
55 #define AML_NAME_CHAR_S              0x53
56 #define AML_NAME_CHAR_T              0x54
57 #define AML_NAME_CHAR_U              0x55
58 #define AML_NAME_CHAR_V              0x56
59 #define AML_NAME_CHAR_W              0x57
60 #define AML_NAME_CHAR_X              0x58
61 #define AML_NAME_CHAR_Y              0x59
62 #define AML_NAME_CHAR_Z              0x5a
63 #define AML_ROOT_CHAR                0x5c
64 #define AML_PARENT_PREFIX_CHAR       0x5e
65 #define AML_NAME_CHAR__              0x5f
66 #define AML_LOCAL0                   0x60
67 #define AML_LOCAL1                   0x61
68 #define AML_LOCAL2                   0x62
69 #define AML_LOCAL3                   0x63
70 #define AML_LOCAL4                   0x64
71 #define AML_LOCAL5                   0x65
72 #define AML_LOCAL6                   0x66
73 #define AML_LOCAL7                   0x67
74 #define AML_ARG0                     0x68
75 #define AML_ARG1                     0x69
76 #define AML_ARG2                     0x6a
77 #define AML_ARG3                     0x6b
78 #define AML_ARG4                     0x6c
79 #define AML_ARG5                     0x6d
80 #define AML_ARG6                     0x6e
81 #define AML_STORE_OP                 0x70
82 #define AML_REF_OF_OP                0x71
83 #define AML_ADD_OP                   0x72
84 #define AML_CONCAT_OP                0x73
85 #define AML_SUBTRACT_OP              0x74
86 #define AML_INCREMENT_OP             0x75
87 #define AML_DECREMENT_OP             0x76
88 #define AML_MULTIPLY_OP              0x77
89 #define AML_DIVIDE_OP                0x78
90 #define AML_SHIFT_LEFT_OP            0x79
91 #define AML_SHIFT_RIGHT_OP           0x7a
92 #define AML_AND_OP                   0x7b
93 #define AML_NAND_OP                  0x7c
94 #define AML_OR_OP                    0x7d
95 #define AML_NOR_OP                   0x7e
96 #define AML_XOR_OP                   0x7f
97 #define AML_NOT_OP                   0x80
98 #define AML_FIND_SET_LEFT_BIT_OP     0x81
99 #define AML_FIND_SET_RIGHT_BIT_OP    0x82
100 #define AML_DEREF_OF_OP              0x83
101 #define AML_CONCAT_RES_OP            0x84
102 #define AML_MOD_OP                   0x85
103 #define AML_NOTIFY_OP                0x86
104 #define AML_SIZE_OF_OP               0x87
105 #define AML_INDEX_OP                 0x88
106 #define AML_MATCH_OP                 0x89
107 #define AML_CREATE_DWORD_FIELD_OP    0x8a
108 #define AML_CREATE_WORD_FIELD_OP     0x8b
109 #define AML_CREATE_BYTE_FIELD_OP     0x8c
110 #define AML_CREATE_BIT_FIELD_OP      0x8d
111 #define AML_OBJECT_TYPE_OP           0x8e
112 #define AML_CREATE_QWORD_FIELD_OP    0x8f
113 #define AML_LAND_OP                  0x90
114 #define AML_LOR_OP                   0x91
115 #define AML_LNOT_OP                  0x92
116 #define AML_LEQUAL_OP                0x93
117 #define AML_LGREATER_OP              0x94
118 #define AML_LLESS_OP                 0x95
119 #define AML_TO_BUFFER_OP             0x96
120 #define AML_TO_DEC_STRING_OP         0x97
121 #define AML_TO_HEX_STRING_OP         0x98
122 #define AML_TO_INTEGER_OP            0x99
123 #define AML_TO_STRING_OP             0x9c
124 #define AML_COPY_OBJECT_OP           0x9d
125 #define AML_MID_OP                   0x9e
126 #define AML_CONTINUE_OP              0x9f
127 #define AML_IF_OP                    0xa0
128 #define AML_ELSE_OP                  0xa1
129 #define AML_WHILE_OP                 0xa2
130 #define AML_NOOP_OP                  0xa3
131 #define AML_RETURN_OP                0xa4
132 #define AML_BREAK_OP                 0xa5
133 #define AML_BREAK_POINT_OP           0xcc
134 #define AML_ONES_OP                  0xff
135 
136 //
137 // Extended OpCode
138 //
139 #define AML_EXT_OP                   0x5b
140 
141 #define AML_EXT_MUTEX_OP             0x01
142 #define AML_EXT_EVENT_OP             0x02
143 #define AML_EXT_COND_REF_OF_OP       0x12
144 #define AML_EXT_CREATE_FIELD_OP      0x13
145 #define AML_EXT_LOAD_TABLE_OP        0x1f
146 #define AML_EXT_LOAD_OP              0x20
147 #define AML_EXT_STALL_OP             0x21
148 #define AML_EXT_SLEEP_OP             0x22
149 #define AML_EXT_ACQUIRE_OP           0x23
150 #define AML_EXT_SIGNAL_OP            0x24
151 #define AML_EXT_WAIT_OP              0x25
152 #define AML_EXT_RESET_OP             0x26
153 #define AML_EXT_RELEASE_OP           0x27
154 #define AML_EXT_FROM_BCD_OP          0x28
155 #define AML_EXT_TO_BCD_OP            0x29
156 #define AML_EXT_UNLOAD_OP            0x2a
157 #define AML_EXT_REVISION_OP          0x30
158 #define AML_EXT_DEBUG_OP             0x31
159 #define AML_EXT_FATAL_OP             0x32
160 #define AML_EXT_TIMER_OP             0x33
161 #define AML_EXT_REGION_OP            0x80
162 #define AML_EXT_FIELD_OP             0x81
163 #define AML_EXT_DEVICE_OP            0x82
164 #define AML_EXT_PROCESSOR_OP         0x83
165 #define AML_EXT_POWER_RES_OP         0x84
166 #define AML_EXT_THERMAL_ZONE_OP      0x85
167 #define AML_EXT_INDEX_FIELD_OP       0x86
168 #define AML_EXT_BANK_FIELD_OP        0x87
169 #define AML_EXT_DATA_REGION_OP       0x88
170 
171 //
172 // FieldElement OpCode
173 //
174 #define AML_FIELD_RESERVED_OP        0x00
175 #define AML_FIELD_ACCESS_OP          0x01
176 #define AML_FIELD_CONNECTION_OP      0x02
177 #define AML_FIELD_EXT_ACCESS_OP      0x03
178 
179 #endif
180