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 <charset.h>
  10 #include <common.h>
  11 #include <command.h>
  12 #include <dm.h>
  13 #include <efi_loader.h>
  14 #include <efi_selftest.h>
  15 #include <errno.h>
  16 #include <linux/libfdt.h>
  17 #include <linux/libfdt_env.h>
  18 #include <memalign.h>
  19 #include <asm/global_data.h>
  20 #include <asm-generic/sections.h>
  21 #include <linux/linkage.h>
  22
  23 DECLARE_GLOBAL_DATA_PTR;
  24
  25 #define OBJ_LIST_NOT_INITIALIZED 1
  26
  27 static efi_status_t efi_obj_list_initialized = OBJ_LIST_NOT_INITIALIZED;
  28
  29 static struct efi_device_path *bootefi_image_path;
  30 static struct efi_device_path *bootefi_device_path;
  31
  32 /* Initialize and populate EFI object list */
  33 efi_status_t efi_init_obj_list(void)
  34 {
  35         efi_status_t ret = EFI_SUCCESS;
  36
  37         /* Initialize once only */
  38         if (efi_obj_list_initialized != OBJ_LIST_NOT_INITIALIZED)
  39                 return efi_obj_list_initialized;
  40
  41         /* Initialize EFI driver uclass */
  42         ret = efi_driver_init();
  43         if (ret != EFI_SUCCESS)
  44                 goto out;
  45
  46         ret = efi_console_register();
  47         if (ret != EFI_SUCCESS)
  48                 goto out;
  49 #ifdef CONFIG_PARTITIONS
  50         ret = efi_disk_register();
  51         if (ret != EFI_SUCCESS)
  52                 goto out;
  53 #endif
  54 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
  55         ret = efi_gop_register();
  56         if (ret != EFI_SUCCESS)
  57                 goto out;
  58 #endif
  59 #ifdef CONFIG_CMD_NET
  60         ret = efi_net_register();
  61         if (ret != EFI_SUCCESS)
  62                 goto out;
  63 #endif
  64 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
  65         ret = efi_smbios_register();
  66         if (ret != EFI_SUCCESS)
  67                 goto out;
  68 #endif
  69         ret = efi_watchdog_register();
  70         if (ret != EFI_SUCCESS)
  71                 goto out;
  72
  73         /* Initialize EFI runtime services */
  74         ret = efi_reset_system_init();
  75         if (ret != EFI_SUCCESS)
  76                 goto out;
  77         ret = efi_get_time_init();
  78         if (ret != EFI_SUCCESS)
  79                 goto out;
  80
  81 out:
  82         efi_obj_list_initialized = ret;
  83         return ret;
  84 }
  85
  86 /*
  87  * Set the load options of an image from an environment variable.
  88  *
  89  * @loaded_image_info:  the image
  90  * @env_var:            name of the environment variable
  91  */
  92 static void set_load_options(struct efi_loaded_image *loaded_image_info,
  93                              const char *env_var)
  94 {
  95         size_t size;
  96         const char *env = env_get(env_var);
  97
  98         loaded_image_info->load_options = NULL;
  99         loaded_image_info->load_options_size = 0;
 100         if (!env)
 101                 return;
 102         size = strlen(env) + 1;
 103         loaded_image_info->load_options = calloc(size, sizeof(u16));
 104         if (!loaded_image_info->load_options) {
 105                 printf("ERROR: Out of memory\n");
 106                 return;
 107         }
 108         utf8_to_utf16(loaded_image_info->load_options, (u8 *)env, size);
 109         loaded_image_info->load_options_size = size * 2;
 110 }
 111
 112 static void *copy_fdt(void *fdt)
 113 {
 114         u64 fdt_size = fdt_totalsize(fdt);
 115         unsigned long fdt_ram_start = -1L, fdt_pages;
 116         u64 new_fdt_addr;
 117         void *new_fdt;
 118         int i;
 119
 120         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 121                 u64 ram_start = gd->bd->bi_dram[i].start;
 122                 u64 ram_size = gd->bd->bi_dram[i].size;
 123
 124                 if (!ram_size)
 125                         continue;
 126
 127                 if (ram_start < fdt_ram_start)
 128                         fdt_ram_start = ram_start;
 129         }
 130
 131         /* Give us at least 4kb breathing room */
 132         fdt_size = ALIGN(fdt_size + 4096, EFI_PAGE_SIZE);
 133         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 134
 135         /* Safe fdt location is at 128MB */
 136         new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
 137         if (efi_allocate_pages(1, EFI_RUNTIME_SERVICES_DATA, fdt_pages,
 138                                &new_fdt_addr) != EFI_SUCCESS) {
 139                 /* If we can't put it there, put it somewhere */
 140                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
 141                 if (efi_allocate_pages(1, EFI_RUNTIME_SERVICES_DATA, fdt_pages,
 142                                        &new_fdt_addr) != EFI_SUCCESS) {
 143                         printf("ERROR: Failed to reserve space for FDT\n");
 144                         return NULL;
 145                 }
 146         }
 147
 148         new_fdt = (void*)(ulong)new_fdt_addr;
 149         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
 150         fdt_set_totalsize(new_fdt, fdt_size);
 151
 152         return new_fdt;
 153 }
 154
 155 static efi_status_t efi_do_enter(
 156                         efi_handle_t image_handle, struct efi_system_table *st,
 157                         EFIAPI efi_status_t (*entry)(
 158                                 efi_handle_t image_handle,
 159                                 struct efi_system_table *st))
 160 {
 161         efi_status_t ret = EFI_LOAD_ERROR;
 162
 163         if (entry)
 164                 ret = entry(image_handle, st);
 165         st->boottime->exit(image_handle, ret, 0, NULL);
 166         return ret;
 167 }
 168
 169 #ifdef CONFIG_ARM64
 170 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
 171                         efi_handle_t image_handle, struct efi_system_table *st),
 172                         efi_handle_t image_handle, struct efi_system_table *st)
 173 {
 174         /* Enable caches again */
 175         dcache_enable();
 176
 177         return efi_do_enter(image_handle, st, entry);
 178 }
 179 #endif
 180
 181 /*
 182  * Load an EFI payload into a newly allocated piece of memory, register all
 183  * EFI objects it would want to access and jump to it.
 184  */
 185 static efi_status_t do_bootefi_exec(void *efi, void *fdt,
 186                                     struct efi_device_path *device_path,
 187                                     struct efi_device_path *image_path)
 188 {
 189         struct efi_loaded_image loaded_image_info = {};
 190         struct efi_object loaded_image_info_obj = {};
 191         struct efi_device_path *memdp = NULL;
 192         efi_status_t ret;
 193
 194         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
 195                                      struct efi_system_table *st);
 196         ulong fdt_pages, fdt_size, fdt_start, fdt_end;
 197         const efi_guid_t fdt_guid = EFI_FDT_GUID;
 198         bootm_headers_t img = { 0 };
 199
 200         /*
 201          * Special case for efi payload not loaded from disk, such as
 202          * 'bootefi hello' or for example payload loaded directly into
 203          * memory via jtag/etc:
 204          */
 205         if (!device_path && !image_path) {
 206                 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
 207                 /* actual addresses filled in after efi_load_pe() */
 208                 memdp = efi_dp_from_mem(0, 0, 0);
 209                 device_path = image_path = memdp;
 210         } else {
 211                 assert(device_path && image_path);
 212         }
 213
 214         efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
 215                                device_path, image_path);
 216
 217         /*
 218          * gd lives in a fixed register which may get clobbered while we execute
 219          * the payload. So save it here and restore it on every callback entry
 220          */
 221         efi_save_gd();
 222
 223         if (fdt && !fdt_check_header(fdt)) {
 224                 /* Prepare fdt for payload */
 225                 fdt = copy_fdt(fdt);
 226
 227                 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 228                         printf("ERROR: Failed to process device tree\n");
 229                         return -EINVAL;
 230                 }
 231
 232                 /* Link to it in the efi tables */
 233                 efi_install_configuration_table(&fdt_guid, fdt);
 234
 235                 /* And reserve the space in the memory map */
 236                 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
 237                 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
 238                 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
 239                 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 240                 /* Give a bootloader the chance to modify the device tree */
 241                 fdt_pages += 2;
 242                 efi_add_memory_map(fdt_start, fdt_pages,
 243                                    EFI_BOOT_SERVICES_DATA, true);
 244         } else {
 245                 printf("WARNING: Invalid device tree, expect boot to fail\n");
 246                 efi_install_configuration_table(&fdt_guid, NULL);
 247         }
 248
 249         /* Transfer environment variable bootargs as load options */
 250         set_load_options(&loaded_image_info, "bootargs");
 251         /* Load the EFI payload */
 252         entry = efi_load_pe(efi, &loaded_image_info);
 253         if (!entry) {
 254                 ret = EFI_LOAD_ERROR;
 255                 goto exit;
 256         }
 257
 258         if (memdp) {
 259                 struct efi_device_path_memory *mdp = (void *)memdp;
 260                 mdp->memory_type = loaded_image_info.image_code_type;
 261                 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
 262                 mdp->end_address = mdp->start_address +
 263                                 loaded_image_info.image_size;
 264         }
 265
 266         /* we don't support much: */
 267         env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
 268                 "{ro,boot}(blob)0000000000000000");
 269
 270         /* Call our payload! */
 271         debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
 272
 273         if (setjmp(&loaded_image_info.exit_jmp)) {
 274                 ret = loaded_image_info.exit_status;
 275                 goto exit;
 276         }
 277
 278 #ifdef CONFIG_ARM64
 279         /* On AArch64 we need to make sure we call our payload in < EL3 */
 280         if (current_el() == 3) {
 281                 smp_kick_all_cpus();
 282                 dcache_disable();       /* flush cache before switch to EL2 */
 283
 284                 /* Move into EL2 and keep running there */
 285                 armv8_switch_to_el2((ulong)entry,
 286                                     (ulong)&loaded_image_info_obj.handle,
 287                                     (ulong)&systab, 0, (ulong)efi_run_in_el2,
 288                                     ES_TO_AARCH64);
 289
 290                 /* Should never reach here, efi exits with longjmp */
 291                 while (1) { }
 292         }
 293 #endif
 294
 295         ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
 296
 297 exit:
 298         /* image has returned, loaded-image obj goes *poof*: */
 299         list_del(&loaded_image_info_obj.link);
 300
 301         return ret;
 302 }
 303
 304 static int do_bootefi_bootmgr_exec(unsigned long fdt_addr)
 305 {
 306         struct efi_device_path *device_path, *file_path;
 307         void *addr;
 308         efi_status_t r;
 309
 310         /*
 311          * gd lives in a fixed register which may get clobbered while we execute
 312          * the payload. So save it here and restore it on every callback entry
 313          */
 314         efi_save_gd();
 315
 316         addr = efi_bootmgr_load(&device_path, &file_path);
 317         if (!addr)
 318                 return 1;
 319
 320         printf("## Starting EFI application at %p ...\n", addr);
 321         r = do_bootefi_exec(addr, (void *)fdt_addr, device_path, file_path);
 322         printf("## Application terminated, r = %lu\n",
 323                r & ~EFI_ERROR_MASK);
 324
 325         if (r != EFI_SUCCESS)
 326                 return 1;
 327
 328         return 0;
 329 }
 330
 331 /* Interpreter command to boot an arbitrary EFI image from memory */
 332 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 333 {
 334         char *saddr, *sfdt;
 335         unsigned long addr, fdt_addr = 0;
 336         efi_status_t r;
 337
 338         /* Initialize EFI drivers */
 339         r = efi_init_obj_list();
 340         if (r != EFI_SUCCESS) {
 341                 printf("Error: Cannot set up EFI drivers, r = %lu\n",
 342                        r & ~EFI_ERROR_MASK);
 343                 return CMD_RET_FAILURE;
 344         }
 345
 346         if (argc < 2)
 347                 return CMD_RET_USAGE;
 348 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 349         if (!strcmp(argv[1], "hello")) {
 350                 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
 351
 352                 saddr = env_get("loadaddr");
 353                 if (saddr)
 354                         addr = simple_strtoul(saddr, NULL, 16);
 355                 else
 356                         addr = CONFIG_SYS_LOAD_ADDR;
 357                 memcpy((char *)addr, __efi_helloworld_begin, size);
 358         } else
 359 #endif
 360 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 361         if (!strcmp(argv[1], "selftest")) {
 362                 struct efi_loaded_image loaded_image_info = {};
 363                 struct efi_object loaded_image_info_obj = {};
 364
 365                 /* Construct a dummy device path. */
 366                 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
 367                                                       (uintptr_t)&efi_selftest,
 368                                                       (uintptr_t)&efi_selftest);
 369                 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
 370
 371                 efi_setup_loaded_image(&loaded_image_info,
 372                                        &loaded_image_info_obj,
 373                                        bootefi_device_path, bootefi_image_path);
 374                 /*
 375                  * gd lives in a fixed register which may get clobbered while we
 376                  * execute the payload. So save it here and restore it on every
 377                  * callback entry
 378                  */
 379                 efi_save_gd();
 380                 /* Initialize and populate EFI object list */
 381                 efi_init_obj_list();
 382                 /* Transfer environment variable efi_selftest as load options */
 383                 set_load_options(&loaded_image_info, "efi_selftest");
 384                 /* Execute the test */
 385                 r = efi_selftest(loaded_image_info_obj.handle, &systab);
 386                 efi_restore_gd();
 387                 free(loaded_image_info.load_options);
 388                 list_del(&loaded_image_info_obj.link);
 389                 return r != EFI_SUCCESS;
 390         } else
 391 #endif
 392         if (!strcmp(argv[1], "bootmgr")) {
 393                 unsigned long fdt_addr = 0;
 394
 395                 if (argc > 2)
 396                         fdt_addr = simple_strtoul(argv[2], NULL, 16);
 397
 398                 return do_bootefi_bootmgr_exec(fdt_addr);
 399         } else {
 400                 saddr = argv[1];
 401
 402                 addr = simple_strtoul(saddr, NULL, 16);
 403                 /* Check that a numeric value was passed */
 404                 if (!addr && *saddr != '0')
 405                         return CMD_RET_USAGE;
 406
 407                 if (argc > 2) {
 408                         sfdt = argv[2];
 409                         fdt_addr = simple_strtoul(sfdt, NULL, 16);
 410                 }
 411         }
 412
 413         printf("## Starting EFI application at %08lx ...\n", addr);
 414         r = do_bootefi_exec((void *)addr, (void *)fdt_addr,
 415                             bootefi_device_path, bootefi_image_path);
 416         printf("## Application terminated, r = %lu\n",
 417                r & ~EFI_ERROR_MASK);
 418
 419         if (r != EFI_SUCCESS)
 420                 return 1;
 421         else
 422                 return 0;
 423 }
 424
 425 #ifdef CONFIG_SYS_LONGHELP
 426 static char bootefi_help_text[] =
 427         "<image address> [fdt address]\n"
 428         "  - boot EFI payload stored at address <image address>.\n"
 429         "    If specified, the device tree located at <fdt address> gets\n"
 430         "    exposed as EFI configuration table.\n"
 431 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 432         "bootefi hello\n"
 433         "  - boot a sample Hello World application stored within U-Boot\n"
 434 #endif
 435 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 436         "bootefi selftest\n"
 437         "  - boot an EFI selftest application stored within U-Boot\n"
 438         "    Use environment variable efi_selftest to select a single test.\n"
 439         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 440 #endif
 441         "bootefi bootmgr [fdt addr]\n"
 442         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
 443         "\n"
 444         "    If specified, the device tree located at <fdt address> gets\n"
 445         "    exposed as EFI configuration table.\n";
 446 #endif
 447
 448 U_BOOT_CMD(
 449         bootefi, 3, 0, do_bootefi,
 450         "Boots an EFI payload from memory",
 451         bootefi_help_text
 452 );
 453
 454 static int parse_partnum(const char *devnr)
 455 {
 456         const char *str = strchr(devnr, ':');
 457         if (str) {
 458                 str++;
 459                 return simple_strtoul(str, NULL, 16);
 460         }
 461         return 0;
 462 }
 463
 464 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 465 {
 466         char filename[32] = { 0 }; /* dp->str is u16[32] long */
 467         char *s;
 468
 469         if (strcmp(dev, "Net")) {
 470                 struct blk_desc *desc;
 471                 int part;
 472
 473                 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
 474                 if (!desc)
 475                         return;
 476                 part = parse_partnum(devnr);
 477
 478                 bootefi_device_path = efi_dp_from_part(desc, part);
 479         } else {
 480 #ifdef CONFIG_CMD_NET
 481                 bootefi_device_path = efi_dp_from_eth();
 482 #endif
 483         }
 484
 485         if (!path)
 486                 return;
 487
 488         if (strcmp(dev, "Net")) {
 489                 /* Add leading / to fs paths, because they're absolute */
 490                 snprintf(filename, sizeof(filename), "/%s", path);
 491         } else {
 492                 snprintf(filename, sizeof(filename), "%s", path);
 493         }
 494         /* DOS style file path: */
 495         s = filename;
 496         while ((s = strchr(s, '/')))
 497                 *s++ = '\\';
 498         bootefi_image_path = efi_dp_from_file(NULL, 0, filename);
 499 }