1 /* 2 * EFI application loader 3 * 4 * Copyright (c) 2016 Alexander Graf 5 * 6 * SPDX-License-Identifier: GPL-2.0+ 7 */ 8 9 #include <common.h> 10 #include <command.h> 11 #include <efi_loader.h> 12 #include <errno.h> 13 #include <libfdt.h> 14 #include <libfdt_env.h> 15 #include <memalign.h> 16 #include <asm/global_data.h> 17 18 DECLARE_GLOBAL_DATA_PTR; 19 20 /* 21 * When booting using the "bootefi" command, we don't know which 22 * physical device the file came from. So we create a pseudo-device 23 * called "bootefi" with the device path /bootefi. 24 * 25 * In addition to the originating device we also declare the file path 26 * of "bootefi" based loads to be /bootefi. 27 */ 28 static struct efi_device_path_file_path bootefi_image_path[] = { 29 { 30 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 31 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 32 .dp.length = sizeof(bootefi_image_path[0]), 33 .str = { 'b','o','o','t','e','f','i' }, 34 }, { 35 .dp.type = DEVICE_PATH_TYPE_END, 36 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 37 .dp.length = sizeof(bootefi_image_path[0]), 38 } 39 }; 40 41 static struct efi_device_path_file_path bootefi_device_path[] = { 42 { 43 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 44 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 45 .dp.length = sizeof(bootefi_image_path[0]), 46 .str = { 'b','o','o','t','e','f','i' }, 47 }, { 48 .dp.type = DEVICE_PATH_TYPE_END, 49 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 50 .dp.length = sizeof(bootefi_image_path[0]), 51 } 52 }; 53 54 static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol, 55 void **protocol_interface, void *agent_handle, 56 void *controller_handle, uint32_t attributes) 57 { 58 *protocol_interface = bootefi_device_path; 59 return EFI_SUCCESS; 60 } 61 62 /* The EFI loaded_image interface for the image executed via "bootefi" */ 63 static struct efi_loaded_image loaded_image_info = { 64 .device_handle = bootefi_device_path, 65 .file_path = bootefi_image_path, 66 }; 67 68 /* The EFI object struct for the image executed via "bootefi" */ 69 static struct efi_object loaded_image_info_obj = { 70 .handle = &loaded_image_info, 71 .protocols = { 72 { 73 /* 74 * When asking for the loaded_image interface, just 75 * return handle which points to loaded_image_info 76 */ 77 .guid = &efi_guid_loaded_image, 78 .open = &efi_return_handle, 79 }, 80 { 81 /* 82 * When asking for the device path interface, return 83 * bootefi_device_path 84 */ 85 .guid = &efi_guid_device_path, 86 .open = &bootefi_open_dp, 87 }, 88 }, 89 }; 90 91 /* The EFI object struct for the device the "bootefi" image was loaded from */ 92 static struct efi_object bootefi_device_obj = { 93 .handle = bootefi_device_path, 94 .protocols = { 95 { 96 /* When asking for the device path interface, return 97 * bootefi_device_path */ 98 .guid = &efi_guid_device_path, 99 .open = &bootefi_open_dp, 100 } 101 }, 102 }; 103 104 static void *copy_fdt(void *fdt) 105 { 106 u64 fdt_size = fdt_totalsize(fdt); 107 unsigned long fdt_ram_start = -1L, fdt_pages; 108 u64 new_fdt_addr; 109 void *new_fdt; 110 int i; 111 112 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 113 u64 ram_start = gd->bd->bi_dram[i].start; 114 u64 ram_size = gd->bd->bi_dram[i].size; 115 116 if (!ram_size) 117 continue; 118 119 if (ram_start < fdt_ram_start) 120 fdt_ram_start = ram_start; 121 } 122 123 /* Give us at least 4kb breathing room */ 124 fdt_size = ALIGN(fdt_size + 4096, 4096); 125 fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 126 127 /* Safe fdt location is at 128MB */ 128 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size; 129 if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages, 130 &new_fdt_addr) != EFI_SUCCESS) { 131 /* If we can't put it there, put it somewhere */ 132 new_fdt_addr = (ulong)memalign(4096, fdt_size); 133 } 134 new_fdt = (void*)(ulong)new_fdt_addr; 135 memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 136 fdt_set_totalsize(new_fdt, fdt_size); 137 138 return new_fdt; 139 } 140 141 /* 142 * Load an EFI payload into a newly allocated piece of memory, register all 143 * EFI objects it would want to access and jump to it. 144 */ 145 static unsigned long do_bootefi_exec(void *efi) 146 { 147 ulong (*entry)(void *image_handle, struct efi_system_table *st); 148 ulong fdt_pages, fdt_size, fdt_start, fdt_end; 149 bootm_headers_t img = { 0 }; 150 void *fdt = working_fdt; 151 152 /* 153 * gd lives in a fixed register which may get clobbered while we execute 154 * the payload. So save it here and restore it on every callback entry 155 */ 156 efi_save_gd(); 157 158 /* Update system table to point to our currently loaded FDT */ 159 160 /* Fall back to included fdt if none was manually loaded */ 161 if (!fdt && gd->fdt_blob) 162 fdt = (void *)gd->fdt_blob; 163 164 if (fdt) { 165 /* Prepare fdt for payload */ 166 fdt = copy_fdt(fdt); 167 168 if (image_setup_libfdt(&img, fdt, 0, NULL)) { 169 printf("ERROR: Failed to process device tree\n"); 170 return -EINVAL; 171 } 172 173 /* Link to it in the efi tables */ 174 systab.tables[0].guid = EFI_FDT_GUID; 175 systab.tables[0].table = fdt; 176 systab.nr_tables = 1; 177 178 /* And reserve the space in the memory map */ 179 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK; 180 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt); 181 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK; 182 fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 183 /* Give a bootloader the chance to modify the device tree */ 184 fdt_pages += 2; 185 efi_add_memory_map(fdt_start, fdt_pages, 186 EFI_BOOT_SERVICES_DATA, true); 187 } else { 188 printf("WARNING: No device tree loaded, expect boot to fail\n"); 189 systab.nr_tables = 0; 190 } 191 192 /* Load the EFI payload */ 193 entry = efi_load_pe(efi, &loaded_image_info); 194 if (!entry) 195 return -ENOENT; 196 197 /* Initialize and populate EFI object list */ 198 INIT_LIST_HEAD(&efi_obj_list); 199 list_add_tail(&loaded_image_info_obj.link, &efi_obj_list); 200 list_add_tail(&bootefi_device_obj.link, &efi_obj_list); 201 #ifdef CONFIG_PARTITIONS 202 efi_disk_register(); 203 #endif 204 #ifdef CONFIG_LCD 205 efi_gop_register(); 206 #endif 207 208 /* Call our payload! */ 209 #ifdef DEBUG_EFI 210 printf("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 211 #endif 212 return entry(&loaded_image_info, &systab); 213 } 214 215 216 /* Interpreter command to boot an arbitrary EFI image from memory */ 217 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 218 { 219 char *saddr; 220 unsigned long addr; 221 int r = 0; 222 223 if (argc < 2) 224 return 1; 225 saddr = argv[1]; 226 227 addr = simple_strtoul(saddr, NULL, 16); 228 229 printf("## Starting EFI application at 0x%08lx ...\n", addr); 230 r = do_bootefi_exec((void *)addr); 231 printf("## Application terminated, r = %d\n", r); 232 233 if (r != 0) 234 r = 1; 235 236 return r; 237 } 238 239 #ifdef CONFIG_SYS_LONGHELP 240 static char bootefi_help_text[] = 241 "<image address>\n" 242 " - boot EFI payload stored at address <image address>\n" 243 "\n" 244 "Since most EFI payloads want to have a device tree provided, please\n" 245 "make sure you load a device tree using the fdt addr command before\n" 246 "executing bootefi.\n"; 247 #endif 248 249 U_BOOT_CMD( 250 bootefi, 2, 0, do_bootefi, 251 "Boots an EFI payload from memory\n", 252 bootefi_help_text 253 ); 254 255 void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 256 { 257 __maybe_unused struct blk_desc *desc; 258 char devname[32] = { 0 }; /* dp->str is u16[32] long */ 259 char *colon; 260 261 /* Assemble the condensed device name we use in efi_disk.c */ 262 snprintf(devname, sizeof(devname), "%s%s", dev, devnr); 263 colon = strchr(devname, ':'); 264 265 #ifdef CONFIG_ISO_PARTITION 266 /* For ISOs we create partition block devices */ 267 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10)); 268 if (desc && (desc->type != DEV_TYPE_UNKNOWN) && 269 (desc->part_type == PART_TYPE_ISO)) { 270 if (!colon) 271 snprintf(devname, sizeof(devname), "%s%s:1", dev, 272 devnr); 273 colon = NULL; 274 } 275 #endif 276 277 if (colon) 278 *colon = '\0'; 279 280 /* Patch bootefi_device_path to the target device */ 281 memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str)); 282 ascii2unicode(bootefi_device_path[0].str, devname); 283 284 /* Patch bootefi_image_path to the target file path */ 285 memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str)); 286 snprintf(devname, sizeof(devname), "%s", path); 287 ascii2unicode(bootefi_image_path[0].str, devname); 288 } 289