1 /* 2 * Copyright (C) 2016 Google, Inc 3 * Written by Simon Glass <sjg@chromium.org> 4 * 5 * SPDX-License-Identifier: GPL-2.0+ 6 */ 7 8 #include <common.h> 9 #include <errno.h> 10 #include <image.h> 11 #include <linux/libfdt.h> 12 #include <spl.h> 13 #include <malloc.h> 14 #include <optee_include/OpteeClientInterface.h> 15 16 #ifndef CONFIG_SYS_BOOTM_LEN 17 #define CONFIG_SYS_BOOTM_LEN (64 << 20) 18 #endif 19 20 /** 21 * spl_fit_get_image_name(): By using the matching configuration subnode, 22 * retrieve the name of an image, specified by a property name and an index 23 * into that. 24 * @fit: Pointer to the FDT blob. 25 * @images: Offset of the /images subnode. 26 * @type: Name of the property within the configuration subnode. 27 * @index: Index into the list of strings in this property. 28 * @outname: Name of the image 29 * 30 * Return: 0 on success, or a negative error number 31 */ 32 static int spl_fit_get_image_name(const void *fit, int images, 33 const char *type, int index, 34 char **outname) 35 { 36 const char *name, *str; 37 __maybe_unused int node; 38 int conf_node; 39 int len, i; 40 41 conf_node = fit_find_config_node(fit); 42 if (conf_node < 0) { 43 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 44 printf("No matching DT out of these options:\n"); 45 for (node = fdt_first_subnode(fit, conf_node); 46 node >= 0; 47 node = fdt_next_subnode(fit, node)) { 48 name = fdt_getprop(fit, node, "description", &len); 49 printf(" %s\n", name); 50 } 51 #endif 52 return conf_node; 53 } 54 55 name = fdt_getprop(fit, conf_node, type, &len); 56 if (!name) { 57 debug("cannot find property '%s': %d\n", type, len); 58 return -EINVAL; 59 } 60 61 str = name; 62 for (i = 0; i < index; i++) { 63 str = strchr(str, '\0') + 1; 64 if (!str || (str - name >= len)) { 65 debug("no string for index %d\n", index); 66 return -E2BIG; 67 } 68 } 69 70 *outname = (char *)str; 71 return 0; 72 } 73 74 /** 75 * spl_fit_get_image_node(): By using the matching configuration subnode, 76 * retrieve the name of an image, specified by a property name and an index 77 * into that. 78 * @fit: Pointer to the FDT blob. 79 * @images: Offset of the /images subnode. 80 * @type: Name of the property within the configuration subnode. 81 * @index: Index into the list of strings in this property. 82 * 83 * Return: the node offset of the respective image node or a negative 84 * error number. 85 */ 86 static int spl_fit_get_image_node(const void *fit, int images, 87 const char *type, int index) 88 { 89 char *str; 90 int err; 91 int node; 92 93 err = spl_fit_get_image_name(fit, images, type, index, &str); 94 if (err) 95 return err; 96 97 debug("%s: '%s'\n", type, str); 98 99 node = fdt_subnode_offset(fit, images, str); 100 if (node < 0) { 101 debug("cannot find image node '%s': %d\n", str, node); 102 return -EINVAL; 103 } 104 105 return node; 106 } 107 108 static int get_aligned_image_offset(struct spl_load_info *info, int offset) 109 { 110 /* 111 * If it is a FS read, get the first address before offset which is 112 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the 113 * block number to which offset belongs. 114 */ 115 if (info->filename) 116 return offset & ~(ARCH_DMA_MINALIGN - 1); 117 118 return offset / info->bl_len; 119 } 120 121 static int get_aligned_image_overhead(struct spl_load_info *info, int offset) 122 { 123 /* 124 * If it is a FS read, get the difference between the offset and 125 * the first address before offset which is aligned to 126 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the 127 * block. 128 */ 129 if (info->filename) 130 return offset & (ARCH_DMA_MINALIGN - 1); 131 132 return offset % info->bl_len; 133 } 134 135 static int get_aligned_image_size(struct spl_load_info *info, int data_size, 136 int offset) 137 { 138 data_size = data_size + get_aligned_image_overhead(info, offset); 139 140 if (info->filename) 141 return data_size; 142 143 return (data_size + info->bl_len - 1) / info->bl_len; 144 } 145 146 /** 147 * spl_load_fit_image(): load the image described in a certain FIT node 148 * @info: points to information about the device to load data from 149 * @sector: the start sector of the FIT image on the device 150 * @fit: points to the flattened device tree blob describing the FIT 151 * image 152 * @base_offset: the beginning of the data area containing the actual 153 * image data, relative to the beginning of the FIT 154 * @node: offset of the DT node describing the image to load (relative 155 * to @fit) 156 * @image_info: will be filled with information about the loaded image 157 * If the FIT node does not contain a "load" (address) property, 158 * the image gets loaded to the address pointed to by the 159 * load_addr member in this struct. 160 * 161 * Return: 0 on success or a negative error number. 162 */ 163 static int spl_load_fit_image(struct spl_load_info *info, ulong sector, 164 void *fit, ulong base_offset, int node, 165 struct spl_image_info *image_info) 166 { 167 int offset; 168 size_t length; 169 int len; 170 ulong size; 171 ulong load_addr, load_ptr; 172 void *src; 173 ulong overhead; 174 int nr_sectors; 175 int align_len = ARCH_DMA_MINALIGN - 1; 176 uint8_t image_comp = -1, type = -1; 177 const void *data; 178 bool external_data = false; 179 180 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) { 181 if (fit_image_get_comp(fit, node, &image_comp)) 182 puts("Cannot get image compression format.\n"); 183 else 184 debug("%s ", genimg_get_comp_name(image_comp)); 185 186 if (fit_image_get_type(fit, node, &type)) 187 puts("Cannot get image type.\n"); 188 else 189 debug("%s ", genimg_get_type_name(type)); 190 } 191 192 if (fit_image_get_load(fit, node, &load_addr)) 193 load_addr = image_info->load_addr; 194 195 if (!fit_image_get_data_position(fit, node, &offset)) { 196 external_data = true; 197 } else if (!fit_image_get_data_offset(fit, node, &offset)) { 198 offset += base_offset; 199 external_data = true; 200 } 201 202 if (external_data) { 203 /* External data */ 204 if (fit_image_get_data_size(fit, node, &len)) 205 return -ENOENT; 206 207 load_ptr = (load_addr + align_len) & ~align_len; 208 #if defined(CONFIG_ARCH_ROCKCHIP) 209 if ((load_ptr < CONFIG_SYS_SDRAM_BASE) || 210 (load_ptr >= CONFIG_SYS_SDRAM_BASE + SDRAM_MAX_SIZE)) 211 load_ptr = (ulong)memalign(ARCH_DMA_MINALIGN, len); 212 #endif 213 length = len; 214 215 overhead = get_aligned_image_overhead(info, offset); 216 nr_sectors = get_aligned_image_size(info, length, offset); 217 218 if (info->read(info, 219 sector + get_aligned_image_offset(info, offset), 220 nr_sectors, (void *)load_ptr) != nr_sectors) 221 return -EIO; 222 223 debug("External data: dst=%lx, offset=%x, size=%lx\n", 224 load_ptr, offset, (unsigned long)length); 225 src = (void *)load_ptr + overhead; 226 } else { 227 /* Embedded data */ 228 if (fit_image_get_data(fit, node, &data, &length)) { 229 puts("Cannot get image data/size\n"); 230 return -ENOENT; 231 } 232 debug("Embedded data: dst=%lx, size=%lx\n", load_addr, 233 (unsigned long)length); 234 src = (void *)data; 235 } 236 237 /* Check hashes and signature */ 238 printf("## Checking %s ... ", 239 fit_get_name(fit, node, NULL)); 240 #ifdef CONFIG_FIT_SPL_PRINT 241 printf("\n"); 242 fit_image_print(fit, node, ""); 243 #endif 244 if (!fit_image_verify_with_data(fit, node, 245 src, length)) 246 return -EPERM; 247 puts("OK\n"); 248 249 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS 250 board_fit_image_post_process(&src, &length); 251 #endif 252 253 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && 254 IS_ENABLED(CONFIG_SPL_GZIP) && 255 image_comp == IH_COMP_GZIP && 256 type == IH_TYPE_KERNEL) { 257 size = length; 258 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN, 259 src, &size)) { 260 puts("Uncompressing error\n"); 261 return -EIO; 262 } 263 length = size; 264 } else { 265 memcpy((void *)load_addr, src, length); 266 } 267 268 if (image_info) { 269 image_info->load_addr = load_addr; 270 image_info->size = length; 271 image_info->entry_point = fdt_getprop_u32(fit, node, "entry"); 272 } 273 274 return 0; 275 } 276 277 static int spl_fit_append_fdt(struct spl_image_info *spl_image, 278 struct spl_load_info *info, ulong sector, 279 void *fit, int images, ulong base_offset) 280 { 281 struct spl_image_info image_info; 282 int node, ret; 283 284 /* Figure out which device tree the board wants to use */ 285 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0); 286 if (node < 0) { 287 debug("%s: cannot find FDT node\n", __func__); 288 return node; 289 } 290 291 /* 292 * Read the device tree and place it after the image. 293 * Align the destination address to ARCH_DMA_MINALIGN. 294 */ 295 image_info.load_addr = spl_image->load_addr + spl_image->size; 296 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 297 &image_info); 298 299 if (ret < 0) 300 return ret; 301 302 /* Make the load-address of the FDT available for the SPL framework */ 303 spl_image->fdt_addr = (void *)image_info.load_addr; 304 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 305 /* Try to make space, so we can inject details on the loadables */ 306 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192); 307 #endif 308 309 return ret; 310 } 311 312 static int spl_fit_record_loadable(const void *fit, int images, int index, 313 void *blob, struct spl_image_info *image) 314 { 315 int ret = 0; 316 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 317 char *name; 318 int node; 319 320 ret = spl_fit_get_image_name(fit, images, "loadables", 321 index, &name); 322 if (ret < 0) 323 return ret; 324 325 node = spl_fit_get_image_node(fit, images, "loadables", index); 326 327 ret = fdt_record_loadable(blob, index, name, image->load_addr, 328 image->size, image->entry_point, 329 fdt_getprop(fit, node, "type", NULL), 330 fdt_getprop(fit, node, "os", NULL)); 331 #endif 332 return ret; 333 } 334 335 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os) 336 { 337 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 338 return -ENOTSUPP; 339 #else 340 return fit_image_get_os(fit, noffset, os); 341 #endif 342 } 343 344 __weak int spl_fit_standalone_release(void) 345 { 346 return 0; 347 } 348 349 static int spl_internal_load_simple_fit(struct spl_image_info *spl_image, 350 struct spl_load_info *info, 351 ulong sector, void *fit) 352 { 353 int sectors; 354 ulong size; 355 unsigned long count; 356 struct spl_image_info image_info; 357 int node = -1; 358 int images, ret; 359 int base_offset, align_len = ARCH_DMA_MINALIGN - 1; 360 int index = 0; 361 362 /* 363 * For FIT with external data, figure out where the external images 364 * start. This is the base for the data-offset properties in each 365 * image. 366 */ 367 size = fdt_totalsize(fit); 368 size = FIT_ALIGN(size); 369 base_offset = FIT_ALIGN(size); 370 371 /* 372 * So far we only have one block of data from the FIT. Read the entire 373 * thing, including that first block, placing it so it finishes before 374 * where we will load the image. 375 * 376 * Note that we will load the image such that its first byte will be 377 * at the load address. Since that byte may be part-way through a 378 * block, we may load the image up to one block before the load 379 * address. So take account of that here by subtracting an addition 380 * block length from the FIT start position. 381 * 382 * In fact the FIT has its own load address, but we assume it cannot 383 * be before CONFIG_SYS_TEXT_BASE. 384 * 385 * For FIT with data embedded, data is loaded as part of FIT image. 386 * For FIT with external data, data is not loaded in this step. 387 */ 388 fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len - 389 align_len) & ~align_len); 390 sectors = get_aligned_image_size(info, size, 0); 391 count = info->read(info, sector, sectors, fit); 392 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n", 393 sector, sectors, fit, count); 394 if (count == 0) 395 return -EIO; 396 397 /* find the node holding the images information */ 398 images = fdt_path_offset(fit, FIT_IMAGES_PATH); 399 if (images < 0) { 400 debug("%s: Cannot find /images node: %d\n", __func__, images); 401 return -1; 402 } 403 404 /* if board sigs verify required, check self */ 405 if (fit_board_verify_required_sigs() && 406 !IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) { 407 printf("Verified-boot requires CONFIG_SPL_FIT_SIGNATURE enabled\n"); 408 hang(); 409 } 410 411 /* verify the configure node by keys, if required */ 412 #ifdef CONFIG_SPL_FIT_SIGNATURE 413 int conf_noffset; 414 415 conf_noffset = fit_conf_get_node(fit, NULL); 416 if (conf_noffset > 0) { 417 ret = fit_config_verify(fit, conf_noffset); 418 if (ret) { 419 printf("fit verify configure failed, ret=%d\n", ret); 420 return ret; 421 } 422 printf("\n"); 423 } 424 425 #ifdef CONFIG_SPL_FIT_ROLLBACK_PROTECT 426 uint32_t this_index, min_index; 427 428 ret = fit_rollback_index_verify(fit, FIT_ROLLBACK_INDEX_SPL, 429 &this_index, &min_index); 430 if (ret) { 431 printf("fit failed to get rollback index, ret=%d\n", ret); 432 return ret; 433 } else if (this_index < min_index) { 434 printf("fit reject rollback: %d < %d(min)\n", 435 this_index, min_index); 436 return -EINVAL; 437 } 438 439 spl_image->rollback_index = this_index; 440 printf("rollback index: %d >= %d, OK\n", this_index, min_index); 441 #endif 442 #endif 443 444 /* 445 * If required to start the other core before load "loadables" 446 * firmwares, use the config "standalone" to load the other core's 447 * firmware, then start it. 448 * Normally, different cores' firmware is attach to the config 449 * "loadables" and load them together. 450 */ 451 if (node < 0) 452 node = spl_fit_get_image_node(fit, images, FIT_STANDALONE_PROP, 453 0); 454 if (node > 0) { 455 /* Load the image and set up the spl_image structure */ 456 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 457 spl_image); 458 if (!ret) { 459 ret = spl_fit_standalone_release(); 460 if (ret) 461 printf("Start standalone fail, ret = %d\n", 462 ret); 463 } 464 465 node = -1; 466 } 467 468 /* 469 * Find the U-Boot image using the following search order: 470 * - start at 'firmware' (e.g. an ARM Trusted Firmware) 471 * - fall back 'kernel' (e.g. a Falcon-mode OS boot 472 * - fall back to using the first 'loadables' entry 473 */ 474 if (node < 0) 475 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP, 476 0); 477 #ifdef CONFIG_SPL_OS_BOOT 478 if (node < 0) 479 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0); 480 #endif 481 if (node < 0) { 482 debug("could not find firmware image, trying loadables...\n"); 483 node = spl_fit_get_image_node(fit, images, "loadables", 0); 484 /* 485 * If we pick the U-Boot image from "loadables", start at 486 * the second image when later loading additional images. 487 */ 488 index = 1; 489 } 490 if (node < 0) { 491 debug("%s: Cannot find u-boot image node: %d\n", 492 __func__, node); 493 return -1; 494 } 495 496 /* Load the image and set up the spl_image structure */ 497 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 498 spl_image); 499 if (ret) 500 return ret; 501 502 /* 503 * For backward compatibility, we treat the first node that is 504 * as a U-Boot image, if no OS-type has been declared. 505 */ 506 if (!spl_fit_image_get_os(fit, node, &spl_image->os)) 507 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os)); 508 #if !defined(CONFIG_SPL_OS_BOOT) 509 else 510 spl_image->os = IH_OS_U_BOOT; 511 #endif 512 513 /* 514 * Booting a next-stage U-Boot may require us to append the FDT. 515 * We allow this to fail, as the U-Boot image might embed its FDT. 516 */ 517 if (spl_image->os == IH_OS_U_BOOT) 518 spl_fit_append_fdt(spl_image, info, sector, fit, 519 images, base_offset); 520 521 /* Now check if there are more images for us to load */ 522 for (; ; index++) { 523 uint8_t os_type = IH_OS_INVALID; 524 525 node = spl_fit_get_image_node(fit, images, "loadables", index); 526 if (node < 0) 527 break; 528 529 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 530 &image_info); 531 if (ret < 0) 532 continue; 533 534 if (!spl_fit_image_get_os(fit, node, &os_type)) 535 debug("Loadable is %s\n", genimg_get_os_name(os_type)); 536 537 if (os_type == IH_OS_U_BOOT) { 538 spl_fit_append_fdt(&image_info, info, sector, 539 fit, images, base_offset); 540 spl_image->fdt_addr = image_info.fdt_addr; 541 } 542 543 /* 544 * If the "firmware" image did not provide an entry point, 545 * use the first valid entry point from the loadables. 546 */ 547 if (spl_image->entry_point == FDT_ERROR && 548 image_info.entry_point != FDT_ERROR) 549 spl_image->entry_point = image_info.entry_point; 550 551 /* Record our loadables into the FDT */ 552 if (spl_image->fdt_addr) 553 spl_fit_record_loadable(fit, images, index, 554 spl_image->fdt_addr, 555 &image_info); 556 } 557 558 /* 559 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's 560 * Makefile will set it to 0 and it will end up as the entry point 561 * here. What it actually means is: use the load address. 562 */ 563 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0) 564 spl_image->entry_point = spl_image->load_addr; 565 566 return 0; 567 } 568 569 int spl_load_simple_fit(struct spl_image_info *spl_image, 570 struct spl_load_info *info, ulong sector, void *fit) 571 { 572 ulong sector_offs = sector; 573 int i; 574 575 for (i = 0; i < CONFIG_SPL_FIT_IMAGE_MULTIPLE; i++) { 576 if (i > 0) { 577 sector_offs += 578 i * ((CONFIG_SPL_FIT_IMAGE_KB << 10) / info->bl_len); 579 printf("Trying fit image at 0x%lx sector\n", sector_offs); 580 if (info->read(info, sector_offs, 1, fit) != 1) { 581 printf("IO error\n"); 582 continue; 583 } 584 } 585 586 if (image_get_magic(fit) != FDT_MAGIC) { 587 printf("Bad fit magic\n"); 588 continue; 589 } 590 591 if (!spl_internal_load_simple_fit(spl_image, info, 592 sector_offs, fit)) 593 return 0; 594 } 595 596 return -EINVAL; 597 } 598 599