]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Foundation/Efi/Include/EfiImage.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Maintainers.txt: Remove EdkCompatibilityPkg information
[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Efi / Include / EfiImage.h
CommitLineData
3eb9473e 1/*++\r
2\r
3e99020d 3Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
f57387d5 4This program and the accompanying materials \r
3eb9473e 5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 EfiImage.h\r
15\r
16Abstract:\r
17\r
18 EFI image format for PE32+. Please note some data structures are different\r
19 for IA-32 and Itanium-based images, look for UINTN and the #ifdef EFI_IA64\r
20\r
21 BugBug: Fix text - doc as defined in MSFT EFI specification\r
22\r
23--*/\r
24\r
25#ifndef _EFI_IMAGE_H_\r
26#define _EFI_IMAGE_H_\r
27\r
28//\r
29// PE32+ Subsystem type for EFI images\r
30//\r
31#define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION 10\r
32#define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11\r
33#define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12\r
34\r
35//\r
36// BugBug: Need to get a real answer for this problem. This is not in the\r
37// PE specification.\r
38//\r
39// A SAL runtime driver does not get fixed up when a transition to\r
40// virtual mode is made. In all other cases it should be treated\r
41// like a EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER image\r
42//\r
43#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13\r
44\r
45//\r
46// PE32+ Machine type for EFI images\r
47//\r
48#define EFI_IMAGE_MACHINE_IA32 0x014c\r
49#define EFI_IMAGE_MACHINE_IA64 0x0200\r
50#define EFI_IMAGE_MACHINE_X64 0x8664\r
1afe0401 51#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01c2\r
373fbc64 52#define EFI_IMAGE_MACHINE_AARCH64 0xAA64\r
1afe0401 53\r
3eb9473e 54//\r
55// #define EFI_IMAGE_MACHINE_FCODE 0xfc0d\r
56//\r
57#define EFI_IMAGE_MACHINE_EBC 0x0EBC\r
58\r
59#define EFI_IMAGE_DOS_SIGNATURE 0x5A4D // MZ\r
60#define EFI_IMAGE_OS2_SIGNATURE 0x454E // NE\r
61#define EFI_IMAGE_OS2_SIGNATURE_LE 0x454C // LE\r
62#define EFI_IMAGE_NT_SIGNATURE 0x00004550 // PE00\r
63#define EFI_IMAGE_EDOS_SIGNATURE 0x44454550 // PEED\r
64//\r
65// PE images can start with an optional DOS header, so if an image is run\r
66// under DOS it can print an error message.\r
67//\r
68typedef struct {\r
69 UINT16 e_magic; // Magic number\r
70 UINT16 e_cblp; // Bytes on last page of file\r
71 UINT16 e_cp; // Pages in file\r
72 UINT16 e_crlc; // Relocations\r
73 UINT16 e_cparhdr; // Size of header in paragraphs\r
74 UINT16 e_minalloc; // Minimum extra paragraphs needed\r
75 UINT16 e_maxalloc; // Maximum extra paragraphs needed\r
76 UINT16 e_ss; // Initial (relative) SS value\r
77 UINT16 e_sp; // Initial SP value\r
78 UINT16 e_csum; // Checksum\r
79 UINT16 e_ip; // Initial IP value\r
80 UINT16 e_cs; // Initial (relative) CS value\r
81 UINT16 e_lfarlc; // File address of relocation table\r
82 UINT16 e_ovno; // Overlay number\r
83 UINT16 e_res[4]; // Reserved words\r
84 UINT16 e_oemid; // OEM identifier (for e_oeminfo)\r
85 UINT16 e_oeminfo; // OEM information; e_oemid specific\r
86 UINT16 e_res2[10]; // Reserved words\r
87 UINT32 e_lfanew; // File address of new exe header\r
88} EFI_IMAGE_DOS_HEADER;\r
89\r
90//\r
91// File header format.\r
92//\r
93typedef struct {\r
94 UINT16 Machine;\r
95 UINT16 NumberOfSections;\r
96 UINT32 TimeDateStamp;\r
97 UINT32 PointerToSymbolTable;\r
98 UINT32 NumberOfSymbols;\r
99 UINT16 SizeOfOptionalHeader;\r
100 UINT16 Characteristics;\r
101} EFI_IMAGE_FILE_HEADER;\r
102\r
103#define EFI_IMAGE_SIZEOF_FILE_HEADER 20\r
104\r
105#define EFI_IMAGE_FILE_RELOCS_STRIPPED 0x0001 // Relocation info stripped from file.\r
106#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE 0x0002 // File is executable (i.e. no unresolved externel references).\r
107#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED 0x0004 // Line nunbers stripped from file.\r
108#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED 0x0008 // Local symbols stripped from file.\r
109#define EFI_IMAGE_FILE_BYTES_REVERSED_LO 0x0080 // Bytes of machine word are reversed.\r
110#define EFI_IMAGE_FILE_32BIT_MACHINE 0x0100 // 32 bit word machine.\r
111#define EFI_IMAGE_FILE_DEBUG_STRIPPED 0x0200 // Debugging info stripped from file in .DBG file\r
112#define EFI_IMAGE_FILE_SYSTEM 0x1000 // System File.\r
113#define EFI_IMAGE_FILE_DLL 0x2000 // File is a DLL.\r
114#define EFI_IMAGE_FILE_BYTES_REVERSED_HI 0x8000 // Bytes of machine word are reversed.\r
115#define EFI_IMAGE_FILE_MACHINE_UNKNOWN 0\r
116#define EFI_IMAGE_FILE_MACHINE_I386 0x14c // Intel 386.\r
117#define EFI_IMAGE_FILE_MACHINE_R3000 0x162 // MIPS* little-endian, 0540 big-endian\r
118#define EFI_IMAGE_FILE_MACHINE_R4000 0x166 // MIPS* little-endian\r
119#define EFI_IMAGE_FILE_MACHINE_ALPHA 0x184 // Alpha_AXP*\r
120#define EFI_IMAGE_FILE_MACHINE_POWERPC 0x1F0 // IBM* PowerPC Little-Endian\r
121#define EFI_IMAGE_FILE_MACHINE_TAHOE 0x7cc // Intel EM machine\r
122//\r
123// * Other names and brands may be claimed as the property of others.\r
124//\r
125//\r
126// Directory format.\r
127//\r
128typedef struct {\r
129 UINT32 VirtualAddress;\r
130 UINT32 Size;\r
131} EFI_IMAGE_DATA_DIRECTORY;\r
132\r
133#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16\r
134\r
135typedef struct {\r
136 UINT16 Magic;\r
137 UINT8 MajorLinkerVersion;\r
138 UINT8 MinorLinkerVersion;\r
139 UINT32 SizeOfCode;\r
140 UINT32 SizeOfInitializedData;\r
141 UINT32 SizeOfUninitializedData;\r
142 UINT32 AddressOfEntryPoint;\r
143 UINT32 BaseOfCode;\r
144 UINT32 BaseOfData;\r
145 UINT32 BaseOfBss;\r
146 UINT32 GprMask;\r
147 UINT32 CprMask[4];\r
148 UINT32 GpValue;\r
149} EFI_IMAGE_ROM_OPTIONAL_HEADER;\r
150\r
151#define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC 0x107\r
152#define EFI_IMAGE_SIZEOF_ROM_OPTIONAL_HEADER sizeof (EFI_IMAGE_ROM_OPTIONAL_HEADER)\r
153\r
154typedef struct {\r
155 EFI_IMAGE_FILE_HEADER FileHeader;\r
156 EFI_IMAGE_ROM_OPTIONAL_HEADER OptionalHeader;\r
157} EFI_IMAGE_ROM_HEADERS;\r
158\r
159//\r
160// ATTENTION!!! EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64\r
161// are for use ONLY by tools. All proper EFI code MUST use\r
162// EFI_IMAGE_OPTIONAL_HEADER ONLY!!!\r
163//\r
164#define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b\r
165\r
166typedef struct {\r
167 //\r
168 // Standard fields.\r
169 //\r
170 UINT16 Magic;\r
171 UINT8 MajorLinkerVersion;\r
172 UINT8 MinorLinkerVersion;\r
173 UINT32 SizeOfCode;\r
174 UINT32 SizeOfInitializedData;\r
175 UINT32 SizeOfUninitializedData;\r
176 UINT32 AddressOfEntryPoint;\r
177 UINT32 BaseOfCode;\r
178 UINT32 BaseOfData;\r
179 //\r
180 // NT additional fields.\r
181 //\r
182 UINT32 ImageBase;\r
183 UINT32 SectionAlignment;\r
184 UINT32 FileAlignment;\r
185 UINT16 MajorOperatingSystemVersion;\r
186 UINT16 MinorOperatingSystemVersion;\r
187 UINT16 MajorImageVersion;\r
188 UINT16 MinorImageVersion;\r
189 UINT16 MajorSubsystemVersion;\r
190 UINT16 MinorSubsystemVersion;\r
191 UINT32 Win32VersionValue;\r
192 UINT32 SizeOfImage;\r
193 UINT32 SizeOfHeaders;\r
194 UINT32 CheckSum;\r
195 UINT16 Subsystem;\r
196 UINT16 DllCharacteristics;\r
197 UINT32 SizeOfStackReserve;\r
198 UINT32 SizeOfStackCommit;\r
199 UINT32 SizeOfHeapReserve;\r
200 UINT32 SizeOfHeapCommit;\r
201 UINT32 LoaderFlags;\r
202 UINT32 NumberOfRvaAndSizes;\r
203 EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];\r
204} EFI_IMAGE_OPTIONAL_HEADER32;\r
205\r
206//\r
207// ATTENTION!!! EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64\r
208// are for use ONLY by tools. All proper EFI code MUST use\r
209// EFI_IMAGE_OPTIONAL_HEADER ONLY!!!\r
210//\r
211#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
212\r
213typedef struct {\r
214 //\r
215 // Standard fields.\r
216 //\r
217 UINT16 Magic;\r
218 UINT8 MajorLinkerVersion;\r
219 UINT8 MinorLinkerVersion;\r
220 UINT32 SizeOfCode;\r
221 UINT32 SizeOfInitializedData;\r
222 UINT32 SizeOfUninitializedData;\r
223 UINT32 AddressOfEntryPoint;\r
224 UINT32 BaseOfCode;\r
225 //\r
226 // NT additional fields.\r
227 //\r
228 UINT64 ImageBase;\r
229 UINT32 SectionAlignment;\r
230 UINT32 FileAlignment;\r
231 UINT16 MajorOperatingSystemVersion;\r
232 UINT16 MinorOperatingSystemVersion;\r
233 UINT16 MajorImageVersion;\r
234 UINT16 MinorImageVersion;\r
235 UINT16 MajorSubsystemVersion;\r
236 UINT16 MinorSubsystemVersion;\r
237 UINT32 Win32VersionValue;\r
238 UINT32 SizeOfImage;\r
239 UINT32 SizeOfHeaders;\r
240 UINT32 CheckSum;\r
241 UINT16 Subsystem;\r
242 UINT16 DllCharacteristics;\r
243 UINT64 SizeOfStackReserve;\r
244 UINT64 SizeOfStackCommit;\r
245 UINT64 SizeOfHeapReserve;\r
246 UINT64 SizeOfHeapCommit;\r
247 UINT32 LoaderFlags;\r
248 UINT32 NumberOfRvaAndSizes;\r
249 EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];\r
250} EFI_IMAGE_OPTIONAL_HEADER64;\r
251\r
252//\r
253// ATTENTION!!! EFI_IMAGE_NT_HEADERS32 and EFI_IMAGE_HEADERS64 are for use ONLY\r
254// by tools. All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!\r
255//\r
256typedef struct {\r
257 UINT32 Signature;\r
258 EFI_IMAGE_FILE_HEADER FileHeader;\r
259 EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader;\r
260} EFI_IMAGE_NT_HEADERS32;\r
261\r
262#define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)\r
263\r
264typedef struct {\r
265 UINT32 Signature;\r
266 EFI_IMAGE_FILE_HEADER FileHeader;\r
267 EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader;\r
268} EFI_IMAGE_NT_HEADERS64;\r
269\r
270#define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)\r
271\r
272//\r
273// Include processor specific definition of EFI_IMAGE_OPTIONAL_HEADER so the\r
274// type name EFI_IMAGE_OPTIONAL_HEADER is appropriate to the build. Same for\r
275// EFI_IMAGE_NT_HEADERS. These definitions MUST be used by ALL EFI code.\r
276//\r
277#include "EfiPeOptionalHeader.h"\r
278\r
279#define EFI_IMAGE_FIRST_SECTION(ntheader) \\r
280 ( \\r
281 (EFI_IMAGE_SECTION_HEADER *) \\r
282 ( \\r
283 (UINT32) ntheader + \\r
284 FIELD_OFFSET (EFI_IMAGE_NT_HEADERS, OptionalHeader) + \\r
285 ((EFI_IMAGE_NT_HEADERS *) (ntheader))->FileHeader.SizeOfOptionalHeader \\r
286 ) \\r
287 )\r
288\r
289//\r
290// Subsystem Values\r
291//\r
292#define EFI_IMAGE_SUBSYSTEM_UNKNOWN 0\r
293#define EFI_IMAGE_SUBSYSTEM_NATIVE 1\r
294#define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2\r
295#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3.\r
296#define EFI_IMAGE_SUBSYSTEM_OS2_CUI 5\r
297#define EFI_IMAGE_SUBSYSTEM_POSIX_CUI 7\r
298\r
299//\r
300// Directory Entries\r
301//\r
302#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT 0\r
303#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT 1\r
304#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE 2\r
305#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION 3\r
306#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY 4\r
307#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC 5\r
308#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG 6\r
309#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7\r
310#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8\r
311#define EFI_IMAGE_DIRECTORY_ENTRY_TLS 9\r
312#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10\r
313\r
314//\r
315// Section header format.\r
316//\r
317#define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
318\r
319typedef struct {\r
320 UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
321 union {\r
322 UINT32 PhysicalAddress;\r
323 UINT32 VirtualSize;\r
324 } Misc;\r
325 UINT32 VirtualAddress;\r
326 UINT32 SizeOfRawData;\r
327 UINT32 PointerToRawData;\r
328 UINT32 PointerToRelocations;\r
329 UINT32 PointerToLinenumbers;\r
330 UINT16 NumberOfRelocations;\r
331 UINT16 NumberOfLinenumbers;\r
332 UINT32 Characteristics;\r
333} EFI_IMAGE_SECTION_HEADER;\r
334\r
335#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40\r
336\r
337#define EFI_IMAGE_SCN_TYPE_NO_PAD 0x00000008 // Reserved.\r
338#define EFI_IMAGE_SCN_CNT_CODE 0x00000020\r
339#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040\r
340#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA 0x00000080\r
341\r
342#define EFI_IMAGE_SCN_LNK_OTHER 0x00000100 // Reserved.\r
343#define EFI_IMAGE_SCN_LNK_INFO 0x00000200 // Section contains comments or some other type of information.\r
344#define EFI_IMAGE_SCN_LNK_REMOVE 0x00000800 // Section contents will not become part of image.\r
345#define EFI_IMAGE_SCN_LNK_COMDAT 0x00001000\r
346\r
347#define EFI_IMAGE_SCN_ALIGN_1BYTES 0x00100000\r
348#define EFI_IMAGE_SCN_ALIGN_2BYTES 0x00200000\r
349#define EFI_IMAGE_SCN_ALIGN_4BYTES 0x00300000\r
350#define EFI_IMAGE_SCN_ALIGN_8BYTES 0x00400000\r
351#define EFI_IMAGE_SCN_ALIGN_16BYTES 0x00500000\r
352#define EFI_IMAGE_SCN_ALIGN_32BYTES 0x00600000\r
353#define EFI_IMAGE_SCN_ALIGN_64BYTES 0x00700000\r
354\r
355#define EFI_IMAGE_SCN_MEM_DISCARDABLE 0x02000000\r
356#define EFI_IMAGE_SCN_MEM_NOT_CACHED 0x04000000\r
357#define EFI_IMAGE_SCN_MEM_NOT_PAGED 0x08000000\r
358#define EFI_IMAGE_SCN_MEM_SHARED 0x10000000\r
359#define EFI_IMAGE_SCN_MEM_EXECUTE 0x20000000\r
360#define EFI_IMAGE_SCN_MEM_READ 0x40000000\r
361#define EFI_IMAGE_SCN_MEM_WRITE 0x80000000\r
362\r
363//\r
364// Symbol format.\r
365//\r
366#define EFI_IMAGE_SIZEOF_SYMBOL 18\r
367\r
368//\r
369// Section values.\r
370//\r
371// Symbols have a section number of the section in which they are\r
372// defined. Otherwise, section numbers have the following meanings:\r
373//\r
374#define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0 // Symbol is undefined or is common.\r
375#define EFI_IMAGE_SYM_ABSOLUTE (UINT16) -1 // Symbol is an absolute value.\r
376#define EFI_IMAGE_SYM_DEBUG (UINT16) -2 // Symbol is a special debug item.\r
377//\r
378// Type (fundamental) values.\r
379//\r
380#define EFI_IMAGE_SYM_TYPE_NULL 0 // no type.\r
381#define EFI_IMAGE_SYM_TYPE_VOID 1 //\r
382#define EFI_IMAGE_SYM_TYPE_CHAR 2 // type character.\r
383#define EFI_IMAGE_SYM_TYPE_SHORT 3 // type short integer.\r
384#define EFI_IMAGE_SYM_TYPE_INT 4\r
385#define EFI_IMAGE_SYM_TYPE_LONG 5\r
386#define EFI_IMAGE_SYM_TYPE_FLOAT 6\r
387#define EFI_IMAGE_SYM_TYPE_DOUBLE 7\r
388#define EFI_IMAGE_SYM_TYPE_STRUCT 8\r
389#define EFI_IMAGE_SYM_TYPE_UNION 9\r
390#define EFI_IMAGE_SYM_TYPE_ENUM 10 // enumeration.\r
391#define EFI_IMAGE_SYM_TYPE_MOE 11 // member of enumeration.\r
392#define EFI_IMAGE_SYM_TYPE_BYTE 12\r
393#define EFI_IMAGE_SYM_TYPE_WORD 13\r
394#define EFI_IMAGE_SYM_TYPE_UINT 14\r
395#define EFI_IMAGE_SYM_TYPE_DWORD 15\r
396\r
397//\r
398// Type (derived) values.\r
399//\r
400#define EFI_IMAGE_SYM_DTYPE_NULL 0 // no derived type.\r
401#define EFI_IMAGE_SYM_DTYPE_POINTER 1\r
402#define EFI_IMAGE_SYM_DTYPE_FUNCTION 2\r
403#define EFI_IMAGE_SYM_DTYPE_ARRAY 3\r
404\r
405//\r
406// Storage classes.\r
407//\r
408#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION (UINT8) -1\r
409#define EFI_IMAGE_SYM_CLASS_NULL 0\r
410#define EFI_IMAGE_SYM_CLASS_AUTOMATIC 1\r
411#define EFI_IMAGE_SYM_CLASS_EXTERNAL 2\r
412#define EFI_IMAGE_SYM_CLASS_STATIC 3\r
413#define EFI_IMAGE_SYM_CLASS_REGISTER 4\r
414#define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF 5\r
415#define EFI_IMAGE_SYM_CLASS_LABEL 6\r
416#define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL 7\r
417#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT 8\r
418#define EFI_IMAGE_SYM_CLASS_ARGUMENT 9\r
419#define EFI_IMAGE_SYM_CLASS_STRUCT_TAG 10\r
420#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION 11\r
421#define EFI_IMAGE_SYM_CLASS_UNION_TAG 12\r
422#define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION 13\r
423#define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC 14\r
424#define EFI_IMAGE_SYM_CLASS_ENUM_TAG 15\r
425#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM 16\r
426#define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM 17\r
427#define EFI_IMAGE_SYM_CLASS_BIT_FIELD 18\r
428#define EFI_IMAGE_SYM_CLASS_BLOCK 100\r
429#define EFI_IMAGE_SYM_CLASS_FUNCTION 101\r
430#define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT 102\r
431#define EFI_IMAGE_SYM_CLASS_FILE 103\r
432#define EFI_IMAGE_SYM_CLASS_SECTION 104\r
433#define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL 105\r
434\r
435//\r
436// type packing constants\r
437//\r
438#define EFI_IMAGE_N_BTMASK 017\r
439#define EFI_IMAGE_N_TMASK 060\r
440#define EFI_IMAGE_N_TMASK1 0300\r
441#define EFI_IMAGE_N_TMASK2 0360\r
442#define EFI_IMAGE_N_BTSHFT 4\r
443#define EFI_IMAGE_N_TSHIFT 2\r
444\r
445//\r
446// Communal selection types.\r
447//\r
448#define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1\r
449#define EFI_IMAGE_COMDAT_SELECT_ANY 2\r
450#define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3\r
451#define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4\r
452#define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5\r
453\r
454#define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1\r
455#define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2\r
456#define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3\r
457\r
458//\r
459// Relocation format.\r
460//\r
461typedef struct {\r
462 UINT32 VirtualAddress;\r
463 UINT32 SymbolTableIndex;\r
464 UINT16 Type;\r
465} EFI_IMAGE_RELOCATION;\r
466\r
467#define EFI_IMAGE_SIZEOF_RELOCATION 10\r
468\r
469//\r
470// I386 relocation types.\r
471//\r
472#define EFI_IMAGE_REL_I386_ABSOLUTE 0 // Reference is absolute, no relocation is necessary\r
473#define EFI_IMAGE_REL_I386_DIR16 01 // Direct 16-bit reference to the symbols virtual address\r
474#define EFI_IMAGE_REL_I386_REL16 02 // PC-relative 16-bit reference to the symbols virtual address\r
475#define EFI_IMAGE_REL_I386_DIR32 06 // Direct 32-bit reference to the symbols virtual address\r
476#define EFI_IMAGE_REL_I386_DIR32NB 07 // Direct 32-bit reference to the symbols virtual address, base not included\r
477#define EFI_IMAGE_REL_I386_SEG12 011 // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address\r
478#define EFI_IMAGE_REL_I386_SECTION 012\r
479#define EFI_IMAGE_REL_I386_SECREL 013\r
480#define EFI_IMAGE_REL_I386_REL32 024 // PC-relative 32-bit reference to the symbols virtual address\r
481//\r
482// Based relocation format.\r
483//\r
484typedef struct {\r
485 UINT32 VirtualAddress;\r
486 UINT32 SizeOfBlock;\r
487} EFI_IMAGE_BASE_RELOCATION;\r
488\r
489#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8\r
490\r
491//\r
492// Based relocation types.\r
493//\r
494#define EFI_IMAGE_REL_BASED_ABSOLUTE 0\r
495#define EFI_IMAGE_REL_BASED_HIGH 1\r
496#define EFI_IMAGE_REL_BASED_LOW 2\r
497#define EFI_IMAGE_REL_BASED_HIGHLOW 3\r
498#define EFI_IMAGE_REL_BASED_HIGHADJ 4\r
499#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR 5\r
500#define EFI_IMAGE_REL_BASED_IA64_IMM64 9\r
501#define EFI_IMAGE_REL_BASED_DIR64 10\r
502\r
503//\r
504// Line number format.\r
505//\r
506typedef struct {\r
507 union {\r
508 UINT32 SymbolTableIndex; // Symbol table index of function name if Linenumber is 0.\r
509 UINT32 VirtualAddress; // Virtual address of line number.\r
510 } Type;\r
511 UINT16 Linenumber; // Line number.\r
512} EFI_IMAGE_LINENUMBER;\r
513\r
514#define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
515\r
516//\r
517// Archive format.\r
518//\r
519#define EFI_IMAGE_ARCHIVE_START_SIZE 8\r
520#define EFI_IMAGE_ARCHIVE_START "!<arch>\n"\r
521#define EFI_IMAGE_ARCHIVE_END "`\n"\r
522#define EFI_IMAGE_ARCHIVE_PAD "\n"\r
523#define EFI_IMAGE_ARCHIVE_LINKER_MEMBER "/ "\r
524#define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER "// "\r
525\r
526typedef struct {\r
527 UINT8 Name[16]; // File member name - `/' terminated.\r
528 UINT8 Date[12]; // File member date - decimal.\r
529 UINT8 UserID[6]; // File member user id - decimal.\r
530 UINT8 GroupID[6]; // File member group id - decimal.\r
531 UINT8 Mode[8]; // File member mode - octal.\r
532 UINT8 Size[10]; // File member size - decimal.\r
533 UINT8 EndHeader[2]; // String to end header.\r
534} EFI_IMAGE_ARCHIVE_MEMBER_HEADER;\r
535\r
536#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
537\r
538//\r
539// DLL support.\r
540//\r
541//\r
542// Export Format\r
543//\r
544typedef struct {\r
545 UINT32 Characteristics;\r
546 UINT32 TimeDateStamp;\r
547 UINT16 MajorVersion;\r
548 UINT16 MinorVersion;\r
549 UINT32 Name;\r
550 UINT32 Base;\r
551 UINT32 NumberOfFunctions;\r
552 UINT32 NumberOfNames;\r
553 UINT32 AddressOfFunctions;\r
554 UINT32 AddressOfNames;\r
555 UINT32 AddressOfNameOrdinals;\r
556} EFI_IMAGE_EXPORT_DIRECTORY;\r
557\r
558//\r
559// Import Format\r
560//\r
561typedef struct {\r
562 UINT16 Hint;\r
563 UINT8 Name[1];\r
564} EFI_IMAGE_IMPORT_BY_NAME;\r
565\r
566typedef struct {\r
567 union {\r
568 UINT32 Function;\r
569 UINT32 Ordinal;\r
570 EFI_IMAGE_IMPORT_BY_NAME *AddressOfData;\r
571 } u1;\r
572} EFI_IMAGE_THUNK_DATA;\r
573\r
574#define EFI_IMAGE_ORDINAL_FLAG 0x80000000\r
575#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)\r
576#define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)\r
577\r
578typedef struct {\r
579 UINT32 Characteristics;\r
580 UINT32 TimeDateStamp;\r
581 UINT32 ForwarderChain;\r
582 UINT32 Name;\r
583 EFI_IMAGE_THUNK_DATA *FirstThunk;\r
584} EFI_IMAGE_IMPORT_DESCRIPTOR;\r
585\r
586//\r
587// Debug Format\r
588//\r
589#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2\r
590\r
591typedef struct {\r
592 UINT32 Characteristics;\r
593 UINT32 TimeDateStamp;\r
594 UINT16 MajorVersion;\r
595 UINT16 MinorVersion;\r
596 UINT32 Type;\r
597 UINT32 SizeOfData;\r
598 UINT32 RVA;\r
599 UINT32 FileOffset;\r
600} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;\r
601\r
602#define CODEVIEW_SIGNATURE_NB10 0x3031424E // "NB10"\r
603typedef struct {\r
604 UINT32 Signature; // "NB10"\r
605 UINT32 Unknown;\r
606 UINT32 Unknown2;\r
607 UINT32 Unknown3;\r
608 //\r
609 // Filename of .PDB goes here\r
610 //\r
611} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;\r
612\r
613#define CODEVIEW_SIGNATURE_RSDS 0x53445352 // "RSDS"\r
614typedef struct {\r
615 UINT32 Signature; // "RSDS"\r
616 UINT32 Unknown;\r
617 UINT32 Unknown2;\r
618 UINT32 Unknown3;\r
619 UINT32 Unknown4;\r
620 UINT32 Unknown5;\r
621 //\r
622 // Filename of .PDB goes here\r
623 //\r
624} EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;\r
625\r
3e99020d
LG		 626//\r
627// Resource Format\r
628//\r
629typedef struct {\r
630 UINT32 Characteristics;\r
631 UINT32 TimeDateStamp;\r
632 UINT16 MajorVersion;\r
633 UINT16 MinorVersion;\r
634 UINT16 NumberOfNamedEntries;\r
635 UINT16 NumberOfIdEntries;\r
636// EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY DirectoryEntries[];\r
637} EFI_IMAGE_RESOURCE_DIRECTORY;\r
638\r
639typedef struct {\r
640 union {\r
641 struct {\r
642 UINT32 NameOffset:31;\r
643 UINT32 NameIsString:1;\r
644 } s;\r
645 UINT32 Id;\r
646 } u1;\r
647 union {\r
648 UINT32 OffsetToData;\r
649 struct {\r
650 UINT32 OffsetToDirectory:31;\r
651 UINT32 DataIsDirectory:1;\r
652 } s;\r
653 } u2;\r
654} EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;\r
655\r
656typedef struct {\r
657 UINT16 Length;\r
658 CHAR16 String[1];\r
659} EFI_IMAGE_RESOURCE_DIRECTORY_STRING;\r
660\r
661typedef struct {\r
662 UINT32 OffsetToData;\r
663 UINT32 Size;\r
664 UINT32 CodePage;\r
665 UINT32 Reserved;\r
666} EFI_IMAGE_RESOURCE_DATA_ENTRY;\r
667\r
3eb9473e 668//\r
669// Header format for TE images\r
670//\r
671typedef struct {\r
672 UINT16 Signature; // signature for TE format = "VZ"\r
673 UINT16 Machine; // from the original file header\r
674 UINT8 NumberOfSections; // from the original file header\r
675 UINT8 Subsystem; // from original optional header\r
676 UINT16 StrippedSize; // how many bytes we removed from the header\r
677 UINT32 AddressOfEntryPoint; // offset to entry point -- from original optional header\r
678 UINT32 BaseOfCode; // from original image -- required for ITP debug\r
679 UINT64 ImageBase; // from original file header\r
680 EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; // only base relocation and debug directory\r
681} EFI_TE_IMAGE_HEADER;\r
682\r
683#define EFI_TE_IMAGE_HEADER_SIGNATURE 0x5A56 // "VZ"\r
684//\r
685// Data directory indexes in our TE image header\r
686//\r
687#define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC 0\r
688#define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG 1\r
689\r
690//\r
691// Union of PE32, PE32+, and TE headers\r
692//\r
693typedef union {\r
694 EFI_IMAGE_NT_HEADERS32 Pe32;\r
695 EFI_IMAGE_NT_HEADERS64 Pe32Plus;\r
696 EFI_TE_IMAGE_HEADER Te;\r
697} EFI_IMAGE_OPTIONAL_HEADER_UNION;\r
698\r
699typedef union {\r
700 EFI_IMAGE_NT_HEADERS32 *Pe32;\r
701 EFI_IMAGE_NT_HEADERS64 *Pe32Plus;\r
702 EFI_TE_IMAGE_HEADER *Te;\r
703 EFI_IMAGE_OPTIONAL_HEADER_UNION *Union;\r
704} EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;\r
705\r
706#endif\r
EFI Development Kit II mirror for PVE