EFI payload / application support v2

The EFI API header is great, but missing a good chunk of function prototype, GUID defines and enum declarations.

This patch extends it to cover more of the EFI API. It's still not 100% complete, but sufficient enough for our EFI payload interface.

Signed-off-by Alexander Graf <[email protected]>

---
 include/efi_api.h | 197 ++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 160 insertions(+), 37 deletions(-)

Quoted 6 lines · Alexander Graf

The EFI API header is great, but missing a good chunk of function prototype, GUID defines and enum declarations.

This patch extends it to cover more of the EFI API. It's still not 100% complete, but sufficient enough for our EFI payload interface.

Quoted 4 lines

Signed-off-by Alexander Graf <[email protected]>

---
  include/efi_api.h | 197 ++++++++++++++++++++++++++++++++++++++++++++----------
  1 file changed, 160 insertions(+), 37 deletions(-)

Reviewed-by Simon Glass <[email protected]>

But does the notify_function parameter need EFIAPI also?

EFI uses the PE binary format for its application images. Add support to EFI PE binaries as well as all necessary bits for the "EFI image loader" interfaces.

Signed-off-by Alexander Graf <[email protected]>

---

v1 -> v2:

- move memory allocation to separate patch
- limit 32/64 to hosts that support it
- check 32bit optional nt header magic
- switch to GPL2+

---
 include/efi_loader.h              |  23 ++++
 include/pe.h                      | 263 ++++++++++++++++++++++++++++++++++++++
 lib/efi_loader/efi_image_loader.c | 178 ++++++++++++++++++++++++++
 3 files changed, 464 insertions(+)
 create mode 100644 include/efi_loader.h
 create mode 100644 include/pe.h
 create mode 100644 lib/efi_loader/efi_image_loader.c

include/efi_loader.h new file +23 -0

new file mode 100644
index 0000000..bf77573
@@ -0,0 +1,23 @@
+/*
+ *  EFI application loader
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+#include <part_efi.h>
+#include <efi_api.h>
+#include <linux/list.h>
+
+extern const efi_guid_t efi_guid_device_path;
+extern const efi_guid_t efi_guid_loaded_image;
+
+efi_status_t efi_return_handle(void *handle,
+               efi_guid_t *protocol, void **protocol_interface,
+               void *agent_handle, void *controller_handle,
+               uint32_t attributes);
+void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
+
+#define EFI_LOADER_POOL_SIZE (128 * 1024 * 1024)
+void *efi_loader_alloc(uint64_t len);

include/pe.h new file +263 -0

new file mode 100644
index 0000000..6379ae1
@@ -0,0 +1,263 @@
+/*
+ *  Portable Executable binary format structures
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  Based on wine code
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+#ifndef _PE_H
+#define _PE_H
+
+typedef struct _IMAGE_DOS_HEADER {
+       uint16_t e_magic;      /* 00: MZ Header signature */
+       uint16_t e_cblp;       /* 02: Bytes on last page of file */
+       uint16_t e_cp;         /* 04: Pages in file */
+       uint16_t e_crlc;       /* 06: Relocations */
+       uint16_t e_cparhdr;    /* 08: Size of header in paragraphs */
+       uint16_t e_minalloc;   /* 0a: Minimum extra paragraphs needed */
+       uint16_t e_maxalloc;   /* 0c: Maximum extra paragraphs needed */
+       uint16_t e_ss;         /* 0e: Initial (relative) SS value */
+       uint16_t e_sp;         /* 10: Initial SP value */
+       uint16_t e_csum;       /* 12: Checksum */
+       uint16_t e_ip;         /* 14: Initial IP value */
+       uint16_t e_cs;         /* 16: Initial (relative) CS value */
+       uint16_t e_lfarlc;     /* 18: File address of relocation table */
+       uint16_t e_ovno;       /* 1a: Overlay number */
+       uint16_t e_res[4];     /* 1c: Reserved words */
+       uint16_t e_oemid;      /* 24: OEM identifier (for e_oeminfo) */
+       uint16_t e_oeminfo;    /* 26: OEM information; e_oemid specific */
+       uint16_t e_res2[10];   /* 28: Reserved words */
+       uint32_t e_lfanew;     /* 3c: Offset to extended header */
+} IMAGE_DOS_HEADER, *PIMAGE_DOS_HEADER;
+
+#define IMAGE_DOS_SIGNATURE            0x5A4D     /* MZ   */
+#define IMAGE_NT_SIGNATURE             0x00004550 /* PE00 */
+
+#define IMAGE_FILE_MACHINE_ARM         0x01c0
+#define IMAGE_FILE_MACHINE_THUMB       0x01c2
+#define IMAGE_FILE_MACHINE_ARMNT       0x01c4
+#define IMAGE_FILE_MACHINE_AMD64       0x8664
+#define IMAGE_FILE_MACHINE_ARM64       0xaa64
+#define IMAGE_NT_OPTIONAL_HDR32_MAGIC  0x10b
+#define IMAGE_NT_OPTIONAL_HDR64_MAGIC  0x20b
+#define IMAGE_SUBSYSTEM_EFI_APPLICATION        10
+
+typedef struct _IMAGE_FILE_HEADER {
+       uint16_t  Machine;
+       uint16_t  NumberOfSections;
+       uint32_t TimeDateStamp;
+       uint32_t PointerToSymbolTable;
+       uint32_t NumberOfSymbols;
+       uint16_t  SizeOfOptionalHeader;
+       uint16_t  Characteristics;
+} IMAGE_FILE_HEADER, *PIMAGE_FILE_HEADER;
+
+typedef struct _IMAGE_DATA_DIRECTORY {
+       uint32_t VirtualAddress;
+       uint32_t Size;
+} IMAGE_DATA_DIRECTORY, *PIMAGE_DATA_DIRECTORY;
+
+#define IMAGE_NUMBEROF_DIRECTORY_ENTRIES 16
+
+typedef struct _IMAGE_OPTIONAL_HEADER64 {
+       uint16_t  Magic; /* 0x20b */
+       uint8_t MajorLinkerVersion;
+       uint8_t MinorLinkerVersion;
+       uint32_t SizeOfCode;
+       uint32_t SizeOfInitializedData;
+       uint32_t SizeOfUninitializedData;
+       uint32_t AddressOfEntryPoint;
+       uint32_t BaseOfCode;
+       uint64_t ImageBase;
+       uint32_t SectionAlignment;
+       uint32_t FileAlignment;
+       uint16_t MajorOperatingSystemVersion;
+       uint16_t MinorOperatingSystemVersion;
+       uint16_t MajorImageVersion;
+       uint16_t MinorImageVersion;
+       uint16_t MajorSubsystemVersion;
+       uint16_t MinorSubsystemVersion;
+       uint32_t Win32VersionValue;
+       uint32_t SizeOfImage;
+       uint32_t SizeOfHeaders;
+       uint32_t CheckSum;
+       uint16_t Subsystem;
+       uint16_t DllCharacteristics;
+       uint64_t SizeOfStackReserve;
+       uint64_t SizeOfStackCommit;
+       uint64_t SizeOfHeapReserve;
+       uint64_t SizeOfHeapCommit;
+       uint32_t LoaderFlags;
+       uint32_t NumberOfRvaAndSizes;
+       IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
+} IMAGE_OPTIONAL_HEADER64, *PIMAGE_OPTIONAL_HEADER64;
+
+typedef struct _IMAGE_NT_HEADERS64 {
+       uint32_t Signature;
+       IMAGE_FILE_HEADER FileHeader;
+       IMAGE_OPTIONAL_HEADER64 OptionalHeader;
+} IMAGE_NT_HEADERS64, *PIMAGE_NT_HEADERS64;
+
+typedef struct _IMAGE_OPTIONAL_HEADER {
+
+       /* Standard fields */
+
+       uint16_t  Magic; /* 0x10b or 0x107 */     /* 0x00 */
+       uint8_t  MajorLinkerVersion;
+       uint8_t  MinorLinkerVersion;
+       uint32_t SizeOfCode;
+       uint32_t SizeOfInitializedData;
+       uint32_t SizeOfUninitializedData;
+       uint32_t AddressOfEntryPoint;            /* 0x10 */
+       uint32_t BaseOfCode;
+       uint32_t BaseOfData;
+
+       /* NT additional fields */
+
+       uint32_t ImageBase;
+       uint32_t SectionAlignment;               /* 0x20 */
+       uint32_t FileAlignment;
+       uint16_t  MajorOperatingSystemVersion;
+       uint16_t  MinorOperatingSystemVersion;
+       uint16_t  MajorImageVersion;
+       uint16_t  MinorImageVersion;
+       uint16_t  MajorSubsystemVersion;          /* 0x30 */
+       uint16_t  MinorSubsystemVersion;
+       uint32_t Win32VersionValue;
+       uint32_t SizeOfImage;
+       uint32_t SizeOfHeaders;
+       uint32_t CheckSum;                       /* 0x40 */
+       uint16_t  Subsystem;
+       uint16_t  DllCharacteristics;
+       uint32_t SizeOfStackReserve;
+       uint32_t SizeOfStackCommit;
+       uint32_t SizeOfHeapReserve;              /* 0x50 */
+       uint32_t SizeOfHeapCommit;
+       uint32_t LoaderFlags;
+       uint32_t NumberOfRvaAndSizes;
+       IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES]; /* 0x60 */
+       /* 0xE0 */
+} IMAGE_OPTIONAL_HEADER32, *PIMAGE_OPTIONAL_HEADER32;
+
+typedef struct _IMAGE_NT_HEADERS {
+       uint32_t Signature; /* "PE"\0\0 */       /* 0x00 */
+       IMAGE_FILE_HEADER FileHeader;         /* 0x04 */
+       IMAGE_OPTIONAL_HEADER32 OptionalHeader;       /* 0x18 */
+} IMAGE_NT_HEADERS32, *PIMAGE_NT_HEADERS32;
+
+#define IMAGE_SIZEOF_SHORT_NAME 8
+
+typedef struct _IMAGE_SECTION_HEADER {
+       uint8_t Name[IMAGE_SIZEOF_SHORT_NAME];
+       union {
+               uint32_t PhysicalAddress;
+               uint32_t VirtualSize;
+       } Misc;
+       uint32_t VirtualAddress;
+       uint32_t SizeOfRawData;
+       uint32_t PointerToRawData;
+       uint32_t PointerToRelocations;
+       uint32_t PointerToLinenumbers;
+       uint16_t        NumberOfRelocations;
+       uint16_t        NumberOfLinenumbers;
+       uint32_t Characteristics;
+} IMAGE_SECTION_HEADER, *PIMAGE_SECTION_HEADER;
+
+#define IMAGE_DIRECTORY_ENTRY_BASERELOC         5
+
+typedef struct _IMAGE_BASE_RELOCATION
+{
+        uint32_t VirtualAddress;
+        uint32_t SizeOfBlock;
+        /* WORD TypeOffset[1]; */
+} IMAGE_BASE_RELOCATION,*PIMAGE_BASE_RELOCATION;
+
+typedef struct _IMAGE_RELOCATION
+{
+       union {
+               uint32_t   VirtualAddress;
+               uint32_t   RelocCount;
+       } DUMMYUNIONNAME;
+       uint32_t   SymbolTableIndex;
+       uint16_t        Type;
+} IMAGE_RELOCATION, *PIMAGE_RELOCATION;
+
+#define IMAGE_SIZEOF_RELOCATION 10
+
+/* generic relocation types */
+#define IMAGE_REL_BASED_ABSOLUTE                0
+#define IMAGE_REL_BASED_HIGH                    1
+#define IMAGE_REL_BASED_LOW                     2
+#define IMAGE_REL_BASED_HIGHLOW                 3
+#define IMAGE_REL_BASED_HIGHADJ                 4
+#define IMAGE_REL_BASED_MIPS_JMPADDR            5
+#define IMAGE_REL_BASED_ARM_MOV32A              5 /* yes, 5 too */
+#define IMAGE_REL_BASED_ARM_MOV32               5 /* yes, 5 too */
+#define IMAGE_REL_BASED_SECTION                 6
+#define IMAGE_REL_BASED_REL                     7
+#define IMAGE_REL_BASED_ARM_MOV32T              7 /* yes, 7 too */
+#define IMAGE_REL_BASED_THUMB_MOV32             7 /* yes, 7 too */
+#define IMAGE_REL_BASED_MIPS_JMPADDR16          9
+#define IMAGE_REL_BASED_IA64_IMM64              9 /* yes, 9 too */
+#define IMAGE_REL_BASED_DIR64                   10
+#define IMAGE_REL_BASED_HIGH3ADJ                11
+
+/* ARM relocation types */
+#define IMAGE_REL_ARM_ABSOLUTE          0x0000
+#define IMAGE_REL_ARM_ADDR              0x0001
+#define IMAGE_REL_ARM_ADDR32NB          0x0002
+#define IMAGE_REL_ARM_BRANCH24          0x0003
+#define IMAGE_REL_ARM_BRANCH11          0x0004
+#define IMAGE_REL_ARM_TOKEN             0x0005
+#define IMAGE_REL_ARM_GPREL12           0x0006
+#define IMAGE_REL_ARM_GPREL7            0x0007
+#define IMAGE_REL_ARM_BLX24             0x0008
+#define IMAGE_REL_ARM_BLX11             0x0009
+#define IMAGE_REL_ARM_SECTION           0x000E
+#define IMAGE_REL_ARM_SECREL            0x000F
+#define IMAGE_REL_ARM_MOV32A            0x0010
+#define IMAGE_REL_ARM_MOV32T            0x0011
+#define IMAGE_REL_ARM_BRANCH20T 0x0012
+#define IMAGE_REL_ARM_BRANCH24T 0x0014
+#define IMAGE_REL_ARM_BLX23T            0x0015
+
+/* ARM64 relocation types */
+#define IMAGE_REL_ARM64_ABSOLUTE        0x0000
+#define IMAGE_REL_ARM64_ADDR32          0x0001
+#define IMAGE_REL_ARM64_ADDR32NB        0x0002
+#define IMAGE_REL_ARM64_BRANCH26        0x0003
+#define IMAGE_REL_ARM64_PAGEBASE_REL21  0x0004
+#define IMAGE_REL_ARM64_REL21           0x0005
+#define IMAGE_REL_ARM64_PAGEOFFSET_12A  0x0006
+#define IMAGE_REL_ARM64_PAGEOFFSET_12L  0x0007
+#define IMAGE_REL_ARM64_SECREL          0x0008
+#define IMAGE_REL_ARM64_SECREL_LOW12A   0x0009
+#define IMAGE_REL_ARM64_SECREL_HIGH12A  0x000A
+#define IMAGE_REL_ARM64_SECREL_LOW12L   0x000B
+#define IMAGE_REL_ARM64_TOKEN           0x000C
+#define IMAGE_REL_ARM64_SECTION         0x000D
+#define IMAGE_REL_ARM64_ADDR64          0x000E
+
+/* AMD64 relocation types */
+#define IMAGE_REL_AMD64_ABSOLUTE        0x0000
+#define IMAGE_REL_AMD64_ADDR64          0x0001
+#define IMAGE_REL_AMD64_ADDR32          0x0002
+#define IMAGE_REL_AMD64_ADDR32NB        0x0003
+#define IMAGE_REL_AMD64_REL32           0x0004
+#define IMAGE_REL_AMD64_REL32_1         0x0005
+#define IMAGE_REL_AMD64_REL32_2         0x0006
+#define IMAGE_REL_AMD64_REL32_3         0x0007
+#define IMAGE_REL_AMD64_REL32_4         0x0008
+#define IMAGE_REL_AMD64_REL32_5         0x0009
+#define IMAGE_REL_AMD64_SECTION         0x000A
+#define IMAGE_REL_AMD64_SECREL          0x000B
+#define IMAGE_REL_AMD64_SECREL7         0x000C
+#define IMAGE_REL_AMD64_TOKEN           0x000D
+#define IMAGE_REL_AMD64_SREL32          0x000E
+#define IMAGE_REL_AMD64_PAIR            0x000F
+#define IMAGE_REL_AMD64_SSPAN32         0x0010
+
+#endif /* _PE_H */

lib/efi_loader/efi_image_loader.c new file +3 -0

new file mode 100644
index 0000000..a7788bf
@@ -0,0 +1,178 @@
+/*
+ *  EFI image loader
+ *

lib/efi_loader/efi_image_loader.c new file +32 -0

+#define MB (1024 * 1024)
+
+const efi_guid_t efi_guid_device_path = DEVICE_PATH_GUID;
+const efi_guid_t efi_guid_loaded_image = LOADED_IMAGE_GUID;
+
+efi_status_t efi_return_handle(void *handle, efi_guid_t *protocol,
+                       void **protocol_interface, void *agent_handle,
+                       void *controller_handle, uint32_t attributes)
+{
+       *protocol_interface = handle;
+       return EFI_SUCCESS;
+}
+
+/* Will be implemented in a later patch */
+void *efi_loader_alloc(uint64_t len)
+{
+       return NULL;
+}
+
+/*
+ * This function loads all sections from a PE binary into a newly reserved
+ * piece of memory. On successful load it then returns the entry point for
+ * the binary. Otherwise NULL.
+ */
+void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info)
+{
+       IMAGE_NT_HEADERS32 *nt;
+       IMAGE_DOS_HEADER *dos;
+       IMAGE_SECTION_HEADER *sections;
+       int num_sections;
+       void *efi_reloc;
+       int i;

lib/efi_loader/efi_image_loader.c new file +101 -0

+
+#if defined(CONFIG_ARM64)
+       can_run_nt32 = false;
+#elif defined(CONFIG_ARM)
+       can_run_nt64 = false;
+#endif
+
+       dos = efi;
+       if (dos->e_magic != IMAGE_DOS_SIGNATURE) {
+               printf("%s: Invalid DOS Signature\n", __func__);
+               return NULL;
+       }
+
+       nt = (void *) ((char *)efi + dos->e_lfanew);
+       if (nt->Signature != IMAGE_NT_SIGNATURE) {
+               printf("%s: Invalid NT Signature\n", __func__);
+               return NULL;
+       }
+
+       /* Calculate upper virtual address boundary */
+       num_sections = nt->FileHeader.NumberOfSections;
+       sections = (void *)&nt->OptionalHeader +
+                           nt->FileHeader.SizeOfOptionalHeader;
+
+       for (i = num_sections - 1; i >= 0; i--) {
+               IMAGE_SECTION_HEADER *sec = &sections[i];
+               virt_size = max_t(unsigned long, virt_size,
+                                 sec->VirtualAddress + sec->Misc.VirtualSize);
+       }
+
+       /* Read 32/64bit specific header bits */
+       if (can_run_nt64 &&
+           (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC)) {
+               IMAGE_NT_HEADERS64 *nt64 = (void *)nt;
+               IMAGE_OPTIONAL_HEADER64 *opt = &nt64->OptionalHeader;
+               image_size = opt->SizeOfImage;
+               efi_reloc = efi_loader_alloc(virt_size);
+               if (!efi_reloc) {
+                       printf("%s: Could not allocate %ld bytes\n",
+                               __func__, virt_size);
+                       return NULL;
+               }
+               entry = efi_reloc + opt->AddressOfEntryPoint;
+               rel_size = opt->DataDirectory[rel_idx].Size;
+               rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
+       } else if (can_run_nt32 &&
+                  (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)) {
+               IMAGE_OPTIONAL_HEADER32 *opt = &nt->OptionalHeader;
+               image_size = opt->SizeOfImage;
+               efi_reloc = efi_loader_alloc(virt_size);
+               if (!efi_reloc) {
+                       printf("%s: Could not allocate %ld bytes\n",
+                               __func__, virt_size);
+                       return NULL;
+               }
+               entry = efi_reloc + opt->AddressOfEntryPoint;
+               rel_size = opt->DataDirectory[rel_idx].Size;
+               rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
+       } else {
+               printf("%s: Invalid optional header magic %x\n", __func__,
+                      nt->OptionalHeader.Magic);
+               return NULL;
+       }
+
+       /* Load sections into RAM */
+       for (i = num_sections - 1; i >= 0; i--) {
+               IMAGE_SECTION_HEADER *sec = &sections[i];
+               memset(efi_reloc + sec->VirtualAddress, 0,
+                      sec->Misc.VirtualSize);
+               memcpy(efi_reloc + sec->VirtualAddress,
+                      efi + sec->PointerToRawData,
+                      sec->SizeOfRawData);
+       }
+
+       /* Run through relocations */
+       end = (const IMAGE_BASE_RELOCATION *)((const char *)rel + rel_size);
+
+       while (rel < end - 1 && rel->SizeOfBlock) {
+               relocs = (const uint16_t *)(rel + 1);
+               i = (rel->SizeOfBlock - sizeof(*rel)) / sizeof(uint16_t);
+               while (i--) {
+                       uint16_t offset = (*relocs & 0xfff) + rel->VirtualAddress;
+                       int type = *relocs >> 12;
+                       unsigned long delta = (unsigned long)efi_reloc;
+                       uint64_t *x64 = efi_reloc + offset;
+                       uint32_t *x32 = efi_reloc + offset;
+                       uint16_t *x16 = efi_reloc + offset;
+
+                       switch (type) {
+                       case IMAGE_REL_BASED_ABSOLUTE:
+                               break;
+                       case IMAGE_REL_BASED_HIGH:
+                               *x16 += ((uint32_t)delta) >> 16;
+                               break;
+                       case IMAGE_REL_BASED_LOW:
+                               *x16 += (uint16_t)delta;
+                               break;
+                       case IMAGE_REL_BASED_HIGHLOW:
+                               *x32 += (uint32_t)delta;
+                               break;
+                       case IMAGE_REL_BASED_DIR64:

lib/efi_loader/efi_image_loader.c new file +7 -1

+
+       /* Populate the loaded image interface bits */
+       loaded_image_info->image_base = efi;
+       loaded_image_info->image_size = image_size;
+
+       return entry;
+}
--

2.1.4

_______________________________________________
U-Boot mailing list
U-Boot at lists.denx.de
http://lists.denx.de/mailman/listinfo/u-boot

Hi Alexander,

Quoted 329 lines · Alexander Graf

EFI uses the PE binary format for its application images. Add support to EFI PE binaries as well as all necessary bits for the "EFI image loader" interfaces.

Signed-off-by Alexander Graf <[email protected]>

---

v1 -> v2:

- move memory allocation to separate patch
- limit 32/64 to hosts that support it
- check 32bit optional nt header magic
- switch to GPL2+

---
  include/efi_loader.h              |  23 ++++
  include/pe.h                      | 263 ++++++++++++++++++++++++++++++++++++++
  lib/efi_loader/efi_image_loader.c | 178 ++++++++++++++++++++++++++
  3 files changed, 464 insertions(+)

create mode 100644 include/efi_loader.h create mode 100644 include/pe.h
create mode 100644 lib/efi_loader/efi_image_loader.c

include/efi_loader.h new file +23 -0

new file mode 100644
index 0000000..bf77573
@@ -0,0 +1,23 @@
+/*
+ *  EFI application loader
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+#include <part_efi.h>
+#include <efi_api.h>
+#include <linux/list.h>
+
+extern const efi_guid_t efi_guid_device_path;
+extern const efi_guid_t efi_guid_loaded_image;
+
+efi_status_t efi_return_handle(void *handle,
+               efi_guid_t *protocol, void **protocol_interface,
+               void *agent_handle, void *controller_handle,
+               uint32_t attributes);
+void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
+
+#define EFI_LOADER_POOL_SIZE (128 * 1024 * 1024)
+void *efi_loader_alloc(uint64_t len);

include/pe.h new file +263 -0

new file mode 100644
index 0000000..6379ae1
@@ -0,0 +1,263 @@
+/*
+ *  Portable Executable binary format structures
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  Based on wine code
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+#ifndef _PE_H
+#define _PE_H
+
+typedef struct _IMAGE_DOS_HEADER {
+       uint16_t e_magic;      /* 00: MZ Header signature */
+       uint16_t e_cblp;       /* 02: Bytes on last page of file */
+       uint16_t e_cp;         /* 04: Pages in file */
+       uint16_t e_crlc;       /* 06: Relocations */
+       uint16_t e_cparhdr;    /* 08: Size of header in paragraphs */
+       uint16_t e_minalloc;   /* 0a: Minimum extra paragraphs needed */
+       uint16_t e_maxalloc;   /* 0c: Maximum extra paragraphs needed */
+       uint16_t e_ss;         /* 0e: Initial (relative) SS value */
+       uint16_t e_sp;         /* 10: Initial SP value */
+       uint16_t e_csum;       /* 12: Checksum */
+       uint16_t e_ip;         /* 14: Initial IP value */
+       uint16_t e_cs;         /* 16: Initial (relative) CS value */
+       uint16_t e_lfarlc;     /* 18: File address of relocation table */
+       uint16_t e_ovno;       /* 1a: Overlay number */
+       uint16_t e_res[4];     /* 1c: Reserved words */
+       uint16_t e_oemid;      /* 24: OEM identifier (for e_oeminfo) */
+       uint16_t e_oeminfo;    /* 26: OEM information; e_oemid specific */
+       uint16_t e_res2[10];   /* 28: Reserved words */
+       uint32_t e_lfanew;     /* 3c: Offset to extended header */
+} IMAGE_DOS_HEADER, *PIMAGE_DOS_HEADER;
+
+#define IMAGE_DOS_SIGNATURE            0x5A4D     /* MZ   */
+#define IMAGE_NT_SIGNATURE             0x00004550 /* PE00 */
+
+#define IMAGE_FILE_MACHINE_ARM         0x01c0
+#define IMAGE_FILE_MACHINE_THUMB       0x01c2
+#define IMAGE_FILE_MACHINE_ARMNT       0x01c4
+#define IMAGE_FILE_MACHINE_AMD64       0x8664
+#define IMAGE_FILE_MACHINE_ARM64       0xaa64
+#define IMAGE_NT_OPTIONAL_HDR32_MAGIC  0x10b
+#define IMAGE_NT_OPTIONAL_HDR64_MAGIC  0x20b
+#define IMAGE_SUBSYSTEM_EFI_APPLICATION        10
+
+typedef struct _IMAGE_FILE_HEADER {
+       uint16_t  Machine;
+       uint16_t  NumberOfSections;
+       uint32_t TimeDateStamp;
+       uint32_t PointerToSymbolTable;
+       uint32_t NumberOfSymbols;
+       uint16_t  SizeOfOptionalHeader;
+       uint16_t  Characteristics;
+} IMAGE_FILE_HEADER, *PIMAGE_FILE_HEADER;
+
+typedef struct _IMAGE_DATA_DIRECTORY {
+       uint32_t VirtualAddress;
+       uint32_t Size;
+} IMAGE_DATA_DIRECTORY, *PIMAGE_DATA_DIRECTORY;
+
+#define IMAGE_NUMBEROF_DIRECTORY_ENTRIES 16
+
+typedef struct _IMAGE_OPTIONAL_HEADER64 {
+       uint16_t  Magic; /* 0x20b */
+       uint8_t MajorLinkerVersion;
+       uint8_t MinorLinkerVersion;
+       uint32_t SizeOfCode;
+       uint32_t SizeOfInitializedData;
+       uint32_t SizeOfUninitializedData;
+       uint32_t AddressOfEntryPoint;
+       uint32_t BaseOfCode;
+       uint64_t ImageBase;
+       uint32_t SectionAlignment;
+       uint32_t FileAlignment;
+       uint16_t MajorOperatingSystemVersion;
+       uint16_t MinorOperatingSystemVersion;
+       uint16_t MajorImageVersion;
+       uint16_t MinorImageVersion;
+       uint16_t MajorSubsystemVersion;
+       uint16_t MinorSubsystemVersion;
+       uint32_t Win32VersionValue;
+       uint32_t SizeOfImage;
+       uint32_t SizeOfHeaders;
+       uint32_t CheckSum;
+       uint16_t Subsystem;
+       uint16_t DllCharacteristics;
+       uint64_t SizeOfStackReserve;
+       uint64_t SizeOfStackCommit;
+       uint64_t SizeOfHeapReserve;
+       uint64_t SizeOfHeapCommit;
+       uint32_t LoaderFlags;
+       uint32_t NumberOfRvaAndSizes;
+       IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
+} IMAGE_OPTIONAL_HEADER64, *PIMAGE_OPTIONAL_HEADER64;
+
+typedef struct _IMAGE_NT_HEADERS64 {
+       uint32_t Signature;
+       IMAGE_FILE_HEADER FileHeader;
+       IMAGE_OPTIONAL_HEADER64 OptionalHeader;
+} IMAGE_NT_HEADERS64, *PIMAGE_NT_HEADERS64;
+
+typedef struct _IMAGE_OPTIONAL_HEADER {
+
+       /* Standard fields */
+
+       uint16_t  Magic; /* 0x10b or 0x107 */     /* 0x00 */
+       uint8_t  MajorLinkerVersion;
+       uint8_t  MinorLinkerVersion;
+       uint32_t SizeOfCode;
+       uint32_t SizeOfInitializedData;
+       uint32_t SizeOfUninitializedData;
+       uint32_t AddressOfEntryPoint;            /* 0x10 */
+       uint32_t BaseOfCode;
+       uint32_t BaseOfData;
+
+       /* NT additional fields */
+
+       uint32_t ImageBase;
+       uint32_t SectionAlignment;               /* 0x20 */
+       uint32_t FileAlignment;
+       uint16_t  MajorOperatingSystemVersion;
+       uint16_t  MinorOperatingSystemVersion;
+       uint16_t  MajorImageVersion;
+       uint16_t  MinorImageVersion;
+       uint16_t  MajorSubsystemVersion;          /* 0x30 */
+       uint16_t  MinorSubsystemVersion;
+       uint32_t Win32VersionValue;
+       uint32_t SizeOfImage;
+       uint32_t SizeOfHeaders;
+       uint32_t CheckSum;                       /* 0x40 */
+       uint16_t  Subsystem;
+       uint16_t  DllCharacteristics;
+       uint32_t SizeOfStackReserve;
+       uint32_t SizeOfStackCommit;
+       uint32_t SizeOfHeapReserve;              /* 0x50 */
+       uint32_t SizeOfHeapCommit;
+       uint32_t LoaderFlags;
+       uint32_t NumberOfRvaAndSizes;
+       IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES]; /* 0x60 */
+       /* 0xE0 */
+} IMAGE_OPTIONAL_HEADER32, *PIMAGE_OPTIONAL_HEADER32;
+
+typedef struct _IMAGE_NT_HEADERS {
+       uint32_t Signature; /* "PE"\0\0 */       /* 0x00 */
+       IMAGE_FILE_HEADER FileHeader;         /* 0x04 */
+       IMAGE_OPTIONAL_HEADER32 OptionalHeader;       /* 0x18 */
+} IMAGE_NT_HEADERS32, *PIMAGE_NT_HEADERS32;
+
+#define IMAGE_SIZEOF_SHORT_NAME 8
+
+typedef struct _IMAGE_SECTION_HEADER {
+       uint8_t Name[IMAGE_SIZEOF_SHORT_NAME];
+       union {
+               uint32_t PhysicalAddress;
+               uint32_t VirtualSize;
+       } Misc;
+       uint32_t VirtualAddress;
+       uint32_t SizeOfRawData;
+       uint32_t PointerToRawData;
+       uint32_t PointerToRelocations;
+       uint32_t PointerToLinenumbers;
+       uint16_t        NumberOfRelocations;
+       uint16_t        NumberOfLinenumbers;
+       uint32_t Characteristics;
+} IMAGE_SECTION_HEADER, *PIMAGE_SECTION_HEADER;
+
+#define IMAGE_DIRECTORY_ENTRY_BASERELOC         5
+
+typedef struct _IMAGE_BASE_RELOCATION
+{
+        uint32_t VirtualAddress;
+        uint32_t SizeOfBlock;
+        /* WORD TypeOffset[1]; */
+} IMAGE_BASE_RELOCATION,*PIMAGE_BASE_RELOCATION;
+
+typedef struct _IMAGE_RELOCATION
+{
+       union {
+               uint32_t   VirtualAddress;
+               uint32_t   RelocCount;
+       } DUMMYUNIONNAME;
+       uint32_t   SymbolTableIndex;
+       uint16_t        Type;
+} IMAGE_RELOCATION, *PIMAGE_RELOCATION;
+
+#define IMAGE_SIZEOF_RELOCATION 10
+
+/* generic relocation types */
+#define IMAGE_REL_BASED_ABSOLUTE                0
+#define IMAGE_REL_BASED_HIGH                    1
+#define IMAGE_REL_BASED_LOW                     2
+#define IMAGE_REL_BASED_HIGHLOW                 3
+#define IMAGE_REL_BASED_HIGHADJ                 4
+#define IMAGE_REL_BASED_MIPS_JMPADDR            5
+#define IMAGE_REL_BASED_ARM_MOV32A              5 /* yes, 5 too */
+#define IMAGE_REL_BASED_ARM_MOV32               5 /* yes, 5 too */
+#define IMAGE_REL_BASED_SECTION                 6
+#define IMAGE_REL_BASED_REL                     7
+#define IMAGE_REL_BASED_ARM_MOV32T              7 /* yes, 7 too */
+#define IMAGE_REL_BASED_THUMB_MOV32             7 /* yes, 7 too */
+#define IMAGE_REL_BASED_MIPS_JMPADDR16          9
+#define IMAGE_REL_BASED_IA64_IMM64              9 /* yes, 9 too */
+#define IMAGE_REL_BASED_DIR64                   10
+#define IMAGE_REL_BASED_HIGH3ADJ                11
+
+/* ARM relocation types */
+#define IMAGE_REL_ARM_ABSOLUTE          0x0000
+#define IMAGE_REL_ARM_ADDR              0x0001
+#define IMAGE_REL_ARM_ADDR32NB          0x0002
+#define IMAGE_REL_ARM_BRANCH24          0x0003
+#define IMAGE_REL_ARM_BRANCH11          0x0004
+#define IMAGE_REL_ARM_TOKEN             0x0005
+#define IMAGE_REL_ARM_GPREL12           0x0006
+#define IMAGE_REL_ARM_GPREL7            0x0007
+#define IMAGE_REL_ARM_BLX24             0x0008
+#define IMAGE_REL_ARM_BLX11             0x0009
+#define IMAGE_REL_ARM_SECTION           0x000E
+#define IMAGE_REL_ARM_SECREL            0x000F
+#define IMAGE_REL_ARM_MOV32A            0x0010
+#define IMAGE_REL_ARM_MOV32T            0x0011
+#define IMAGE_REL_ARM_BRANCH20T 0x0012
+#define IMAGE_REL_ARM_BRANCH24T 0x0014
+#define IMAGE_REL_ARM_BLX23T            0x0015
+
+/* ARM64 relocation types */
+#define IMAGE_REL_ARM64_ABSOLUTE        0x0000
+#define IMAGE_REL_ARM64_ADDR32          0x0001
+#define IMAGE_REL_ARM64_ADDR32NB        0x0002
+#define IMAGE_REL_ARM64_BRANCH26        0x0003
+#define IMAGE_REL_ARM64_PAGEBASE_REL21  0x0004
+#define IMAGE_REL_ARM64_REL21           0x0005
+#define IMAGE_REL_ARM64_PAGEOFFSET_12A  0x0006
+#define IMAGE_REL_ARM64_PAGEOFFSET_12L  0x0007
+#define IMAGE_REL_ARM64_SECREL          0x0008
+#define IMAGE_REL_ARM64_SECREL_LOW12A   0x0009
+#define IMAGE_REL_ARM64_SECREL_HIGH12A  0x000A
+#define IMAGE_REL_ARM64_SECREL_LOW12L   0x000B
+#define IMAGE_REL_ARM64_TOKEN           0x000C
+#define IMAGE_REL_ARM64_SECTION         0x000D
+#define IMAGE_REL_ARM64_ADDR64          0x000E
+
+/* AMD64 relocation types */
+#define IMAGE_REL_AMD64_ABSOLUTE        0x0000
+#define IMAGE_REL_AMD64_ADDR64          0x0001
+#define IMAGE_REL_AMD64_ADDR32          0x0002
+#define IMAGE_REL_AMD64_ADDR32NB        0x0003
+#define IMAGE_REL_AMD64_REL32           0x0004
+#define IMAGE_REL_AMD64_REL32_1         0x0005
+#define IMAGE_REL_AMD64_REL32_2         0x0006
+#define IMAGE_REL_AMD64_REL32_3         0x0007
+#define IMAGE_REL_AMD64_REL32_4         0x0008
+#define IMAGE_REL_AMD64_REL32_5         0x0009
+#define IMAGE_REL_AMD64_SECTION         0x000A
+#define IMAGE_REL_AMD64_SECREL          0x000B
+#define IMAGE_REL_AMD64_SECREL7         0x000C
+#define IMAGE_REL_AMD64_TOKEN           0x000D
+#define IMAGE_REL_AMD64_SREL32          0x000E
+#define IMAGE_REL_AMD64_PAIR            0x000F
+#define IMAGE_REL_AMD64_SSPAN32         0x0010
+
+#endif /* _PE_H */

lib/efi_loader/efi_image_loader.c new file +3 -0

new file mode 100644
index 0000000..a7788bf
@@ -0,0 +1,178 @@
+/*
+ *  EFI image loader
+ *

lib/efi_loader/efi_image_loader.c line 13

Quoted 10 lines

lib/efi_loader/efi_image_loader.c new file +10 -0

+ *  based partly on wine code
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+#include <common.h>
+#include <pe.h>
+#include <efi_loader.h>

This should go above pe.h to keep alpha ordering.

lib/efi_loader/efi_image_loader.c line 18

Quoted 5 lines

lib/efi_loader/efi_image_loader.c new file +5 -0

+#include <asm/global_data.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#define ROUND_UP(val, round) ((val + (round - 1)) & ~(round - 1))

Can you use round_up()?

Quoted 36 lines

lib/efi_loader/efi_image_loader.c new file +35 -0

+#define MB (1024 * 1024)
+
+const efi_guid_t efi_guid_device_path = DEVICE_PATH_GUID;
+const efi_guid_t efi_guid_loaded_image = LOADED_IMAGE_GUID;
+
+efi_status_t efi_return_handle(void *handle, efi_guid_t *protocol,
+                       void **protocol_interface, void *agent_handle,
+                       void *controller_handle, uint32_t attributes)
+{
+       *protocol_interface = handle;
+       return EFI_SUCCESS;
+}
+
+/* Will be implemented in a later patch */
+void *efi_loader_alloc(uint64_t len)
+{
+       return NULL;
+}
+
+/*
+ * This function loads all sections from a PE binary into a newly reserved
+ * piece of memory. On successful load it then returns the entry point for
+ * the binary. Otherwise NULL.
+ */
+void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info)
+{
+       IMAGE_NT_HEADERS32 *nt;
+       IMAGE_DOS_HEADER *dos;
+       IMAGE_SECTION_HEADER *sections;
+       int num_sections;
+       void *efi_reloc;
+       int i;
+       const uint16_t *relocs;
+       const IMAGE_BASE_RELOCATION *rel;
+       const IMAGE_BASE_RELOCATION *end;

lib/efi_loader/efi_image_loader.c line 60

Quoted 7 lines

lib/efi_loader/efi_image_loader.c new file +7 -0

+       unsigned long rel_size;
+       int rel_idx = IMAGE_DIRECTORY_ENTRY_BASERELOC;
+       void *entry;
+       uint64_t image_size;
+       unsigned long virt_size = 0;
+       bool can_run_nt64 = true;
+       bool can_run_nt32 = true;

What does nt stand for?

Quoted 106 lines

lib/efi_loader/efi_image_loader.c new file +105 -0

+
+#if defined(CONFIG_ARM64)
+       can_run_nt32 = false;
+#elif defined(CONFIG_ARM)
+       can_run_nt64 = false;
+#endif
+
+       dos = efi;
+       if (dos->e_magic != IMAGE_DOS_SIGNATURE) {
+               printf("%s: Invalid DOS Signature\n", __func__);
+               return NULL;
+       }
+
+       nt = (void *) ((char *)efi + dos->e_lfanew);
+       if (nt->Signature != IMAGE_NT_SIGNATURE) {
+               printf("%s: Invalid NT Signature\n", __func__);
+               return NULL;
+       }
+
+       /* Calculate upper virtual address boundary */
+       num_sections = nt->FileHeader.NumberOfSections;
+       sections = (void *)&nt->OptionalHeader +
+                           nt->FileHeader.SizeOfOptionalHeader;
+
+       for (i = num_sections - 1; i >= 0; i--) {
+               IMAGE_SECTION_HEADER *sec = &sections[i];
+               virt_size = max_t(unsigned long, virt_size,
+                                 sec->VirtualAddress + sec->Misc.VirtualSize);
+       }
+
+       /* Read 32/64bit specific header bits */
+       if (can_run_nt64 &&
+           (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC)) {
+               IMAGE_NT_HEADERS64 *nt64 = (void *)nt;
+               IMAGE_OPTIONAL_HEADER64 *opt = &nt64->OptionalHeader;
+               image_size = opt->SizeOfImage;
+               efi_reloc = efi_loader_alloc(virt_size);
+               if (!efi_reloc) {
+                       printf("%s: Could not allocate %ld bytes\n",
+                               __func__, virt_size);
+                       return NULL;
+               }
+               entry = efi_reloc + opt->AddressOfEntryPoint;
+               rel_size = opt->DataDirectory[rel_idx].Size;
+               rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
+       } else if (can_run_nt32 &&
+                  (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)) {
+               IMAGE_OPTIONAL_HEADER32 *opt = &nt->OptionalHeader;
+               image_size = opt->SizeOfImage;
+               efi_reloc = efi_loader_alloc(virt_size);
+               if (!efi_reloc) {
+                       printf("%s: Could not allocate %ld bytes\n",
+                               __func__, virt_size);
+                       return NULL;
+               }
+               entry = efi_reloc + opt->AddressOfEntryPoint;
+               rel_size = opt->DataDirectory[rel_idx].Size;
+               rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
+       } else {
+               printf("%s: Invalid optional header magic %x\n", __func__,
+                      nt->OptionalHeader.Magic);
+               return NULL;
+       }
+
+       /* Load sections into RAM */
+       for (i = num_sections - 1; i >= 0; i--) {
+               IMAGE_SECTION_HEADER *sec = &sections[i];
+               memset(efi_reloc + sec->VirtualAddress, 0,
+                      sec->Misc.VirtualSize);
+               memcpy(efi_reloc + sec->VirtualAddress,
+                      efi + sec->PointerToRawData,
+                      sec->SizeOfRawData);
+       }
+
+       /* Run through relocations */
+       end = (const IMAGE_BASE_RELOCATION *)((const char *)rel + rel_size);
+
+       while (rel < end - 1 && rel->SizeOfBlock) {
+               relocs = (const uint16_t *)(rel + 1);
+               i = (rel->SizeOfBlock - sizeof(*rel)) / sizeof(uint16_t);
+               while (i--) {
+                       uint16_t offset = (*relocs & 0xfff) + rel->VirtualAddress;
+                       int type = *relocs >> 12;
+                       unsigned long delta = (unsigned long)efi_reloc;
+                       uint64_t *x64 = efi_reloc + offset;
+                       uint32_t *x32 = efi_reloc + offset;
+                       uint16_t *x16 = efi_reloc + offset;
+
+                       switch (type) {
+                       case IMAGE_REL_BASED_ABSOLUTE:
+                               break;
+                       case IMAGE_REL_BASED_HIGH:
+                               *x16 += ((uint32_t)delta) >> 16;
+                               break;
+                       case IMAGE_REL_BASED_LOW:
+                               *x16 += (uint16_t)delta;
+                               break;
+                       case IMAGE_REL_BASED_HIGHLOW:
+                               *x32 += (uint32_t)delta;
+                               break;
+                       case IMAGE_REL_BASED_DIR64:
+                               *x64 += (uint64_t)delta;
+                               break;
+                       default:
+                               printf("Unknown Relocation off %x type %x\n",

lib/efi_loader/efi_image_loader.c line 171

Quoted 6 lines

lib/efi_loader/efi_image_loader.c new file +6 -0

+                                      offset, type);
+                       }
+                       relocs++;
+               }
+               rel = (const IMAGE_BASE_RELOCATION *)relocs;
+       }

How about putting the relocation code in a separate function, as this one is getting large.

When an EFI application runs, it has access to a few descriptor and callback tables to instruct the EFI compliant firmware to do things for it. The bulk of those interfaces are "boot time services". They handle all object management, and memory allocation.

This patch adds support for the boot time services and also exposes a system table, which is the point of entry descriptor table for EFI payloads.

Signed-off-by Alexander Graf <[email protected]>

---

v1 -> v2:

- Fix typo s/does now/does not/
- Add #ifdefs around header to allow inclusion when efi_loader is disabled
- Add stub efi_restore_gd() function when efi_loader is disabled
- Disable debug
- Mark runtime region as such
- Fix up memory map
- Allow efi_restore_gd to be called before first efi entry
- Add 32bit arm cache workaround
- Move memory map to separate patch
- Change BTS version to 2.5
- Fix return values for a few callbacks to more EFI compliant ones
- Change vendor to "Das U-Boot"
- Add warning when truncating timer trigger
- Move to GPLv2+

---
 include/efi_loader.h          |  51 +++
 lib/efi_loader/efi_boottime.c | 761 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 812 insertions(+)
 create mode 100644 lib/efi_loader/efi_boottime.c

include/efi_loader.h +51 -0

index bf77573..391459e 100644
@@ -6,18 +6,69 @@
  *  SPDX-License-Identifier:     GPL-2.0+
  */
 
+#include <common.h>
 #include <part_efi.h>
 #include <efi_api.h>
+
+#ifdef CONFIG_EFI_LOADER
+
 #include <linux/list.h>
 
+/* #define DEBUG_EFI */
+
+#ifdef DEBUG_EFI
+#define EFI_ENTRY(format, ...) do { \
+	efi_restore_gd(); \
+	printf("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \
+	} while(0)
+#else
+#define EFI_ENTRY(format, ...) do { \
+	efi_restore_gd(); \
+	} while(0)
+#endif
+
+#define EFI_EXIT(ret) efi_exit_func(ret);
+
+extern struct efi_system_table systab;
+
 extern const efi_guid_t efi_guid_device_path;
 extern const efi_guid_t efi_guid_loaded_image;
 
+struct efi_class_map {
+	const efi_guid_t *guid;
+	const void *interface;
+};
+
+struct efi_handler {
+	const efi_guid_t *guid;
+	efi_status_t (EFIAPI *open)(void *handle,
+			efi_guid_t *protocol, void **protocol_interface,
+			void *agent_handle, void *controller_handle,
+			uint32_t attributes);
+};
+
+struct efi_object {
+	struct list_head link;
+	struct efi_handler protocols[4];
+	void *handle;
+};
+extern struct list_head efi_obj_list;
+
 efi_status_t efi_return_handle(void *handle,
 		efi_guid_t *protocol, void **protocol_interface,
 		void *agent_handle, void *controller_handle,
 		uint32_t attributes);
+void efi_timer_check(void);
 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
+void efi_save_gd(void);
+void efi_restore_gd(void);
+efi_status_t efi_exit_func(efi_status_t ret);
 
 #define EFI_LOADER_POOL_SIZE (128 * 1024 * 1024)
 void *efi_loader_alloc(uint64_t len);
+
+#else /* defined(EFI_LOADER) */
+
+static inline void efi_restore_gd(void) { }
+
+#endif

lib/efi_loader/efi_boottime.c new file +119 -0

new file mode 100644
index 0000000..5756c9c
@@ -0,0 +1,761 @@
+/*
+ *  EFI application boot time services
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+/* #define DEBUG_EFI */
+
+#include <common.h>
+#include <efi_loader.h>
+#include <malloc.h>
+#include <asm/global_data.h>
+#include <libfdt_env.h>
+#include <u-boot/crc.h>
+#include <bootm.h>
+#include <inttypes.h>
+#include <watchdog.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+/*
+ * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
+ * we need to do trickery with caches. Since we don't want to break the EFI
+ * aware boot path, only apply hacks when loading exiting directly (breaking
+ * direct Linux EFI booting along the way - oh well).
+ */
+static bool efi_is_direct_boot = true;
+
+/*
+ * EFI can pass arbitrary additional "tables" containing vendor specific
+ * information to the payload. One such table is the FDT table which contains
+ * a pointer to a flattened device tree blob.
+ *
+ * In most cases we want to pass an FDT to the payload, so reserve one slot of
+ * config table space for it. The pointer gets populated by do_bootefi_exec().
+ */
+static struct efi_configuration_table efi_conf_table[] = {
+	{
+		.guid = EFI_FDT_GUID,
+	},
+};
+
+/*
+ * The "gd" pointer lives in a register on ARM and AArch64 that we declare
+ * fixed when compiling U-Boot. However, the payload does not know about that
+ * restriction so we need to manually swap its and our view of that register on
+ * EFI callback entry/exit.
+ */
+static volatile void *efi_gd, *app_gd;
+
+/* Called from do_bootefi_exec() */
+void efi_save_gd(void)
+{
+	efi_gd = gd;
+}
+
+/* Called on every callback entry */
+void efi_restore_gd(void)
+{
+	/* Only restore if we're already in EFI context */
+	if (!efi_gd)
+		return;
+
+	if (gd != efi_gd)
+		app_gd = gd;
+	gd = efi_gd;
+}
+
+/* Called on every callback exit */
+efi_status_t efi_exit_func(efi_status_t ret)
+{
+	gd = app_gd;
+	return ret;
+}
+
+static efi_status_t efi_unsupported(const char *funcname)
+{
+#ifdef DEBUG_EFI
+	printf("EFI: App called into unimplemented function %s\n", funcname);
+#endif
+	return EFI_EXIT(EFI_UNSUPPORTED);
+}
+
+static unsigned long efi_raise_tpl(unsigned long new_tpl)
+{
+	EFI_ENTRY("0x%lx", new_tpl);
+	return EFI_EXIT(0);
+}
+
+static void efi_restore_tpl(unsigned long old_tpl)
+{
+	EFI_ENTRY("0x%lx", old_tpl);
+	EFI_EXIT(efi_unsupported(__func__));
+}
+
+static void *efi_alloc(uint64_t len, int memory_type)
+{
+	switch (memory_type) {
+	default:
+		return malloc(len);
+	}
+}
+
+static efi_status_t efi_allocate_pages(int type, int memory_type,
+				       unsigned long pages, uint64_t *memory)
+{
+	u64 len = pages << 12;
+	efi_status_t r = EFI_SUCCESS;
+
+	EFI_ENTRY("%d, %d, 0x%lx, %p", type, memory_type, pages, memory);
+
+	switch (type) {
+	case 0:
+		/* Any page means we can go to efi_alloc */
+		*memory = (unsigned long)efi_alloc(len, memory_type);
+		break;
+	case 1:

lib/efi_loader/efi_boottime.c new file +16 -0

+	default:
+		/* UEFI doesn't specify other allocation types */
+		r = EFI_INVALID_PARAMETER;
+		break;
+	}
+
+	return EFI_EXIT(r);
+}
+
+static efi_status_t efi_free_pages(uint64_t memory, unsigned long pages)
+{
+	/* We don't free, let's cross our fingers we have plenty RAM */
+	EFI_ENTRY("%"PRIx64", 0x%lx", memory, pages);
+	return EFI_EXIT(EFI_SUCCESS);
+}
+

lib/efi_loader/efi_boottime.c new file +82 -0

+}
+
+static efi_status_t efi_allocate_pool(int pool_type, unsigned long size, void **buffer)
+{
+	return efi_allocate_pages(0, pool_type, (size + 0xfff) >> 12, (void*)buffer);
+}
+
+static efi_status_t efi_free_pool(void *buffer)
+{
+	return efi_free_pages((ulong)buffer, 0);
+}
+
+/*
+ * Our event capabilities are very limited. Only support a single
+ * event to exist, so we don't need to maintain lists.
+ */
+static struct {
+	enum efi_event_type type;
+	u32 trigger_type;
+	u32 trigger_time;
+	u64 trigger_next;
+	unsigned long notify_tpl;
+	void (*notify_function) (void *event, void *context);
+	void *notify_context;
+} efi_event;
+
+static efi_status_t efi_create_event(enum efi_event_type type, ulong notify_tpl,
+			     void (*notify_function) (void *event,
+						      void *context),
+			     void *notify_context, void **event)
+{
+	EFI_ENTRY("%d, 0x%lx, %p, %p", type, notify_tpl, notify_function,
+		  notify_context);
+	if (efi_event.notify_function) {
+		/* We only support one event at a time */
+		return EFI_EXIT(EFI_OUT_OF_RESOURCES);
+	}
+
+	efi_event.type = type;
+	efi_event.notify_tpl = notify_tpl;
+	efi_event.notify_function = notify_function;
+	efi_event.notify_context = notify_context;
+	*event = &efi_event;
+
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+/*
+ * Our timers have to work without interrupts, so we check whenever keyboard
+ * input or disk accesses happen if enough time elapsed for it to fire.
+ */
+void efi_timer_check(void)
+{
+	u64 now = timer_get_us();
+
+	if (now >= efi_event.trigger_next) {
+		/* Triggering! */
+		if (efi_event.trigger_type == EFI_TIMER_PERIODIC)
+			efi_event.trigger_next += efi_event.trigger_time / 10;
+		efi_event.notify_function(&efi_event, efi_event.notify_context);
+	}
+
+	WATCHDOG_RESET();
+}
+
+static efi_status_t efi_set_timer(void *event, int type, uint64_t trigger_time)
+{
+	/* We don't have 64bit division available everywhere, so limit timer
+	 * distances to 32bit bits. */
+	u32 trigger32 = trigger_time;
+
+	if (trigger32 < trigger_time) {
+		printf("WARNING: Truncating timer from %"PRIx64" to %x\n",
+		       trigger_time, trigger32);
+	}
+
+	EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
+	if (event != &efi_event) {
+		/* We only support one event at a time */
+		return EFI_EXIT(EFI_INVALID_PARAMETER);
+	}
+

lib/efi_loader/efi_boottime.c new file +58 -0

+}
+
+static int efi_search(enum efi_locate_search_type search_type,
+			efi_guid_t *protocol, void *search_key,
+			struct efi_object *efiobj)
+{
+	int i;
+
+	switch (search_type) {
+	case all_handles:
+		return 0;
+	case by_register_notify:
+		return -1;
+	case by_protocol:
+		for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
+			const efi_guid_t *guid = efiobj->protocols[i].guid;
+			if (guid && !memcmp(guid, protocol, sizeof(efi_guid_t)))
+				return 0;
+		}
+		return -1;
+	}
+
+	return -1;
+}
+
+static efi_status_t efi_locate_handle(enum efi_locate_search_type search_type,
+			efi_guid_t *protocol, void *search_key,
+			unsigned long *buffer_size, efi_handle_t *buffer)
+{
+	struct list_head *lhandle;
+	unsigned long size = 0;
+
+	EFI_ENTRY("%d, %p, %p, %p, %p", search_type, protocol, search_key,
+		  buffer_size, buffer);
+
+	/* Count how much space we need */
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+		if (!efi_search(search_type, protocol, search_key, efiobj)) {
+			size += sizeof(void*);
+		}
+	}
+
+	if (*buffer_size < size) {
+		*buffer_size = size;
+		return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
+	}
+
+	/* Then fill the array */
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+		if (!efi_search(search_type, protocol, search_key, efiobj)) {
+			*(buffer++) = efiobj->handle;
+		}
+	}
+

lib/efi_loader/efi_boottime.c new file +23 -0

+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_load_image(bool boot_policy, efi_handle_t parent_image,
+			   struct efi_device_path *file_path,
+			   void *source_buffer, unsigned long source_size,
+			   efi_handle_t *image_handle)
+{
+	static struct efi_object loaded_image_info_obj = {
+		.protocols = {
+			{
+				.guid = &efi_guid_loaded_image,
+				.open = &efi_return_handle,
+			},
+		},
+	};
+	struct efi_loaded_image *info;
+	struct efi_object *obj;
+
+	EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
+		  file_path, source_buffer, source_size, image_handle);
+	info = malloc(sizeof(*info));
+	obj = malloc(sizeof(loaded_image_info_obj));

lib/efi_loader/efi_boottime.c new file +23 -0

+
+	*image_handle = info;
+	list_add_tail(&obj->link, &efi_obj_list);
+
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_start_image(efi_handle_t image_handle,
+			    unsigned long *exit_data_size,
+			    s16 **exit_data)
+{
+	ulong (*entry)(void *image_handle, struct efi_system_table *st);
+	struct efi_loaded_image *info = image_handle;
+
+	EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
+	entry = info->reserved;
+
+	efi_is_direct_boot = false;
+
+	/* call the image! */
+	entry(image_handle, &systab);
+
+	/* Should usually never get here */

lib/efi_loader/efi_boottime.c new file +25 -0

+}
+
+static struct efi_object *efi_search_obj(void *handle)
+{
+	struct list_head *lhandle;
+
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+		if (efiobj->handle == handle)
+			return efiobj;
+	}
+
+	return NULL;
+}
+
+static efi_status_t efi_unload_image(void *image_handle)
+{
+	struct efi_object *efiobj;
+
+	EFI_ENTRY("%p", image_handle);
+	efiobj = efi_search_obj(image_handle);
+	if (efiobj)
+		list_del(&efiobj->link);
+

lib/efi_loader/efi_boottime.c new file +16 -0

+	if (efi_is_direct_boot)
+		cleanup_before_linux();
+#endif
+}
+
+static efi_status_t efi_exit_boot_services(void *image_handle,
+				   unsigned long map_key)
+{
+	EFI_ENTRY("%p, %ld", image_handle, map_key);
+
+	/* Fix up caches for EFI payloads if necessary */
+	efi_exit_caches();
+
+	/* This stops all lingering devices */
+	bootm_disable_interrupts();
+

lib/efi_loader/efi_boottime.c new file +18 -0

+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_stall(unsigned long microseconds)
+{
+	EFI_ENTRY("%ld", microseconds);
+	udelay(microseconds);
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_set_watchdog_timer(unsigned long timeout,
+				   uint64_t watchdog_code,
+				   unsigned long data_size,
+				   uint16_t *watchdog_data)
+{
+	EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
+		  data_size, watchdog_data);
+	return EFI_EXIT(efi_unsupported(__func__));

lib/efi_loader/efi_boottime.c new file +21 -0

+}
+
+static struct efi_class_map efi_class_maps[] = {
+	{
+		.guid = &efi_guid_console_control,
+		.interface = &efi_console_control
+	},
+};
+
+static efi_status_t efi_locate_protocol(efi_guid_t *protocol, void *registration,
+			        void **protocol_interface)
+{
+	efi_status_t r = EFI_NOT_FOUND;
+	int i;
+
+	EFI_ENTRY("%p, %p, %p", protocol, registration, protocol_interface);
+	for (i = 0; i < ARRAY_SIZE(efi_class_maps); i++) {
+		struct efi_class_map *curmap = &efi_class_maps[i];
+		if (!memcmp(protocol, curmap->guid, sizeof(efi_guid_t))) {
+			*protocol_interface = (void*)curmap->interface;
+			return EFI_EXIT(EFI_SUCCESS);

lib/efi_loader/efi_boottime.c new file +55 -0

+}
+
+static efi_status_t efi_calculate_crc32(void *data, unsigned long data_size,
+				uint32_t *crc32_p)
+{
+	EFI_ENTRY("%p, %ld", data, data_size);
+	*crc32_p = crc32(0, data, data_size);
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static void efi_copy_mem(void *destination, void *source, unsigned long length)
+{
+	EFI_ENTRY("%p, %p, %ld", destination, source, length);
+	memcpy(destination, source, length);
+}
+
+static void efi_set_mem(void *buffer, unsigned long size, uint8_t value)
+{
+	EFI_ENTRY("%p, %ld, 0x%x", buffer, size, value);
+	memset(buffer, value, size);
+}
+
+static efi_status_t efi_open_protocol(void *handle, efi_guid_t *protocol,
+			       void **protocol_interface, void *agent_handle,
+			       void *controller_handle, uint32_t attributes)
+{
+	struct list_head *lhandle;
+	int i;
+	efi_status_t r = EFI_UNSUPPORTED;
+
+	EFI_ENTRY("%p, %p, %p, %p, %p, 0x%x", handle, protocol,
+		  protocol_interface, agent_handle, controller_handle,
+		  attributes);
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+
+		if (efiobj->handle != handle)
+			continue;
+
+		for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
+			struct efi_handler *handler = &efiobj->protocols[i];
+			const efi_guid_t *hprotocol = handler->guid;
+			if (!hprotocol)
+				break;
+			if (!memcmp(hprotocol, protocol, sizeof(efi_guid_t))) {
+				r = handler->open(handle, protocol,
+				    protocol_interface, agent_handle,
+				    controller_handle, attributes);
+				goto out;
+			}
+		}
+	}
+
+out:

lib/efi_loader/efi_boottime.c new file +69 -0

+
+static const struct efi_boot_services efi_boot_services = {
+	.hdr = {
+		.headersize = sizeof(struct efi_table_hdr),
+	},
+	.raise_tpl = efi_raise_tpl,
+	.restore_tpl = efi_restore_tpl,
+	.allocate_pages = efi_allocate_pages,
+	.free_pages = efi_free_pages,
+	.get_memory_map = efi_get_memory_map,
+	.allocate_pool = efi_allocate_pool,
+	.free_pool = efi_free_pool,
+	.create_event = efi_create_event,
+	.set_timer = efi_set_timer,
+	.wait_for_event = efi_wait_for_event,
+	.signal_event = efi_signal_event,
+	.close_event = efi_close_event,
+	.check_event = efi_check_event,
+	.install_protocol_interface = efi_install_protocol_interface,
+	.reinstall_protocol_interface = efi_reinstall_protocol_interface,
+	.uninstall_protocol_interface = efi_uninstall_protocol_interface,
+	.handle_protocol = efi_handle_protocol,
+	.reserved = NULL,
+	.register_protocol_notify = efi_register_protocol_notify,
+	.locate_handle = efi_locate_handle,
+	.locate_device_path = efi_locate_device_path,
+	.install_configuration_table = efi_install_configuration_table,
+	.load_image = efi_load_image,
+	.start_image = efi_start_image,
+	.exit = (void*)efi_exit,
+	.unload_image = efi_unload_image,
+	.exit_boot_services = efi_exit_boot_services,
+	.get_next_monotonic_count = efi_get_next_monotonic_count,
+	.stall = efi_stall,
+	.set_watchdog_timer = efi_set_watchdog_timer,
+	.connect_controller = efi_connect_controller,
+	.disconnect_controller = efi_disconnect_controller,
+	.open_protocol = efi_open_protocol,
+	.close_protocol = efi_close_protocol,
+	.open_protocol_information = efi_open_protocol_information,
+	.protocols_per_handle = efi_protocols_per_handle,
+	.locate_handle_buffer = efi_locate_handle_buffer,
+	.locate_protocol = efi_locate_protocol,
+	.install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
+	.uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
+	.calculate_crc32 = efi_calculate_crc32,
+	.copy_mem = efi_copy_mem,
+	.set_mem = efi_set_mem,
+};
+
+
+static uint16_t firmware_vendor[] =
+	{ 'D','a','s',' ','U','-','b','o','o','t',0 };
+
+struct efi_system_table systab = {
+	.hdr = {
+		.signature = EFI_SYSTEM_TABLE_SIGNATURE,
+		.revision = 0x20005, /* 2.5 */
+		.headersize = sizeof(struct efi_table_hdr),
+	},
+	.fw_vendor = (long)firmware_vendor,
+	.con_in = (void*)&efi_con_in,
+	.con_out = (void*)&efi_con_out,
+	.std_err = (void*)&efi_con_out,
+	.runtime = (void*)&efi_runtime_services,
+	.boottime = (void*)&efi_boot_services,
+	.nr_tables = 1,
+	.tables = (void*)efi_conf_table,
+};

Signature · 1 line

2.1.4

Quoted 233 lines · Alexander Graf

When an EFI application runs, it has access to a few descriptor and callback tables to instruct the EFI compliant firmware to do things for it. The bulk of those interfaces are "boot time services". They handle all object management, and memory allocation.

This patch adds support for the boot time services and also exposes a system table, which is the point of entry descriptor table for EFI payloads.

Signed-off-by Alexander Graf <[email protected]>

---

v1 -> v2:

- Fix typo s/does now/does not/
- Add #ifdefs around header to allow inclusion when efi_loader is disabled
- Add stub efi_restore_gd() function when efi_loader is disabled
- Disable debug
- Mark runtime region as such
- Fix up memory map
- Allow efi_restore_gd to be called before first efi entry
- Add 32bit arm cache workaround
- Move memory map to separate patch
- Change BTS version to 2.5
- Fix return values for a few callbacks to more EFI compliant ones
- Change vendor to "Das U-Boot"
- Add warning when truncating timer trigger
- Move to GPLv2+

---
  include/efi_loader.h          |  51 +++
  lib/efi_loader/efi_boottime.c | 761 ++++++++++++++++++++++++++++++++++++++++++
  2 files changed, 812 insertions(+)

create mode 100644 lib/efi_loader/efi_boottime.c

include/efi_loader.h +51 -0

index bf77573..391459e 100644
@@ -6,18 +6,69 @@
   *  SPDX-License-Identifier:     GPL-2.0+
   */
 
+#include <common.h>
  #include <part_efi.h>
  #include <efi_api.h>
+
+#ifdef CONFIG_EFI_LOADER
+
  #include <linux/list.h>
 
+/* #define DEBUG_EFI */
+
+#ifdef DEBUG_EFI
+#define EFI_ENTRY(format, ...) do { \
+	efi_restore_gd(); \
+	printf("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \
+	} while(0)
+#else
+#define EFI_ENTRY(format, ...) do { \
+	efi_restore_gd(); \
+	} while(0)
+#endif
+
+#define EFI_EXIT(ret) efi_exit_func(ret);
+
+extern struct efi_system_table systab;
+
  extern const efi_guid_t efi_guid_device_path;
  extern const efi_guid_t efi_guid_loaded_image;
 
+struct efi_class_map {
+	const efi_guid_t *guid;
+	const void *interface;
+};
+
+struct efi_handler {
+	const efi_guid_t *guid;
+	efi_status_t (EFIAPI *open)(void *handle,
+			efi_guid_t *protocol, void **protocol_interface,
+			void *agent_handle, void *controller_handle,
+			uint32_t attributes);
+};
+
+struct efi_object {
+	struct list_head link;
+	struct efi_handler protocols[4];
+	void *handle;
+};
+extern struct list_head efi_obj_list;
+
  efi_status_t efi_return_handle(void *handle,
  		efi_guid_t *protocol, void **protocol_interface,
  		void *agent_handle, void *controller_handle,
  		uint32_t attributes);
+void efi_timer_check(void);
  void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
+void efi_save_gd(void);
+void efi_restore_gd(void);
+efi_status_t efi_exit_func(efi_status_t ret);
 
  #define EFI_LOADER_POOL_SIZE (128 * 1024 * 1024)
  void *efi_loader_alloc(uint64_t len);
+
+#else /* defined(EFI_LOADER) */
+
+static inline void efi_restore_gd(void) { }
+
+#endif

lib/efi_loader/efi_boottime.c new file +119 -0

new file mode 100644
index 0000000..5756c9c
@@ -0,0 +1,761 @@
+/*
+ *  EFI application boot time services
+ *
+ *  Copyright (c) 2016 Alexander Graf
+ *
+ *  SPDX-License-Identifier:     GPL-2.0+
+ */
+
+/* #define DEBUG_EFI */
+
+#include <common.h>
+#include <efi_loader.h>
+#include <malloc.h>
+#include <asm/global_data.h>
+#include <libfdt_env.h>
+#include <u-boot/crc.h>
+#include <bootm.h>
+#include <inttypes.h>
+#include <watchdog.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+/*
+ * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
+ * we need to do trickery with caches. Since we don't want to break the EFI
+ * aware boot path, only apply hacks when loading exiting directly (breaking
+ * direct Linux EFI booting along the way - oh well).
+ */
+static bool efi_is_direct_boot = true;
+
+/*
+ * EFI can pass arbitrary additional "tables" containing vendor specific
+ * information to the payload. One such table is the FDT table which contains
+ * a pointer to a flattened device tree blob.
+ *
+ * In most cases we want to pass an FDT to the payload, so reserve one slot of
+ * config table space for it. The pointer gets populated by do_bootefi_exec().
+ */
+static struct efi_configuration_table efi_conf_table[] = {
+	{
+		.guid = EFI_FDT_GUID,
+	},
+};
+
+/*
+ * The "gd" pointer lives in a register on ARM and AArch64 that we declare
+ * fixed when compiling U-Boot. However, the payload does not know about that
+ * restriction so we need to manually swap its and our view of that register on
+ * EFI callback entry/exit.
+ */
+static volatile void *efi_gd, *app_gd;
+
+/* Called from do_bootefi_exec() */
+void efi_save_gd(void)
+{
+	efi_gd = gd;
+}
+
+/* Called on every callback entry */
+void efi_restore_gd(void)
+{
+	/* Only restore if we're already in EFI context */
+	if (!efi_gd)
+		return;
+
+	if (gd != efi_gd)
+		app_gd = gd;
+	gd = efi_gd;
+}
+
+/* Called on every callback exit */
+efi_status_t efi_exit_func(efi_status_t ret)
+{
+	gd = app_gd;
+	return ret;
+}
+
+static efi_status_t efi_unsupported(const char *funcname)
+{
+#ifdef DEBUG_EFI
+	printf("EFI: App called into unimplemented function %s\n", funcname);
+#endif
+	return EFI_EXIT(EFI_UNSUPPORTED);
+}
+
+static unsigned long efi_raise_tpl(unsigned long new_tpl)
+{
+	EFI_ENTRY("0x%lx", new_tpl);
+	return EFI_EXIT(0);
+}
+
+static void efi_restore_tpl(unsigned long old_tpl)
+{
+	EFI_ENTRY("0x%lx", old_tpl);
+	EFI_EXIT(efi_unsupported(__func__));
+}
+
+static void *efi_alloc(uint64_t len, int memory_type)
+{
+	switch (memory_type) {
+	default:
+		return malloc(len);
+	}
+}
+
+static efi_status_t efi_allocate_pages(int type, int memory_type,
+				       unsigned long pages, uint64_t *memory)
+{
+	u64 len = pages << 12;
+	efi_status_t r = EFI_SUCCESS;
+
+	EFI_ENTRY("%d, %d, 0x%lx, %p", type, memory_type, pages, memory);
+
+	switch (type) {
+	case 0:
+		/* Any page means we can go to efi_alloc */
+		*memory = (unsigned long)efi_alloc(len, memory_type);
+		break;
+	case 1:

lib/efi_loader/efi_boottime.c line 129

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+		/* Max address */
+		if (gd->relocaddr < *memory) {
+			*memory = (unsigned long)efi_alloc(len, memory_type);
+			break;
+		}
+		r = EFI_NOT_FOUND;
+		break;
+	case 2:
+		/* Exact address, grant it. The addr is already in *memory. */
+		break;

While potentially not necessary for the basic grub->linux flow, for compliance this one should really:
- Register a memory map entry.
- Check for clashes with existing memory map entries.

Quoted 16 lines

lib/efi_loader/efi_boottime.c new file +16 -0

+	default:
+		/* UEFI doesn't specify other allocation types */
+		r = EFI_INVALID_PARAMETER;
+		break;
+	}
+
+	return EFI_EXIT(r);
+}
+
+static efi_status_t efi_free_pages(uint64_t memory, unsigned long pages)
+{
+	/* We don't free, let's cross our fingers we have plenty RAM */
+	EFI_ENTRY("%"PRIx64", 0x%lx", memory, pages);
+	return EFI_EXIT(EFI_SUCCESS);
+}
+

lib/efi_loader/efi_boottime.c line 155

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+/* Will be implemented in a later patch */
+static efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
+			       struct efi_mem_desc *memory_map,
+			       unsigned long *map_key,
+			       unsigned long *descriptor_size,
+			       uint32_t *descriptor_version)
+{
+	EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map, map_key,
+		  descriptor_size, descriptor_version);
+	return EFI_EXIT(EFI_UNSUPPORTED);

(Invalid, but will be overridden in later patch :)

Quoted 82 lines

lib/efi_loader/efi_boottime.c new file +82 -0

+}
+
+static efi_status_t efi_allocate_pool(int pool_type, unsigned long size, void **buffer)
+{
+	return efi_allocate_pages(0, pool_type, (size + 0xfff) >> 12, (void*)buffer);
+}
+
+static efi_status_t efi_free_pool(void *buffer)
+{
+	return efi_free_pages((ulong)buffer, 0);
+}
+
+/*
+ * Our event capabilities are very limited. Only support a single
+ * event to exist, so we don't need to maintain lists.
+ */
+static struct {
+	enum efi_event_type type;
+	u32 trigger_type;
+	u32 trigger_time;
+	u64 trigger_next;
+	unsigned long notify_tpl;
+	void (*notify_function) (void *event, void *context);
+	void *notify_context;
+} efi_event;
+
+static efi_status_t efi_create_event(enum efi_event_type type, ulong notify_tpl,
+			     void (*notify_function) (void *event,
+						      void *context),
+			     void *notify_context, void **event)
+{
+	EFI_ENTRY("%d, 0x%lx, %p, %p", type, notify_tpl, notify_function,
+		  notify_context);
+	if (efi_event.notify_function) {
+		/* We only support one event at a time */
+		return EFI_EXIT(EFI_OUT_OF_RESOURCES);
+	}
+
+	efi_event.type = type;
+	efi_event.notify_tpl = notify_tpl;
+	efi_event.notify_function = notify_function;
+	efi_event.notify_context = notify_context;
+	*event = &efi_event;
+
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+/*
+ * Our timers have to work without interrupts, so we check whenever keyboard
+ * input or disk accesses happen if enough time elapsed for it to fire.
+ */
+void efi_timer_check(void)
+{
+	u64 now = timer_get_us();
+
+	if (now >= efi_event.trigger_next) {
+		/* Triggering! */
+		if (efi_event.trigger_type == EFI_TIMER_PERIODIC)
+			efi_event.trigger_next += efi_event.trigger_time / 10;
+		efi_event.notify_function(&efi_event, efi_event.notify_context);
+	}
+
+	WATCHDOG_RESET();
+}
+
+static efi_status_t efi_set_timer(void *event, int type, uint64_t trigger_time)
+{
+	/* We don't have 64bit division available everywhere, so limit timer
+	 * distances to 32bit bits. */
+	u32 trigger32 = trigger_time;
+
+	if (trigger32 < trigger_time) {
+		printf("WARNING: Truncating timer from %"PRIx64" to %x\n",
+		       trigger_time, trigger32);
+	}
+
+	EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
+	if (event != &efi_event) {
+		/* We only support one event at a time */
+		return EFI_EXIT(EFI_INVALID_PARAMETER);
+	}
+

lib/efi_loader/efi_boottime.c line 247

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+	switch (type) {
+	case EFI_TIMER_STOP:
+		efi_event.trigger_next = -1ULL;
+		break;
+	case EFI_TIMER_PERIODIC:
+	case EFI_TIMER_RELATIVE:
+		efi_event.trigger_next = timer_get_us() + (trigger32 / 10);
+		break;
+	default:
+		return EFI_EXIT(EFI_UNSUPPORTED);

Not a valid return code. EFI_INVALID_PARAMETER is a better choice.

lib/efi_loader/efi_boottime.c line 259

Quoted 12 lines

lib/efi_loader/efi_boottime.c new file +12 -0

+	}
+	efi_event.trigger_type = type;
+	efi_event.trigger_time = trigger_time;
+
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_wait_for_event(unsigned long num_events, void *event,
+			       unsigned long *index)
+{
+	EFI_ENTRY("%ld, %p, %p", num_events, event, index);
+	return EFI_EXIT(efi_unsupported(__func__));

I can't see a way this function can really be left out. None of the valid return values make sense otherwise.

lib/efi_loader/efi_boottime.c line 265

Quoted 6 lines

lib/efi_loader/efi_boottime.c new file +6 -0

+}
+
+static efi_status_t efi_signal_event(void *event)
+{
+	EFI_ENTRY("%p", event);
+	return EFI_EXIT(efi_unsupported(__func__));

Only valid return is EFI_SUCCESS.

lib/efi_loader/efi_boottime.c line 271

Quoted 6 lines

lib/efi_loader/efi_boottime.c new file +6 -0

+}
+
+static efi_status_t efi_close_event(void *event)
+{
+	EFI_ENTRY("%p", event);
+	return EFI_EXIT(efi_unsupported(__func__));

Only valid return is EFI_SUCCESS.

lib/efi_loader/efi_boottime.c line 277

Quoted 6 lines

lib/efi_loader/efi_boottime.c new file +6 -0

+}
+
+static efi_status_t efi_check_event(void *event)
+{
+	EFI_ENTRY("%p", event);
+	return EFI_EXIT(efi_unsupported(__func__));

EFI_NOT_READY?

lib/efi_loader/efi_boottime.c line 287

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+}
+
+static efi_status_t efi_install_protocol_interface(void **handle,
+					   efi_guid_t *protocol,
+					   int protocol_interface_type,
+					   void *protocol_interface)
+{
+	EFI_ENTRY("%p, %p, %d, %p", handle, protocol, protocol_interface_type,
+		  protocol_interface);
+	return EFI_EXIT(efi_unsupported(__func__));

EFI_OUT_OF_RESOURCES?

lib/efi_loader/efi_boottime.c line 296

Quoted 9 lines

lib/efi_loader/efi_boottime.c new file +9 -0

+}
+static efi_status_t efi_reinstall_protocol_interface(void *handle,
+					     efi_guid_t *protocol,
+					     void *old_interface,
+					     void *new_interface)
+{
+	EFI_ENTRY("%p, %p, %p, %p", handle, protocol, old_interface,
+		  new_interface);
+	return EFI_EXIT(efi_unsupported(__func__));

EFI_NOT_FOUND/EFI_ACCESS_DENIED?

lib/efi_loader/efi_boottime.c line 304

Quoted 8 lines

lib/efi_loader/efi_boottime.c new file +8 -0

+}
+
+static efi_status_t efi_uninstall_protocol_interface(void *handle,
+					     efi_guid_t *protocol,
+					     void *protocol_interface)
+{
+	EFI_ENTRY("%p, %p, %p", handle, protocol, protocol_interface);
+	return EFI_EXIT(efi_unsupported(__func__));

EFI_NOT_FOUND?

lib/efi_loader/efi_boottime.c line 311

Quoted 7 lines

lib/efi_loader/efi_boottime.c new file +7 -0

+}
+
+static efi_status_t efi_register_protocol_notify(efi_guid_t *protocol,
+					 void *event, void **registration)
+{e
+	EFI_ENTRY("%p, %p, %p", protocol, event, registration);
+	return EFI_EXIT(efi_unsupported(__func__));

EFI_OUT_OF_RESOURCES is the only valid return value that doesn't mean "one of the inputs is NULL".

Quoted 58 lines

lib/efi_loader/efi_boottime.c new file +58 -0

+}
+
+static int efi_search(enum efi_locate_search_type search_type,
+			efi_guid_t *protocol, void *search_key,
+			struct efi_object *efiobj)
+{
+	int i;
+
+	switch (search_type) {
+	case all_handles:
+		return 0;
+	case by_register_notify:
+		return -1;
+	case by_protocol:
+		for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
+			const efi_guid_t *guid = efiobj->protocols[i].guid;
+			if (guid && !memcmp(guid, protocol, sizeof(efi_guid_t)))
+				return 0;
+		}
+		return -1;
+	}
+
+	return -1;
+}
+
+static efi_status_t efi_locate_handle(enum efi_locate_search_type search_type,
+			efi_guid_t *protocol, void *search_key,
+			unsigned long *buffer_size, efi_handle_t *buffer)
+{
+	struct list_head *lhandle;
+	unsigned long size = 0;
+
+	EFI_ENTRY("%d, %p, %p, %p, %p", search_type, protocol, search_key,
+		  buffer_size, buffer);
+
+	/* Count how much space we need */
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+		if (!efi_search(search_type, protocol, search_key, efiobj)) {
+			size += sizeof(void*);
+		}
+	}
+
+	if (*buffer_size < size) {
+		*buffer_size = size;
+		return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
+	}
+
+	/* Then fill the array */
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+		if (!efi_search(search_type, protocol, search_key, efiobj)) {
+			*(buffer++) = efiobj->handle;
+		}
+	}
+

lib/efi_loader/efi_boottime.c line 379

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+	*buffer_size = size;
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_locate_device_path(efi_guid_t *protocol,
+				   struct efi_device_path **device_path,
+				   efi_handle_t *device)
+{
+	EFI_ENTRY("%p, %p, %p", protocol, device_path, device);
+	return EFI_EXIT(efi_unsupported(__func__));

EFI_NOT_FOUND?

lib/efi_loader/efi_boottime.c line 386

Quoted 7 lines

lib/efi_loader/efi_boottime.c new file +7 -0

+}
+
+static efi_status_t efi_install_configuration_table(efi_guid_t *guid, void *table)
+{
+	EFI_ENTRY("%p, %p", guid, table);
+	/* Only allow overriding of the FDT */
+	if (memcmp(guid, &efi_conf_table[0].guid, sizeof(efi_guid_t)))

Worth creating a guidcmp() macro?

lib/efi_loader/efi_boottime.c line 387

Quoted 1 line

lib/efi_loader/efi_boottime.c new file +1 -0

+		return EFI_EXIT(EFI_UNSUPPORTED);

Not a valid return value.
EFI_OUT_OF_RESOURCES would sort of be correct in this scenario (and my proposed variation below).

lib/efi_loader/efi_boottime.c line 389

Quoted 2 lines

lib/efi_loader/efi_boottime.c new file +2 -0

+
+	efi_conf_table[0].table = table;

The config table infrastructure should also be possible to make more extensible without really increasing the code complexity. Could just loop over NumberOfTableEntries in the system table, and check against a hardcoded max value set by the size of the efi_conf_table struct.

Quoted 29 lines

lib/efi_loader/efi_boottime.c new file +28 -0

+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_load_image(bool boot_policy, efi_handle_t parent_image,
+			   struct efi_device_path *file_path,
+			   void *source_buffer, unsigned long source_size,
+			   efi_handle_t *image_handle)
+{
+	static struct efi_object loaded_image_info_obj = {
+		.protocols = {
+			{
+				.guid = &efi_guid_loaded_image,
+				.open = &efi_return_handle,
+			},
+		},
+	};
+	struct efi_loaded_image *info;
+	struct efi_object *obj;
+
+	EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
+		  file_path, source_buffer, source_size, image_handle);
+	info = malloc(sizeof(*info));
+	obj = malloc(sizeof(loaded_image_info_obj));
+	memset(info, 0, sizeof(*info));
+	memcpy(obj, &loaded_image_info_obj, sizeof(loaded_image_info_obj));
+	obj->handle = info;
+	info->file_path = file_path;
+	info->reserved = efi_load_pe(source_buffer, info);

lib/efi_loader/efi_boottime.c line 422

Quoted 5 lines

lib/efi_loader/efi_boottime.c new file +5 -0

+	if (!info->reserved) {
+		free(info);
+		free(obj);
+		return EFI_EXIT(EFI_UNSUPPORTED);
+	}

Do we need a Dcache clean to PoU at this point (in ARM terms, whatever that means in core code), and Icache invalidation? Or should that be part of efi_load_pe?

Quoted 28 lines

lib/efi_loader/efi_boottime.c new file +27 -0

+
+	*image_handle = info;
+	list_add_tail(&obj->link, &efi_obj_list);
+
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_start_image(efi_handle_t image_handle,
+			    unsigned long *exit_data_size,
+			    s16 **exit_data)
+{
+	ulong (*entry)(void *image_handle, struct efi_system_table *st);
+	struct efi_loaded_image *info = image_handle;
+
+	EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
+	entry = info->reserved;
+
+	efi_is_direct_boot = false;
+
+	/* call the image! */
+	entry(image_handle, &systab);
+
+	/* Should usually never get here */
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_exit(void *image_handle, long exit_status,

lib/efi_loader/efi_boottime.c line 455

Quoted 6 lines

lib/efi_loader/efi_boottime.c new file +6 -0

+		     unsigned long exit_data_size,
+		     uint16_t *exit_data)
+{
+	EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
+		  exit_data_size, exit_data);
+	return EFI_EXIT(efi_unsupported(__func__));

There's not really a valid "no" return value here other than "that ain't me, mate".

Quoted 26 lines

lib/efi_loader/efi_boottime.c new file +25 -0

+}
+
+static struct efi_object *efi_search_obj(void *handle)
+{
+	struct list_head *lhandle;
+
+	list_for_each(lhandle, &efi_obj_list) {
+		struct efi_object *efiobj;
+		efiobj = list_entry(lhandle, struct efi_object, link);
+		if (efiobj->handle == handle)
+			return efiobj;
+	}
+
+	return NULL;
+}
+
+static efi_status_t efi_unload_image(void *image_handle)
+{
+	struct efi_object *efiobj;
+
+	EFI_ENTRY("%p", image_handle);
+	efiobj = efi_search_obj(image_handle);
+	if (efiobj)
+		list_del(&efiobj->link);
+

lib/efi_loader/efi_boottime.c line 490

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static void efi_exit_caches(void)
+{
+#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
+	/*
+	 * Grub on 32bit ARM needs to have caches disabled before jumping into
+	 * a zImage, but does not know of all cache layers. Give it a hand.
+	 */

Just a note: the UEFI support in the 32bit Linux loader in GRUB (written by me) is a bit crap. Now we actually have the kernel UEFI support merged, I should just unify it with the 64bit one, at which point this requirement goes away.

Quoted 16 lines

lib/efi_loader/efi_boottime.c new file +16 -0

+	if (efi_is_direct_boot)
+		cleanup_before_linux();
+#endif
+}
+
+static efi_status_t efi_exit_boot_services(void *image_handle,
+				   unsigned long map_key)
+{
+	EFI_ENTRY("%p, %ld", image_handle, map_key);
+
+	/* Fix up caches for EFI payloads if necessary */
+	efi_exit_caches();
+
+	/* This stops all lingering devices */
+	bootm_disable_interrupts();
+

lib/efi_loader/efi_boottime.c line 516

Quoted 10 lines

lib/efi_loader/efi_boottime.c new file +10 -0

+	/* Give the payload some time to boot */
+	WATCHDOG_RESET();
+
+	return EFI_EXIT(EFI_SUCCESS);
+}
+
+static efi_status_t efi_get_next_monotonic_count(uint64_t *count)
+{
+	EFI_ENTRY("%p", count);
+	*count = timer_get_us();

This doesn't actually conform to the spec.
While we may not explicitly care enough to implement the full defined behaviour in this emulation (persistent top 32 bits), we should still make sure the lower 32 bits are increment by explicitly 1 every time it's called.