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