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