/** @file\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
+ 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
+ This file is coded to the Visual Studio, Microsoft Portable Executable and\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 - 2009, Intel Corporation<BR>\r
- Portions Copyright (c) 2008-2009 Apple Inc.<BR>\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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
+Portions Copyright (c) 2016 - 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\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
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\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
+#define IMAGE_FILE_MACHINE_RISCV32 0x5032\r
+#define IMAGE_FILE_MACHINE_RISCV64 0x5064\r
+#define IMAGE_FILE_MACHINE_RISCV128 0x5128\r
\r
//\r
// EXE file formats\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
-/// COFF File Header (Object and Image)\r
+/// COFF File Header (Object and Image).\r
///\r
typedef struct {\r
UINT16 Machine;\r
} EFI_IMAGE_FILE_HEADER;\r
\r
///\r
-/// Size of EFI_IMAGE_FILE_HEADER\r
+/// Size of EFI_IMAGE_FILE_HEADER.\r
///\r
#define EFI_IMAGE_SIZEOF_FILE_HEADER 20\r
\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_LINE_NUMS_STRIPPED BIT2 ///< 0x0004 Line numbers 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_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
-/// Header Data Directories\r
+/// Header Data Directories.\r
///\r
typedef struct {\r
UINT32 VirtualAddress;\r
\r
///\r
/// @attention\r
-/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and \r
+/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and\r
/// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary\r
/// 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
+/// Optional Header Standard Fields for PE32.\r
///\r
typedef struct {\r
///\r
UINT32 SizeOfUninitializedData;\r
UINT32 AddressOfEntryPoint;\r
UINT32 BaseOfCode;\r
- UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+\r
+ UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.\r
///\r
/// Optional Header Windows-Specific Fields.\r
///\r
\r
///\r
/// @attention\r
-/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and \r
+/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and\r
/// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary\r
/// after NT additional fields.\r
///\r
#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
\r
///\r
-/// Optional Header Standard Fields for PE32+\r
+/// Optional Header Standard Fields for PE32+.\r
///\r
typedef struct {\r
///\r
#define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
\r
///\r
-/// Section Table, this table immediately follows the optional header\r
+/// Section Table. This table immediately follows the optional header.\r
///\r
typedef struct {\r
UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
} EFI_IMAGE_SECTION_HEADER;\r
\r
///\r
-/// Size of EFI_IMAGE_SECTION_HEADER\r
+/// Size of EFI_IMAGE_SECTION_HEADER.\r
///\r
#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40\r
- \r
+\r
//\r
// Section Flags Values\r
//\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
+\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
+\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_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
+\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_WRITE BIT31 ///< 0x80000000\r
\r
///\r
-/// Size of a Symbol Table Record\r
+/// Size of a Symbol Table Record.\r
///\r
#define EFI_IMAGE_SIZEOF_SYMBOL 18\r
\r
#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
//\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_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
+#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.\r
\r
-// \r
+//\r
// x64 processor relocation types.\r
-// \r
+//\r
#define IMAGE_REL_AMD64_ABSOLUTE 0x0000\r
#define IMAGE_REL_AMD64_ADDR64 0x0001\r
#define IMAGE_REL_AMD64_ADDR32 0x0002\r
} EFI_IMAGE_BASE_RELOCATION;\r
\r
///\r
-/// Size of EFI_IMAGE_BASE_RELOCATION\r
+/// Size of EFI_IMAGE_BASE_RELOCATION.\r
///\r
#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8\r
\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
+/// Relocation types of RISC-V processor.\r
+///\r
+#define EFI_IMAGE_REL_BASED_RISCV_HI20 5\r
+#define EFI_IMAGE_REL_BASED_RISCV_LOW12I 7\r
+#define EFI_IMAGE_REL_BASED_RISCV_LOW12S 8\r
+\r
///\r
/// Line number format.\r
///\r
} EFI_IMAGE_LINENUMBER;\r
\r
///\r
-/// Size of EFI_IMAGE_LINENUMBER\r
+/// Size of EFI_IMAGE_LINENUMBER.\r
///\r
#define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
\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
+ 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
+/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.\r
///\r
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
\r
//\r
\r
///\r
-/// Export Directory Table\r
+/// Export Directory Table.\r
///\r
typedef struct {\r
UINT32 Characteristics;\r
} EFI_IMAGE_EXPORT_DIRECTORY;\r
\r
///\r
-/// Hint/Name Table\r
+/// Hint/Name Table.\r
///\r
typedef struct {\r
UINT16 Hint;\r
} EFI_IMAGE_IMPORT_BY_NAME;\r
\r
///\r
-/// Import Address Table RVA (Thunk Table)\r
+/// Import Address Table RVA (Thunk Table).\r
///\r
typedef struct {\r
union {\r
} u1;\r
} EFI_IMAGE_THUNK_DATA;\r
\r
-#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32\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
\r
///\r
-/// Debug Directory Format\r
+/// Debug Directory Format.\r
///\r
typedef struct {\r
UINT32 Characteristics;\r
UINT16 MinorVersion;\r
UINT32 Type;\r
UINT32 SizeOfData;\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
+ 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 EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information\r
+#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information.\r
\r
///\r
-/// Debug Data Structure defined in Microsoft C++\r
+/// Debug Data Structure defined in Microsoft C++.\r
///\r
#define CODEVIEW_SIGNATURE_NB10 SIGNATURE_32('N', 'B', '1', '0')\r
typedef struct {\r
} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;\r
\r
///\r
-/// Debug Data Structure defined in Microsoft C++\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
\r
\r
///\r
-/// Debug Data Structure defined by Apple Mach-O to Coff utility\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
+ UINT32 Signature; ///< "MTOC".\r
GUID MachOUuid;\r
//\r
// Filename of .DLL (Mach-O with debug info) goes here\r
} EFI_IMAGE_RESOURCE_DATA_ENTRY;\r
\r
///\r
-/// Header format for TE images, defined in PI Specification, 1.0\r
+/// Header format for TE images, defined in the PI Specification, 1.0.\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
+ 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
\r
\r
\r
///\r
-/// Union of PE32, PE32+, and TE headers\r
+/// Union of PE32, PE32+, and TE headers.\r
///\r
typedef union {\r
EFI_IMAGE_NT_HEADERS32 Pe32;\r
projects / mirror_edk2.git / blobdiff