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