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> 11b9939336SAlexander Graf #include <efi_loader.h> 12b9939336SAlexander Graf #include <errno.h> 13b9939336SAlexander Graf #include <libfdt.h> 14b9939336SAlexander Graf #include <libfdt_env.h> 15ad0c1a3dSAlexander Graf #include <memalign.h> 160d9d501fSAlexander Graf #include <asm/global_data.h> 170d9d501fSAlexander Graf 180d9d501fSAlexander Graf DECLARE_GLOBAL_DATA_PTR; 19b9939336SAlexander Graf 20b9939336SAlexander Graf /* 21b9939336SAlexander Graf * When booting using the "bootefi" command, we don't know which 22b9939336SAlexander Graf * physical device the file came from. So we create a pseudo-device 23b9939336SAlexander Graf * called "bootefi" with the device path /bootefi. 24b9939336SAlexander Graf * 25b9939336SAlexander Graf * In addition to the originating device we also declare the file path 26b9939336SAlexander Graf * of "bootefi" based loads to be /bootefi. 27b9939336SAlexander Graf */ 280f4060ebSAlexander Graf static struct efi_device_path_file_path bootefi_image_path[] = { 29b9939336SAlexander Graf { 30b9939336SAlexander Graf .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 31b9939336SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 320f4060ebSAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 33b9939336SAlexander Graf .str = { 'b','o','o','t','e','f','i' }, 34b9939336SAlexander Graf }, { 35b9939336SAlexander Graf .dp.type = DEVICE_PATH_TYPE_END, 36b9939336SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 370f4060ebSAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 38b9939336SAlexander Graf } 39b9939336SAlexander Graf }; 40b9939336SAlexander Graf 41c07ad7c0SAlexander Graf static struct efi_device_path_file_path bootefi_device_path[] = { 42c07ad7c0SAlexander Graf { 43c07ad7c0SAlexander Graf .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 44c07ad7c0SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 45c07ad7c0SAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 46c07ad7c0SAlexander Graf .str = { 'b','o','o','t','e','f','i' }, 47c07ad7c0SAlexander Graf }, { 48c07ad7c0SAlexander Graf .dp.type = DEVICE_PATH_TYPE_END, 49c07ad7c0SAlexander Graf .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 50c07ad7c0SAlexander Graf .dp.length = sizeof(bootefi_image_path[0]), 51c07ad7c0SAlexander Graf } 52c07ad7c0SAlexander Graf }; 53c07ad7c0SAlexander Graf 54b9939336SAlexander Graf static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol, 55b9939336SAlexander Graf void **protocol_interface, void *agent_handle, 56b9939336SAlexander Graf void *controller_handle, uint32_t attributes) 57b9939336SAlexander Graf { 58c07ad7c0SAlexander Graf *protocol_interface = bootefi_device_path; 59b9939336SAlexander Graf return EFI_SUCCESS; 60b9939336SAlexander Graf } 61b9939336SAlexander Graf 62b9939336SAlexander Graf /* The EFI loaded_image interface for the image executed via "bootefi" */ 63b9939336SAlexander Graf static struct efi_loaded_image loaded_image_info = { 64c07ad7c0SAlexander Graf .device_handle = bootefi_device_path, 650f4060ebSAlexander Graf .file_path = bootefi_image_path, 66b9939336SAlexander Graf }; 67b9939336SAlexander Graf 68b9939336SAlexander Graf /* The EFI object struct for the image executed via "bootefi" */ 69b9939336SAlexander Graf static struct efi_object loaded_image_info_obj = { 70b9939336SAlexander Graf .handle = &loaded_image_info, 71b9939336SAlexander Graf .protocols = { 72b9939336SAlexander Graf { 73b9939336SAlexander Graf /* 74b9939336SAlexander Graf * When asking for the loaded_image interface, just 75b9939336SAlexander Graf * return handle which points to loaded_image_info 76b9939336SAlexander Graf */ 77b9939336SAlexander Graf .guid = &efi_guid_loaded_image, 78b9939336SAlexander Graf .open = &efi_return_handle, 79b9939336SAlexander Graf }, 80b9939336SAlexander Graf { 81b9939336SAlexander Graf /* 82b9939336SAlexander Graf * When asking for the device path interface, return 83c07ad7c0SAlexander Graf * bootefi_device_path 84b9939336SAlexander Graf */ 85b9939336SAlexander Graf .guid = &efi_guid_device_path, 86b9939336SAlexander Graf .open = &bootefi_open_dp, 87b9939336SAlexander Graf }, 88b9939336SAlexander Graf }, 89b9939336SAlexander Graf }; 90b9939336SAlexander Graf 91b9939336SAlexander Graf /* The EFI object struct for the device the "bootefi" image was loaded from */ 92b9939336SAlexander Graf static struct efi_object bootefi_device_obj = { 93c07ad7c0SAlexander Graf .handle = bootefi_device_path, 94b9939336SAlexander Graf .protocols = { 95b9939336SAlexander Graf { 96b9939336SAlexander Graf /* When asking for the device path interface, return 97c07ad7c0SAlexander Graf * bootefi_device_path */ 98b9939336SAlexander Graf .guid = &efi_guid_device_path, 99b9939336SAlexander Graf .open = &bootefi_open_dp, 100b9939336SAlexander Graf } 101b9939336SAlexander Graf }, 102b9939336SAlexander Graf }; 103b9939336SAlexander Graf 1040d9d501fSAlexander Graf static void *copy_fdt(void *fdt) 1050d9d501fSAlexander Graf { 1060d9d501fSAlexander Graf u64 fdt_size = fdt_totalsize(fdt); 107ad0c1a3dSAlexander Graf unsigned long fdt_ram_start = -1L, fdt_pages; 108ad0c1a3dSAlexander Graf u64 new_fdt_addr; 1090d9d501fSAlexander Graf void *new_fdt; 110ad0c1a3dSAlexander Graf int i; 1110d9d501fSAlexander Graf 112ad0c1a3dSAlexander Graf for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 113ad0c1a3dSAlexander Graf u64 ram_start = gd->bd->bi_dram[i].start; 114ad0c1a3dSAlexander Graf u64 ram_size = gd->bd->bi_dram[i].size; 1150d9d501fSAlexander Graf 116ad0c1a3dSAlexander Graf if (!ram_size) 117ad0c1a3dSAlexander Graf continue; 118ad0c1a3dSAlexander Graf 119ad0c1a3dSAlexander Graf if (ram_start < fdt_ram_start) 120ad0c1a3dSAlexander Graf fdt_ram_start = ram_start; 121ad0c1a3dSAlexander Graf } 122ad0c1a3dSAlexander Graf 123ad0c1a3dSAlexander Graf /* Give us at least 4kb breathing room */ 124ad0c1a3dSAlexander Graf fdt_size = ALIGN(fdt_size + 4096, 4096); 125ad0c1a3dSAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 126ad0c1a3dSAlexander Graf 127ad0c1a3dSAlexander Graf /* Safe fdt location is at 128MB */ 128ad0c1a3dSAlexander Graf new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size; 129ad0c1a3dSAlexander Graf if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages, 130ad0c1a3dSAlexander Graf &new_fdt_addr) != EFI_SUCCESS) { 131ad0c1a3dSAlexander Graf /* If we can't put it there, put it somewhere */ 132ad0c1a3dSAlexander Graf new_fdt_addr = (ulong)memalign(4096, fdt_size); 133ad0c1a3dSAlexander Graf } 134ad0c1a3dSAlexander Graf new_fdt = (void*)(ulong)new_fdt_addr; 1350d9d501fSAlexander Graf memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 1360d9d501fSAlexander Graf fdt_set_totalsize(new_fdt, fdt_size); 1370d9d501fSAlexander Graf 1380d9d501fSAlexander Graf return new_fdt; 1390d9d501fSAlexander Graf } 1400d9d501fSAlexander Graf 141b9939336SAlexander Graf /* 142b9939336SAlexander Graf * Load an EFI payload into a newly allocated piece of memory, register all 143b9939336SAlexander Graf * EFI objects it would want to access and jump to it. 144b9939336SAlexander Graf */ 1451c39809bSAlexander Graf static unsigned long do_bootefi_exec(void *efi, void *fdt) 146b9939336SAlexander Graf { 147b9939336SAlexander Graf ulong (*entry)(void *image_handle, struct efi_system_table *st); 148b9939336SAlexander Graf ulong fdt_pages, fdt_size, fdt_start, fdt_end; 149dea2174dSAlexander Graf bootm_headers_t img = { 0 }; 150b9939336SAlexander Graf 151b9939336SAlexander Graf /* 152b9939336SAlexander Graf * gd lives in a fixed register which may get clobbered while we execute 153b9939336SAlexander Graf * the payload. So save it here and restore it on every callback entry 154b9939336SAlexander Graf */ 155b9939336SAlexander Graf efi_save_gd(); 156b9939336SAlexander Graf 1571c39809bSAlexander Graf if (fdt && !fdt_check_header(fdt)) { 158dea2174dSAlexander Graf /* Prepare fdt for payload */ 1590d9d501fSAlexander Graf fdt = copy_fdt(fdt); 1600d9d501fSAlexander Graf 1610d9d501fSAlexander Graf if (image_setup_libfdt(&img, fdt, 0, NULL)) { 162dea2174dSAlexander Graf printf("ERROR: Failed to process device tree\n"); 163dea2174dSAlexander Graf return -EINVAL; 164dea2174dSAlexander Graf } 165dea2174dSAlexander Graf 166dea2174dSAlexander Graf /* Link to it in the efi tables */ 167b9939336SAlexander Graf systab.tables[0].guid = EFI_FDT_GUID; 1680d9d501fSAlexander Graf systab.tables[0].table = fdt; 169b9939336SAlexander Graf systab.nr_tables = 1; 170b9939336SAlexander Graf 171b9939336SAlexander Graf /* And reserve the space in the memory map */ 1720d9d501fSAlexander Graf fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK; 1730d9d501fSAlexander Graf fdt_end = ((ulong)fdt) + fdt_totalsize(fdt); 174b9939336SAlexander Graf fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK; 175b9939336SAlexander Graf fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 176b9939336SAlexander Graf /* Give a bootloader the chance to modify the device tree */ 177b9939336SAlexander Graf fdt_pages += 2; 178b9939336SAlexander Graf efi_add_memory_map(fdt_start, fdt_pages, 179b9939336SAlexander Graf EFI_BOOT_SERVICES_DATA, true); 180b9939336SAlexander Graf } else { 1811c39809bSAlexander Graf printf("WARNING: Invalid device tree, expect boot to fail\n"); 182b9939336SAlexander Graf systab.nr_tables = 0; 183b9939336SAlexander Graf } 184b9939336SAlexander Graf 185b9939336SAlexander Graf /* Load the EFI payload */ 186b9939336SAlexander Graf entry = efi_load_pe(efi, &loaded_image_info); 187b9939336SAlexander Graf if (!entry) 188b9939336SAlexander Graf return -ENOENT; 189b9939336SAlexander Graf 190b9939336SAlexander Graf /* Initialize and populate EFI object list */ 191b9939336SAlexander Graf INIT_LIST_HEAD(&efi_obj_list); 192b9939336SAlexander Graf list_add_tail(&loaded_image_info_obj.link, &efi_obj_list); 193b9939336SAlexander Graf list_add_tail(&bootefi_device_obj.link, &efi_obj_list); 194b9939336SAlexander Graf #ifdef CONFIG_PARTITIONS 195b9939336SAlexander Graf efi_disk_register(); 196b9939336SAlexander Graf #endif 197be8d3241SAlexander Graf #ifdef CONFIG_LCD 198be8d3241SAlexander Graf efi_gop_register(); 199be8d3241SAlexander Graf #endif 2000efe1bcfSAlexander Graf #ifdef CONFIG_NET 2010efe1bcfSAlexander Graf void *nethandle = loaded_image_info.device_handle; 2020efe1bcfSAlexander Graf efi_net_register(&nethandle); 2030efe1bcfSAlexander Graf 2040efe1bcfSAlexander Graf if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6)) 2050efe1bcfSAlexander Graf loaded_image_info.device_handle = nethandle; 2060efe1bcfSAlexander Graf #endif 207b9939336SAlexander Graf 208b9939336SAlexander Graf /* Call our payload! */ 209edcef3baSAlexander Graf debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 210a86aeaf2SAlexander Graf 211a86aeaf2SAlexander Graf if (setjmp(&loaded_image_info.exit_jmp)) { 212a86aeaf2SAlexander Graf efi_status_t status = loaded_image_info.exit_status; 213a86aeaf2SAlexander Graf return status == EFI_SUCCESS ? 0 : -EINVAL; 214a86aeaf2SAlexander Graf } 215a86aeaf2SAlexander Graf 216b9939336SAlexander Graf return entry(&loaded_image_info, &systab); 217b9939336SAlexander Graf } 218b9939336SAlexander Graf 219b9939336SAlexander Graf 220b9939336SAlexander Graf /* Interpreter command to boot an arbitrary EFI image from memory */ 221b9939336SAlexander Graf static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 222b9939336SAlexander Graf { 2231c39809bSAlexander Graf char *saddr, *sfdt; 2241c39809bSAlexander Graf unsigned long addr, fdt_addr = 0; 225b9939336SAlexander Graf int r = 0; 226b9939336SAlexander Graf 227b9939336SAlexander Graf if (argc < 2) 228b9939336SAlexander Graf return 1; 229b9939336SAlexander Graf saddr = argv[1]; 230b9939336SAlexander Graf 231b9939336SAlexander Graf addr = simple_strtoul(saddr, NULL, 16); 232b9939336SAlexander Graf 2331c39809bSAlexander Graf if (argc > 2) { 2341c39809bSAlexander Graf sfdt = argv[2]; 2351c39809bSAlexander Graf fdt_addr = simple_strtoul(sfdt, NULL, 16); 2361c39809bSAlexander Graf } 2371c39809bSAlexander Graf 238b9939336SAlexander Graf printf("## Starting EFI application at 0x%08lx ...\n", addr); 2391c39809bSAlexander Graf r = do_bootefi_exec((void *)addr, (void*)fdt_addr); 240b9939336SAlexander Graf printf("## Application terminated, r = %d\n", r); 241b9939336SAlexander Graf 242b9939336SAlexander Graf if (r != 0) 243b9939336SAlexander Graf r = 1; 244b9939336SAlexander Graf 245b9939336SAlexander Graf return r; 246b9939336SAlexander Graf } 247b9939336SAlexander Graf 248b9939336SAlexander Graf #ifdef CONFIG_SYS_LONGHELP 249b9939336SAlexander Graf static char bootefi_help_text[] = 2501c39809bSAlexander Graf "<image address> [fdt address]\n" 2511c39809bSAlexander Graf " - boot EFI payload stored at address <image address>.\n" 2521c39809bSAlexander Graf " If specified, the device tree located at <fdt address> gets\n" 2531c39809bSAlexander Graf " exposed as EFI configuration table.\n"; 254b9939336SAlexander Graf #endif 255b9939336SAlexander Graf 256b9939336SAlexander Graf U_BOOT_CMD( 2571c39809bSAlexander Graf bootefi, 3, 0, do_bootefi, 258*92dfd922SSergey Kubushyn "Boots an EFI payload from memory", 259b9939336SAlexander Graf bootefi_help_text 260b9939336SAlexander Graf ); 2610f4060ebSAlexander Graf 262c07ad7c0SAlexander Graf void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 2630f4060ebSAlexander Graf { 2648c3df0bfSAlexander Graf __maybe_unused struct blk_desc *desc; 265ecbe1a07SAlexander Graf char devname[32] = { 0 }; /* dp->str is u16[32] long */ 2660f4060ebSAlexander Graf char *colon; 2670f4060ebSAlexander Graf 2680f4060ebSAlexander Graf /* Assemble the condensed device name we use in efi_disk.c */ 2690f4060ebSAlexander Graf snprintf(devname, sizeof(devname), "%s%s", dev, devnr); 2700f4060ebSAlexander Graf colon = strchr(devname, ':'); 2718c3df0bfSAlexander Graf 2728c3df0bfSAlexander Graf #ifdef CONFIG_ISO_PARTITION 2738c3df0bfSAlexander Graf /* For ISOs we create partition block devices */ 2748c3df0bfSAlexander Graf desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10)); 2758c3df0bfSAlexander Graf if (desc && (desc->type != DEV_TYPE_UNKNOWN) && 2768c3df0bfSAlexander Graf (desc->part_type == PART_TYPE_ISO)) { 2778c3df0bfSAlexander Graf if (!colon) 2788c3df0bfSAlexander Graf snprintf(devname, sizeof(devname), "%s%s:1", dev, 2798c3df0bfSAlexander Graf devnr); 2808c3df0bfSAlexander Graf colon = NULL; 2818c3df0bfSAlexander Graf } 2828c3df0bfSAlexander Graf #endif 2838c3df0bfSAlexander Graf 2840f4060ebSAlexander Graf if (colon) 2850f4060ebSAlexander Graf *colon = '\0'; 2860f4060ebSAlexander Graf 287c07ad7c0SAlexander Graf /* Patch bootefi_device_path to the target device */ 288c07ad7c0SAlexander Graf memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str)); 289c07ad7c0SAlexander Graf ascii2unicode(bootefi_device_path[0].str, devname); 290c07ad7c0SAlexander Graf 291c07ad7c0SAlexander Graf /* Patch bootefi_image_path to the target file path */ 2920f4060ebSAlexander Graf memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str)); 293c07ad7c0SAlexander Graf snprintf(devname, sizeof(devname), "%s", path); 2940f4060ebSAlexander Graf ascii2unicode(bootefi_image_path[0].str, devname); 2950f4060ebSAlexander Graf } 296