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 static efi_status_t efi_install_fdt(void *fdt)
 182 {
 183         bootm_headers_t img = { 0 };
 184         ulong fdt_pages, fdt_size, fdt_start, fdt_end;
 185         efi_status_t ret;
 186
 187         if (fdt_check_header(fdt)) {
 188                 printf("ERROR: invalid device tree\n");
 189                 return EFI_INVALID_PARAMETER;
 190         }
 191
 192         /* Prepare fdt for payload */
 193         fdt = copy_fdt(fdt);
 194         if (!fdt)
 195                 return EFI_OUT_OF_RESOURCES;
 196
 197         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 198                 printf("ERROR: failed to process device tree\n");
 199                 return EFI_LOAD_ERROR;
 200         }
 201
 202         /* Link to it in the efi tables */
 203         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
 204         if (ret != EFI_SUCCESS)
 205                 return EFI_OUT_OF_RESOURCES;
 206
 207         /* And reserve the space in the memory map */
 208         fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
 209         fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
 210         fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
 211         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 212         /* Give a bootloader the chance to modify the device tree */
 213         fdt_pages += 2;
 214         ret = efi_add_memory_map(fdt_start, fdt_pages,
 215                                  EFI_BOOT_SERVICES_DATA, true);
 216         return ret;
 217 }
 218
 219 /*
 220  * Load an EFI payload into a newly allocated piece of memory, register all
 221  * EFI objects it would want to access and jump to it.
 222  */
 223 static efi_status_t do_bootefi_exec(void *efi,
 224                                     struct efi_device_path *device_path,
 225                                     struct efi_device_path *image_path)
 226 {
 227         struct efi_loaded_image loaded_image_info = {};
 228         struct efi_object loaded_image_info_obj = {};
 229         struct efi_device_path *memdp = NULL;
 230         efi_status_t ret;
 231
 232         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
 233                                      struct efi_system_table *st);
 234
 235         /*
 236          * Special case for efi payload not loaded from disk, such as
 237          * 'bootefi hello' or for example payload loaded directly into
 238          * memory via jtag/etc:
 239          */
 240         if (!device_path && !image_path) {
 241                 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
 242                 /* actual addresses filled in after efi_load_pe() */
 243                 memdp = efi_dp_from_mem(0, 0, 0);
 244                 device_path = image_path = memdp;
 245         } else {
 246                 assert(device_path && image_path);
 247         }
 248
 249         efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
 250                                device_path, image_path);
 251
 252         /*
 253          * gd lives in a fixed register which may get clobbered while we execute
 254          * the payload. So save it here and restore it on every callback entry
 255          */
 256         efi_save_gd();
 257
 258         /* Transfer environment variable bootargs as load options */
 259         set_load_options(&loaded_image_info, "bootargs");
 260         /* Load the EFI payload */
 261         entry = efi_load_pe(efi, &loaded_image_info);
 262         if (!entry) {
 263                 ret = EFI_LOAD_ERROR;
 264                 goto exit;
 265         }
 266
 267         if (memdp) {
 268                 struct efi_device_path_memory *mdp = (void *)memdp;
 269                 mdp->memory_type = loaded_image_info.image_code_type;
 270                 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
 271                 mdp->end_address = mdp->start_address +
 272                                 loaded_image_info.image_size;
 273         }
 274
 275         /* we don't support much: */
 276         env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
 277                 "{ro,boot}(blob)0000000000000000");
 278
 279         /* Call our payload! */
 280         debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
 281
 282         if (setjmp(&loaded_image_info.exit_jmp)) {
 283                 ret = loaded_image_info.exit_status;
 284                 goto exit;
 285         }
 286
 287 #ifdef CONFIG_ARM64
 288         /* On AArch64 we need to make sure we call our payload in < EL3 */
 289         if (current_el() == 3) {
 290                 smp_kick_all_cpus();
 291                 dcache_disable();       /* flush cache before switch to EL2 */
 292
 293                 /* Move into EL2 and keep running there */
 294                 armv8_switch_to_el2((ulong)entry,
 295                                     (ulong)&loaded_image_info_obj.handle,
 296                                     (ulong)&systab, 0, (ulong)efi_run_in_el2,
 297                                     ES_TO_AARCH64);
 298
 299                 /* Should never reach here, efi exits with longjmp */
 300                 while (1) { }
 301         }
 302 #endif
 303
 304         ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
 305
 306 exit:
 307         /* image has returned, loaded-image obj goes *poof*: */
 308         list_del(&loaded_image_info_obj.link);
 309
 310         return ret;
 311 }
 312
 313 static int do_bootefi_bootmgr_exec(void)
 314 {
 315         struct efi_device_path *device_path, *file_path;
 316         void *addr;
 317         efi_status_t r;
 318
 319         /*
 320          * gd lives in a fixed register which may get clobbered while we execute
 321          * the payload. So save it here and restore it on every callback entry
 322          */
 323         efi_save_gd();
 324
 325         addr = efi_bootmgr_load(&device_path, &file_path);
 326         if (!addr)
 327                 return 1;
 328
 329         printf("## Starting EFI application at %p ...\n", addr);
 330         r = do_bootefi_exec(addr, device_path, file_path);
 331         printf("## Application terminated, r = %lu\n",
 332                r & ~EFI_ERROR_MASK);
 333
 334         if (r != EFI_SUCCESS)
 335                 return 1;
 336
 337         return 0;
 338 }
 339
 340 /* Interpreter command to boot an arbitrary EFI image from memory */
 341 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 342 {
 343         unsigned long addr;
 344         char *saddr;
 345         efi_status_t r;
 346         void *fdt_addr;
 347
 348         /* Initialize EFI drivers */
 349         r = efi_init_obj_list();
 350         if (r != EFI_SUCCESS) {
 351                 printf("Error: Cannot set up EFI drivers, r = %lu\n",
 352                        r & ~EFI_ERROR_MASK);
 353                 return CMD_RET_FAILURE;
 354         }
 355
 356         if (argc < 2)
 357                 return CMD_RET_USAGE;
 358
 359         if (argc > 2) {
 360                 fdt_addr = (void *)simple_strtoul(argv[2], NULL, 16);
 361                 if (!fdt_addr && *argv[2] != '0')
 362                         return CMD_RET_USAGE;
 363                 /* Install device tree */
 364                 r = efi_install_fdt(fdt_addr);
 365                 if (r != EFI_SUCCESS) {
 366                         printf("ERROR: failed to install device tree\n");
 367                         return CMD_RET_FAILURE;
 368                 }
 369         } else {
 370                 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
 371                 efi_install_configuration_table(&efi_guid_fdt, NULL);
 372                 printf("WARNING: booting without device tree\n");
 373         }
 374 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 375         if (!strcmp(argv[1], "hello")) {
 376                 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
 377
 378                 saddr = env_get("loadaddr");
 379                 if (saddr)
 380                         addr = simple_strtoul(saddr, NULL, 16);
 381                 else
 382                         addr = CONFIG_SYS_LOAD_ADDR;
 383                 memcpy((char *)addr, __efi_helloworld_begin, size);
 384         } else
 385 #endif
 386 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 387         if (!strcmp(argv[1], "selftest")) {
 388                 struct efi_loaded_image loaded_image_info = {};
 389                 struct efi_object loaded_image_info_obj = {};
 390
 391                 /* Construct a dummy device path. */
 392                 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
 393                                                       (uintptr_t)&efi_selftest,
 394                                                       (uintptr_t)&efi_selftest);
 395                 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
 396
 397                 efi_setup_loaded_image(&loaded_image_info,
 398                                        &loaded_image_info_obj,
 399                                        bootefi_device_path, bootefi_image_path);
 400                 /*
 401                  * gd lives in a fixed register which may get clobbered while we
 402                  * execute the payload. So save it here and restore it on every
 403                  * callback entry
 404                  */
 405                 efi_save_gd();
 406                 /* Initialize and populate EFI object list */
 407                 efi_init_obj_list();
 408                 /* Transfer environment variable efi_selftest as load options */
 409                 set_load_options(&loaded_image_info, "efi_selftest");
 410                 /* Execute the test */
 411                 r = efi_selftest(loaded_image_info_obj.handle, &systab);
 412                 efi_restore_gd();
 413                 free(loaded_image_info.load_options);
 414                 list_del(&loaded_image_info_obj.link);
 415                 return r != EFI_SUCCESS;
 416         } else
 417 #endif
 418         if (!strcmp(argv[1], "bootmgr")) {
 419                 return do_bootefi_bootmgr_exec();
 420         } else {
 421                 saddr = argv[1];
 422
 423                 addr = simple_strtoul(saddr, NULL, 16);
 424                 /* Check that a numeric value was passed */
 425                 if (!addr && *saddr != '0')
 426                         return CMD_RET_USAGE;
 427
 428         }
 429
 430         printf("## Starting EFI application at %08lx ...\n", addr);
 431         r = do_bootefi_exec((void *)addr, bootefi_device_path,
 432                             bootefi_image_path);
 433         printf("## Application terminated, r = %lu\n",
 434                r & ~EFI_ERROR_MASK);
 435
 436         if (r != EFI_SUCCESS)
 437                 return 1;
 438         else
 439                 return 0;
 440 }
 441
 442 #ifdef CONFIG_SYS_LONGHELP
 443 static char bootefi_help_text[] =
 444         "<image address> [fdt address]\n"
 445         "  - boot EFI payload stored at address <image address>.\n"
 446         "    If specified, the device tree located at <fdt address> gets\n"
 447         "    exposed as EFI configuration table.\n"
 448 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 449         "bootefi hello\n"
 450         "  - boot a sample Hello World application stored within U-Boot\n"
 451 #endif
 452 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 453         "bootefi selftest [fdt address]\n"
 454         "  - boot an EFI selftest application stored within U-Boot\n"
 455         "    Use environment variable efi_selftest to select a single test.\n"
 456         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 457 #endif
 458         "bootefi bootmgr [fdt addr]\n"
 459         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
 460         "\n"
 461         "    If specified, the device tree located at <fdt address> gets\n"
 462         "    exposed as EFI configuration table.\n";
 463 #endif
 464
 465 U_BOOT_CMD(
 466         bootefi, 3, 0, do_bootefi,
 467         "Boots an EFI payload from memory",
 468         bootefi_help_text
 469 );
 470
 471 static int parse_partnum(const char *devnr)
 472 {
 473         const char *str = strchr(devnr, ':');
 474         if (str) {
 475                 str++;
 476                 return simple_strtoul(str, NULL, 16);
 477         }
 478         return 0;
 479 }
 480
 481 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 482 {
 483         char filename[32] = { 0 }; /* dp->str is u16[32] long */
 484         char *s;
 485
 486         if (strcmp(dev, "Net")) {
 487                 struct blk_desc *desc;
 488                 int part;
 489
 490                 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
 491                 if (!desc)
 492                         return;
 493                 part = parse_partnum(devnr);
 494
 495                 bootefi_device_path = efi_dp_from_part(desc, part);
 496         } else {
 497 #ifdef CONFIG_CMD_NET
 498                 bootefi_device_path = efi_dp_from_eth();
 499 #endif
 500         }
 501
 502         if (!path)
 503                 return;
 504
 505         if (strcmp(dev, "Net")) {
 506                 /* Add leading / to fs paths, because they're absolute */
 507                 snprintf(filename, sizeof(filename), "/%s", path);
 508         } else {
 509                 snprintf(filename, sizeof(filename), "%s", path);
 510         }
 511         /* DOS style file path: */
 512         s = filename;
 513         while ((s = strchr(s, '/')))
 514                 *s++ = '\\';
 515         bootefi_image_path = efi_dp_from_file(NULL, 0, filename);
 516 }