common/spl/spl_fit.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2016 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #include <common.h>
   8 #include <errno.h>
   9 #include <fpga.h>
  10 #include <gzip.h>
  11 #include <image.h>
  12 #include <log.h>
  13 #include <malloc.h>
  14 #include <mapmem.h>
  15 #include <spl.h>
  16 #include <sysinfo.h>
  17 #include <asm/cache.h>
  18 #include <asm/global_data.h>
  19 #include <linux/libfdt.h>
  20
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 #ifndef CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
  24 #define CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ (64 * 1024)
  25 #endif
  26
  27 #ifndef CONFIG_SYS_BOOTM_LEN
  28 #define CONFIG_SYS_BOOTM_LEN    (64 << 20)
  29 #endif
  30
  31 struct spl_fit_info {
  32         const void *fit;        /* Pointer to a valid FIT blob */
  33         size_t ext_data_offset; /* Offset to FIT external data (end of FIT) */
  34         int images_node;        /* FDT offset to "/images" node */
  35         int conf_node;          /* FDT offset to selected configuration node */
  36 };
  37
  38 __weak void board_spl_fit_post_load(const void *fit)
  39 {
  40 }
  41
  42 __weak ulong board_spl_fit_size_align(ulong size)
  43 {
  44         return size;
  45 }
  46
  47 static int find_node_from_desc(const void *fit, int node, const char *str)
  48 {
  49         int child;
  50
  51         if (node < 0)
  52                 return -EINVAL;
  53
  54         /* iterate the FIT nodes and find a matching description */
  55         for (child = fdt_first_subnode(fit, node); child >= 0;
  56              child = fdt_next_subnode(fit, child)) {
  57                 int len;
  58                 const char *desc = fdt_getprop(fit, child, "description", &len);
  59
  60                 if (!desc)
  61                         continue;
  62
  63                 if (!strcmp(desc, str))
  64                         return child;
  65         }
  66
  67         return -ENOENT;
  68 }
  69
  70 /**
  71  * spl_fit_get_image_name(): By using the matching configuration subnode,
  72  * retrieve the name of an image, specified by a property name and an index
  73  * into that.
  74  * @fit:        Pointer to the FDT blob.
  75  * @images:     Offset of the /images subnode.
  76  * @type:       Name of the property within the configuration subnode.
  77  * @index:      Index into the list of strings in this property.
  78  * @outname:    Name of the image
  79  *
  80  * Return:      0 on success, or a negative error number
  81  */
  82 static int spl_fit_get_image_name(const struct spl_fit_info *ctx,
  83                                   const char *type, int index,
  84                                   const char **outname)
  85 {
  86         struct udevice *sysinfo;
  87         const char *name, *str;
  88         __maybe_unused int node;
  89         int len, i;
  90         bool found = true;
  91
  92         name = fdt_getprop(ctx->fit, ctx->conf_node, type, &len);
  93         if (!name) {
  94                 debug("cannot find property '%s': %d\n", type, len);
  95                 return -EINVAL;
  96         }
  97
  98         str = name;
  99         for (i = 0; i < index; i++) {
 100                 str = strchr(str, '\0') + 1;
 101                 if (!str || (str - name >= len)) {
 102                         found = false;
 103                         break;
 104                 }
 105         }
 106
 107         if (!found && CONFIG_IS_ENABLED(SYSINFO) && !sysinfo_get(&sysinfo)) {
 108                 int rc;
 109                 /*
 110                  * no string in the property for this index. Check if the
 111                  * sysinfo-level code can supply one.
 112                  */
 113                 rc = sysinfo_detect(sysinfo);
 114                 if (rc)
 115                         return rc;
 116
 117                 rc = sysinfo_get_fit_loadable(sysinfo, index - i - 1, type,
 118                                               &str);
 119                 if (rc && rc != -ENOENT)
 120                         return rc;
 121
 122                 if (!rc) {
 123                         /*
 124                          * The sysinfo provided a name for a loadable.
 125                          * Try to match it against the description properties
 126                          * first. If no matching node is found, use it as a
 127                          * node name.
 128                          */
 129                         int node;
 130                         int images = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
 131
 132                         node = find_node_from_desc(ctx->fit, images, str);
 133                         if (node > 0)
 134                                 str = fdt_get_name(ctx->fit, node, NULL);
 135
 136                         found = true;
 137                 }
 138         }
 139
 140         if (!found) {
 141                 debug("no string for index %d\n", index);
 142                 return -E2BIG;
 143         }
 144
 145         *outname = str;
 146         return 0;
 147 }
 148
 149 /**
 150  * spl_fit_get_image_node(): By using the matching configuration subnode,
 151  * retrieve the name of an image, specified by a property name and an index
 152  * into that.
 153  * @fit:        Pointer to the FDT blob.
 154  * @images:     Offset of the /images subnode.
 155  * @type:       Name of the property within the configuration subnode.
 156  * @index:      Index into the list of strings in this property.
 157  *
 158  * Return:      the node offset of the respective image node or a negative
 159  *              error number.
 160  */
 161 static int spl_fit_get_image_node(const struct spl_fit_info *ctx,
 162                                   const char *type, int index)
 163 {
 164         const char *str;
 165         int err;
 166         int node;
 167
 168         err = spl_fit_get_image_name(ctx, type, index, &str);
 169         if (err)
 170                 return err;
 171
 172         debug("%s: '%s'\n", type, str);
 173
 174         node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
 175         if (node < 0) {
 176                 pr_err("cannot find image node '%s': %d\n", str, node);
 177                 return -EINVAL;
 178         }
 179
 180         return node;
 181 }
 182
 183 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
 184 {
 185         /*
 186          * If it is a FS read, get the first address before offset which is
 187          * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
 188          * block number to which offset belongs.
 189          */
 190         if (info->filename)
 191                 return offset & ~(ARCH_DMA_MINALIGN - 1);
 192
 193         return offset / info->bl_len;
 194 }
 195
 196 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
 197 {
 198         /*
 199          * If it is a FS read, get the difference between the offset and
 200          * the first address before offset which is aligned to
 201          * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
 202          * block.
 203          */
 204         if (info->filename)
 205                 return offset & (ARCH_DMA_MINALIGN - 1);
 206
 207         return offset % info->bl_len;
 208 }
 209
 210 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
 211                                   int offset)
 212 {
 213         data_size = data_size + get_aligned_image_overhead(info, offset);
 214
 215         if (info->filename)
 216                 return data_size;
 217
 218         return (data_size + info->bl_len - 1) / info->bl_len;
 219 }
 220
 221 /**
 222  * spl_load_fit_image(): load the image described in a certain FIT node
 223  * @info:       points to information about the device to load data from
 224  * @sector:     the start sector of the FIT image on the device
 225  * @ctx:        points to the FIT context structure
 226  * @node:       offset of the DT node describing the image to load (relative
 227  *              to @fit)
 228  * @image_info: will be filled with information about the loaded image
 229  *              If the FIT node does not contain a "load" (address) property,
 230  *              the image gets loaded to the address pointed to by the
 231  *              load_addr member in this struct, if load_addr is not 0
 232  *
 233  * Return:      0 on success or a negative error number.
 234  */
 235 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
 236                               const struct spl_fit_info *ctx, int node,
 237                               struct spl_image_info *image_info)
 238 {
 239         int offset;
 240         size_t length;
 241         int len;
 242         ulong size;
 243         ulong load_addr;
 244         void *load_ptr;
 245         void *src;
 246         ulong overhead;
 247         int nr_sectors;
 248         uint8_t image_comp = -1, type = -1;
 249         const void *data;
 250         const void *fit = ctx->fit;
 251         bool external_data = false;
 252
 253         if (IS_ENABLED(CONFIG_SPL_FPGA) ||
 254             (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
 255                 if (fit_image_get_type(fit, node, &type))
 256                         puts("Cannot get image type.\n");
 257                 else
 258                         debug("%s ", genimg_get_type_name(type));
 259         }
 260
 261         if (IS_ENABLED(CONFIG_SPL_GZIP)) {
 262                 fit_image_get_comp(fit, node, &image_comp);
 263                 debug("%s ", genimg_get_comp_name(image_comp));
 264         }
 265
 266         if (fit_image_get_load(fit, node, &load_addr)) {
 267                 if (!image_info->load_addr) {
 268                         printf("Can't load %s: No load address and no buffer\n",
 269                                fit_get_name(fit, node, NULL));
 270                         return -ENOBUFS;
 271                 }
 272                 load_addr = image_info->load_addr;
 273         }
 274
 275         if (!fit_image_get_data_position(fit, node, &offset)) {
 276                 external_data = true;
 277         } else if (!fit_image_get_data_offset(fit, node, &offset)) {
 278                 offset += ctx->ext_data_offset;
 279                 external_data = true;
 280         }
 281
 282         if (external_data) {
 283                 void *src_ptr;
 284
 285                 /* External data */
 286                 if (fit_image_get_data_size(fit, node, &len))
 287                         return -ENOENT;
 288
 289                 /* Dont bother to copy 0 byte data, but warn, though */
 290                 if (!len) {
 291                         log_warning("%s: Skip load '%s': image size is 0!\n",
 292                                     __func__, fit_get_name(fit, node, NULL));
 293                         return 0;
 294                 }
 295
 296                 src_ptr = map_sysmem(ALIGN(load_addr, ARCH_DMA_MINALIGN), len);
 297                 length = len;
 298
 299                 overhead = get_aligned_image_overhead(info, offset);
 300                 nr_sectors = get_aligned_image_size(info, length, offset);
 301
 302                 if (info->read(info,
 303                                sector + get_aligned_image_offset(info, offset),
 304                                nr_sectors, src_ptr) != nr_sectors)
 305                         return -EIO;
 306
 307                 debug("External data: dst=%p, offset=%x, size=%lx\n",
 308                       src_ptr, offset, (unsigned long)length);
 309                 src = src_ptr + overhead;
 310         } else {
 311                 /* Embedded data */
 312                 if (fit_image_get_data(fit, node, &data, &length)) {
 313                         puts("Cannot get image data/size\n");
 314                         return -ENOENT;
 315                 }
 316                 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
 317                       (unsigned long)length);
 318                 src = (void *)data;     /* cast away const */
 319         }
 320
 321         if (CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
 322                 printf("## Checking hash(es) for Image %s ... ",
 323                        fit_get_name(fit, node, NULL));
 324                 if (!fit_image_verify_with_data(fit, node, src, length))
 325                         return -EPERM;
 326                 puts("OK\n");
 327         }
 328
 329         if (CONFIG_IS_ENABLED(FIT_IMAGE_POST_PROCESS))
 330                 board_fit_image_post_process(fit, node, &src, &length);
 331
 332         load_ptr = map_sysmem(load_addr, length);
 333         if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
 334                 size = length;
 335                 if (gunzip(load_ptr, CONFIG_SYS_BOOTM_LEN, src, &size)) {
 336                         puts("Uncompressing error\n");
 337                         return -EIO;
 338                 }
 339                 length = size;
 340         } else {
 341                 memcpy(load_ptr, src, length);
 342         }
 343
 344         if (image_info) {
 345                 ulong entry_point;
 346
 347                 image_info->load_addr = load_addr;
 348                 image_info->size = length;
 349
 350                 if (!fit_image_get_entry(fit, node, &entry_point))
 351                         image_info->entry_point = entry_point;
 352                 else
 353                         image_info->entry_point = FDT_ERROR;
 354         }
 355
 356         return 0;
 357 }
 358
 359 static bool os_takes_devicetree(uint8_t os)
 360 {
 361         switch (os) {
 362         case IH_OS_U_BOOT:
 363                 return true;
 364         case IH_OS_LINUX:
 365                 return IS_ENABLED(CONFIG_SPL_OS_BOOT);
 366         default:
 367                 return false;
 368         }
 369 }
 370
 371 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
 372                               struct spl_load_info *info, ulong sector,
 373                               const struct spl_fit_info *ctx)
 374 {
 375         struct spl_image_info image_info;
 376         int node, ret = 0, index = 0;
 377
 378         /*
 379          * Use the address following the image as target address for the
 380          * device tree.
 381          */
 382         image_info.load_addr = spl_image->load_addr + spl_image->size;
 383
 384         /* Figure out which device tree the board wants to use */
 385         node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index++);
 386         if (node < 0) {
 387                 debug("%s: cannot find FDT node\n", __func__);
 388
 389                 /*
 390                  * U-Boot did not find a device tree inside the FIT image. Use
 391                  * the U-Boot device tree instead.
 392                  */
 393                 if (gd->fdt_blob)
 394                         memcpy((void *)image_info.load_addr, gd->fdt_blob,
 395                                fdt_totalsize(gd->fdt_blob));
 396                 else
 397                         return node;
 398         } else {
 399                 ret = spl_load_fit_image(info, sector, ctx, node,
 400                                          &image_info);
 401                 if (ret < 0)
 402                         return ret;
 403         }
 404
 405         /* Make the load-address of the FDT available for the SPL framework */
 406         spl_image->fdt_addr = map_sysmem(image_info.load_addr, 0);
 407         if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
 408                 return 0;
 409
 410         if (CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)) {
 411                 void *tmpbuffer = NULL;
 412
 413                 for (; ; index++) {
 414                         node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index);
 415                         if (node == -E2BIG) {
 416                                 debug("%s: No additional FDT node\n", __func__);
 417                                 break;
 418                         } else if (node < 0) {
 419                                 debug("%s: unable to find FDT node %d\n",
 420                                       __func__, index);
 421                                 continue;
 422                         }
 423
 424                         if (!tmpbuffer) {
 425                                 /*
 426                                  * allocate memory to store the DT overlay
 427                                  * before it is applied. It may not be used
 428                                  * depending on how the overlay is stored, so
 429                                  * don't fail yet if the allocation failed.
 430                                  */
 431                                 tmpbuffer = malloc(CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ);
 432                                 if (!tmpbuffer)
 433                                         debug("%s: unable to allocate space for overlays\n",
 434                                               __func__);
 435                         }
 436                         image_info.load_addr = (ulong)tmpbuffer;
 437                         ret = spl_load_fit_image(info, sector, ctx,
 438                                                  node, &image_info);
 439                         if (ret < 0)
 440                                 break;
 441
 442                         /* Make room in FDT for changes from the overlay */
 443                         ret = fdt_increase_size(spl_image->fdt_addr,
 444                                                 image_info.size);
 445                         if (ret < 0)
 446                                 break;
 447
 448                         ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
 449                                                         (void *)image_info.load_addr);
 450                         if (ret) {
 451                                 pr_err("failed to apply DT overlay %s\n",
 452                                        fit_get_name(ctx->fit, node, NULL));
 453                                 break;
 454                         }
 455
 456                         debug("%s: DT overlay %s applied\n", __func__,
 457                               fit_get_name(ctx->fit, node, NULL));
 458                 }
 459                 free(tmpbuffer);
 460                 if (ret)
 461                         return ret;
 462         }
 463         /* Try to make space, so we can inject details on the loadables */
 464         ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
 465         if (ret < 0)
 466                 return ret;
 467
 468         return ret;
 469 }
 470
 471 static int spl_fit_record_loadable(const struct spl_fit_info *ctx, int index,
 472                                    void *blob, struct spl_image_info *image)
 473 {
 474         int ret = 0;
 475         const char *name;
 476         int node;
 477
 478         if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
 479                 return 0;
 480
 481         ret = spl_fit_get_image_name(ctx, "loadables", index, &name);
 482         if (ret < 0)
 483                 return ret;
 484
 485         node = spl_fit_get_image_node(ctx, "loadables", index);
 486
 487         ret = fdt_record_loadable(blob, index, name, image->load_addr,
 488                                   image->size, image->entry_point,
 489                                   fdt_getprop(ctx->fit, node, "type", NULL),
 490                                   fdt_getprop(ctx->fit, node, "os", NULL),
 491                                   fdt_getprop(ctx->fit, node, "arch", NULL));
 492         return ret;
 493 }
 494
 495 static int spl_fit_image_is_fpga(const void *fit, int node)
 496 {
 497         const char *type;
 498
 499         if (!IS_ENABLED(CONFIG_SPL_FPGA))
 500                 return 0;
 501
 502         type = fdt_getprop(fit, node, FIT_TYPE_PROP, NULL);
 503         if (!type)
 504                 return 0;
 505
 506         return !strcmp(type, "fpga");
 507 }
 508
 509 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
 510 {
 511         if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) || CONFIG_IS_ENABLED(OS_BOOT))
 512                 return fit_image_get_os(fit, noffset, os);
 513
 514         const char *name = fdt_getprop(fit, noffset, FIT_OS_PROP, NULL);
 515         if (!name)
 516                 return -ENOENT;
 517
 518         /*
 519          * We don't care what the type of the image actually is,
 520          * only whether or not it is U-Boot. This saves some
 521          * space by omitting the large table of OS types.
 522          */
 523         if (!strcmp(name, "u-boot"))
 524                 *os = IH_OS_U_BOOT;
 525         else
 526                 *os = IH_OS_INVALID;
 527
 528         return 0;
 529 }
 530
 531 /*
 532  * The purpose of the FIT load buffer is to provide a memory location that is
 533  * independent of the load address of any FIT component.
 534  */
 535 static void *spl_get_fit_load_buffer(size_t size)
 536 {
 537         void *buf;
 538
 539         buf = malloc(size);
 540         if (!buf) {
 541                 pr_err("Could not get FIT buffer of %lu bytes\n", (ulong)size);
 542                 pr_err("\tcheck CONFIG_SYS_SPL_MALLOC_SIZE\n");
 543                 buf = spl_get_load_buffer(0, size);
 544         }
 545         return buf;
 546 }
 547
 548 __weak void *board_spl_fit_buffer_addr(ulong fit_size, int sectors, int bl_len)
 549 {
 550         return spl_get_fit_load_buffer(sectors * bl_len);
 551 }
 552
 553 /*
 554  * Weak default function to allow customizing SPL fit loading for load-only
 555  * use cases by allowing to skip the parsing/processing of the FIT contents
 556  * (so that this can be done separately in a more customized fashion)
 557  */
 558 __weak bool spl_load_simple_fit_skip_processing(void)
 559 {
 560         return false;
 561 }
 562
 563 /*
 564  * Weak default function to allow fixes after fit header
 565  * is loaded.
 566  */
 567 __weak void *spl_load_simple_fit_fix_load(const void *fit)
 568 {
 569         return (void *)fit;
 570 }
 571
 572 static void warn_deprecated(const char *msg)
 573 {
 574         printf("DEPRECATED: %s\n", msg);
 575         printf("\tSee doc/uImage.FIT/source_file_format.txt\n");
 576 }
 577
 578 static int spl_fit_upload_fpga(struct spl_fit_info *ctx, int node,
 579                                struct spl_image_info *fpga_image)
 580 {
 581         const char *compatible;
 582         int ret;
 583
 584         debug("FPGA bitstream at: %x, size: %x\n",
 585               (u32)fpga_image->load_addr, fpga_image->size);
 586
 587         compatible = fdt_getprop(ctx->fit, node, "compatible", NULL);
 588         if (!compatible)
 589                 warn_deprecated("'fpga' image without 'compatible' property");
 590         else if (strcmp(compatible, "u-boot,fpga-legacy"))
 591                 printf("Ignoring compatible = %s property\n", compatible);
 592
 593         ret = fpga_load(0, (void *)fpga_image->load_addr, fpga_image->size,
 594                         BIT_FULL);
 595         if (ret) {
 596                 printf("%s: Cannot load the image to the FPGA\n", __func__);
 597                 return ret;
 598         }
 599
 600         puts("FPGA image loaded from FIT\n");
 601
 602         return 0;
 603 }
 604
 605 static int spl_fit_load_fpga(struct spl_fit_info *ctx,
 606                              struct spl_load_info *info, ulong sector)
 607 {
 608         int node, ret;
 609
 610         struct spl_image_info fpga_image = {
 611                 .load_addr = 0,
 612         };
 613
 614         node = spl_fit_get_image_node(ctx, "fpga", 0);
 615         if (node < 0)
 616                 return node;
 617
 618         warn_deprecated("'fpga' property in config node. Use 'loadables'");
 619
 620         /* Load the image and set up the fpga_image structure */
 621         ret = spl_load_fit_image(info, sector, ctx, node, &fpga_image);
 622         if (ret) {
 623                 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
 624                 return ret;
 625         }
 626
 627         return spl_fit_upload_fpga(ctx, node, &fpga_image);
 628 }
 629
 630 static int spl_simple_fit_read(struct spl_fit_info *ctx,
 631                                struct spl_load_info *info, ulong sector,
 632                                const void *fit_header)
 633 {
 634         unsigned long count, size;
 635         int sectors;
 636         void *buf;
 637
 638         /*
 639          * For FIT with external data, figure out where the external images
 640          * start. This is the base for the data-offset properties in each
 641          * image.
 642          */
 643         size = ALIGN(fdt_totalsize(fit_header), 4);
 644         size = board_spl_fit_size_align(size);
 645         ctx->ext_data_offset = ALIGN(size, 4);
 646
 647         /*
 648          * So far we only have one block of data from the FIT. Read the entire
 649          * thing, including that first block.
 650          *
 651          * For FIT with data embedded, data is loaded as part of FIT image.
 652          * For FIT with external data, data is not loaded in this step.
 653          */
 654         sectors = get_aligned_image_size(info, size, 0);
 655         buf = board_spl_fit_buffer_addr(size, sectors, info->bl_len);
 656
 657         count = info->read(info, sector, sectors, buf);
 658         ctx->fit = buf;
 659         debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
 660               sector, sectors, buf, count, size);
 661
 662         return (count == 0) ? -EIO : 0;
 663 }
 664
 665 static int spl_simple_fit_parse(struct spl_fit_info *ctx)
 666 {
 667         /* Find the correct subnode under "/configurations" */
 668         ctx->conf_node = fit_find_config_node(ctx->fit);
 669         if (ctx->conf_node < 0)
 670                 return -EINVAL;
 671
 672         if (IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) {
 673                 printf("## Checking hash(es) for config %s ... ",
 674                        fit_get_name(ctx->fit, ctx->conf_node, NULL));
 675                 if (fit_config_verify(ctx->fit, ctx->conf_node))
 676                         return -EPERM;
 677                 puts("OK\n");
 678         }
 679
 680         /* find the node holding the images information */
 681         ctx->images_node = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
 682         if (ctx->images_node < 0) {
 683                 debug("%s: Cannot find /images node: %d\n", __func__,
 684                       ctx->images_node);
 685                 return -EINVAL;
 686         }
 687
 688         return 0;
 689 }
 690
 691 int spl_load_simple_fit(struct spl_image_info *spl_image,
 692                         struct spl_load_info *info, ulong sector, void *fit)
 693 {
 694         struct spl_image_info image_info;
 695         struct spl_fit_info ctx;
 696         int node = -1;
 697         int ret;
 698         int index = 0;
 699         int firmware_node;
 700
 701         ret = spl_simple_fit_read(&ctx, info, sector, fit);
 702         if (ret < 0)
 703                 return ret;
 704
 705         /* skip further processing if requested to enable load-only use cases */
 706         if (spl_load_simple_fit_skip_processing())
 707                 return 0;
 708
 709         ctx.fit = spl_load_simple_fit_fix_load(ctx.fit);
 710
 711         ret = spl_simple_fit_parse(&ctx);
 712         if (ret < 0)
 713                 return ret;
 714
 715         if (IS_ENABLED(CONFIG_SPL_FPGA))
 716                 spl_fit_load_fpga(&ctx, info, sector);
 717
 718         /*
 719          * Find the U-Boot image using the following search order:
 720          *   - start at 'firmware' (e.g. an ARM Trusted Firmware)
 721          *   - fall back 'kernel' (e.g. a Falcon-mode OS boot
 722          *   - fall back to using the first 'loadables' entry
 723          */
 724         if (node < 0)
 725                 node = spl_fit_get_image_node(&ctx, FIT_FIRMWARE_PROP, 0);
 726
 727         if (node < 0 && IS_ENABLED(CONFIG_SPL_OS_BOOT))
 728                 node = spl_fit_get_image_node(&ctx, FIT_KERNEL_PROP, 0);
 729
 730         if (node < 0) {
 731                 debug("could not find firmware image, trying loadables...\n");
 732                 node = spl_fit_get_image_node(&ctx, "loadables", 0);
 733                 /*
 734                  * If we pick the U-Boot image from "loadables", start at
 735                  * the second image when later loading additional images.
 736                  */
 737                 index = 1;
 738         }
 739         if (node < 0) {
 740                 debug("%s: Cannot find u-boot image node: %d\n",
 741                       __func__, node);
 742                 return -1;
 743         }
 744
 745         /* Load the image and set up the spl_image structure */
 746         ret = spl_load_fit_image(info, sector, &ctx, node, spl_image);
 747         if (ret)
 748                 return ret;
 749
 750         /*
 751          * For backward compatibility, we treat the first node that is
 752          * as a U-Boot image, if no OS-type has been declared.
 753          */
 754         if (!spl_fit_image_get_os(ctx.fit, node, &spl_image->os))
 755                 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
 756         else if (!IS_ENABLED(CONFIG_SPL_OS_BOOT))
 757                 spl_image->os = IH_OS_U_BOOT;
 758
 759         /*
 760          * Booting a next-stage U-Boot may require us to append the FDT.
 761          * We allow this to fail, as the U-Boot image might embed its FDT.
 762          */
 763         if (os_takes_devicetree(spl_image->os)) {
 764                 ret = spl_fit_append_fdt(spl_image, info, sector, &ctx);
 765                 if (ret < 0 && spl_image->os != IH_OS_U_BOOT)
 766                         return ret;
 767         }
 768
 769         firmware_node = node;
 770         /* Now check if there are more images for us to load */
 771         for (; ; index++) {
 772                 uint8_t os_type = IH_OS_INVALID;
 773
 774                 node = spl_fit_get_image_node(&ctx, "loadables", index);
 775                 if (node < 0)
 776                         break;
 777
 778                 /*
 779                  * if the firmware is also a loadable, skip it because
 780                  * it already has been loaded. This is typically the case with
 781                  * u-boot.img generated by mkimage.
 782                  */
 783                 if (firmware_node == node)
 784                         continue;
 785
 786                 image_info.load_addr = 0;
 787                 ret = spl_load_fit_image(info, sector, &ctx, node, &image_info);
 788                 if (ret < 0) {
 789                         printf("%s: can't load image loadables index %d (ret = %d)\n",
 790                                __func__, index, ret);
 791                         return ret;
 792                 }
 793
 794                 if (spl_fit_image_is_fpga(ctx.fit, node))
 795                         spl_fit_upload_fpga(&ctx, node, &image_info);
 796
 797                 if (!spl_fit_image_get_os(ctx.fit, node, &os_type))
 798                         debug("Loadable is %s\n", genimg_get_os_name(os_type));
 799
 800                 if (os_takes_devicetree(os_type)) {
 801                         spl_fit_append_fdt(&image_info, info, sector, &ctx);
 802                         spl_image->fdt_addr = image_info.fdt_addr;
 803                 }
 804
 805                 /*
 806                  * If the "firmware" image did not provide an entry point,
 807                  * use the first valid entry point from the loadables.
 808                  */
 809                 if (spl_image->entry_point == FDT_ERROR &&
 810                     image_info.entry_point != FDT_ERROR)
 811                         spl_image->entry_point = image_info.entry_point;
 812
 813                 /* Record our loadables into the FDT */
 814                 if (spl_image->fdt_addr)
 815                         spl_fit_record_loadable(&ctx, index,
 816                                                 spl_image->fdt_addr,
 817                                                 &image_info);
 818         }
 819
 820         /*
 821          * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
 822          * Makefile will set it to 0 and it will end up as the entry point
 823          * here. What it actually means is: use the load address.
 824          */
 825         if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
 826                 spl_image->entry_point = spl_image->load_addr;
 827
 828         spl_image->flags |= SPL_FIT_FOUND;
 829
 830         if (IS_ENABLED(CONFIG_IMX_HAB))
 831                 board_spl_fit_post_load(ctx.fit);
 832
 833         return 0;
 834 }