Merge tag 'signed-efi-next' of git://github.com/agraf/u-boot
[platform/kernel/u-boot.git] / cmd / bootefi.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  *  EFI application loader
4  *
5  *  Copyright (c) 2016 Alexander Graf
6  */
7
8 #include <charset.h>
9 #include <common.h>
10 #include <command.h>
11 #include <dm.h>
12 #include <efi_loader.h>
13 #include <efi_selftest.h>
14 #include <errno.h>
15 #include <linux/libfdt.h>
16 #include <linux/libfdt_env.h>
17 #include <memalign.h>
18 #include <asm/global_data.h>
19 #include <asm-generic/sections.h>
20 #include <asm-generic/unaligned.h>
21 #include <linux/linkage.h>
22
23 DECLARE_GLOBAL_DATA_PTR;
24
25 #define OBJ_LIST_NOT_INITIALIZED 1
26
27 static efi_status_t efi_obj_list_initialized = OBJ_LIST_NOT_INITIALIZED;
28
29 static struct efi_device_path *bootefi_image_path;
30 static struct efi_device_path *bootefi_device_path;
31
32 /* Initialize and populate EFI object list */
33 efi_status_t efi_init_obj_list(void)
34 {
35         efi_status_t ret = EFI_SUCCESS;
36
37         /* Initialize once only */
38         if (efi_obj_list_initialized != OBJ_LIST_NOT_INITIALIZED)
39                 return efi_obj_list_initialized;
40
41         /* Initialize EFI driver uclass */
42         ret = efi_driver_init();
43         if (ret != EFI_SUCCESS)
44                 goto out;
45
46         ret = efi_console_register();
47         if (ret != EFI_SUCCESS)
48                 goto out;
49 #ifdef CONFIG_PARTITIONS
50         ret = efi_disk_register();
51         if (ret != EFI_SUCCESS)
52                 goto out;
53 #endif
54 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
55         ret = efi_gop_register();
56         if (ret != EFI_SUCCESS)
57                 goto out;
58 #endif
59 #ifdef CONFIG_NET
60         ret = efi_net_register();
61         if (ret != EFI_SUCCESS)
62                 goto out;
63 #endif
64 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
65         ret = efi_smbios_register();
66         if (ret != EFI_SUCCESS)
67                 goto out;
68 #endif
69         ret = efi_watchdog_register();
70         if (ret != EFI_SUCCESS)
71                 goto out;
72
73         /* Initialize EFI runtime services */
74         ret = efi_reset_system_init();
75         if (ret != EFI_SUCCESS)
76                 goto out;
77         ret = efi_get_time_init();
78         if (ret != EFI_SUCCESS)
79                 goto out;
80
81 out:
82         efi_obj_list_initialized = ret;
83         return ret;
84 }
85
86 /*
87  * Allow unaligned memory access.
88  *
89  * This routine is overridden by architectures providing this feature.
90  */
91 void __weak allow_unaligned(void)
92 {
93 }
94
95 /*
96  * Set the load options of an image from an environment variable.
97  *
98  * @loaded_image_info:  the image
99  * @env_var:            name of the environment variable
100  */
101 static void set_load_options(struct efi_loaded_image *loaded_image_info,
102                              const char *env_var)
103 {
104         size_t size;
105         const char *env = env_get(env_var);
106
107         loaded_image_info->load_options = NULL;
108         loaded_image_info->load_options_size = 0;
109         if (!env)
110                 return;
111         size = strlen(env) + 1;
112         loaded_image_info->load_options = calloc(size, sizeof(u16));
113         if (!loaded_image_info->load_options) {
114                 printf("ERROR: Out of memory\n");
115                 return;
116         }
117         utf8_to_utf16(loaded_image_info->load_options, (u8 *)env, size);
118         loaded_image_info->load_options_size = size * 2;
119 }
120
121 static void *copy_fdt(void *fdt)
122 {
123         u64 fdt_size = fdt_totalsize(fdt);
124         unsigned long fdt_ram_start = -1L, fdt_pages;
125         u64 new_fdt_addr;
126         void *new_fdt;
127         int i;
128
129         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
130                 u64 ram_start = gd->bd->bi_dram[i].start;
131                 u64 ram_size = gd->bd->bi_dram[i].size;
132
133                 if (!ram_size)
134                         continue;
135
136                 if (ram_start < fdt_ram_start)
137                         fdt_ram_start = ram_start;
138         }
139
140         /* Give us at least 4kb breathing room */
141         fdt_size = ALIGN(fdt_size + 4096, EFI_PAGE_SIZE);
142         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
143
144         /* Safe fdt location is at 128MB */
145         new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
146         if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
147                                EFI_RUNTIME_SERVICES_DATA, fdt_pages,
148                                &new_fdt_addr) != EFI_SUCCESS) {
149                 /* If we can't put it there, put it somewhere */
150                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
151                 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
152                                        EFI_RUNTIME_SERVICES_DATA, fdt_pages,
153                                        &new_fdt_addr) != EFI_SUCCESS) {
154                         printf("ERROR: Failed to reserve space for FDT\n");
155                         return NULL;
156                 }
157         }
158
159         new_fdt = (void*)(ulong)new_fdt_addr;
160         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
161         fdt_set_totalsize(new_fdt, fdt_size);
162
163         return new_fdt;
164 }
165
166 static efi_status_t efi_do_enter(
167                         efi_handle_t image_handle, struct efi_system_table *st,
168                         EFIAPI efi_status_t (*entry)(
169                                 efi_handle_t image_handle,
170                                 struct efi_system_table *st))
171 {
172         efi_status_t ret = EFI_LOAD_ERROR;
173
174         if (entry)
175                 ret = entry(image_handle, st);
176         st->boottime->exit(image_handle, ret, 0, NULL);
177         return ret;
178 }
179
180 #ifdef CONFIG_ARM64
181 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
182                         efi_handle_t image_handle, struct efi_system_table *st),
183                         efi_handle_t image_handle, struct efi_system_table *st)
184 {
185         /* Enable caches again */
186         dcache_enable();
187
188         return efi_do_enter(image_handle, st, entry);
189 }
190 #endif
191
192 /* Carve out DT reserved memory ranges */
193 static efi_status_t efi_carve_out_dt_rsv(void *fdt)
194 {
195         int nr_rsv, i;
196         uint64_t addr, size, pages;
197
198         nr_rsv = fdt_num_mem_rsv(fdt);
199
200         /* Look for an existing entry and add it to the efi mem map. */
201         for (i = 0; i < nr_rsv; i++) {
202                 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
203                         continue;
204
205                 pages = ALIGN(size, EFI_PAGE_SIZE) >> EFI_PAGE_SHIFT;
206                 efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
207                                    false);
208         }
209
210         return EFI_SUCCESS;
211 }
212
213 static efi_status_t efi_install_fdt(void *fdt)
214 {
215         bootm_headers_t img = { 0 };
216         ulong fdt_pages, fdt_size, fdt_start, fdt_end;
217         efi_status_t ret;
218
219         if (fdt_check_header(fdt)) {
220                 printf("ERROR: invalid device tree\n");
221                 return EFI_INVALID_PARAMETER;
222         }
223
224         /* Prepare fdt for payload */
225         fdt = copy_fdt(fdt);
226         if (!fdt)
227                 return EFI_OUT_OF_RESOURCES;
228
229         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
230                 printf("ERROR: failed to process device tree\n");
231                 return EFI_LOAD_ERROR;
232         }
233
234         if (efi_carve_out_dt_rsv(fdt) != EFI_SUCCESS) {
235                 printf("ERROR: failed to carve out memory\n");
236                 return EFI_LOAD_ERROR;
237         }
238
239         /* Link to it in the efi tables */
240         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
241         if (ret != EFI_SUCCESS)
242                 return EFI_OUT_OF_RESOURCES;
243
244         /* And reserve the space in the memory map */
245         fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
246         fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
247         fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
248         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
249         /* Give a bootloader the chance to modify the device tree */
250         fdt_pages += 2;
251         ret = efi_add_memory_map(fdt_start, fdt_pages,
252                                  EFI_BOOT_SERVICES_DATA, true);
253         return ret;
254 }
255
256 /*
257  * Load an EFI payload into a newly allocated piece of memory, register all
258  * EFI objects it would want to access and jump to it.
259  */
260 static efi_status_t do_bootefi_exec(void *efi,
261                                     struct efi_device_path *device_path,
262                                     struct efi_device_path *image_path)
263 {
264         struct efi_loaded_image loaded_image_info = {};
265         struct efi_object loaded_image_info_obj = {};
266         struct efi_device_path *memdp = NULL;
267         efi_status_t ret;
268
269         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
270                                      struct efi_system_table *st);
271
272         /*
273          * Special case for efi payload not loaded from disk, such as
274          * 'bootefi hello' or for example payload loaded directly into
275          * memory via jtag/etc:
276          */
277         if (!device_path && !image_path) {
278                 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
279                 /* actual addresses filled in after efi_load_pe() */
280                 memdp = efi_dp_from_mem(0, 0, 0);
281                 device_path = image_path = memdp;
282         } else {
283                 assert(device_path && image_path);
284         }
285
286         efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
287                                device_path, image_path);
288
289         /*
290          * gd lives in a fixed register which may get clobbered while we execute
291          * the payload. So save it here and restore it on every callback entry
292          */
293         efi_save_gd();
294
295         /* Transfer environment variable bootargs as load options */
296         set_load_options(&loaded_image_info, "bootargs");
297         /* Load the EFI payload */
298         entry = efi_load_pe(efi, &loaded_image_info);
299         if (!entry) {
300                 ret = EFI_LOAD_ERROR;
301                 goto exit;
302         }
303
304         if (memdp) {
305                 struct efi_device_path_memory *mdp = (void *)memdp;
306                 mdp->memory_type = loaded_image_info.image_code_type;
307                 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
308                 mdp->end_address = mdp->start_address +
309                                 loaded_image_info.image_size;
310         }
311
312         /* we don't support much: */
313         env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
314                 "{ro,boot}(blob)0000000000000000");
315
316         /* Call our payload! */
317         debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
318
319         if (setjmp(&loaded_image_info.exit_jmp)) {
320                 ret = loaded_image_info.exit_status;
321                 goto exit;
322         }
323
324 #ifdef CONFIG_ARM64
325         /* On AArch64 we need to make sure we call our payload in < EL3 */
326         if (current_el() == 3) {
327                 smp_kick_all_cpus();
328                 dcache_disable();       /* flush cache before switch to EL2 */
329
330                 /* Move into EL2 and keep running there */
331                 armv8_switch_to_el2((ulong)entry,
332                                     (ulong)&loaded_image_info_obj.handle,
333                                     (ulong)&systab, 0, (ulong)efi_run_in_el2,
334                                     ES_TO_AARCH64);
335
336                 /* Should never reach here, efi exits with longjmp */
337                 while (1) { }
338         }
339 #endif
340
341         ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
342
343 exit:
344         /* image has returned, loaded-image obj goes *poof*: */
345         list_del(&loaded_image_info_obj.link);
346
347         return ret;
348 }
349
350 static int do_bootefi_bootmgr_exec(void)
351 {
352         struct efi_device_path *device_path, *file_path;
353         void *addr;
354         efi_status_t r;
355
356         /*
357          * gd lives in a fixed register which may get clobbered while we execute
358          * the payload. So save it here and restore it on every callback entry
359          */
360         efi_save_gd();
361
362         addr = efi_bootmgr_load(&device_path, &file_path);
363         if (!addr)
364                 return 1;
365
366         printf("## Starting EFI application at %p ...\n", addr);
367         r = do_bootefi_exec(addr, device_path, file_path);
368         printf("## Application terminated, r = %lu\n",
369                r & ~EFI_ERROR_MASK);
370
371         if (r != EFI_SUCCESS)
372                 return 1;
373
374         return 0;
375 }
376
377 /* Interpreter command to boot an arbitrary EFI image from memory */
378 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
379 {
380         unsigned long addr;
381         char *saddr;
382         efi_status_t r;
383         void *fdt_addr;
384
385         /* Allow unaligned memory access */
386         allow_unaligned();
387
388         /* Initialize EFI drivers */
389         r = efi_init_obj_list();
390         if (r != EFI_SUCCESS) {
391                 printf("Error: Cannot set up EFI drivers, r = %lu\n",
392                        r & ~EFI_ERROR_MASK);
393                 return CMD_RET_FAILURE;
394         }
395
396         if (argc < 2)
397                 return CMD_RET_USAGE;
398
399         if (argc > 2) {
400                 fdt_addr = (void *)simple_strtoul(argv[2], NULL, 16);
401                 if (!fdt_addr && *argv[2] != '0')
402                         return CMD_RET_USAGE;
403                 /* Install device tree */
404                 r = efi_install_fdt(fdt_addr);
405                 if (r != EFI_SUCCESS) {
406                         printf("ERROR: failed to install device tree\n");
407                         return CMD_RET_FAILURE;
408                 }
409         } else {
410                 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
411                 efi_install_configuration_table(&efi_guid_fdt, NULL);
412                 printf("WARNING: booting without device tree\n");
413         }
414 #ifdef CONFIG_CMD_BOOTEFI_HELLO
415         if (!strcmp(argv[1], "hello")) {
416                 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
417
418                 saddr = env_get("loadaddr");
419                 if (saddr)
420                         addr = simple_strtoul(saddr, NULL, 16);
421                 else
422                         addr = CONFIG_SYS_LOAD_ADDR;
423                 memcpy((char *)addr, __efi_helloworld_begin, size);
424         } else
425 #endif
426 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
427         if (!strcmp(argv[1], "selftest")) {
428                 struct efi_loaded_image loaded_image_info = {};
429                 struct efi_object loaded_image_info_obj = {};
430
431                 /* Construct a dummy device path. */
432                 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
433                                                       (uintptr_t)&efi_selftest,
434                                                       (uintptr_t)&efi_selftest);
435                 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
436
437                 efi_setup_loaded_image(&loaded_image_info,
438                                        &loaded_image_info_obj,
439                                        bootefi_device_path, bootefi_image_path);
440                 /*
441                  * gd lives in a fixed register which may get clobbered while we
442                  * execute the payload. So save it here and restore it on every
443                  * callback entry
444                  */
445                 efi_save_gd();
446                 /* Transfer environment variable efi_selftest as load options */
447                 set_load_options(&loaded_image_info, "efi_selftest");
448                 /* Execute the test */
449                 r = efi_selftest(loaded_image_info_obj.handle, &systab);
450                 efi_restore_gd();
451                 free(loaded_image_info.load_options);
452                 list_del(&loaded_image_info_obj.link);
453                 return r != EFI_SUCCESS;
454         } else
455 #endif
456         if (!strcmp(argv[1], "bootmgr")) {
457                 return do_bootefi_bootmgr_exec();
458         } else {
459                 saddr = argv[1];
460
461                 addr = simple_strtoul(saddr, NULL, 16);
462                 /* Check that a numeric value was passed */
463                 if (!addr && *saddr != '0')
464                         return CMD_RET_USAGE;
465
466         }
467
468         printf("## Starting EFI application at %08lx ...\n", addr);
469         r = do_bootefi_exec((void *)addr, bootefi_device_path,
470                             bootefi_image_path);
471         printf("## Application terminated, r = %lu\n",
472                r & ~EFI_ERROR_MASK);
473
474         if (r != EFI_SUCCESS)
475                 return 1;
476         else
477                 return 0;
478 }
479
480 #ifdef CONFIG_SYS_LONGHELP
481 static char bootefi_help_text[] =
482         "<image address> [fdt address]\n"
483         "  - boot EFI payload stored at address <image address>.\n"
484         "    If specified, the device tree located at <fdt address> gets\n"
485         "    exposed as EFI configuration table.\n"
486 #ifdef CONFIG_CMD_BOOTEFI_HELLO
487         "bootefi hello\n"
488         "  - boot a sample Hello World application stored within U-Boot\n"
489 #endif
490 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
491         "bootefi selftest [fdt address]\n"
492         "  - boot an EFI selftest application stored within U-Boot\n"
493         "    Use environment variable efi_selftest to select a single test.\n"
494         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
495 #endif
496         "bootefi bootmgr [fdt addr]\n"
497         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
498         "\n"
499         "    If specified, the device tree located at <fdt address> gets\n"
500         "    exposed as EFI configuration table.\n";
501 #endif
502
503 U_BOOT_CMD(
504         bootefi, 3, 0, do_bootefi,
505         "Boots an EFI payload from memory",
506         bootefi_help_text
507 );
508
509 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
510 {
511         char filename[32] = { 0 }; /* dp->str is u16[32] long */
512         char *s;
513
514         if (strcmp(dev, "Net")) {
515                 struct blk_desc *desc;
516                 disk_partition_t fs_partition;
517                 int part;
518
519                 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
520                                                1);
521                 if (part < 0)
522                         return;
523
524                 bootefi_device_path = efi_dp_from_part(desc, part);
525         } else {
526 #ifdef CONFIG_NET
527                 bootefi_device_path = efi_dp_from_eth();
528 #endif
529         }
530
531         if (!path)
532                 return;
533
534         if (strcmp(dev, "Net")) {
535                 /* Add leading / to fs paths, because they're absolute */
536                 snprintf(filename, sizeof(filename), "/%s", path);
537         } else {
538                 snprintf(filename, sizeof(filename), "%s", path);
539         }
540         /* DOS style file path: */
541         s = filename;
542         while ((s = strchr(s, '/')))
543                 *s++ = '\\';
544         bootefi_image_path = efi_dp_from_file(NULL, 0, filename);
545 }