Tools/Source/TianoTools/GenFvImage/Common/EfiImage.h

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