blob: d80353fa7189a344b61f2270d400aff59c49b56a [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Grafb9939332016-03-10 00:27:20 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafb9939332016-03-10 00:27:20 +01006 */
7
Heinrich Schuchardtc0018372020-07-17 20:21:00 +02008#define LOG_CATEGORY LOGC_EFI
9
Alexander Grafb9939332016-03-10 00:27:20 +010010#include <common.h>
Heinrich Schuchardt82d01f02021-01-24 14:34:12 +000011#include <bootm.h>
Heinrich Schuchardtf6c6df72019-01-08 18:13:06 +010012#include <charset.h>
Alexander Grafb9939332016-03-10 00:27:20 +010013#include <command.h>
Simon Glass9d922452017-05-17 17:18:03 -060014#include <dm.h>
Alexander Grafb9939332016-03-10 00:27:20 +010015#include <efi_loader.h>
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020016#include <efi_selftest.h>
Simon Glass7b51b572019-08-01 09:46:52 -060017#include <env.h>
Alexander Grafb9939332016-03-10 00:27:20 +010018#include <errno.h>
Simon Glass4d72caa2020-05-10 11:40:01 -060019#include <image.h>
Heinrich Schuchardtc0018372020-07-17 20:21:00 +020020#include <log.h>
Simon Glass336d4612020-02-03 07:36:16 -070021#include <malloc.h>
Simon Glass401d1c42020-10-30 21:38:53 -060022#include <asm/global_data.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090023#include <linux/libfdt.h>
24#include <linux/libfdt_env.h>
Alexander Graf354264b2018-06-18 17:22:58 +020025#include <mapmem.h>
Alexander Grafad0c1a32016-04-11 23:51:01 +020026#include <memalign.h>
Simon Glasse2754582016-09-25 15:27:32 -060027#include <asm-generic/sections.h>
28#include <linux/linkage.h>
Alexander Graf0d9d5012016-04-11 16:55:26 +020029
30DECLARE_GLOBAL_DATA_PTR;
Alexander Grafb9939332016-03-10 00:27:20 +010031
Rob Clark95c55532017-09-13 18:05:33 -040032static struct efi_device_path *bootefi_image_path;
33static struct efi_device_path *bootefi_device_path;
Heinrich Schuchardt5f595182021-01-12 12:46:24 +010034static void *image_addr;
35static size_t image_size;
36
37/**
38 * efi_clear_bootdev() - clear boot device
39 */
40static 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 */
62void 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
Simon Glassd837cb12022-01-29 14:58:37 -070068 log_debug("dev=%s, devnr=%s, path=%s, buffer=%p, size=%zx\n", dev,
69 devnr, path, buffer, buffer_size);
70
Heinrich Schuchardt5f595182021-01-12 12:46:24 +010071 /* 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) {
Simon Glassd837cb12022-01-29 14:58:37 -070078 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");
Heinrich Schuchardt5f595182021-01-12 12:46:24 +010089 return;
Simon Glassd837cb12022-01-29 14:58:37 -070090 }
Heinrich Schuchardt5f595182021-01-12 12:46:24 +010091 }
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;
Simon Glassd837cb12022-01-29 14:58:37 -0700110 log_debug("- recorded device %ls\n", efi_dp_str(device));
111 if (image)
112 log_debug("- and image %ls\n", efi_dp_str(image));
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100113 } else {
Simon Glassd837cb12022-01-29 14:58:37 -0700114 log_debug("- efi_dp_from_name() failed, err=%lx\n", ret);
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100115 efi_clear_bootdev();
116 }
117}
Alexander Grafb9939332016-03-10 00:27:20 +0100118
Heinrich Schuchardt810371a2019-07-14 13:00:44 +0200119/**
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200120 * efi_env_set_load_options() - set load options from environment variable
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200121 *
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100122 * @handle: the image handle
123 * @env_var: name of the environment variable
124 * @load_options: pointer to load options (output)
125 * Return: status code
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200126 */
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200127static efi_status_t efi_env_set_load_options(efi_handle_t handle,
128 const char *env_var,
129 u16 **load_options)
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200130{
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200131 const char *env = env_get(env_var);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200132 size_t size;
Heinrich Schuchardt7086a712018-08-31 21:31:33 +0200133 u16 *pos;
AKASHI Takahirodefa7b82019-04-19 12:22:28 +0900134 efi_status_t ret;
135
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100136 *load_options = NULL;
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200137 if (!env)
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200138 return EFI_SUCCESS;
139 size = sizeof(u16) * (utf8_utf16_strlen(env) + 1);
140 pos = calloc(size, 1);
141 if (!pos)
AKASHI Takahirodefa7b82019-04-19 12:22:28 +0900142 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100143 *load_options = pos;
Heinrich Schuchardt7086a712018-08-31 21:31:33 +0200144 utf8_utf16_strcpy(&pos, env);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200145 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;
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200151}
152
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200153#if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
154
Simon Glass9dff4902018-08-08 03:54:30 -0600155/**
156 * copy_fdt() - Copy the device tree to a new location available to EFI
157 *
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100158 * The FDT is copied to a suitable location within the EFI memory map.
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100159 * Additional 12 KiB are added to the space in case the device tree needs to be
Simon Glass9dff4902018-08-08 03:54:30 -0600160 * expanded later with fdt_open_into().
161 *
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100162 * @fdtp: On entry a pointer to the flattened device tree.
163 * On exit a pointer to the copy of the flattened device tree.
Heinrich Schuchardt4574d1b2018-11-12 18:55:22 +0100164 * FDT start
165 * Return: status code
Simon Glass9dff4902018-08-08 03:54:30 -0600166 */
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100167static efi_status_t copy_fdt(void **fdtp)
Alexander Graf0d9d5012016-04-11 16:55:26 +0200168{
Alexander Grafad0c1a32016-04-11 23:51:01 +0200169 unsigned long fdt_ram_start = -1L, fdt_pages;
Simon Glass9dff4902018-08-08 03:54:30 -0600170 efi_status_t ret = 0;
171 void *fdt, *new_fdt;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200172 u64 new_fdt_addr;
Simon Glass9dff4902018-08-08 03:54:30 -0600173 uint fdt_size;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200174 int i;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200175
Simon Glass9dff4902018-08-08 03:54:30 -0600176 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;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200179
Alexander Grafad0c1a32016-04-11 23:51:01 +0200180 if (!ram_size)
181 continue;
182
183 if (ram_start < fdt_ram_start)
184 fdt_ram_start = ram_start;
185 }
186
Simon Glassbc9a6382018-06-18 08:08:25 -0600187 /*
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100188 * Give us at least 12 KiB of breathing room in case the device tree
189 * needs to be expanded later.
Simon Glassbc9a6382018-06-18 08:08:25 -0600190 */
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100191 fdt = *fdtp;
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100192 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
193 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200194
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100195 /*
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);
Simon Glass9dff4902018-08-08 03:54:30 -0600201 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
Heinrich Schuchardt42a426e2020-05-06 20:32:31 +0200202 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
Simon Glass9dff4902018-08-08 03:54:30 -0600203 &new_fdt_addr);
204 if (ret != EFI_SUCCESS) {
Alexander Grafad0c1a32016-04-11 23:51:01 +0200205 /* If we can't put it there, put it somewhere */
xypron.glpk@gmx.dea44bffc2017-08-11 21:19:25 +0200206 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
Simon Glass9dff4902018-08-08 03:54:30 -0600207 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
Heinrich Schuchardt42a426e2020-05-06 20:32:31 +0200208 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
Simon Glass9dff4902018-08-08 03:54:30 -0600209 &new_fdt_addr);
210 if (ret != EFI_SUCCESS) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200211 log_err("ERROR: Failed to reserve space for FDT\n");
Simon Glass9dff4902018-08-08 03:54:30 -0600212 goto done;
Alexander Graf85a6e9b2017-07-03 13:32:35 +0200213 }
Alexander Grafad0c1a32016-04-11 23:51:01 +0200214 }
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100215 new_fdt = (void *)(uintptr_t)new_fdt_addr;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200216 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
217 fdt_set_totalsize(new_fdt, fdt_size);
218
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100219 *fdtp = (void *)(uintptr_t)new_fdt_addr;
Simon Glass9dff4902018-08-08 03:54:30 -0600220done:
221 return ret;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200222}
223
Heinrich Schuchardt4cbb2932020-08-27 12:52:20 +0200224/**
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200225 * get_config_table() - get configuration table
226 *
227 * @guid: GUID of the configuration table
228 * Return: pointer to configuration table or NULL
229 */
230static 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/**
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100244 * efi_install_fdt() - install device tree
Heinrich Schuchardte2d82f82019-05-12 20:16:25 +0200245 *
Heinrich Schuchardt7d4d5512020-02-07 22:10:49 +0100246 * 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.
Heinrich Schuchardte2d82f82019-05-12 20:16:25 +0200250 *
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100251 * On architectures using ACPI tables device trees shall not be installed as
252 * configuration table.
Heinrich Schuchardte2d82f82019-05-12 20:16:25 +0200253 *
Heinrich Schuchardt7d4d5512020-02-07 22:10:49 +0100254 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100255 * 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
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900258 * Return: status code
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900259 */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100260efi_status_t efi_install_fdt(void *fdt)
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900261{
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200262 /*
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)
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100267 if (fdt) {
Alexander Graf0832dd22022-02-27 13:18:56 +0100268 log_warning("WARNING: Can't have ACPI table and device tree - ignoring DT.\n");
269 return EFI_SUCCESS;
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200270 }
271#else
AKASHI Takahiro3ffc52f2019-04-19 12:22:30 +0900272 bootm_headers_t img = { 0 };
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900273 efi_status_t ret;
274
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100275 if (fdt == EFI_FDT_USE_INTERNAL) {
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100276 const char *fdt_opt;
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100277 uintptr_t fdt_addr;
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100278
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200279 /* Look for device tree that is already installed */
280 if (get_config_table(&efi_guid_fdt))
281 return EFI_SUCCESS;
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100282 /* Check if there is a hardware device tree */
283 fdt_opt = env_get("fdt_addr");
284 /* Use our own device tree as fallback */
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200285 if (!fdt_opt) {
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100286 fdt_opt = env_get("fdtcontroladdr");
287 if (!fdt_opt) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200288 log_err("ERROR: need device tree\n");
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100289 return EFI_NOT_FOUND;
290 }
AKASHI Takahiro3ffc52f2019-04-19 12:22:30 +0900291 }
Simon Glass7e5f4602021-07-24 09:03:29 -0600292 fdt_addr = hextoul(fdt_opt, NULL);
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200293 if (!fdt_addr) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200294 log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
AKASHI Takahiro3ffc52f2019-04-19 12:22:30 +0900295 return EFI_LOAD_ERROR;
296 }
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100297 fdt = map_sysmem(fdt_addr, 0);
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900298 }
299
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200300 /* Install device tree */
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200301 if (fdt_check_header(fdt)) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200302 log_err("ERROR: invalid device tree\n");
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200303 return EFI_LOAD_ERROR;
304 }
305
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200306 /* Prepare device tree for payload */
307 ret = copy_fdt(&fdt);
308 if (ret) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200309 log_err("ERROR: out of memory\n");
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200310 return EFI_OUT_OF_RESOURCES;
311 }
312
313 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200314 log_err("ERROR: failed to process device tree\n");
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200315 return EFI_LOAD_ERROR;
316 }
317
Heinrich Schuchardtfef907b2020-03-14 10:59:34 +0100318 /* Create memory reservations as indicated by the device tree */
319 efi_carve_out_dt_rsv(fdt);
320
Ilias Apalodimasa2f14822022-01-03 14:07:37 +0200321 efi_try_purge_kaslr_seed(fdt);
322
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200323 /* Install device tree as UEFI table */
324 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
325 if (ret != EFI_SUCCESS) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200326 log_err("ERROR: failed to install device tree\n");
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200327 return ret;
328 }
329#endif /* GENERATE_ACPI_TABLE */
330
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900331 return EFI_SUCCESS;
332}
333
Simon Glass5e2f0392018-11-25 20:14:39 -0700334/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200335 * do_bootefi_exec() - execute EFI binary
336 *
Heinrich Schuchardt72e1fca2020-08-15 23:10:22 +0200337 * The image indicated by @handle is started. When it returns the allocated
338 * memory for the @load_options is freed.
339 *
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900340 * @handle: handle of loaded image
Heinrich Schuchardt72e1fca2020-08-15 23:10:22 +0200341 * @load_options: load options
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200342 * 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.
Alexander Grafb9939332016-03-10 00:27:20 +0100346 */
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200347static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
Alexander Grafb9939332016-03-10 00:27:20 +0100348{
Heinrich Schuchardt45204b12018-03-03 15:29:01 +0100349 efi_status_t ret;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200350 efi_uintn_t exit_data_size = 0;
351 u16 *exit_data = NULL;
Rob Clarkbf192732017-10-10 08:23:06 -0400352
Heinrich Schuchardt82d01f02021-01-24 14:34:12 +0000353 /* On ARM switch from EL3 or secure mode to EL2 or non-secure mode */
354 switch_to_non_secure_mode();
355
Masahisa Kojima3fa9ed92022-02-22 09:58:30 +0900356 /*
357 * The UEFI standard requires that the watchdog timer is set to five
358 * minutes when invoking an EFI boot option.
359 *
360 * Unified Extensible Firmware Interface (UEFI), version 2.7 Errata A
361 * 7.5. Miscellaneous Boot Services - EFI_BOOT_SERVICES.SetWatchdogTimer
362 */
363 ret = efi_set_watchdog(300);
364 if (ret != EFI_SUCCESS) {
365 log_err("ERROR: Failed to set watchdog timer\n");
366 goto out;
367 }
368
Alexander Grafb9939332016-03-10 00:27:20 +0100369 /* Call our payload! */
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200370 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200371 if (ret != EFI_SUCCESS) {
372 log_err("## Application failed, r = %lu\n",
373 ret & ~EFI_ERROR_MASK);
374 if (exit_data) {
375 log_err("## %ls\n", exit_data);
376 efi_free_pool(exit_data);
377 }
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200378 }
Rob Clark95c55532017-09-13 18:05:33 -0400379
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900380 efi_restore_gd();
Simon Glass5e2f0392018-11-25 20:14:39 -0700381
Masahisa Kojima3fa9ed92022-02-22 09:58:30 +0900382out:
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100383 free(load_options);
Rob Clark95c55532017-09-13 18:05:33 -0400384
Ilias Apalodimas53f6a5a2021-03-17 21:55:00 +0200385 if (IS_ENABLED(CONFIG_EFI_LOAD_FILE2_INITRD))
386 efi_initrd_deregister();
387
Masahisa Kojima3fa9ed92022-02-22 09:58:30 +0900388 /* Control is returned to U-Boot, disable EFI watchdog */
389 efi_set_watchdog(0);
390
Rob Clark95c55532017-09-13 18:05:33 -0400391 return ret;
Alexander Grafb9939332016-03-10 00:27:20 +0100392}
393
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900394/**
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200395 * do_efibootmgr() - execute EFI boot manager
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900396 *
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900397 * Return: status code
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900398 */
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200399static int do_efibootmgr(void)
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900400{
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900401 efi_handle_t handle;
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900402 efi_status_t ret;
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200403 void *load_options;
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900404
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200405 ret = efi_bootmgr_load(&handle, &load_options);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900406 if (ret != EFI_SUCCESS) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200407 log_notice("EFI boot manager: Cannot load any image\n");
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900408 return CMD_RET_FAILURE;
409 }
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900410
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200411 ret = do_bootefi_exec(handle, load_options);
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900412
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900413 if (ret != EFI_SUCCESS)
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900414 return CMD_RET_FAILURE;
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900415
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900416 return CMD_RET_SUCCESS;
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900417}
418
Heinrich Schuchardt810371a2019-07-14 13:00:44 +0200419/**
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200420 * do_bootefi_image() - execute EFI binary
421 *
422 * Set up memory image for the binary to be loaded, prepare device path, and
423 * then call do_bootefi_exec() to execute it.
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900424 *
Kyle Evans20589832022-04-10 16:05:55 -0500425 * @image_opt: string with image start address
426 * @size_opt: string with image size or NULL
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900427 * Return: status code
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900428 */
Kyle Evans20589832022-04-10 16:05:55 -0500429static int do_bootefi_image(const char *image_opt, const char *size_opt)
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900430{
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900431 void *image_buf;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900432 unsigned long addr, size;
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900433 efi_status_t ret;
434
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900435#ifdef CONFIG_CMD_BOOTEFI_HELLO
436 if (!strcmp(image_opt, "hello")) {
Heinrich Schuchardtbb33c792021-01-12 17:44:08 +0100437 image_buf = __efi_helloworld_begin;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900438 size = __efi_helloworld_end - __efi_helloworld_begin;
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100439 efi_clear_bootdev();
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900440 } else
441#endif
442 {
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100443 addr = strtoul(image_opt, NULL, 16);
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900444 /* Check that a numeric value was passed */
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100445 if (!addr)
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900446 return CMD_RET_USAGE;
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100447 image_buf = map_sysmem(addr, 0);
448
Kyle Evans20589832022-04-10 16:05:55 -0500449 if (size_opt) {
450 size = strtoul(size_opt, NULL, 16);
451 if (!size)
452 return CMD_RET_USAGE;
453 efi_clear_bootdev();
454 } else {
455 if (image_buf != image_addr) {
456 log_err("No UEFI binary known at %s\n",
457 image_opt);
458 return CMD_RET_FAILURE;
459 }
460 size = image_size;
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100461 }
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900462 }
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100463 ret = efi_run_image(image_buf, size);
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900464
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100465 if (ret != EFI_SUCCESS)
466 return CMD_RET_FAILURE;
467
468 return CMD_RET_SUCCESS;
469}
470
471/**
472 * efi_run_image() - run loaded UEFI image
473 *
474 * @source_buffer: memory address of the UEFI image
475 * @source_size: size of the UEFI image
476 * Return: status code
477 */
478efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
479{
480 efi_handle_t mem_handle = NULL, handle;
481 struct efi_device_path *file_path = NULL;
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000482 struct efi_device_path *msg_path;
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100483 efi_status_t ret;
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000484 u16 *load_options;
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100485
486 if (!bootefi_device_path || !bootefi_image_path) {
Simon Glassd837cb12022-01-29 14:58:37 -0700487 log_debug("Not loaded from disk\n");
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900488 /*
489 * Special case for efi payload not loaded from disk,
490 * such as 'bootefi hello' or for example payload
491 * loaded directly into memory via JTAG, etc:
492 */
493 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100494 (uintptr_t)source_buffer,
495 source_size);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900496 /*
497 * Make sure that device for device_path exist
498 * in load_image(). Otherwise, shell and grub will fail.
499 */
500 ret = efi_create_handle(&mem_handle);
501 if (ret != EFI_SUCCESS)
502 goto out;
503
504 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
505 file_path);
506 if (ret != EFI_SUCCESS)
507 goto out;
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000508 msg_path = file_path;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900509 } else {
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100510 file_path = efi_dp_append(bootefi_device_path,
511 bootefi_image_path);
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000512 msg_path = bootefi_image_path;
Simon Glassd837cb12022-01-29 14:58:37 -0700513 log_debug("Loaded from disk\n");
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900514 }
515
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000516 log_info("Booting %pD\n", msg_path);
517
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100518 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
519 source_size, &handle));
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000520 if (ret != EFI_SUCCESS) {
521 log_err("Loading image failed\n");
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900522 goto out;
Heinrich Schuchardtc2f01032020-08-25 17:54:05 +0000523 }
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200524
525 /* Transfer environment variable as load options */
526 ret = efi_env_set_load_options(handle, "bootargs", &load_options);
527 if (ret != EFI_SUCCESS)
528 goto out;
529
530 ret = do_bootefi_exec(handle, load_options);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900531
532out:
Heinrich Schuchardt4fe050e2020-04-20 12:44:56 +0200533 efi_delete_handle(mem_handle);
534 efi_free_pool(file_path);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100535 return ret;
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900536}
537
Simon Glassd9717ea2018-11-25 20:14:37 -0700538#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900539static efi_status_t bootefi_run_prepare(const char *load_options_path,
540 struct efi_device_path *device_path,
541 struct efi_device_path *image_path,
542 struct efi_loaded_image_obj **image_objp,
543 struct efi_loaded_image **loaded_image_infop)
544{
545 efi_status_t ret;
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100546 u16 *load_options;
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900547
548 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
549 loaded_image_infop);
550 if (ret != EFI_SUCCESS)
551 return ret;
552
553 /* Transfer environment variable as load options */
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200554 return efi_env_set_load_options((efi_handle_t)*image_objp,
555 load_options_path,
556 &load_options);
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900557}
558
Simon Glassd9717ea2018-11-25 20:14:37 -0700559/**
560 * bootefi_test_prepare() - prepare to run an EFI test
561 *
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100562 * Prepare to run a test as if it were provided by a loaded image.
Simon Glassd9717ea2018-11-25 20:14:37 -0700563 *
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100564 * @image_objp: pointer to be set to the loaded image handle
565 * @loaded_image_infop: pointer to be set to the loaded image protocol
566 * @path: dummy file path used to construct the device path
567 * set in the loaded image protocol
568 * @load_options_path: name of a U-Boot environment variable. Its value is
569 * set as load options in the loaded image protocol.
570 * Return: status code
Simon Glassd9717ea2018-11-25 20:14:37 -0700571 */
572static efi_status_t bootefi_test_prepare
573 (struct efi_loaded_image_obj **image_objp,
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100574 struct efi_loaded_image **loaded_image_infop, const char *path,
575 const char *load_options_path)
Simon Glassd9717ea2018-11-25 20:14:37 -0700576{
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100577 efi_status_t ret;
578
Simon Glassd9717ea2018-11-25 20:14:37 -0700579 /* Construct a dummy device path */
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100580 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
Simon Glassd9717ea2018-11-25 20:14:37 -0700581 if (!bootefi_device_path)
582 return EFI_OUT_OF_RESOURCES;
Simon Glassd9717ea2018-11-25 20:14:37 -0700583
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100584 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
585 if (!bootefi_image_path) {
586 ret = EFI_OUT_OF_RESOURCES;
587 goto failure;
588 }
589
590 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
591 bootefi_image_path, image_objp,
592 loaded_image_infop);
593 if (ret == EFI_SUCCESS)
594 return ret;
595
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100596failure:
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100597 efi_clear_bootdev();
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100598 return ret;
Simon Glassd9717ea2018-11-25 20:14:37 -0700599}
600
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900601/**
602 * bootefi_run_finish() - finish up after running an EFI test
603 *
604 * @loaded_image_info: Pointer to a struct which holds the loaded image info
605 * @image_obj: Pointer to a struct which holds the loaded image object
606 */
607static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
608 struct efi_loaded_image *loaded_image_info)
609{
610 efi_restore_gd();
611 free(loaded_image_info->load_options);
612 efi_delete_handle(&image_obj->header);
613}
614
615/**
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200616 * do_efi_selftest() - execute EFI selftest
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900617 *
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900618 * Return: status code
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900619 */
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200620static int do_efi_selftest(void)
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900621{
622 struct efi_loaded_image_obj *image_obj;
623 struct efi_loaded_image *loaded_image_info;
624 efi_status_t ret;
625
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900626 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
627 "\\selftest", "efi_selftest");
628 if (ret != EFI_SUCCESS)
629 return CMD_RET_FAILURE;
630
631 /* Execute the test */
632 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
633 bootefi_run_finish(image_obj, loaded_image_info);
634
635 return ret != EFI_SUCCESS;
636}
Simon Glassd9717ea2018-11-25 20:14:37 -0700637#endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
638
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200639/**
640 * do_bootefi() - execute `bootefi` command
641 *
642 * @cmdtp: table entry describing command
643 * @flag: bitmap indicating how the command was invoked
644 * @argc: number of arguments
645 * @argv: command line arguments
646 * Return: status code
647 */
Simon Glass09140112020-05-10 11:40:03 -0600648static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
649 char *const argv[])
Alexander Grafb9939332016-03-10 00:27:20 +0100650{
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200651 efi_status_t ret;
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100652 void *fdt;
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200653
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900654 if (argc < 2)
655 return CMD_RET_USAGE;
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900656
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200657 /* Initialize EFI drivers */
658 ret = efi_init_obj_list();
659 if (ret != EFI_SUCCESS) {
Heinrich Schuchardtc0018372020-07-17 20:21:00 +0200660 log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
661 ret & ~EFI_ERROR_MASK);
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200662 return CMD_RET_FAILURE;
663 }
664
Kyle Evans20589832022-04-10 16:05:55 -0500665 if (argc > 2 && strcmp(argv[2], "-")) {
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100666 uintptr_t fdt_addr;
667
Simon Glass7e5f4602021-07-24 09:03:29 -0600668 fdt_addr = hextoul(argv[2], NULL);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100669 fdt = map_sysmem(fdt_addr, 0);
670 } else {
671 fdt = EFI_FDT_USE_INTERNAL;
672 }
673 ret = efi_install_fdt(fdt);
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200674 if (ret == EFI_INVALID_PARAMETER)
675 return CMD_RET_USAGE;
676 else if (ret != EFI_SUCCESS)
677 return CMD_RET_FAILURE;
678
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +0100679 if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) {
680 if (!strcmp(argv[1], "bootmgr"))
681 return do_efibootmgr();
682 }
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900683#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +0100684 if (!strcmp(argv[1], "selftest"))
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200685 return do_efi_selftest();
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900686#endif
687
Kyle Evans20589832022-04-10 16:05:55 -0500688 return do_bootefi_image(argv[1], argc > 3 ? argv[3] : NULL);
Alexander Grafb9939332016-03-10 00:27:20 +0100689}
690
691#ifdef CONFIG_SYS_LONGHELP
692static char bootefi_help_text[] =
Kyle Evans20589832022-04-10 16:05:55 -0500693 "<image address> [fdt address [image size]]\n"
694 " - boot EFI payload stored at <image address>\n"
695 " fdt address, address of device-tree or '-'\n"
696 " image size, required if image not preloaded\n"
Simon Glassc7ae3df2016-11-07 08:47:08 -0700697#ifdef CONFIG_CMD_BOOTEFI_HELLO
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200698 "bootefi hello\n"
699 " - boot a sample Hello World application stored within U-Boot\n"
700#endif
701#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100702 "bootefi selftest [fdt address]\n"
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200703 " - boot an EFI selftest application stored within U-Boot\n"
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200704 " Use environment variable efi_selftest to select a single test.\n"
705 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
Simon Glassc7ae3df2016-11-07 08:47:08 -0700706#endif
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +0100707#ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900708 "bootefi bootmgr [fdt address]\n"
Rob Clark9975fe92017-09-13 18:05:38 -0400709 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
710 "\n"
711 " If specified, the device tree located at <fdt address> gets\n"
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +0100712 " exposed as EFI configuration table.\n"
713#endif
714 ;
Alexander Grafb9939332016-03-10 00:27:20 +0100715#endif
716
717U_BOOT_CMD(
Kyle Evans20589832022-04-10 16:05:55 -0500718 bootefi, 4, 0, do_bootefi,
Sergey Kubushyn92dfd922016-06-07 11:14:31 -0700719 "Boots an EFI payload from memory",
Alexander Grafb9939332016-03-10 00:27:20 +0100720 bootefi_help_text
721);