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> 180d9d501fSAlexander Graf 190d9d501fSAlexander Graf DECLARE_GLOBAL_DATA_PTR; 20b9939336SAlexander Graf 21b9939336SAlexander Graf /* 22b9939336SAlexander Graf * When booting using the "bootefi" command, we don't know which 23b9939336SAlexander Graf * physical device the file came from. So we create a pseudo-device 24b9939336SAlexander Graf * called "bootefi" with the device path /bootefi. 25b9939336SAlexander Graf * 26b9939336SAlexander Graf * In addition to the originating device we also declare the file path 27b9939336SAlexander Graf * of "bootefi" based loads to be /bootefi. 28b9939336SAlexander Graf */ 290f4060ebSAlexander Graf static struct efi_device_path_file_path bootefi_image_path[] = { 30b9939336SAlexander Graf { 31b9939336SAlexander Graf .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 32b9939336SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 330f4060ebSAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 34b9939336SAlexander Graf .str = { 'b','o','o','t','e','f','i' }, 35b9939336SAlexander Graf }, { 36b9939336SAlexander Graf .dp.type = DEVICE_PATH_TYPE_END, 37b9939336SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 380f4060ebSAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 39b9939336SAlexander Graf } 40b9939336SAlexander Graf }; 41b9939336SAlexander Graf 42c07ad7c0SAlexander Graf static struct efi_device_path_file_path bootefi_device_path[] = { 43c07ad7c0SAlexander Graf { 44c07ad7c0SAlexander Graf .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 45c07ad7c0SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 46c07ad7c0SAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 47c07ad7c0SAlexander Graf .str = { 'b','o','o','t','e','f','i' }, 48c07ad7c0SAlexander Graf }, { 49c07ad7c0SAlexander Graf .dp.type = DEVICE_PATH_TYPE_END, 50c07ad7c0SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 51c07ad7c0SAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 52c07ad7c0SAlexander Graf } 53c07ad7c0SAlexander Graf }; 54c07ad7c0SAlexander Graf 55b9939336SAlexander Graf static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol, 56b9939336SAlexander Graf void **protocol_interface, void *agent_handle, 57b9939336SAlexander Graf void *controller_handle, uint32_t attributes) 58b9939336SAlexander Graf { 59c07ad7c0SAlexander Graf *protocol_interface = bootefi_device_path; 60b9939336SAlexander Graf return EFI_SUCCESS; 61b9939336SAlexander Graf } 62b9939336SAlexander Graf 63b9939336SAlexander Graf /* The EFI loaded_image interface for the image executed via "bootefi" */ 64b9939336SAlexander Graf static struct efi_loaded_image loaded_image_info = { 65c07ad7c0SAlexander Graf .device_handle = bootefi_device_path, 660f4060ebSAlexander Graf .file_path = bootefi_image_path, 67b9939336SAlexander Graf }; 68b9939336SAlexander Graf 69b9939336SAlexander Graf /* The EFI object struct for the image executed via "bootefi" */ 70b9939336SAlexander Graf static struct efi_object loaded_image_info_obj = { 71b9939336SAlexander Graf .handle = &loaded_image_info, 72b9939336SAlexander Graf .protocols = { 73b9939336SAlexander Graf { 74b9939336SAlexander Graf /* 75b9939336SAlexander Graf * When asking for the loaded_image interface, just 76b9939336SAlexander Graf * return handle which points to loaded_image_info 77b9939336SAlexander Graf */ 78b9939336SAlexander Graf .guid = &efi_guid_loaded_image, 79b9939336SAlexander Graf .open = &efi_return_handle, 80b9939336SAlexander Graf }, 81b9939336SAlexander Graf { 82b9939336SAlexander Graf /* 83b9939336SAlexander Graf * When asking for the device path interface, return 84c07ad7c0SAlexander Graf * bootefi_device_path 85b9939336SAlexander Graf */ 86b9939336SAlexander Graf .guid = &efi_guid_device_path, 87b9939336SAlexander Graf .open = &bootefi_open_dp, 88b9939336SAlexander Graf }, 89b9939336SAlexander Graf }, 90b9939336SAlexander Graf }; 91b9939336SAlexander Graf 92b9939336SAlexander Graf /* The EFI object struct for the device the "bootefi" image was loaded from */ 93b9939336SAlexander Graf static struct efi_object bootefi_device_obj = { 94c07ad7c0SAlexander Graf .handle = bootefi_device_path, 95b9939336SAlexander Graf .protocols = { 96b9939336SAlexander Graf { 97b9939336SAlexander Graf /* When asking for the device path interface, return 98c07ad7c0SAlexander Graf * bootefi_device_path */ 99b9939336SAlexander Graf .guid = &efi_guid_device_path, 100b9939336SAlexander Graf .open = &bootefi_open_dp, 101b9939336SAlexander Graf } 102b9939336SAlexander Graf }, 103b9939336SAlexander Graf }; 104b9939336SAlexander Graf 1050d9d501fSAlexander Graf static void *copy_fdt(void *fdt) 1060d9d501fSAlexander Graf { 1070d9d501fSAlexander Graf u64 fdt_size = fdt_totalsize(fdt); 108ad0c1a3dSAlexander Graf unsigned long fdt_ram_start = -1L, fdt_pages; 109ad0c1a3dSAlexander Graf u64 new_fdt_addr; 1100d9d501fSAlexander Graf void *new_fdt; 111ad0c1a3dSAlexander Graf int i; 1120d9d501fSAlexander Graf 113ad0c1a3dSAlexander Graf for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 114ad0c1a3dSAlexander Graf u64 ram_start = gd->bd->bi_dram[i].start; 115ad0c1a3dSAlexander Graf u64 ram_size = gd->bd->bi_dram[i].size; 1160d9d501fSAlexander Graf 117ad0c1a3dSAlexander Graf if (!ram_size) 118ad0c1a3dSAlexander Graf continue; 119ad0c1a3dSAlexander Graf 120ad0c1a3dSAlexander Graf if (ram_start < fdt_ram_start) 121ad0c1a3dSAlexander Graf fdt_ram_start = ram_start; 122ad0c1a3dSAlexander Graf } 123ad0c1a3dSAlexander Graf 124ad0c1a3dSAlexander Graf /* Give us at least 4kb breathing room */ 125ad0c1a3dSAlexander Graf fdt_size = ALIGN(fdt_size + 4096, 4096); 126ad0c1a3dSAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 127ad0c1a3dSAlexander Graf 128ad0c1a3dSAlexander Graf /* Safe fdt location is at 128MB */ 129ad0c1a3dSAlexander Graf new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size; 130ad0c1a3dSAlexander Graf if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages, 131ad0c1a3dSAlexander Graf &new_fdt_addr) != EFI_SUCCESS) { 132ad0c1a3dSAlexander Graf /* If we can't put it there, put it somewhere */ 133ad0c1a3dSAlexander Graf new_fdt_addr = (ulong)memalign(4096, fdt_size); 134ad0c1a3dSAlexander Graf } 135ad0c1a3dSAlexander Graf new_fdt = (void*)(ulong)new_fdt_addr; 1360d9d501fSAlexander Graf memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 1370d9d501fSAlexander Graf fdt_set_totalsize(new_fdt, fdt_size); 1380d9d501fSAlexander Graf 1390d9d501fSAlexander Graf return new_fdt; 1400d9d501fSAlexander Graf } 1410d9d501fSAlexander Graf 142b9939336SAlexander Graf /* 143b9939336SAlexander Graf * Load an EFI payload into a newly allocated piece of memory, register all 144b9939336SAlexander Graf * EFI objects it would want to access and jump to it. 145b9939336SAlexander Graf */ 1461c39809bSAlexander Graf static unsigned long do_bootefi_exec(void *efi, void *fdt) 147b9939336SAlexander Graf { 148b9939336SAlexander Graf ulong (*entry)(void *image_handle, struct efi_system_table *st); 149b9939336SAlexander Graf ulong fdt_pages, fdt_size, fdt_start, fdt_end; 150dea2174dSAlexander Graf bootm_headers_t img = { 0 }; 151b9939336SAlexander Graf 152b9939336SAlexander Graf /* 153b9939336SAlexander Graf * gd lives in a fixed register which may get clobbered while we execute 154b9939336SAlexander Graf * the payload. So save it here and restore it on every callback entry 155b9939336SAlexander Graf */ 156b9939336SAlexander Graf efi_save_gd(); 157b9939336SAlexander Graf 1581c39809bSAlexander Graf if (fdt && !fdt_check_header(fdt)) { 159dea2174dSAlexander Graf /* Prepare fdt for payload */ 1600d9d501fSAlexander Graf fdt = copy_fdt(fdt); 1610d9d501fSAlexander Graf 1620d9d501fSAlexander Graf if (image_setup_libfdt(&img, fdt, 0, NULL)) { 163dea2174dSAlexander Graf printf("ERROR: Failed to process device tree\n"); 164dea2174dSAlexander Graf return -EINVAL; 165dea2174dSAlexander Graf } 166dea2174dSAlexander Graf 167dea2174dSAlexander Graf /* Link to it in the efi tables */ 168b9939336SAlexander Graf systab.tables[0].guid = EFI_FDT_GUID; 1690d9d501fSAlexander Graf systab.tables[0].table = fdt; 170b9939336SAlexander Graf systab.nr_tables = 1; 171b9939336SAlexander Graf 172b9939336SAlexander Graf /* And reserve the space in the memory map */ 1730d9d501fSAlexander Graf fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK; 1740d9d501fSAlexander Graf fdt_end = ((ulong)fdt) + fdt_totalsize(fdt); 175b9939336SAlexander Graf fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK; 176b9939336SAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 177b9939336SAlexander Graf /* Give a bootloader the chance to modify the device tree */ 178b9939336SAlexander Graf fdt_pages += 2; 179b9939336SAlexander Graf efi_add_memory_map(fdt_start, fdt_pages, 180b9939336SAlexander Graf EFI_BOOT_SERVICES_DATA, true); 181b9939336SAlexander Graf } else { 1821c39809bSAlexander Graf printf("WARNING: Invalid device tree, expect boot to fail\n"); 183b9939336SAlexander Graf systab.nr_tables = 0; 184b9939336SAlexander Graf } 185b9939336SAlexander Graf 186b9939336SAlexander Graf /* Load the EFI payload */ 187b9939336SAlexander Graf entry = efi_load_pe(efi, &loaded_image_info); 188b9939336SAlexander Graf if (!entry) 189b9939336SAlexander Graf return -ENOENT; 190b9939336SAlexander Graf 191b9939336SAlexander Graf /* Initialize and populate EFI object list */ 192b9939336SAlexander Graf INIT_LIST_HEAD(&efi_obj_list); 193b9939336SAlexander Graf list_add_tail(&loaded_image_info_obj.link, &efi_obj_list); 194b9939336SAlexander Graf list_add_tail(&bootefi_device_obj.link, &efi_obj_list); 195b9939336SAlexander Graf #ifdef CONFIG_PARTITIONS 196b9939336SAlexander Graf efi_disk_register(); 197b9939336SAlexander Graf #endif 198be8d3241SAlexander Graf #ifdef CONFIG_LCD 199be8d3241SAlexander Graf efi_gop_register(); 200be8d3241SAlexander Graf #endif 2010efe1bcfSAlexander Graf #ifdef CONFIG_NET 2020efe1bcfSAlexander Graf void *nethandle = loaded_image_info.device_handle; 2030efe1bcfSAlexander Graf efi_net_register(&nethandle); 2040efe1bcfSAlexander Graf 2050efe1bcfSAlexander Graf if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6)) 2060efe1bcfSAlexander Graf loaded_image_info.device_handle = nethandle; 2070efe1bcfSAlexander Graf #endif 208b9939336SAlexander Graf 209*80a4800eSAlexander Graf /* Initialize EFI runtime services */ 210*80a4800eSAlexander Graf efi_reset_system_init(); 211*80a4800eSAlexander Graf efi_get_time_init(); 212*80a4800eSAlexander Graf 213b9939336SAlexander Graf /* Call our payload! */ 214edcef3baSAlexander Graf debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 215a86aeaf2SAlexander Graf 216a86aeaf2SAlexander Graf if (setjmp(&loaded_image_info.exit_jmp)) { 217a86aeaf2SAlexander Graf efi_status_t status = loaded_image_info.exit_status; 218a86aeaf2SAlexander Graf return status == EFI_SUCCESS ? 0 : -EINVAL; 219a86aeaf2SAlexander Graf } 220a86aeaf2SAlexander Graf 221b9939336SAlexander Graf return entry(&loaded_image_info, &systab); 222b9939336SAlexander Graf } 223b9939336SAlexander Graf 224b9939336SAlexander Graf 225b9939336SAlexander Graf /* Interpreter command to boot an arbitrary EFI image from memory */ 226b9939336SAlexander Graf static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 227b9939336SAlexander Graf { 2281c39809bSAlexander Graf char *saddr, *sfdt; 2291c39809bSAlexander Graf unsigned long addr, fdt_addr = 0; 230b9939336SAlexander Graf int r = 0; 231b9939336SAlexander Graf 232b9939336SAlexander Graf if (argc < 2) 2333c1dcef6SBin Meng return CMD_RET_USAGE; 234b9939336SAlexander Graf saddr = argv[1]; 235b9939336SAlexander Graf 236b9939336SAlexander Graf addr = simple_strtoul(saddr, NULL, 16); 237b9939336SAlexander Graf 2381c39809bSAlexander Graf if (argc > 2) { 2391c39809bSAlexander Graf sfdt = argv[2]; 2401c39809bSAlexander Graf fdt_addr = simple_strtoul(sfdt, NULL, 16); 2411c39809bSAlexander Graf } 2421c39809bSAlexander Graf 243b9939336SAlexander Graf printf("## Starting EFI application at 0x%08lx ...\n", addr); 2441c39809bSAlexander Graf r = do_bootefi_exec((void *)addr, (void*)fdt_addr); 245b9939336SAlexander Graf printf("## Application terminated, r = %d\n", r); 246b9939336SAlexander Graf 247b9939336SAlexander Graf if (r != 0) 248b9939336SAlexander Graf r = 1; 249b9939336SAlexander Graf 250b9939336SAlexander Graf return r; 251b9939336SAlexander Graf } 252b9939336SAlexander Graf 253b9939336SAlexander Graf #ifdef CONFIG_SYS_LONGHELP 254b9939336SAlexander Graf static char bootefi_help_text[] = 2551c39809bSAlexander Graf "<image address> [fdt address]\n" 2561c39809bSAlexander Graf " - boot EFI payload stored at address <image address>.\n" 2571c39809bSAlexander Graf " If specified, the device tree located at <fdt address> gets\n" 2581c39809bSAlexander Graf " exposed as EFI configuration table.\n"; 259b9939336SAlexander Graf #endif 260b9939336SAlexander Graf 261b9939336SAlexander Graf U_BOOT_CMD( 2621c39809bSAlexander Graf bootefi, 3, 0, do_bootefi, 26392dfd922SSergey Kubushyn "Boots an EFI payload from memory", 264b9939336SAlexander Graf bootefi_help_text 265b9939336SAlexander Graf ); 2660f4060ebSAlexander Graf 267c07ad7c0SAlexander Graf void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 2680f4060ebSAlexander Graf { 2698c3df0bfSAlexander Graf __maybe_unused struct blk_desc *desc; 270ecbe1a07SAlexander Graf char devname[32] = { 0 }; /* dp->str is u16[32] long */ 2710f4060ebSAlexander Graf char *colon; 2720f4060ebSAlexander Graf 273f9d334bdSAlexander Graf #if defined(CONFIG_BLK) || defined(CONFIG_ISO_PARTITION) 274f9d334bdSAlexander Graf desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10)); 275f9d334bdSAlexander Graf #endif 276f9d334bdSAlexander Graf 277f9d334bdSAlexander Graf #ifdef CONFIG_BLK 278f9d334bdSAlexander Graf if (desc) { 279f9d334bdSAlexander Graf snprintf(devname, sizeof(devname), "%s", desc->bdev->name); 280f9d334bdSAlexander Graf } else 281f9d334bdSAlexander Graf #endif 282f9d334bdSAlexander Graf 283f9d334bdSAlexander Graf { 2840f4060ebSAlexander Graf /* Assemble the condensed device name we use in efi_disk.c */ 2850f4060ebSAlexander Graf snprintf(devname, sizeof(devname), "%s%s", dev, devnr); 286f9d334bdSAlexander Graf } 287f9d334bdSAlexander Graf 2880f4060ebSAlexander Graf colon = strchr(devname, ':'); 2898c3df0bfSAlexander Graf 2908c3df0bfSAlexander Graf #ifdef CONFIG_ISO_PARTITION 2918c3df0bfSAlexander Graf /* For ISOs we create partition block devices */ 2928c3df0bfSAlexander Graf if (desc && (desc->type != DEV_TYPE_UNKNOWN) && 2938c3df0bfSAlexander Graf (desc->part_type == PART_TYPE_ISO)) { 2948c3df0bfSAlexander Graf if (!colon) 295f9d334bdSAlexander Graf snprintf(devname, sizeof(devname), "%s:1", devname); 296f9d334bdSAlexander Graf 2978c3df0bfSAlexander Graf colon = NULL; 2988c3df0bfSAlexander Graf } 2998c3df0bfSAlexander Graf #endif 3008c3df0bfSAlexander Graf 3010f4060ebSAlexander Graf if (colon) 3020f4060ebSAlexander Graf *colon = '\0'; 3030f4060ebSAlexander Graf 304c07ad7c0SAlexander Graf /* Patch bootefi_device_path to the target device */ 305c07ad7c0SAlexander Graf memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str)); 306c07ad7c0SAlexander Graf ascii2unicode(bootefi_device_path[0].str, devname); 307c07ad7c0SAlexander Graf 308c07ad7c0SAlexander Graf /* Patch bootefi_image_path to the target file path */ 3090f4060ebSAlexander Graf memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str)); 31049271666SAlexander Graf if (strcmp(dev, "Net")) { 31149271666SAlexander Graf /* Add leading / to fs paths, because they're absolute */ 31249271666SAlexander Graf snprintf(devname, sizeof(devname), "/%s", path); 31349271666SAlexander Graf } else { 314c07ad7c0SAlexander Graf snprintf(devname, sizeof(devname), "%s", path); 31549271666SAlexander Graf } 3160f4060ebSAlexander Graf ascii2unicode(bootefi_image_path[0].str, devname); 3170f4060ebSAlexander Graf } 318