]> git.ipfire.org Git - thirdparty/u-boot.git/blob - cmd/bootefi.c
efi: Rename bootefi_test_finish() to bootefi_run_finish()
[thirdparty/u-boot.git] / cmd / bootefi.c
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 <mapmem.h>
18 #include <memalign.h>
19 #include <asm/global_data.h>
20 #include <asm-generic/sections.h>
21 #include <asm-generic/unaligned.h>
22 #include <linux/linkage.h>
23
24 #ifdef CONFIG_ARMV7_NONSEC
25 #include <asm/armv7.h>
26 #include <asm/secure.h>
27 #endif
28
29 DECLARE_GLOBAL_DATA_PTR;
30
31 #define OBJ_LIST_NOT_INITIALIZED 1
32
33 static efi_status_t efi_obj_list_initialized = OBJ_LIST_NOT_INITIALIZED;
34
35 static struct efi_device_path *bootefi_image_path;
36 static struct efi_device_path *bootefi_device_path;
37
38 /* Initialize and populate EFI object list */
39 efi_status_t efi_init_obj_list(void)
40 {
41 efi_status_t ret = EFI_SUCCESS;
42
43 /*
44 * On the ARM architecture gd is mapped to a fixed register (r9 or x18).
45 * As this register may be overwritten by an EFI payload we save it here
46 * and restore it on every callback entered.
47 */
48 efi_save_gd();
49
50 /* Initialize once only */
51 if (efi_obj_list_initialized != OBJ_LIST_NOT_INITIALIZED)
52 return efi_obj_list_initialized;
53
54 /* Initialize system table */
55 ret = efi_initialize_system_table();
56 if (ret != EFI_SUCCESS)
57 goto out;
58
59 /* Initialize root node */
60 ret = efi_root_node_register();
61 if (ret != EFI_SUCCESS)
62 goto out;
63
64 /* Initialize EFI driver uclass */
65 ret = efi_driver_init();
66 if (ret != EFI_SUCCESS)
67 goto out;
68
69 ret = efi_console_register();
70 if (ret != EFI_SUCCESS)
71 goto out;
72 #ifdef CONFIG_PARTITIONS
73 ret = efi_disk_register();
74 if (ret != EFI_SUCCESS)
75 goto out;
76 #endif
77 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
78 ret = efi_gop_register();
79 if (ret != EFI_SUCCESS)
80 goto out;
81 #endif
82 #ifdef CONFIG_NET
83 ret = efi_net_register();
84 if (ret != EFI_SUCCESS)
85 goto out;
86 #endif
87 #ifdef CONFIG_GENERATE_ACPI_TABLE
88 ret = efi_acpi_register();
89 if (ret != EFI_SUCCESS)
90 goto out;
91 #endif
92 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
93 ret = efi_smbios_register();
94 if (ret != EFI_SUCCESS)
95 goto out;
96 #endif
97 ret = efi_watchdog_register();
98 if (ret != EFI_SUCCESS)
99 goto out;
100
101 /* Initialize EFI runtime services */
102 ret = efi_reset_system_init();
103 if (ret != EFI_SUCCESS)
104 goto out;
105
106 out:
107 efi_obj_list_initialized = ret;
108 return ret;
109 }
110
111 /*
112 * Allow unaligned memory access.
113 *
114 * This routine is overridden by architectures providing this feature.
115 */
116 void __weak allow_unaligned(void)
117 {
118 }
119
120 /*
121 * Set the load options of an image from an environment variable.
122 *
123 * @loaded_image_info: the image
124 * @env_var: name of the environment variable
125 */
126 static void set_load_options(struct efi_loaded_image *loaded_image_info,
127 const char *env_var)
128 {
129 size_t size;
130 const char *env = env_get(env_var);
131 u16 *pos;
132
133 loaded_image_info->load_options = NULL;
134 loaded_image_info->load_options_size = 0;
135 if (!env)
136 return;
137 size = utf8_utf16_strlen(env) + 1;
138 loaded_image_info->load_options = calloc(size, sizeof(u16));
139 if (!loaded_image_info->load_options) {
140 printf("ERROR: Out of memory\n");
141 return;
142 }
143 pos = loaded_image_info->load_options;
144 utf8_utf16_strcpy(&pos, env);
145 loaded_image_info->load_options_size = size * 2;
146 }
147
148 /**
149 * copy_fdt() - Copy the device tree to a new location available to EFI
150 *
151 * The FDT is relocated into a suitable location within the EFI memory map.
152 * An additional 12KB is added to the space in case the device tree needs to be
153 * expanded later with fdt_open_into().
154 *
155 * @fdt_addr: On entry, address of start of FDT. On exit, address of relocated
156 * FDT start
157 * Return: status code
158 */
159 static efi_status_t copy_fdt(ulong *fdt_addrp)
160 {
161 unsigned long fdt_ram_start = -1L, fdt_pages;
162 efi_status_t ret = 0;
163 void *fdt, *new_fdt;
164 u64 new_fdt_addr;
165 uint fdt_size;
166 int i;
167
168 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
169 u64 ram_start = gd->bd->bi_dram[i].start;
170 u64 ram_size = gd->bd->bi_dram[i].size;
171
172 if (!ram_size)
173 continue;
174
175 if (ram_start < fdt_ram_start)
176 fdt_ram_start = ram_start;
177 }
178
179 /*
180 * Give us at least 4KB of breathing room in case the device tree needs
181 * to be expanded later. Round up to the nearest EFI page boundary.
182 */
183 fdt = map_sysmem(*fdt_addrp, 0);
184 fdt_size = fdt_totalsize(fdt);
185 fdt_size += 4096 * 3;
186 fdt_size = ALIGN(fdt_size + EFI_PAGE_SIZE - 1, EFI_PAGE_SIZE);
187 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
188
189 /* Safe fdt location is at 127MB */
190 new_fdt_addr = fdt_ram_start + (127 * 1024 * 1024) + fdt_size;
191 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
192 EFI_RUNTIME_SERVICES_DATA, fdt_pages,
193 &new_fdt_addr);
194 if (ret != EFI_SUCCESS) {
195 /* If we can't put it there, put it somewhere */
196 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
197 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
198 EFI_RUNTIME_SERVICES_DATA, fdt_pages,
199 &new_fdt_addr);
200 if (ret != EFI_SUCCESS) {
201 printf("ERROR: Failed to reserve space for FDT\n");
202 goto done;
203 }
204 }
205
206 new_fdt = map_sysmem(new_fdt_addr, fdt_size);
207 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
208 fdt_set_totalsize(new_fdt, fdt_size);
209
210 *fdt_addrp = new_fdt_addr;
211 done:
212 return ret;
213 }
214
215 static efi_status_t efi_do_enter(
216 efi_handle_t image_handle, struct efi_system_table *st,
217 EFIAPI efi_status_t (*entry)(
218 efi_handle_t image_handle,
219 struct efi_system_table *st))
220 {
221 efi_status_t ret = EFI_LOAD_ERROR;
222
223 if (entry)
224 ret = entry(image_handle, st);
225 st->boottime->exit(image_handle, ret, 0, NULL);
226 return ret;
227 }
228
229 #ifdef CONFIG_ARM64
230 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
231 efi_handle_t image_handle, struct efi_system_table *st),
232 efi_handle_t image_handle, struct efi_system_table *st)
233 {
234 /* Enable caches again */
235 dcache_enable();
236
237 return efi_do_enter(image_handle, st, entry);
238 }
239 #endif
240
241 #ifdef CONFIG_ARMV7_NONSEC
242 static bool is_nonsec;
243
244 static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)(
245 efi_handle_t image_handle, struct efi_system_table *st),
246 efi_handle_t image_handle, struct efi_system_table *st)
247 {
248 /* Enable caches again */
249 dcache_enable();
250
251 is_nonsec = true;
252
253 return efi_do_enter(image_handle, st, entry);
254 }
255 #endif
256
257 /*
258 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
259 *
260 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
261 * ignored because this is not critical and we would rather continue to try to
262 * boot.
263 *
264 * @fdt: Pointer to device tree
265 */
266 static void efi_carve_out_dt_rsv(void *fdt)
267 {
268 int nr_rsv, i;
269 uint64_t addr, size, pages;
270
271 nr_rsv = fdt_num_mem_rsv(fdt);
272
273 /* Look for an existing entry and add it to the efi mem map. */
274 for (i = 0; i < nr_rsv; i++) {
275 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
276 continue;
277
278 /*
279 * Do not carve out the device tree. It is already marked as
280 * EFI_RUNTIME_SERVICES_DATA
281 */
282 if (addr == (uintptr_t)fdt)
283 continue;
284
285 pages = ALIGN(size + (addr & EFI_PAGE_MASK), EFI_PAGE_SIZE) >>
286 EFI_PAGE_SHIFT;
287 addr &= ~EFI_PAGE_MASK;
288 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
289 false))
290 printf("FDT memrsv map %d: Failed to add to map\n", i);
291 }
292 }
293
294 static efi_status_t efi_install_fdt(ulong fdt_addr)
295 {
296 bootm_headers_t img = { 0 };
297 efi_status_t ret;
298 void *fdt;
299
300 fdt = map_sysmem(fdt_addr, 0);
301 if (fdt_check_header(fdt)) {
302 printf("ERROR: invalid device tree\n");
303 return EFI_INVALID_PARAMETER;
304 }
305
306 /* Prepare fdt for payload */
307 ret = copy_fdt(&fdt_addr);
308 if (ret)
309 return ret;
310
311 unmap_sysmem(fdt);
312 fdt = map_sysmem(fdt_addr, 0);
313 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
314 printf("ERROR: failed to process device tree\n");
315 return EFI_LOAD_ERROR;
316 }
317
318 efi_carve_out_dt_rsv(fdt);
319
320 /* Link to it in the efi tables */
321 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
322 if (ret != EFI_SUCCESS)
323 return EFI_OUT_OF_RESOURCES;
324
325 return ret;
326 }
327
328 static efi_status_t bootefi_run_prepare(const char *load_options_path,
329 struct efi_device_path *device_path,
330 struct efi_device_path *image_path,
331 struct efi_loaded_image_obj **image_objp,
332 struct efi_loaded_image **loaded_image_infop)
333 {
334 efi_status_t ret;
335
336 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
337 loaded_image_infop);
338 if (ret != EFI_SUCCESS)
339 return ret;
340
341 /* Transfer environment variable as load options */
342 set_load_options(*loaded_image_infop, load_options_path);
343
344 return 0;
345 }
346
347 /**
348 * bootefi_run_finish() - finish up after running an EFI test
349 *
350 * @loaded_image_info: Pointer to a struct which holds the loaded image info
351 * @image_objj: Pointer to a struct which holds the loaded image object
352 */
353 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
354 struct efi_loaded_image *loaded_image_info)
355 {
356 efi_restore_gd();
357 free(loaded_image_info->load_options);
358 efi_delete_handle(&image_obj->header);
359 }
360
361 /**
362 * do_bootefi_exec() - execute EFI binary
363 *
364 * @efi: address of the binary
365 * @device_path: path of the device from which the binary was loaded
366 * @image_path: device path of the binary
367 * Return: status code
368 *
369 * Load the EFI binary into a newly assigned memory unwinding the relocation
370 * information, install the loaded image protocol, and call the binary.
371 */
372 static efi_status_t do_bootefi_exec(void *efi,
373 struct efi_device_path *device_path,
374 struct efi_device_path *image_path)
375 {
376 efi_handle_t mem_handle = NULL;
377 struct efi_device_path *memdp = NULL;
378 efi_status_t ret;
379 struct efi_loaded_image_obj *image_obj = NULL;
380 struct efi_loaded_image *loaded_image_info = NULL;
381
382 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
383 struct efi_system_table *st);
384
385 /*
386 * Special case for efi payload not loaded from disk, such as
387 * 'bootefi hello' or for example payload loaded directly into
388 * memory via JTAG, etc:
389 */
390 if (!device_path && !image_path) {
391 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
392 /* actual addresses filled in after efi_load_pe() */
393 memdp = efi_dp_from_mem(0, 0, 0);
394 device_path = image_path = memdp;
395 /*
396 * Grub expects that the device path of the loaded image is
397 * installed on a handle.
398 */
399 ret = efi_create_handle(&mem_handle);
400 if (ret != EFI_SUCCESS)
401 return ret; /* TODO: leaks device_path */
402 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
403 device_path);
404 if (ret != EFI_SUCCESS)
405 goto err_add_protocol;
406 } else {
407 assert(device_path && image_path);
408 }
409
410 ret = bootefi_run_prepare("bootargs", device_path, image_path,
411 &image_obj, &loaded_image_info);
412 if (ret)
413 goto err_prepare;
414
415 /* Load the EFI payload */
416 entry = efi_load_pe(image_obj, efi, loaded_image_info);
417 if (!entry) {
418 ret = EFI_LOAD_ERROR;
419 goto err_prepare;
420 }
421
422 if (memdp) {
423 struct efi_device_path_memory *mdp = (void *)memdp;
424 mdp->memory_type = loaded_image_info->image_code_type;
425 mdp->start_address = (uintptr_t)loaded_image_info->image_base;
426 mdp->end_address = mdp->start_address +
427 loaded_image_info->image_size;
428 }
429
430 /* we don't support much: */
431 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
432 "{ro,boot}(blob)0000000000000000");
433
434 /* Call our payload! */
435 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
436
437 if (setjmp(&image_obj->exit_jmp)) {
438 ret = image_obj->exit_status;
439 goto err_prepare;
440 }
441
442 #ifdef CONFIG_ARM64
443 /* On AArch64 we need to make sure we call our payload in < EL3 */
444 if (current_el() == 3) {
445 smp_kick_all_cpus();
446 dcache_disable(); /* flush cache before switch to EL2 */
447
448 /* Move into EL2 and keep running there */
449 armv8_switch_to_el2((ulong)entry,
450 (ulong)&image_obj->header,
451 (ulong)&systab, 0, (ulong)efi_run_in_el2,
452 ES_TO_AARCH64);
453
454 /* Should never reach here, efi exits with longjmp */
455 while (1) { }
456 }
457 #endif
458
459 #ifdef CONFIG_ARMV7_NONSEC
460 if (armv7_boot_nonsec() && !is_nonsec) {
461 dcache_disable(); /* flush cache before switch to HYP */
462
463 armv7_init_nonsec();
464 secure_ram_addr(_do_nonsec_entry)(
465 efi_run_in_hyp,
466 (uintptr_t)entry,
467 (uintptr_t)&image_obj->header,
468 (uintptr_t)&systab);
469
470 /* Should never reach here, efi exits with longjmp */
471 while (1) { }
472 }
473 #endif
474
475 ret = efi_do_enter(&image_obj->header, &systab, entry);
476
477 err_prepare:
478 /* image has returned, loaded-image obj goes *poof*: */
479 bootefi_run_finish(image_obj, loaded_image_info);
480
481 err_add_protocol:
482 if (mem_handle)
483 efi_delete_handle(mem_handle);
484
485 return ret;
486 }
487
488 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
489 /**
490 * bootefi_test_prepare() - prepare to run an EFI test
491 *
492 * This sets things up so we can call EFI functions. This involves preparing
493 * the 'gd' pointer and setting up the load ed image data structures.
494 *
495 * @image_objp: loaded_image_infop: Pointer to a struct which will hold the
496 * loaded image object. This struct will be inited by this function before
497 * use.
498 * @loaded_image_infop: Pointer to a struct which will hold the loaded image
499 * info. This struct will be inited by this function before use.
500 * @path: File path to the test being run (often just the test name with a
501 * backslash before it
502 * @test_func: Address of the test function that is being run
503 * @load_options_path: U-Boot environment variable to use as load options
504 * @return 0 if OK, -ve on error
505 */
506 static efi_status_t bootefi_test_prepare
507 (struct efi_loaded_image_obj **image_objp,
508 struct efi_loaded_image **loaded_image_infop, const char *path,
509 ulong test_func, const char *load_options_path)
510 {
511 /* Construct a dummy device path */
512 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
513 (uintptr_t)test_func,
514 (uintptr_t)test_func);
515 if (!bootefi_device_path)
516 return EFI_OUT_OF_RESOURCES;
517 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
518 if (!bootefi_image_path)
519 return EFI_OUT_OF_RESOURCES;
520
521 return bootefi_run_prepare(load_options_path, bootefi_device_path,
522 bootefi_image_path, image_objp,
523 loaded_image_infop);
524 }
525
526 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
527
528 static int do_bootefi_bootmgr_exec(void)
529 {
530 struct efi_device_path *device_path, *file_path;
531 void *addr;
532 efi_status_t r;
533
534 addr = efi_bootmgr_load(&device_path, &file_path);
535 if (!addr)
536 return 1;
537
538 printf("## Starting EFI application at %p ...\n", addr);
539 r = do_bootefi_exec(addr, device_path, file_path);
540 printf("## Application terminated, r = %lu\n",
541 r & ~EFI_ERROR_MASK);
542
543 if (r != EFI_SUCCESS)
544 return 1;
545
546 return 0;
547 }
548
549 /* Interpreter command to boot an arbitrary EFI image from memory */
550 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
551 {
552 unsigned long addr;
553 char *saddr;
554 efi_status_t r;
555 unsigned long fdt_addr;
556
557 /* Allow unaligned memory access */
558 allow_unaligned();
559
560 /* Initialize EFI drivers */
561 r = efi_init_obj_list();
562 if (r != EFI_SUCCESS) {
563 printf("Error: Cannot set up EFI drivers, r = %lu\n",
564 r & ~EFI_ERROR_MASK);
565 return CMD_RET_FAILURE;
566 }
567
568 if (argc < 2)
569 return CMD_RET_USAGE;
570
571 if (argc > 2) {
572 fdt_addr = simple_strtoul(argv[2], NULL, 16);
573 if (!fdt_addr && *argv[2] != '0')
574 return CMD_RET_USAGE;
575 /* Install device tree */
576 r = efi_install_fdt(fdt_addr);
577 if (r != EFI_SUCCESS) {
578 printf("ERROR: failed to install device tree\n");
579 return CMD_RET_FAILURE;
580 }
581 } else {
582 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
583 efi_install_configuration_table(&efi_guid_fdt, NULL);
584 printf("WARNING: booting without device tree\n");
585 }
586 #ifdef CONFIG_CMD_BOOTEFI_HELLO
587 if (!strcmp(argv[1], "hello")) {
588 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
589
590 saddr = env_get("loadaddr");
591 if (saddr)
592 addr = simple_strtoul(saddr, NULL, 16);
593 else
594 addr = CONFIG_SYS_LOAD_ADDR;
595 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
596 } else
597 #endif
598 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
599 if (!strcmp(argv[1], "selftest")) {
600 struct efi_loaded_image_obj *image_obj;
601 struct efi_loaded_image *loaded_image_info;
602
603 if (bootefi_test_prepare(&image_obj, &loaded_image_info,
604 "\\selftest", (uintptr_t)&efi_selftest,
605 "efi_selftest"))
606 return CMD_RET_FAILURE;
607
608 /* Execute the test */
609 r = efi_selftest(&image_obj->header, &systab);
610 bootefi_run_finish(image_obj, loaded_image_info);
611 return r != EFI_SUCCESS;
612 } else
613 #endif
614 if (!strcmp(argv[1], "bootmgr")) {
615 return do_bootefi_bootmgr_exec();
616 } else {
617 saddr = argv[1];
618
619 addr = simple_strtoul(saddr, NULL, 16);
620 /* Check that a numeric value was passed */
621 if (!addr && *saddr != '0')
622 return CMD_RET_USAGE;
623
624 }
625
626 printf("## Starting EFI application at %08lx ...\n", addr);
627 r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
628 bootefi_image_path);
629 printf("## Application terminated, r = %lu\n",
630 r & ~EFI_ERROR_MASK);
631
632 if (r != EFI_SUCCESS)
633 return 1;
634 else
635 return 0;
636 }
637
638 #ifdef CONFIG_SYS_LONGHELP
639 static char bootefi_help_text[] =
640 "<image address> [fdt address]\n"
641 " - boot EFI payload stored at address <image address>.\n"
642 " If specified, the device tree located at <fdt address> gets\n"
643 " exposed as EFI configuration table.\n"
644 #ifdef CONFIG_CMD_BOOTEFI_HELLO
645 "bootefi hello\n"
646 " - boot a sample Hello World application stored within U-Boot\n"
647 #endif
648 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
649 "bootefi selftest [fdt address]\n"
650 " - boot an EFI selftest application stored within U-Boot\n"
651 " Use environment variable efi_selftest to select a single test.\n"
652 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
653 #endif
654 "bootefi bootmgr [fdt addr]\n"
655 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
656 "\n"
657 " If specified, the device tree located at <fdt address> gets\n"
658 " exposed as EFI configuration table.\n";
659 #endif
660
661 U_BOOT_CMD(
662 bootefi, 3, 0, do_bootefi,
663 "Boots an EFI payload from memory",
664 bootefi_help_text
665 );
666
667 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
668 {
669 struct efi_device_path *device, *image;
670 efi_status_t ret;
671
672 /* efi_set_bootdev is typically called repeatedly, recover memory */
673 efi_free_pool(bootefi_device_path);
674 efi_free_pool(bootefi_image_path);
675
676 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
677 if (ret == EFI_SUCCESS) {
678 bootefi_device_path = device;
679 bootefi_image_path = image;
680 } else {
681 bootefi_device_path = NULL;
682 bootefi_image_path = NULL;
683 }
684 }