1f739fcd8STom Rini // SPDX-License-Identifier: GPL-2.0+ 2b9939336SAlexander Graf /* 3b9939336SAlexander Graf * EFI application loader 4b9939336SAlexander Graf * 5b9939336SAlexander Graf * Copyright (c) 2016 Alexander Graf 6b9939336SAlexander Graf */ 7b9939336SAlexander Graf 8d78e40d6SHeinrich Schuchardt #include <charset.h> 9b9939336SAlexander Graf #include <common.h> 10b9939336SAlexander Graf #include <command.h> 119d922450SSimon Glass #include <dm.h> 12b9939336SAlexander Graf #include <efi_loader.h> 13d78e40d6SHeinrich Schuchardt #include <efi_selftest.h> 14b9939336SAlexander Graf #include <errno.h> 15b08c8c48SMasahiro Yamada #include <linux/libfdt.h> 16b08c8c48SMasahiro Yamada #include <linux/libfdt_env.h> 17354264b3SAlexander Graf #include <mapmem.h> 18ad0c1a3dSAlexander Graf #include <memalign.h> 190d9d501fSAlexander Graf #include <asm/global_data.h> 20e275458cSSimon Glass #include <asm-generic/sections.h> 21c3b11deaSHeinrich Schuchardt #include <asm-generic/unaligned.h> 22e275458cSSimon Glass #include <linux/linkage.h> 230d9d501fSAlexander Graf 24dc500c36SMark Kettenis #ifdef CONFIG_ARMV7_NONSEC 25dc500c36SMark Kettenis #include <asm/armv7.h> 26dc500c36SMark Kettenis #include <asm/secure.h> 27dc500c36SMark Kettenis #endif 28dc500c36SMark Kettenis 290d9d501fSAlexander Graf DECLARE_GLOBAL_DATA_PTR; 30b9939336SAlexander Graf 31fc225e60SHeinrich Schuchardt #define OBJ_LIST_NOT_INITIALIZED 1 32fc225e60SHeinrich Schuchardt 33fc225e60SHeinrich Schuchardt static efi_status_t efi_obj_list_initialized = OBJ_LIST_NOT_INITIALIZED; 347cbc1241SHeinrich Schuchardt 3595c5553eSRob Clark static struct efi_device_path *bootefi_image_path; 3695c5553eSRob Clark static struct efi_device_path *bootefi_device_path; 37b9939336SAlexander Graf 387cbc1241SHeinrich Schuchardt /* Initialize and populate EFI object list */ 39fc225e60SHeinrich Schuchardt efi_status_t efi_init_obj_list(void) 407cbc1241SHeinrich Schuchardt { 41fc225e60SHeinrich Schuchardt efi_status_t ret = EFI_SUCCESS; 42fc225e60SHeinrich Schuchardt 431e1e1c27SHeinrich Schuchardt /* 441e1e1c27SHeinrich Schuchardt * On the ARM architecture gd is mapped to a fixed register (r9 or x18). 451e1e1c27SHeinrich Schuchardt * As this register may be overwritten by an EFI payload we save it here 461e1e1c27SHeinrich Schuchardt * and restore it on every callback entered. 471e1e1c27SHeinrich Schuchardt */ 481e1e1c27SHeinrich Schuchardt efi_save_gd(); 491e1e1c27SHeinrich Schuchardt 50098a6cddSHeinrich Schuchardt /* Initialize once only */ 51fc225e60SHeinrich Schuchardt if (efi_obj_list_initialized != OBJ_LIST_NOT_INITIALIZED) 52fc225e60SHeinrich Schuchardt return efi_obj_list_initialized; 537cbc1241SHeinrich Schuchardt 54640adadfSHeinrich Schuchardt /* Initialize system table */ 55640adadfSHeinrich Schuchardt ret = efi_initialize_system_table(); 56640adadfSHeinrich Schuchardt if (ret != EFI_SUCCESS) 57640adadfSHeinrich Schuchardt goto out; 58640adadfSHeinrich Schuchardt 594e6b5d65SHeinrich Schuchardt /* Initialize root node */ 604e6b5d65SHeinrich Schuchardt ret = efi_root_node_register(); 614e6b5d65SHeinrich Schuchardt if (ret != EFI_SUCCESS) 624e6b5d65SHeinrich Schuchardt goto out; 634e6b5d65SHeinrich Schuchardt 6405ef48a2SHeinrich Schuchardt /* Initialize EFI driver uclass */ 65fc225e60SHeinrich Schuchardt ret = efi_driver_init(); 66fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 67fc225e60SHeinrich Schuchardt goto out; 6805ef48a2SHeinrich Schuchardt 69fc225e60SHeinrich Schuchardt ret = efi_console_register(); 70fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 71fc225e60SHeinrich Schuchardt goto out; 727cbc1241SHeinrich Schuchardt #ifdef CONFIG_PARTITIONS 73fc225e60SHeinrich Schuchardt ret = efi_disk_register(); 74fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 75fc225e60SHeinrich Schuchardt goto out; 767cbc1241SHeinrich Schuchardt #endif 777cbc1241SHeinrich Schuchardt #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO) 78fc225e60SHeinrich Schuchardt ret = efi_gop_register(); 79fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 80fc225e60SHeinrich Schuchardt goto out; 817cbc1241SHeinrich Schuchardt #endif 82092f2f35SJoe Hershberger #ifdef CONFIG_NET 83fc225e60SHeinrich Schuchardt ret = efi_net_register(); 84fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 85fc225e60SHeinrich Schuchardt goto out; 867cbc1241SHeinrich Schuchardt #endif 8786df34d4SBin Meng #ifdef CONFIG_GENERATE_ACPI_TABLE 8886df34d4SBin Meng ret = efi_acpi_register(); 8986df34d4SBin Meng if (ret != EFI_SUCCESS) 9086df34d4SBin Meng goto out; 9186df34d4SBin Meng #endif 927cbc1241SHeinrich Schuchardt #ifdef CONFIG_GENERATE_SMBIOS_TABLE 93fc225e60SHeinrich Schuchardt ret = efi_smbios_register(); 94fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 95fc225e60SHeinrich Schuchardt goto out; 967cbc1241SHeinrich Schuchardt #endif 97fc225e60SHeinrich Schuchardt ret = efi_watchdog_register(); 98fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 99fc225e60SHeinrich Schuchardt goto out; 1007cbc1241SHeinrich Schuchardt 1017cbc1241SHeinrich Schuchardt /* Initialize EFI runtime services */ 102fc225e60SHeinrich Schuchardt ret = efi_reset_system_init(); 103fc225e60SHeinrich Schuchardt if (ret != EFI_SUCCESS) 104fc225e60SHeinrich Schuchardt goto out; 105fc225e60SHeinrich Schuchardt 106fc225e60SHeinrich Schuchardt out: 107fc225e60SHeinrich Schuchardt efi_obj_list_initialized = ret; 108fc225e60SHeinrich Schuchardt return ret; 1097cbc1241SHeinrich Schuchardt } 1107cbc1241SHeinrich Schuchardt 111d78e40d6SHeinrich Schuchardt /* 112c3b11deaSHeinrich Schuchardt * Allow unaligned memory access. 113c3b11deaSHeinrich Schuchardt * 114c3b11deaSHeinrich Schuchardt * This routine is overridden by architectures providing this feature. 115c3b11deaSHeinrich Schuchardt */ 116c3b11deaSHeinrich Schuchardt void __weak allow_unaligned(void) 117c3b11deaSHeinrich Schuchardt { 118c3b11deaSHeinrich Schuchardt } 119c3b11deaSHeinrich Schuchardt 120c3b11deaSHeinrich Schuchardt /* 121d78e40d6SHeinrich Schuchardt * Set the load options of an image from an environment variable. 122d78e40d6SHeinrich Schuchardt * 123d78e40d6SHeinrich Schuchardt * @loaded_image_info: the image 124d78e40d6SHeinrich Schuchardt * @env_var: name of the environment variable 125d78e40d6SHeinrich Schuchardt */ 126d78e40d6SHeinrich Schuchardt static void set_load_options(struct efi_loaded_image *loaded_image_info, 127d78e40d6SHeinrich Schuchardt const char *env_var) 128d78e40d6SHeinrich Schuchardt { 129d78e40d6SHeinrich Schuchardt size_t size; 130d78e40d6SHeinrich Schuchardt const char *env = env_get(env_var); 1317086a71aSHeinrich Schuchardt u16 *pos; 132d78e40d6SHeinrich Schuchardt 133d78e40d6SHeinrich Schuchardt loaded_image_info->load_options = NULL; 134d78e40d6SHeinrich Schuchardt loaded_image_info->load_options_size = 0; 135d78e40d6SHeinrich Schuchardt if (!env) 136d78e40d6SHeinrich Schuchardt return; 1377086a71aSHeinrich Schuchardt size = utf8_utf16_strlen(env) + 1; 138d78e40d6SHeinrich Schuchardt loaded_image_info->load_options = calloc(size, sizeof(u16)); 139d78e40d6SHeinrich Schuchardt if (!loaded_image_info->load_options) { 140d78e40d6SHeinrich Schuchardt printf("ERROR: Out of memory\n"); 141d78e40d6SHeinrich Schuchardt return; 142d78e40d6SHeinrich Schuchardt } 1437086a71aSHeinrich Schuchardt pos = loaded_image_info->load_options; 1447086a71aSHeinrich Schuchardt utf8_utf16_strcpy(&pos, env); 145d78e40d6SHeinrich Schuchardt loaded_image_info->load_options_size = size * 2; 146d78e40d6SHeinrich Schuchardt } 147d78e40d6SHeinrich Schuchardt 1489dff4900SSimon Glass /** 1499dff4900SSimon Glass * copy_fdt() - Copy the device tree to a new location available to EFI 1509dff4900SSimon Glass * 1519dff4900SSimon Glass * The FDT is relocated into a suitable location within the EFI memory map. 1529dff4900SSimon Glass * An additional 12KB is added to the space in case the device tree needs to be 1539dff4900SSimon Glass * expanded later with fdt_open_into(). 1549dff4900SSimon Glass * 1559dff4900SSimon Glass * @fdt_addr: On entry, address of start of FDT. On exit, address of relocated 1569dff4900SSimon Glass * FDT start 1574574d1b3SHeinrich Schuchardt * Return: status code 1589dff4900SSimon Glass */ 1594574d1b3SHeinrich Schuchardt static efi_status_t copy_fdt(ulong *fdt_addrp) 1600d9d501fSAlexander Graf { 161ad0c1a3dSAlexander Graf unsigned long fdt_ram_start = -1L, fdt_pages; 1629dff4900SSimon Glass efi_status_t ret = 0; 1639dff4900SSimon Glass void *fdt, *new_fdt; 164ad0c1a3dSAlexander Graf u64 new_fdt_addr; 1659dff4900SSimon Glass uint fdt_size; 166ad0c1a3dSAlexander Graf int i; 1670d9d501fSAlexander Graf 168ad0c1a3dSAlexander Graf for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 169ad0c1a3dSAlexander Graf u64 ram_start = gd->bd->bi_dram[i].start; 170ad0c1a3dSAlexander Graf u64 ram_size = gd->bd->bi_dram[i].size; 1710d9d501fSAlexander Graf 172ad0c1a3dSAlexander Graf if (!ram_size) 173ad0c1a3dSAlexander Graf continue; 174ad0c1a3dSAlexander Graf 175ad0c1a3dSAlexander Graf if (ram_start < fdt_ram_start) 176ad0c1a3dSAlexander Graf fdt_ram_start = ram_start; 177ad0c1a3dSAlexander Graf } 178ad0c1a3dSAlexander Graf 179bc9a638aSSimon Glass /* 180bc9a638aSSimon Glass * Give us at least 4KB of breathing room in case the device tree needs 181bc9a638aSSimon Glass * to be expanded later. Round up to the nearest EFI page boundary. 182bc9a638aSSimon Glass */ 1839dff4900SSimon Glass fdt = map_sysmem(*fdt_addrp, 0); 1849dff4900SSimon Glass fdt_size = fdt_totalsize(fdt); 1859dff4900SSimon Glass fdt_size += 4096 * 3; 186bc9a638aSSimon Glass fdt_size = ALIGN(fdt_size + EFI_PAGE_SIZE - 1, EFI_PAGE_SIZE); 187ad0c1a3dSAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 188ad0c1a3dSAlexander Graf 189baf70c02SSimon Glass /* Safe fdt location is at 127MB */ 190baf70c02SSimon Glass new_fdt_addr = fdt_ram_start + (127 * 1024 * 1024) + fdt_size; 1919dff4900SSimon Glass ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, 192e09159c8SHeinrich Schuchardt EFI_RUNTIME_SERVICES_DATA, fdt_pages, 1939dff4900SSimon Glass &new_fdt_addr); 1949dff4900SSimon Glass if (ret != EFI_SUCCESS) { 195ad0c1a3dSAlexander Graf /* If we can't put it there, put it somewhere */ 196a44bffccSxypron.glpk@gmx.de new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size); 1979dff4900SSimon Glass ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, 198e09159c8SHeinrich Schuchardt EFI_RUNTIME_SERVICES_DATA, fdt_pages, 1999dff4900SSimon Glass &new_fdt_addr); 2009dff4900SSimon Glass if (ret != EFI_SUCCESS) { 20185a6e9b3SAlexander Graf printf("ERROR: Failed to reserve space for FDT\n"); 2029dff4900SSimon Glass goto done; 203ad0c1a3dSAlexander Graf } 20485a6e9b3SAlexander Graf } 20585a6e9b3SAlexander Graf 2069dff4900SSimon Glass new_fdt = map_sysmem(new_fdt_addr, fdt_size); 2070d9d501fSAlexander Graf memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 2080d9d501fSAlexander Graf fdt_set_totalsize(new_fdt, fdt_size); 2090d9d501fSAlexander Graf 2109dff4900SSimon Glass *fdt_addrp = new_fdt_addr; 2119dff4900SSimon Glass done: 2129dff4900SSimon Glass return ret; 2130d9d501fSAlexander Graf } 2140d9d501fSAlexander Graf 2153eb0841bSHeinrich Schuchardt static efi_status_t efi_do_enter( 2162074f700SHeinrich Schuchardt efi_handle_t image_handle, struct efi_system_table *st, 217c6fa5df6SAlexander Graf EFIAPI efi_status_t (*entry)( 218c6fa5df6SAlexander Graf efi_handle_t image_handle, 219b06d8ac3Sxypron.glpk@gmx.de struct efi_system_table *st)) 220b06d8ac3Sxypron.glpk@gmx.de { 221b06d8ac3Sxypron.glpk@gmx.de efi_status_t ret = EFI_LOAD_ERROR; 222b06d8ac3Sxypron.glpk@gmx.de 223b06d8ac3Sxypron.glpk@gmx.de if (entry) 224b06d8ac3Sxypron.glpk@gmx.de ret = entry(image_handle, st); 225b06d8ac3Sxypron.glpk@gmx.de st->boottime->exit(image_handle, ret, 0, NULL); 226b06d8ac3Sxypron.glpk@gmx.de return ret; 227b06d8ac3Sxypron.glpk@gmx.de } 228b06d8ac3Sxypron.glpk@gmx.de 229ec6617c3SAlison Wang #ifdef CONFIG_ARM64 230c6fa5df6SAlexander Graf static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)( 2312074f700SHeinrich Schuchardt efi_handle_t image_handle, struct efi_system_table *st), 2322074f700SHeinrich Schuchardt efi_handle_t image_handle, struct efi_system_table *st) 233ec6617c3SAlison Wang { 234ec6617c3SAlison Wang /* Enable caches again */ 235ec6617c3SAlison Wang dcache_enable(); 236ec6617c3SAlison Wang 237b06d8ac3Sxypron.glpk@gmx.de return efi_do_enter(image_handle, st, entry); 238ec6617c3SAlison Wang } 239ec6617c3SAlison Wang #endif 240ec6617c3SAlison Wang 241dc500c36SMark Kettenis #ifdef CONFIG_ARMV7_NONSEC 242f17f2001SMark Kettenis static bool is_nonsec; 243f17f2001SMark Kettenis 244dc500c36SMark Kettenis static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)( 245dc500c36SMark Kettenis efi_handle_t image_handle, struct efi_system_table *st), 246dc500c36SMark Kettenis efi_handle_t image_handle, struct efi_system_table *st) 247dc500c36SMark Kettenis { 248dc500c36SMark Kettenis /* Enable caches again */ 249dc500c36SMark Kettenis dcache_enable(); 250dc500c36SMark Kettenis 251f17f2001SMark Kettenis is_nonsec = true; 252f17f2001SMark Kettenis 253dc500c36SMark Kettenis return efi_do_enter(image_handle, st, entry); 254dc500c36SMark Kettenis } 255dc500c36SMark Kettenis #endif 256dc500c36SMark Kettenis 257416e07e2SSimon Glass /* 258416e07e2SSimon Glass * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges 259416e07e2SSimon Glass * 260416e07e2SSimon Glass * The mem_rsv entries of the FDT are added to the memory map. Any failures are 261416e07e2SSimon Glass * ignored because this is not critical and we would rather continue to try to 262416e07e2SSimon Glass * boot. 263416e07e2SSimon Glass * 264416e07e2SSimon Glass * @fdt: Pointer to device tree 265416e07e2SSimon Glass */ 266416e07e2SSimon Glass static void efi_carve_out_dt_rsv(void *fdt) 267806d2fa8SAlexander Graf { 268806d2fa8SAlexander Graf int nr_rsv, i; 269806d2fa8SAlexander Graf uint64_t addr, size, pages; 270806d2fa8SAlexander Graf 271806d2fa8SAlexander Graf nr_rsv = fdt_num_mem_rsv(fdt); 272806d2fa8SAlexander Graf 273806d2fa8SAlexander Graf /* Look for an existing entry and add it to the efi mem map. */ 274806d2fa8SAlexander Graf for (i = 0; i < nr_rsv; i++) { 275806d2fa8SAlexander Graf if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0) 276806d2fa8SAlexander Graf continue; 277806d2fa8SAlexander Graf 27823fd84b3SHeinrich Schuchardt /* 27923fd84b3SHeinrich Schuchardt * Do not carve out the device tree. It is already marked as 28023fd84b3SHeinrich Schuchardt * EFI_RUNTIME_SERVICES_DATA 28123fd84b3SHeinrich Schuchardt */ 28223fd84b3SHeinrich Schuchardt if (addr == (uintptr_t)fdt) 28323fd84b3SHeinrich Schuchardt continue; 28423fd84b3SHeinrich Schuchardt 28523fd84b3SHeinrich Schuchardt pages = ALIGN(size + (addr & EFI_PAGE_MASK), EFI_PAGE_SIZE) >> 28623fd84b3SHeinrich Schuchardt EFI_PAGE_SHIFT; 28723fd84b3SHeinrich Schuchardt addr &= ~EFI_PAGE_MASK; 288416e07e2SSimon Glass if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE, 289416e07e2SSimon Glass false)) 290416e07e2SSimon Glass printf("FDT memrsv map %d: Failed to add to map\n", i); 291806d2fa8SAlexander Graf } 292806d2fa8SAlexander Graf } 293806d2fa8SAlexander Graf 2949dff4900SSimon Glass static efi_status_t efi_install_fdt(ulong fdt_addr) 295bc4f9133SHeinrich Schuchardt { 296bc4f9133SHeinrich Schuchardt bootm_headers_t img = { 0 }; 297bc4f9133SHeinrich Schuchardt efi_status_t ret; 2989dff4900SSimon Glass void *fdt; 299bc4f9133SHeinrich Schuchardt 3009dff4900SSimon Glass fdt = map_sysmem(fdt_addr, 0); 301bc4f9133SHeinrich Schuchardt if (fdt_check_header(fdt)) { 302bc4f9133SHeinrich Schuchardt printf("ERROR: invalid device tree\n"); 303bc4f9133SHeinrich Schuchardt return EFI_INVALID_PARAMETER; 304bc4f9133SHeinrich Schuchardt } 305bc4f9133SHeinrich Schuchardt 306bc4f9133SHeinrich Schuchardt /* Prepare fdt for payload */ 3074574d1b3SHeinrich Schuchardt ret = copy_fdt(&fdt_addr); 3089dff4900SSimon Glass if (ret) 3099dff4900SSimon Glass return ret; 310bc4f9133SHeinrich Schuchardt 3119dff4900SSimon Glass unmap_sysmem(fdt); 3129dff4900SSimon Glass fdt = map_sysmem(fdt_addr, 0); 313bc4f9133SHeinrich Schuchardt if (image_setup_libfdt(&img, fdt, 0, NULL)) { 314bc4f9133SHeinrich Schuchardt printf("ERROR: failed to process device tree\n"); 315bc4f9133SHeinrich Schuchardt return EFI_LOAD_ERROR; 316bc4f9133SHeinrich Schuchardt } 317bc4f9133SHeinrich Schuchardt 318416e07e2SSimon Glass efi_carve_out_dt_rsv(fdt); 319806d2fa8SAlexander Graf 320bc4f9133SHeinrich Schuchardt /* Link to it in the efi tables */ 321bc4f9133SHeinrich Schuchardt ret = efi_install_configuration_table(&efi_guid_fdt, fdt); 322bc4f9133SHeinrich Schuchardt if (ret != EFI_SUCCESS) 323bc4f9133SHeinrich Schuchardt return EFI_OUT_OF_RESOURCES; 324bc4f9133SHeinrich Schuchardt 325bc4f9133SHeinrich Schuchardt return ret; 326bc4f9133SHeinrich Schuchardt } 327bc4f9133SHeinrich Schuchardt 328*f4f0f7cbSSimon Glass static efi_status_t bootefi_run_prepare(const char *load_options_path, 329*f4f0f7cbSSimon Glass struct efi_device_path *device_path, 330*f4f0f7cbSSimon Glass struct efi_device_path *image_path, 331*f4f0f7cbSSimon Glass struct efi_loaded_image_obj **image_objp, 332*f4f0f7cbSSimon Glass struct efi_loaded_image **loaded_image_infop) 333*f4f0f7cbSSimon Glass { 334*f4f0f7cbSSimon Glass efi_status_t ret; 335*f4f0f7cbSSimon Glass 336*f4f0f7cbSSimon Glass ret = efi_setup_loaded_image(device_path, image_path, image_objp, 337*f4f0f7cbSSimon Glass loaded_image_infop); 338*f4f0f7cbSSimon Glass if (ret != EFI_SUCCESS) 339*f4f0f7cbSSimon Glass return ret; 340*f4f0f7cbSSimon Glass 341*f4f0f7cbSSimon Glass /* Transfer environment variable as load options */ 342*f4f0f7cbSSimon Glass set_load_options(*loaded_image_infop, load_options_path); 343*f4f0f7cbSSimon Glass 344*f4f0f7cbSSimon Glass return 0; 345*f4f0f7cbSSimon Glass } 346*f4f0f7cbSSimon Glass 347c982874eSHeinrich Schuchardt /** 348c982874eSHeinrich Schuchardt * do_bootefi_exec() - execute EFI binary 349c982874eSHeinrich Schuchardt * 350c982874eSHeinrich Schuchardt * @efi: address of the binary 351c982874eSHeinrich Schuchardt * @device_path: path of the device from which the binary was loaded 352c982874eSHeinrich Schuchardt * @image_path: device path of the binary 353c982874eSHeinrich Schuchardt * Return: status code 354c982874eSHeinrich Schuchardt * 355c982874eSHeinrich Schuchardt * Load the EFI binary into a newly assigned memory unwinding the relocation 356c982874eSHeinrich Schuchardt * information, install the loaded image protocol, and call the binary. 357b9939336SAlexander Graf */ 358bc4f9133SHeinrich Schuchardt static efi_status_t do_bootefi_exec(void *efi, 35995c5553eSRob Clark struct efi_device_path *device_path, 36095c5553eSRob Clark struct efi_device_path *image_path) 361b9939336SAlexander Graf { 3628887acc6SHeinrich Schuchardt efi_handle_t mem_handle = NULL; 363bf19273eSRob Clark struct efi_device_path *memdp = NULL; 36445204b10SHeinrich Schuchardt efi_status_t ret; 365faea1041SHeinrich Schuchardt struct efi_loaded_image_obj *image_obj = NULL; 366c982874eSHeinrich Schuchardt struct efi_loaded_image *loaded_image_info = NULL; 36795c5553eSRob Clark 368c6fa5df6SAlexander Graf EFIAPI efi_status_t (*entry)(efi_handle_t image_handle, 369c6fa5df6SAlexander Graf struct efi_system_table *st); 370b9939336SAlexander Graf 371bf19273eSRob Clark /* 372bf19273eSRob Clark * Special case for efi payload not loaded from disk, such as 373bf19273eSRob Clark * 'bootefi hello' or for example payload loaded directly into 374e1fec152SHeinrich Schuchardt * memory via JTAG, etc: 375bf19273eSRob Clark */ 376bf19273eSRob Clark if (!device_path && !image_path) { 377bf19273eSRob Clark printf("WARNING: using memory device/image path, this may confuse some payloads!\n"); 378bf19273eSRob Clark /* actual addresses filled in after efi_load_pe() */ 379bf19273eSRob Clark memdp = efi_dp_from_mem(0, 0, 0); 380bf19273eSRob Clark device_path = image_path = memdp; 3818887acc6SHeinrich Schuchardt /* 3828887acc6SHeinrich Schuchardt * Grub expects that the device path of the loaded image is 3838887acc6SHeinrich Schuchardt * installed on a handle. 3848887acc6SHeinrich Schuchardt */ 3858887acc6SHeinrich Schuchardt ret = efi_create_handle(&mem_handle); 3868887acc6SHeinrich Schuchardt if (ret != EFI_SUCCESS) 3878887acc6SHeinrich Schuchardt goto exit; 3888887acc6SHeinrich Schuchardt ret = efi_add_protocol(mem_handle, &efi_guid_device_path, 38958bc69d2SAlexander Graf device_path); 39058bc69d2SAlexander Graf if (ret != EFI_SUCCESS) 39158bc69d2SAlexander Graf goto exit; 392bf19273eSRob Clark } else { 393bf19273eSRob Clark assert(device_path && image_path); 394bf19273eSRob Clark } 395bf19273eSRob Clark 396*f4f0f7cbSSimon Glass ret = bootefi_run_prepare("bootargs", device_path, image_path, 397*f4f0f7cbSSimon Glass &image_obj, &loaded_image_info); 398*f4f0f7cbSSimon Glass if (ret) 399*f4f0f7cbSSimon Glass return ret; 40095c5553eSRob Clark 401b9939336SAlexander Graf /* Load the EFI payload */ 402faea1041SHeinrich Schuchardt entry = efi_load_pe(image_obj, efi, loaded_image_info); 40395c5553eSRob Clark if (!entry) { 40445204b10SHeinrich Schuchardt ret = EFI_LOAD_ERROR; 40595c5553eSRob Clark goto exit; 40695c5553eSRob Clark } 40780a4800eSAlexander Graf 408bf19273eSRob Clark if (memdp) { 409bf19273eSRob Clark struct efi_device_path_memory *mdp = (void *)memdp; 410c982874eSHeinrich Schuchardt mdp->memory_type = loaded_image_info->image_code_type; 411c982874eSHeinrich Schuchardt mdp->start_address = (uintptr_t)loaded_image_info->image_base; 412bf19273eSRob Clark mdp->end_address = mdp->start_address + 413c982874eSHeinrich Schuchardt loaded_image_info->image_size; 414bf19273eSRob Clark } 415bf19273eSRob Clark 416ad644e7cSRob Clark /* we don't support much: */ 417ad644e7cSRob Clark env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported", 418ad644e7cSRob Clark "{ro,boot}(blob)0000000000000000"); 419ad644e7cSRob Clark 420b9939336SAlexander Graf /* Call our payload! */ 421edcef3baSAlexander Graf debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 422a86aeaf2SAlexander Graf 423faea1041SHeinrich Schuchardt if (setjmp(&image_obj->exit_jmp)) { 424faea1041SHeinrich Schuchardt ret = image_obj->exit_status; 42595c5553eSRob Clark goto exit; 426a86aeaf2SAlexander Graf } 427a86aeaf2SAlexander Graf 42869bd459dSAlexander Graf #ifdef CONFIG_ARM64 42969bd459dSAlexander Graf /* On AArch64 we need to make sure we call our payload in < EL3 */ 43069bd459dSAlexander Graf if (current_el() == 3) { 43169bd459dSAlexander Graf smp_kick_all_cpus(); 43269bd459dSAlexander Graf dcache_disable(); /* flush cache before switch to EL2 */ 433ec6617c3SAlison Wang 434ec6617c3SAlison Wang /* Move into EL2 and keep running there */ 435ea54ad59SHeinrich Schuchardt armv8_switch_to_el2((ulong)entry, 436d39646a3SHeinrich Schuchardt (ulong)&image_obj->header, 4377c5e1febSAlison Wang (ulong)&systab, 0, (ulong)efi_run_in_el2, 438ec6617c3SAlison Wang ES_TO_AARCH64); 439ec6617c3SAlison Wang 440ec6617c3SAlison Wang /* Should never reach here, efi exits with longjmp */ 441ec6617c3SAlison Wang while (1) { } 44269bd459dSAlexander Graf } 44369bd459dSAlexander Graf #endif 44469bd459dSAlexander Graf 445dc500c36SMark Kettenis #ifdef CONFIG_ARMV7_NONSEC 446f17f2001SMark Kettenis if (armv7_boot_nonsec() && !is_nonsec) { 447dc500c36SMark Kettenis dcache_disable(); /* flush cache before switch to HYP */ 448dc500c36SMark Kettenis 449dc500c36SMark Kettenis armv7_init_nonsec(); 450dc500c36SMark Kettenis secure_ram_addr(_do_nonsec_entry)( 451dc500c36SMark Kettenis efi_run_in_hyp, 452dc500c36SMark Kettenis (uintptr_t)entry, 453d39646a3SHeinrich Schuchardt (uintptr_t)&image_obj->header, 454dc500c36SMark Kettenis (uintptr_t)&systab); 455dc500c36SMark Kettenis 456dc500c36SMark Kettenis /* Should never reach here, efi exits with longjmp */ 457dc500c36SMark Kettenis while (1) { } 458dc500c36SMark Kettenis } 459dc500c36SMark Kettenis #endif 460dc500c36SMark Kettenis 461d39646a3SHeinrich Schuchardt ret = efi_do_enter(&image_obj->header, &systab, entry); 46295c5553eSRob Clark 46395c5553eSRob Clark exit: 46495c5553eSRob Clark /* image has returned, loaded-image obj goes *poof*: */ 465faea1041SHeinrich Schuchardt if (image_obj) 466d39646a3SHeinrich Schuchardt efi_delete_handle(&image_obj->header); 4678887acc6SHeinrich Schuchardt if (mem_handle) 4688887acc6SHeinrich Schuchardt efi_delete_handle(mem_handle); 46995c5553eSRob Clark 47095c5553eSRob Clark return ret; 471b9939336SAlexander Graf } 472b9939336SAlexander Graf 473d9717eaeSSimon Glass #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 474d9717eaeSSimon Glass /** 475d9717eaeSSimon Glass * bootefi_test_prepare() - prepare to run an EFI test 476d9717eaeSSimon Glass * 477d9717eaeSSimon Glass * This sets things up so we can call EFI functions. This involves preparing 478d9717eaeSSimon Glass * the 'gd' pointer and setting up the load ed image data structures. 479d9717eaeSSimon Glass * 480d9717eaeSSimon Glass * @image_objp: loaded_image_infop: Pointer to a struct which will hold the 481d9717eaeSSimon Glass * loaded image object. This struct will be inited by this function before 482d9717eaeSSimon Glass * use. 483d9717eaeSSimon Glass * @loaded_image_infop: Pointer to a struct which will hold the loaded image 484d9717eaeSSimon Glass * info. This struct will be inited by this function before use. 485d9717eaeSSimon Glass * @path: File path to the test being run (often just the test name with a 486d9717eaeSSimon Glass * backslash before it 487d9717eaeSSimon Glass * @test_func: Address of the test function that is being run 488*f4f0f7cbSSimon Glass * @load_options_path: U-Boot environment variable to use as load options 489d9717eaeSSimon Glass * @return 0 if OK, -ve on error 490d9717eaeSSimon Glass */ 491d9717eaeSSimon Glass static efi_status_t bootefi_test_prepare 492d9717eaeSSimon Glass (struct efi_loaded_image_obj **image_objp, 493*f4f0f7cbSSimon Glass struct efi_loaded_image **loaded_image_infop, const char *path, 494*f4f0f7cbSSimon Glass ulong test_func, const char *load_options_path) 495d9717eaeSSimon Glass { 496d9717eaeSSimon Glass /* Construct a dummy device path */ 497d9717eaeSSimon Glass bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 498d9717eaeSSimon Glass (uintptr_t)test_func, 499d9717eaeSSimon Glass (uintptr_t)test_func); 500d9717eaeSSimon Glass if (!bootefi_device_path) 501d9717eaeSSimon Glass return EFI_OUT_OF_RESOURCES; 502d9717eaeSSimon Glass bootefi_image_path = efi_dp_from_file(NULL, 0, path); 503d9717eaeSSimon Glass if (!bootefi_image_path) 504d9717eaeSSimon Glass return EFI_OUT_OF_RESOURCES; 505d9717eaeSSimon Glass 506*f4f0f7cbSSimon Glass return bootefi_run_prepare(load_options_path, bootefi_device_path, 507*f4f0f7cbSSimon Glass bootefi_image_path, image_objp, 508*f4f0f7cbSSimon Glass loaded_image_infop); 509d9717eaeSSimon Glass } 510d9717eaeSSimon Glass 511d9717eaeSSimon Glass /** 512d9717eaeSSimon Glass * bootefi_test_finish() - finish up after running an EFI test 513d9717eaeSSimon Glass * 514d9717eaeSSimon Glass * @image_obj: Pointer to a struct which holds the loaded image object 515d9717eaeSSimon Glass * @loaded_image_info: Pointer to a struct which holds the loaded image info 516d9717eaeSSimon Glass */ 517d9717eaeSSimon Glass static void bootefi_test_finish(struct efi_loaded_image_obj *image_obj, 518d9717eaeSSimon Glass struct efi_loaded_image *loaded_image_info) 519d9717eaeSSimon Glass { 520d9717eaeSSimon Glass efi_restore_gd(); 521d9717eaeSSimon Glass free(loaded_image_info->load_options); 522d9717eaeSSimon Glass efi_delete_handle(&image_obj->header); 523d9717eaeSSimon Glass } 524d9717eaeSSimon Glass #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */ 525d9717eaeSSimon Glass 526bc4f9133SHeinrich Schuchardt static int do_bootefi_bootmgr_exec(void) 5279975fe96SRob Clark { 5289975fe96SRob Clark struct efi_device_path *device_path, *file_path; 5299975fe96SRob Clark void *addr; 5309975fe96SRob Clark efi_status_t r; 5319975fe96SRob Clark 5329975fe96SRob Clark addr = efi_bootmgr_load(&device_path, &file_path); 5339975fe96SRob Clark if (!addr) 5349975fe96SRob Clark return 1; 5359975fe96SRob Clark 5369975fe96SRob Clark printf("## Starting EFI application at %p ...\n", addr); 537bc4f9133SHeinrich Schuchardt r = do_bootefi_exec(addr, device_path, file_path); 5389975fe96SRob Clark printf("## Application terminated, r = %lu\n", 5399975fe96SRob Clark r & ~EFI_ERROR_MASK); 5409975fe96SRob Clark 5419975fe96SRob Clark if (r != EFI_SUCCESS) 5429975fe96SRob Clark return 1; 5439975fe96SRob Clark 5449975fe96SRob Clark return 0; 5459975fe96SRob Clark } 5469975fe96SRob Clark 547b9939336SAlexander Graf /* Interpreter command to boot an arbitrary EFI image from memory */ 548b9939336SAlexander Graf static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 549b9939336SAlexander Graf { 550bc4f9133SHeinrich Schuchardt unsigned long addr; 551bc4f9133SHeinrich Schuchardt char *saddr; 5523eb0841bSHeinrich Schuchardt efi_status_t r; 553354264b3SAlexander Graf unsigned long fdt_addr; 554b9939336SAlexander Graf 555c3b11deaSHeinrich Schuchardt /* Allow unaligned memory access */ 556c3b11deaSHeinrich Schuchardt allow_unaligned(); 557c3b11deaSHeinrich Schuchardt 558fc225e60SHeinrich Schuchardt /* Initialize EFI drivers */ 559fc225e60SHeinrich Schuchardt r = efi_init_obj_list(); 560fc225e60SHeinrich Schuchardt if (r != EFI_SUCCESS) { 561fc225e60SHeinrich Schuchardt printf("Error: Cannot set up EFI drivers, r = %lu\n", 562fc225e60SHeinrich Schuchardt r & ~EFI_ERROR_MASK); 563fc225e60SHeinrich Schuchardt return CMD_RET_FAILURE; 564fc225e60SHeinrich Schuchardt } 565fc225e60SHeinrich Schuchardt 566b9939336SAlexander Graf if (argc < 2) 5673c1dcef6SBin Meng return CMD_RET_USAGE; 568bc4f9133SHeinrich Schuchardt 569bc4f9133SHeinrich Schuchardt if (argc > 2) { 570354264b3SAlexander Graf fdt_addr = simple_strtoul(argv[2], NULL, 16); 571bc4f9133SHeinrich Schuchardt if (!fdt_addr && *argv[2] != '0') 572bc4f9133SHeinrich Schuchardt return CMD_RET_USAGE; 573bc4f9133SHeinrich Schuchardt /* Install device tree */ 5749dff4900SSimon Glass r = efi_install_fdt(fdt_addr); 575bc4f9133SHeinrich Schuchardt if (r != EFI_SUCCESS) { 576bc4f9133SHeinrich Schuchardt printf("ERROR: failed to install device tree\n"); 577bc4f9133SHeinrich Schuchardt return CMD_RET_FAILURE; 578bc4f9133SHeinrich Schuchardt } 579bc4f9133SHeinrich Schuchardt } else { 580bc4f9133SHeinrich Schuchardt /* Remove device tree. EFI_NOT_FOUND can be ignored here */ 581bc4f9133SHeinrich Schuchardt efi_install_configuration_table(&efi_guid_fdt, NULL); 582bc4f9133SHeinrich Schuchardt printf("WARNING: booting without device tree\n"); 583bc4f9133SHeinrich Schuchardt } 584c7ae3dfdSSimon Glass #ifdef CONFIG_CMD_BOOTEFI_HELLO 585c7ae3dfdSSimon Glass if (!strcmp(argv[1], "hello")) { 5865e44489bSHeinrich Schuchardt ulong size = __efi_helloworld_end - __efi_helloworld_begin; 587c7ae3dfdSSimon Glass 58851c533fdSHeinrich Schuchardt saddr = env_get("loadaddr"); 58951c533fdSHeinrich Schuchardt if (saddr) 59051c533fdSHeinrich Schuchardt addr = simple_strtoul(saddr, NULL, 16); 59151c533fdSHeinrich Schuchardt else 592c7ae3dfdSSimon Glass addr = CONFIG_SYS_LOAD_ADDR; 593354264b3SAlexander Graf memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size); 594c7ae3dfdSSimon Glass } else 595c7ae3dfdSSimon Glass #endif 596623b3a57SHeinrich Schuchardt #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 597623b3a57SHeinrich Schuchardt if (!strcmp(argv[1], "selftest")) { 598faea1041SHeinrich Schuchardt struct efi_loaded_image_obj *image_obj; 599c982874eSHeinrich Schuchardt struct efi_loaded_image *loaded_image_info; 6007aca68caSHeinrich Schuchardt 601d9717eaeSSimon Glass if (bootefi_test_prepare(&image_obj, &loaded_image_info, 602*f4f0f7cbSSimon Glass "\\selftest", (uintptr_t)&efi_selftest, 603*f4f0f7cbSSimon Glass "efi_selftest")) 6042ab7ef74SSimon Glass return CMD_RET_FAILURE; 6052ab7ef74SSimon Glass 606d78e40d6SHeinrich Schuchardt /* Execute the test */ 607d39646a3SHeinrich Schuchardt r = efi_selftest(&image_obj->header, &systab); 608d9717eaeSSimon Glass bootefi_test_finish(image_obj, loaded_image_info); 609c2b53902SHeinrich Schuchardt return r != EFI_SUCCESS; 610623b3a57SHeinrich Schuchardt } else 611623b3a57SHeinrich Schuchardt #endif 6129975fe96SRob Clark if (!strcmp(argv[1], "bootmgr")) { 613bc4f9133SHeinrich Schuchardt return do_bootefi_bootmgr_exec(); 6149975fe96SRob Clark } else { 615b9939336SAlexander Graf saddr = argv[1]; 616b9939336SAlexander Graf 617b9939336SAlexander Graf addr = simple_strtoul(saddr, NULL, 16); 61849db1cb8SHeinrich Schuchardt /* Check that a numeric value was passed */ 61949db1cb8SHeinrich Schuchardt if (!addr && *saddr != '0') 62049db1cb8SHeinrich Schuchardt return CMD_RET_USAGE; 621b9939336SAlexander Graf 622c7ae3dfdSSimon Glass } 6231c39809bSAlexander Graf 6245ee31bafSSimon Glass printf("## Starting EFI application at %08lx ...\n", addr); 625354264b3SAlexander Graf r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path, 626bc4f9133SHeinrich Schuchardt bootefi_image_path); 6271da1bac4Sxypron.glpk@gmx.de printf("## Application terminated, r = %lu\n", 6281da1bac4Sxypron.glpk@gmx.de r & ~EFI_ERROR_MASK); 629b9939336SAlexander Graf 6301da1bac4Sxypron.glpk@gmx.de if (r != EFI_SUCCESS) 6311da1bac4Sxypron.glpk@gmx.de return 1; 6321da1bac4Sxypron.glpk@gmx.de else 6331da1bac4Sxypron.glpk@gmx.de return 0; 634b9939336SAlexander Graf } 635b9939336SAlexander Graf 636b9939336SAlexander Graf #ifdef CONFIG_SYS_LONGHELP 637b9939336SAlexander Graf static char bootefi_help_text[] = 6381c39809bSAlexander Graf "<image address> [fdt address]\n" 6391c39809bSAlexander Graf " - boot EFI payload stored at address <image address>.\n" 6401c39809bSAlexander Graf " If specified, the device tree located at <fdt address> gets\n" 641c7ae3dfdSSimon Glass " exposed as EFI configuration table.\n" 642c7ae3dfdSSimon Glass #ifdef CONFIG_CMD_BOOTEFI_HELLO 643623b3a57SHeinrich Schuchardt "bootefi hello\n" 644623b3a57SHeinrich Schuchardt " - boot a sample Hello World application stored within U-Boot\n" 645623b3a57SHeinrich Schuchardt #endif 646623b3a57SHeinrich Schuchardt #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 647bc4f9133SHeinrich Schuchardt "bootefi selftest [fdt address]\n" 648623b3a57SHeinrich Schuchardt " - boot an EFI selftest application stored within U-Boot\n" 649d78e40d6SHeinrich Schuchardt " Use environment variable efi_selftest to select a single test.\n" 650d78e40d6SHeinrich Schuchardt " Use 'setenv efi_selftest list' to enumerate all tests.\n" 651c7ae3dfdSSimon Glass #endif 652f623e07fSHeinrich Schuchardt "bootefi bootmgr [fdt addr]\n" 6539975fe96SRob Clark " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n" 6549975fe96SRob Clark "\n" 6559975fe96SRob Clark " If specified, the device tree located at <fdt address> gets\n" 6569975fe96SRob Clark " exposed as EFI configuration table.\n"; 657b9939336SAlexander Graf #endif 658b9939336SAlexander Graf 659b9939336SAlexander Graf U_BOOT_CMD( 6601c39809bSAlexander Graf bootefi, 3, 0, do_bootefi, 66192dfd922SSergey Kubushyn "Boots an EFI payload from memory", 662b9939336SAlexander Graf bootefi_help_text 663b9939336SAlexander Graf ); 6640f4060ebSAlexander Graf 665c07ad7c0SAlexander Graf void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 6660f4060ebSAlexander Graf { 667f1589ffbSAKASHI Takahiro struct efi_device_path *device, *image; 668f1589ffbSAKASHI Takahiro efi_status_t ret; 6690f4060ebSAlexander Graf 67079276eb2SHeinrich Schuchardt /* efi_set_bootdev is typically called repeatedly, recover memory */ 67179276eb2SHeinrich Schuchardt efi_free_pool(bootefi_device_path); 67279276eb2SHeinrich Schuchardt efi_free_pool(bootefi_image_path); 673f1589ffbSAKASHI Takahiro 674f1589ffbSAKASHI Takahiro ret = efi_dp_from_name(dev, devnr, path, &device, &image); 675f1589ffbSAKASHI Takahiro if (ret == EFI_SUCCESS) { 676f1589ffbSAKASHI Takahiro bootefi_device_path = device; 677f1589ffbSAKASHI Takahiro bootefi_image_path = image; 678f1589ffbSAKASHI Takahiro } else { 67979276eb2SHeinrich Schuchardt bootefi_device_path = NULL; 68079276eb2SHeinrich Schuchardt bootefi_image_path = NULL; 681f9d334bdSAlexander Graf } 6820f4060ebSAlexander Graf } 683