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