cmd/bootefi.c

   1 /*
   2  *  EFI application loader
   3  *
   4  *  Copyright (c) 2016 Alexander Graf
   5  *
   6  *  SPDX-License-Identifier:     GPL-2.0+
   7  */
   8
   9 #include <common.h>
  10 #include <command.h>
  11 #include <dm/device.h>
  12 #include <efi_loader.h>
  13 #include <errno.h>
  14 #include <libfdt.h>
  15 #include <libfdt_env.h>
  16 #include <memalign.h>
  17 #include <asm/global_data.h>
  18 #include <asm-generic/sections.h>
  19 #include <linux/linkage.h>
  20
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 /*
  24  * When booting using the "bootefi" command, we don't know which
  25  * physical device the file came from. So we create a pseudo-device
  26  * called "bootefi" with the device path /bootefi.
  27  *
  28  * In addition to the originating device we also declare the file path
  29  * of "bootefi" based loads to be /bootefi.
  30  */
  31 static struct efi_device_path_file_path bootefi_image_path[] = {
  32         {
  33                 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
  34                 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
  35                 .dp.length = sizeof(bootefi_image_path[0]),
  36                 .str = { 'b','o','o','t','e','f','i' },
  37         }, {
  38                 .dp.type = DEVICE_PATH_TYPE_END,
  39                 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
  40                 .dp.length = sizeof(bootefi_image_path[0]),
  41         }
  42 };
  43
  44 static struct efi_device_path_file_path bootefi_device_path[] = {
  45         {
  46                 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
  47                 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
  48                 .dp.length = sizeof(bootefi_image_path[0]),
  49                 .str = { 'b','o','o','t','e','f','i' },
  50         }, {
  51                 .dp.type = DEVICE_PATH_TYPE_END,
  52                 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
  53                 .dp.length = sizeof(bootefi_image_path[0]),
  54         }
  55 };
  56
  57 static efi_status_t EFIAPI bootefi_open_dp(void *handle, efi_guid_t *protocol,
  58                         void **protocol_interface, void *agent_handle,
  59                         void *controller_handle, uint32_t attributes)
  60 {
  61         *protocol_interface = bootefi_device_path;
  62         return EFI_SUCCESS;
  63 }
  64
  65 /* The EFI loaded_image interface for the image executed via "bootefi" */
  66 static struct efi_loaded_image loaded_image_info = {
  67         .device_handle = bootefi_device_path,
  68         .file_path = bootefi_image_path,
  69 };
  70
  71 /* The EFI object struct for the image executed via "bootefi" */
  72 static struct efi_object loaded_image_info_obj = {
  73         .handle = &loaded_image_info,
  74         .protocols = {
  75                 {
  76                         /*
  77                          * When asking for the loaded_image interface, just
  78                          * return handle which points to loaded_image_info
  79                          */
  80                         .guid = &efi_guid_loaded_image,
  81                         .open = &efi_return_handle,
  82                 },
  83                 {
  84                         /*
  85                          * When asking for the device path interface, return
  86                          * bootefi_device_path
  87                          */
  88                         .guid = &efi_guid_device_path,
  89                         .open = &bootefi_open_dp,
  90                 },
  91         },
  92 };
  93
  94 /* The EFI object struct for the device the "bootefi" image was loaded from */
  95 static struct efi_object bootefi_device_obj = {
  96         .handle = bootefi_device_path,
  97         .protocols = {
  98                 {
  99                         /* When asking for the device path interface, return
 100                          * bootefi_device_path */
 101                         .guid = &efi_guid_device_path,
 102                         .open = &bootefi_open_dp,
 103                 }
 104         },
 105 };
 106
 107 static void *copy_fdt(void *fdt)
 108 {
 109         u64 fdt_size = fdt_totalsize(fdt);
 110         unsigned long fdt_ram_start = -1L, fdt_pages;
 111         u64 new_fdt_addr;
 112         void *new_fdt;
 113         int i;
 114
 115         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 116                 u64 ram_start = gd->bd->bi_dram[i].start;
 117                 u64 ram_size = gd->bd->bi_dram[i].size;
 118
 119                 if (!ram_size)
 120                         continue;
 121
 122                 if (ram_start < fdt_ram_start)
 123                         fdt_ram_start = ram_start;
 124         }
 125
 126         /* Give us at least 4kb breathing room */
 127         fdt_size = ALIGN(fdt_size + 4096, 4096);
 128         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 129
 130         /* Safe fdt location is at 128MB */
 131         new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
 132         if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages,
 133                                &new_fdt_addr) != EFI_SUCCESS) {
 134                 /* If we can't put it there, put it somewhere */
 135                 new_fdt_addr = (ulong)memalign(4096, fdt_size);
 136         }
 137         new_fdt = (void*)(ulong)new_fdt_addr;
 138         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
 139         fdt_set_totalsize(new_fdt, fdt_size);
 140
 141         return new_fdt;
 142 }
 143
 144 /*
 145  * Load an EFI payload into a newly allocated piece of memory, register all
 146  * EFI objects it would want to access and jump to it.
 147  */
 148 static unsigned long do_bootefi_exec(void *efi, void *fdt)
 149 {
 150         ulong (*entry)(void *image_handle, struct efi_system_table *st)
 151                 asmlinkage;
 152         ulong fdt_pages, fdt_size, fdt_start, fdt_end;
 153         bootm_headers_t img = { 0 };
 154
 155         /*
 156          * gd lives in a fixed register which may get clobbered while we execute
 157          * the payload. So save it here and restore it on every callback entry
 158          */
 159         efi_save_gd();
 160
 161         if (fdt && !fdt_check_header(fdt)) {
 162                 /* Prepare fdt for payload */
 163                 fdt = copy_fdt(fdt);
 164
 165                 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 166                         printf("ERROR: Failed to process device tree\n");
 167                         return -EINVAL;
 168                 }
 169
 170                 /* Link to it in the efi tables */
 171                 systab.tables[0].guid = EFI_FDT_GUID;
 172                 systab.tables[0].table = fdt;
 173                 systab.nr_tables = 1;
 174
 175                 /* And reserve the space in the memory map */
 176                 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
 177                 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
 178                 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
 179                 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 180                 /* Give a bootloader the chance to modify the device tree */
 181                 fdt_pages += 2;
 182                 efi_add_memory_map(fdt_start, fdt_pages,
 183                                    EFI_BOOT_SERVICES_DATA, true);
 184         } else {
 185                 printf("WARNING: Invalid device tree, expect boot to fail\n");
 186                 systab.nr_tables = 0;
 187         }
 188
 189         /* Load the EFI payload */
 190         entry = efi_load_pe(efi, &loaded_image_info);
 191         if (!entry)
 192                 return -ENOENT;
 193
 194         /* Initialize and populate EFI object list */
 195         INIT_LIST_HEAD(&efi_obj_list);
 196         list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
 197         list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
 198 #ifdef CONFIG_PARTITIONS
 199         efi_disk_register();
 200 #endif
 201 #ifdef CONFIG_LCD
 202         efi_gop_register();
 203 #endif
 204 #ifdef CONFIG_NET
 205         void *nethandle = loaded_image_info.device_handle;
 206         efi_net_register(&nethandle);
 207
 208         if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6))
 209                 loaded_image_info.device_handle = nethandle;
 210         else
 211                 loaded_image_info.device_handle = bootefi_device_path;
 212 #endif
 213 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
 214         efi_smbios_register();
 215 #endif
 216
 217         /* Initialize EFI runtime services */
 218         efi_reset_system_init();
 219         efi_get_time_init();
 220
 221         /* Call our payload! */
 222         debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
 223
 224         if (setjmp(&loaded_image_info.exit_jmp)) {
 225                 efi_status_t status = loaded_image_info.exit_status;
 226                 return status == EFI_SUCCESS ? 0 : -EINVAL;
 227         }
 228
 229 #ifdef CONFIG_ARM64
 230         /* On AArch64 we need to make sure we call our payload in < EL3 */
 231         if (current_el() == 3) {
 232                 smp_kick_all_cpus();
 233                 dcache_disable();       /* flush cache before switch to EL2 */
 234                 armv8_switch_to_el2();
 235                 /* Enable caches again */
 236                 dcache_enable();
 237         }
 238 #endif
 239
 240         return entry(&loaded_image_info, &systab);
 241 }
 242
 243
 244 /* Interpreter command to boot an arbitrary EFI image from memory */
 245 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 246 {
 247         char *saddr, *sfdt;
 248         unsigned long addr, fdt_addr = 0;
 249         int r = 0;
 250
 251         if (argc < 2)
 252                 return CMD_RET_USAGE;
 253 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 254         if (!strcmp(argv[1], "hello")) {
 255                 ulong size = __efi_hello_world_end - __efi_hello_world_begin;
 256
 257                 addr = CONFIG_SYS_LOAD_ADDR;
 258                 memcpy((char *)addr, __efi_hello_world_begin, size);
 259         } else
 260 #endif
 261         {
 262                 saddr = argv[1];
 263
 264                 addr = simple_strtoul(saddr, NULL, 16);
 265
 266                 if (argc > 2) {
 267                         sfdt = argv[2];
 268                         fdt_addr = simple_strtoul(sfdt, NULL, 16);
 269                 }
 270         }
 271
 272         printf("## Starting EFI application at %08lx ...\n", addr);
 273         r = do_bootefi_exec((void *)addr, (void*)fdt_addr);
 274         printf("## Application terminated, r = %d\n", r);
 275
 276         if (r != 0)
 277                 r = 1;
 278
 279         return r;
 280 }
 281
 282 #ifdef CONFIG_SYS_LONGHELP
 283 static char bootefi_help_text[] =
 284         "<image address> [fdt address]\n"
 285         "  - boot EFI payload stored at address <image address>.\n"
 286         "    If specified, the device tree located at <fdt address> gets\n"
 287         "    exposed as EFI configuration table.\n"
 288 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 289         "hello\n"
 290         "  - boot a sample Hello World application stored within U-Boot"
 291 #endif
 292         ;
 293 #endif
 294
 295 U_BOOT_CMD(
 296         bootefi, 3, 0, do_bootefi,
 297         "Boots an EFI payload from memory",
 298         bootefi_help_text
 299 );
 300
 301 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 302 {
 303         __maybe_unused struct blk_desc *desc;
 304         char devname[32] = { 0 }; /* dp->str is u16[32] long */
 305         char *colon;
 306
 307 #if defined(CONFIG_BLK) || defined(CONFIG_ISO_PARTITION)
 308         desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
 309 #endif
 310
 311 #ifdef CONFIG_BLK
 312         if (desc) {
 313                 snprintf(devname, sizeof(devname), "%s", desc->bdev->name);
 314         } else
 315 #endif
 316
 317         {
 318                 /* Assemble the condensed device name we use in efi_disk.c */
 319                 snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
 320         }
 321
 322         colon = strchr(devname, ':');
 323
 324 #ifdef CONFIG_ISO_PARTITION
 325         /* For ISOs we create partition block devices */
 326         if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
 327             (desc->part_type == PART_TYPE_ISO)) {
 328                 if (!colon)
 329                         snprintf(devname, sizeof(devname), "%s:1", devname);
 330
 331                 colon = NULL;
 332         }
 333 #endif
 334
 335         if (colon)
 336                 *colon = '\0';
 337
 338         /* Patch bootefi_device_path to the target device */
 339         memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
 340         ascii2unicode(bootefi_device_path[0].str, devname);
 341
 342         /* Patch bootefi_image_path to the target file path */
 343         memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
 344         if (strcmp(dev, "Net")) {
 345                 /* Add leading / to fs paths, because they're absolute */
 346                 snprintf(devname, sizeof(devname), "/%s", path);
 347         } else {
 348                 snprintf(devname, sizeof(devname), "%s", path);
 349         }
 350         ascii2unicode(bootefi_image_path[0].str, devname);
 351 }