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