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 #ifdef CONFIG_SPL_FIT_SIGNATURE 238 printf("## Checking hash(es) for Image %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 #endif 249 250 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS 251 board_fit_image_post_process(&src, &length); 252 #endif 253 254 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && 255 IS_ENABLED(CONFIG_SPL_GZIP) && 256 image_comp == IH_COMP_GZIP && 257 type == IH_TYPE_KERNEL) { 258 size = length; 259 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN, 260 src, &size)) { 261 puts("Uncompressing error\n"); 262 return -EIO; 263 } 264 length = size; 265 } else { 266 memcpy((void *)load_addr, src, length); 267 } 268 269 if (image_info) { 270 image_info->load_addr = load_addr; 271 image_info->size = length; 272 image_info->entry_point = fdt_getprop_u32(fit, node, "entry"); 273 } 274 275 return 0; 276 } 277 278 static int spl_fit_append_fdt(struct spl_image_info *spl_image, 279 struct spl_load_info *info, ulong sector, 280 void *fit, int images, ulong base_offset) 281 { 282 struct spl_image_info image_info; 283 int node, ret; 284 285 /* Figure out which device tree the board wants to use */ 286 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0); 287 if (node < 0) { 288 debug("%s: cannot find FDT node\n", __func__); 289 return node; 290 } 291 292 /* 293 * Read the device tree and place it after the image. 294 * Align the destination address to ARCH_DMA_MINALIGN. 295 */ 296 image_info.load_addr = spl_image->load_addr + spl_image->size; 297 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 298 &image_info); 299 300 if (ret < 0) 301 return ret; 302 303 /* Make the load-address of the FDT available for the SPL framework */ 304 spl_image->fdt_addr = (void *)image_info.load_addr; 305 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 306 /* Try to make space, so we can inject details on the loadables */ 307 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192); 308 #endif 309 310 return ret; 311 } 312 313 static int spl_fit_record_loadable(const void *fit, int images, int index, 314 void *blob, struct spl_image_info *image) 315 { 316 int ret = 0; 317 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 318 char *name; 319 int node; 320 321 ret = spl_fit_get_image_name(fit, images, "loadables", 322 index, &name); 323 if (ret < 0) 324 return ret; 325 326 node = spl_fit_get_image_node(fit, images, "loadables", index); 327 328 ret = fdt_record_loadable(blob, index, name, image->load_addr, 329 image->size, image->entry_point, 330 fdt_getprop(fit, node, "type", NULL), 331 fdt_getprop(fit, node, "os", NULL)); 332 #endif 333 return ret; 334 } 335 336 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os) 337 { 338 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 339 return -ENOTSUPP; 340 #else 341 return fit_image_get_os(fit, noffset, os); 342 #endif 343 } 344 345 __weak int spl_fit_standalone_release(void) 346 { 347 return 0; 348 } 349 350 static int spl_internal_load_simple_fit(struct spl_image_info *spl_image, 351 struct spl_load_info *info, 352 ulong sector, void *fit) 353 { 354 int sectors; 355 ulong size; 356 unsigned long count; 357 struct spl_image_info image_info; 358 int node = -1; 359 int images, ret; 360 int base_offset, align_len = ARCH_DMA_MINALIGN - 1; 361 int index = 0; 362 363 /* 364 * For FIT with external data, figure out where the external images 365 * start. This is the base for the data-offset properties in each 366 * image. 367 */ 368 size = fdt_totalsize(fit); 369 size = FIT_ALIGN(size); 370 base_offset = FIT_ALIGN(size); 371 372 /* 373 * So far we only have one block of data from the FIT. Read the entire 374 * thing, including that first block, placing it so it finishes before 375 * where we will load the image. 376 * 377 * Note that we will load the image such that its first byte will be 378 * at the load address. Since that byte may be part-way through a 379 * block, we may load the image up to one block before the load 380 * address. So take account of that here by subtracting an addition 381 * block length from the FIT start position. 382 * 383 * In fact the FIT has its own load address, but we assume it cannot 384 * be before CONFIG_SYS_TEXT_BASE. 385 * 386 * For FIT with data embedded, data is loaded as part of FIT image. 387 * For FIT with external data, data is not loaded in this step. 388 */ 389 fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len - 390 align_len) & ~align_len); 391 sectors = get_aligned_image_size(info, size, 0); 392 count = info->read(info, sector, sectors, fit); 393 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n", 394 sector, sectors, fit, count); 395 if (count == 0) 396 return -EIO; 397 398 /* find the node holding the images information */ 399 images = fdt_path_offset(fit, FIT_IMAGES_PATH); 400 if (images < 0) { 401 debug("%s: Cannot find /images node: %d\n", __func__, images); 402 return -1; 403 } 404 405 /* verify the configure node by keys, if required */ 406 #ifdef CONFIG_SPL_FIT_SIGNATURE 407 int conf_noffset; 408 409 conf_noffset = fit_conf_get_node(fit, NULL); 410 if (conf_noffset > 0) { 411 ret = fit_config_verify(fit, conf_noffset); 412 if (ret) { 413 printf("fit verify configure failed, ret=%d\n", ret); 414 return ret; 415 } 416 printf("\n"); 417 } 418 419 #ifdef CONFIG_SPL_FIT_ROLLBACK_PROTECT 420 uint32_t this_index, min_index; 421 422 ret = fit_rollback_index_verify(fit, FIT_ROLLBACK_INDEX_SPL, 423 &this_index, &min_index); 424 if (ret) { 425 printf("fit failed to get rollback index, ret=%d\n", ret); 426 return ret; 427 } else if (this_index < min_index) { 428 printf("fit reject rollback: %d < %d(min)\n", 429 this_index, min_index); 430 return -EINVAL; 431 } 432 433 spl_image->rollback_index = this_index; 434 printf("rollback index: %d >= %d, OK\n", this_index, min_index); 435 #endif 436 #endif 437 438 /* 439 * If required to start the other core before load "loadables" 440 * firmwares, use the config "standalone" to load the other core's 441 * firmware, then start it. 442 * Normally, different cores' firmware is attach to the config 443 * "loadables" and load them together. 444 */ 445 if (node < 0) 446 node = spl_fit_get_image_node(fit, images, FIT_STANDALONE_PROP, 447 0); 448 if (node > 0) { 449 /* Load the image and set up the spl_image structure */ 450 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 451 spl_image); 452 if (!ret) { 453 ret = spl_fit_standalone_release(); 454 if (ret) 455 printf("Start standalone fail, ret = %d\n", 456 ret); 457 } 458 459 node = -1; 460 } 461 462 /* 463 * Find the U-Boot image using the following search order: 464 * - start at 'firmware' (e.g. an ARM Trusted Firmware) 465 * - fall back 'kernel' (e.g. a Falcon-mode OS boot 466 * - fall back to using the first 'loadables' entry 467 */ 468 if (node < 0) 469 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP, 470 0); 471 #ifdef CONFIG_SPL_OS_BOOT 472 if (node < 0) 473 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0); 474 #endif 475 if (node < 0) { 476 debug("could not find firmware image, trying loadables...\n"); 477 node = spl_fit_get_image_node(fit, images, "loadables", 0); 478 /* 479 * If we pick the U-Boot image from "loadables", start at 480 * the second image when later loading additional images. 481 */ 482 index = 1; 483 } 484 if (node < 0) { 485 debug("%s: Cannot find u-boot image node: %d\n", 486 __func__, node); 487 return -1; 488 } 489 490 /* Load the image and set up the spl_image structure */ 491 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 492 spl_image); 493 if (ret) 494 return ret; 495 496 /* 497 * For backward compatibility, we treat the first node that is 498 * as a U-Boot image, if no OS-type has been declared. 499 */ 500 if (!spl_fit_image_get_os(fit, node, &spl_image->os)) 501 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os)); 502 #if !defined(CONFIG_SPL_OS_BOOT) 503 else 504 spl_image->os = IH_OS_U_BOOT; 505 #endif 506 507 /* 508 * Booting a next-stage U-Boot may require us to append the FDT. 509 * We allow this to fail, as the U-Boot image might embed its FDT. 510 */ 511 if (spl_image->os == IH_OS_U_BOOT) 512 spl_fit_append_fdt(spl_image, info, sector, fit, 513 images, base_offset); 514 515 /* Now check if there are more images for us to load */ 516 for (; ; index++) { 517 uint8_t os_type = IH_OS_INVALID; 518 519 node = spl_fit_get_image_node(fit, images, "loadables", index); 520 if (node < 0) 521 break; 522 523 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 524 &image_info); 525 if (ret < 0) 526 continue; 527 528 if (!spl_fit_image_get_os(fit, node, &os_type)) 529 debug("Loadable is %s\n", genimg_get_os_name(os_type)); 530 531 if (os_type == IH_OS_U_BOOT) { 532 spl_fit_append_fdt(&image_info, info, sector, 533 fit, images, base_offset); 534 spl_image->fdt_addr = image_info.fdt_addr; 535 } 536 537 /* 538 * If the "firmware" image did not provide an entry point, 539 * use the first valid entry point from the loadables. 540 */ 541 if (spl_image->entry_point == FDT_ERROR && 542 image_info.entry_point != FDT_ERROR) 543 spl_image->entry_point = image_info.entry_point; 544 545 /* Record our loadables into the FDT */ 546 if (spl_image->fdt_addr) 547 spl_fit_record_loadable(fit, images, index, 548 spl_image->fdt_addr, 549 &image_info); 550 } 551 552 /* 553 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's 554 * Makefile will set it to 0 and it will end up as the entry point 555 * here. What it actually means is: use the load address. 556 */ 557 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0) 558 spl_image->entry_point = spl_image->load_addr; 559 560 return 0; 561 } 562 563 int spl_load_simple_fit(struct spl_image_info *spl_image, 564 struct spl_load_info *info, ulong sector, void *fit) 565 { 566 ulong sector_offs = sector; 567 int i; 568 569 for (i = 0; i < CONFIG_SPL_FIT_IMAGE_MULTIPLE; i++) { 570 if (i > 0) { 571 sector_offs += 572 i * ((CONFIG_SPL_FIT_IMAGE_KB << 10) / info->bl_len); 573 printf("Trying fit image at 0x%lx sector\n", sector_offs); 574 if (info->read(info, sector_offs, 1, fit) != 1) { 575 printf("IO error\n"); 576 continue; 577 } 578 } 579 580 if (image_get_magic(fit) != FDT_MAGIC) { 581 printf("Bad fit magic\n"); 582 continue; 583 } 584 585 if (!spl_internal_load_simple_fit(spl_image, info, 586 sector_offs, fit)) 587 return 0; 588 } 589 590 return -EINVAL; 591 } 592 593