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 <dm.h> 12 #include <efi_loader.h> 13 #include <errno.h> 14 #include <libfdt.h> 15 #include <libfdt_env.h> 16 #include <memalign.h> 17 #include <asm/global_data.h> 18 #include <asm-generic/sections.h> 19 #include <linux/linkage.h> 20 21 DECLARE_GLOBAL_DATA_PTR; 22 23 /* 24 * When booting using the "bootefi" command, we don't know which 25 * physical device the file came from. So we create a pseudo-device 26 * called "bootefi" with the device path /bootefi. 27 * 28 * In addition to the originating device we also declare the file path 29 * of "bootefi" based loads to be /bootefi. 30 */ 31 static struct efi_device_path_file_path bootefi_image_path[] = { 32 { 33 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 34 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 35 .dp.length = sizeof(bootefi_image_path[0]), 36 .str = { 'b','o','o','t','e','f','i' }, 37 }, { 38 .dp.type = DEVICE_PATH_TYPE_END, 39 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 40 .dp.length = sizeof(bootefi_image_path[0]), 41 } 42 }; 43 44 static struct efi_device_path_file_path bootefi_device_path[] = { 45 { 46 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, 47 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, 48 .dp.length = sizeof(bootefi_image_path[0]), 49 .str = { 'b','o','o','t','e','f','i' }, 50 }, { 51 .dp.type = DEVICE_PATH_TYPE_END, 52 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, 53 .dp.length = sizeof(bootefi_image_path[0]), 54 } 55 }; 56 57 /* The EFI loaded_image interface for the image executed via "bootefi" */ 58 static struct efi_loaded_image loaded_image_info = { 59 .device_handle = bootefi_device_path, 60 .file_path = bootefi_image_path, 61 }; 62 63 /* The EFI object struct for the image executed via "bootefi" */ 64 static struct efi_object loaded_image_info_obj = { 65 .handle = &loaded_image_info, 66 .protocols = { 67 { 68 /* 69 * When asking for the loaded_image interface, just 70 * return handle which points to loaded_image_info 71 */ 72 .guid = &efi_guid_loaded_image, 73 .protocol_interface = &loaded_image_info, 74 }, 75 { 76 /* 77 * When asking for the device path interface, return 78 * bootefi_device_path 79 */ 80 .guid = &efi_guid_device_path, 81 .protocol_interface = bootefi_device_path, 82 }, 83 { 84 .guid = &efi_guid_console_control, 85 .protocol_interface = (void *) &efi_console_control 86 }, 87 { 88 .guid = &efi_guid_device_path_to_text_protocol, 89 .protocol_interface = (void *) &efi_device_path_to_text 90 }, 91 }, 92 }; 93 94 /* The EFI object struct for the device the "bootefi" image was loaded from */ 95 static struct efi_object bootefi_device_obj = { 96 .handle = bootefi_device_path, 97 .protocols = { 98 { 99 /* When asking for the device path interface, return 100 * bootefi_device_path */ 101 .guid = &efi_guid_device_path, 102 .protocol_interface = bootefi_device_path 103 } 104 }, 105 }; 106 107 static void *copy_fdt(void *fdt) 108 { 109 u64 fdt_size = fdt_totalsize(fdt); 110 unsigned long fdt_ram_start = -1L, fdt_pages; 111 u64 new_fdt_addr; 112 void *new_fdt; 113 int i; 114 115 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { 116 u64 ram_start = gd->bd->bi_dram[i].start; 117 u64 ram_size = gd->bd->bi_dram[i].size; 118 119 if (!ram_size) 120 continue; 121 122 if (ram_start < fdt_ram_start) 123 fdt_ram_start = ram_start; 124 } 125 126 /* Give us at least 4kb breathing room */ 127 fdt_size = ALIGN(fdt_size + 4096, 4096); 128 fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 129 130 /* Safe fdt location is at 128MB */ 131 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size; 132 if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages, 133 &new_fdt_addr) != EFI_SUCCESS) { 134 /* If we can't put it there, put it somewhere */ 135 new_fdt_addr = (ulong)memalign(4096, fdt_size); 136 if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages, 137 &new_fdt_addr) != EFI_SUCCESS) { 138 printf("ERROR: Failed to reserve space for FDT\n"); 139 return NULL; 140 } 141 } 142 143 new_fdt = (void*)(ulong)new_fdt_addr; 144 memcpy(new_fdt, fdt, fdt_totalsize(fdt)); 145 fdt_set_totalsize(new_fdt, fdt_size); 146 147 return new_fdt; 148 } 149 150 static ulong efi_do_enter(void *image_handle, 151 struct efi_system_table *st, 152 asmlinkage ulong (*entry)(void *image_handle, 153 struct efi_system_table *st)) 154 { 155 efi_status_t ret = EFI_LOAD_ERROR; 156 157 if (entry) 158 ret = entry(image_handle, st); 159 st->boottime->exit(image_handle, ret, 0, NULL); 160 return ret; 161 } 162 163 #ifdef CONFIG_ARM64 164 static unsigned long efi_run_in_el2(asmlinkage ulong (*entry)( 165 void *image_handle, struct efi_system_table *st), 166 void *image_handle, struct efi_system_table *st) 167 { 168 /* Enable caches again */ 169 dcache_enable(); 170 171 return efi_do_enter(image_handle, st, entry); 172 } 173 #endif 174 175 /* 176 * Load an EFI payload into a newly allocated piece of memory, register all 177 * EFI objects it would want to access and jump to it. 178 */ 179 static unsigned long do_bootefi_exec(void *efi, void *fdt) 180 { 181 ulong (*entry)(void *image_handle, struct efi_system_table *st) 182 asmlinkage; 183 ulong fdt_pages, fdt_size, fdt_start, fdt_end; 184 bootm_headers_t img = { 0 }; 185 186 /* 187 * gd lives in a fixed register which may get clobbered while we execute 188 * the payload. So save it here and restore it on every callback entry 189 */ 190 efi_save_gd(); 191 192 if (fdt && !fdt_check_header(fdt)) { 193 /* Prepare fdt for payload */ 194 fdt = copy_fdt(fdt); 195 196 if (image_setup_libfdt(&img, fdt, 0, NULL)) { 197 printf("ERROR: Failed to process device tree\n"); 198 return -EINVAL; 199 } 200 201 /* Link to it in the efi tables */ 202 systab.tables[0].guid = EFI_FDT_GUID; 203 systab.tables[0].table = fdt; 204 systab.nr_tables = 1; 205 206 /* And reserve the space in the memory map */ 207 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK; 208 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt); 209 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK; 210 fdt_pages = fdt_size >> EFI_PAGE_SHIFT; 211 /* Give a bootloader the chance to modify the device tree */ 212 fdt_pages += 2; 213 efi_add_memory_map(fdt_start, fdt_pages, 214 EFI_BOOT_SERVICES_DATA, true); 215 } else { 216 printf("WARNING: Invalid device tree, expect boot to fail\n"); 217 systab.nr_tables = 0; 218 } 219 220 /* Load the EFI payload */ 221 entry = efi_load_pe(efi, &loaded_image_info); 222 if (!entry) 223 return -ENOENT; 224 225 /* Initialize and populate EFI object list */ 226 INIT_LIST_HEAD(&efi_obj_list); 227 list_add_tail(&loaded_image_info_obj.link, &efi_obj_list); 228 list_add_tail(&bootefi_device_obj.link, &efi_obj_list); 229 efi_console_register(); 230 #ifdef CONFIG_PARTITIONS 231 efi_disk_register(); 232 #endif 233 #ifdef CONFIG_LCD 234 efi_gop_register(); 235 #endif 236 #ifdef CONFIG_NET 237 void *nethandle = loaded_image_info.device_handle; 238 efi_net_register(&nethandle); 239 240 if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6)) 241 loaded_image_info.device_handle = nethandle; 242 else 243 loaded_image_info.device_handle = bootefi_device_path; 244 #endif 245 #ifdef CONFIG_GENERATE_SMBIOS_TABLE 246 efi_smbios_register(); 247 #endif 248 249 /* Initialize EFI runtime services */ 250 efi_reset_system_init(); 251 efi_get_time_init(); 252 253 /* Call our payload! */ 254 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); 255 256 if (setjmp(&loaded_image_info.exit_jmp)) { 257 return loaded_image_info.exit_status; 258 } 259 260 #ifdef CONFIG_ARM64 261 /* On AArch64 we need to make sure we call our payload in < EL3 */ 262 if (current_el() == 3) { 263 smp_kick_all_cpus(); 264 dcache_disable(); /* flush cache before switch to EL2 */ 265 266 /* Move into EL2 and keep running there */ 267 armv8_switch_to_el2((ulong)entry, (ulong)&loaded_image_info, 268 (ulong)&systab, 0, (ulong)efi_run_in_el2, 269 ES_TO_AARCH64); 270 271 /* Should never reach here, efi exits with longjmp */ 272 while (1) { } 273 } 274 #endif 275 276 return efi_do_enter(&loaded_image_info, &systab, entry); 277 } 278 279 280 /* Interpreter command to boot an arbitrary EFI image from memory */ 281 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 282 { 283 char *saddr, *sfdt; 284 unsigned long addr, fdt_addr = 0; 285 unsigned long r; 286 287 if (argc < 2) 288 return CMD_RET_USAGE; 289 #ifdef CONFIG_CMD_BOOTEFI_HELLO 290 if (!strcmp(argv[1], "hello")) { 291 ulong size = __efi_hello_world_end - __efi_hello_world_begin; 292 293 addr = CONFIG_SYS_LOAD_ADDR; 294 memcpy((char *)addr, __efi_hello_world_begin, size); 295 } else 296 #endif 297 { 298 saddr = argv[1]; 299 300 addr = simple_strtoul(saddr, NULL, 16); 301 302 if (argc > 2) { 303 sfdt = argv[2]; 304 fdt_addr = simple_strtoul(sfdt, NULL, 16); 305 } 306 } 307 308 printf("## Starting EFI application at %08lx ...\n", addr); 309 r = do_bootefi_exec((void *)addr, (void*)fdt_addr); 310 printf("## Application terminated, r = %lu\n", 311 r & ~EFI_ERROR_MASK); 312 313 if (r != EFI_SUCCESS) 314 return 1; 315 else 316 return 0; 317 } 318 319 #ifdef CONFIG_SYS_LONGHELP 320 static char bootefi_help_text[] = 321 "<image address> [fdt address]\n" 322 " - boot EFI payload stored at address <image address>.\n" 323 " If specified, the device tree located at <fdt address> gets\n" 324 " exposed as EFI configuration table.\n" 325 #ifdef CONFIG_CMD_BOOTEFI_HELLO 326 "hello\n" 327 " - boot a sample Hello World application stored within U-Boot" 328 #endif 329 ; 330 #endif 331 332 U_BOOT_CMD( 333 bootefi, 3, 0, do_bootefi, 334 "Boots an EFI payload from memory", 335 bootefi_help_text 336 ); 337 338 void efi_set_bootdev(const char *dev, const char *devnr, const char *path) 339 { 340 __maybe_unused struct blk_desc *desc; 341 char devname[32] = { 0 }; /* dp->str is u16[32] long */ 342 char *colon, *s; 343 344 #if defined(CONFIG_BLK) || CONFIG_IS_ENABLED(ISO_PARTITION) 345 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10)); 346 #endif 347 348 #ifdef CONFIG_BLK 349 if (desc) { 350 snprintf(devname, sizeof(devname), "%s", desc->bdev->name); 351 } else 352 #endif 353 354 { 355 /* Assemble the condensed device name we use in efi_disk.c */ 356 snprintf(devname, sizeof(devname), "%s%s", dev, devnr); 357 } 358 359 colon = strchr(devname, ':'); 360 361 #if CONFIG_IS_ENABLED(ISO_PARTITION) 362 /* For ISOs we create partition block devices */ 363 if (desc && (desc->type != DEV_TYPE_UNKNOWN) && 364 (desc->part_type == PART_TYPE_ISO)) { 365 if (!colon) 366 snprintf(devname, sizeof(devname), "%s:1", devname); 367 368 colon = NULL; 369 } 370 #endif 371 372 if (colon) 373 *colon = '\0'; 374 375 /* Patch bootefi_device_path to the target device */ 376 memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str)); 377 ascii2unicode(bootefi_device_path[0].str, devname); 378 379 /* Patch bootefi_image_path to the target file path */ 380 memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str)); 381 if (strcmp(dev, "Net")) { 382 /* Add leading / to fs paths, because they're absolute */ 383 snprintf(devname, sizeof(devname), "/%s", path); 384 } else { 385 snprintf(devname, sizeof(devname), "%s", path); 386 } 387 /* DOS style file path: */ 388 s = devname; 389 while ((s = strchr(s, '/'))) 390 *s++ = '\\'; 391 ascii2unicode(bootefi_image_path[0].str, devname); 392 } 393