]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/PeImage.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
MdePkg: add missing #defines for decoding PCIe 2.1 extended capability structures
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / PeImage.h
CommitLineData
a7ed1e2e 1/** @file\r
1f76500e 2 EFI image format for PE32, PE32+ and TE. Please note some data structures are \r
a7ed1e2e 3 different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and \r
4 EFI_IMAGE_NT_HEADERS64 is for PE32+. \r
5\r
6 This file is coded to the Visual Studio, Microsoft Portable Executable and \r
fed549d7 7 Common Object File Format Specification, Revision 8.3 - February 6, 2013.\r
1f76500e 8 This file also includes some definitions in PI Specification, Revision 1.0.\r
a7ed1e2e 9\r
9df063a0
HT		 10Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
11Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
12This program and the accompanying materials \r
af2dc6a7 13are licensed and made available under the terms and conditions of the BSD License \r
14which accompanies this distribution. The full text of the license may be found at \r
15http://opensource.org/licenses/bsd-license.php. \r
a7ed1e2e 16\r
af2dc6a7 17THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
18WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
a7ed1e2e 19\r
a7ed1e2e 20**/\r
21\r
1f76500e 22#ifndef __PE_IMAGE_H__\r
23#define __PE_IMAGE_H__\r
a7ed1e2e 24\r
427987f5 25//\r
26// PE32+ Subsystem type for EFI images\r
27//\r
a7ed1e2e 28#define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION 10\r
29#define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11\r
30#define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12\r
1f76500e 31#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13 ///< defined PI Specification, 1.0\r
a7ed1e2e 32\r
33\r
427987f5 34//\r
35// PE32+ Machine type for EFI images\r
36//\r
a35dd88a 37#define IMAGE_FILE_MACHINE_I386 0x014c\r
38#define IMAGE_FILE_MACHINE_IA64 0x0200\r
39#define IMAGE_FILE_MACHINE_EBC 0x0EBC\r
40#define IMAGE_FILE_MACHINE_X64 0x8664\r
41#define IMAGE_FILE_MACHINE_ARMTHUMB_MIXED 0x01c2\r
fed549d7 42#define IMAGE_FILE_MACHINE_ARM64 0xAA64\r
a7ed1e2e 43\r
427987f5 44//\r
45// EXE file formats\r
46//\r
13c31065 47#define EFI_IMAGE_DOS_SIGNATURE SIGNATURE_16('M', 'Z')\r
48#define EFI_IMAGE_OS2_SIGNATURE SIGNATURE_16('N', 'E')\r
49#define EFI_IMAGE_OS2_SIGNATURE_LE SIGNATURE_16('L', 'E')\r
9d96b055 50#define EFI_IMAGE_NT_SIGNATURE SIGNATURE_32('P', 'E', '\0', '\0')\r
a7ed1e2e 51\r
52///\r
53/// PE images can start with an optional DOS header, so if an image is run\r
1f76500e 54/// under DOS it can print an error message.\r
a7ed1e2e 55///\r
56typedef struct {\r
af2dc6a7 57 UINT16 e_magic; ///< Magic number.\r
58 UINT16 e_cblp; ///< Bytes on last page of file.\r
59 UINT16 e_cp; ///< Pages in file.\r
60 UINT16 e_crlc; ///< Relocations.\r
61 UINT16 e_cparhdr; ///< Size of header in paragraphs.\r
62 UINT16 e_minalloc; ///< Minimum extra paragraphs needed.\r
63 UINT16 e_maxalloc; ///< Maximum extra paragraphs needed.\r
64 UINT16 e_ss; ///< Initial (relative) SS value.\r
65 UINT16 e_sp; ///< Initial SP value.\r
66 UINT16 e_csum; ///< Checksum.\r
67 UINT16 e_ip; ///< Initial IP value.\r
68 UINT16 e_cs; ///< Initial (relative) CS value.\r
69 UINT16 e_lfarlc; ///< File address of relocation table.\r
70 UINT16 e_ovno; ///< Overlay number.\r
71 UINT16 e_res[4]; ///< Reserved words.\r
72 UINT16 e_oemid; ///< OEM identifier (for e_oeminfo).\r
73 UINT16 e_oeminfo; ///< OEM information; e_oemid specific.\r
74 UINT16 e_res2[10]; ///< Reserved words.\r
75 UINT32 e_lfanew; ///< File address of new exe header.\r
a7ed1e2e 76} EFI_IMAGE_DOS_HEADER;\r
77\r
78///\r
af2dc6a7 79/// COFF File Header (Object and Image).\r
a7ed1e2e 80///\r
81typedef struct {\r
82 UINT16 Machine;\r
83 UINT16 NumberOfSections;\r
84 UINT32 TimeDateStamp;\r
85 UINT32 PointerToSymbolTable;\r
86 UINT32 NumberOfSymbols;\r
87 UINT16 SizeOfOptionalHeader;\r
88 UINT16 Characteristics;\r
89} EFI_IMAGE_FILE_HEADER;\r
90\r
1f76500e 91///\r
af2dc6a7 92/// Size of EFI_IMAGE_FILE_HEADER.\r
1f76500e 93///\r
a7ed1e2e 94#define EFI_IMAGE_SIZEOF_FILE_HEADER 20\r
95\r
427987f5 96//\r
97// Characteristics\r
98//\r
1f76500e 99#define EFI_IMAGE_FILE_RELOCS_STRIPPED BIT0 ///< 0x0001 Relocation info stripped from file.\r
100#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE BIT1 ///< 0x0002 File is executable (i.e. no unresolved externel references).\r
101#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED BIT2 ///< 0x0004 Line nunbers stripped from file.\r
102#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED BIT3 ///< 0x0008 Local symbols stripped from file.\r
103#define EFI_IMAGE_FILE_BYTES_REVERSED_LO BIT7 ///< 0x0080 Bytes of machine word are reversed.\r
104#define EFI_IMAGE_FILE_32BIT_MACHINE BIT8 ///< 0x0100 32 bit word machine.\r
af2dc6a7 105#define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file.\r
1f76500e 106#define EFI_IMAGE_FILE_SYSTEM BIT12 ///< 0x1000 System File.\r
107#define EFI_IMAGE_FILE_DLL BIT13 ///< 0x2000 File is a DLL.\r
108#define EFI_IMAGE_FILE_BYTES_REVERSED_HI BIT15 ///< 0x8000 Bytes of machine word are reversed.\r
109\r
a7ed1e2e 110///\r
af2dc6a7 111/// Header Data Directories.\r
a7ed1e2e 112///\r
113typedef struct {\r
114 UINT32 VirtualAddress;\r
115 UINT32 Size;\r
116} EFI_IMAGE_DATA_DIRECTORY;\r
117\r
427987f5 118//\r
119// Directory Entries\r
120//\r
1f76500e 121#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT 0\r
122#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT 1\r
123#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE 2\r
124#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION 3\r
125#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY 4\r
126#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC 5\r
127#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG 6\r
128#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7\r
129#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8\r
130#define EFI_IMAGE_DIRECTORY_ENTRY_TLS 9\r
131#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10\r
132\r
133#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16\r
a7ed1e2e 134\r
135///\r
136/// @attention\r
137/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and \r
138/// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary\r
139/// after NT additional fields.\r
140///\r
141#define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b\r
427987f5 142 \r
143///\r
af2dc6a7 144/// Optional Header Standard Fields for PE32.\r
427987f5 145///\r
a7ed1e2e 146typedef struct {\r
1bc5d021 147 ///\r
148 /// Standard fields.\r
149 ///\r
a7ed1e2e 150 UINT16 Magic;\r
151 UINT8 MajorLinkerVersion;\r
152 UINT8 MinorLinkerVersion;\r
153 UINT32 SizeOfCode;\r
154 UINT32 SizeOfInitializedData;\r
155 UINT32 SizeOfUninitializedData;\r
156 UINT32 AddressOfEntryPoint;\r
157 UINT32 BaseOfCode;\r
af2dc6a7 158 UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.\r
1bc5d021 159 ///\r
427987f5 160 /// Optional Header Windows-Specific Fields.\r
1bc5d021 161 ///\r
a7ed1e2e 162 UINT32 ImageBase;\r
163 UINT32 SectionAlignment;\r
164 UINT32 FileAlignment;\r
165 UINT16 MajorOperatingSystemVersion;\r
166 UINT16 MinorOperatingSystemVersion;\r
167 UINT16 MajorImageVersion;\r
168 UINT16 MinorImageVersion;\r
169 UINT16 MajorSubsystemVersion;\r
170 UINT16 MinorSubsystemVersion;\r
171 UINT32 Win32VersionValue;\r
172 UINT32 SizeOfImage;\r
173 UINT32 SizeOfHeaders;\r
174 UINT32 CheckSum;\r
175 UINT16 Subsystem;\r
176 UINT16 DllCharacteristics;\r
177 UINT32 SizeOfStackReserve;\r
178 UINT32 SizeOfStackCommit;\r
179 UINT32 SizeOfHeapReserve;\r
180 UINT32 SizeOfHeapCommit;\r
181 UINT32 LoaderFlags;\r
182 UINT32 NumberOfRvaAndSizes;\r
183 EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];\r
184} EFI_IMAGE_OPTIONAL_HEADER32;\r
185\r
186///\r
187/// @attention\r
188/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and \r
189/// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary\r
190/// after NT additional fields.\r
191///\r
192#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
193\r
427987f5 194///\r
af2dc6a7 195/// Optional Header Standard Fields for PE32+.\r
427987f5 196///\r
a7ed1e2e 197typedef struct {\r
427987f5 198 ///\r
199 /// Standard fields.\r
200 ///\r
a7ed1e2e 201 UINT16 Magic;\r
202 UINT8 MajorLinkerVersion;\r
203 UINT8 MinorLinkerVersion;\r
204 UINT32 SizeOfCode;\r
205 UINT32 SizeOfInitializedData;\r
206 UINT32 SizeOfUninitializedData;\r
207 UINT32 AddressOfEntryPoint;\r
208 UINT32 BaseOfCode;\r
427987f5 209 ///\r
210 /// Optional Header Windows-Specific Fields.\r
211 ///\r
a7ed1e2e 212 UINT64 ImageBase;\r
213 UINT32 SectionAlignment;\r
214 UINT32 FileAlignment;\r
215 UINT16 MajorOperatingSystemVersion;\r
216 UINT16 MinorOperatingSystemVersion;\r
217 UINT16 MajorImageVersion;\r
218 UINT16 MinorImageVersion;\r
219 UINT16 MajorSubsystemVersion;\r
220 UINT16 MinorSubsystemVersion;\r
221 UINT32 Win32VersionValue;\r
222 UINT32 SizeOfImage;\r
223 UINT32 SizeOfHeaders;\r
224 UINT32 CheckSum;\r
225 UINT16 Subsystem;\r
226 UINT16 DllCharacteristics;\r
227 UINT64 SizeOfStackReserve;\r
228 UINT64 SizeOfStackCommit;\r
229 UINT64 SizeOfHeapReserve;\r
230 UINT64 SizeOfHeapCommit;\r
231 UINT32 LoaderFlags;\r
232 UINT32 NumberOfRvaAndSizes;\r
233 EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];\r
234} EFI_IMAGE_OPTIONAL_HEADER64;\r
235\r
236\r
237///\r
238/// @attention\r
cc078d72 239/// EFI_IMAGE_NT_HEADERS32 is for use ONLY by tools.\r
a7ed1e2e 240///\r
241typedef struct {\r
242 UINT32 Signature;\r
243 EFI_IMAGE_FILE_HEADER FileHeader;\r
244 EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader;\r
245} EFI_IMAGE_NT_HEADERS32;\r
246\r
247#define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)\r
248\r
cc078d72 249///\r
250/// @attention\r
251/// EFI_IMAGE_HEADERS64 is for use ONLY by tools.\r
cc078d72 252///\r
a7ed1e2e 253typedef struct {\r
254 UINT32 Signature;\r
255 EFI_IMAGE_FILE_HEADER FileHeader;\r
256 EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader;\r
257} EFI_IMAGE_NT_HEADERS64;\r
258\r
259#define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)\r
260\r
427987f5 261//\r
262// Other Windows Subsystem Values\r
263//\r
a7ed1e2e 264#define EFI_IMAGE_SUBSYSTEM_UNKNOWN 0\r
265#define EFI_IMAGE_SUBSYSTEM_NATIVE 1\r
266#define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2\r
1f76500e 267#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3\r
a7ed1e2e 268#define EFI_IMAGE_SUBSYSTEM_OS2_CUI 5\r
269#define EFI_IMAGE_SUBSYSTEM_POSIX_CUI 7\r
270\r
1f76500e 271///\r
cc078d72 272/// Length of ShortName.\r
1f76500e 273///\r
a7ed1e2e 274#define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
275\r
427987f5 276///\r
af2dc6a7 277/// Section Table. This table immediately follows the optional header.\r
427987f5 278///\r
a7ed1e2e 279typedef struct {\r
280 UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
281 union {\r
282 UINT32 PhysicalAddress;\r
283 UINT32 VirtualSize;\r
284 } Misc;\r
285 UINT32 VirtualAddress;\r
286 UINT32 SizeOfRawData;\r
287 UINT32 PointerToRawData;\r
288 UINT32 PointerToRelocations;\r
289 UINT32 PointerToLinenumbers;\r
290 UINT16 NumberOfRelocations;\r
291 UINT16 NumberOfLinenumbers;\r
292 UINT32 Characteristics;\r
293} EFI_IMAGE_SECTION_HEADER;\r
294\r
1f76500e 295///\r
af2dc6a7 296/// Size of EFI_IMAGE_SECTION_HEADER.\r
1f76500e 297///\r
a7ed1e2e 298#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40\r
1f76500e 299 \r
427987f5 300//\r
301// Section Flags Values\r
302//\r
1f76500e 303#define EFI_IMAGE_SCN_TYPE_NO_PAD BIT3 ///< 0x00000008 ///< Reserved.\r
304#define EFI_IMAGE_SCN_CNT_CODE BIT5 ///< 0x00000020\r
305#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA BIT6 ///< 0x00000040\r
306#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA BIT7 ///< 0x00000080\r
307 \r
308#define EFI_IMAGE_SCN_LNK_OTHER BIT8 ///< 0x00000100 ///< Reserved.\r
309#define EFI_IMAGE_SCN_LNK_INFO BIT9 ///< 0x00000200 ///< Section contains comments or some other type of information.\r
14996c96 310#define EFI_IMAGE_SCN_LNK_REMOVE BIT11 ///< 0x00000800 ///< Section contents will not become part of image.\r
1f76500e 311#define EFI_IMAGE_SCN_LNK_COMDAT BIT12 ///< 0x00001000\r
312 \r
313#define EFI_IMAGE_SCN_ALIGN_1BYTES BIT20 ///< 0x00100000\r
314#define EFI_IMAGE_SCN_ALIGN_2BYTES BIT21 ///< 0x00200000\r
315#define EFI_IMAGE_SCN_ALIGN_4BYTES (BIT20|BIT21) ///< 0x00300000\r
316#define EFI_IMAGE_SCN_ALIGN_8BYTES BIT22 ///< 0x00400000\r
317#define EFI_IMAGE_SCN_ALIGN_16BYTES (BIT20|BIT22) ///< 0x00500000\r
318#define EFI_IMAGE_SCN_ALIGN_32BYTES (BIT21|BIT22) ///< 0x00600000\r
319#define EFI_IMAGE_SCN_ALIGN_64BYTES (BIT20|BIT21|BIT22) ///< 0x00700000\r
320 \r
321#define EFI_IMAGE_SCN_MEM_DISCARDABLE BIT25 ///< 0x02000000\r
322#define EFI_IMAGE_SCN_MEM_NOT_CACHED BIT26 ///< 0x04000000\r
323#define EFI_IMAGE_SCN_MEM_NOT_PAGED BIT27 ///< 0x08000000\r
324#define EFI_IMAGE_SCN_MEM_SHARED BIT28 ///< 0x10000000\r
325#define EFI_IMAGE_SCN_MEM_EXECUTE BIT29 ///< 0x20000000\r
326#define EFI_IMAGE_SCN_MEM_READ BIT30 ///< 0x40000000\r
327#define EFI_IMAGE_SCN_MEM_WRITE BIT31 ///< 0x80000000\r
328\r
329///\r
af2dc6a7 330/// Size of a Symbol Table Record.\r
1f76500e 331///\r
332#define EFI_IMAGE_SIZEOF_SYMBOL 18\r
a7ed1e2e 333\r
427987f5 334//\r
335// Symbols have a section number of the section in which they are\r
336// defined. Otherwise, section numbers have the following meanings:\r
337//\r
1f76500e 338#define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0 ///< Symbol is undefined or is common.\r
339#define EFI_IMAGE_SYM_ABSOLUTE (UINT16) -1 ///< Symbol is an absolute value.\r
340#define EFI_IMAGE_SYM_DEBUG (UINT16) -2 ///< Symbol is a special debug item.\r
a7ed1e2e 341\r
427987f5 342//\r
343// Symbol Type (fundamental) values.\r
344//\r
1f76500e 345#define EFI_IMAGE_SYM_TYPE_NULL 0 ///< no type.\r
346#define EFI_IMAGE_SYM_TYPE_VOID 1 ///< no valid type.\r
347#define EFI_IMAGE_SYM_TYPE_CHAR 2 ///< type character.\r
348#define EFI_IMAGE_SYM_TYPE_SHORT 3 ///< type short integer.\r
a7ed1e2e 349#define EFI_IMAGE_SYM_TYPE_INT 4\r
350#define EFI_IMAGE_SYM_TYPE_LONG 5\r
351#define EFI_IMAGE_SYM_TYPE_FLOAT 6\r
352#define EFI_IMAGE_SYM_TYPE_DOUBLE 7\r
353#define EFI_IMAGE_SYM_TYPE_STRUCT 8\r
354#define EFI_IMAGE_SYM_TYPE_UNION 9\r
1f76500e 355#define EFI_IMAGE_SYM_TYPE_ENUM 10 ///< enumeration.\r
356#define EFI_IMAGE_SYM_TYPE_MOE 11 ///< member of enumeration.\r
a7ed1e2e 357#define EFI_IMAGE_SYM_TYPE_BYTE 12\r
358#define EFI_IMAGE_SYM_TYPE_WORD 13\r
359#define EFI_IMAGE_SYM_TYPE_UINT 14\r
360#define EFI_IMAGE_SYM_TYPE_DWORD 15\r
361\r
427987f5 362//\r
363// Symbol Type (derived) values.\r
364//\r
1f76500e 365#define EFI_IMAGE_SYM_DTYPE_NULL 0 ///< no derived type.\r
a7ed1e2e 366#define EFI_IMAGE_SYM_DTYPE_POINTER 1\r
367#define EFI_IMAGE_SYM_DTYPE_FUNCTION 2\r
368#define EFI_IMAGE_SYM_DTYPE_ARRAY 3\r
369\r
427987f5 370//\r
371// Storage classes.\r
372//\r
1f76500e 373#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION ((UINT8) -1)\r
a7ed1e2e 374#define EFI_IMAGE_SYM_CLASS_NULL 0\r
375#define EFI_IMAGE_SYM_CLASS_AUTOMATIC 1\r
376#define EFI_IMAGE_SYM_CLASS_EXTERNAL 2\r
377#define EFI_IMAGE_SYM_CLASS_STATIC 3\r
378#define EFI_IMAGE_SYM_CLASS_REGISTER 4\r
379#define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF 5\r
380#define EFI_IMAGE_SYM_CLASS_LABEL 6\r
381#define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL 7\r
382#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT 8\r
383#define EFI_IMAGE_SYM_CLASS_ARGUMENT 9\r
384#define EFI_IMAGE_SYM_CLASS_STRUCT_TAG 10\r
385#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION 11\r
386#define EFI_IMAGE_SYM_CLASS_UNION_TAG 12\r
387#define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION 13\r
388#define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC 14\r
389#define EFI_IMAGE_SYM_CLASS_ENUM_TAG 15\r
390#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM 16\r
391#define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM 17\r
392#define EFI_IMAGE_SYM_CLASS_BIT_FIELD 18\r
393#define EFI_IMAGE_SYM_CLASS_BLOCK 100\r
394#define EFI_IMAGE_SYM_CLASS_FUNCTION 101\r
395#define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT 102\r
396#define EFI_IMAGE_SYM_CLASS_FILE 103\r
397#define EFI_IMAGE_SYM_CLASS_SECTION 104\r
398#define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL 105\r
399\r
400//\r
401// type packing constants\r
402//\r
403#define EFI_IMAGE_N_BTMASK 017\r
404#define EFI_IMAGE_N_TMASK 060\r
405#define EFI_IMAGE_N_TMASK1 0300\r
406#define EFI_IMAGE_N_TMASK2 0360\r
407#define EFI_IMAGE_N_BTSHFT 4\r
408#define EFI_IMAGE_N_TSHIFT 2\r
409\r
427987f5 410//\r
411// Communal selection types.\r
412//\r
a7ed1e2e 413#define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1\r
414#define EFI_IMAGE_COMDAT_SELECT_ANY 2\r
415#define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3\r
416#define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4\r
417#define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5\r
1f76500e 418 \r
427987f5 419//\r
420// the following values only be referred in PeCoff, not defined in PECOFF.\r
421//\r
a7ed1e2e 422#define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1\r
423#define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2\r
424#define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3\r
425\r
426///\r
427/// Relocation format.\r
428///\r
429typedef struct {\r
430 UINT32 VirtualAddress;\r
431 UINT32 SymbolTableIndex;\r
432 UINT16 Type;\r
433} EFI_IMAGE_RELOCATION;\r
434\r
1f76500e 435///\r
436/// Size of EFI_IMAGE_RELOCATION\r
437///\r
a7ed1e2e 438#define EFI_IMAGE_SIZEOF_RELOCATION 10\r
439\r
427987f5 440//\r
441// I386 relocation types.\r
442//\r
af2dc6a7 443#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary.\r
444#define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address.\r
445#define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address.\r
446#define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address.\r
447#define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included.\r
448#define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.\r
1f76500e 449#define EFI_IMAGE_REL_I386_SECTION 0x000A\r
450#define EFI_IMAGE_REL_I386_SECREL 0x000B\r
af2dc6a7 451#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.\r
a7ed1e2e 452\r
427987f5 453// \r
454// x64 processor relocation types.\r
455// \r
ee6c452c 456#define IMAGE_REL_AMD64_ABSOLUTE 0x0000\r
457#define IMAGE_REL_AMD64_ADDR64 0x0001\r
458#define IMAGE_REL_AMD64_ADDR32 0x0002\r
459#define IMAGE_REL_AMD64_ADDR32NB 0x0003\r
460#define IMAGE_REL_AMD64_REL32 0x0004\r
461#define IMAGE_REL_AMD64_REL32_1 0x0005\r
462#define IMAGE_REL_AMD64_REL32_2 0x0006\r
463#define IMAGE_REL_AMD64_REL32_3 0x0007\r
464#define IMAGE_REL_AMD64_REL32_4 0x0008\r
465#define IMAGE_REL_AMD64_REL32_5 0x0009\r
466#define IMAGE_REL_AMD64_SECTION 0x000A\r
467#define IMAGE_REL_AMD64_SECREL 0x000B\r
468#define IMAGE_REL_AMD64_SECREL7 0x000C\r
469#define IMAGE_REL_AMD64_TOKEN 0x000D\r
470#define IMAGE_REL_AMD64_SREL32 0x000E\r
471#define IMAGE_REL_AMD64_PAIR 0x000F\r
472#define IMAGE_REL_AMD64_SSPAN32 0x0010\r
a7ed1e2e 473\r
474///\r
475/// Based relocation format.\r
476///\r
477typedef struct {\r
478 UINT32 VirtualAddress;\r
479 UINT32 SizeOfBlock;\r
480} EFI_IMAGE_BASE_RELOCATION;\r
481\r
1f76500e 482///\r
af2dc6a7 483/// Size of EFI_IMAGE_BASE_RELOCATION.\r
1f76500e 484///\r
a7ed1e2e 485#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8\r
486\r
427987f5 487//\r
488// Based relocation types.\r
489//\r
14996c96
LG		 490#define EFI_IMAGE_REL_BASED_ABSOLUTE 0\r
491#define EFI_IMAGE_REL_BASED_HIGH 1\r
492#define EFI_IMAGE_REL_BASED_LOW 2\r
493#define EFI_IMAGE_REL_BASED_HIGHLOW 3\r
494#define EFI_IMAGE_REL_BASED_HIGHADJ 4\r
495#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR 5\r
e0919a58 496#define EFI_IMAGE_REL_BASED_ARM_MOV32A 5\r
497#define EFI_IMAGE_REL_BASED_ARM_MOV32T 7\r
14996c96
LG		 498#define EFI_IMAGE_REL_BASED_IA64_IMM64 9\r
499#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR16 9\r
500#define EFI_IMAGE_REL_BASED_DIR64 10\r
a7ed1e2e 501\r
502///\r
503/// Line number format.\r
504///\r
505typedef struct {\r
506 union {\r
6800ac83 507 UINT32 SymbolTableIndex; ///< Symbol table index of function name if Linenumber is 0.\r
508 UINT32 VirtualAddress; ///< Virtual address of line number.\r
a7ed1e2e 509 } Type;\r
6800ac83 510 UINT16 Linenumber; ///< Line number.\r
a7ed1e2e 511} EFI_IMAGE_LINENUMBER;\r
512\r
1f76500e 513///\r
af2dc6a7 514/// Size of EFI_IMAGE_LINENUMBER.\r
1f76500e 515///\r
a7ed1e2e 516#define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
517\r
427987f5 518//\r
519// Archive format.\r
520//\r
a7ed1e2e 521#define EFI_IMAGE_ARCHIVE_START_SIZE 8\r
522#define EFI_IMAGE_ARCHIVE_START "!<arch>\n"\r
523#define EFI_IMAGE_ARCHIVE_END "`\n"\r
524#define EFI_IMAGE_ARCHIVE_PAD "\n"\r
525#define EFI_IMAGE_ARCHIVE_LINKER_MEMBER "/ "\r
526#define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER "// "\r
527\r
427987f5 528///\r
529/// Archive Member Headers\r
530///\r
a7ed1e2e 531typedef struct {\r
1f76500e 532 UINT8 Name[16]; ///< File member name - `/' terminated.\r
533 UINT8 Date[12]; ///< File member date - decimal.\r
534 UINT8 UserID[6]; ///< File member user id - decimal.\r
535 UINT8 GroupID[6]; ///< File member group id - decimal.\r
536 UINT8 Mode[8]; ///< File member mode - octal.\r
537 UINT8 Size[10]; ///< File member size - decimal.\r
af2dc6a7 538 UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).\r
a7ed1e2e 539} EFI_IMAGE_ARCHIVE_MEMBER_HEADER;\r
540\r
1f76500e 541///\r
af2dc6a7 542/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.\r
1f76500e 543///\r
a7ed1e2e 544#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
545\r
a7ed1e2e 546\r
427987f5 547//\r
548// DLL Support\r
549//\r
1f76500e 550\r
551///\r
af2dc6a7 552/// Export Directory Table.\r
a7ed1e2e 553///\r
554typedef struct {\r
555 UINT32 Characteristics;\r
556 UINT32 TimeDateStamp;\r
557 UINT16 MajorVersion;\r
558 UINT16 MinorVersion;\r
559 UINT32 Name;\r
560 UINT32 Base;\r
561 UINT32 NumberOfFunctions;\r
562 UINT32 NumberOfNames;\r
563 UINT32 AddressOfFunctions;\r
564 UINT32 AddressOfNames;\r
565 UINT32 AddressOfNameOrdinals;\r
566} EFI_IMAGE_EXPORT_DIRECTORY;\r
567\r
568///\r
af2dc6a7 569/// Hint/Name Table.\r
a7ed1e2e 570///\r
571typedef struct {\r
572 UINT16 Hint;\r
573 UINT8 Name[1];\r
574} EFI_IMAGE_IMPORT_BY_NAME;\r
575\r
427987f5 576///\r
af2dc6a7 577/// Import Address Table RVA (Thunk Table).\r
427987f5 578///\r
a7ed1e2e 579typedef struct {\r
580 union {\r
581 UINT32 Function;\r
582 UINT32 Ordinal;\r
583 EFI_IMAGE_IMPORT_BY_NAME *AddressOfData;\r
584 } u1;\r
585} EFI_IMAGE_THUNK_DATA;\r
586\r
af2dc6a7 587#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32.\r
a7ed1e2e 588#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)\r
589#define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)\r
590\r
1f76500e 591///\r
592/// Import Directory Table\r
593///\r
a7ed1e2e 594typedef struct {\r
595 UINT32 Characteristics;\r
596 UINT32 TimeDateStamp;\r
597 UINT32 ForwarderChain;\r
598 UINT32 Name;\r
599 EFI_IMAGE_THUNK_DATA *FirstThunk;\r
600} EFI_IMAGE_IMPORT_DESCRIPTOR;\r
601\r
1f76500e 602\r
a7ed1e2e 603///\r
af2dc6a7 604/// Debug Directory Format.\r
a7ed1e2e 605///\r
a7ed1e2e 606typedef struct {\r
607 UINT32 Characteristics;\r
608 UINT32 TimeDateStamp;\r
609 UINT16 MajorVersion;\r
610 UINT16 MinorVersion;\r
611 UINT32 Type;\r
612 UINT32 SizeOfData;\r
af2dc6a7 613 UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base.\r
614 UINT32 FileOffset; ///< The file pointer to the debug data.\r
a7ed1e2e 615} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;\r
616\r
af2dc6a7 617#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information.\r
1f76500e 618\r
619///\r
af2dc6a7 620/// Debug Data Structure defined in Microsoft C++.\r
1f76500e 621///\r
13c31065 622#define CODEVIEW_SIGNATURE_NB10 SIGNATURE_32('N', 'B', '1', '0')\r
a7ed1e2e 623typedef struct {\r
1f76500e 624 UINT32 Signature; ///< "NB10"\r
a7ed1e2e 625 UINT32 Unknown;\r
626 UINT32 Unknown2;\r
627 UINT32 Unknown3;\r
628 //\r
629 // Filename of .PDB goes here\r
630 //\r
631} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;\r
632\r
1f76500e 633///\r
af2dc6a7 634/// Debug Data Structure defined in Microsoft C++.\r
1f76500e 635///\r
13c31065 636#define CODEVIEW_SIGNATURE_RSDS SIGNATURE_32('R', 'S', 'D', 'S')\r
a7ed1e2e 637typedef struct {\r
af2dc6a7 638 UINT32 Signature; ///< "RSDS".\r
a7ed1e2e 639 UINT32 Unknown;\r
640 UINT32 Unknown2;\r
641 UINT32 Unknown3;\r
642 UINT32 Unknown4;\r
643 UINT32 Unknown5;\r
644 //\r
645 // Filename of .PDB goes here\r
646 //\r
647} EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;\r
648\r
a35dd88a 649\r
650///\r
af2dc6a7 651/// Debug Data Structure defined by Apple Mach-O to Coff utility.\r
a35dd88a 652///\r
653#define CODEVIEW_SIGNATURE_MTOC SIGNATURE_32('M', 'T', 'O', 'C')\r
654typedef struct {\r
af2dc6a7 655 UINT32 Signature; ///< "MTOC".\r
a35dd88a 656 GUID MachOUuid;\r
657 //\r
658 // Filename of .DLL (Mach-O with debug info) goes here\r
659 //\r
660} EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY;\r
661\r
aeb90c4a 662///\r
663/// Resource format.\r
664///\r
665typedef struct {\r
666 UINT32 Characteristics;\r
667 UINT32 TimeDateStamp;\r
668 UINT16 MajorVersion;\r
669 UINT16 MinorVersion;\r
670 UINT16 NumberOfNamedEntries;\r
671 UINT16 NumberOfIdEntries;\r
672 //\r
673 // Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here.\r
674 //\r
675} EFI_IMAGE_RESOURCE_DIRECTORY;\r
676\r
677///\r
678/// Resource directory entry format.\r
679///\r
680typedef struct {\r
681 union {\r
682 struct {\r
683 UINT32 NameOffset:31;\r
684 UINT32 NameIsString:1;\r
685 } s;\r
686 UINT32 Id;\r
687 } u1;\r
688 union {\r
689 UINT32 OffsetToData;\r
690 struct {\r
691 UINT32 OffsetToDirectory:31;\r
692 UINT32 DataIsDirectory:1;\r
693 } s;\r
694 } u2;\r
695} EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;\r
696\r
697///\r
698/// Resource directory entry for string.\r
699///\r
700typedef struct {\r
701 UINT16 Length;\r
702 CHAR16 String[1];\r
703} EFI_IMAGE_RESOURCE_DIRECTORY_STRING;\r
704\r
705///\r
706/// Resource directory entry for data array.\r
707///\r
708typedef struct {\r
709 UINT32 OffsetToData;\r
710 UINT32 Size;\r
711 UINT32 CodePage;\r
712 UINT32 Reserved;\r
713} EFI_IMAGE_RESOURCE_DATA_ENTRY;\r
714\r
a7ed1e2e 715///\r
af2dc6a7 716/// Header format for TE images, defined in the PI Specification, 1.0.\r
a7ed1e2e 717///\r
718typedef struct {\r
af2dc6a7 719 UINT16 Signature; ///< The signature for TE format = "VZ".\r
720 UINT16 Machine; ///< From the original file header.\r
721 UINT8 NumberOfSections; ///< From the original file header.\r
722 UINT8 Subsystem; ///< From original optional header.\r
723 UINT16 StrippedSize; ///< Number of bytes we removed from the header.\r
724 UINT32 AddressOfEntryPoint; ///< Offset to entry point -- from original optional header.\r
725 UINT32 BaseOfCode; ///< From original image -- required for ITP debug.\r
726 UINT64 ImageBase; ///< From original file header.\r
727 EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< Only base relocation and debug directory.\r
a7ed1e2e 728} EFI_TE_IMAGE_HEADER;\r
729\r
1f76500e 730\r
13c31065 731#define EFI_TE_IMAGE_HEADER_SIGNATURE SIGNATURE_16('V', 'Z')\r
a7ed1e2e 732\r
733//\r
734// Data directory indexes in our TE image header\r
735//\r
736#define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC 0\r
737#define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG 1\r
738\r
739\r
1bc5d021 740///\r
af2dc6a7 741/// Union of PE32, PE32+, and TE headers.\r
1bc5d021 742///\r
a7ed1e2e 743typedef union {\r
744 EFI_IMAGE_NT_HEADERS32 Pe32;\r
745 EFI_IMAGE_NT_HEADERS64 Pe32Plus;\r
746 EFI_TE_IMAGE_HEADER Te;\r
747} EFI_IMAGE_OPTIONAL_HEADER_UNION;\r
748\r
749typedef union {\r
750 EFI_IMAGE_NT_HEADERS32 *Pe32;\r
751 EFI_IMAGE_NT_HEADERS64 *Pe32Plus;\r
752 EFI_TE_IMAGE_HEADER *Te;\r
753 EFI_IMAGE_OPTIONAL_HEADER_UNION *Union;\r
754} EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;\r
755\r
756#endif\r
EFI Development Kit II mirror for PVE