]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/IndustryStandard/PeImage.h
MdePkg: add missing #defines for decoding PCIe 2.1 extended capability structures
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / PeImage.h
index 07932d54111cc6befb5afa0bccb6fa754c0bc898..1abe72971ecbfb9e8faf8098ce88f2c9d8441de9 100644 (file)
@@ -1,24 +1,26 @@
 /** @file\r
-  EFI image format for PE32 and PE32+. Please note some data structures are \r
+  EFI image format for PE32, PE32+ and TE. Please note some data structures are \r
   different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and \r
   EFI_IMAGE_NT_HEADERS64 is for PE32+. \r
 \r
   This file is coded to the Visual Studio, Microsoft Portable Executable and \r
-  Common Object File Format Specification, Revision 8.0 - May 16, 2006. \r
+  Common Object File Format Specification, Revision 8.3 - February 6, 2013.\r
+  This file also includes some definitions in PI Specification, Revision 1.0.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
+This program and the accompanying materials                          \r
+are licensed and made available under the terms and conditions of the BSD License         \r
+which accompanies this distribution.  The full text of the license may be found at        \r
+http://opensource.org/licenses/bsd-license.php.                                           \r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
 **/\r
 \r
-#ifndef __EFI_IMAGE_H__\r
-#define __EFI_IMAGE_H__\r
+#ifndef __PE_IMAGE_H__\r
+#define __PE_IMAGE_H__\r
 \r
 //\r
 // PE32+ Subsystem type for EFI images\r
 #define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION         10\r
 #define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11\r
 #define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER      12\r
-#define EFI_IMAGE_SUBSYSTEM_EFI_EFI_ROM             13\r
-\r
-#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER      13\r
+#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER      13 ///< defined PI Specification, 1.0\r
 \r
 \r
 //\r
 // PE32+ Machine type for EFI images\r
 //\r
-#define IMAGE_FILE_MACHINE_I386     0x014c\r
-#define IMAGE_FILE_MACHINE_IA64     0x0200\r
-#define IMAGE_FILE_MACHINE_EBC      0x0EBC\r
-#define IMAGE_FILE_MACHINE_X64      0x8664\r
+#define IMAGE_FILE_MACHINE_I386            0x014c\r
+#define IMAGE_FILE_MACHINE_IA64            0x0200\r
+#define IMAGE_FILE_MACHINE_EBC             0x0EBC\r
+#define IMAGE_FILE_MACHINE_X64             0x8664\r
+#define IMAGE_FILE_MACHINE_ARMTHUMB_MIXED  0x01c2\r
+#define IMAGE_FILE_MACHINE_ARM64           0xAA64\r
+\r
 //\r
-// Support old names for backward compatible\r
+// EXE file formats\r
 //\r
-#define EFI_IMAGE_MACHINE_IA32      IMAGE_FILE_MACHINE_I386 \r
-#define EFI_IMAGE_MACHINE_IA64      IMAGE_FILE_MACHINE_IA64  \r
-#define EFI_IMAGE_MACHINE_IPF       IMAGE_FILE_MACHINE_IA64  \r
-#define EFI_IMAGE_MACHINE_EBC       IMAGE_FILE_MACHINE_EBC  \r
-#define EFI_IMAGE_MACHINE_X64       IMAGE_FILE_MACHINE_X64\r
-\r
-#define EFI_IMAGE_DOS_SIGNATURE     0x5A4D      // MZ\r
-#define EFI_IMAGE_OS2_SIGNATURE     0x454E      // NE\r
-#define EFI_IMAGE_OS2_SIGNATURE_LE  0x454C      // LE\r
-#define EFI_IMAGE_NT_SIGNATURE      0x00004550  // PE00\r
+#define EFI_IMAGE_DOS_SIGNATURE     SIGNATURE_16('M', 'Z')\r
+#define EFI_IMAGE_OS2_SIGNATURE     SIGNATURE_16('N', 'E')\r
+#define EFI_IMAGE_OS2_SIGNATURE_LE  SIGNATURE_16('L', 'E')\r
+#define EFI_IMAGE_NT_SIGNATURE      SIGNATURE_32('P', 'E', '\0', '\0')\r
 \r
 ///\r
 /// PE images can start with an optional DOS header, so if an image is run\r
-///  under DOS it can print an error message.\r
+/// under DOS it can print an error message.\r
 ///\r
 typedef struct {\r
-  UINT16  e_magic;    // Magic number\r
-  UINT16  e_cblp;     // Bytes on last page of file\r
-  UINT16  e_cp;       // Pages in file\r
-  UINT16  e_crlc;     // Relocations\r
-  UINT16  e_cparhdr;  // Size of header in paragraphs\r
-  UINT16  e_minalloc; // Minimum extra paragraphs needed\r
-  UINT16  e_maxalloc; // Maximum extra paragraphs needed\r
-  UINT16  e_ss;       // Initial (relative) SS value\r
-  UINT16  e_sp;       // Initial SP value\r
-  UINT16  e_csum;     // Checksum\r
-  UINT16  e_ip;       // Initial IP value\r
-  UINT16  e_cs;       // Initial (relative) CS value\r
-  UINT16  e_lfarlc;   // File address of relocation table\r
-  UINT16  e_ovno;     // Overlay number\r
-  UINT16  e_res[4];   // Reserved words\r
-  UINT16  e_oemid;    // OEM identifier (for e_oeminfo)\r
-  UINT16  e_oeminfo;  // OEM information; e_oemid specific\r
-  UINT16  e_res2[10]; // Reserved words\r
-  UINT32  e_lfanew;   // File address of new exe header\r
+  UINT16  e_magic;    ///< Magic number.\r
+  UINT16  e_cblp;     ///< Bytes on last page of file.\r
+  UINT16  e_cp;       ///< Pages in file.\r
+  UINT16  e_crlc;     ///< Relocations.\r
+  UINT16  e_cparhdr;  ///< Size of header in paragraphs.\r
+  UINT16  e_minalloc; ///< Minimum extra paragraphs needed.\r
+  UINT16  e_maxalloc; ///< Maximum extra paragraphs needed.\r
+  UINT16  e_ss;       ///< Initial (relative) SS value.\r
+  UINT16  e_sp;       ///< Initial SP value.\r
+  UINT16  e_csum;     ///< Checksum.\r
+  UINT16  e_ip;       ///< Initial IP value.\r
+  UINT16  e_cs;       ///< Initial (relative) CS value.\r
+  UINT16  e_lfarlc;   ///< File address of relocation table.\r
+  UINT16  e_ovno;     ///< Overlay number.\r
+  UINT16  e_res[4];   ///< Reserved words.\r
+  UINT16  e_oemid;    ///< OEM identifier (for e_oeminfo).\r
+  UINT16  e_oeminfo;  ///< OEM information; e_oemid specific.\r
+  UINT16  e_res2[10]; ///< Reserved words.\r
+  UINT32  e_lfanew;   ///< File address of new exe header.\r
 } EFI_IMAGE_DOS_HEADER;\r
 \r
 ///\r
-/// File header format.\r
+/// COFF File Header (Object and Image).\r
 ///\r
 typedef struct {\r
   UINT16  Machine;\r
@@ -91,62 +88,49 @@ typedef struct {
   UINT16  Characteristics;\r
 } EFI_IMAGE_FILE_HEADER;\r
 \r
+///\r
+/// Size of EFI_IMAGE_FILE_HEADER.\r
+///\r
 #define EFI_IMAGE_SIZEOF_FILE_HEADER        20\r
 \r
-#define EFI_IMAGE_FILE_RELOCS_STRIPPED      0x0001  // Relocation info stripped from file.\r
-#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE     0x0002  // File is executable  (i.e. no unresolved externel references).\r
-#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED   0x0004  // Line nunbers stripped from file.\r
-#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED  0x0008  // Local symbols stripped from file.\r
-#define EFI_IMAGE_FILE_BYTES_REVERSED_LO    0x0080  // Bytes of machine word are reversed.\r
-#define EFI_IMAGE_FILE_32BIT_MACHINE        0x0100  // 32 bit word machine.\r
-#define EFI_IMAGE_FILE_DEBUG_STRIPPED       0x0200  // Debugging info stripped from file in .DBG file\r
-#define EFI_IMAGE_FILE_SYSTEM               0x1000  // System File.\r
-#define EFI_IMAGE_FILE_DLL                  0x2000  // File is a DLL.\r
-#define EFI_IMAGE_FILE_BYTES_REVERSED_HI    0x8000  // Bytes of machine word are reversed.\r
-#define EFI_IMAGE_FILE_MACHINE_UNKNOWN      0\r
-#define EFI_IMAGE_FILE_MACHINE_I386         0x14c   // Intel 386.\r
-#define EFI_IMAGE_FILE_MACHINE_R3000        0x162   // MIPS* little-endian, 0540 big-endian\r
-#define EFI_IMAGE_FILE_MACHINE_R4000        0x166   // MIPS* little-endian\r
-#define EFI_IMAGE_FILE_MACHINE_ALPHA        0x184   // Alpha_AXP*\r
-#define EFI_IMAGE_FILE_MACHINE_POWERPC      0x1F0   // IBM* PowerPC Little-Endian\r
-#define EFI_IMAGE_FILE_MACHINE_TAHOE        0x7cc   // Intel EM machine\r
 //\r
-// * Other names and brands may be claimed as the property of others.\r
+// Characteristics\r
 //\r
+#define EFI_IMAGE_FILE_RELOCS_STRIPPED      BIT0     ///< 0x0001  Relocation info stripped from file.\r
+#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE     BIT1     ///< 0x0002  File is executable  (i.e. no unresolved externel references).\r
+#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED   BIT2     ///< 0x0004  Line nunbers stripped from file.\r
+#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED  BIT3     ///< 0x0008  Local symbols stripped from file.\r
+#define EFI_IMAGE_FILE_BYTES_REVERSED_LO    BIT7     ///< 0x0080  Bytes of machine word are reversed.\r
+#define EFI_IMAGE_FILE_32BIT_MACHINE        BIT8     ///< 0x0100  32 bit word machine.\r
+#define EFI_IMAGE_FILE_DEBUG_STRIPPED       BIT9     ///< 0x0200  Debugging info stripped from file in .DBG file.\r
+#define EFI_IMAGE_FILE_SYSTEM               BIT12    ///< 0x1000  System File.\r
+#define EFI_IMAGE_FILE_DLL                  BIT13    ///< 0x2000  File is a DLL.\r
+#define EFI_IMAGE_FILE_BYTES_REVERSED_HI    BIT15    ///< 0x8000  Bytes of machine word are reversed.\r
 \r
 ///\r
-/// Directory format.\r
+/// Header Data Directories.\r
 ///\r
 typedef struct {\r
   UINT32  VirtualAddress;\r
   UINT32  Size;\r
 } EFI_IMAGE_DATA_DIRECTORY;\r
 \r
-#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16\r
-\r
-typedef struct {\r
-  UINT16  Magic;\r
-  UINT8   MajorLinkerVersion;\r
-  UINT8   MinorLinkerVersion;\r
-  UINT32  SizeOfCode;\r
-  UINT32  SizeOfInitializedData;\r
-  UINT32  SizeOfUninitializedData;\r
-  UINT32  AddressOfEntryPoint;\r
-  UINT32  BaseOfCode;\r
-  UINT32  BaseOfData;\r
-  UINT32  BaseOfBss;\r
-  UINT32  GprMask;\r
-  UINT32  CprMask[4];\r
-  UINT32  GpValue;\r
-} EFI_IMAGE_ROM_OPTIONAL_HEADER;\r
-\r
-#define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC      0x107\r
-#define EFI_IMAGE_SIZEOF_ROM_OPTIONAL_HEADER  sizeof (EFI_IMAGE_ROM_OPTIONAL_HEADER)\r
+//\r
+// Directory Entries\r
+//\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT      0\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT      1\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE    2\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION   3\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY    4\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC   5\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG       6\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT   7\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR   8\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_TLS         9\r
+#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10\r
 \r
-typedef struct {\r
-  EFI_IMAGE_FILE_HEADER         FileHeader;\r
-  EFI_IMAGE_ROM_OPTIONAL_HEADER OptionalHeader;\r
-} EFI_IMAGE_ROM_HEADERS;\r
+#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16\r
 \r
 ///\r
 /// @attention\r
@@ -155,11 +139,14 @@ typedef struct {
 /// after NT additional fields.\r
 ///\r
 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b\r
-\r
+          \r
+///\r
+/// Optional Header Standard Fields for PE32.\r
+///\r
 typedef struct {\r
-  //\r
-  // Standard fields.\r
-  //\r
+  ///\r
+  /// Standard fields.\r
+  ///\r
   UINT16                    Magic;\r
   UINT8                     MajorLinkerVersion;\r
   UINT8                     MinorLinkerVersion;\r
@@ -168,10 +155,10 @@ typedef struct {
   UINT32                    SizeOfUninitializedData;\r
   UINT32                    AddressOfEntryPoint;\r
   UINT32                    BaseOfCode;\r
-  UINT32                    BaseOfData;\r
-  //\r
-  // NT additional fields.\r
-  //\r
+  UINT32                    BaseOfData;  ///< PE32 contains this additional field, which is absent in PE32+.\r
+  ///\r
+  /// Optional Header Windows-Specific Fields.\r
+  ///\r
   UINT32                    ImageBase;\r
   UINT32                    SectionAlignment;\r
   UINT32                    FileAlignment;\r
@@ -204,10 +191,13 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
 \r
+///\r
+/// Optional Header Standard Fields for PE32+.\r
+///\r
 typedef struct {\r
-  //\r
-  // Standard fields.\r
-  //\r
+  ///\r
+  /// Standard fields.\r
+  ///\r
   UINT16                    Magic;\r
   UINT8                     MajorLinkerVersion;\r
   UINT8                     MinorLinkerVersion;\r
@@ -216,9 +206,9 @@ typedef struct {
   UINT32                    SizeOfUninitializedData;\r
   UINT32                    AddressOfEntryPoint;\r
   UINT32                    BaseOfCode;\r
-  //\r
-  // NT additional fields.\r
-  //\r
+  ///\r
+  /// Optional Header Windows-Specific Fields.\r
+  ///\r
   UINT64                    ImageBase;\r
   UINT32                    SectionAlignment;\r
   UINT32                    FileAlignment;\r
@@ -246,8 +236,7 @@ typedef struct {
 \r
 ///\r
 /// @attention\r
-/// EFI_IMAGE_NT_HEADERS32 and EFI_IMAGE_HEADERS64 are for use ONLY\r
-/// by tools.  All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!\r
+/// EFI_IMAGE_NT_HEADERS32 is for use ONLY by tools.\r
 ///\r
 typedef struct {\r
   UINT32                      Signature;\r
@@ -257,6 +246,10 @@ typedef struct {
 \r
 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)\r
 \r
+///\r
+/// @attention\r
+/// EFI_IMAGE_HEADERS64 is for use ONLY by tools.\r
+///\r
 typedef struct {\r
   UINT32                      Signature;\r
   EFI_IMAGE_FILE_HEADER       FileHeader;\r
@@ -265,109 +258,24 @@ typedef struct {
 \r
 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)\r
 \r
-\r
-//\r
-// Processor specific definition of EFI_IMAGE_OPTIONAL_HEADER so the\r
-// type name EFI_IMAGE_OPTIONAL_HEADER is appropriate to the build.  Same for\r
-// EFI_IMAGE_NT_HEADERS.  These definitions MUST be used by ALL EFI code.\r
-//\r
-#if   defined (MDE_CPU_IA32)\r
-\r
-#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
-  (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
-\r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64) \r
-\r
-//\r
-// @bug - Remove me when other package updated. \r
-//\r
-typedef EFI_IMAGE_NT_HEADERS32    EFI_IMAGE_NT_HEADERS;\r
-\r
-#elif defined (MDE_CPU_IPF)\r
-\r
-#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
-  (((Machine) == EFI_IMAGE_MACHINE_IPF) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
-\r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) \r
-\r
-//\r
-// @bug - Remove me when other package updated. \r
-//\r
-typedef EFI_IMAGE_NT_HEADERS64    EFI_IMAGE_NT_HEADERS;\r
-\r
-#elif defined (MDE_CPU_X64)\r
-\r
-#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
-  (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
-\r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32) \r
-\r
-//\r
-// @bug - Remove me when other package updated. \r
-//\r
-typedef EFI_IMAGE_NT_HEADERS64    EFI_IMAGE_NT_HEADERS;\r
-\r
-#elif defined (MDE_CPU_EBC)\r
-\r
-//\r
-// This is just to make sure you can cross compile with the EBC compiiler.\r
-// It does not make sense to have a PE loader coded in EBC. You need to \r
-// understand the basic \r
-//\r
-#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)\r
-\r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) \r
-\r
 //\r
-// @bug - Remove me when other package updated. \r
-//\r
-typedef EFI_IMAGE_NT_HEADERS64    EFI_IMAGE_NT_HEADERS;\r
-\r
-#else\r
-#error Unknown Processor Type\r
-#endif\r
-\r
-\r
-#define EFI_IMAGE_FIRST_SECTION(ntheader) \\r
-    ( \\r
-      (EFI_IMAGE_SECTION_HEADER *) \\r
-        ( \\r
-          (UINT32) ntheader + \\r
-          FIELD_OFFSET (EFI_IMAGE_NT_HEADERS, OptionalHeader) + \\r
-          ((EFI_IMAGE_NT_HEADERS *) (ntheader))->FileHeader.SizeOfOptionalHeader \\r
-        ) \\r
-    )\r
-\r
-//\r
-// Subsystem Values\r
+// Other Windows Subsystem Values\r
 //\r
 #define EFI_IMAGE_SUBSYSTEM_UNKNOWN     0\r
 #define EFI_IMAGE_SUBSYSTEM_NATIVE      1\r
 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2\r
-#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3.\r
+#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3\r
 #define EFI_IMAGE_SUBSYSTEM_OS2_CUI     5\r
 #define EFI_IMAGE_SUBSYSTEM_POSIX_CUI   7\r
 \r
-//\r
-// Directory Entries\r
-//\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT      0\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT      1\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE    2\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION   3\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY    4\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC   5\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG       6\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT   7\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR   8\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_TLS         9\r
-#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10\r
-\r
-//\r
-// Section header format.\r
-//\r
+///\r
+/// Length of ShortName.\r
+///\r
 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
 \r
+///\r
+/// Section Table. This table immediately follows the optional header.\r
+///\r
 typedef struct {\r
   UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
   union {\r
@@ -384,72 +292,77 @@ typedef struct {
   UINT32  Characteristics;\r
 } EFI_IMAGE_SECTION_HEADER;\r
 \r
+///\r
+/// Size of EFI_IMAGE_SECTION_HEADER.\r
+///\r
 #define EFI_IMAGE_SIZEOF_SECTION_HEADER       40\r
-\r
-#define EFI_IMAGE_SCN_TYPE_NO_PAD             0x00000008  // Reserved.\r
-#define EFI_IMAGE_SCN_CNT_CODE                0x00000020\r
-#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA    0x00000040\r
-#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA  0x00000080\r
-\r
-#define EFI_IMAGE_SCN_LNK_OTHER               0x00000100  // Reserved.\r
-#define EFI_IMAGE_SCN_LNK_INFO                0x00000200  // Section contains comments or some other type of information.\r
-#define EFI_IMAGE_SCN_LNK_REMOVE              0x00000800  // Section contents will not become part of image.\r
-#define EFI_IMAGE_SCN_LNK_COMDAT              0x00001000\r
-\r
-#define EFI_IMAGE_SCN_ALIGN_1BYTES            0x00100000\r
-#define EFI_IMAGE_SCN_ALIGN_2BYTES            0x00200000\r
-#define EFI_IMAGE_SCN_ALIGN_4BYTES            0x00300000\r
-#define EFI_IMAGE_SCN_ALIGN_8BYTES            0x00400000\r
-#define EFI_IMAGE_SCN_ALIGN_16BYTES           0x00500000\r
-#define EFI_IMAGE_SCN_ALIGN_32BYTES           0x00600000\r
-#define EFI_IMAGE_SCN_ALIGN_64BYTES           0x00700000\r
-\r
-#define EFI_IMAGE_SCN_MEM_DISCARDABLE         0x02000000\r
-#define EFI_IMAGE_SCN_MEM_NOT_CACHED          0x04000000\r
-#define EFI_IMAGE_SCN_MEM_NOT_PAGED           0x08000000\r
-#define EFI_IMAGE_SCN_MEM_SHARED              0x10000000\r
-#define EFI_IMAGE_SCN_MEM_EXECUTE             0x20000000\r
-#define EFI_IMAGE_SCN_MEM_READ                0x40000000\r
-#define EFI_IMAGE_SCN_MEM_WRITE               0x80000000\r
+         \r
+//\r
+// Section Flags Values\r
+//\r
+#define EFI_IMAGE_SCN_TYPE_NO_PAD                  BIT3   ///< 0x00000008  ///< Reserved.\r
+#define EFI_IMAGE_SCN_CNT_CODE                     BIT5   ///< 0x00000020\r
+#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA         BIT6   ///< 0x00000040\r
+#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA       BIT7   ///< 0x00000080\r
+                                                   \r
+#define EFI_IMAGE_SCN_LNK_OTHER                    BIT8   ///< 0x00000100  ///< Reserved.\r
+#define EFI_IMAGE_SCN_LNK_INFO                     BIT9   ///< 0x00000200  ///< Section contains comments or some other type of information.\r
+#define EFI_IMAGE_SCN_LNK_REMOVE                   BIT11  ///< 0x00000800  ///< Section contents will not become part of image.\r
+#define EFI_IMAGE_SCN_LNK_COMDAT                   BIT12  ///< 0x00001000\r
+                                                   \r
+#define EFI_IMAGE_SCN_ALIGN_1BYTES                 BIT20  ///< 0x00100000\r
+#define EFI_IMAGE_SCN_ALIGN_2BYTES                 BIT21  ///< 0x00200000\r
+#define EFI_IMAGE_SCN_ALIGN_4BYTES          (BIT20|BIT21) ///< 0x00300000\r
+#define EFI_IMAGE_SCN_ALIGN_8BYTES                 BIT22  ///< 0x00400000\r
+#define EFI_IMAGE_SCN_ALIGN_16BYTES         (BIT20|BIT22) ///< 0x00500000\r
+#define EFI_IMAGE_SCN_ALIGN_32BYTES         (BIT21|BIT22) ///< 0x00600000\r
+#define EFI_IMAGE_SCN_ALIGN_64BYTES   (BIT20|BIT21|BIT22) ///< 0x00700000\r
+                                              \r
+#define EFI_IMAGE_SCN_MEM_DISCARDABLE              BIT25  ///< 0x02000000\r
+#define EFI_IMAGE_SCN_MEM_NOT_CACHED               BIT26  ///< 0x04000000\r
+#define EFI_IMAGE_SCN_MEM_NOT_PAGED                BIT27  ///< 0x08000000\r
+#define EFI_IMAGE_SCN_MEM_SHARED                   BIT28  ///< 0x10000000\r
+#define EFI_IMAGE_SCN_MEM_EXECUTE                  BIT29  ///< 0x20000000\r
+#define EFI_IMAGE_SCN_MEM_READ                     BIT30  ///< 0x40000000\r
+#define EFI_IMAGE_SCN_MEM_WRITE                    BIT31  ///< 0x80000000\r
 \r
 ///\r
-/// Symbol format.\r
+/// Size of a Symbol Table Record.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_SYMBOL 18\r
 \r
-//\r
-// Section values.\r
 //\r
 // Symbols have a section number of the section in which they are\r
 // defined. Otherwise, section numbers have the following meanings:\r
 //\r
-#define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0  // Symbol is undefined or is common.\r
-#define EFI_IMAGE_SYM_ABSOLUTE  (UINT16) -1 // Symbol is an absolute value.\r
-#define EFI_IMAGE_SYM_DEBUG     (UINT16) -2 // Symbol is a special debug item.\r
+#define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0  ///< Symbol is undefined or is common.\r
+#define EFI_IMAGE_SYM_ABSOLUTE  (UINT16) -1 ///< Symbol is an absolute value.\r
+#define EFI_IMAGE_SYM_DEBUG     (UINT16) -2 ///< Symbol is a special debug item.\r
+\r
 //\r
-// Type (fundamental) values.\r
+// Symbol Type (fundamental) values.\r
 //\r
-#define EFI_IMAGE_SYM_TYPE_NULL   0   // no type.\r
-#define EFI_IMAGE_SYM_TYPE_VOID   1   //\r
-#define EFI_IMAGE_SYM_TYPE_CHAR   2   // type character.\r
-#define EFI_IMAGE_SYM_TYPE_SHORT  3   // type short integer.\r
+#define EFI_IMAGE_SYM_TYPE_NULL   0   ///< no type.\r
+#define EFI_IMAGE_SYM_TYPE_VOID   1   ///< no valid type.\r
+#define EFI_IMAGE_SYM_TYPE_CHAR   2   ///< type character.\r
+#define EFI_IMAGE_SYM_TYPE_SHORT  3   ///< type short integer.\r
 #define EFI_IMAGE_SYM_TYPE_INT    4\r
 #define EFI_IMAGE_SYM_TYPE_LONG   5\r
 #define EFI_IMAGE_SYM_TYPE_FLOAT  6\r
 #define EFI_IMAGE_SYM_TYPE_DOUBLE 7\r
 #define EFI_IMAGE_SYM_TYPE_STRUCT 8\r
 #define EFI_IMAGE_SYM_TYPE_UNION  9\r
-#define EFI_IMAGE_SYM_TYPE_ENUM   10  // enumeration.\r
-#define EFI_IMAGE_SYM_TYPE_MOE    11  // member of enumeration.\r
+#define EFI_IMAGE_SYM_TYPE_ENUM   10  ///< enumeration.\r
+#define EFI_IMAGE_SYM_TYPE_MOE    11  ///< member of enumeration.\r
 #define EFI_IMAGE_SYM_TYPE_BYTE   12\r
 #define EFI_IMAGE_SYM_TYPE_WORD   13\r
 #define EFI_IMAGE_SYM_TYPE_UINT   14\r
 #define EFI_IMAGE_SYM_TYPE_DWORD  15\r
 \r
 //\r
-// Type (derived) values.\r
+// Symbol Type (derived) values.\r
 //\r
-#define EFI_IMAGE_SYM_DTYPE_NULL      0 // no derived type.\r
+#define EFI_IMAGE_SYM_DTYPE_NULL      0 ///< no derived type.\r
 #define EFI_IMAGE_SYM_DTYPE_POINTER   1\r
 #define EFI_IMAGE_SYM_DTYPE_FUNCTION  2\r
 #define EFI_IMAGE_SYM_DTYPE_ARRAY     3\r
@@ -457,7 +370,7 @@ typedef struct {
 //\r
 // Storage classes.\r
 //\r
-#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION   (UINT8) -1\r
+#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION   ((UINT8) -1)\r
 #define EFI_IMAGE_SYM_CLASS_NULL              0\r
 #define EFI_IMAGE_SYM_CLASS_AUTOMATIC         1\r
 #define EFI_IMAGE_SYM_CLASS_EXTERNAL          2\r
@@ -502,7 +415,10 @@ typedef struct {
 #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE       3\r
 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH     4\r
 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE     5\r
-\r
+                                       \r
+//\r
+// the following values only be referred in PeCoff, not defined in PECOFF.\r
+//\r
 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY  1\r
 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY    2\r
 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS      3\r
@@ -516,41 +432,44 @@ typedef struct {
   UINT16  Type;\r
 } EFI_IMAGE_RELOCATION;\r
 \r
+///\r
+/// Size of EFI_IMAGE_RELOCATION\r
+///\r
 #define EFI_IMAGE_SIZEOF_RELOCATION 10\r
 \r
 //\r
 // I386 relocation types.\r
 //\r
-#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000   // Reference is absolute, no relocation is necessary\r
-#define EFI_IMAGE_REL_I386_DIR16    0x0001  // Direct 16-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_REL16    0x0002  // PC-relative 16-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_DIR32    0x0006  // Direct 32-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_DIR32NB  0x0007  // Direct 32-bit reference to the symbols virtual address, base not included\r
-#define EFI_IMAGE_REL_I386_SEG12    0x0009 // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address\r
-#define EFI_IMAGE_REL_I386_SECTION  0x001a\r
-#define EFI_IMAGE_REL_I386_SECREL   0x000b\r
-#define EFI_IMAGE_REL_I386_REL32    0x0014 // PC-relative 32-bit reference to the symbols virtual address\r
-\r
-//\r
+#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000  ///< Reference is absolute, no relocation is necessary.\r
+#define EFI_IMAGE_REL_I386_DIR16    0x0001  ///< Direct 16-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_REL16    0x0002  ///< PC-relative 16-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_DIR32    0x0006  ///< Direct 32-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_DIR32NB  0x0007  ///< Direct 32-bit reference to the symbols virtual address, base not included.\r
+#define EFI_IMAGE_REL_I386_SEG12    0x0009  ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.\r
+#define EFI_IMAGE_REL_I386_SECTION  0x000A\r
+#define EFI_IMAGE_REL_I386_SECREL   0x000B\r
+#define EFI_IMAGE_REL_I386_REL32    0x0014  ///< PC-relative 32-bit reference to the symbols virtual address.\r
+\r
+// \r
 // x64 processor relocation types.\r
-//\r
-#define IMAGE_REL_AMD64_ABSOLUTE       0x0000\r
-#define IMAGE_REL_AMD64_ADDR64   0x0001\r
-#define IMAGE_REL_AMD64_ADDR32   0x0002\r
-#define IMAGE_REL_AMD64_ADDR32NB       0x0003\r
-#define IMAGE_REL_AMD64_REL32      0x0004\r
-#define IMAGE_REL_AMD64_REL32_1          0x0005\r
-#define IMAGE_REL_AMD64_REL32_2          0x0006\r
-#define IMAGE_REL_AMD64_REL32_3          0x0007\r
-#define IMAGE_REL_AMD64_REL32_4          0x0008\r
-#define IMAGE_REL_AMD64_REL32_5          0x0009\r
-#define IMAGE_REL_AMD64_SECTION          0x000A\r
-#define IMAGE_REL_AMD64_SECREL   0x000B\r
-#define IMAGE_REL_AMD64_SECREL7          0x000C\r
-#define IMAGE_REL_AMD64_TOKEN      0x000D\r
-#define IMAGE_REL_AMD64_SREL32   0x000E\r
-#define IMAGE_REL_AMD64_PAIR       0x000F\r
-#define IMAGE_REL_AMD64_SSPAN32          0x0010\r
+// \r
+#define IMAGE_REL_AMD64_ABSOLUTE  0x0000\r
+#define IMAGE_REL_AMD64_ADDR64    0x0001\r
+#define IMAGE_REL_AMD64_ADDR32    0x0002\r
+#define IMAGE_REL_AMD64_ADDR32NB  0x0003\r
+#define IMAGE_REL_AMD64_REL32     0x0004\r
+#define IMAGE_REL_AMD64_REL32_1   0x0005\r
+#define IMAGE_REL_AMD64_REL32_2   0x0006\r
+#define IMAGE_REL_AMD64_REL32_3   0x0007\r
+#define IMAGE_REL_AMD64_REL32_4   0x0008\r
+#define IMAGE_REL_AMD64_REL32_5   0x0009\r
+#define IMAGE_REL_AMD64_SECTION   0x000A\r
+#define IMAGE_REL_AMD64_SECREL    0x000B\r
+#define IMAGE_REL_AMD64_SECREL7   0x000C\r
+#define IMAGE_REL_AMD64_TOKEN     0x000D\r
+#define IMAGE_REL_AMD64_SREL32    0x000E\r
+#define IMAGE_REL_AMD64_PAIR      0x000F\r
+#define IMAGE_REL_AMD64_SSPAN32   0x0010\r
 \r
 ///\r
 /// Based relocation format.\r
@@ -560,31 +479,40 @@ typedef struct {
   UINT32  SizeOfBlock;\r
 } EFI_IMAGE_BASE_RELOCATION;\r
 \r
+///\r
+/// Size of EFI_IMAGE_BASE_RELOCATION.\r
+///\r
 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION  8\r
 \r
 //\r
 // Based relocation types.\r
 //\r
-#define EFI_IMAGE_REL_BASED_ABSOLUTE      0\r
-#define EFI_IMAGE_REL_BASED_HIGH          1\r
-#define EFI_IMAGE_REL_BASED_LOW           2\r
-#define EFI_IMAGE_REL_BASED_HIGHLOW       3\r
-#define EFI_IMAGE_REL_BASED_HIGHADJ       4\r
-#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR  5\r
-#define EFI_IMAGE_REL_BASED_IA64_IMM64    9\r
-#define EFI_IMAGE_REL_BASED_DIR64         10\r
+#define EFI_IMAGE_REL_BASED_ABSOLUTE        0\r
+#define EFI_IMAGE_REL_BASED_HIGH            1\r
+#define EFI_IMAGE_REL_BASED_LOW             2\r
+#define EFI_IMAGE_REL_BASED_HIGHLOW         3\r
+#define EFI_IMAGE_REL_BASED_HIGHADJ         4\r
+#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR    5\r
+#define EFI_IMAGE_REL_BASED_ARM_MOV32A      5\r
+#define EFI_IMAGE_REL_BASED_ARM_MOV32T      7\r
+#define EFI_IMAGE_REL_BASED_IA64_IMM64      9\r
+#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR16  9\r
+#define EFI_IMAGE_REL_BASED_DIR64           10\r
 \r
 ///\r
 /// Line number format.\r
 ///\r
 typedef struct {\r
   union {\r
-    UINT32  SymbolTableIndex; // Symbol table index of function name if Linenumber is 0.\r
-    UINT32  VirtualAddress;   // Virtual address of line number.\r
+    UINT32  SymbolTableIndex; ///< Symbol table index of function name if Linenumber is 0.\r
+    UINT32  VirtualAddress;   ///< Virtual address of line number.\r
   } Type;\r
-  UINT16  Linenumber;         // Line number.\r
+  UINT16  Linenumber;         ///< Line number.\r
 } EFI_IMAGE_LINENUMBER;\r
 \r
+///\r
+/// Size of EFI_IMAGE_LINENUMBER.\r
+///\r
 #define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
 \r
 //\r
@@ -597,24 +525,31 @@ typedef struct {
 #define EFI_IMAGE_ARCHIVE_LINKER_MEMBER     "/               "\r
 #define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER  "//              "\r
 \r
+///\r
+/// Archive Member Headers\r
+///\r
 typedef struct {\r
-  UINT8 Name[16];     // File member name - `/' terminated.\r
-  UINT8 Date[12];     // File member date - decimal.\r
-  UINT8 UserID[6];    // File member user id - decimal.\r
-  UINT8 GroupID[6];   // File member group id - decimal.\r
-  UINT8 Mode[8];      // File member mode - octal.\r
-  UINT8 Size[10];     // File member size - decimal.\r
-  UINT8 EndHeader[2]; // String to end header.\r
+  UINT8 Name[16];     ///< File member name - `/' terminated.\r
+  UINT8 Date[12];     ///< File member date - decimal.\r
+  UINT8 UserID[6];    ///< File member user id - decimal.\r
+  UINT8 GroupID[6];   ///< File member group id - decimal.\r
+  UINT8 Mode[8];      ///< File member mode - octal.\r
+  UINT8 Size[10];     ///< File member size - decimal.\r
+  UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).\r
 } EFI_IMAGE_ARCHIVE_MEMBER_HEADER;\r
 \r
+///\r
+/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.\r
+///\r
 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
 \r
+\r
 //\r
-// DLL support.\r
+// DLL Support\r
 //\r
 \r
 ///\r
-/// DLL Export Format\r
+/// Export Directory Table.\r
 ///\r
 typedef struct {\r
   UINT32  Characteristics;\r
@@ -631,14 +566,16 @@ typedef struct {
 } EFI_IMAGE_EXPORT_DIRECTORY;\r
 \r
 ///\r
-/// DLL support.\r
-/// Import Format\r
+/// Hint/Name Table.\r
 ///\r
 typedef struct {\r
   UINT16  Hint;\r
   UINT8   Name[1];\r
 } EFI_IMAGE_IMPORT_BY_NAME;\r
 \r
+///\r
+/// Import Address Table RVA (Thunk Table).\r
+///\r
 typedef struct {\r
   union {\r
     UINT32                    Function;\r
@@ -647,10 +584,13 @@ typedef struct {
   } u1;\r
 } EFI_IMAGE_THUNK_DATA;\r
 \r
-#define EFI_IMAGE_ORDINAL_FLAG              0x80000000\r
+#define EFI_IMAGE_ORDINAL_FLAG              BIT31    ///< Flag for PE32.\r
 #define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal)  ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)\r
 #define EFI_IMAGE_ORDINAL(Ordinal)          (Ordinal & 0xffff)\r
 \r
+///\r
+/// Import Directory Table\r
+///\r
 typedef struct {\r
   UINT32                Characteristics;\r
   UINT32                TimeDateStamp;\r
@@ -659,11 +599,10 @@ typedef struct {
   EFI_IMAGE_THUNK_DATA  *FirstThunk;\r
 } EFI_IMAGE_IMPORT_DESCRIPTOR;\r
 \r
+\r
 ///\r
-/// Debug Format\r
+/// Debug Directory Format.\r
 ///\r
-#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2\r
-\r
 typedef struct {\r
   UINT32  Characteristics;\r
   UINT32  TimeDateStamp;\r
@@ -671,13 +610,18 @@ typedef struct {
   UINT16  MinorVersion;\r
   UINT32  Type;\r
   UINT32  SizeOfData;\r
-  UINT32  RVA;\r
-  UINT32  FileOffset;\r
+  UINT32  RVA;           ///< The address of the debug data when loaded, relative to the image base.\r
+  UINT32  FileOffset;    ///< The file pointer to the debug data.\r
 } EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;\r
 \r
-#define CODEVIEW_SIGNATURE_NB10 0x3031424E  // "NB10"\r
+#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2     ///< The Visual C++ debug information.\r
+\r
+///\r
+/// Debug Data Structure defined in Microsoft C++.\r
+///\r
+#define CODEVIEW_SIGNATURE_NB10  SIGNATURE_32('N', 'B', '1', '0')\r
 typedef struct {\r
-  UINT32  Signature;                        // "NB10"\r
+  UINT32  Signature;                        ///< "NB10"\r
   UINT32  Unknown;\r
   UINT32  Unknown2;\r
   UINT32  Unknown3;\r
@@ -686,9 +630,12 @@ typedef struct {
   //\r
 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;\r
 \r
-#define CODEVIEW_SIGNATURE_RSDS 0x53445352  // "RSDS"\r
+///\r
+/// Debug Data Structure defined in Microsoft C++.\r
+///\r
+#define CODEVIEW_SIGNATURE_RSDS  SIGNATURE_32('R', 'S', 'D', 'S')\r
 typedef struct {\r
-  UINT32  Signature;                        // "RSDS"\r
+  UINT32  Signature;                        ///< "RSDS".\r
   UINT32  Unknown;\r
   UINT32  Unknown2;\r
   UINT32  Unknown3;\r
@@ -699,22 +646,89 @@ typedef struct {
   //\r
 } EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;\r
 \r
+\r
+///\r
+/// Debug Data Structure defined by Apple Mach-O to Coff utility.\r
+///\r
+#define CODEVIEW_SIGNATURE_MTOC  SIGNATURE_32('M', 'T', 'O', 'C')\r
+typedef struct {\r
+  UINT32    Signature;                       ///< "MTOC".\r
+  GUID      MachOUuid;\r
+  //\r
+  //  Filename of .DLL (Mach-O with debug info) goes here\r
+  //\r
+} EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY;\r
+\r
+///\r
+/// Resource format.\r
+///\r
+typedef struct {\r
+  UINT32  Characteristics;\r
+  UINT32  TimeDateStamp;\r
+  UINT16  MajorVersion;\r
+  UINT16  MinorVersion;\r
+  UINT16  NumberOfNamedEntries;\r
+  UINT16  NumberOfIdEntries;\r
+  //\r
+  // Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here.\r
+  //\r
+} EFI_IMAGE_RESOURCE_DIRECTORY;\r
+\r
 ///\r
-/// Header format for TE images\r
+/// Resource directory entry format.\r
 ///\r
 typedef struct {\r
-  UINT16                    Signature;            // signature for TE format = "VZ"\r
-  UINT16                    Machine;              // from the original file header\r
-  UINT8                     NumberOfSections;     // from the original file header\r
-  UINT8                     Subsystem;            // from original optional header\r
-  UINT16                    StrippedSize;         // how many bytes we removed from the header\r
-  UINT32                    AddressOfEntryPoint;  // offset to entry point -- from original optional header\r
-  UINT32                    BaseOfCode;           // from original image -- required for ITP debug\r
-  UINT64                    ImageBase;            // from original file header\r
-  EFI_IMAGE_DATA_DIRECTORY  DataDirectory[2];     // only base relocation and debug directory\r
+  union {\r
+    struct {\r
+      UINT32  NameOffset:31;\r
+      UINT32  NameIsString:1;\r
+    } s;\r
+    UINT32  Id;\r
+  } u1;\r
+  union {\r
+    UINT32  OffsetToData;\r
+    struct {\r
+      UINT32  OffsetToDirectory:31;\r
+      UINT32  DataIsDirectory:1;\r
+    } s;\r
+  } u2;\r
+} EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;\r
+\r
+///\r
+/// Resource directory entry for string.\r
+///\r
+typedef struct {\r
+  UINT16  Length;\r
+  CHAR16  String[1];\r
+} EFI_IMAGE_RESOURCE_DIRECTORY_STRING;\r
+\r
+///\r
+/// Resource directory entry for data array.\r
+///\r
+typedef struct {\r
+  UINT32  OffsetToData;\r
+  UINT32  Size;\r
+  UINT32  CodePage;\r
+  UINT32  Reserved;\r
+} EFI_IMAGE_RESOURCE_DATA_ENTRY;\r
+\r
+///\r
+/// Header format for TE images, defined in the PI Specification, 1.0.\r
+///\r
+typedef struct {\r
+  UINT16                    Signature;            ///< The signature for TE format = "VZ".\r
+  UINT16                    Machine;              ///< From the original file header.\r
+  UINT8                     NumberOfSections;     ///< From the original file header.\r
+  UINT8                     Subsystem;            ///< From original optional header.\r
+  UINT16                    StrippedSize;         ///< Number of bytes we removed from the header.\r
+  UINT32                    AddressOfEntryPoint;  ///< Offset to entry point -- from original optional header.\r
+  UINT32                    BaseOfCode;           ///< From original image -- required for ITP debug.\r
+  UINT64                    ImageBase;            ///< From original file header.\r
+  EFI_IMAGE_DATA_DIRECTORY  DataDirectory[2];     ///< Only base relocation and debug directory.\r
 } EFI_TE_IMAGE_HEADER;\r
 \r
-#define EFI_TE_IMAGE_HEADER_SIGNATURE 0x5A56      // "VZ"\r
+\r
+#define EFI_TE_IMAGE_HEADER_SIGNATURE  SIGNATURE_16('V', 'Z')\r
 \r
 //\r
 // Data directory indexes in our TE image header\r
@@ -723,9 +737,9 @@ typedef struct {
 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG      1\r
 \r
 \r
-//\r
-// Union of PE32, PE32+, and TE headers\r
-//\r
+///\r
+/// Union of PE32, PE32+, and TE headers.\r
+///\r
 typedef union {\r
   EFI_IMAGE_NT_HEADERS32   Pe32;\r
   EFI_IMAGE_NT_HEADERS64   Pe32Plus;\r