1b9939336SAlexander Graf /* 2b9939336SAlexander Graf * EFI application loader 3b9939336SAlexander Graf * 4b9939336SAlexander Graf * Copyright (c) 2016 Alexander Graf 5b9939336SAlexander Graf * 6b9939336SAlexander Graf * SPDX-License-Identifier: GPL-2.0+ 7b9939336SAlexander Graf */ 8b9939336SAlexander Graf 9b9939336SAlexander Graf #include <common.h> 10b9939336SAlexander Graf #include <command.h> 11f9d334bdSAlexander Graf #include <dm/device.h> 12b9939336SAlexander Graf #include <efi_loader.h> 13b9939336SAlexander Graf #include <errno.h> 14b9939336SAlexander Graf #include <libfdt.h> 15b9939336SAlexander Graf #include <libfdt_env.h> 16ad0c1a3dSAlexander Graf #include <memalign.h> 170d9d501fSAlexander Graf #include <asm/global_data.h> 18e275458cSSimon Glass #include <asm-generic/sections.h> 19e275458cSSimon Glass #include <linux/linkage.h> 200d9d501fSAlexander Graf 210d9d501fSAlexander Graf DECLARE_GLOBAL_DATA_PTR; 22b9939336SAlexander Graf 23b9939336SAlexander Graf /* 24b9939336SAlexander Graf * When booting using the "bootefi" command, we don't know which 25b9939336SAlexander Graf * physical device the file came from. So we create a pseudo-device 26b9939336SAlexander Graf * called "bootefi" with the device path /bootefi. 27b9939336SAlexander Graf * 28b9939336SAlexander Graf * In addition to the originating device we also declare the file path 29b9939336SAlexander Graf * of "bootefi" based loads to be /bootefi. 30b9939336SAlexander Graf */ 310f4060ebSAlexander Graf static struct efi_device_path_file_path bootefi_image_path[] = { 32b9939336SAlexander Graf { 33b9939336SAlexander Graf .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 34b9939336SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 350f4060ebSAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 36b9939336SAlexander Graf .str = { 'b','o','o','t','e','f','i' }, 37b9939336SAlexander Graf }, { 38b9939336SAlexander Graf .dp.type = DEVICE_PATH_TYPE_END, 39b9939336SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 400f4060ebSAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 41b9939336SAlexander Graf } 42b9939336SAlexander Graf }; 43b9939336SAlexander Graf 44c07ad7c0SAlexander Graf static struct efi_device_path_file_path bootefi_device_path[] = { 45c07ad7c0SAlexander Graf { 46c07ad7c0SAlexander Graf .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 47c07ad7c0SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 48c07ad7c0SAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 49c07ad7c0SAlexander Graf .str = { 'b','o','o','t','e','f','i' }, 50c07ad7c0SAlexander Graf }, { 51c07ad7c0SAlexander Graf .dp.type = DEVICE_PATH_TYPE_END, 52c07ad7c0SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 53c07ad7c0SAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 54c07ad7c0SAlexander Graf } 55c07ad7c0SAlexander Graf }; 56c07ad7c0SAlexander Graf 57e275458cSSimon Glass static efi_status_t EFIAPI bootefi_open_dp(void *handle, efi_guid_t *protocol, 58b9939336SAlexander Graf void **protocol_interface, void *agent_handle, 59b9939336SAlexander Graf void *controller_handle, uint32_t attributes) 60b9939336SAlexander Graf { 61c07ad7c0SAlexander Graf *protocol_interface = bootefi_device_path; 62b9939336SAlexander Graf return EFI_SUCCESS; 63b9939336SAlexander Graf } 64b9939336SAlexander Graf 65b9939336SAlexander Graf /* The EFI loaded_image interface for the image executed via "bootefi" */ 66b9939336SAlexander Graf static struct efi_loaded_image loaded_image_info = { 67c07ad7c0SAlexander Graf .device_handle = bootefi_device_path, 680f4060ebSAlexander Graf .file_path = bootefi_image_path, 69b9939336SAlexander Graf }; 70b9939336SAlexander Graf 71b9939336SAlexander Graf /* The EFI object struct for the image executed via "bootefi" */ 72b9939336SAlexander Graf static struct efi_object loaded_image_info_obj = { 73b9939336SAlexander Graf .handle = &loaded_image_info, 74b9939336SAlexander Graf .protocols = { 75b9939336SAlexander Graf { 76b9939336SAlexander Graf /* 77b9939336SAlexander Graf * When asking for the loaded_image interface, just 78b9939336SAlexander Graf * return handle which points to loaded_image_info 79b9939336SAlexander Graf */ 80b9939336SAlexander Graf .guid = &efi_guid_loaded_image, 81b9939336SAlexander Graf .open = &efi_return_handle, 82b9939336SAlexander Graf }, 83b9939336SAlexander Graf { 84b9939336SAlexander Graf /* 85b9939336SAlexander Graf * When asking for the device path interface, return 86c07ad7c0SAlexander Graf * bootefi_device_path 87b9939336SAlexander Graf */ 88b9939336SAlexander Graf .guid = &efi_guid_device_path, 89b9939336SAlexander Graf .open = &bootefi_open_dp, 90b9939336SAlexander Graf }, 91b9939336SAlexander Graf }, 92b9939336SAlexander Graf }; 93b9939336SAlexander Graf 94b9939336SAlexander Graf /* The EFI object struct for the device the "bootefi" image was loaded from */ 95b9939336SAlexander Graf static struct efi_object bootefi_device_obj = { 96c07ad7c0SAlexander Graf .handle = bootefi_device_path, 97b9939336SAlexander Graf .protocols = { 98b9939336SAlexander Graf { 99b9939336SAlexander Graf /* When asking for the device path interface, return 100c07ad7c0SAlexander Graf * bootefi_device_path */ 101b9939336SAlexander Graf .guid = &efi_guid_device_path, 102b9939336SAlexander Graf .open = &bootefi_open_dp, 103b9939336SAlexander Graf } 104b9939336SAlexander Graf }, 105b9939336SAlexander Graf }; 106b9939336SAlexander Graf 1070d9d501fSAlexander Graf static void *copy_fdt(void *fdt) 1080d9d501fSAlexander Graf { 1090d9d501fSAlexander Graf u64 fdt_size = fdt_totalsize(fdt); 110ad0c1a3dSAlexander Graf unsigned long fdt_ram_start = -1L, fdt_pages; 111ad0c1a3dSAlexander Graf u64 new_fdt_addr; 1120d9d501fSAlexander Graf void *new_fdt; 113ad0c1a3dSAlexander Graf int i; 1140d9d501fSAlexander Graf 115ad0c1a3dSAlexander Graf for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 116ad0c1a3dSAlexander Graf u64 ram_start = gd->bd->bi_dram[i].start; 117ad0c1a3dSAlexander Graf u64 ram_size = gd->bd->bi_dram[i].size; 1180d9d501fSAlexander Graf 119ad0c1a3dSAlexander Graf if (!ram_size) 120ad0c1a3dSAlexander Graf continue; 121ad0c1a3dSAlexander Graf 122ad0c1a3dSAlexander Graf if (ram_start < fdt_ram_start) 123ad0c1a3dSAlexander Graf fdt_ram_start = ram_start; 124ad0c1a3dSAlexander Graf } 125ad0c1a3dSAlexander Graf 126ad0c1a3dSAlexander Graf /* Give us at least 4kb breathing room */ 127ad0c1a3dSAlexander Graf fdt_size = ALIGN(fdt_size + 4096, 4096); 128ad0c1a3dSAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 129ad0c1a3dSAlexander Graf 130ad0c1a3dSAlexander Graf /* Safe fdt location is at 128MB */ 131ad0c1a3dSAlexander Graf new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size; 132ad0c1a3dSAlexander Graf if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages, 133ad0c1a3dSAlexander Graf &new_fdt_addr) != EFI_SUCCESS) { 134ad0c1a3dSAlexander Graf /* If we can't put it there, put it somewhere */ 135ad0c1a3dSAlexander Graf new_fdt_addr = (ulong)memalign(4096, fdt_size); 136ad0c1a3dSAlexander Graf } 137ad0c1a3dSAlexander Graf new_fdt = (void*)(ulong)new_fdt_addr; 1380d9d501fSAlexander Graf memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 1390d9d501fSAlexander Graf fdt_set_totalsize(new_fdt, fdt_size); 1400d9d501fSAlexander Graf 1410d9d501fSAlexander Graf return new_fdt; 1420d9d501fSAlexander Graf } 1430d9d501fSAlexander Graf 144b9939336SAlexander Graf /* 145b9939336SAlexander Graf * Load an EFI payload into a newly allocated piece of memory, register all 146b9939336SAlexander Graf * EFI objects it would want to access and jump to it. 147b9939336SAlexander Graf */ 1481c39809bSAlexander Graf static unsigned long do_bootefi_exec(void *efi, void *fdt) 149b9939336SAlexander Graf { 150e275458cSSimon Glass ulong (*entry)(void *image_handle, struct efi_system_table *st) 151e275458cSSimon Glass asmlinkage; 152b9939336SAlexander Graf ulong fdt_pages, fdt_size, fdt_start, fdt_end; 153dea2174dSAlexander Graf bootm_headers_t img = { 0 }; 154b9939336SAlexander Graf 155b9939336SAlexander Graf /* 156b9939336SAlexander Graf * gd lives in a fixed register which may get clobbered while we execute 157b9939336SAlexander Graf * the payload. So save it here and restore it on every callback entry 158b9939336SAlexander Graf */ 159b9939336SAlexander Graf efi_save_gd(); 160b9939336SAlexander Graf 1611c39809bSAlexander Graf if (fdt && !fdt_check_header(fdt)) { 162dea2174dSAlexander Graf /* Prepare fdt for payload */ 1630d9d501fSAlexander Graf fdt = copy_fdt(fdt); 1640d9d501fSAlexander Graf 1650d9d501fSAlexander Graf if (image_setup_libfdt(&img, fdt, 0, NULL)) { 166dea2174dSAlexander Graf printf("ERROR: Failed to process device tree\n"); 167dea2174dSAlexander Graf return -EINVAL; 168dea2174dSAlexander Graf } 169dea2174dSAlexander Graf 170dea2174dSAlexander Graf /* Link to it in the efi tables */ 171b9939336SAlexander Graf systab.tables[0].guid = EFI_FDT_GUID; 1720d9d501fSAlexander Graf systab.tables[0].table = fdt; 173b9939336SAlexander Graf systab.nr_tables = 1; 174b9939336SAlexander Graf 175b9939336SAlexander Graf /* And reserve the space in the memory map */ 1760d9d501fSAlexander Graf fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK; 1770d9d501fSAlexander Graf fdt_end = ((ulong)fdt) + fdt_totalsize(fdt); 178b9939336SAlexander Graf fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK; 179b9939336SAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 180b9939336SAlexander Graf /* Give a bootloader the chance to modify the device tree */ 181b9939336SAlexander Graf fdt_pages += 2; 182b9939336SAlexander Graf efi_add_memory_map(fdt_start, fdt_pages, 183b9939336SAlexander Graf EFI_BOOT_SERVICES_DATA, true); 184b9939336SAlexander Graf } else { 1851c39809bSAlexander Graf printf("WARNING: Invalid device tree, expect boot to fail\n"); 186b9939336SAlexander Graf systab.nr_tables = 0; 187b9939336SAlexander Graf } 188b9939336SAlexander Graf 189b9939336SAlexander Graf /* Load the EFI payload */ 190b9939336SAlexander Graf entry = efi_load_pe(efi, &loaded_image_info); 191b9939336SAlexander Graf if (!entry) 192b9939336SAlexander Graf return -ENOENT; 193b9939336SAlexander Graf 194b9939336SAlexander Graf /* Initialize and populate EFI object list */ 195b9939336SAlexander Graf INIT_LIST_HEAD(&efi_obj_list); 196b9939336SAlexander Graf list_add_tail(&loaded_image_info_obj.link, &efi_obj_list); 197b9939336SAlexander Graf list_add_tail(&bootefi_device_obj.link, &efi_obj_list); 198b9939336SAlexander Graf #ifdef CONFIG_PARTITIONS 199b9939336SAlexander Graf efi_disk_register(); 200b9939336SAlexander Graf #endif 201be8d3241SAlexander Graf #ifdef CONFIG_LCD 202be8d3241SAlexander Graf efi_gop_register(); 203be8d3241SAlexander Graf #endif 2040efe1bcfSAlexander Graf #ifdef CONFIG_NET 2050efe1bcfSAlexander Graf void *nethandle = loaded_image_info.device_handle; 2060efe1bcfSAlexander Graf efi_net_register(&nethandle); 2070efe1bcfSAlexander Graf 2080efe1bcfSAlexander Graf if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6)) 2090efe1bcfSAlexander Graf loaded_image_info.device_handle = nethandle; 210*3fb97e26SAlexander Graf else 211*3fb97e26SAlexander Graf loaded_image_info.device_handle = bootefi_device_path; 2120efe1bcfSAlexander Graf #endif 213e663b350SAlexander Graf #ifdef CONFIG_GENERATE_SMBIOS_TABLE 214e663b350SAlexander Graf efi_smbios_register(); 215e663b350SAlexander Graf #endif 216b9939336SAlexander Graf 21780a4800eSAlexander Graf /* Initialize EFI runtime services */ 21880a4800eSAlexander Graf efi_reset_system_init(); 21980a4800eSAlexander Graf efi_get_time_init(); 22080a4800eSAlexander Graf 221b9939336SAlexander Graf /* Call our payload! */ 222edcef3baSAlexander Graf debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 223a86aeaf2SAlexander Graf 224a86aeaf2SAlexander Graf if (setjmp(&loaded_image_info.exit_jmp)) { 225a86aeaf2SAlexander Graf efi_status_t status = loaded_image_info.exit_status; 226a86aeaf2SAlexander Graf return status == EFI_SUCCESS ? 0 : -EINVAL; 227a86aeaf2SAlexander Graf } 228a86aeaf2SAlexander Graf 229b9939336SAlexander Graf return entry(&loaded_image_info, &systab); 230b9939336SAlexander Graf } 231b9939336SAlexander Graf 232b9939336SAlexander Graf 233b9939336SAlexander Graf /* Interpreter command to boot an arbitrary EFI image from memory */ 234b9939336SAlexander Graf static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 235b9939336SAlexander Graf { 2361c39809bSAlexander Graf char *saddr, *sfdt; 2371c39809bSAlexander Graf unsigned long addr, fdt_addr = 0; 238b9939336SAlexander Graf int r = 0; 239b9939336SAlexander Graf 240b9939336SAlexander Graf if (argc < 2) 2413c1dcef6SBin Meng return CMD_RET_USAGE; 242b9939336SAlexander Graf saddr = argv[1]; 243b9939336SAlexander Graf 244b9939336SAlexander Graf addr = simple_strtoul(saddr, NULL, 16); 245b9939336SAlexander Graf 2461c39809bSAlexander Graf if (argc > 2) { 2471c39809bSAlexander Graf sfdt = argv[2]; 2481c39809bSAlexander Graf fdt_addr = simple_strtoul(sfdt, NULL, 16); 2491c39809bSAlexander Graf } 2501c39809bSAlexander Graf 251b9939336SAlexander Graf printf("## Starting EFI application at 0x%08lx ...\n", addr); 2521c39809bSAlexander Graf r = do_bootefi_exec((void *)addr, (void*)fdt_addr); 253b9939336SAlexander Graf printf("## Application terminated, r = %d\n", r); 254b9939336SAlexander Graf 255b9939336SAlexander Graf if (r != 0) 256b9939336SAlexander Graf r = 1; 257b9939336SAlexander Graf 258b9939336SAlexander Graf return r; 259b9939336SAlexander Graf } 260b9939336SAlexander Graf 261b9939336SAlexander Graf #ifdef CONFIG_SYS_LONGHELP 262b9939336SAlexander Graf static char bootefi_help_text[] = 2631c39809bSAlexander Graf "<image address> [fdt address]\n" 2641c39809bSAlexander Graf " - boot EFI payload stored at address <image address>.\n" 2651c39809bSAlexander Graf " If specified, the device tree located at <fdt address> gets\n" 2661c39809bSAlexander Graf " exposed as EFI configuration table.\n"; 267b9939336SAlexander Graf #endif 268b9939336SAlexander Graf 269b9939336SAlexander Graf U_BOOT_CMD( 2701c39809bSAlexander Graf bootefi, 3, 0, do_bootefi, 27192dfd922SSergey Kubushyn "Boots an EFI payload from memory", 272b9939336SAlexander Graf bootefi_help_text 273b9939336SAlexander Graf ); 2740f4060ebSAlexander Graf 275c07ad7c0SAlexander Graf void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 2760f4060ebSAlexander Graf { 2778c3df0bfSAlexander Graf __maybe_unused struct blk_desc *desc; 278ecbe1a07SAlexander Graf char devname[32] = { 0 }; /* dp->str is u16[32] long */ 2790f4060ebSAlexander Graf char *colon; 2800f4060ebSAlexander Graf 281f9d334bdSAlexander Graf #if defined(CONFIG_BLK) || defined(CONFIG_ISO_PARTITION) 282f9d334bdSAlexander Graf desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10)); 283f9d334bdSAlexander Graf #endif 284f9d334bdSAlexander Graf 285f9d334bdSAlexander Graf #ifdef CONFIG_BLK 286f9d334bdSAlexander Graf if (desc) { 287f9d334bdSAlexander Graf snprintf(devname, sizeof(devname), "%s", desc->bdev->name); 288f9d334bdSAlexander Graf } else 289f9d334bdSAlexander Graf #endif 290f9d334bdSAlexander Graf 291f9d334bdSAlexander Graf { 2920f4060ebSAlexander Graf /* Assemble the condensed device name we use in efi_disk.c */ 2930f4060ebSAlexander Graf snprintf(devname, sizeof(devname), "%s%s", dev, devnr); 294f9d334bdSAlexander Graf } 295f9d334bdSAlexander Graf 2960f4060ebSAlexander Graf colon = strchr(devname, ':'); 2978c3df0bfSAlexander Graf 2988c3df0bfSAlexander Graf #ifdef CONFIG_ISO_PARTITION 2998c3df0bfSAlexander Graf /* For ISOs we create partition block devices */ 3008c3df0bfSAlexander Graf if (desc && (desc->type != DEV_TYPE_UNKNOWN) && 3018c3df0bfSAlexander Graf (desc->part_type == PART_TYPE_ISO)) { 3028c3df0bfSAlexander Graf if (!colon) 303f9d334bdSAlexander Graf snprintf(devname, sizeof(devname), "%s:1", devname); 304f9d334bdSAlexander Graf 3058c3df0bfSAlexander Graf colon = NULL; 3068c3df0bfSAlexander Graf } 3078c3df0bfSAlexander Graf #endif 3088c3df0bfSAlexander Graf 3090f4060ebSAlexander Graf if (colon) 3100f4060ebSAlexander Graf *colon = '\0'; 3110f4060ebSAlexander Graf 312c07ad7c0SAlexander Graf /* Patch bootefi_device_path to the target device */ 313c07ad7c0SAlexander Graf memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str)); 314c07ad7c0SAlexander Graf ascii2unicode(bootefi_device_path[0].str, devname); 315c07ad7c0SAlexander Graf 316c07ad7c0SAlexander Graf /* Patch bootefi_image_path to the target file path */ 3170f4060ebSAlexander Graf memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str)); 31849271666SAlexander Graf if (strcmp(dev, "Net")) { 31949271666SAlexander Graf /* Add leading / to fs paths, because they're absolute */ 32049271666SAlexander Graf snprintf(devname, sizeof(devname), "/%s", path); 32149271666SAlexander Graf } else { 322c07ad7c0SAlexander Graf snprintf(devname, sizeof(devname), "%s", path); 32349271666SAlexander Graf } 3240f4060ebSAlexander Graf ascii2unicode(bootefi_image_path[0].str, devname); 3250f4060ebSAlexander Graf } 326