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 * 151*16b615d9SHeinrich Schuchardt * The FDT is copied to a suitable location within the EFI memory map. 152c3772ca1SHeinrich Schuchardt * Additional 12 KiB are added to the space in case the device tree needs to be 1539dff4900SSimon Glass * expanded later with fdt_open_into(). 1549dff4900SSimon Glass * 155*16b615d9SHeinrich Schuchardt * @fdtp: On entry a pointer to the flattened device tree. 156*16b615d9SHeinrich Schuchardt * On exit a pointer to the copy of the flattened device tree. 1579dff4900SSimon Glass * FDT start 1584574d1b3SHeinrich Schuchardt * Return: status code 1599dff4900SSimon Glass */ 160*16b615d9SHeinrich Schuchardt static efi_status_t copy_fdt(void **fdtp) 1610d9d501fSAlexander Graf { 162ad0c1a3dSAlexander Graf unsigned long fdt_ram_start = -1L, fdt_pages; 1639dff4900SSimon Glass efi_status_t ret = 0; 1649dff4900SSimon Glass void *fdt, *new_fdt; 165ad0c1a3dSAlexander Graf u64 new_fdt_addr; 1669dff4900SSimon Glass uint fdt_size; 167ad0c1a3dSAlexander Graf int i; 1680d9d501fSAlexander Graf 169ad0c1a3dSAlexander Graf for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 170ad0c1a3dSAlexander Graf u64 ram_start = gd->bd->bi_dram[i].start; 171ad0c1a3dSAlexander Graf u64 ram_size = gd->bd->bi_dram[i].size; 1720d9d501fSAlexander Graf 173ad0c1a3dSAlexander Graf if (!ram_size) 174ad0c1a3dSAlexander Graf continue; 175ad0c1a3dSAlexander Graf 176ad0c1a3dSAlexander Graf if (ram_start < fdt_ram_start) 177ad0c1a3dSAlexander Graf fdt_ram_start = ram_start; 178ad0c1a3dSAlexander Graf } 179ad0c1a3dSAlexander Graf 180bc9a638aSSimon Glass /* 181c3772ca1SHeinrich Schuchardt * Give us at least 12 KiB of breathing room in case the device tree 182c3772ca1SHeinrich Schuchardt * needs to be expanded later. 183bc9a638aSSimon Glass */ 184*16b615d9SHeinrich Schuchardt fdt = *fdtp; 185c3772ca1SHeinrich Schuchardt fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000); 186c3772ca1SHeinrich Schuchardt fdt_size = fdt_pages << EFI_PAGE_SHIFT; 187ad0c1a3dSAlexander Graf 188*16b615d9SHeinrich Schuchardt /* 189*16b615d9SHeinrich Schuchardt * Safe fdt location is at 127 MiB. 190*16b615d9SHeinrich Schuchardt * On the sandbox convert from the sandbox address space. 191*16b615d9SHeinrich Schuchardt */ 192*16b615d9SHeinrich Schuchardt new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 + 193*16b615d9SHeinrich Schuchardt fdt_size, 0); 1949dff4900SSimon Glass ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, 195e09159c8SHeinrich Schuchardt EFI_RUNTIME_SERVICES_DATA, fdt_pages, 1969dff4900SSimon Glass &new_fdt_addr); 1979dff4900SSimon Glass if (ret != EFI_SUCCESS) { 198ad0c1a3dSAlexander Graf /* If we can't put it there, put it somewhere */ 199a44bffccSxypron.glpk@gmx.de new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size); 2009dff4900SSimon Glass ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, 201e09159c8SHeinrich Schuchardt EFI_RUNTIME_SERVICES_DATA, fdt_pages, 2029dff4900SSimon Glass &new_fdt_addr); 2039dff4900SSimon Glass if (ret != EFI_SUCCESS) { 20485a6e9b3SAlexander Graf printf("ERROR: Failed to reserve space for FDT\n"); 2059dff4900SSimon Glass goto done; 206ad0c1a3dSAlexander Graf } 20785a6e9b3SAlexander Graf } 208*16b615d9SHeinrich Schuchardt new_fdt = (void *)(uintptr_t)new_fdt_addr; 2090d9d501fSAlexander Graf memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 2100d9d501fSAlexander Graf fdt_set_totalsize(new_fdt, fdt_size); 2110d9d501fSAlexander Graf 212*16b615d9SHeinrich Schuchardt *fdtp = (void *)(uintptr_t)new_fdt_addr; 2139dff4900SSimon Glass done: 2149dff4900SSimon Glass return ret; 2150d9d501fSAlexander Graf } 2160d9d501fSAlexander Graf 2173eb0841bSHeinrich Schuchardt static efi_status_t efi_do_enter( 2182074f700SHeinrich Schuchardt efi_handle_t image_handle, struct efi_system_table *st, 219c6fa5df6SAlexander Graf EFIAPI efi_status_t (*entry)( 220c6fa5df6SAlexander Graf efi_handle_t image_handle, 221b06d8ac3Sxypron.glpk@gmx.de struct efi_system_table *st)) 222b06d8ac3Sxypron.glpk@gmx.de { 223b06d8ac3Sxypron.glpk@gmx.de efi_status_t ret = EFI_LOAD_ERROR; 224b06d8ac3Sxypron.glpk@gmx.de 225b06d8ac3Sxypron.glpk@gmx.de if (entry) 226b06d8ac3Sxypron.glpk@gmx.de ret = entry(image_handle, st); 227b06d8ac3Sxypron.glpk@gmx.de st->boottime->exit(image_handle, ret, 0, NULL); 228b06d8ac3Sxypron.glpk@gmx.de return ret; 229b06d8ac3Sxypron.glpk@gmx.de } 230b06d8ac3Sxypron.glpk@gmx.de 231ec6617c3SAlison Wang #ifdef CONFIG_ARM64 232c6fa5df6SAlexander Graf static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)( 2332074f700SHeinrich Schuchardt efi_handle_t image_handle, struct efi_system_table *st), 2342074f700SHeinrich Schuchardt efi_handle_t image_handle, struct efi_system_table *st) 235ec6617c3SAlison Wang { 236ec6617c3SAlison Wang /* Enable caches again */ 237ec6617c3SAlison Wang dcache_enable(); 238ec6617c3SAlison Wang 239b06d8ac3Sxypron.glpk@gmx.de return efi_do_enter(image_handle, st, entry); 240ec6617c3SAlison Wang } 241ec6617c3SAlison Wang #endif 242ec6617c3SAlison Wang 243dc500c36SMark Kettenis #ifdef CONFIG_ARMV7_NONSEC 244f17f2001SMark Kettenis static bool is_nonsec; 245f17f2001SMark Kettenis 246dc500c36SMark Kettenis static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)( 247dc500c36SMark Kettenis efi_handle_t image_handle, struct efi_system_table *st), 248dc500c36SMark Kettenis efi_handle_t image_handle, struct efi_system_table *st) 249dc500c36SMark Kettenis { 250dc500c36SMark Kettenis /* Enable caches again */ 251dc500c36SMark Kettenis dcache_enable(); 252dc500c36SMark Kettenis 253f17f2001SMark Kettenis is_nonsec = true; 254f17f2001SMark Kettenis 255dc500c36SMark Kettenis return efi_do_enter(image_handle, st, entry); 256dc500c36SMark Kettenis } 257dc500c36SMark Kettenis #endif 258dc500c36SMark Kettenis 259416e07e2SSimon Glass /* 260416e07e2SSimon Glass * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges 261416e07e2SSimon Glass * 262416e07e2SSimon Glass * The mem_rsv entries of the FDT are added to the memory map. Any failures are 263416e07e2SSimon Glass * ignored because this is not critical and we would rather continue to try to 264416e07e2SSimon Glass * boot. 265416e07e2SSimon Glass * 266416e07e2SSimon Glass * @fdt: Pointer to device tree 267416e07e2SSimon Glass */ 268416e07e2SSimon Glass static void efi_carve_out_dt_rsv(void *fdt) 269806d2fa8SAlexander Graf { 270806d2fa8SAlexander Graf int nr_rsv, i; 271806d2fa8SAlexander Graf uint64_t addr, size, pages; 272806d2fa8SAlexander Graf 273806d2fa8SAlexander Graf nr_rsv = fdt_num_mem_rsv(fdt); 274806d2fa8SAlexander Graf 275806d2fa8SAlexander Graf /* Look for an existing entry and add it to the efi mem map. */ 276806d2fa8SAlexander Graf for (i = 0; i < nr_rsv; i++) { 277806d2fa8SAlexander Graf if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0) 278806d2fa8SAlexander Graf continue; 279806d2fa8SAlexander Graf 280*16b615d9SHeinrich Schuchardt /* Convert from sandbox address space. */ 281*16b615d9SHeinrich Schuchardt addr = (uintptr_t)map_sysmem(addr, 0); 282*16b615d9SHeinrich Schuchardt 28323fd84b3SHeinrich Schuchardt /* 28423fd84b3SHeinrich Schuchardt * Do not carve out the device tree. It is already marked as 28523fd84b3SHeinrich Schuchardt * EFI_RUNTIME_SERVICES_DATA 28623fd84b3SHeinrich Schuchardt */ 28723fd84b3SHeinrich Schuchardt if (addr == (uintptr_t)fdt) 28823fd84b3SHeinrich Schuchardt continue; 28923fd84b3SHeinrich Schuchardt 290c3772ca1SHeinrich Schuchardt pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK)); 29123fd84b3SHeinrich Schuchardt addr &= ~EFI_PAGE_MASK; 292416e07e2SSimon Glass if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE, 293416e07e2SSimon Glass false)) 294416e07e2SSimon Glass printf("FDT memrsv map %d: Failed to add to map\n", i); 295806d2fa8SAlexander Graf } 296806d2fa8SAlexander Graf } 297806d2fa8SAlexander Graf 2989dff4900SSimon Glass static efi_status_t efi_install_fdt(ulong fdt_addr) 299bc4f9133SHeinrich Schuchardt { 300bc4f9133SHeinrich Schuchardt bootm_headers_t img = { 0 }; 301bc4f9133SHeinrich Schuchardt efi_status_t ret; 3029dff4900SSimon Glass void *fdt; 303bc4f9133SHeinrich Schuchardt 3049dff4900SSimon Glass fdt = map_sysmem(fdt_addr, 0); 305bc4f9133SHeinrich Schuchardt if (fdt_check_header(fdt)) { 306bc4f9133SHeinrich Schuchardt printf("ERROR: invalid device tree\n"); 307bc4f9133SHeinrich Schuchardt return EFI_INVALID_PARAMETER; 308bc4f9133SHeinrich Schuchardt } 309bc4f9133SHeinrich Schuchardt 310bc4f9133SHeinrich Schuchardt /* Prepare fdt for payload */ 311*16b615d9SHeinrich Schuchardt ret = copy_fdt(&fdt); 3129dff4900SSimon Glass if (ret) 3139dff4900SSimon Glass return ret; 314bc4f9133SHeinrich Schuchardt 315bc4f9133SHeinrich Schuchardt if (image_setup_libfdt(&img, fdt, 0, NULL)) { 316bc4f9133SHeinrich Schuchardt printf("ERROR: failed to process device tree\n"); 317bc4f9133SHeinrich Schuchardt return EFI_LOAD_ERROR; 318bc4f9133SHeinrich Schuchardt } 319bc4f9133SHeinrich Schuchardt 320416e07e2SSimon Glass efi_carve_out_dt_rsv(fdt); 321806d2fa8SAlexander Graf 322bc4f9133SHeinrich Schuchardt /* Link to it in the efi tables */ 323bc4f9133SHeinrich Schuchardt ret = efi_install_configuration_table(&efi_guid_fdt, fdt); 324bc4f9133SHeinrich Schuchardt if (ret != EFI_SUCCESS) 325bc4f9133SHeinrich Schuchardt return EFI_OUT_OF_RESOURCES; 326bc4f9133SHeinrich Schuchardt 327bc4f9133SHeinrich Schuchardt return ret; 328bc4f9133SHeinrich Schuchardt } 329bc4f9133SHeinrich Schuchardt 330f4f0f7cbSSimon Glass static efi_status_t bootefi_run_prepare(const char *load_options_path, 331f4f0f7cbSSimon Glass struct efi_device_path *device_path, 332f4f0f7cbSSimon Glass struct efi_device_path *image_path, 333f4f0f7cbSSimon Glass struct efi_loaded_image_obj **image_objp, 334f4f0f7cbSSimon Glass struct efi_loaded_image **loaded_image_infop) 335f4f0f7cbSSimon Glass { 336f4f0f7cbSSimon Glass efi_status_t ret; 337f4f0f7cbSSimon Glass 338f4f0f7cbSSimon Glass ret = efi_setup_loaded_image(device_path, image_path, image_objp, 339f4f0f7cbSSimon Glass loaded_image_infop); 340f4f0f7cbSSimon Glass if (ret != EFI_SUCCESS) 341f4f0f7cbSSimon Glass return ret; 342f4f0f7cbSSimon Glass 343f4f0f7cbSSimon Glass /* Transfer environment variable as load options */ 344f4f0f7cbSSimon Glass set_load_options(*loaded_image_infop, load_options_path); 345f4f0f7cbSSimon Glass 346f4f0f7cbSSimon Glass return 0; 347f4f0f7cbSSimon Glass } 348f4f0f7cbSSimon Glass 349c982874eSHeinrich Schuchardt /** 3505e2f0391SSimon Glass * bootefi_run_finish() - finish up after running an EFI test 3515e2f0391SSimon Glass * 3525e2f0391SSimon Glass * @loaded_image_info: Pointer to a struct which holds the loaded image info 3535e2f0391SSimon Glass * @image_objj: Pointer to a struct which holds the loaded image object 3545e2f0391SSimon Glass */ 3555e2f0391SSimon Glass static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj, 3565e2f0391SSimon Glass struct efi_loaded_image *loaded_image_info) 3575e2f0391SSimon Glass { 3585e2f0391SSimon Glass efi_restore_gd(); 3595e2f0391SSimon Glass free(loaded_image_info->load_options); 3605e2f0391SSimon Glass efi_delete_handle(&image_obj->header); 3615e2f0391SSimon Glass } 3625e2f0391SSimon Glass 3635e2f0391SSimon Glass /** 364c982874eSHeinrich Schuchardt * do_bootefi_exec() - execute EFI binary 365c982874eSHeinrich Schuchardt * 366c982874eSHeinrich Schuchardt * @efi: address of the binary 367c982874eSHeinrich Schuchardt * @device_path: path of the device from which the binary was loaded 368c982874eSHeinrich Schuchardt * @image_path: device path of the binary 369c982874eSHeinrich Schuchardt * Return: status code 370c982874eSHeinrich Schuchardt * 371c982874eSHeinrich Schuchardt * Load the EFI binary into a newly assigned memory unwinding the relocation 372c982874eSHeinrich Schuchardt * information, install the loaded image protocol, and call the binary. 373b9939336SAlexander Graf */ 374bc4f9133SHeinrich Schuchardt static efi_status_t do_bootefi_exec(void *efi, 37595c5553eSRob Clark struct efi_device_path *device_path, 37695c5553eSRob Clark struct efi_device_path *image_path) 377b9939336SAlexander Graf { 3788887acc6SHeinrich Schuchardt efi_handle_t mem_handle = NULL; 379bf19273eSRob Clark struct efi_device_path *memdp = NULL; 38045204b10SHeinrich Schuchardt efi_status_t ret; 381faea1041SHeinrich Schuchardt struct efi_loaded_image_obj *image_obj = NULL; 382c982874eSHeinrich Schuchardt struct efi_loaded_image *loaded_image_info = NULL; 38395c5553eSRob Clark 384c6fa5df6SAlexander Graf EFIAPI efi_status_t (*entry)(efi_handle_t image_handle, 385c6fa5df6SAlexander Graf struct efi_system_table *st); 386b9939336SAlexander Graf 387bf19273eSRob Clark /* 388bf19273eSRob Clark * Special case for efi payload not loaded from disk, such as 389bf19273eSRob Clark * 'bootefi hello' or for example payload loaded directly into 390e1fec152SHeinrich Schuchardt * memory via JTAG, etc: 391bf19273eSRob Clark */ 392bf19273eSRob Clark if (!device_path && !image_path) { 393bf19273eSRob Clark printf("WARNING: using memory device/image path, this may confuse some payloads!\n"); 394bf19273eSRob Clark /* actual addresses filled in after efi_load_pe() */ 395bf19273eSRob Clark memdp = efi_dp_from_mem(0, 0, 0); 396bf19273eSRob Clark device_path = image_path = memdp; 3978887acc6SHeinrich Schuchardt /* 3988887acc6SHeinrich Schuchardt * Grub expects that the device path of the loaded image is 3998887acc6SHeinrich Schuchardt * installed on a handle. 4008887acc6SHeinrich Schuchardt */ 4018887acc6SHeinrich Schuchardt ret = efi_create_handle(&mem_handle); 4028887acc6SHeinrich Schuchardt if (ret != EFI_SUCCESS) 4035e2f0391SSimon Glass return ret; /* TODO: leaks device_path */ 4048887acc6SHeinrich Schuchardt ret = efi_add_protocol(mem_handle, &efi_guid_device_path, 40558bc69d2SAlexander Graf device_path); 40658bc69d2SAlexander Graf if (ret != EFI_SUCCESS) 4075e2f0391SSimon Glass goto err_add_protocol; 408bf19273eSRob Clark } else { 409bf19273eSRob Clark assert(device_path && image_path); 410bf19273eSRob Clark } 411bf19273eSRob Clark 412f4f0f7cbSSimon Glass ret = bootefi_run_prepare("bootargs", device_path, image_path, 413f4f0f7cbSSimon Glass &image_obj, &loaded_image_info); 414f4f0f7cbSSimon Glass if (ret) 4155e2f0391SSimon Glass goto err_prepare; 41695c5553eSRob Clark 417b9939336SAlexander Graf /* Load the EFI payload */ 418faea1041SHeinrich Schuchardt entry = efi_load_pe(image_obj, efi, loaded_image_info); 41995c5553eSRob Clark if (!entry) { 42045204b10SHeinrich Schuchardt ret = EFI_LOAD_ERROR; 4215e2f0391SSimon Glass goto err_prepare; 42295c5553eSRob Clark } 42380a4800eSAlexander Graf 424bf19273eSRob Clark if (memdp) { 425bf19273eSRob Clark struct efi_device_path_memory *mdp = (void *)memdp; 426c982874eSHeinrich Schuchardt mdp->memory_type = loaded_image_info->image_code_type; 427c982874eSHeinrich Schuchardt mdp->start_address = (uintptr_t)loaded_image_info->image_base; 428bf19273eSRob Clark mdp->end_address = mdp->start_address + 429c982874eSHeinrich Schuchardt loaded_image_info->image_size; 430bf19273eSRob Clark } 431bf19273eSRob Clark 432ad644e7cSRob Clark /* we don't support much: */ 433ad644e7cSRob Clark env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported", 434ad644e7cSRob Clark "{ro,boot}(blob)0000000000000000"); 435ad644e7cSRob Clark 436b9939336SAlexander Graf /* Call our payload! */ 437edcef3baSAlexander Graf debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 438a86aeaf2SAlexander Graf 439faea1041SHeinrich Schuchardt if (setjmp(&image_obj->exit_jmp)) { 440faea1041SHeinrich Schuchardt ret = image_obj->exit_status; 4415e2f0391SSimon Glass goto err_prepare; 442a86aeaf2SAlexander Graf } 443a86aeaf2SAlexander Graf 44469bd459dSAlexander Graf #ifdef CONFIG_ARM64 44569bd459dSAlexander Graf /* On AArch64 we need to make sure we call our payload in < EL3 */ 44669bd459dSAlexander Graf if (current_el() == 3) { 44769bd459dSAlexander Graf smp_kick_all_cpus(); 44869bd459dSAlexander Graf dcache_disable(); /* flush cache before switch to EL2 */ 449ec6617c3SAlison Wang 450ec6617c3SAlison Wang /* Move into EL2 and keep running there */ 451ea54ad59SHeinrich Schuchardt armv8_switch_to_el2((ulong)entry, 452d39646a3SHeinrich Schuchardt (ulong)&image_obj->header, 4537c5e1febSAlison Wang (ulong)&systab, 0, (ulong)efi_run_in_el2, 454ec6617c3SAlison Wang ES_TO_AARCH64); 455ec6617c3SAlison Wang 456ec6617c3SAlison Wang /* Should never reach here, efi exits with longjmp */ 457ec6617c3SAlison Wang while (1) { } 45869bd459dSAlexander Graf } 45969bd459dSAlexander Graf #endif 46069bd459dSAlexander Graf 461dc500c36SMark Kettenis #ifdef CONFIG_ARMV7_NONSEC 462f17f2001SMark Kettenis if (armv7_boot_nonsec() && !is_nonsec) { 463dc500c36SMark Kettenis dcache_disable(); /* flush cache before switch to HYP */ 464dc500c36SMark Kettenis 465dc500c36SMark Kettenis armv7_init_nonsec(); 466dc500c36SMark Kettenis secure_ram_addr(_do_nonsec_entry)( 467dc500c36SMark Kettenis efi_run_in_hyp, 468dc500c36SMark Kettenis (uintptr_t)entry, 469d39646a3SHeinrich Schuchardt (uintptr_t)&image_obj->header, 470dc500c36SMark Kettenis (uintptr_t)&systab); 471dc500c36SMark Kettenis 472dc500c36SMark Kettenis /* Should never reach here, efi exits with longjmp */ 473dc500c36SMark Kettenis while (1) { } 474dc500c36SMark Kettenis } 475dc500c36SMark Kettenis #endif 476dc500c36SMark Kettenis 477d39646a3SHeinrich Schuchardt ret = efi_do_enter(&image_obj->header, &systab, entry); 47895c5553eSRob Clark 4795e2f0391SSimon Glass err_prepare: 48095c5553eSRob Clark /* image has returned, loaded-image obj goes *poof*: */ 4815e2f0391SSimon Glass bootefi_run_finish(image_obj, loaded_image_info); 4825e2f0391SSimon Glass 4835e2f0391SSimon Glass err_add_protocol: 4848887acc6SHeinrich Schuchardt if (mem_handle) 4858887acc6SHeinrich Schuchardt efi_delete_handle(mem_handle); 48695c5553eSRob Clark 48795c5553eSRob Clark return ret; 488b9939336SAlexander Graf } 489b9939336SAlexander Graf 490d9717eaeSSimon Glass #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 491d9717eaeSSimon Glass /** 492d9717eaeSSimon Glass * bootefi_test_prepare() - prepare to run an EFI test 493d9717eaeSSimon Glass * 494d9717eaeSSimon Glass * This sets things up so we can call EFI functions. This involves preparing 495d9717eaeSSimon Glass * the 'gd' pointer and setting up the load ed image data structures. 496d9717eaeSSimon Glass * 497d9717eaeSSimon Glass * @image_objp: loaded_image_infop: Pointer to a struct which will hold the 498d9717eaeSSimon Glass * loaded image object. This struct will be inited by this function before 499d9717eaeSSimon Glass * use. 500d9717eaeSSimon Glass * @loaded_image_infop: Pointer to a struct which will hold the loaded image 501d9717eaeSSimon Glass * info. This struct will be inited by this function before use. 502d9717eaeSSimon Glass * @path: File path to the test being run (often just the test name with a 503d9717eaeSSimon Glass * backslash before it 504d9717eaeSSimon Glass * @test_func: Address of the test function that is being run 505f4f0f7cbSSimon Glass * @load_options_path: U-Boot environment variable to use as load options 506d9717eaeSSimon Glass * @return 0 if OK, -ve on error 507d9717eaeSSimon Glass */ 508d9717eaeSSimon Glass static efi_status_t bootefi_test_prepare 509d9717eaeSSimon Glass (struct efi_loaded_image_obj **image_objp, 510f4f0f7cbSSimon Glass struct efi_loaded_image **loaded_image_infop, const char *path, 511f4f0f7cbSSimon Glass ulong test_func, const char *load_options_path) 512d9717eaeSSimon Glass { 513d9717eaeSSimon Glass /* Construct a dummy device path */ 514d9717eaeSSimon Glass bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 515d9717eaeSSimon Glass (uintptr_t)test_func, 516d9717eaeSSimon Glass (uintptr_t)test_func); 517d9717eaeSSimon Glass if (!bootefi_device_path) 518d9717eaeSSimon Glass return EFI_OUT_OF_RESOURCES; 519d9717eaeSSimon Glass bootefi_image_path = efi_dp_from_file(NULL, 0, path); 520d9717eaeSSimon Glass if (!bootefi_image_path) 521d9717eaeSSimon Glass return EFI_OUT_OF_RESOURCES; 522d9717eaeSSimon Glass 523f4f0f7cbSSimon Glass return bootefi_run_prepare(load_options_path, bootefi_device_path, 524f4f0f7cbSSimon Glass bootefi_image_path, image_objp, 525f4f0f7cbSSimon Glass loaded_image_infop); 526d9717eaeSSimon Glass } 527d9717eaeSSimon Glass 528d9717eaeSSimon Glass #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */ 529d9717eaeSSimon Glass 530bc4f9133SHeinrich Schuchardt static int do_bootefi_bootmgr_exec(void) 5319975fe96SRob Clark { 5329975fe96SRob Clark struct efi_device_path *device_path, *file_path; 5339975fe96SRob Clark void *addr; 5349975fe96SRob Clark efi_status_t r; 5359975fe96SRob Clark 5369975fe96SRob Clark addr = efi_bootmgr_load(&device_path, &file_path); 5379975fe96SRob Clark if (!addr) 5389975fe96SRob Clark return 1; 5399975fe96SRob Clark 5409975fe96SRob Clark printf("## Starting EFI application at %p ...\n", addr); 541bc4f9133SHeinrich Schuchardt r = do_bootefi_exec(addr, device_path, file_path); 5429975fe96SRob Clark printf("## Application terminated, r = %lu\n", 5439975fe96SRob Clark r & ~EFI_ERROR_MASK); 5449975fe96SRob Clark 5459975fe96SRob Clark if (r != EFI_SUCCESS) 5469975fe96SRob Clark return 1; 5479975fe96SRob Clark 5489975fe96SRob Clark return 0; 5499975fe96SRob Clark } 5509975fe96SRob Clark 551b9939336SAlexander Graf /* Interpreter command to boot an arbitrary EFI image from memory */ 552b9939336SAlexander Graf static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 553b9939336SAlexander Graf { 554bc4f9133SHeinrich Schuchardt unsigned long addr; 555bc4f9133SHeinrich Schuchardt char *saddr; 5563eb0841bSHeinrich Schuchardt efi_status_t r; 557354264b3SAlexander Graf unsigned long fdt_addr; 558b9939336SAlexander Graf 559c3b11deaSHeinrich Schuchardt /* Allow unaligned memory access */ 560c3b11deaSHeinrich Schuchardt allow_unaligned(); 561c3b11deaSHeinrich Schuchardt 562fc225e60SHeinrich Schuchardt /* Initialize EFI drivers */ 563fc225e60SHeinrich Schuchardt r = efi_init_obj_list(); 564fc225e60SHeinrich Schuchardt if (r != EFI_SUCCESS) { 565fc225e60SHeinrich Schuchardt printf("Error: Cannot set up EFI drivers, r = %lu\n", 566fc225e60SHeinrich Schuchardt r & ~EFI_ERROR_MASK); 567fc225e60SHeinrich Schuchardt return CMD_RET_FAILURE; 568fc225e60SHeinrich Schuchardt } 569fc225e60SHeinrich Schuchardt 570b9939336SAlexander Graf if (argc < 2) 5713c1dcef6SBin Meng return CMD_RET_USAGE; 572bc4f9133SHeinrich Schuchardt 573bc4f9133SHeinrich Schuchardt if (argc > 2) { 574354264b3SAlexander Graf fdt_addr = simple_strtoul(argv[2], NULL, 16); 575bc4f9133SHeinrich Schuchardt if (!fdt_addr && *argv[2] != '0') 576bc4f9133SHeinrich Schuchardt return CMD_RET_USAGE; 577bc4f9133SHeinrich Schuchardt /* Install device tree */ 5789dff4900SSimon Glass r = efi_install_fdt(fdt_addr); 579bc4f9133SHeinrich Schuchardt if (r != EFI_SUCCESS) { 580bc4f9133SHeinrich Schuchardt printf("ERROR: failed to install device tree\n"); 581bc4f9133SHeinrich Schuchardt return CMD_RET_FAILURE; 582bc4f9133SHeinrich Schuchardt } 583bc4f9133SHeinrich Schuchardt } else { 584bc4f9133SHeinrich Schuchardt /* Remove device tree. EFI_NOT_FOUND can be ignored here */ 585bc4f9133SHeinrich Schuchardt efi_install_configuration_table(&efi_guid_fdt, NULL); 586bc4f9133SHeinrich Schuchardt printf("WARNING: booting without device tree\n"); 587bc4f9133SHeinrich Schuchardt } 588c7ae3dfdSSimon Glass #ifdef CONFIG_CMD_BOOTEFI_HELLO 589c7ae3dfdSSimon Glass if (!strcmp(argv[1], "hello")) { 5905e44489bSHeinrich Schuchardt ulong size = __efi_helloworld_end - __efi_helloworld_begin; 591c7ae3dfdSSimon Glass 59251c533fdSHeinrich Schuchardt saddr = env_get("loadaddr"); 59351c533fdSHeinrich Schuchardt if (saddr) 59451c533fdSHeinrich Schuchardt addr = simple_strtoul(saddr, NULL, 16); 59551c533fdSHeinrich Schuchardt else 596c7ae3dfdSSimon Glass addr = CONFIG_SYS_LOAD_ADDR; 597354264b3SAlexander Graf memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size); 598c7ae3dfdSSimon Glass } else 599c7ae3dfdSSimon Glass #endif 600623b3a57SHeinrich Schuchardt #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 601623b3a57SHeinrich Schuchardt if (!strcmp(argv[1], "selftest")) { 602faea1041SHeinrich Schuchardt struct efi_loaded_image_obj *image_obj; 603c982874eSHeinrich Schuchardt struct efi_loaded_image *loaded_image_info; 6047aca68caSHeinrich Schuchardt 605d9717eaeSSimon Glass if (bootefi_test_prepare(&image_obj, &loaded_image_info, 606f4f0f7cbSSimon Glass "\\selftest", (uintptr_t)&efi_selftest, 607f4f0f7cbSSimon Glass "efi_selftest")) 6082ab7ef74SSimon Glass return CMD_RET_FAILURE; 6092ab7ef74SSimon Glass 610d78e40d6SHeinrich Schuchardt /* Execute the test */ 611d39646a3SHeinrich Schuchardt r = efi_selftest(&image_obj->header, &systab); 6125e2f0391SSimon Glass bootefi_run_finish(image_obj, loaded_image_info); 613c2b53902SHeinrich Schuchardt return r != EFI_SUCCESS; 614623b3a57SHeinrich Schuchardt } else 615623b3a57SHeinrich Schuchardt #endif 6169975fe96SRob Clark if (!strcmp(argv[1], "bootmgr")) { 617bc4f9133SHeinrich Schuchardt return do_bootefi_bootmgr_exec(); 6189975fe96SRob Clark } else { 619b9939336SAlexander Graf saddr = argv[1]; 620b9939336SAlexander Graf 621b9939336SAlexander Graf addr = simple_strtoul(saddr, NULL, 16); 62249db1cb8SHeinrich Schuchardt /* Check that a numeric value was passed */ 62349db1cb8SHeinrich Schuchardt if (!addr && *saddr != '0') 62449db1cb8SHeinrich Schuchardt return CMD_RET_USAGE; 625b9939336SAlexander Graf 626c7ae3dfdSSimon Glass } 6271c39809bSAlexander Graf 6285ee31bafSSimon Glass printf("## Starting EFI application at %08lx ...\n", addr); 629354264b3SAlexander Graf r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path, 630bc4f9133SHeinrich Schuchardt bootefi_image_path); 6311da1bac4Sxypron.glpk@gmx.de printf("## Application terminated, r = %lu\n", 6321da1bac4Sxypron.glpk@gmx.de r & ~EFI_ERROR_MASK); 633b9939336SAlexander Graf 6341da1bac4Sxypron.glpk@gmx.de if (r != EFI_SUCCESS) 6351da1bac4Sxypron.glpk@gmx.de return 1; 6361da1bac4Sxypron.glpk@gmx.de else 6371da1bac4Sxypron.glpk@gmx.de return 0; 638b9939336SAlexander Graf } 639b9939336SAlexander Graf 640b9939336SAlexander Graf #ifdef CONFIG_SYS_LONGHELP 641b9939336SAlexander Graf static char bootefi_help_text[] = 6421c39809bSAlexander Graf "<image address> [fdt address]\n" 6431c39809bSAlexander Graf " - boot EFI payload stored at address <image address>.\n" 6441c39809bSAlexander Graf " If specified, the device tree located at <fdt address> gets\n" 645c7ae3dfdSSimon Glass " exposed as EFI configuration table.\n" 646c7ae3dfdSSimon Glass #ifdef CONFIG_CMD_BOOTEFI_HELLO 647623b3a57SHeinrich Schuchardt "bootefi hello\n" 648623b3a57SHeinrich Schuchardt " - boot a sample Hello World application stored within U-Boot\n" 649623b3a57SHeinrich Schuchardt #endif 650623b3a57SHeinrich Schuchardt #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 651bc4f9133SHeinrich Schuchardt "bootefi selftest [fdt address]\n" 652623b3a57SHeinrich Schuchardt " - boot an EFI selftest application stored within U-Boot\n" 653d78e40d6SHeinrich Schuchardt " Use environment variable efi_selftest to select a single test.\n" 654d78e40d6SHeinrich Schuchardt " Use 'setenv efi_selftest list' to enumerate all tests.\n" 655c7ae3dfdSSimon Glass #endif 656f623e07fSHeinrich Schuchardt "bootefi bootmgr [fdt addr]\n" 6579975fe96SRob Clark " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n" 6589975fe96SRob Clark "\n" 6599975fe96SRob Clark " If specified, the device tree located at <fdt address> gets\n" 6609975fe96SRob Clark " exposed as EFI configuration table.\n"; 661b9939336SAlexander Graf #endif 662b9939336SAlexander Graf 663b9939336SAlexander Graf U_BOOT_CMD( 6641c39809bSAlexander Graf bootefi, 3, 0, do_bootefi, 66592dfd922SSergey Kubushyn "Boots an EFI payload from memory", 666b9939336SAlexander Graf bootefi_help_text 667b9939336SAlexander Graf ); 6680f4060ebSAlexander Graf 669c07ad7c0SAlexander Graf void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 6700f4060ebSAlexander Graf { 671f1589ffbSAKASHI Takahiro struct efi_device_path *device, *image; 672f1589ffbSAKASHI Takahiro efi_status_t ret; 6730f4060ebSAlexander Graf 67479276eb2SHeinrich Schuchardt /* efi_set_bootdev is typically called repeatedly, recover memory */ 67579276eb2SHeinrich Schuchardt efi_free_pool(bootefi_device_path); 67679276eb2SHeinrich Schuchardt efi_free_pool(bootefi_image_path); 677f1589ffbSAKASHI Takahiro 678f1589ffbSAKASHI Takahiro ret = efi_dp_from_name(dev, devnr, path, &device, &image); 679f1589ffbSAKASHI Takahiro if (ret == EFI_SUCCESS) { 680f1589ffbSAKASHI Takahiro bootefi_device_path = device; 681f1589ffbSAKASHI Takahiro bootefi_image_path = image; 682f1589ffbSAKASHI Takahiro } else { 68379276eb2SHeinrich Schuchardt bootefi_device_path = NULL; 68479276eb2SHeinrich Schuchardt bootefi_image_path = NULL; 685f9d334bdSAlexander Graf } 6860f4060ebSAlexander Graf } 687