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