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