1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * EFI application loader 4 * 5 * Copyright (c) 2016 Alexander Graf 6 */ 7 8 #include <charset.h> 9 #include <common.h> 10 #include <command.h> 11 #include <dm.h> 12 #include <efi_loader.h> 13 #include <efi_selftest.h> 14 #include <errno.h> 15 #include <linux/libfdt.h> 16 #include <linux/libfdt_env.h> 17 #include <memalign.h> 18 #include <asm/global_data.h> 19 #include <asm-generic/sections.h> 20 #include <asm-generic/unaligned.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_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 * Allow unaligned memory access. 88 * 89 * This routine is overridden by architectures providing this feature. 90 */ 91 void __weak allow_unaligned(void) 92 { 93 } 94 95 /* 96 * Set the load options of an image from an environment variable. 97 * 98 * @loaded_image_info: the image 99 * @env_var: name of the environment variable 100 */ 101 static void set_load_options(struct efi_loaded_image *loaded_image_info, 102 const char *env_var) 103 { 104 size_t size; 105 const char *env = env_get(env_var); 106 107 loaded_image_info->load_options = NULL; 108 loaded_image_info->load_options_size = 0; 109 if (!env) 110 return; 111 size = strlen(env) + 1; 112 loaded_image_info->load_options = calloc(size, sizeof(u16)); 113 if (!loaded_image_info->load_options) { 114 printf("ERROR: Out of memory\n"); 115 return; 116 } 117 utf8_to_utf16(loaded_image_info->load_options, (u8 *)env, size); 118 loaded_image_info->load_options_size = size * 2; 119 } 120 121 static void *copy_fdt(void *fdt) 122 { 123 u64 fdt_size = fdt_totalsize(fdt); 124 unsigned long fdt_ram_start = -1L, fdt_pages; 125 u64 new_fdt_addr; 126 void *new_fdt; 127 int i; 128 129 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 130 u64 ram_start = gd->bd->bi_dram[i].start; 131 u64 ram_size = gd->bd->bi_dram[i].size; 132 133 if (!ram_size) 134 continue; 135 136 if (ram_start < fdt_ram_start) 137 fdt_ram_start = ram_start; 138 } 139 140 /* Give us at least 4kb breathing room */ 141 fdt_size = ALIGN(fdt_size + 4096, EFI_PAGE_SIZE); 142 fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 143 144 /* Safe fdt location is at 128MB */ 145 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size; 146 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, 147 EFI_RUNTIME_SERVICES_DATA, fdt_pages, 148 &new_fdt_addr) != EFI_SUCCESS) { 149 /* If we can't put it there, put it somewhere */ 150 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size); 151 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, 152 EFI_RUNTIME_SERVICES_DATA, fdt_pages, 153 &new_fdt_addr) != EFI_SUCCESS) { 154 printf("ERROR: Failed to reserve space for FDT\n"); 155 return NULL; 156 } 157 } 158 159 new_fdt = (void*)(ulong)new_fdt_addr; 160 memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 161 fdt_set_totalsize(new_fdt, fdt_size); 162 163 return new_fdt; 164 } 165 166 static efi_status_t efi_do_enter( 167 efi_handle_t image_handle, struct efi_system_table *st, 168 EFIAPI efi_status_t (*entry)( 169 efi_handle_t image_handle, 170 struct efi_system_table *st)) 171 { 172 efi_status_t ret = EFI_LOAD_ERROR; 173 174 if (entry) 175 ret = entry(image_handle, st); 176 st->boottime->exit(image_handle, ret, 0, NULL); 177 return ret; 178 } 179 180 #ifdef CONFIG_ARM64 181 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)( 182 efi_handle_t image_handle, struct efi_system_table *st), 183 efi_handle_t image_handle, struct efi_system_table *st) 184 { 185 /* Enable caches again */ 186 dcache_enable(); 187 188 return efi_do_enter(image_handle, st, entry); 189 } 190 #endif 191 192 /* Carve out DT reserved memory ranges */ 193 static efi_status_t efi_carve_out_dt_rsv(void *fdt) 194 { 195 int nr_rsv, i; 196 uint64_t addr, size, pages; 197 198 nr_rsv = fdt_num_mem_rsv(fdt); 199 200 /* Look for an existing entry and add it to the efi mem map. */ 201 for (i = 0; i < nr_rsv; i++) { 202 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0) 203 continue; 204 205 pages = ALIGN(size, EFI_PAGE_SIZE) >> EFI_PAGE_SHIFT; 206 efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE, 207 false); 208 } 209 210 return EFI_SUCCESS; 211 } 212 213 static efi_status_t efi_install_fdt(void *fdt) 214 { 215 bootm_headers_t img = { 0 }; 216 ulong fdt_pages, fdt_size, fdt_start, fdt_end; 217 efi_status_t ret; 218 219 if (fdt_check_header(fdt)) { 220 printf("ERROR: invalid device tree\n"); 221 return EFI_INVALID_PARAMETER; 222 } 223 224 /* Prepare fdt for payload */ 225 fdt = copy_fdt(fdt); 226 if (!fdt) 227 return EFI_OUT_OF_RESOURCES; 228 229 if (image_setup_libfdt(&img, fdt, 0, NULL)) { 230 printf("ERROR: failed to process device tree\n"); 231 return EFI_LOAD_ERROR; 232 } 233 234 if (efi_carve_out_dt_rsv(fdt) != EFI_SUCCESS) { 235 printf("ERROR: failed to carve out memory\n"); 236 return EFI_LOAD_ERROR; 237 } 238 239 /* Link to it in the efi tables */ 240 ret = efi_install_configuration_table(&efi_guid_fdt, fdt); 241 if (ret != EFI_SUCCESS) 242 return EFI_OUT_OF_RESOURCES; 243 244 /* And reserve the space in the memory map */ 245 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK; 246 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt); 247 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK; 248 fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 249 /* Give a bootloader the chance to modify the device tree */ 250 fdt_pages += 2; 251 ret = efi_add_memory_map(fdt_start, fdt_pages, 252 EFI_BOOT_SERVICES_DATA, true); 253 return ret; 254 } 255 256 /* 257 * Load an EFI payload into a newly allocated piece of memory, register all 258 * EFI objects it would want to access and jump to it. 259 */ 260 static efi_status_t do_bootefi_exec(void *efi, 261 struct efi_device_path *device_path, 262 struct efi_device_path *image_path) 263 { 264 struct efi_loaded_image loaded_image_info = {}; 265 struct efi_object loaded_image_info_obj = {}; 266 struct efi_object mem_obj = {}; 267 struct efi_device_path *memdp = NULL; 268 efi_status_t ret; 269 270 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle, 271 struct efi_system_table *st); 272 273 /* 274 * Special case for efi payload not loaded from disk, such as 275 * 'bootefi hello' or for example payload loaded directly into 276 * memory via jtag/etc: 277 */ 278 if (!device_path && !image_path) { 279 printf("WARNING: using memory device/image path, this may confuse some payloads!\n"); 280 /* actual addresses filled in after efi_load_pe() */ 281 memdp = efi_dp_from_mem(0, 0, 0); 282 device_path = image_path = memdp; 283 efi_add_handle(&mem_obj); 284 285 ret = efi_add_protocol(mem_obj.handle, &efi_guid_device_path, 286 device_path); 287 if (ret != EFI_SUCCESS) 288 goto exit; 289 } else { 290 assert(device_path && image_path); 291 } 292 293 efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj, 294 device_path, image_path); 295 296 /* 297 * gd lives in a fixed register which may get clobbered while we execute 298 * the payload. So save it here and restore it on every callback entry 299 */ 300 efi_save_gd(); 301 302 /* Transfer environment variable bootargs as load options */ 303 set_load_options(&loaded_image_info, "bootargs"); 304 /* Load the EFI payload */ 305 entry = efi_load_pe(efi, &loaded_image_info); 306 if (!entry) { 307 ret = EFI_LOAD_ERROR; 308 goto exit; 309 } 310 311 if (memdp) { 312 struct efi_device_path_memory *mdp = (void *)memdp; 313 mdp->memory_type = loaded_image_info.image_code_type; 314 mdp->start_address = (uintptr_t)loaded_image_info.image_base; 315 mdp->end_address = mdp->start_address + 316 loaded_image_info.image_size; 317 } 318 319 /* we don't support much: */ 320 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported", 321 "{ro,boot}(blob)0000000000000000"); 322 323 /* Call our payload! */ 324 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 325 326 if (setjmp(&loaded_image_info.exit_jmp)) { 327 ret = loaded_image_info.exit_status; 328 goto exit; 329 } 330 331 #ifdef CONFIG_ARM64 332 /* On AArch64 we need to make sure we call our payload in < EL3 */ 333 if (current_el() == 3) { 334 smp_kick_all_cpus(); 335 dcache_disable(); /* flush cache before switch to EL2 */ 336 337 /* Move into EL2 and keep running there */ 338 armv8_switch_to_el2((ulong)entry, 339 (ulong)&loaded_image_info_obj.handle, 340 (ulong)&systab, 0, (ulong)efi_run_in_el2, 341 ES_TO_AARCH64); 342 343 /* Should never reach here, efi exits with longjmp */ 344 while (1) { } 345 } 346 #endif 347 348 ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry); 349 350 exit: 351 /* image has returned, loaded-image obj goes *poof*: */ 352 list_del(&loaded_image_info_obj.link); 353 if (mem_obj.handle) 354 list_del(&mem_obj.link); 355 356 return ret; 357 } 358 359 static int do_bootefi_bootmgr_exec(void) 360 { 361 struct efi_device_path *device_path, *file_path; 362 void *addr; 363 efi_status_t r; 364 365 /* 366 * gd lives in a fixed register which may get clobbered while we execute 367 * the payload. So save it here and restore it on every callback entry 368 */ 369 efi_save_gd(); 370 371 addr = efi_bootmgr_load(&device_path, &file_path); 372 if (!addr) 373 return 1; 374 375 printf("## Starting EFI application at %p ...\n", addr); 376 r = do_bootefi_exec(addr, device_path, file_path); 377 printf("## Application terminated, r = %lu\n", 378 r & ~EFI_ERROR_MASK); 379 380 if (r != EFI_SUCCESS) 381 return 1; 382 383 return 0; 384 } 385 386 /* Interpreter command to boot an arbitrary EFI image from memory */ 387 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 388 { 389 unsigned long addr; 390 char *saddr; 391 efi_status_t r; 392 void *fdt_addr; 393 394 /* Allow unaligned memory access */ 395 allow_unaligned(); 396 397 /* Initialize EFI drivers */ 398 r = efi_init_obj_list(); 399 if (r != EFI_SUCCESS) { 400 printf("Error: Cannot set up EFI drivers, r = %lu\n", 401 r & ~EFI_ERROR_MASK); 402 return CMD_RET_FAILURE; 403 } 404 405 if (argc < 2) 406 return CMD_RET_USAGE; 407 408 if (argc > 2) { 409 fdt_addr = (void *)simple_strtoul(argv[2], NULL, 16); 410 if (!fdt_addr && *argv[2] != '0') 411 return CMD_RET_USAGE; 412 /* Install device tree */ 413 r = efi_install_fdt(fdt_addr); 414 if (r != EFI_SUCCESS) { 415 printf("ERROR: failed to install device tree\n"); 416 return CMD_RET_FAILURE; 417 } 418 } else { 419 /* Remove device tree. EFI_NOT_FOUND can be ignored here */ 420 efi_install_configuration_table(&efi_guid_fdt, NULL); 421 printf("WARNING: booting without device tree\n"); 422 } 423 #ifdef CONFIG_CMD_BOOTEFI_HELLO 424 if (!strcmp(argv[1], "hello")) { 425 ulong size = __efi_helloworld_end - __efi_helloworld_begin; 426 427 saddr = env_get("loadaddr"); 428 if (saddr) 429 addr = simple_strtoul(saddr, NULL, 16); 430 else 431 addr = CONFIG_SYS_LOAD_ADDR; 432 memcpy((char *)addr, __efi_helloworld_begin, size); 433 } else 434 #endif 435 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 436 if (!strcmp(argv[1], "selftest")) { 437 struct efi_loaded_image loaded_image_info = {}; 438 struct efi_object loaded_image_info_obj = {}; 439 440 /* Construct a dummy device path. */ 441 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 442 (uintptr_t)&efi_selftest, 443 (uintptr_t)&efi_selftest); 444 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest"); 445 446 efi_setup_loaded_image(&loaded_image_info, 447 &loaded_image_info_obj, 448 bootefi_device_path, bootefi_image_path); 449 /* 450 * gd lives in a fixed register which may get clobbered while we 451 * execute the payload. So save it here and restore it on every 452 * callback entry 453 */ 454 efi_save_gd(); 455 /* Transfer environment variable efi_selftest as load options */ 456 set_load_options(&loaded_image_info, "efi_selftest"); 457 /* Execute the test */ 458 r = efi_selftest(loaded_image_info_obj.handle, &systab); 459 efi_restore_gd(); 460 free(loaded_image_info.load_options); 461 list_del(&loaded_image_info_obj.link); 462 return r != EFI_SUCCESS; 463 } else 464 #endif 465 if (!strcmp(argv[1], "bootmgr")) { 466 return do_bootefi_bootmgr_exec(); 467 } else { 468 saddr = argv[1]; 469 470 addr = simple_strtoul(saddr, NULL, 16); 471 /* Check that a numeric value was passed */ 472 if (!addr && *saddr != '0') 473 return CMD_RET_USAGE; 474 475 } 476 477 printf("## Starting EFI application at %08lx ...\n", addr); 478 r = do_bootefi_exec((void *)addr, bootefi_device_path, 479 bootefi_image_path); 480 printf("## Application terminated, r = %lu\n", 481 r & ~EFI_ERROR_MASK); 482 483 if (r != EFI_SUCCESS) 484 return 1; 485 else 486 return 0; 487 } 488 489 #ifdef CONFIG_SYS_LONGHELP 490 static char bootefi_help_text[] = 491 "<image address> [fdt address]\n" 492 " - boot EFI payload stored at address <image address>.\n" 493 " If specified, the device tree located at <fdt address> gets\n" 494 " exposed as EFI configuration table.\n" 495 #ifdef CONFIG_CMD_BOOTEFI_HELLO 496 "bootefi hello\n" 497 " - boot a sample Hello World application stored within U-Boot\n" 498 #endif 499 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 500 "bootefi selftest [fdt address]\n" 501 " - boot an EFI selftest application stored within U-Boot\n" 502 " Use environment variable efi_selftest to select a single test.\n" 503 " Use 'setenv efi_selftest list' to enumerate all tests.\n" 504 #endif 505 "bootefi bootmgr [fdt addr]\n" 506 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n" 507 "\n" 508 " If specified, the device tree located at <fdt address> gets\n" 509 " exposed as EFI configuration table.\n"; 510 #endif 511 512 U_BOOT_CMD( 513 bootefi, 3, 0, do_bootefi, 514 "Boots an EFI payload from memory", 515 bootefi_help_text 516 ); 517 518 void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 519 { 520 char filename[32] = { 0 }; /* dp->str is u16[32] long */ 521 char *s; 522 523 if (strcmp(dev, "Net")) { 524 struct blk_desc *desc; 525 disk_partition_t fs_partition; 526 int part; 527 528 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition, 529 1); 530 if (part < 0) 531 return; 532 533 bootefi_device_path = efi_dp_from_part(desc, part); 534 } else { 535 #ifdef CONFIG_NET 536 bootefi_device_path = efi_dp_from_eth(); 537 #endif 538 } 539 540 if (!path) 541 return; 542 543 if (strcmp(dev, "Net")) { 544 /* Add leading / to fs paths, because they're absolute */ 545 snprintf(filename, sizeof(filename), "/%s", path); 546 } else { 547 snprintf(filename, sizeof(filename), "%s", path); 548 } 549 /* DOS style file path: */ 550 s = filename; 551 while ((s = strchr(s, '/'))) 552 *s++ = '\\'; 553 bootefi_image_path = efi_dp_from_file(NULL, 0, filename); 554 } 555