Common Object File Format Specification, Revision 8.0 - May 16, 2006. \r
This file also includes some definitions in PI Specification, Revision 1.0.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation\r
+ Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
+ Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
#ifndef __PE_IMAGE_H__\r
#define __PE_IMAGE_H__\r
\r
-///\r
-/// PE32+ Subsystem type for EFI images\r
-///\r
+//\r
+// PE32+ Subsystem type for EFI images\r
+//\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 ///< 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
//\r
-// Support old names for backward compatible\r
+// PE32+ Machine type for EFI images\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
+#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
\r
-///\r
-/// EXE file formats\r
-///\r
+//\r
+// EXE file formats\r
+//\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
///\r
#define EFI_IMAGE_SIZEOF_FILE_HEADER 20\r
\r
-///\r
-/// Characteristics\r
-///\r
+//\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_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
-/// Other Machine Types\r
-///\r
-#define EFI_IMAGE_FILE_MACHINE_UNKNOWN 0 ///< Any machine type\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_POWERPC 0x1F0 ///< IBM* PowerPC Little-Endian\r
-//\r
-// * Other names and brands may be claimed as the property of others.\r
-//\r
-\r
///\r
/// Header Data Directories\r
///\r
UINT32 Size;\r
} EFI_IMAGE_DATA_DIRECTORY;\r
\r
-#define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC 0x107\r
-\r
-///\r
-/// Directory Entries\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
/// 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
UINT32 BaseOfCode;\r
UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+\r
///\r
- /// NT additional fields.\r
+ /// Optional Header Windows-Specific Fields.\r
///\r
UINT32 ImageBase;\r
UINT32 SectionAlignment;\r
///\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
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
\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
\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
\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
-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
-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
-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
-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
-/// Other Windows Subsystem Values\r
-///\r
+//\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_POSIX_CUI 7\r
\r
///\r
-/// Section header format.\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
///\r
#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40\r
\r
-///\r
-/// Section Flags Values\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
\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 BIT10 ///< 0x00000800 ///< Section contents will not become part of image.\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
///\r
#define EFI_IMAGE_SIZEOF_SYMBOL 18\r
\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
+//\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
\r
-///\r
-/// Symbol Type (fundamental) values.\r
-///\r
+//\r
+// Symbol Type (fundamental) values.\r
+//\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_UINT 14\r
#define EFI_IMAGE_SYM_TYPE_DWORD 15\r
\r
-///\r
-/// Symbol Type (derived) values.\r
-///\r
+//\r
+// Symbol Type (derived) values.\r
+//\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
\r
-///\r
-/// Storage classes.\r
-///\r
+//\r
+// Storage classes.\r
+//\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_N_BTSHFT 4\r
#define EFI_IMAGE_N_TSHIFT 2\r
\r
-///\r
-/// Communal selection types.\r
-///\r
+//\r
+// Communal selection types.\r
+//\r
#define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1\r
#define EFI_IMAGE_COMDAT_SELECT_ANY 2\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
-/// the following values only be referred in PeCoff, not defined in PECOFF.\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
///\r
#define EFI_IMAGE_SIZEOF_RELOCATION 10\r
\r
-///\r
-/// I386 relocation types.\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_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
+// \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
///\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 IMAGE_REL_BASED_MIPS_JMPADDR16 9\r
-#define EFI_IMAGE_REL_BASED_DIR64 10\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_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
///\r
#define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
\r
-///\r
-/// Archive format.\r
-///\r
+//\r
+// Archive format.\r
+//\r
#define EFI_IMAGE_ARCHIVE_START_SIZE 8\r
#define EFI_IMAGE_ARCHIVE_START "!<arch>\n"\r
#define EFI_IMAGE_ARCHIVE_END "`\n"\r
#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
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
\r
\r
-///\r
-/// DLL Support\r
-///\r
+//\r
+// DLL Support\r
+//\r
\r
///\r
/// Export Directory Table\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
\r
\r
///\r
-/// Debug Direcotry Format\r
+/// Debug Directory Format\r
///\r
typedef struct {\r
UINT32 Characteristics;\r
//\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
+/// Resource directory entry format.\r
+///\r
+typedef struct {\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 PI Specification, 1.0\r
///\r
projects / mirror_edk2.git / blobdiff