efi_loader: macro efi_size_in_pages()
[oweals/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  * Additional 12 KiB are 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 12 KiB of breathing room in case the device tree
181          * needs to be expanded later.
182          */
183         fdt = map_sysmem(*fdt_addrp, 0);
184         fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
185         fdt_size = fdt_pages << EFI_PAGE_SHIFT;
186
187         /* Safe fdt location is at 127MB */
188         new_fdt_addr = fdt_ram_start + (127 * 1024 * 1024) + fdt_size;
189         ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
190                                  EFI_RUNTIME_SERVICES_DATA, fdt_pages,
191                                  &new_fdt_addr);
192         if (ret != EFI_SUCCESS) {
193                 /* If we can't put it there, put it somewhere */
194                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
195                 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
196                                          EFI_RUNTIME_SERVICES_DATA, fdt_pages,
197                                          &new_fdt_addr);
198                 if (ret != EFI_SUCCESS) {
199                         printf("ERROR: Failed to reserve space for FDT\n");
200                         goto done;
201                 }
202         }
203
204         new_fdt = map_sysmem(new_fdt_addr, fdt_size);
205         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
206         fdt_set_totalsize(new_fdt, fdt_size);
207
208         *fdt_addrp = new_fdt_addr;
209 done:
210         return ret;
211 }
212
213 static efi_status_t efi_do_enter(
214                         efi_handle_t image_handle, struct efi_system_table *st,
215                         EFIAPI efi_status_t (*entry)(
216                                 efi_handle_t image_handle,
217                                 struct efi_system_table *st))
218 {
219         efi_status_t ret = EFI_LOAD_ERROR;
220
221         if (entry)
222                 ret = entry(image_handle, st);
223         st->boottime->exit(image_handle, ret, 0, NULL);
224         return ret;
225 }
226
227 #ifdef CONFIG_ARM64
228 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
229                         efi_handle_t image_handle, struct efi_system_table *st),
230                         efi_handle_t image_handle, struct efi_system_table *st)
231 {
232         /* Enable caches again */
233         dcache_enable();
234
235         return efi_do_enter(image_handle, st, entry);
236 }
237 #endif
238
239 #ifdef CONFIG_ARMV7_NONSEC
240 static bool is_nonsec;
241
242 static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)(
243                         efi_handle_t image_handle, struct efi_system_table *st),
244                         efi_handle_t image_handle, struct efi_system_table *st)
245 {
246         /* Enable caches again */
247         dcache_enable();
248
249         is_nonsec = true;
250
251         return efi_do_enter(image_handle, st, entry);
252 }
253 #endif
254
255 /*
256  * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
257  *
258  * The mem_rsv entries of the FDT are added to the memory map. Any failures are
259  * ignored because this is not critical and we would rather continue to try to
260  * boot.
261  *
262  * @fdt: Pointer to device tree
263  */
264 static void efi_carve_out_dt_rsv(void *fdt)
265 {
266         int nr_rsv, i;
267         uint64_t addr, size, pages;
268
269         nr_rsv = fdt_num_mem_rsv(fdt);
270
271         /* Look for an existing entry and add it to the efi mem map. */
272         for (i = 0; i < nr_rsv; i++) {
273                 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
274                         continue;
275
276                 /*
277                  * Do not carve out the device tree. It is already marked as
278                  * EFI_RUNTIME_SERVICES_DATA
279                  */
280                 if (addr == (uintptr_t)fdt)
281                         continue;
282
283                 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
284                 addr &= ~EFI_PAGE_MASK;
285                 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
286                                         false))
287                         printf("FDT memrsv map %d: Failed to add to map\n", i);
288         }
289 }
290
291 static efi_status_t efi_install_fdt(ulong fdt_addr)
292 {
293         bootm_headers_t img = { 0 };
294         efi_status_t ret;
295         void *fdt;
296
297         fdt = map_sysmem(fdt_addr, 0);
298         if (fdt_check_header(fdt)) {
299                 printf("ERROR: invalid device tree\n");
300                 return EFI_INVALID_PARAMETER;
301         }
302
303         /* Prepare fdt for payload */
304         ret = copy_fdt(&fdt_addr);
305         if (ret)
306                 return ret;
307
308         unmap_sysmem(fdt);
309         fdt = map_sysmem(fdt_addr, 0);
310         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
311                 printf("ERROR: failed to process device tree\n");
312                 return EFI_LOAD_ERROR;
313         }
314
315         efi_carve_out_dt_rsv(fdt);
316
317         /* Link to it in the efi tables */
318         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
319         if (ret != EFI_SUCCESS)
320                 return EFI_OUT_OF_RESOURCES;
321
322         return ret;
323 }
324
325 static efi_status_t bootefi_run_prepare(const char *load_options_path,
326                 struct efi_device_path *device_path,
327                 struct efi_device_path *image_path,
328                 struct efi_loaded_image_obj **image_objp,
329                 struct efi_loaded_image **loaded_image_infop)
330 {
331         efi_status_t ret;
332
333         ret = efi_setup_loaded_image(device_path, image_path, image_objp,
334                                      loaded_image_infop);
335         if (ret != EFI_SUCCESS)
336                 return ret;
337
338         /* Transfer environment variable as load options */
339         set_load_options(*loaded_image_infop, load_options_path);
340
341         return 0;
342 }
343
344 /**
345  * bootefi_run_finish() - finish up after running an EFI test
346  *
347  * @loaded_image_info: Pointer to a struct which holds the loaded image info
348  * @image_objj: Pointer to a struct which holds the loaded image object
349  */
350 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
351                                struct efi_loaded_image *loaded_image_info)
352 {
353         efi_restore_gd();
354         free(loaded_image_info->load_options);
355         efi_delete_handle(&image_obj->header);
356 }
357
358 /**
359  * do_bootefi_exec() - execute EFI binary
360  *
361  * @efi:                address of the binary
362  * @device_path:        path of the device from which the binary was loaded
363  * @image_path:         device path of the binary
364  * Return:              status code
365  *
366  * Load the EFI binary into a newly assigned memory unwinding the relocation
367  * information, install the loaded image protocol, and call the binary.
368  */
369 static efi_status_t do_bootefi_exec(void *efi,
370                                     struct efi_device_path *device_path,
371                                     struct efi_device_path *image_path)
372 {
373         efi_handle_t mem_handle = NULL;
374         struct efi_device_path *memdp = NULL;
375         efi_status_t ret;
376         struct efi_loaded_image_obj *image_obj = NULL;
377         struct efi_loaded_image *loaded_image_info = NULL;
378
379         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
380                                      struct efi_system_table *st);
381
382         /*
383          * Special case for efi payload not loaded from disk, such as
384          * 'bootefi hello' or for example payload loaded directly into
385          * memory via JTAG, etc:
386          */
387         if (!device_path && !image_path) {
388                 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
389                 /* actual addresses filled in after efi_load_pe() */
390                 memdp = efi_dp_from_mem(0, 0, 0);
391                 device_path = image_path = memdp;
392                 /*
393                  * Grub expects that the device path of the loaded image is
394                  * installed on a handle.
395                  */
396                 ret = efi_create_handle(&mem_handle);
397                 if (ret != EFI_SUCCESS)
398                         return ret; /* TODO: leaks device_path */
399                 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
400                                        device_path);
401                 if (ret != EFI_SUCCESS)
402                         goto err_add_protocol;
403         } else {
404                 assert(device_path && image_path);
405         }
406
407         ret = bootefi_run_prepare("bootargs", device_path, image_path,
408                                   &image_obj, &loaded_image_info);
409         if (ret)
410                 goto err_prepare;
411
412         /* Load the EFI payload */
413         entry = efi_load_pe(image_obj, efi, loaded_image_info);
414         if (!entry) {
415                 ret = EFI_LOAD_ERROR;
416                 goto err_prepare;
417         }
418
419         if (memdp) {
420                 struct efi_device_path_memory *mdp = (void *)memdp;
421                 mdp->memory_type = loaded_image_info->image_code_type;
422                 mdp->start_address = (uintptr_t)loaded_image_info->image_base;
423                 mdp->end_address = mdp->start_address +
424                                 loaded_image_info->image_size;
425         }
426
427         /* we don't support much: */
428         env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
429                 "{ro,boot}(blob)0000000000000000");
430
431         /* Call our payload! */
432         debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
433
434         if (setjmp(&image_obj->exit_jmp)) {
435                 ret = image_obj->exit_status;
436                 goto err_prepare;
437         }
438
439 #ifdef CONFIG_ARM64
440         /* On AArch64 we need to make sure we call our payload in < EL3 */
441         if (current_el() == 3) {
442                 smp_kick_all_cpus();
443                 dcache_disable();       /* flush cache before switch to EL2 */
444
445                 /* Move into EL2 and keep running there */
446                 armv8_switch_to_el2((ulong)entry,
447                                     (ulong)&image_obj->header,
448                                     (ulong)&systab, 0, (ulong)efi_run_in_el2,
449                                     ES_TO_AARCH64);
450
451                 /* Should never reach here, efi exits with longjmp */
452                 while (1) { }
453         }
454 #endif
455
456 #ifdef CONFIG_ARMV7_NONSEC
457         if (armv7_boot_nonsec() && !is_nonsec) {
458                 dcache_disable();       /* flush cache before switch to HYP */
459
460                 armv7_init_nonsec();
461                 secure_ram_addr(_do_nonsec_entry)(
462                                         efi_run_in_hyp,
463                                         (uintptr_t)entry,
464                                         (uintptr_t)&image_obj->header,
465                                         (uintptr_t)&systab);
466
467                 /* Should never reach here, efi exits with longjmp */
468                 while (1) { }
469         }
470 #endif
471
472         ret = efi_do_enter(&image_obj->header, &systab, entry);
473
474 err_prepare:
475         /* image has returned, loaded-image obj goes *poof*: */
476         bootefi_run_finish(image_obj, loaded_image_info);
477
478 err_add_protocol:
479         if (mem_handle)
480                 efi_delete_handle(mem_handle);
481
482         return ret;
483 }
484
485 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
486 /**
487  * bootefi_test_prepare() - prepare to run an EFI test
488  *
489  * This sets things up so we can call EFI functions. This involves preparing
490  * the 'gd' pointer and setting up the load ed image data structures.
491  *
492  * @image_objp: loaded_image_infop: Pointer to a struct which will hold the
493  *    loaded image object. This struct will be inited by this function before
494  *    use.
495  * @loaded_image_infop: Pointer to a struct which will hold the loaded image
496  *    info. This struct will be inited by this function before use.
497  * @path: File path to the test being run (often just the test name with a
498  *    backslash before it
499  * @test_func: Address of the test function that is being run
500  * @load_options_path: U-Boot environment variable to use as load options
501  * @return 0 if OK, -ve on error
502  */
503 static efi_status_t bootefi_test_prepare
504                 (struct efi_loaded_image_obj **image_objp,
505                 struct efi_loaded_image **loaded_image_infop, const char *path,
506                 ulong test_func, const char *load_options_path)
507 {
508         /* Construct a dummy device path */
509         bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
510                                               (uintptr_t)test_func,
511                                               (uintptr_t)test_func);
512         if (!bootefi_device_path)
513                 return EFI_OUT_OF_RESOURCES;
514         bootefi_image_path = efi_dp_from_file(NULL, 0, path);
515         if (!bootefi_image_path)
516                 return EFI_OUT_OF_RESOURCES;
517
518         return bootefi_run_prepare(load_options_path, bootefi_device_path,
519                                    bootefi_image_path, image_objp,
520                                    loaded_image_infop);
521 }
522
523 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
524
525 static int do_bootefi_bootmgr_exec(void)
526 {
527         struct efi_device_path *device_path, *file_path;
528         void *addr;
529         efi_status_t r;
530
531         addr = efi_bootmgr_load(&device_path, &file_path);
532         if (!addr)
533                 return 1;
534
535         printf("## Starting EFI application at %p ...\n", addr);
536         r = do_bootefi_exec(addr, device_path, file_path);
537         printf("## Application terminated, r = %lu\n",
538                r & ~EFI_ERROR_MASK);
539
540         if (r != EFI_SUCCESS)
541                 return 1;
542
543         return 0;
544 }
545
546 /* Interpreter command to boot an arbitrary EFI image from memory */
547 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
548 {
549         unsigned long addr;
550         char *saddr;
551         efi_status_t r;
552         unsigned long fdt_addr;
553
554         /* Allow unaligned memory access */
555         allow_unaligned();
556
557         /* Initialize EFI drivers */
558         r = efi_init_obj_list();
559         if (r != EFI_SUCCESS) {
560                 printf("Error: Cannot set up EFI drivers, r = %lu\n",
561                        r & ~EFI_ERROR_MASK);
562                 return CMD_RET_FAILURE;
563         }
564
565         if (argc < 2)
566                 return CMD_RET_USAGE;
567
568         if (argc > 2) {
569                 fdt_addr = simple_strtoul(argv[2], NULL, 16);
570                 if (!fdt_addr && *argv[2] != '0')
571                         return CMD_RET_USAGE;
572                 /* Install device tree */
573                 r = efi_install_fdt(fdt_addr);
574                 if (r != EFI_SUCCESS) {
575                         printf("ERROR: failed to install device tree\n");
576                         return CMD_RET_FAILURE;
577                 }
578         } else {
579                 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
580                 efi_install_configuration_table(&efi_guid_fdt, NULL);
581                 printf("WARNING: booting without device tree\n");
582         }
583 #ifdef CONFIG_CMD_BOOTEFI_HELLO
584         if (!strcmp(argv[1], "hello")) {
585                 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
586
587                 saddr = env_get("loadaddr");
588                 if (saddr)
589                         addr = simple_strtoul(saddr, NULL, 16);
590                 else
591                         addr = CONFIG_SYS_LOAD_ADDR;
592                 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
593         } else
594 #endif
595 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
596         if (!strcmp(argv[1], "selftest")) {
597                 struct efi_loaded_image_obj *image_obj;
598                 struct efi_loaded_image *loaded_image_info;
599
600                 if (bootefi_test_prepare(&image_obj, &loaded_image_info,
601                                          "\\selftest", (uintptr_t)&efi_selftest,
602                                          "efi_selftest"))
603                         return CMD_RET_FAILURE;
604
605                 /* Execute the test */
606                 r = efi_selftest(&image_obj->header, &systab);
607                 bootefi_run_finish(image_obj, loaded_image_info);
608                 return r != EFI_SUCCESS;
609         } else
610 #endif
611         if (!strcmp(argv[1], "bootmgr")) {
612                 return do_bootefi_bootmgr_exec();
613         } else {
614                 saddr = argv[1];
615
616                 addr = simple_strtoul(saddr, NULL, 16);
617                 /* Check that a numeric value was passed */
618                 if (!addr && *saddr != '0')
619                         return CMD_RET_USAGE;
620
621         }
622
623         printf("## Starting EFI application at %08lx ...\n", addr);
624         r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
625                             bootefi_image_path);
626         printf("## Application terminated, r = %lu\n",
627                r & ~EFI_ERROR_MASK);
628
629         if (r != EFI_SUCCESS)
630                 return 1;
631         else
632                 return 0;
633 }
634
635 #ifdef CONFIG_SYS_LONGHELP
636 static char bootefi_help_text[] =
637         "<image address> [fdt address]\n"
638         "  - boot EFI payload stored at address <image address>.\n"
639         "    If specified, the device tree located at <fdt address> gets\n"
640         "    exposed as EFI configuration table.\n"
641 #ifdef CONFIG_CMD_BOOTEFI_HELLO
642         "bootefi hello\n"
643         "  - boot a sample Hello World application stored within U-Boot\n"
644 #endif
645 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
646         "bootefi selftest [fdt address]\n"
647         "  - boot an EFI selftest application stored within U-Boot\n"
648         "    Use environment variable efi_selftest to select a single test.\n"
649         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
650 #endif
651         "bootefi bootmgr [fdt addr]\n"
652         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
653         "\n"
654         "    If specified, the device tree located at <fdt address> gets\n"
655         "    exposed as EFI configuration table.\n";
656 #endif
657
658 U_BOOT_CMD(
659         bootefi, 3, 0, do_bootefi,
660         "Boots an EFI payload from memory",
661         bootefi_help_text
662 );
663
664 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
665 {
666         struct efi_device_path *device, *image;
667         efi_status_t ret;
668
669         /* efi_set_bootdev is typically called repeatedly, recover memory */
670         efi_free_pool(bootefi_device_path);
671         efi_free_pool(bootefi_image_path);
672
673         ret = efi_dp_from_name(dev, devnr, path, &device, &image);
674         if (ret == EFI_SUCCESS) {
675                 bootefi_device_path = device;
676                 bootefi_image_path = image;
677         } else {
678                 bootefi_device_path = NULL;
679                 bootefi_image_path = NULL;
680         }
681 }