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