]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | Describes the protocol interface to the EBC interpreter.\r | |
3 | \r | |
9095d37b | 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
d1f95000 | 6 | \r |
d1f95000 | 7 | **/\r |
8 | \r | |
9 | #ifndef __EFI_EBC_PROTOCOL_H__\r | |
10 | #define __EFI_EBC_PROTOCOL_H__\r | |
11 | \r | |
12 | #define EFI_EBC_INTERPRETER_PROTOCOL_GUID \\r | |
13 | { \\r | |
14 | 0x13AC6DD1, 0x73D0, 0x11D4, {0xB0, 0x6B, 0x00, 0xAA, 0x00, 0xBD, 0x6D, 0xE7 } \\r | |
15 | }\r | |
16 | \r | |
3e2c7843 PB |
17 | //\r |
18 | // Define OPCODES\r | |
19 | //\r | |
20 | #define OPCODE_BREAK 0x00\r | |
21 | #define OPCODE_JMP 0x01\r | |
22 | #define OPCODE_JMP8 0x02\r | |
23 | #define OPCODE_CALL 0x03\r | |
24 | #define OPCODE_RET 0x04\r | |
25 | #define OPCODE_CMPEQ 0x05\r | |
26 | #define OPCODE_CMPLTE 0x06\r | |
27 | #define OPCODE_CMPGTE 0x07\r | |
28 | #define OPCODE_CMPULTE 0x08\r | |
29 | #define OPCODE_CMPUGTE 0x09\r | |
30 | #define OPCODE_NOT 0x0A\r | |
31 | #define OPCODE_NEG 0x0B\r | |
32 | #define OPCODE_ADD 0x0C\r | |
33 | #define OPCODE_SUB 0x0D\r | |
34 | #define OPCODE_MUL 0x0E\r | |
35 | #define OPCODE_MULU 0x0F\r | |
36 | #define OPCODE_DIV 0x10\r | |
37 | #define OPCODE_DIVU 0x11\r | |
38 | #define OPCODE_MOD 0x12\r | |
39 | #define OPCODE_MODU 0x13\r | |
40 | #define OPCODE_AND 0x14\r | |
41 | #define OPCODE_OR 0x15\r | |
42 | #define OPCODE_XOR 0x16\r | |
43 | #define OPCODE_SHL 0x17\r | |
44 | #define OPCODE_SHR 0x18\r | |
45 | #define OPCODE_ASHR 0x19\r | |
46 | #define OPCODE_EXTNDB 0x1A\r | |
47 | #define OPCODE_EXTNDW 0x1B\r | |
48 | #define OPCODE_EXTNDD 0x1C\r | |
49 | #define OPCODE_MOVBW 0x1D\r | |
50 | #define OPCODE_MOVWW 0x1E\r | |
51 | #define OPCODE_MOVDW 0x1F\r | |
52 | #define OPCODE_MOVQW 0x20\r | |
53 | #define OPCODE_MOVBD 0x21\r | |
54 | #define OPCODE_MOVWD 0x22\r | |
55 | #define OPCODE_MOVDD 0x23\r | |
56 | #define OPCODE_MOVQD 0x24\r | |
57 | #define OPCODE_MOVSNW 0x25 // Move signed natural with word index\r | |
58 | #define OPCODE_MOVSND 0x26 // Move signed natural with dword index\r | |
59 | //\r | |
60 | // #define OPCODE_27 0x27\r | |
61 | //\r | |
62 | #define OPCODE_MOVQQ 0x28 // Does this go away?\r | |
63 | #define OPCODE_LOADSP 0x29\r | |
64 | #define OPCODE_STORESP 0x2A\r | |
65 | #define OPCODE_PUSH 0x2B\r | |
66 | #define OPCODE_POP 0x2C\r | |
67 | #define OPCODE_CMPIEQ 0x2D\r | |
68 | #define OPCODE_CMPILTE 0x2E\r | |
69 | #define OPCODE_CMPIGTE 0x2F\r | |
70 | #define OPCODE_CMPIULTE 0x30\r | |
71 | #define OPCODE_CMPIUGTE 0x31\r | |
72 | #define OPCODE_MOVNW 0x32\r | |
73 | #define OPCODE_MOVND 0x33\r | |
74 | //\r | |
75 | // #define OPCODE_34 0x34\r | |
76 | //\r | |
77 | #define OPCODE_PUSHN 0x35\r | |
78 | #define OPCODE_POPN 0x36\r | |
79 | #define OPCODE_MOVI 0x37\r | |
80 | #define OPCODE_MOVIN 0x38\r | |
81 | #define OPCODE_MOVREL 0x39\r | |
82 | \r | |
83 | //\r | |
84 | // Bit masks for opcode encodings\r | |
85 | //\r | |
86 | #define OPCODE_M_OPCODE 0x3F // bits of interest for first level decode\r | |
87 | #define OPCODE_M_IMMDATA 0x80\r | |
88 | #define OPCODE_M_IMMDATA64 0x40\r | |
89 | #define OPCODE_M_64BIT 0x40 // for CMP\r | |
90 | #define OPCODE_M_RELADDR 0x10 // for CALL instruction\r | |
91 | #define OPCODE_M_CMPI32_DATA 0x80 // for CMPI\r | |
92 | #define OPCODE_M_CMPI64 0x40 // for CMPI 32 or 64 bit comparison\r | |
93 | #define OPERAND_M_MOVIN_N 0x80\r | |
94 | #define OPERAND_M_CMPI_INDEX 0x10\r | |
95 | \r | |
96 | //\r | |
97 | // Masks for instructions that encode presence of indexes for operand1 and/or\r | |
98 | // operand2.\r | |
99 | //\r | |
100 | #define OPCODE_M_IMMED_OP1 0x80\r | |
101 | #define OPCODE_M_IMMED_OP2 0x40\r | |
102 | \r | |
103 | //\r | |
104 | // Bit masks for operand encodings\r | |
105 | //\r | |
106 | #define OPERAND_M_INDIRECT1 0x08\r | |
107 | #define OPERAND_M_INDIRECT2 0x80\r | |
108 | #define OPERAND_M_OP1 0x07\r | |
109 | #define OPERAND_M_OP2 0x70\r | |
110 | \r | |
111 | //\r | |
112 | // Masks for data manipulation instructions\r | |
113 | //\r | |
114 | #define DATAMANIP_M_64 0x40 // 64-bit width operation\r | |
115 | #define DATAMANIP_M_IMMDATA 0x80\r | |
116 | \r | |
117 | //\r | |
118 | // For MOV instructions, need a mask for the opcode when immediate\r | |
119 | // data applies to R2.\r | |
120 | //\r | |
121 | #define OPCODE_M_IMMED_OP2 0x40\r | |
122 | \r | |
123 | //\r | |
124 | // The MOVI/MOVIn instructions use bit 6 of operands byte to indicate\r | |
125 | // if an index is present. Then bits 4 and 5 are used to indicate the width\r | |
126 | // of the move.\r | |
127 | //\r | |
128 | #define MOVI_M_IMMDATA 0x40\r | |
129 | #define MOVI_M_DATAWIDTH 0xC0\r | |
130 | #define MOVI_DATAWIDTH16 0x40\r | |
131 | #define MOVI_DATAWIDTH32 0x80\r | |
132 | #define MOVI_DATAWIDTH64 0xC0\r | |
133 | #define MOVI_M_MOVEWIDTH 0x30\r | |
134 | #define MOVI_MOVEWIDTH8 0x00\r | |
135 | #define MOVI_MOVEWIDTH16 0x10\r | |
136 | #define MOVI_MOVEWIDTH32 0x20\r | |
137 | #define MOVI_MOVEWIDTH64 0x30\r | |
138 | \r | |
139 | //\r | |
140 | // Masks for CALL instruction encodings\r | |
141 | //\r | |
142 | #define OPERAND_M_RELATIVE_ADDR 0x10\r | |
143 | #define OPERAND_M_NATIVE_CALL 0x20\r | |
144 | \r | |
145 | //\r | |
146 | // Masks for decoding push/pop instructions\r | |
147 | //\r | |
148 | #define PUSHPOP_M_IMMDATA 0x80 // opcode bit indicating immediate data\r | |
149 | #define PUSHPOP_M_64 0x40 // opcode bit indicating 64-bit operation\r | |
150 | //\r | |
151 | // Mask for operand of JMP instruction\r | |
152 | //\r | |
153 | #define JMP_M_RELATIVE 0x10\r | |
154 | #define JMP_M_CONDITIONAL 0x80\r | |
155 | #define JMP_M_CS 0x40\r | |
156 | \r | |
157 | //\r | |
158 | // Macros to determine if a given operand is indirect\r | |
159 | //\r | |
160 | #define OPERAND1_INDIRECT(op) ((op) & OPERAND_M_INDIRECT1)\r | |
161 | #define OPERAND2_INDIRECT(op) ((op) & OPERAND_M_INDIRECT2)\r | |
162 | \r | |
163 | //\r | |
164 | // Macros to extract the operands from second byte of instructions\r | |
165 | //\r | |
166 | #define OPERAND1_REGNUM(op) ((op) & OPERAND_M_OP1)\r | |
167 | #define OPERAND2_REGNUM(op) (((op) & OPERAND_M_OP2) >> 4)\r | |
168 | \r | |
169 | #define OPERAND1_CHAR(op) ('0' + OPERAND1_REGNUM (op))\r | |
170 | #define OPERAND2_CHAR(op) ('0' + OPERAND2_REGNUM (op))\r | |
171 | \r | |
172 | //\r | |
173 | // Condition masks usually for byte 1 encodings of code\r | |
174 | //\r | |
175 | #define CONDITION_M_CONDITIONAL 0x80\r | |
176 | #define CONDITION_M_CS 0x40\r | |
177 | \r | |
99e8ed21 | 178 | ///\r |
179 | /// Protocol Guid Name defined in spec.\r | |
180 | ///\r | |
d1f95000 | 181 | #define EFI_EBC_PROTOCOL_GUID EFI_EBC_INTERPRETER_PROTOCOL_GUID\r |
182 | \r | |
99e8ed21 | 183 | ///\r |
184 | /// Define for forward reference.\r | |
185 | ///\r | |
d1f95000 | 186 | typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;\r |
187 | \r | |
188 | /**\r | |
4ca9b6c4 | 189 | Creates a thunk for an EBC entry point, returning the address of the thunk.\r |
9095d37b | 190 | \r |
4ca9b6c4 | 191 | A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the\r |
630b4187 | 192 | entry point for image execution. However, for EBC images, this is the entry point of EBC\r |
193 | instructions, so is not directly executable by the native processor. Therefore, when an EBC image is\r | |
194 | loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed,\r | |
4ca9b6c4 LG |
195 | which will invoke the interpreter to begin execution at the original EBC entry point.\r |
196 | \r | |
197 | @param This A pointer to the EFI_EBC_PROTOCOL instance.\r | |
198 | @param ImageHandle Handle of image for which the thunk is being created.\r | |
199 | @param EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.\r | |
f754f721 | 200 | @param Thunk Returned pointer to a thunk created.\r |
4ca9b6c4 LG |
201 | \r |
202 | @retval EFI_SUCCESS The function completed successfully.\r | |
203 | @retval EFI_INVALID_PARAMETER Image entry point is not 2-byte aligned.\r | |
204 | @retval EFI_OUT_OF_RESOURCES Memory could not be allocated for the thunk.\r | |
d1f95000 | 205 | **/\r |
206 | typedef\r | |
207 | EFI_STATUS\r | |
8b13229b | 208 | (EFIAPI *EFI_EBC_CREATE_THUNK)(\r |
d1f95000 | 209 | IN EFI_EBC_PROTOCOL *This,\r |
210 | IN EFI_HANDLE ImageHandle,\r | |
211 | IN VOID *EbcEntryPoint,\r | |
212 | OUT VOID **Thunk\r | |
213 | );\r | |
214 | \r | |
215 | /**\r | |
4ca9b6c4 | 216 | Called prior to unloading an EBC image from memory.\r |
d1f95000 | 217 | \r |
4ca9b6c4 LG |
218 | This function is called after an EBC image has exited, but before the image is actually unloaded. It\r |
219 | is intended to provide the interpreter with the opportunity to perform any cleanup that may be\r | |
220 | necessary as a result of loading and executing the image.\r | |
d1f95000 | 221 | \r |
4ca9b6c4 LG |
222 | @param This A pointer to the EFI_EBC_PROTOCOL instance.\r |
223 | @param ImageHandle Image handle of the EBC image that is being unloaded from memory.\r | |
d1f95000 | 224 | \r |
4ca9b6c4 | 225 | @retval EFI_SUCCESS The function completed successfully.\r |
9095d37b | 226 | @retval EFI_INVALID_PARAMETER Image handle is not recognized as belonging\r |
4ca9b6c4 | 227 | to an EBC image that has been executed.\r |
d1f95000 | 228 | **/\r |
229 | typedef\r | |
230 | EFI_STATUS\r | |
8b13229b | 231 | (EFIAPI *EFI_EBC_UNLOAD_IMAGE)(\r |
d1f95000 | 232 | IN EFI_EBC_PROTOCOL *This,\r |
233 | IN EFI_HANDLE ImageHandle\r | |
234 | );\r | |
235 | \r | |
236 | /**\r | |
9095d37b | 237 | This is the prototype for the Flush callback routine. A pointer to a routine\r |
4ca9b6c4 | 238 | of this type is passed to the EBC EFI_EBC_REGISTER_ICACHE_FLUSH protocol service.\r |
d1f95000 | 239 | \r |
4ca9b6c4 LG |
240 | @param Start The beginning physical address to flush from the processor's instruction cache.\r |
241 | @param Length The number of bytes to flush from the processor's instruction cache.\r | |
d1f95000 | 242 | \r |
4ca9b6c4 | 243 | @retval EFI_SUCCESS The function completed successfully.\r |
d1f95000 | 244 | \r |
245 | **/\r | |
246 | typedef\r | |
247 | EFI_STATUS\r | |
8b13229b | 248 | (EFIAPI *EBC_ICACHE_FLUSH)(\r |
d1f95000 | 249 | IN EFI_PHYSICAL_ADDRESS Start,\r |
250 | IN UINT64 Length\r | |
251 | );\r | |
252 | \r | |
253 | /**\r | |
9095d37b | 254 | Registers a callback function that the EBC interpreter calls to flush\r |
74fec708 | 255 | the processor instruction cache following creation of thunks.\r |
d1f95000 | 256 | \r |
4ca9b6c4 LG |
257 | @param This A pointer to the EFI_EBC_PROTOCOL instance.\r |
258 | @param Flush Pointer to a function of type EBC_ICACH_FLUSH.\r | |
d1f95000 | 259 | \r |
4ca9b6c4 | 260 | @retval EFI_SUCCESS The function completed successfully.\r |
d1f95000 | 261 | \r |
262 | **/\r | |
263 | typedef\r | |
264 | EFI_STATUS\r | |
8b13229b | 265 | (EFIAPI *EFI_EBC_REGISTER_ICACHE_FLUSH)(\r |
d1f95000 | 266 | IN EFI_EBC_PROTOCOL *This,\r |
267 | IN EBC_ICACHE_FLUSH Flush\r | |
268 | );\r | |
269 | \r | |
270 | /**\r | |
4ca9b6c4 LG |
271 | Called to get the version of the interpreter.\r |
272 | \r | |
273 | This function is called to get the version of the loaded EBC interpreter. The value and format of the\r | |
274 | returned version is identical to that returned by the EBC BREAK 1 instruction.\r | |
d1f95000 | 275 | \r |
9095d37b | 276 | @param This A pointer to the EFI_EBC_PROTOCOL instance.\r |
f754f721 | 277 | @param Version Pointer to where to store the returned version of the interpreter.\r |
d1f95000 | 278 | \r |
4ca9b6c4 LG |
279 | @retval EFI_SUCCESS The function completed successfully.\r |
280 | @retval EFI_INVALID_PARAMETER Version pointer is NULL.\r | |
d1f95000 | 281 | \r |
282 | **/\r | |
283 | typedef\r | |
284 | EFI_STATUS\r | |
8b13229b | 285 | (EFIAPI *EFI_EBC_GET_VERSION)(\r |
d1f95000 | 286 | IN EFI_EBC_PROTOCOL *This,\r |
287 | IN OUT UINT64 *Version\r | |
288 | );\r | |
289 | \r | |
44717a39 | 290 | ///\r |
291 | /// The EFI EBC protocol provides services to load and execute EBC images, which will typically be\r | |
292 | /// loaded into option ROMs. The image loader will load the EBC image, perform standard relocations,\r | |
293 | /// and invoke the CreateThunk() service to create a thunk for the EBC image's entry point. The\r | |
294 | /// image can then be run using the standard EFI start image services.\r | |
295 | ///\r | |
d1f95000 | 296 | struct _EFI_EBC_PROTOCOL {\r |
297 | EFI_EBC_CREATE_THUNK CreateThunk;\r | |
298 | EFI_EBC_UNLOAD_IMAGE UnloadImage;\r | |
299 | EFI_EBC_REGISTER_ICACHE_FLUSH RegisterICacheFlush;\r | |
300 | EFI_EBC_GET_VERSION GetVersion;\r | |
301 | };\r | |
302 | \r | |
303 | //\r | |
304 | // Extern the global EBC protocol GUID\r | |
305 | //\r | |
306 | extern EFI_GUID gEfiEbcProtocolGuid;\r | |
307 | \r | |
308 | #endif\r |