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