blob: 57552f99fcf12388a90fe62ce8058611b426d1b5 [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
8#include <common.h>
Heinrich Schuchardtf6c6df72019-01-08 18:13:06 +01009#include <charset.h>
Alexander Grafb9939332016-03-10 00:27:20 +010010#include <command.h>
Simon Glass9d922452017-05-17 17:18:03 -060011#include <dm.h>
Alexander Grafb9939332016-03-10 00:27:20 +010012#include <efi_loader.h>
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020013#include <efi_selftest.h>
Simon Glass7b51b572019-08-01 09:46:52 -060014#include <env.h>
Alexander Grafb9939332016-03-10 00:27:20 +010015#include <errno.h>
Simon Glass4d72caa2020-05-10 11:40:01 -060016#include <image.h>
Simon Glass336d4612020-02-03 07:36:16 -070017#include <malloc.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090018#include <linux/libfdt.h>
19#include <linux/libfdt_env.h>
Alexander Graf354264b2018-06-18 17:22:58 +020020#include <mapmem.h>
Alexander Grafad0c1a32016-04-11 23:51:01 +020021#include <memalign.h>
Simon Glasse2754582016-09-25 15:27:32 -060022#include <asm-generic/sections.h>
23#include <linux/linkage.h>
Alexander Graf0d9d5012016-04-11 16:55:26 +020024
25DECLARE_GLOBAL_DATA_PTR;
Alexander Grafb9939332016-03-10 00:27:20 +010026
Rob Clark95c55532017-09-13 18:05:33 -040027static struct efi_device_path *bootefi_image_path;
28static struct efi_device_path *bootefi_device_path;
Alexander Grafb9939332016-03-10 00:27:20 +010029
Heinrich Schuchardt810371a2019-07-14 13:00:44 +020030/**
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020031 * Set the load options of an image from an environment variable.
32 *
Heinrich Schuchardta3850e42020-01-03 22:53:42 +010033 * @handle: the image handle
34 * @env_var: name of the environment variable
35 * @load_options: pointer to load options (output)
36 * Return: status code
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020037 */
Heinrich Schuchardta3850e42020-01-03 22:53:42 +010038static efi_status_t set_load_options(efi_handle_t handle, const char *env_var,
39 u16 **load_options)
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020040{
AKASHI Takahirodefa7b82019-04-19 12:22:28 +090041 struct efi_loaded_image *loaded_image_info;
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020042 size_t size;
43 const char *env = env_get(env_var);
Heinrich Schuchardt7086a712018-08-31 21:31:33 +020044 u16 *pos;
AKASHI Takahirodefa7b82019-04-19 12:22:28 +090045 efi_status_t ret;
46
Heinrich Schuchardta3850e42020-01-03 22:53:42 +010047 *load_options = NULL;
AKASHI Takahirodefa7b82019-04-19 12:22:28 +090048 ret = EFI_CALL(systab.boottime->open_protocol(
49 handle,
50 &efi_guid_loaded_image,
51 (void **)&loaded_image_info,
52 efi_root, NULL,
53 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
54 if (ret != EFI_SUCCESS)
55 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020056
57 loaded_image_info->load_options = NULL;
58 loaded_image_info->load_options_size = 0;
59 if (!env)
AKASHI Takahirodefa7b82019-04-19 12:22:28 +090060 goto out;
61
Heinrich Schuchardt7086a712018-08-31 21:31:33 +020062 size = utf8_utf16_strlen(env) + 1;
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020063 loaded_image_info->load_options = calloc(size, sizeof(u16));
64 if (!loaded_image_info->load_options) {
65 printf("ERROR: Out of memory\n");
AKASHI Takahirodefa7b82019-04-19 12:22:28 +090066 EFI_CALL(systab.boottime->close_protocol(handle,
67 &efi_guid_loaded_image,
68 efi_root, NULL));
69 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020070 }
Heinrich Schuchardt7086a712018-08-31 21:31:33 +020071 pos = loaded_image_info->load_options;
Heinrich Schuchardta3850e42020-01-03 22:53:42 +010072 *load_options = pos;
Heinrich Schuchardt7086a712018-08-31 21:31:33 +020073 utf8_utf16_strcpy(&pos, env);
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020074 loaded_image_info->load_options_size = size * 2;
AKASHI Takahirodefa7b82019-04-19 12:22:28 +090075
76out:
77 return EFI_CALL(systab.boottime->close_protocol(handle,
78 &efi_guid_loaded_image,
79 efi_root, NULL));
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020080}
81
Heinrich Schuchardt61824952019-04-20 13:33:55 +020082#if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
83
Simon Glass9dff4902018-08-08 03:54:30 -060084/**
85 * copy_fdt() - Copy the device tree to a new location available to EFI
86 *
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +010087 * The FDT is copied to a suitable location within the EFI memory map.
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +010088 * Additional 12 KiB are added to the space in case the device tree needs to be
Simon Glass9dff4902018-08-08 03:54:30 -060089 * expanded later with fdt_open_into().
90 *
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +010091 * @fdtp: On entry a pointer to the flattened device tree.
92 * On exit a pointer to the copy of the flattened device tree.
Heinrich Schuchardt4574d1b2018-11-12 18:55:22 +010093 * FDT start
94 * Return: status code
Simon Glass9dff4902018-08-08 03:54:30 -060095 */
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +010096static efi_status_t copy_fdt(void **fdtp)
Alexander Graf0d9d5012016-04-11 16:55:26 +020097{
Alexander Grafad0c1a32016-04-11 23:51:01 +020098 unsigned long fdt_ram_start = -1L, fdt_pages;
Simon Glass9dff4902018-08-08 03:54:30 -060099 efi_status_t ret = 0;
100 void *fdt, *new_fdt;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200101 u64 new_fdt_addr;
Simon Glass9dff4902018-08-08 03:54:30 -0600102 uint fdt_size;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200103 int i;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200104
Simon Glass9dff4902018-08-08 03:54:30 -0600105 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
106 u64 ram_start = gd->bd->bi_dram[i].start;
107 u64 ram_size = gd->bd->bi_dram[i].size;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200108
Alexander Grafad0c1a32016-04-11 23:51:01 +0200109 if (!ram_size)
110 continue;
111
112 if (ram_start < fdt_ram_start)
113 fdt_ram_start = ram_start;
114 }
115
Simon Glassbc9a6382018-06-18 08:08:25 -0600116 /*
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100117 * Give us at least 12 KiB of breathing room in case the device tree
118 * needs to be expanded later.
Simon Glassbc9a6382018-06-18 08:08:25 -0600119 */
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100120 fdt = *fdtp;
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100121 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
122 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200123
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100124 /*
125 * Safe fdt location is at 127 MiB.
126 * On the sandbox convert from the sandbox address space.
127 */
128 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
129 fdt_size, 0);
Simon Glass9dff4902018-08-08 03:54:30 -0600130 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
Heinrich Schuchardt42a426e2020-05-06 20:32:31 +0200131 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
Simon Glass9dff4902018-08-08 03:54:30 -0600132 &new_fdt_addr);
133 if (ret != EFI_SUCCESS) {
Alexander Grafad0c1a32016-04-11 23:51:01 +0200134 /* If we can't put it there, put it somewhere */
xypron.glpk@gmx.dea44bffc2017-08-11 21:19:25 +0200135 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
Simon Glass9dff4902018-08-08 03:54:30 -0600136 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
Heinrich Schuchardt42a426e2020-05-06 20:32:31 +0200137 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
Simon Glass9dff4902018-08-08 03:54:30 -0600138 &new_fdt_addr);
139 if (ret != EFI_SUCCESS) {
Alexander Graf85a6e9b2017-07-03 13:32:35 +0200140 printf("ERROR: Failed to reserve space for FDT\n");
Simon Glass9dff4902018-08-08 03:54:30 -0600141 goto done;
Alexander Graf85a6e9b2017-07-03 13:32:35 +0200142 }
Alexander Grafad0c1a32016-04-11 23:51:01 +0200143 }
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100144 new_fdt = (void *)(uintptr_t)new_fdt_addr;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200145 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
146 fdt_set_totalsize(new_fdt, fdt_size);
147
Heinrich Schuchardt16b615d2018-11-18 17:58:52 +0100148 *fdtp = (void *)(uintptr_t)new_fdt_addr;
Simon Glass9dff4902018-08-08 03:54:30 -0600149done:
150 return ret;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200151}
152
Atish Patra7be64b82020-03-13 17:11:30 -0700153static void efi_reserve_memory(u64 addr, u64 size)
154{
Atish Patra7be64b82020-03-13 17:11:30 -0700155 /* Convert from sandbox address space. */
156 addr = (uintptr_t)map_sysmem(addr, 0);
Michael Walle714497e2020-05-17 12:29:19 +0200157 if (efi_add_memory_map(addr, size,
158 EFI_RESERVED_MEMORY_TYPE) != EFI_SUCCESS)
Atish Patra7be64b82020-03-13 17:11:30 -0700159 printf("Reserved memory mapping failed addr %llx size %llx\n",
160 addr, size);
161}
162
Heinrich Schuchardt810371a2019-07-14 13:00:44 +0200163/**
Simon Glass416e07e2018-06-18 08:08:28 -0600164 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
165 *
166 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
167 * ignored because this is not critical and we would rather continue to try to
168 * boot.
169 *
170 * @fdt: Pointer to device tree
171 */
172static void efi_carve_out_dt_rsv(void *fdt)
Alexander Graf806d2fa2018-04-06 09:40:51 +0200173{
174 int nr_rsv, i;
Atish Patra7be64b82020-03-13 17:11:30 -0700175 u64 addr, size;
176 int nodeoffset, subnode;
Alexander Graf806d2fa2018-04-06 09:40:51 +0200177
178 nr_rsv = fdt_num_mem_rsv(fdt);
179
180 /* Look for an existing entry and add it to the efi mem map. */
181 for (i = 0; i < nr_rsv; i++) {
182 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
183 continue;
Atish Patra7be64b82020-03-13 17:11:30 -0700184 efi_reserve_memory(addr, size);
185 }
Alexander Graf806d2fa2018-04-06 09:40:51 +0200186
Atish Patra7be64b82020-03-13 17:11:30 -0700187 /* process reserved-memory */
188 nodeoffset = fdt_subnode_offset(fdt, 0, "reserved-memory");
189 if (nodeoffset >= 0) {
190 subnode = fdt_first_subnode(fdt, nodeoffset);
191 while (subnode >= 0) {
Bin Mengb1c272d2020-06-22 23:50:50 -0700192 fdt_addr_t fdt_addr;
193 fdt_size_t fdt_size;
Atish Patra0d7c2912020-06-18 18:51:50 -0700194
Atish Patra7be64b82020-03-13 17:11:30 -0700195 /* check if this subnode has a reg property */
Atish Patra0d7c2912020-06-18 18:51:50 -0700196 fdt_addr = fdtdec_get_addr_size_auto_parent(
197 fdt, nodeoffset, subnode,
198 "reg", 0, &fdt_size, false);
Atish Patra7be64b82020-03-13 17:11:30 -0700199 /*
200 * The /reserved-memory node may have children with
201 * a size instead of a reg property.
202 */
Heinrich Schuchardt039d4f52020-06-30 14:12:43 +0200203 if (fdt_addr != FDT_ADDR_T_NONE &&
Heinrich Schuchardt4ef2b0d2020-03-24 07:37:52 +0100204 fdtdec_get_is_enabled(fdt, subnode))
Atish Patra0d7c2912020-06-18 18:51:50 -0700205 efi_reserve_memory(fdt_addr, fdt_size);
Atish Patra7be64b82020-03-13 17:11:30 -0700206 subnode = fdt_next_subnode(fdt, subnode);
207 }
Alexander Graf806d2fa2018-04-06 09:40:51 +0200208 }
Alexander Graf806d2fa2018-04-06 09:40:51 +0200209}
210
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900211/**
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200212 * get_config_table() - get configuration table
213 *
214 * @guid: GUID of the configuration table
215 * Return: pointer to configuration table or NULL
216 */
217static void *get_config_table(const efi_guid_t *guid)
218{
219 size_t i;
220
221 for (i = 0; i < systab.nr_tables; i++) {
222 if (!guidcmp(guid, &systab.tables[i].guid))
223 return systab.tables[i].table;
224 }
225 return NULL;
226}
227
228#endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
229
230/**
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100231 * efi_install_fdt() - install device tree
Heinrich Schuchardte2d82f82019-05-12 20:16:25 +0200232 *
Heinrich Schuchardt7d4d5512020-02-07 22:10:49 +0100233 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
234 * address will will be installed as configuration table, otherwise the device
235 * tree located at the address indicated by environment variable fdt_addr or as
236 * fallback fdtcontroladdr will be used.
Heinrich Schuchardte2d82f82019-05-12 20:16:25 +0200237 *
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100238 * On architectures using ACPI tables device trees shall not be installed as
239 * configuration table.
Heinrich Schuchardte2d82f82019-05-12 20:16:25 +0200240 *
Heinrich Schuchardt7d4d5512020-02-07 22:10:49 +0100241 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100242 * the hardware device tree as indicated by environment variable
243 * fdt_addr or as fallback the internal device tree as indicated by
244 * the environment variable fdtcontroladdr
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900245 * Return: status code
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900246 */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100247efi_status_t efi_install_fdt(void *fdt)
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900248{
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200249 /*
250 * The EBBR spec requires that we have either an FDT or an ACPI table
251 * but not both.
252 */
253#if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100254 if (fdt) {
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200255 printf("ERROR: can't have ACPI table and device tree.\n");
256 return EFI_LOAD_ERROR;
257 }
258#else
AKASHI Takahiro3ffc52f2019-04-19 12:22:30 +0900259 bootm_headers_t img = { 0 };
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900260 efi_status_t ret;
261
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100262 if (fdt == EFI_FDT_USE_INTERNAL) {
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100263 const char *fdt_opt;
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100264 uintptr_t fdt_addr;
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100265
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200266 /* Look for device tree that is already installed */
267 if (get_config_table(&efi_guid_fdt))
268 return EFI_SUCCESS;
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100269 /* Check if there is a hardware device tree */
270 fdt_opt = env_get("fdt_addr");
271 /* Use our own device tree as fallback */
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200272 if (!fdt_opt) {
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100273 fdt_opt = env_get("fdtcontroladdr");
274 if (!fdt_opt) {
275 printf("ERROR: need device tree\n");
276 return EFI_NOT_FOUND;
277 }
AKASHI Takahiro3ffc52f2019-04-19 12:22:30 +0900278 }
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200279 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
280 if (!fdt_addr) {
Heinrich Schuchardt753aa182019-12-04 12:31:12 +0100281 printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
AKASHI Takahiro3ffc52f2019-04-19 12:22:30 +0900282 return EFI_LOAD_ERROR;
283 }
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100284 fdt = map_sysmem(fdt_addr, 0);
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900285 }
286
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200287 /* Install device tree */
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200288 if (fdt_check_header(fdt)) {
289 printf("ERROR: invalid device tree\n");
290 return EFI_LOAD_ERROR;
291 }
292
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200293 /* Prepare device tree for payload */
294 ret = copy_fdt(&fdt);
295 if (ret) {
296 printf("ERROR: out of memory\n");
297 return EFI_OUT_OF_RESOURCES;
298 }
299
300 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
301 printf("ERROR: failed to process device tree\n");
302 return EFI_LOAD_ERROR;
303 }
304
Heinrich Schuchardtfef907b2020-03-14 10:59:34 +0100305 /* Create memory reservations as indicated by the device tree */
306 efi_carve_out_dt_rsv(fdt);
307
Heinrich Schuchardt61824952019-04-20 13:33:55 +0200308 /* Install device tree as UEFI table */
309 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
310 if (ret != EFI_SUCCESS) {
311 printf("ERROR: failed to install device tree\n");
312 return ret;
313 }
314#endif /* GENERATE_ACPI_TABLE */
315
AKASHI Takahiroe878e6a2019-04-19 12:22:29 +0900316 return EFI_SUCCESS;
317}
318
Simon Glass5e2f0392018-11-25 20:14:39 -0700319/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200320 * do_bootefi_exec() - execute EFI binary
321 *
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900322 * @handle: handle of loaded image
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200323 * Return: status code
324 *
325 * Load the EFI binary into a newly assigned memory unwinding the relocation
326 * information, install the loaded image protocol, and call the binary.
Alexander Grafb9939332016-03-10 00:27:20 +0100327 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900328static efi_status_t do_bootefi_exec(efi_handle_t handle)
Alexander Grafb9939332016-03-10 00:27:20 +0100329{
Heinrich Schuchardt45204b12018-03-03 15:29:01 +0100330 efi_status_t ret;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200331 efi_uintn_t exit_data_size = 0;
332 u16 *exit_data = NULL;
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100333 u16 *load_options;
Rob Clark95c55532017-09-13 18:05:33 -0400334
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900335 /* Transfer environment variable as load options */
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100336 ret = set_load_options(handle, "bootargs", &load_options);
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900337 if (ret != EFI_SUCCESS)
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900338 return ret;
Rob Clarkbf192732017-10-10 08:23:06 -0400339
Alexander Grafb9939332016-03-10 00:27:20 +0100340 /* Call our payload! */
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200341 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
342 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
343 if (ret && exit_data) {
344 printf("## %ls\n", exit_data);
345 efi_free_pool(exit_data);
346 }
Rob Clark95c55532017-09-13 18:05:33 -0400347
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900348 efi_restore_gd();
Simon Glass5e2f0392018-11-25 20:14:39 -0700349
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100350 free(load_options);
Rob Clark95c55532017-09-13 18:05:33 -0400351
352 return ret;
Alexander Grafb9939332016-03-10 00:27:20 +0100353}
354
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900355/**
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200356 * do_efibootmgr() - execute EFI boot manager
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900357 *
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900358 * Return: status code
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900359 */
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200360static int do_efibootmgr(void)
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900361{
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900362 efi_handle_t handle;
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900363 efi_status_t ret;
364
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900365 ret = efi_bootmgr_load(&handle);
366 if (ret != EFI_SUCCESS) {
367 printf("EFI boot manager: Cannot load any image\n");
368 return CMD_RET_FAILURE;
369 }
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900370
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900371 ret = do_bootefi_exec(handle);
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900372
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900373 if (ret != EFI_SUCCESS)
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900374 return CMD_RET_FAILURE;
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900375
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900376 return CMD_RET_SUCCESS;
AKASHI Takahirocc999d52019-04-19 12:22:32 +0900377}
378
Heinrich Schuchardt810371a2019-07-14 13:00:44 +0200379/**
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200380 * do_bootefi_image() - execute EFI binary
381 *
382 * Set up memory image for the binary to be loaded, prepare device path, and
383 * then call do_bootefi_exec() to execute it.
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900384 *
385 * @image_opt: string of image start address
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900386 * Return: status code
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900387 */
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200388static int do_bootefi_image(const char *image_opt)
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900389{
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900390 void *image_buf;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900391 unsigned long addr, size;
392 const char *size_str;
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900393 efi_status_t ret;
394
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900395#ifdef CONFIG_CMD_BOOTEFI_HELLO
396 if (!strcmp(image_opt, "hello")) {
397 char *saddr;
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900398
399 saddr = env_get("loadaddr");
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900400 size = __efi_helloworld_end - __efi_helloworld_begin;
401
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900402 if (saddr)
403 addr = simple_strtoul(saddr, NULL, 16);
404 else
405 addr = CONFIG_SYS_LOAD_ADDR;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900406
407 image_buf = map_sysmem(addr, size);
408 memcpy(image_buf, __efi_helloworld_begin, size);
409
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100410 efi_free_pool(bootefi_device_path);
411 efi_free_pool(bootefi_image_path);
412 bootefi_device_path = NULL;
413 bootefi_image_path = NULL;
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900414 } else
415#endif
416 {
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900417 size_str = env_get("filesize");
418 if (size_str)
419 size = simple_strtoul(size_str, NULL, 16);
420 else
421 size = 0;
422
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900423 addr = simple_strtoul(image_opt, NULL, 16);
424 /* Check that a numeric value was passed */
425 if (!addr && *image_opt != '0')
426 return CMD_RET_USAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900427
428 image_buf = map_sysmem(addr, size);
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900429 }
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100430 ret = efi_run_image(image_buf, size);
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900431
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100432 if (ret != EFI_SUCCESS)
433 return CMD_RET_FAILURE;
434
435 return CMD_RET_SUCCESS;
436}
437
438/**
439 * efi_run_image() - run loaded UEFI image
440 *
441 * @source_buffer: memory address of the UEFI image
442 * @source_size: size of the UEFI image
443 * Return: status code
444 */
445efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
446{
447 efi_handle_t mem_handle = NULL, handle;
448 struct efi_device_path *file_path = NULL;
449 efi_status_t ret;
450
451 if (!bootefi_device_path || !bootefi_image_path) {
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900452 /*
453 * Special case for efi payload not loaded from disk,
454 * such as 'bootefi hello' or for example payload
455 * loaded directly into memory via JTAG, etc:
456 */
457 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100458 (uintptr_t)source_buffer,
459 source_size);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900460 /*
461 * Make sure that device for device_path exist
462 * in load_image(). Otherwise, shell and grub will fail.
463 */
464 ret = efi_create_handle(&mem_handle);
465 if (ret != EFI_SUCCESS)
466 goto out;
467
468 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
469 file_path);
470 if (ret != EFI_SUCCESS)
471 goto out;
472 } else {
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100473 file_path = efi_dp_append(bootefi_device_path,
474 bootefi_image_path);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900475 }
476
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100477 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
478 source_size, &handle));
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900479 if (ret != EFI_SUCCESS)
480 goto out;
481
482 ret = do_bootefi_exec(handle);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900483
484out:
Heinrich Schuchardt4fe050e2020-04-20 12:44:56 +0200485 efi_delete_handle(mem_handle);
486 efi_free_pool(file_path);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100487 return ret;
AKASHI Takahiroe2e40982019-04-19 12:22:34 +0900488}
489
Simon Glassd9717ea2018-11-25 20:14:37 -0700490#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900491static efi_status_t bootefi_run_prepare(const char *load_options_path,
492 struct efi_device_path *device_path,
493 struct efi_device_path *image_path,
494 struct efi_loaded_image_obj **image_objp,
495 struct efi_loaded_image **loaded_image_infop)
496{
497 efi_status_t ret;
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100498 u16 *load_options;
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900499
500 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
501 loaded_image_infop);
502 if (ret != EFI_SUCCESS)
503 return ret;
504
505 /* Transfer environment variable as load options */
Heinrich Schuchardta3850e42020-01-03 22:53:42 +0100506 return set_load_options((efi_handle_t)*image_objp, load_options_path,
507 &load_options);
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900508}
509
Simon Glassd9717ea2018-11-25 20:14:37 -0700510/**
511 * bootefi_test_prepare() - prepare to run an EFI test
512 *
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100513 * Prepare to run a test as if it were provided by a loaded image.
Simon Glassd9717ea2018-11-25 20:14:37 -0700514 *
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100515 * @image_objp: pointer to be set to the loaded image handle
516 * @loaded_image_infop: pointer to be set to the loaded image protocol
517 * @path: dummy file path used to construct the device path
518 * set in the loaded image protocol
519 * @load_options_path: name of a U-Boot environment variable. Its value is
520 * set as load options in the loaded image protocol.
521 * Return: status code
Simon Glassd9717ea2018-11-25 20:14:37 -0700522 */
523static efi_status_t bootefi_test_prepare
524 (struct efi_loaded_image_obj **image_objp,
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100525 struct efi_loaded_image **loaded_image_infop, const char *path,
526 const char *load_options_path)
Simon Glassd9717ea2018-11-25 20:14:37 -0700527{
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100528 efi_status_t ret;
529
Simon Glassd9717ea2018-11-25 20:14:37 -0700530 /* Construct a dummy device path */
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100531 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
Simon Glassd9717ea2018-11-25 20:14:37 -0700532 if (!bootefi_device_path)
533 return EFI_OUT_OF_RESOURCES;
Simon Glassd9717ea2018-11-25 20:14:37 -0700534
Heinrich Schuchardt1504bb02019-01-12 14:42:40 +0100535 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
536 if (!bootefi_image_path) {
537 ret = EFI_OUT_OF_RESOURCES;
538 goto failure;
539 }
540
541 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
542 bootefi_image_path, image_objp,
543 loaded_image_infop);
544 if (ret == EFI_SUCCESS)
545 return ret;
546
547 efi_free_pool(bootefi_image_path);
548 bootefi_image_path = NULL;
549failure:
550 efi_free_pool(bootefi_device_path);
551 bootefi_device_path = NULL;
552 return ret;
Simon Glassd9717ea2018-11-25 20:14:37 -0700553}
554
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900555/**
556 * bootefi_run_finish() - finish up after running an EFI test
557 *
558 * @loaded_image_info: Pointer to a struct which holds the loaded image info
559 * @image_obj: Pointer to a struct which holds the loaded image object
560 */
561static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
562 struct efi_loaded_image *loaded_image_info)
563{
564 efi_restore_gd();
565 free(loaded_image_info->load_options);
566 efi_delete_handle(&image_obj->header);
567}
568
569/**
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200570 * do_efi_selftest() - execute EFI selftest
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900571 *
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900572 * Return: status code
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900573 */
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200574static int do_efi_selftest(void)
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900575{
576 struct efi_loaded_image_obj *image_obj;
577 struct efi_loaded_image *loaded_image_info;
578 efi_status_t ret;
579
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900580 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
581 "\\selftest", "efi_selftest");
582 if (ret != EFI_SUCCESS)
583 return CMD_RET_FAILURE;
584
585 /* Execute the test */
586 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
587 bootefi_run_finish(image_obj, loaded_image_info);
588
589 return ret != EFI_SUCCESS;
590}
Simon Glassd9717ea2018-11-25 20:14:37 -0700591#endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
592
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200593/**
594 * do_bootefi() - execute `bootefi` command
595 *
596 * @cmdtp: table entry describing command
597 * @flag: bitmap indicating how the command was invoked
598 * @argc: number of arguments
599 * @argv: command line arguments
600 * Return: status code
601 */
Simon Glass09140112020-05-10 11:40:03 -0600602static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
603 char *const argv[])
Alexander Grafb9939332016-03-10 00:27:20 +0100604{
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200605 efi_status_t ret;
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100606 void *fdt;
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200607
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900608 if (argc < 2)
609 return CMD_RET_USAGE;
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900610
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200611 /* Initialize EFI drivers */
612 ret = efi_init_obj_list();
613 if (ret != EFI_SUCCESS) {
614 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
615 ret & ~EFI_ERROR_MASK);
616 return CMD_RET_FAILURE;
617 }
618
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100619 if (argc > 2) {
620 uintptr_t fdt_addr;
621
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100622 fdt_addr = simple_strtoul(argv[2], NULL, 16);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100623 fdt = map_sysmem(fdt_addr, 0);
624 } else {
625 fdt = EFI_FDT_USE_INTERNAL;
626 }
627 ret = efi_install_fdt(fdt);
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200628 if (ret == EFI_INVALID_PARAMETER)
629 return CMD_RET_USAGE;
630 else if (ret != EFI_SUCCESS)
631 return CMD_RET_FAILURE;
632
AKASHI Takahirod6b21892019-04-19 12:22:33 +0900633 if (!strcmp(argv[1], "bootmgr"))
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200634 return do_efibootmgr();
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900635#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
636 else if (!strcmp(argv[1], "selftest"))
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200637 return do_efi_selftest();
AKASHI Takahiro3fc2b162019-04-19 12:22:31 +0900638#endif
639
Heinrich Schuchardt7e92db82019-05-12 20:16:25 +0200640 return do_bootefi_image(argv[1]);
Alexander Grafb9939332016-03-10 00:27:20 +0100641}
642
643#ifdef CONFIG_SYS_LONGHELP
644static char bootefi_help_text[] =
Alexander Graf1c398092016-04-14 16:07:53 +0200645 "<image address> [fdt address]\n"
646 " - boot EFI payload stored at address <image address>.\n"
647 " If specified, the device tree located at <fdt address> gets\n"
Simon Glassc7ae3df2016-11-07 08:47:08 -0700648 " exposed as EFI configuration table.\n"
649#ifdef CONFIG_CMD_BOOTEFI_HELLO
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200650 "bootefi hello\n"
651 " - boot a sample Hello World application stored within U-Boot\n"
652#endif
653#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100654 "bootefi selftest [fdt address]\n"
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200655 " - boot an EFI selftest application stored within U-Boot\n"
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200656 " Use environment variable efi_selftest to select a single test.\n"
657 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
Simon Glassc7ae3df2016-11-07 08:47:08 -0700658#endif
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900659 "bootefi bootmgr [fdt address]\n"
Rob Clark9975fe92017-09-13 18:05:38 -0400660 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
661 "\n"
662 " If specified, the device tree located at <fdt address> gets\n"
663 " exposed as EFI configuration table.\n";
Alexander Grafb9939332016-03-10 00:27:20 +0100664#endif
665
666U_BOOT_CMD(
Alexander Graf1c398092016-04-14 16:07:53 +0200667 bootefi, 3, 0, do_bootefi,
Sergey Kubushyn92dfd922016-06-07 11:14:31 -0700668 "Boots an EFI payload from memory",
Alexander Grafb9939332016-03-10 00:27:20 +0100669 bootefi_help_text
670);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100671
Heinrich Schuchardt810371a2019-07-14 13:00:44 +0200672/**
673 * efi_set_bootdev() - set boot device
674 *
675 * This function is called when a file is loaded, e.g. via the 'load' command.
676 * We use the path to this file to inform the UEFI binary about the boot device.
677 *
678 * @dev: device, e.g. "MMC"
679 * @devnr: number of the device, e.g. "1:2"
680 * @path: path to file loaded
681 */
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200682void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
Alexander Graf0f4060e2016-03-04 01:10:14 +0100683{
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900684 struct efi_device_path *device, *image;
685 efi_status_t ret;
Alexander Graf0f4060e2016-03-04 01:10:14 +0100686
Heinrich Schuchardt79276eb2018-09-16 07:20:21 +0200687 /* efi_set_bootdev is typically called repeatedly, recover memory */
688 efi_free_pool(bootefi_device_path);
689 efi_free_pool(bootefi_image_path);
Heinrich Schuchardt79276eb2018-09-16 07:20:21 +0200690
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900691 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
692 if (ret == EFI_SUCCESS) {
693 bootefi_device_path = device;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900694 if (image) {
695 /* FIXME: image should not contain device */
696 struct efi_device_path *image_tmp = image;
697
698 efi_dp_split_file_path(image, &device, &image);
699 efi_free_pool(image_tmp);
700 }
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900701 bootefi_image_path = image;
Rob Clark95c55532017-09-13 18:05:33 -0400702 } else {
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900703 bootefi_device_path = NULL;
704 bootefi_image_path = NULL;
Alexander Graff9d334b2016-08-05 14:49:53 +0200705 }
Alexander Graf0f4060e2016-03-04 01:10:14 +0100706}