efi_loader: carve out efi_run_image()
[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 <common.h>
9 #include <charset.h>
10 #include <command.h>
11 #include <dm.h>
12 #include <efi_loader.h>
13 #include <efi_selftest.h>
14 #include <env.h>
15 #include <errno.h>
16 #include <linux/libfdt.h>
17 #include <linux/libfdt_env.h>
18 #include <mapmem.h>
19 #include <memalign.h>
20 #include <asm-generic/sections.h>
21 #include <linux/linkage.h>
22
23 DECLARE_GLOBAL_DATA_PTR;
24
25 static struct efi_device_path *bootefi_image_path;
26 static struct efi_device_path *bootefi_device_path;
27
28 /**
29  * Set the load options of an image from an environment variable.
30  *
31  * @handle:     the image handle
32  * @env_var:    name of the environment variable
33  * Return:      status code
34  */
35 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
36 {
37         struct efi_loaded_image *loaded_image_info;
38         size_t size;
39         const char *env = env_get(env_var);
40         u16 *pos;
41         efi_status_t ret;
42
43         ret = EFI_CALL(systab.boottime->open_protocol(
44                                         handle,
45                                         &efi_guid_loaded_image,
46                                         (void **)&loaded_image_info,
47                                         efi_root, NULL,
48                                         EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
49         if (ret != EFI_SUCCESS)
50                 return EFI_INVALID_PARAMETER;
51
52         loaded_image_info->load_options = NULL;
53         loaded_image_info->load_options_size = 0;
54         if (!env)
55                 goto out;
56
57         size = utf8_utf16_strlen(env) + 1;
58         loaded_image_info->load_options = calloc(size, sizeof(u16));
59         if (!loaded_image_info->load_options) {
60                 printf("ERROR: Out of memory\n");
61                 EFI_CALL(systab.boottime->close_protocol(handle,
62                                                          &efi_guid_loaded_image,
63                                                          efi_root, NULL));
64                 return EFI_OUT_OF_RESOURCES;
65         }
66         pos = loaded_image_info->load_options;
67         utf8_utf16_strcpy(&pos, env);
68         loaded_image_info->load_options_size = size * 2;
69
70 out:
71         return EFI_CALL(systab.boottime->close_protocol(handle,
72                                                         &efi_guid_loaded_image,
73                                                         efi_root, NULL));
74 }
75
76 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
77
78 /**
79  * copy_fdt() - Copy the device tree to a new location available to EFI
80  *
81  * The FDT is copied to a suitable location within the EFI memory map.
82  * Additional 12 KiB are added to the space in case the device tree needs to be
83  * expanded later with fdt_open_into().
84  *
85  * @fdtp:       On entry a pointer to the flattened device tree.
86  *              On exit a pointer to the copy of the flattened device tree.
87  *              FDT start
88  * Return:      status code
89  */
90 static efi_status_t copy_fdt(void **fdtp)
91 {
92         unsigned long fdt_ram_start = -1L, fdt_pages;
93         efi_status_t ret = 0;
94         void *fdt, *new_fdt;
95         u64 new_fdt_addr;
96         uint fdt_size;
97         int i;
98
99         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
100                 u64 ram_start = gd->bd->bi_dram[i].start;
101                 u64 ram_size = gd->bd->bi_dram[i].size;
102
103                 if (!ram_size)
104                         continue;
105
106                 if (ram_start < fdt_ram_start)
107                         fdt_ram_start = ram_start;
108         }
109
110         /*
111          * Give us at least 12 KiB of breathing room in case the device tree
112          * needs to be expanded later.
113          */
114         fdt = *fdtp;
115         fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
116         fdt_size = fdt_pages << EFI_PAGE_SHIFT;
117
118         /*
119          * Safe fdt location is at 127 MiB.
120          * On the sandbox convert from the sandbox address space.
121          */
122         new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
123                                              fdt_size, 0);
124         ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
125                                  EFI_BOOT_SERVICES_DATA, fdt_pages,
126                                  &new_fdt_addr);
127         if (ret != EFI_SUCCESS) {
128                 /* If we can't put it there, put it somewhere */
129                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
130                 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
131                                          EFI_BOOT_SERVICES_DATA, fdt_pages,
132                                          &new_fdt_addr);
133                 if (ret != EFI_SUCCESS) {
134                         printf("ERROR: Failed to reserve space for FDT\n");
135                         goto done;
136                 }
137         }
138         new_fdt = (void *)(uintptr_t)new_fdt_addr;
139         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
140         fdt_set_totalsize(new_fdt, fdt_size);
141
142         *fdtp = (void *)(uintptr_t)new_fdt_addr;
143 done:
144         return ret;
145 }
146
147 /**
148  * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
149  *
150  * The mem_rsv entries of the FDT are added to the memory map. Any failures are
151  * ignored because this is not critical and we would rather continue to try to
152  * boot.
153  *
154  * @fdt: Pointer to device tree
155  */
156 static void efi_carve_out_dt_rsv(void *fdt)
157 {
158         int nr_rsv, i;
159         uint64_t addr, size, pages;
160
161         nr_rsv = fdt_num_mem_rsv(fdt);
162
163         /* Look for an existing entry and add it to the efi mem map. */
164         for (i = 0; i < nr_rsv; i++) {
165                 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
166                         continue;
167
168                 /* Convert from sandbox address space. */
169                 addr = (uintptr_t)map_sysmem(addr, 0);
170
171                 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
172                 addr &= ~EFI_PAGE_MASK;
173                 if (efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
174                                        false) != EFI_SUCCESS)
175                         printf("FDT memrsv map %d: Failed to add to map\n", i);
176         }
177 }
178
179 /**
180  * get_config_table() - get configuration table
181  *
182  * @guid:       GUID of the configuration table
183  * Return:      pointer to configuration table or NULL
184  */
185 static void *get_config_table(const efi_guid_t *guid)
186 {
187         size_t i;
188
189         for (i = 0; i < systab.nr_tables; i++) {
190                 if (!guidcmp(guid, &systab.tables[i].guid))
191                         return systab.tables[i].table;
192         }
193         return NULL;
194 }
195
196 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
197
198 /**
199  * efi_install_fdt() - install device tree
200  *
201  * If fdt_addr is available, the device tree located at that memory address will
202  * will be installed as configuration table, otherwise the device tree located
203  * at the address indicated by environment variable fdt_addr or as fallback
204  * fdtcontroladdr will be used.
205  *
206  * On architectures using ACPI tables device trees shall not be installed as
207  * configuration table.
208  *
209  * @fdt_addr:   address of device tree or EFI_FDT_USE_INTERNAL to use the
210  *              the hardware device tree as indicated by environment variable
211  *              fdt_addr or as fallback the internal device tree as indicated by
212  *              the environment variable fdtcontroladdr
213  * Return:      status code
214  */
215 static efi_status_t efi_install_fdt(uintptr_t fdt_addr)
216 {
217         /*
218          * The EBBR spec requires that we have either an FDT or an ACPI table
219          * but not both.
220          */
221 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
222         if (fdt_addr) {
223                 printf("ERROR: can't have ACPI table and device tree.\n");
224                 return EFI_LOAD_ERROR;
225         }
226 #else
227         void *fdt;
228         bootm_headers_t img = { 0 };
229         efi_status_t ret;
230
231         if (fdt_addr == EFI_FDT_USE_INTERNAL) {
232                 const char *fdt_opt;
233
234                 /* Look for device tree that is already installed */
235                 if (get_config_table(&efi_guid_fdt))
236                         return EFI_SUCCESS;
237                 /* Check if there is a hardware device tree */
238                 fdt_opt = env_get("fdt_addr");
239                 /* Use our own device tree as fallback */
240                 if (!fdt_opt) {
241                         fdt_opt = env_get("fdtcontroladdr");
242                         if (!fdt_opt) {
243                                 printf("ERROR: need device tree\n");
244                                 return EFI_NOT_FOUND;
245                         }
246                 }
247                 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
248                 if (!fdt_addr) {
249                         printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
250                         return EFI_LOAD_ERROR;
251                 }
252         }
253
254         /* Install device tree */
255         fdt = map_sysmem(fdt_addr, 0);
256         if (fdt_check_header(fdt)) {
257                 printf("ERROR: invalid device tree\n");
258                 return EFI_LOAD_ERROR;
259         }
260
261         /* Create memory reservations as indicated by the device tree */
262         efi_carve_out_dt_rsv(fdt);
263
264         /* Prepare device tree for payload */
265         ret = copy_fdt(&fdt);
266         if (ret) {
267                 printf("ERROR: out of memory\n");
268                 return EFI_OUT_OF_RESOURCES;
269         }
270
271         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
272                 printf("ERROR: failed to process device tree\n");
273                 return EFI_LOAD_ERROR;
274         }
275
276         /* Install device tree as UEFI table */
277         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
278         if (ret != EFI_SUCCESS) {
279                 printf("ERROR: failed to install device tree\n");
280                 return ret;
281         }
282 #endif /* GENERATE_ACPI_TABLE */
283
284         return EFI_SUCCESS;
285 }
286
287 /**
288  * do_bootefi_exec() - execute EFI binary
289  *
290  * @handle:             handle of loaded image
291  * Return:              status code
292  *
293  * Load the EFI binary into a newly assigned memory unwinding the relocation
294  * information, install the loaded image protocol, and call the binary.
295  */
296 static efi_status_t do_bootefi_exec(efi_handle_t handle)
297 {
298         efi_status_t ret;
299         efi_uintn_t exit_data_size = 0;
300         u16 *exit_data = NULL;
301
302         /* Transfer environment variable as load options */
303         ret = set_load_options(handle, "bootargs");
304         if (ret != EFI_SUCCESS)
305                 return ret;
306
307         /* Call our payload! */
308         ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
309         printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
310         if (ret && exit_data) {
311                 printf("## %ls\n", exit_data);
312                 efi_free_pool(exit_data);
313         }
314
315         efi_restore_gd();
316
317         /*
318          * FIXME: Who is responsible for
319          *      free(loaded_image_info->load_options);
320          * Once efi_exit() is implemented correctly,
321          * handle itself doesn't exist here.
322          */
323
324         return ret;
325 }
326
327 /**
328  * do_efibootmgr() - execute EFI boot manager
329  *
330  * Return:      status code
331  */
332 static int do_efibootmgr(void)
333 {
334         efi_handle_t handle;
335         efi_status_t ret;
336
337         ret = efi_bootmgr_load(&handle);
338         if (ret != EFI_SUCCESS) {
339                 printf("EFI boot manager: Cannot load any image\n");
340                 return CMD_RET_FAILURE;
341         }
342
343         ret = do_bootefi_exec(handle);
344
345         if (ret != EFI_SUCCESS)
346                 return CMD_RET_FAILURE;
347
348         return CMD_RET_SUCCESS;
349 }
350
351 /**
352  * do_bootefi_image() - execute EFI binary
353  *
354  * Set up memory image for the binary to be loaded, prepare device path, and
355  * then call do_bootefi_exec() to execute it.
356  *
357  * @image_opt:  string of image start address
358  * Return:      status code
359  */
360 static int do_bootefi_image(const char *image_opt)
361 {
362         void *image_buf;
363         unsigned long addr, size;
364         const char *size_str;
365         efi_status_t ret;
366
367 #ifdef CONFIG_CMD_BOOTEFI_HELLO
368         if (!strcmp(image_opt, "hello")) {
369                 char *saddr;
370
371                 saddr = env_get("loadaddr");
372                 size = __efi_helloworld_end - __efi_helloworld_begin;
373
374                 if (saddr)
375                         addr = simple_strtoul(saddr, NULL, 16);
376                 else
377                         addr = CONFIG_SYS_LOAD_ADDR;
378
379                 image_buf = map_sysmem(addr, size);
380                 memcpy(image_buf, __efi_helloworld_begin, size);
381
382                 efi_free_pool(bootefi_device_path);
383                 efi_free_pool(bootefi_image_path);
384                 bootefi_device_path = NULL;
385                 bootefi_image_path = NULL;
386         } else
387 #endif
388         {
389                 size_str = env_get("filesize");
390                 if (size_str)
391                         size = simple_strtoul(size_str, NULL, 16);
392                 else
393                         size = 0;
394
395                 addr = simple_strtoul(image_opt, NULL, 16);
396                 /* Check that a numeric value was passed */
397                 if (!addr && *image_opt != '0')
398                         return CMD_RET_USAGE;
399
400                 image_buf = map_sysmem(addr, size);
401         }
402         ret = efi_run_image(image_buf, size);
403
404         if (ret != EFI_SUCCESS)
405                 return CMD_RET_FAILURE;
406
407         return CMD_RET_SUCCESS;
408 }
409
410 /**
411  * efi_run_image() - run loaded UEFI image
412  *
413  * @source_buffer:      memory address of the UEFI image
414  * @source_size:        size of the UEFI image
415  * Return:              status code
416  */
417 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
418 {
419         efi_handle_t mem_handle = NULL, handle;
420         struct efi_device_path *file_path = NULL;
421         efi_status_t ret;
422
423         if (!bootefi_device_path || !bootefi_image_path) {
424                 /*
425                  * Special case for efi payload not loaded from disk,
426                  * such as 'bootefi hello' or for example payload
427                  * loaded directly into memory via JTAG, etc:
428                  */
429                 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
430                                             (uintptr_t)source_buffer,
431                                             source_size);
432                 /*
433                  * Make sure that device for device_path exist
434                  * in load_image(). Otherwise, shell and grub will fail.
435                  */
436                 ret = efi_create_handle(&mem_handle);
437                 if (ret != EFI_SUCCESS)
438                         goto out;
439
440                 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
441                                        file_path);
442                 if (ret != EFI_SUCCESS)
443                         goto out;
444         } else {
445                 file_path = efi_dp_append(bootefi_device_path,
446                                           bootefi_image_path);
447         }
448
449         ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
450                                       source_size, &handle));
451         if (ret != EFI_SUCCESS)
452                 goto out;
453
454         ret = do_bootefi_exec(handle);
455
456 out:
457         if (mem_handle)
458                 efi_delete_handle(mem_handle);
459         if (file_path)
460                 efi_free_pool(file_path);
461         return ret;
462 }
463
464 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
465 static efi_status_t bootefi_run_prepare(const char *load_options_path,
466                 struct efi_device_path *device_path,
467                 struct efi_device_path *image_path,
468                 struct efi_loaded_image_obj **image_objp,
469                 struct efi_loaded_image **loaded_image_infop)
470 {
471         efi_status_t ret;
472
473         ret = efi_setup_loaded_image(device_path, image_path, image_objp,
474                                      loaded_image_infop);
475         if (ret != EFI_SUCCESS)
476                 return ret;
477
478         /* Transfer environment variable as load options */
479         return set_load_options((efi_handle_t)*image_objp, load_options_path);
480 }
481
482 /**
483  * bootefi_test_prepare() - prepare to run an EFI test
484  *
485  * Prepare to run a test as if it were provided by a loaded image.
486  *
487  * @image_objp:         pointer to be set to the loaded image handle
488  * @loaded_image_infop: pointer to be set to the loaded image protocol
489  * @path:               dummy file path used to construct the device path
490  *                      set in the loaded image protocol
491  * @load_options_path:  name of a U-Boot environment variable. Its value is
492  *                      set as load options in the loaded image protocol.
493  * Return:              status code
494  */
495 static efi_status_t bootefi_test_prepare
496                 (struct efi_loaded_image_obj **image_objp,
497                  struct efi_loaded_image **loaded_image_infop, const char *path,
498                  const char *load_options_path)
499 {
500         efi_status_t ret;
501
502         /* Construct a dummy device path */
503         bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
504         if (!bootefi_device_path)
505                 return EFI_OUT_OF_RESOURCES;
506
507         bootefi_image_path = efi_dp_from_file(NULL, 0, path);
508         if (!bootefi_image_path) {
509                 ret = EFI_OUT_OF_RESOURCES;
510                 goto failure;
511         }
512
513         ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
514                                   bootefi_image_path, image_objp,
515                                   loaded_image_infop);
516         if (ret == EFI_SUCCESS)
517                 return ret;
518
519         efi_free_pool(bootefi_image_path);
520         bootefi_image_path = NULL;
521 failure:
522         efi_free_pool(bootefi_device_path);
523         bootefi_device_path = NULL;
524         return ret;
525 }
526
527 /**
528  * bootefi_run_finish() - finish up after running an EFI test
529  *
530  * @loaded_image_info: Pointer to a struct which holds the loaded image info
531  * @image_obj: Pointer to a struct which holds the loaded image object
532  */
533 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
534                                struct efi_loaded_image *loaded_image_info)
535 {
536         efi_restore_gd();
537         free(loaded_image_info->load_options);
538         efi_delete_handle(&image_obj->header);
539 }
540
541 /**
542  * do_efi_selftest() - execute EFI selftest
543  *
544  * Return:      status code
545  */
546 static int do_efi_selftest(void)
547 {
548         struct efi_loaded_image_obj *image_obj;
549         struct efi_loaded_image *loaded_image_info;
550         efi_status_t ret;
551
552         ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
553                                    "\\selftest", "efi_selftest");
554         if (ret != EFI_SUCCESS)
555                 return CMD_RET_FAILURE;
556
557         /* Execute the test */
558         ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
559         bootefi_run_finish(image_obj, loaded_image_info);
560
561         return ret != EFI_SUCCESS;
562 }
563 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
564
565 /**
566  * do_bootefi() - execute `bootefi` command
567  *
568  * @cmdtp:      table entry describing command
569  * @flag:       bitmap indicating how the command was invoked
570  * @argc:       number of arguments
571  * @argv:       command line arguments
572  * Return:      status code
573  */
574 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
575 {
576         efi_status_t ret;
577         uintptr_t fdt_addr;
578
579         if (argc < 2)
580                 return CMD_RET_USAGE;
581
582         /* Initialize EFI drivers */
583         ret = efi_init_obj_list();
584         if (ret != EFI_SUCCESS) {
585                 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
586                        ret & ~EFI_ERROR_MASK);
587                 return CMD_RET_FAILURE;
588         }
589
590         if (argc > 2)
591                 fdt_addr = simple_strtoul(argv[2], NULL, 16);
592         else
593                 fdt_addr = EFI_FDT_USE_INTERNAL;
594         ret = efi_install_fdt(fdt_addr);
595         if (ret == EFI_INVALID_PARAMETER)
596                 return CMD_RET_USAGE;
597         else if (ret != EFI_SUCCESS)
598                 return CMD_RET_FAILURE;
599
600         if (!strcmp(argv[1], "bootmgr"))
601                 return do_efibootmgr();
602 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
603         else if (!strcmp(argv[1], "selftest"))
604                 return do_efi_selftest();
605 #endif
606
607         return do_bootefi_image(argv[1]);
608 }
609
610 #ifdef CONFIG_SYS_LONGHELP
611 static char bootefi_help_text[] =
612         "<image address> [fdt address]\n"
613         "  - boot EFI payload stored at address <image address>.\n"
614         "    If specified, the device tree located at <fdt address> gets\n"
615         "    exposed as EFI configuration table.\n"
616 #ifdef CONFIG_CMD_BOOTEFI_HELLO
617         "bootefi hello\n"
618         "  - boot a sample Hello World application stored within U-Boot\n"
619 #endif
620 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
621         "bootefi selftest [fdt address]\n"
622         "  - boot an EFI selftest application stored within U-Boot\n"
623         "    Use environment variable efi_selftest to select a single test.\n"
624         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
625 #endif
626         "bootefi bootmgr [fdt address]\n"
627         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
628         "\n"
629         "    If specified, the device tree located at <fdt address> gets\n"
630         "    exposed as EFI configuration table.\n";
631 #endif
632
633 U_BOOT_CMD(
634         bootefi, 3, 0, do_bootefi,
635         "Boots an EFI payload from memory",
636         bootefi_help_text
637 );
638
639 /**
640  * efi_set_bootdev() - set boot device
641  *
642  * This function is called when a file is loaded, e.g. via the 'load' command.
643  * We use the path to this file to inform the UEFI binary about the boot device.
644  *
645  * @dev:        device, e.g. "MMC"
646  * @devnr:      number of the device, e.g. "1:2"
647  * @path:       path to file loaded
648  */
649 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
650 {
651         struct efi_device_path *device, *image;
652         efi_status_t ret;
653
654         /* efi_set_bootdev is typically called repeatedly, recover memory */
655         efi_free_pool(bootefi_device_path);
656         efi_free_pool(bootefi_image_path);
657
658         ret = efi_dp_from_name(dev, devnr, path, &device, &image);
659         if (ret == EFI_SUCCESS) {
660                 bootefi_device_path = device;
661                 if (image) {
662                         /* FIXME: image should not contain device */
663                         struct efi_device_path *image_tmp = image;
664
665                         efi_dp_split_file_path(image, &device, &image);
666                         efi_free_pool(image_tmp);
667                 }
668                 bootefi_image_path = image;
669         } else {
670                 bootefi_device_path = NULL;
671                 bootefi_image_path = NULL;
672         }
673 }