boot/image-fit.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2013, Google Inc.
   4  *
   5  * (C) Copyright 2008 Semihalf
   6  *
   7  * (C) Copyright 2000-2006
   8  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   9  */
  10
  11 #define LOG_CATEGORY LOGC_BOOT
  12
  13 #ifdef USE_HOSTCC
  14 #include "mkimage.h"
  15 #include <time.h>
  16 #include <linux/libfdt.h>
  17 #include <u-boot/crc.h>
  18 #else
  19 #include <linux/compiler.h>
  20 #include <linux/sizes.h>
  21 #include <common.h>
  22 #include <errno.h>
  23 #include <log.h>
  24 #include <mapmem.h>
  25 #include <asm/io.h>
  26 #include <malloc.h>
  27 #include <memalign.h>
  28 #include <asm/global_data.h>
  29 #ifdef CONFIG_DM_HASH
  30 #include <dm.h>
  31 #include <u-boot/hash.h>
  32 #endif
  33 DECLARE_GLOBAL_DATA_PTR;
  34 #endif /* !USE_HOSTCC*/
  35
  36 #include <bootm.h>
  37 #include <image.h>
  38 #include <bootstage.h>
  39 #include <linux/kconfig.h>
  40 #include <u-boot/crc.h>
  41 #include <u-boot/md5.h>
  42 #include <u-boot/sha1.h>
  43 #include <u-boot/sha256.h>
  44 #include <u-boot/sha512.h>
  45
  46 /*****************************************************************************/
  47 /* New uImage format routines */
  48 /*****************************************************************************/
  49 #ifndef USE_HOSTCC
  50 static int fit_parse_spec(const char *spec, char sepc, ulong addr_curr,
  51                 ulong *addr, const char **name)
  52 {
  53         const char *sep;
  54
  55         *addr = addr_curr;
  56         *name = NULL;
  57
  58         sep = strchr(spec, sepc);
  59         if (sep) {
  60                 if (sep - spec > 0)
  61                         *addr = hextoul(spec, NULL);
  62
  63                 *name = sep + 1;
  64                 return 1;
  65         }
  66
  67         return 0;
  68 }
  69
  70 /**
  71  * fit_parse_conf - parse FIT configuration spec
  72  * @spec: input string, containing configuration spec
  73  * @add_curr: current image address (to be used as a possible default)
  74  * @addr: pointer to a ulong variable, will hold FIT image address of a given
  75  * configuration
  76  * @conf_name double pointer to a char, will hold pointer to a configuration
  77  * unit name
  78  *
  79  * fit_parse_conf() expects configuration spec in the form of [<addr>]#<conf>,
  80  * where <addr> is a FIT image address that contains configuration
  81  * with a <conf> unit name.
  82  *
  83  * Address part is optional, and if omitted default add_curr will
  84  * be used instead.
  85  *
  86  * returns:
  87  *     1 if spec is a valid configuration string,
  88  *     addr and conf_name are set accordingly
  89  *     0 otherwise
  90  */
  91 int fit_parse_conf(const char *spec, ulong addr_curr,
  92                 ulong *addr, const char **conf_name)
  93 {
  94         return fit_parse_spec(spec, '#', addr_curr, addr, conf_name);
  95 }
  96
  97 /**
  98  * fit_parse_subimage - parse FIT subimage spec
  99  * @spec: input string, containing subimage spec
 100  * @add_curr: current image address (to be used as a possible default)
 101  * @addr: pointer to a ulong variable, will hold FIT image address of a given
 102  * subimage
 103  * @image_name: double pointer to a char, will hold pointer to a subimage name
 104  *
 105  * fit_parse_subimage() expects subimage spec in the form of
 106  * [<addr>]:<subimage>, where <addr> is a FIT image address that contains
 107  * subimage with a <subimg> unit name.
 108  *
 109  * Address part is optional, and if omitted default add_curr will
 110  * be used instead.
 111  *
 112  * returns:
 113  *     1 if spec is a valid subimage string,
 114  *     addr and image_name are set accordingly
 115  *     0 otherwise
 116  */
 117 int fit_parse_subimage(const char *spec, ulong addr_curr,
 118                 ulong *addr, const char **image_name)
 119 {
 120         return fit_parse_spec(spec, ':', addr_curr, addr, image_name);
 121 }
 122 #endif /* !USE_HOSTCC */
 123
 124 #ifdef USE_HOSTCC
 125 /* Host tools use these implementations for Cipher and Signature support */
 126 static void *host_blob;
 127
 128 void image_set_host_blob(void *blob)
 129 {
 130         host_blob = blob;
 131 }
 132
 133 void *image_get_host_blob(void)
 134 {
 135         return host_blob;
 136 }
 137 #endif /* USE_HOSTCC */
 138
 139 static void fit_get_debug(const void *fit, int noffset,
 140                 char *prop_name, int err)
 141 {
 142         debug("Can't get '%s' property from FIT 0x%08lx, node: offset %d, name %s (%s)\n",
 143               prop_name, (ulong)fit, noffset, fit_get_name(fit, noffset, NULL),
 144               fdt_strerror(err));
 145 }
 146
 147 /**
 148  * fit_get_subimage_count - get component (sub-image) count
 149  * @fit: pointer to the FIT format image header
 150  * @images_noffset: offset of images node
 151  *
 152  * returns:
 153  *     number of image components
 154  */
 155 int fit_get_subimage_count(const void *fit, int images_noffset)
 156 {
 157         int noffset;
 158         int ndepth;
 159         int count = 0;
 160
 161         /* Process its subnodes, print out component images details */
 162         for (ndepth = 0, count = 0,
 163                 noffset = fdt_next_node(fit, images_noffset, &ndepth);
 164              (noffset >= 0) && (ndepth > 0);
 165              noffset = fdt_next_node(fit, noffset, &ndepth)) {
 166                 if (ndepth == 1) {
 167                         count++;
 168                 }
 169         }
 170
 171         return count;
 172 }
 173
 174 /**
 175  * fit_image_print_data() - prints out the hash node details
 176  * @fit: pointer to the FIT format image header
 177  * @noffset: offset of the hash node
 178  * @p: pointer to prefix string
 179  * @type: Type of information to print ("hash" or "sign")
 180  *
 181  * fit_image_print_data() lists properties for the processed hash node
 182  *
 183  * This function avoid using puts() since it prints a newline on the host
 184  * but does not in U-Boot.
 185  *
 186  * returns:
 187  *     no returned results
 188  */
 189 static void fit_image_print_data(const void *fit, int noffset, const char *p,
 190                                  const char *type)
 191 {
 192         const char *keyname;
 193         uint8_t *value;
 194         int value_len;
 195         const char *algo;
 196         const char *padding;
 197         bool required;
 198         int ret, i;
 199
 200         debug("%s  %s node:    '%s'\n", p, type,
 201               fit_get_name(fit, noffset, NULL));
 202         printf("%s  %s algo:    ", p, type);
 203         if (fit_image_hash_get_algo(fit, noffset, &algo)) {
 204                 printf("invalid/unsupported\n");
 205                 return;
 206         }
 207         printf("%s", algo);
 208         keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
 209         required = fdt_getprop(fit, noffset, FIT_KEY_REQUIRED, NULL) != NULL;
 210         if (keyname)
 211                 printf(":%s", keyname);
 212         if (required)
 213                 printf(" (required)");
 214         printf("\n");
 215
 216         padding = fdt_getprop(fit, noffset, "padding", NULL);
 217         if (padding)
 218                 printf("%s  %s padding: %s\n", p, type, padding);
 219
 220         ret = fit_image_hash_get_value(fit, noffset, &value,
 221                                        &value_len);
 222         printf("%s  %s value:   ", p, type);
 223         if (ret) {
 224                 printf("unavailable\n");
 225         } else {
 226                 for (i = 0; i < value_len; i++)
 227                         printf("%02x", value[i]);
 228                 printf("\n");
 229         }
 230
 231         debug("%s  %s len:     %d\n", p, type, value_len);
 232
 233         /* Signatures have a time stamp */
 234         if (IMAGE_ENABLE_TIMESTAMP && keyname) {
 235                 time_t timestamp;
 236
 237                 printf("%s  Timestamp:    ", p);
 238                 if (fit_get_timestamp(fit, noffset, &timestamp))
 239                         printf("unavailable\n");
 240                 else
 241                         genimg_print_time(timestamp);
 242         }
 243 }
 244
 245 /**
 246  * fit_image_print_verification_data() - prints out the hash/signature details
 247  * @fit: pointer to the FIT format image header
 248  * @noffset: offset of the hash or signature node
 249  * @p: pointer to prefix string
 250  *
 251  * This lists properties for the processed hash node
 252  *
 253  * returns:
 254  *     no returned results
 255  */
 256 static void fit_image_print_verification_data(const void *fit, int noffset,
 257                                               const char *p)
 258 {
 259         const char *name;
 260
 261         /*
 262          * Check subnode name, must be equal to "hash" or "signature".
 263          * Multiple hash/signature nodes require unique unit node
 264          * names, e.g. hash-1, hash-2, signature-1, signature-2, etc.
 265          */
 266         name = fit_get_name(fit, noffset, NULL);
 267         if (!strncmp(name, FIT_HASH_NODENAME, strlen(FIT_HASH_NODENAME))) {
 268                 fit_image_print_data(fit, noffset, p, "Hash");
 269         } else if (!strncmp(name, FIT_SIG_NODENAME,
 270                                 strlen(FIT_SIG_NODENAME))) {
 271                 fit_image_print_data(fit, noffset, p, "Sign");
 272         }
 273 }
 274
 275 /**
 276  * fit_conf_print - prints out the FIT configuration details
 277  * @fit: pointer to the FIT format image header
 278  * @noffset: offset of the configuration node
 279  * @p: pointer to prefix string
 280  *
 281  * fit_conf_print() lists all mandatory properties for the processed
 282  * configuration node.
 283  *
 284  * returns:
 285  *     no returned results
 286  */
 287 static void fit_conf_print(const void *fit, int noffset, const char *p)
 288 {
 289         char *desc;
 290         const char *uname;
 291         int ret;
 292         int fdt_index, loadables_index;
 293         int ndepth;
 294
 295         /* Mandatory properties */
 296         ret = fit_get_desc(fit, noffset, &desc);
 297         printf("%s  Description:  ", p);
 298         if (ret)
 299                 printf("unavailable\n");
 300         else
 301                 printf("%s\n", desc);
 302
 303         uname = fdt_getprop(fit, noffset, FIT_KERNEL_PROP, NULL);
 304         printf("%s  Kernel:       ", p);
 305         if (!uname)
 306                 printf("unavailable\n");
 307         else
 308                 printf("%s\n", uname);
 309
 310         /* Optional properties */
 311         uname = fdt_getprop(fit, noffset, FIT_RAMDISK_PROP, NULL);
 312         if (uname)
 313                 printf("%s  Init Ramdisk: %s\n", p, uname);
 314
 315         uname = fdt_getprop(fit, noffset, FIT_FIRMWARE_PROP, NULL);
 316         if (uname)
 317                 printf("%s  Firmware:     %s\n", p, uname);
 318
 319         for (fdt_index = 0;
 320              uname = fdt_stringlist_get(fit, noffset, FIT_FDT_PROP,
 321                                         fdt_index, NULL), uname;
 322              fdt_index++) {
 323                 if (fdt_index == 0)
 324                         printf("%s  FDT:          ", p);
 325                 else
 326                         printf("%s                ", p);
 327                 printf("%s\n", uname);
 328         }
 329
 330         uname = fdt_getprop(fit, noffset, FIT_FPGA_PROP, NULL);
 331         if (uname)
 332                 printf("%s  FPGA:         %s\n", p, uname);
 333
 334         /* Print out all of the specified loadables */
 335         for (loadables_index = 0;
 336              uname = fdt_stringlist_get(fit, noffset, FIT_LOADABLE_PROP,
 337                                         loadables_index, NULL), uname;
 338              loadables_index++) {
 339                 if (loadables_index == 0) {
 340                         printf("%s  Loadables:    ", p);
 341                 } else {
 342                         printf("%s                ", p);
 343                 }
 344                 printf("%s\n", uname);
 345         }
 346
 347         /* Process all hash subnodes of the component configuration node */
 348         for (ndepth = 0, noffset = fdt_next_node(fit, noffset, &ndepth);
 349              (noffset >= 0) && (ndepth > 0);
 350              noffset = fdt_next_node(fit, noffset, &ndepth)) {
 351                 if (ndepth == 1) {
 352                         /* Direct child node of the component configuration node */
 353                         fit_image_print_verification_data(fit, noffset, p);
 354                 }
 355         }
 356 }
 357
 358 /**
 359  * fit_print_contents - prints out the contents of the FIT format image
 360  * @fit: pointer to the FIT format image header
 361  * @p: pointer to prefix string
 362  *
 363  * fit_print_contents() formats a multi line FIT image contents description.
 364  * The routine prints out FIT image properties (root node level) followed by
 365  * the details of each component image.
 366  *
 367  * returns:
 368  *     no returned results
 369  */
 370 void fit_print_contents(const void *fit)
 371 {
 372         char *desc;
 373         char *uname;
 374         int images_noffset;
 375         int confs_noffset;
 376         int noffset;
 377         int ndepth;
 378         int count = 0;
 379         int ret;
 380         const char *p;
 381         time_t timestamp;
 382
 383         if (!CONFIG_IS_ENABLED(FIT_PRINT))
 384                 return;
 385
 386         /* Indent string is defined in header image.h */
 387         p = IMAGE_INDENT_STRING;
 388
 389         /* Root node properties */
 390         ret = fit_get_desc(fit, 0, &desc);
 391         printf("%sFIT description: ", p);
 392         if (ret)
 393                 printf("unavailable\n");
 394         else
 395                 printf("%s\n", desc);
 396
 397         if (IMAGE_ENABLE_TIMESTAMP) {
 398                 ret = fit_get_timestamp(fit, 0, &timestamp);
 399                 printf("%sCreated:         ", p);
 400                 if (ret)
 401                         printf("unavailable\n");
 402                 else
 403                         genimg_print_time(timestamp);
 404         }
 405
 406         /* Find images parent node offset */
 407         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
 408         if (images_noffset < 0) {
 409                 printf("Can't find images parent node '%s' (%s)\n",
 410                        FIT_IMAGES_PATH, fdt_strerror(images_noffset));
 411                 return;
 412         }
 413
 414         /* Process its subnodes, print out component images details */
 415         for (ndepth = 0, count = 0,
 416                 noffset = fdt_next_node(fit, images_noffset, &ndepth);
 417              (noffset >= 0) && (ndepth > 0);
 418              noffset = fdt_next_node(fit, noffset, &ndepth)) {
 419                 if (ndepth == 1) {
 420                         /*
 421                          * Direct child node of the images parent node,
 422                          * i.e. component image node.
 423                          */
 424                         printf("%s Image %u (%s)\n", p, count++,
 425                                fit_get_name(fit, noffset, NULL));
 426
 427                         fit_image_print(fit, noffset, p);
 428                 }
 429         }
 430
 431         /* Find configurations parent node offset */
 432         confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
 433         if (confs_noffset < 0) {
 434                 debug("Can't get configurations parent node '%s' (%s)\n",
 435                       FIT_CONFS_PATH, fdt_strerror(confs_noffset));
 436                 return;
 437         }
 438
 439         /* get default configuration unit name from default property */
 440         uname = (char *)fdt_getprop(fit, noffset, FIT_DEFAULT_PROP, NULL);
 441         if (uname)
 442                 printf("%s Default Configuration: '%s'\n", p, uname);
 443
 444         /* Process its subnodes, print out configurations details */
 445         for (ndepth = 0, count = 0,
 446                 noffset = fdt_next_node(fit, confs_noffset, &ndepth);
 447              (noffset >= 0) && (ndepth > 0);
 448              noffset = fdt_next_node(fit, noffset, &ndepth)) {
 449                 if (ndepth == 1) {
 450                         /*
 451                          * Direct child node of the configurations parent node,
 452                          * i.e. configuration node.
 453                          */
 454                         printf("%s Configuration %u (%s)\n", p, count++,
 455                                fit_get_name(fit, noffset, NULL));
 456
 457                         fit_conf_print(fit, noffset, p);
 458                 }
 459         }
 460 }
 461
 462 /**
 463  * fit_image_print - prints out the FIT component image details
 464  * @fit: pointer to the FIT format image header
 465  * @image_noffset: offset of the component image node
 466  * @p: pointer to prefix string
 467  *
 468  * fit_image_print() lists all mandatory properties for the processed component
 469  * image. If present, hash nodes are printed out as well. Load
 470  * address for images of type firmware is also printed out. Since the load
 471  * address is not mandatory for firmware images, it will be output as
 472  * "unavailable" when not present.
 473  *
 474  * returns:
 475  *     no returned results
 476  */
 477 void fit_image_print(const void *fit, int image_noffset, const char *p)
 478 {
 479         char *desc;
 480         uint8_t type, arch, os, comp = IH_COMP_NONE;
 481         size_t size;
 482         ulong load, entry;
 483         const void *data;
 484         int noffset;
 485         int ndepth;
 486         int ret;
 487
 488         if (!CONFIG_IS_ENABLED(FIT_PRINT))
 489                 return;
 490
 491         /* Mandatory properties */
 492         ret = fit_get_desc(fit, image_noffset, &desc);
 493         printf("%s  Description:  ", p);
 494         if (ret)
 495                 printf("unavailable\n");
 496         else
 497                 printf("%s\n", desc);
 498
 499         if (IMAGE_ENABLE_TIMESTAMP) {
 500                 time_t timestamp;
 501
 502                 ret = fit_get_timestamp(fit, 0, &timestamp);
 503                 printf("%s  Created:      ", p);
 504                 if (ret)
 505                         printf("unavailable\n");
 506                 else
 507                         genimg_print_time(timestamp);
 508         }
 509
 510         fit_image_get_type(fit, image_noffset, &type);
 511         printf("%s  Type:         %s\n", p, genimg_get_type_name(type));
 512
 513         fit_image_get_comp(fit, image_noffset, &comp);
 514         printf("%s  Compression:  %s\n", p, genimg_get_comp_name(comp));
 515
 516         ret = fit_image_get_data_and_size(fit, image_noffset, &data, &size);
 517
 518         if (!tools_build()) {
 519                 printf("%s  Data Start:   ", p);
 520                 if (ret) {
 521                         printf("unavailable\n");
 522                 } else {
 523                         void *vdata = (void *)data;
 524
 525                         printf("0x%08lx\n", (ulong)map_to_sysmem(vdata));
 526                 }
 527         }
 528
 529         printf("%s  Data Size:    ", p);
 530         if (ret)
 531                 printf("unavailable\n");
 532         else
 533                 genimg_print_size(size);
 534
 535         /* Remaining, type dependent properties */
 536         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
 537             (type == IH_TYPE_RAMDISK) || (type == IH_TYPE_FIRMWARE) ||
 538             (type == IH_TYPE_FLATDT)) {
 539                 fit_image_get_arch(fit, image_noffset, &arch);
 540                 printf("%s  Architecture: %s\n", p, genimg_get_arch_name(arch));
 541         }
 542
 543         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_RAMDISK) ||
 544             (type == IH_TYPE_FIRMWARE)) {
 545                 fit_image_get_os(fit, image_noffset, &os);
 546                 printf("%s  OS:           %s\n", p, genimg_get_os_name(os));
 547         }
 548
 549         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
 550             (type == IH_TYPE_FIRMWARE) || (type == IH_TYPE_RAMDISK) ||
 551             (type == IH_TYPE_FPGA)) {
 552                 ret = fit_image_get_load(fit, image_noffset, &load);
 553                 printf("%s  Load Address: ", p);
 554                 if (ret)
 555                         printf("unavailable\n");
 556                 else
 557                         printf("0x%08lx\n", load);
 558         }
 559
 560         /* optional load address for FDT */
 561         if (type == IH_TYPE_FLATDT && !fit_image_get_load(fit, image_noffset, &load))
 562                 printf("%s  Load Address: 0x%08lx\n", p, load);
 563
 564         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
 565             (type == IH_TYPE_RAMDISK)) {
 566                 ret = fit_image_get_entry(fit, image_noffset, &entry);
 567                 printf("%s  Entry Point:  ", p);
 568                 if (ret)
 569                         printf("unavailable\n");
 570                 else
 571                         printf("0x%08lx\n", entry);
 572         }
 573
 574         /* Process all hash subnodes of the component image node */
 575         for (ndepth = 0, noffset = fdt_next_node(fit, image_noffset, &ndepth);
 576              (noffset >= 0) && (ndepth > 0);
 577              noffset = fdt_next_node(fit, noffset, &ndepth)) {
 578                 if (ndepth == 1) {
 579                         /* Direct child node of the component image node */
 580                         fit_image_print_verification_data(fit, noffset, p);
 581                 }
 582         }
 583 }
 584
 585 /**
 586  * fit_get_desc - get node description property
 587  * @fit: pointer to the FIT format image header
 588  * @noffset: node offset
 589  * @desc: double pointer to the char, will hold pointer to the description
 590  *
 591  * fit_get_desc() reads description property from a given node, if
 592  * description is found pointer to it is returned in third call argument.
 593  *
 594  * returns:
 595  *     0, on success
 596  *     -1, on failure
 597  */
 598 int fit_get_desc(const void *fit, int noffset, char **desc)
 599 {
 600         int len;
 601
 602         *desc = (char *)fdt_getprop(fit, noffset, FIT_DESC_PROP, &len);
 603         if (*desc == NULL) {
 604                 fit_get_debug(fit, noffset, FIT_DESC_PROP, len);
 605                 return -1;
 606         }
 607
 608         return 0;
 609 }
 610
 611 /**
 612  * fit_get_timestamp - get node timestamp property
 613  * @fit: pointer to the FIT format image header
 614  * @noffset: node offset
 615  * @timestamp: pointer to the time_t, will hold read timestamp
 616  *
 617  * fit_get_timestamp() reads timestamp property from given node, if timestamp
 618  * is found and has a correct size its value is returned in third call
 619  * argument.
 620  *
 621  * returns:
 622  *     0, on success
 623  *     -1, on property read failure
 624  *     -2, on wrong timestamp size
 625  */
 626 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp)
 627 {
 628         int len;
 629         const void *data;
 630
 631         data = fdt_getprop(fit, noffset, FIT_TIMESTAMP_PROP, &len);
 632         if (data == NULL) {
 633                 fit_get_debug(fit, noffset, FIT_TIMESTAMP_PROP, len);
 634                 return -1;
 635         }
 636         if (len != sizeof(uint32_t)) {
 637                 debug("FIT timestamp with incorrect size of (%u)\n", len);
 638                 return -2;
 639         }
 640
 641         *timestamp = uimage_to_cpu(*((uint32_t *)data));
 642         return 0;
 643 }
 644
 645 /**
 646  * fit_image_get_node - get node offset for component image of a given unit name
 647  * @fit: pointer to the FIT format image header
 648  * @image_uname: component image node unit name
 649  *
 650  * fit_image_get_node() finds a component image (within the '/images'
 651  * node) of a provided unit name. If image is found its node offset is
 652  * returned to the caller.
 653  *
 654  * returns:
 655  *     image node offset when found (>=0)
 656  *     negative number on failure (FDT_ERR_* code)
 657  */
 658 int fit_image_get_node(const void *fit, const char *image_uname)
 659 {
 660         int noffset, images_noffset;
 661
 662         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
 663         if (images_noffset < 0) {
 664                 debug("Can't find images parent node '%s' (%s)\n",
 665                       FIT_IMAGES_PATH, fdt_strerror(images_noffset));
 666                 return images_noffset;
 667         }
 668
 669         noffset = fdt_subnode_offset(fit, images_noffset, image_uname);
 670         if (noffset < 0) {
 671                 debug("Can't get node offset for image unit name: '%s' (%s)\n",
 672                       image_uname, fdt_strerror(noffset));
 673         }
 674
 675         return noffset;
 676 }
 677
 678 /**
 679  * fit_image_get_os - get os id for a given component image node
 680  * @fit: pointer to the FIT format image header
 681  * @noffset: component image node offset
 682  * @os: pointer to the uint8_t, will hold os numeric id
 683  *
 684  * fit_image_get_os() finds os property in a given component image node.
 685  * If the property is found, its (string) value is translated to the numeric
 686  * id which is returned to the caller.
 687  *
 688  * returns:
 689  *     0, on success
 690  *     -1, on failure
 691  */
 692 int fit_image_get_os(const void *fit, int noffset, uint8_t *os)
 693 {
 694         int len;
 695         const void *data;
 696
 697         /* Get OS name from property data */
 698         data = fdt_getprop(fit, noffset, FIT_OS_PROP, &len);
 699         if (data == NULL) {
 700                 fit_get_debug(fit, noffset, FIT_OS_PROP, len);
 701                 *os = -1;
 702                 return -1;
 703         }
 704
 705         /* Translate OS name to id */
 706         *os = genimg_get_os_id(data);
 707         return 0;
 708 }
 709
 710 /**
 711  * fit_image_get_arch - get arch id for a given component image node
 712  * @fit: pointer to the FIT format image header
 713  * @noffset: component image node offset
 714  * @arch: pointer to the uint8_t, will hold arch numeric id
 715  *
 716  * fit_image_get_arch() finds arch property in a given component image node.
 717  * If the property is found, its (string) value is translated to the numeric
 718  * id which is returned to the caller.
 719  *
 720  * returns:
 721  *     0, on success
 722  *     -1, on failure
 723  */
 724 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch)
 725 {
 726         int len;
 727         const void *data;
 728
 729         /* Get architecture name from property data */
 730         data = fdt_getprop(fit, noffset, FIT_ARCH_PROP, &len);
 731         if (data == NULL) {
 732                 fit_get_debug(fit, noffset, FIT_ARCH_PROP, len);
 733                 *arch = -1;
 734                 return -1;
 735         }
 736
 737         /* Translate architecture name to id */
 738         *arch = genimg_get_arch_id(data);
 739         return 0;
 740 }
 741
 742 /**
 743  * fit_image_get_type - get type id for a given component image node
 744  * @fit: pointer to the FIT format image header
 745  * @noffset: component image node offset
 746  * @type: pointer to the uint8_t, will hold type numeric id
 747  *
 748  * fit_image_get_type() finds type property in a given component image node.
 749  * If the property is found, its (string) value is translated to the numeric
 750  * id which is returned to the caller.
 751  *
 752  * returns:
 753  *     0, on success
 754  *     -1, on failure
 755  */
 756 int fit_image_get_type(const void *fit, int noffset, uint8_t *type)
 757 {
 758         int len;
 759         const void *data;
 760
 761         /* Get image type name from property data */
 762         data = fdt_getprop(fit, noffset, FIT_TYPE_PROP, &len);
 763         if (data == NULL) {
 764                 fit_get_debug(fit, noffset, FIT_TYPE_PROP, len);
 765                 *type = -1;
 766                 return -1;
 767         }
 768
 769         /* Translate image type name to id */
 770         *type = genimg_get_type_id(data);
 771         return 0;
 772 }
 773
 774 /**
 775  * fit_image_get_comp - get comp id for a given component image node
 776  * @fit: pointer to the FIT format image header
 777  * @noffset: component image node offset
 778  * @comp: pointer to the uint8_t, will hold comp numeric id
 779  *
 780  * fit_image_get_comp() finds comp property in a given component image node.
 781  * If the property is found, its (string) value is translated to the numeric
 782  * id which is returned to the caller.
 783  *
 784  * returns:
 785  *     0, on success
 786  *     -1, on failure
 787  */
 788 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp)
 789 {
 790         int len;
 791         const void *data;
 792
 793         /* Get compression name from property data */
 794         data = fdt_getprop(fit, noffset, FIT_COMP_PROP, &len);
 795         if (data == NULL) {
 796                 fit_get_debug(fit, noffset, FIT_COMP_PROP, len);
 797                 return -1;
 798         }
 799
 800         /* Translate compression name to id */
 801         *comp = genimg_get_comp_id(data);
 802         return 0;
 803 }
 804
 805 static int fit_image_get_address(const void *fit, int noffset, char *name,
 806                           ulong *load)
 807 {
 808         int len, cell_len;
 809         const fdt32_t *cell;
 810         uint64_t load64 = 0;
 811
 812         cell = fdt_getprop(fit, noffset, name, &len);
 813         if (cell == NULL) {
 814                 fit_get_debug(fit, noffset, name, len);
 815                 return -1;
 816         }
 817
 818         cell_len = len >> 2;
 819         /* Use load64 to avoid compiling warning for 32-bit target */
 820         while (cell_len--) {
 821                 load64 = (load64 << 32) | uimage_to_cpu(*cell);
 822                 cell++;
 823         }
 824
 825         if (len > sizeof(ulong) && (uint32_t)(load64 >> 32)) {
 826                 printf("Unsupported %s address size\n", name);
 827                 return -1;
 828         }
 829
 830         *load = (ulong)load64;
 831
 832         return 0;
 833 }
 834 /**
 835  * fit_image_get_load() - get load addr property for given component image node
 836  * @fit: pointer to the FIT format image header
 837  * @noffset: component image node offset
 838  * @load: pointer to the uint32_t, will hold load address
 839  *
 840  * fit_image_get_load() finds load address property in a given component
 841  * image node. If the property is found, its value is returned to the caller.
 842  *
 843  * returns:
 844  *     0, on success
 845  *     -1, on failure
 846  */
 847 int fit_image_get_load(const void *fit, int noffset, ulong *load)
 848 {
 849         return fit_image_get_address(fit, noffset, FIT_LOAD_PROP, load);
 850 }
 851
 852 /**
 853  * fit_image_get_entry() - get entry point address property
 854  * @fit: pointer to the FIT format image header
 855  * @noffset: component image node offset
 856  * @entry: pointer to the uint32_t, will hold entry point address
 857  *
 858  * This gets the entry point address property for a given component image
 859  * node.
 860  *
 861  * fit_image_get_entry() finds entry point address property in a given
 862  * component image node.  If the property is found, its value is returned
 863  * to the caller.
 864  *
 865  * returns:
 866  *     0, on success
 867  *     -1, on failure
 868  */
 869 int fit_image_get_entry(const void *fit, int noffset, ulong *entry)
 870 {
 871         return fit_image_get_address(fit, noffset, FIT_ENTRY_PROP, entry);
 872 }
 873
 874 /**
 875  * fit_image_get_data - get data property and its size for a given component image node
 876  * @fit: pointer to the FIT format image header
 877  * @noffset: component image node offset
 878  * @data: double pointer to void, will hold data property's data address
 879  * @size: pointer to size_t, will hold data property's data size
 880  *
 881  * fit_image_get_data() finds data property in a given component image node.
 882  * If the property is found its data start address and size are returned to
 883  * the caller.
 884  *
 885  * returns:
 886  *     0, on success
 887  *     -1, on failure
 888  */
 889 int fit_image_get_data(const void *fit, int noffset,
 890                 const void **data, size_t *size)
 891 {
 892         int len;
 893
 894         *data = fdt_getprop(fit, noffset, FIT_DATA_PROP, &len);
 895         if (*data == NULL) {
 896                 fit_get_debug(fit, noffset, FIT_DATA_PROP, len);
 897                 *size = 0;
 898                 return -1;
 899         }
 900
 901         *size = len;
 902         return 0;
 903 }
 904
 905 /**
 906  * Get 'data-offset' property from a given image node.
 907  *
 908  * @fit: pointer to the FIT image header
 909  * @noffset: component image node offset
 910  * @data_offset: holds the data-offset property
 911  *
 912  * returns:
 913  *     0, on success
 914  *     -ENOENT if the property could not be found
 915  */
 916 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset)
 917 {
 918         const fdt32_t *val;
 919
 920         val = fdt_getprop(fit, noffset, FIT_DATA_OFFSET_PROP, NULL);
 921         if (!val)
 922                 return -ENOENT;
 923
 924         *data_offset = fdt32_to_cpu(*val);
 925
 926         return 0;
 927 }
 928
 929 /**
 930  * Get 'data-position' property from a given image node.
 931  *
 932  * @fit: pointer to the FIT image header
 933  * @noffset: component image node offset
 934  * @data_position: holds the data-position property
 935  *
 936  * returns:
 937  *     0, on success
 938  *     -ENOENT if the property could not be found
 939  */
 940 int fit_image_get_data_position(const void *fit, int noffset,
 941                                 int *data_position)
 942 {
 943         const fdt32_t *val;
 944
 945         val = fdt_getprop(fit, noffset, FIT_DATA_POSITION_PROP, NULL);
 946         if (!val)
 947                 return -ENOENT;
 948
 949         *data_position = fdt32_to_cpu(*val);
 950
 951         return 0;
 952 }
 953
 954 /**
 955  * Get 'data-size' property from a given image node.
 956  *
 957  * @fit: pointer to the FIT image header
 958  * @noffset: component image node offset
 959  * @data_size: holds the data-size property
 960  *
 961  * returns:
 962  *     0, on success
 963  *     -ENOENT if the property could not be found
 964  */
 965 int fit_image_get_data_size(const void *fit, int noffset, int *data_size)
 966 {
 967         const fdt32_t *val;
 968
 969         val = fdt_getprop(fit, noffset, FIT_DATA_SIZE_PROP, NULL);
 970         if (!val)
 971                 return -ENOENT;
 972
 973         *data_size = fdt32_to_cpu(*val);
 974
 975         return 0;
 976 }
 977
 978 /**
 979  * Get 'data-size-unciphered' property from a given image node.
 980  *
 981  * @fit: pointer to the FIT image header
 982  * @noffset: component image node offset
 983  * @data_size: holds the data-size property
 984  *
 985  * returns:
 986  *     0, on success
 987  *     -ENOENT if the property could not be found
 988  */
 989 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
 990                                        size_t *data_size)
 991 {
 992         const fdt32_t *val;
 993
 994         val = fdt_getprop(fit, noffset, "data-size-unciphered", NULL);
 995         if (!val)
 996                 return -ENOENT;
 997
 998         *data_size = (size_t)fdt32_to_cpu(*val);
 999
1000         return 0;
1001 }
1002
1003 /**
1004  * fit_image_get_data_and_size - get data and its size including
1005  *                               both embedded and external data
1006  * @fit: pointer to the FIT format image header
1007  * @noffset: component image node offset
1008  * @data: double pointer to void, will hold data property's data address
1009  * @size: pointer to size_t, will hold data property's data size
1010  *
1011  * fit_image_get_data_and_size() finds data and its size including
1012  * both embedded and external data. If the property is found
1013  * its data start address and size are returned to the caller.
1014  *
1015  * returns:
1016  *     0, on success
1017  *     otherwise, on failure
1018  */
1019 int fit_image_get_data_and_size(const void *fit, int noffset,
1020                                 const void **data, size_t *size)
1021 {
1022         bool external_data = false;
1023         int offset;
1024         int len;
1025         int ret;
1026
1027         if (!fit_image_get_data_position(fit, noffset, &offset)) {
1028                 external_data = true;
1029         } else if (!fit_image_get_data_offset(fit, noffset, &offset)) {
1030                 external_data = true;
1031                 /*
1032                  * For FIT with external data, figure out where
1033                  * the external images start. This is the base
1034                  * for the data-offset properties in each image.
1035                  */
1036                 offset += ((fdt_totalsize(fit) + 3) & ~3);
1037         }
1038
1039         if (external_data) {
1040                 debug("External Data\n");
1041                 ret = fit_image_get_data_size(fit, noffset, &len);
1042                 if (!ret) {
1043                         *data = fit + offset;
1044                         *size = len;
1045                 }
1046         } else {
1047                 ret = fit_image_get_data(fit, noffset, data, size);
1048         }
1049
1050         return ret;
1051 }
1052
1053 /**
1054  * fit_image_hash_get_algo - get hash algorithm name
1055  * @fit: pointer to the FIT format image header
1056  * @noffset: hash node offset
1057  * @algo: double pointer to char, will hold pointer to the algorithm name
1058  *
1059  * fit_image_hash_get_algo() finds hash algorithm property in a given hash node.
1060  * If the property is found its data start address is returned to the caller.
1061  *
1062  * returns:
1063  *     0, on success
1064  *     -1, on failure
1065  */
1066 int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo)
1067 {
1068         int len;
1069
1070         *algo = (const char *)fdt_getprop(fit, noffset, FIT_ALGO_PROP, &len);
1071         if (*algo == NULL) {
1072                 fit_get_debug(fit, noffset, FIT_ALGO_PROP, len);
1073                 return -1;
1074         }
1075
1076         return 0;
1077 }
1078
1079 /**
1080  * fit_image_hash_get_value - get hash value and length
1081  * @fit: pointer to the FIT format image header
1082  * @noffset: hash node offset
1083  * @value: double pointer to uint8_t, will hold address of a hash value data
1084  * @value_len: pointer to an int, will hold hash data length
1085  *
1086  * fit_image_hash_get_value() finds hash value property in a given hash node.
1087  * If the property is found its data start address and size are returned to
1088  * the caller.
1089  *
1090  * returns:
1091  *     0, on success
1092  *     -1, on failure
1093  */
1094 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1095                                 int *value_len)
1096 {
1097         int len;
1098
1099         *value = (uint8_t *)fdt_getprop(fit, noffset, FIT_VALUE_PROP, &len);
1100         if (*value == NULL) {
1101                 fit_get_debug(fit, noffset, FIT_VALUE_PROP, len);
1102                 *value_len = 0;
1103                 return -1;
1104         }
1105
1106         *value_len = len;
1107         return 0;
1108 }
1109
1110 /**
1111  * fit_image_hash_get_ignore - get hash ignore flag
1112  * @fit: pointer to the FIT format image header
1113  * @noffset: hash node offset
1114  * @ignore: pointer to an int, will hold hash ignore flag
1115  *
1116  * fit_image_hash_get_ignore() finds hash ignore property in a given hash node.
1117  * If the property is found and non-zero, the hash algorithm is not verified by
1118  * u-boot automatically.
1119  *
1120  * returns:
1121  *     0, on ignore not found
1122  *     value, on ignore found
1123  */
1124 static int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore)
1125 {
1126         int len;
1127         int *value;
1128
1129         value = (int *)fdt_getprop(fit, noffset, FIT_IGNORE_PROP, &len);
1130         if (value == NULL || len != sizeof(int))
1131                 *ignore = 0;
1132         else
1133                 *ignore = *value;
1134
1135         return 0;
1136 }
1137
1138 /**
1139  * fit_image_cipher_get_algo - get cipher algorithm name
1140  * @fit: pointer to the FIT format image header
1141  * @noffset: cipher node offset
1142  * @algo: double pointer to char, will hold pointer to the algorithm name
1143  *
1144  * fit_image_cipher_get_algo() finds cipher algorithm property in a given
1145  * cipher node. If the property is found its data start address is returned
1146  * to the caller.
1147  *
1148  * returns:
1149  *     0, on success
1150  *     -1, on failure
1151  */
1152 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo)
1153 {
1154         int len;
1155
1156         *algo = (char *)fdt_getprop(fit, noffset, FIT_ALGO_PROP, &len);
1157         if (!*algo) {
1158                 fit_get_debug(fit, noffset, FIT_ALGO_PROP, len);
1159                 return -1;
1160         }
1161
1162         return 0;
1163 }
1164
1165 ulong fit_get_end(const void *fit)
1166 {
1167         return map_to_sysmem((void *)(fit + fdt_totalsize(fit)));
1168 }
1169
1170 /**
1171  * fit_set_timestamp - set node timestamp property
1172  * @fit: pointer to the FIT format image header
1173  * @noffset: node offset
1174  * @timestamp: timestamp value to be set
1175  *
1176  * fit_set_timestamp() attempts to set timestamp property in the requested
1177  * node and returns operation status to the caller.
1178  *
1179  * returns:
1180  *     0, on success
1181  *     -ENOSPC if no space in device tree, -1 for other error
1182  */
1183 int fit_set_timestamp(void *fit, int noffset, time_t timestamp)
1184 {
1185         uint32_t t;
1186         int ret;
1187
1188         t = cpu_to_uimage(timestamp);
1189         ret = fdt_setprop(fit, noffset, FIT_TIMESTAMP_PROP, &t,
1190                                 sizeof(uint32_t));
1191         if (ret) {
1192                 debug("Can't set '%s' property for '%s' node (%s)\n",
1193                       FIT_TIMESTAMP_PROP, fit_get_name(fit, noffset, NULL),
1194                       fdt_strerror(ret));
1195                 return ret == -FDT_ERR_NOSPACE ? -ENOSPC : -1;
1196         }
1197
1198         return 0;
1199 }
1200
1201 /**
1202  * calculate_hash - calculate and return hash for provided input data
1203  * @data: pointer to the input data
1204  * @data_len: data length
1205  * @name: requested hash algorithm name
1206  * @value: pointer to the char, will hold hash value data (caller must
1207  * allocate enough free space)
1208  * value_len: length of the calculated hash
1209  *
1210  * calculate_hash() computes input data hash according to the requested
1211  * algorithm.
1212  * Resulting hash value is placed in caller provided 'value' buffer, length
1213  * of the calculated hash is returned via value_len pointer argument.
1214  *
1215  * returns:
1216  *     0, on success
1217  *    -1, when algo is unsupported
1218  */
1219 int calculate_hash(const void *data, int data_len, const char *name,
1220                         uint8_t *value, int *value_len)
1221 {
1222 #if !defined(USE_HOSTCC) && defined(CONFIG_DM_HASH)
1223         int rc;
1224         enum HASH_ALGO hash_algo;
1225         struct udevice *dev;
1226
1227         rc = uclass_get_device(UCLASS_HASH, 0, &dev);
1228         if (rc) {
1229                 debug("failed to get hash device, rc=%d\n", rc);
1230                 return -1;
1231         }
1232
1233         hash_algo = hash_algo_lookup_by_name(name);
1234         if (hash_algo == HASH_ALGO_INVALID) {
1235                 debug("Unsupported hash algorithm\n");
1236                 return -1;
1237         };
1238
1239         rc = hash_digest_wd(dev, hash_algo, data, data_len, value, CHUNKSZ);
1240         if (rc) {
1241                 debug("failed to get hash value, rc=%d\n", rc);
1242                 return -1;
1243         }
1244
1245         *value_len = hash_algo_digest_size(hash_algo);
1246 #else
1247         struct hash_algo *algo;
1248         int ret;
1249
1250         ret = hash_lookup_algo(name, &algo);
1251         if (ret < 0) {
1252                 debug("Unsupported hash alogrithm\n");
1253                 return -1;
1254         }
1255
1256         algo->hash_func_ws(data, data_len, value, algo->chunk_size);
1257         *value_len = algo->digest_size;
1258 #endif
1259
1260         return 0;
1261 }
1262
1263 static int fit_image_check_hash(const void *fit, int noffset, const void *data,
1264                                 size_t size, char **err_msgp)
1265 {
1266         ALLOC_CACHE_ALIGN_BUFFER(uint8_t, value, FIT_MAX_HASH_LEN);
1267         int value_len;
1268         const char *algo;
1269         uint8_t *fit_value;
1270         int fit_value_len;
1271         int ignore;
1272
1273         *err_msgp = NULL;
1274
1275         if (fit_image_hash_get_algo(fit, noffset, &algo)) {
1276                 *err_msgp = "Can't get hash algo property";
1277                 return -1;
1278         }
1279         printf("%s", algo);
1280
1281         if (!tools_build()) {
1282                 fit_image_hash_get_ignore(fit, noffset, &ignore);
1283                 if (ignore) {
1284                         printf("-skipped ");
1285                         return 0;
1286                 }
1287         }
1288
1289         if (fit_image_hash_get_value(fit, noffset, &fit_value,
1290                                      &fit_value_len)) {
1291                 *err_msgp = "Can't get hash value property";
1292                 return -1;
1293         }
1294
1295         if (calculate_hash(data, size, algo, value, &value_len)) {
1296                 *err_msgp = "Unsupported hash algorithm";
1297                 return -1;
1298         }
1299
1300         if (value_len != fit_value_len) {
1301                 *err_msgp = "Bad hash value len";
1302                 return -1;
1303         } else if (memcmp(value, fit_value, value_len) != 0) {
1304                 *err_msgp = "Bad hash value";
1305                 return -1;
1306         }
1307
1308         return 0;
1309 }
1310
1311 int fit_image_verify_with_data(const void *fit, int image_noffset,
1312                                const void *key_blob, const void *data,
1313                                size_t size)
1314 {
1315         int             noffset = 0;
1316         char            *err_msg = "";
1317         int verify_all = 1;
1318         int ret;
1319
1320         /* Verify all required signatures */
1321         if (FIT_IMAGE_ENABLE_VERIFY &&
1322             fit_image_verify_required_sigs(fit, image_noffset, data, size,
1323                                            key_blob, &verify_all)) {
1324                 err_msg = "Unable to verify required signature";
1325                 goto error;
1326         }
1327
1328         /* Process all hash subnodes of the component image node */
1329         fdt_for_each_subnode(noffset, fit, image_noffset) {
1330                 const char *name = fit_get_name(fit, noffset, NULL);
1331
1332                 /*
1333                  * Check subnode name, must be equal to "hash".
1334                  * Multiple hash nodes require unique unit node
1335                  * names, e.g. hash-1, hash-2, etc.
1336                  */
1337                 if (!strncmp(name, FIT_HASH_NODENAME,
1338                              strlen(FIT_HASH_NODENAME))) {
1339                         if (fit_image_check_hash(fit, noffset, data, size,
1340                                                  &err_msg))
1341                                 goto error;
1342                         puts("+ ");
1343                 } else if (FIT_IMAGE_ENABLE_VERIFY && verify_all &&
1344                                 !strncmp(name, FIT_SIG_NODENAME,
1345                                         strlen(FIT_SIG_NODENAME))) {
1346                         ret = fit_image_check_sig(fit, noffset, data, size,
1347                                                   gd_fdt_blob(), -1, &err_msg);
1348
1349                         /*
1350                          * Show an indication on failure, but do not return
1351                          * an error. Only keys marked 'required' can cause
1352                          * an image validation failure. See the call to
1353                          * fit_image_verify_required_sigs() above.
1354                          */
1355                         if (ret)
1356                                 puts("- ");
1357                         else
1358                                 puts("+ ");
1359                 }
1360         }
1361
1362         if (noffset == -FDT_ERR_TRUNCATED || noffset == -FDT_ERR_BADSTRUCTURE) {
1363                 err_msg = "Corrupted or truncated tree";
1364                 goto error;
1365         }
1366
1367         return 1;
1368
1369 error:
1370         printf(" error!\n%s for '%s' hash node in '%s' image node\n",
1371                err_msg, fit_get_name(fit, noffset, NULL),
1372                fit_get_name(fit, image_noffset, NULL));
1373         return 0;
1374 }
1375
1376 /**
1377  * fit_image_verify - verify data integrity
1378  * @fit: pointer to the FIT format image header
1379  * @image_noffset: component image node offset
1380  *
1381  * fit_image_verify() goes over component image hash nodes,
1382  * re-calculates each data hash and compares with the value stored in hash
1383  * node.
1384  *
1385  * returns:
1386  *     1, if all hashes are valid
1387  *     0, otherwise (or on error)
1388  */
1389 int fit_image_verify(const void *fit, int image_noffset)
1390 {
1391         const char *name = fit_get_name(fit, image_noffset, NULL);
1392         const void      *data;
1393         size_t          size;
1394         char            *err_msg = "";
1395
1396         if (IS_ENABLED(CONFIG_FIT_SIGNATURE) && strchr(name, '@')) {
1397                 /*
1398                  * We don't support this since libfdt considers names with the
1399                  * name root but different @ suffix to be equal
1400                  */
1401                 err_msg = "Node name contains @";
1402                 goto err;
1403         }
1404         /* Get image data and data length */
1405         if (fit_image_get_data_and_size(fit, image_noffset, &data, &size)) {
1406                 err_msg = "Can't get image data/size";
1407                 goto err;
1408         }
1409
1410         return fit_image_verify_with_data(fit, image_noffset, gd_fdt_blob(),
1411                                           data, size);
1412
1413 err:
1414         printf("error!\n%s in '%s' image node\n", err_msg,
1415                fit_get_name(fit, image_noffset, NULL));
1416         return 0;
1417 }
1418
1419 /**
1420  * fit_all_image_verify - verify data integrity for all images
1421  * @fit: pointer to the FIT format image header
1422  *
1423  * fit_all_image_verify() goes over all images in the FIT and
1424  * for every images checks if all it's hashes are valid.
1425  *
1426  * returns:
1427  *     1, if all hashes of all images are valid
1428  *     0, otherwise (or on error)
1429  */
1430 int fit_all_image_verify(const void *fit)
1431 {
1432         int images_noffset;
1433         int noffset;
1434         int ndepth;
1435         int count;
1436
1437         /* Find images parent node offset */
1438         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1439         if (images_noffset < 0) {
1440                 printf("Can't find images parent node '%s' (%s)\n",
1441                        FIT_IMAGES_PATH, fdt_strerror(images_noffset));
1442                 return 0;
1443         }
1444
1445         /* Process all image subnodes, check hashes for each */
1446         printf("## Checking hash(es) for FIT Image at %08lx ...\n",
1447                (ulong)fit);
1448         for (ndepth = 0, count = 0,
1449              noffset = fdt_next_node(fit, images_noffset, &ndepth);
1450                         (noffset >= 0) && (ndepth > 0);
1451                         noffset = fdt_next_node(fit, noffset, &ndepth)) {
1452                 if (ndepth == 1) {
1453                         /*
1454                          * Direct child node of the images parent node,
1455                          * i.e. component image node.
1456                          */
1457                         printf("   Hash(es) for Image %u (%s): ", count,
1458                                fit_get_name(fit, noffset, NULL));
1459                         count++;
1460
1461                         if (!fit_image_verify(fit, noffset))
1462                                 return 0;
1463                         printf("\n");
1464                 }
1465         }
1466         return 1;
1467 }
1468
1469 static int fit_image_uncipher(const void *fit, int image_noffset,
1470                               void **data, size_t *size)
1471 {
1472         int cipher_noffset, ret;
1473         void *dst;
1474         size_t size_dst;
1475
1476         cipher_noffset = fdt_subnode_offset(fit, image_noffset,
1477                                             FIT_CIPHER_NODENAME);
1478         if (cipher_noffset < 0)
1479                 return 0;
1480
1481         ret = fit_image_decrypt_data(fit, image_noffset, cipher_noffset,
1482                                      *data, *size, &dst, &size_dst);
1483         if (ret)
1484                 goto out;
1485
1486         *data = dst;
1487         *size = size_dst;
1488
1489  out:
1490         return ret;
1491 }
1492
1493 /**
1494  * fit_image_check_os - check whether image node is of a given os type
1495  * @fit: pointer to the FIT format image header
1496  * @noffset: component image node offset
1497  * @os: requested image os
1498  *
1499  * fit_image_check_os() reads image os property and compares its numeric
1500  * id with the requested os. Comparison result is returned to the caller.
1501  *
1502  * returns:
1503  *     1 if image is of given os type
1504  *     0 otherwise (or on error)
1505  */
1506 int fit_image_check_os(const void *fit, int noffset, uint8_t os)
1507 {
1508         uint8_t image_os;
1509
1510         if (fit_image_get_os(fit, noffset, &image_os))
1511                 return 0;
1512         return (os == image_os);
1513 }
1514
1515 /**
1516  * fit_image_check_arch - check whether image node is of a given arch
1517  * @fit: pointer to the FIT format image header
1518  * @noffset: component image node offset
1519  * @arch: requested imagearch
1520  *
1521  * fit_image_check_arch() reads image arch property and compares its numeric
1522  * id with the requested arch. Comparison result is returned to the caller.
1523  *
1524  * returns:
1525  *     1 if image is of given arch
1526  *     0 otherwise (or on error)
1527  */
1528 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch)
1529 {
1530         uint8_t image_arch;
1531         int aarch32_support = 0;
1532
1533         /* Let's assume that sandbox can load any architecture */
1534         if (IS_ENABLED(CONFIG_SANDBOX))
1535                 return true;
1536
1537         if (IS_ENABLED(CONFIG_ARM64_SUPPORT_AARCH32))
1538                 aarch32_support = 1;
1539
1540         if (fit_image_get_arch(fit, noffset, &image_arch))
1541                 return 0;
1542         return (arch == image_arch) ||
1543                 (arch == IH_ARCH_I386 && image_arch == IH_ARCH_X86_64) ||
1544                 (arch == IH_ARCH_ARM64 && image_arch == IH_ARCH_ARM &&
1545                  aarch32_support);
1546 }
1547
1548 /**
1549  * fit_image_check_type - check whether image node is of a given type
1550  * @fit: pointer to the FIT format image header
1551  * @noffset: component image node offset
1552  * @type: requested image type
1553  *
1554  * fit_image_check_type() reads image type property and compares its numeric
1555  * id with the requested type. Comparison result is returned to the caller.
1556  *
1557  * returns:
1558  *     1 if image is of given type
1559  *     0 otherwise (or on error)
1560  */
1561 int fit_image_check_type(const void *fit, int noffset, uint8_t type)
1562 {
1563         uint8_t image_type;
1564
1565         if (fit_image_get_type(fit, noffset, &image_type))
1566                 return 0;
1567         return (type == image_type);
1568 }
1569
1570 /**
1571  * fit_image_check_comp - check whether image node uses given compression
1572  * @fit: pointer to the FIT format image header
1573  * @noffset: component image node offset
1574  * @comp: requested image compression type
1575  *
1576  * fit_image_check_comp() reads image compression property and compares its
1577  * numeric id with the requested compression type. Comparison result is
1578  * returned to the caller.
1579  *
1580  * returns:
1581  *     1 if image uses requested compression
1582  *     0 otherwise (or on error)
1583  */
1584 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp)
1585 {
1586         uint8_t image_comp;
1587
1588         if (fit_image_get_comp(fit, noffset, &image_comp))
1589                 return 0;
1590         return (comp == image_comp);
1591 }
1592
1593 /**
1594  * fdt_check_no_at() - Check for nodes whose names contain '@'
1595  *
1596  * This checks the parent node and all subnodes recursively
1597  *
1598  * @fit: FIT to check
1599  * @parent: Parent node to check
1600  * Return: 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@'
1601  */
1602 static int fdt_check_no_at(const void *fit, int parent)
1603 {
1604         const char *name;
1605         int node;
1606         int ret;
1607
1608         name = fdt_get_name(fit, parent, NULL);
1609         if (!name || strchr(name, '@'))
1610                 return -EADDRNOTAVAIL;
1611
1612         fdt_for_each_subnode(node, fit, parent) {
1613                 ret = fdt_check_no_at(fit, node);
1614                 if (ret)
1615                         return ret;
1616         }
1617
1618         return 0;
1619 }
1620
1621 int fit_check_format(const void *fit, ulong size)
1622 {
1623         int ret;
1624
1625         /* A FIT image must be a valid FDT */
1626         ret = fdt_check_header(fit);
1627         if (ret) {
1628                 log_debug("Wrong FIT format: not a flattened device tree (err=%d)\n",
1629                           ret);
1630                 return -ENOEXEC;
1631         }
1632
1633         if (CONFIG_IS_ENABLED(FIT_FULL_CHECK)) {
1634                 /*
1635                  * If we are not given the size, make do wtih calculating it.
1636                  * This is not as secure, so we should consider a flag to
1637                  * control this.
1638                  */
1639                 if (size == IMAGE_SIZE_INVAL)
1640                         size = fdt_totalsize(fit);
1641                 ret = fdt_check_full(fit, size);
1642                 if (ret)
1643                         ret = -EINVAL;
1644
1645                 /*
1646                  * U-Boot stopped using unit addressed in 2017. Since libfdt
1647                  * can match nodes ignoring any unit address, signature
1648                  * verification can see the wrong node if one is inserted with
1649                  * the same name as a valid node but with a unit address
1650                  * attached. Protect against this by disallowing unit addresses.
1651                  */
1652                 if (!ret && CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
1653                         ret = fdt_check_no_at(fit, 0);
1654
1655                         if (ret) {
1656                                 log_debug("FIT check error %d\n", ret);
1657                                 return ret;
1658                         }
1659                 }
1660                 if (ret) {
1661                         log_debug("FIT check error %d\n", ret);
1662                         return ret;
1663                 }
1664         }
1665
1666         /* mandatory / node 'description' property */
1667         if (!fdt_getprop(fit, 0, FIT_DESC_PROP, NULL)) {
1668                 log_debug("Wrong FIT format: no description\n");
1669                 return -ENOMSG;
1670         }
1671
1672         if (IMAGE_ENABLE_TIMESTAMP) {
1673                 /* mandatory / node 'timestamp' property */
1674                 if (!fdt_getprop(fit, 0, FIT_TIMESTAMP_PROP, NULL)) {
1675                         log_debug("Wrong FIT format: no timestamp\n");
1676                         return -EBADMSG;
1677                 }
1678         }
1679
1680         /* mandatory subimages parent '/images' node */
1681         if (fdt_path_offset(fit, FIT_IMAGES_PATH) < 0) {
1682                 log_debug("Wrong FIT format: no images parent node\n");
1683                 return -ENOENT;
1684         }
1685
1686         return 0;
1687 }
1688
1689 int fit_conf_find_compat(const void *fit, const void *fdt)
1690 {
1691         int ndepth = 0;
1692         int noffset, confs_noffset, images_noffset;
1693         const void *fdt_compat;
1694         int fdt_compat_len;
1695         int best_match_offset = 0;
1696         int best_match_pos = 0;
1697
1698         confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1699         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1700         if (confs_noffset < 0 || images_noffset < 0) {
1701                 debug("Can't find configurations or images nodes.\n");
1702                 return -1;
1703         }
1704
1705         fdt_compat = fdt_getprop(fdt, 0, "compatible", &fdt_compat_len);
1706         if (!fdt_compat) {
1707                 debug("Fdt for comparison has no \"compatible\" property.\n");
1708                 return -1;
1709         }
1710
1711         /*
1712          * Loop over the configurations in the FIT image.
1713          */
1714         for (noffset = fdt_next_node(fit, confs_noffset, &ndepth);
1715                         (noffset >= 0) && (ndepth > 0);
1716                         noffset = fdt_next_node(fit, noffset, &ndepth)) {
1717                 const void *fdt;
1718                 const char *kfdt_name;
1719                 int kfdt_noffset, compat_noffset;
1720                 const char *cur_fdt_compat;
1721                 int len;
1722                 size_t sz;
1723                 int i;
1724
1725                 if (ndepth > 1)
1726                         continue;
1727
1728                 /* If there's a compat property in the config node, use that. */
1729                 if (fdt_getprop(fit, noffset, "compatible", NULL)) {
1730                         fdt = fit;                /* search in FIT image */
1731                         compat_noffset = noffset; /* search under config node */
1732                 } else {        /* Otherwise extract it from the kernel FDT. */
1733                         kfdt_name = fdt_getprop(fit, noffset, "fdt", &len);
1734                         if (!kfdt_name) {
1735                                 debug("No fdt property found.\n");
1736                                 continue;
1737                         }
1738                         kfdt_noffset = fdt_subnode_offset(fit, images_noffset,
1739                                                           kfdt_name);
1740                         if (kfdt_noffset < 0) {
1741                                 debug("No image node named \"%s\" found.\n",
1742                                       kfdt_name);
1743                                 continue;
1744                         }
1745
1746                         if (!fit_image_check_comp(fit, kfdt_noffset,
1747                                                   IH_COMP_NONE)) {
1748                                 debug("Can't extract compat from \"%s\" "
1749                                       "(compressed)\n", kfdt_name);
1750                                 continue;
1751                         }
1752
1753                         /* search in this config's kernel FDT */
1754                         if (fit_image_get_data_and_size(fit, kfdt_noffset,
1755                                                         &fdt, &sz)) {
1756                                 debug("Failed to get fdt \"%s\".\n", kfdt_name);
1757                                 continue;
1758                         }
1759
1760                         compat_noffset = 0;  /* search kFDT under root node */
1761                 }
1762
1763                 len = fdt_compat_len;
1764                 cur_fdt_compat = fdt_compat;
1765                 /*
1766                  * Look for a match for each U-Boot compatibility string in
1767                  * turn in the compat string property.
1768                  */
1769                 for (i = 0; len > 0 &&
1770                      (!best_match_offset || best_match_pos > i); i++) {
1771                         int cur_len = strlen(cur_fdt_compat) + 1;
1772
1773                         if (!fdt_node_check_compatible(fdt, compat_noffset,
1774                                                        cur_fdt_compat)) {
1775                                 best_match_offset = noffset;
1776                                 best_match_pos = i;
1777                                 break;
1778                         }
1779                         len -= cur_len;
1780                         cur_fdt_compat += cur_len;
1781                 }
1782         }
1783         if (!best_match_offset) {
1784                 debug("No match found.\n");
1785                 return -1;
1786         }
1787
1788         return best_match_offset;
1789 }
1790
1791 int fit_conf_get_node(const void *fit, const char *conf_uname)
1792 {
1793         int noffset, confs_noffset;
1794         int len;
1795         const char *s;
1796         char *conf_uname_copy = NULL;
1797
1798         confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1799         if (confs_noffset < 0) {
1800                 debug("Can't find configurations parent node '%s' (%s)\n",
1801                       FIT_CONFS_PATH, fdt_strerror(confs_noffset));
1802                 return confs_noffset;
1803         }
1804
1805         if (conf_uname == NULL) {
1806                 /* get configuration unit name from the default property */
1807                 debug("No configuration specified, trying default...\n");
1808                 if (!tools_build() && IS_ENABLED(CONFIG_MULTI_DTB_FIT)) {
1809                         noffset = fit_find_config_node(fit);
1810                         if (noffset < 0)
1811                                 return noffset;
1812                         conf_uname = fdt_get_name(fit, noffset, NULL);
1813                 } else {
1814                         conf_uname = (char *)fdt_getprop(fit, confs_noffset,
1815                                                          FIT_DEFAULT_PROP, &len);
1816                         if (conf_uname == NULL) {
1817                                 fit_get_debug(fit, confs_noffset, FIT_DEFAULT_PROP,
1818                                               len);
1819                                 return len;
1820                         }
1821                 }
1822                 debug("Found default configuration: '%s'\n", conf_uname);
1823         }
1824
1825         s = strchr(conf_uname, '#');
1826         if (s) {
1827                 len = s - conf_uname;
1828                 conf_uname_copy = malloc(len + 1);
1829                 if (!conf_uname_copy) {
1830                         debug("Can't allocate uname copy: '%s'\n",
1831                                         conf_uname);
1832                         return -ENOMEM;
1833                 }
1834                 memcpy(conf_uname_copy, conf_uname, len);
1835                 conf_uname_copy[len] = '\0';
1836                 conf_uname = conf_uname_copy;
1837         }
1838
1839         noffset = fdt_subnode_offset(fit, confs_noffset, conf_uname);
1840         if (noffset < 0) {
1841                 debug("Can't get node offset for configuration unit name: '%s' (%s)\n",
1842                       conf_uname, fdt_strerror(noffset));
1843         }
1844
1845         free(conf_uname_copy);
1846
1847         return noffset;
1848 }
1849
1850 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1851                 const char *prop_name)
1852 {
1853         return fdt_stringlist_count(fit, noffset, prop_name);
1854 }
1855
1856 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1857                 const char *prop_name, int index)
1858 {
1859         const char *uname;
1860         int len;
1861
1862         /* get kernel image unit name from configuration kernel property */
1863         uname = fdt_stringlist_get(fit, noffset, prop_name, index, &len);
1864         if (uname == NULL)
1865                 return len;
1866
1867         return fit_image_get_node(fit, uname);
1868 }
1869
1870 int fit_conf_get_prop_node(const void *fit, int noffset,
1871                 const char *prop_name)
1872 {
1873         return fit_conf_get_prop_node_index(fit, noffset, prop_name, 0);
1874 }
1875
1876 static int fit_get_data_tail(const void *fit, int noffset,
1877                              const void **data, size_t *size)
1878 {
1879         char *desc;
1880
1881         if (noffset < 0)
1882                 return noffset;
1883
1884         if (!fit_image_verify(fit, noffset))
1885                 return -EINVAL;
1886
1887         if (fit_image_get_data_and_size(fit, noffset, data, size))
1888                 return -ENOENT;
1889
1890         if (!fit_get_desc(fit, noffset, &desc))
1891                 printf("%s\n", desc);
1892
1893         return 0;
1894 }
1895
1896 int fit_get_data_node(const void *fit, const char *image_uname,
1897                       const void **data, size_t *size)
1898 {
1899         int noffset = fit_image_get_node(fit, image_uname);
1900
1901         return fit_get_data_tail(fit, noffset, data, size);
1902 }
1903
1904 int fit_get_data_conf_prop(const void *fit, const char *prop_name,
1905                            const void **data, size_t *size)
1906 {
1907         int noffset = fit_conf_get_node(fit, NULL);
1908
1909         noffset = fit_conf_get_prop_node(fit, noffset, prop_name);
1910         return fit_get_data_tail(fit, noffset, data, size);
1911 }
1912
1913 static int fit_image_select(const void *fit, int rd_noffset, int verify)
1914 {
1915         fit_image_print(fit, rd_noffset, "   ");
1916
1917         if (verify) {
1918                 puts("   Verifying Hash Integrity ... ");
1919                 if (!fit_image_verify(fit, rd_noffset)) {
1920                         puts("Bad Data Hash\n");
1921                         return -EACCES;
1922                 }
1923                 puts("OK\n");
1924         }
1925
1926         return 0;
1927 }
1928
1929 int fit_get_node_from_config(struct bootm_headers *images,
1930                              const char *prop_name, ulong addr)
1931 {
1932         int cfg_noffset;
1933         void *fit_hdr;
1934         int noffset;
1935
1936         debug("*  %s: using config '%s' from image at 0x%08lx\n",
1937               prop_name, images->fit_uname_cfg, addr);
1938
1939         /* Check whether configuration has this property defined */
1940         fit_hdr = map_sysmem(addr, 0);
1941         cfg_noffset = fit_conf_get_node(fit_hdr, images->fit_uname_cfg);
1942         if (cfg_noffset < 0) {
1943                 debug("*  %s: no such config\n", prop_name);
1944                 return -EINVAL;
1945         }
1946
1947         noffset = fit_conf_get_prop_node(fit_hdr, cfg_noffset, prop_name);
1948         if (noffset < 0) {
1949                 debug("*  %s: no '%s' in config\n", prop_name, prop_name);
1950                 return -ENOENT;
1951         }
1952
1953         return noffset;
1954 }
1955
1956 /**
1957  * fit_get_image_type_property() - get property name for IH_TYPE_...
1958  *
1959  * Return: the properly name where we expect to find the image in the
1960  * config node
1961  */
1962 static const char *fit_get_image_type_property(int type)
1963 {
1964         /*
1965          * This is sort-of available in the uimage_type[] table in image.c
1966          * but we don't have access to the short name, and "fdt" is different
1967          * anyway. So let's just keep it here.
1968          */
1969         switch (type) {
1970         case IH_TYPE_FLATDT:
1971                 return FIT_FDT_PROP;
1972         case IH_TYPE_KERNEL:
1973                 return FIT_KERNEL_PROP;
1974         case IH_TYPE_FIRMWARE:
1975                 return FIT_FIRMWARE_PROP;
1976         case IH_TYPE_RAMDISK:
1977                 return FIT_RAMDISK_PROP;
1978         case IH_TYPE_X86_SETUP:
1979                 return FIT_SETUP_PROP;
1980         case IH_TYPE_LOADABLE:
1981                 return FIT_LOADABLE_PROP;
1982         case IH_TYPE_FPGA:
1983                 return FIT_FPGA_PROP;
1984         case IH_TYPE_STANDALONE:
1985                 return FIT_STANDALONE_PROP;
1986         }
1987
1988         return "unknown";
1989 }
1990
1991 int fit_image_load(struct bootm_headers *images, ulong addr,
1992                    const char **fit_unamep, const char **fit_uname_configp,
1993                    int arch, int image_type, int bootstage_id,
1994                    enum fit_load_op load_op, ulong *datap, ulong *lenp)
1995 {
1996         int cfg_noffset, noffset;
1997         const char *fit_uname;
1998         const char *fit_uname_config;
1999         const char *fit_base_uname_config;
2000         const void *fit;
2001         void *buf;
2002         void *loadbuf;
2003         size_t size;
2004         int type_ok, os_ok;
2005         ulong load, load_end, data, len;
2006         uint8_t os, comp;
2007         const char *prop_name;
2008         int ret;
2009
2010         fit = map_sysmem(addr, 0);
2011         fit_uname = fit_unamep ? *fit_unamep : NULL;
2012         fit_uname_config = fit_uname_configp ? *fit_uname_configp : NULL;
2013         fit_base_uname_config = NULL;
2014         prop_name = fit_get_image_type_property(image_type);
2015         printf("## Loading %s from FIT Image at %08lx ...\n", prop_name, addr);
2016
2017         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_FORMAT);
2018         ret = fit_check_format(fit, IMAGE_SIZE_INVAL);
2019         if (ret) {
2020                 printf("Bad FIT %s image format! (err=%d)\n", prop_name, ret);
2021                 if (CONFIG_IS_ENABLED(FIT_SIGNATURE) && ret == -EADDRNOTAVAIL)
2022                         printf("Signature checking prevents use of unit addresses (@) in nodes\n");
2023                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_FORMAT);
2024                 return ret;
2025         }
2026         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_FORMAT_OK);
2027         if (fit_uname) {
2028                 /* get FIT component image node offset */
2029                 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_UNIT_NAME);
2030                 noffset = fit_image_get_node(fit, fit_uname);
2031         } else {
2032                 /*
2033                  * no image node unit name, try to get config
2034                  * node first. If config unit node name is NULL
2035                  * fit_conf_get_node() will try to find default config node
2036                  */
2037                 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_NO_UNIT_NAME);
2038                 if (IS_ENABLED(CONFIG_FIT_BEST_MATCH) && !fit_uname_config) {
2039                         cfg_noffset = fit_conf_find_compat(fit, gd_fdt_blob());
2040                 } else {
2041                         cfg_noffset = fit_conf_get_node(fit,
2042                                                         fit_uname_config);
2043                 }
2044                 if (cfg_noffset < 0) {
2045                         puts("Could not find configuration node\n");
2046                         bootstage_error(bootstage_id +
2047                                         BOOTSTAGE_SUB_NO_UNIT_NAME);
2048                         return -ENOENT;
2049                 }
2050
2051                 fit_base_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
2052                 printf("   Using '%s' configuration\n", fit_base_uname_config);
2053                 /* Remember this config */
2054                 if (image_type == IH_TYPE_KERNEL)
2055                         images->fit_uname_cfg = fit_base_uname_config;
2056
2057                 if (FIT_IMAGE_ENABLE_VERIFY && images->verify) {
2058                         puts("   Verifying Hash Integrity ... ");
2059                         if (fit_config_verify(fit, cfg_noffset)) {
2060                                 puts("Bad Data Hash\n");
2061                                 bootstage_error(bootstage_id +
2062                                         BOOTSTAGE_SUB_HASH);
2063                                 return -EACCES;
2064                         }
2065                         puts("OK\n");
2066                 }
2067
2068                 bootstage_mark(BOOTSTAGE_ID_FIT_CONFIG);
2069
2070                 noffset = fit_conf_get_prop_node(fit, cfg_noffset,
2071                                                  prop_name);
2072                 fit_uname = fit_get_name(fit, noffset, NULL);
2073         }
2074         if (noffset < 0) {
2075                 printf("Could not find subimage node type '%s'\n", prop_name);
2076                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_SUBNODE);
2077                 return -ENOENT;
2078         }
2079
2080         printf("   Trying '%s' %s subimage\n", fit_uname, prop_name);
2081
2082         ret = fit_image_select(fit, noffset, images->verify);
2083         if (ret) {
2084                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_HASH);
2085                 return ret;
2086         }
2087
2088         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ARCH);
2089         if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX)) {
2090                 if (!fit_image_check_target_arch(fit, noffset)) {
2091                         puts("Unsupported Architecture\n");
2092                         bootstage_error(bootstage_id + BOOTSTAGE_SUB_CHECK_ARCH);
2093                         return -ENOEXEC;
2094                 }
2095         }
2096
2097 #ifndef USE_HOSTCC
2098         {
2099         uint8_t os_arch;
2100
2101         fit_image_get_arch(fit, noffset, &os_arch);
2102         images->os.arch = os_arch;
2103         }
2104 #endif
2105
2106         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL);
2107         type_ok = fit_image_check_type(fit, noffset, image_type) ||
2108                   fit_image_check_type(fit, noffset, IH_TYPE_FIRMWARE) ||
2109                   fit_image_check_type(fit, noffset, IH_TYPE_TEE) ||
2110                   (image_type == IH_TYPE_KERNEL &&
2111                    fit_image_check_type(fit, noffset, IH_TYPE_KERNEL_NOLOAD));
2112
2113         os_ok = image_type == IH_TYPE_FLATDT ||
2114                 image_type == IH_TYPE_FPGA ||
2115                 fit_image_check_os(fit, noffset, IH_OS_LINUX) ||
2116                 fit_image_check_os(fit, noffset, IH_OS_U_BOOT) ||
2117                 fit_image_check_os(fit, noffset, IH_OS_TEE) ||
2118                 fit_image_check_os(fit, noffset, IH_OS_OPENRTOS) ||
2119                 fit_image_check_os(fit, noffset, IH_OS_EFI) ||
2120                 fit_image_check_os(fit, noffset, IH_OS_VXWORKS);
2121
2122         /*
2123          * If either of the checks fail, we should report an error, but
2124          * if the image type is coming from the "loadables" field, we
2125          * don't care what it is
2126          */
2127         if ((!type_ok || !os_ok) && image_type != IH_TYPE_LOADABLE) {
2128                 fit_image_get_os(fit, noffset, &os);
2129                 printf("No %s %s %s Image\n",
2130                        genimg_get_os_name(os),
2131                        genimg_get_arch_name(arch),
2132                        genimg_get_type_name(image_type));
2133                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL);
2134                 return -EIO;
2135         }
2136
2137         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL_OK);
2138
2139         /* get image data address and length */
2140         if (fit_image_get_data_and_size(fit, noffset,
2141                                         (const void **)&buf, &size)) {
2142                 printf("Could not find %s subimage data!\n", prop_name);
2143                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_GET_DATA);
2144                 return -ENOENT;
2145         }
2146
2147         /* Decrypt data before uncompress/move */
2148         if (IS_ENABLED(CONFIG_FIT_CIPHER) && IMAGE_ENABLE_DECRYPT) {
2149                 puts("   Decrypting Data ... ");
2150                 if (fit_image_uncipher(fit, noffset, &buf, &size)) {
2151                         puts("Error\n");
2152                         return -EACCES;
2153                 }
2154                 puts("OK\n");
2155         }
2156
2157         /* perform any post-processing on the image data */
2158         if (!tools_build() && IS_ENABLED(CONFIG_FIT_IMAGE_POST_PROCESS))
2159                 board_fit_image_post_process(fit, noffset, &buf, &size);
2160
2161         len = (ulong)size;
2162
2163         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_GET_DATA_OK);
2164
2165         data = map_to_sysmem(buf);
2166         load = data;
2167         if (load_op == FIT_LOAD_IGNORED) {
2168                 /* Don't load */
2169         } else if (fit_image_get_load(fit, noffset, &load)) {
2170                 if (load_op == FIT_LOAD_REQUIRED) {
2171                         printf("Can't get %s subimage load address!\n",
2172                                prop_name);
2173                         bootstage_error(bootstage_id + BOOTSTAGE_SUB_LOAD);
2174                         return -EBADF;
2175                 }
2176         } else if (load_op != FIT_LOAD_OPTIONAL_NON_ZERO || load) {
2177                 ulong image_start, image_end;
2178
2179                 /*
2180                  * move image data to the load address,
2181                  * make sure we don't overwrite initial image
2182                  */
2183                 image_start = addr;
2184                 image_end = addr + fit_get_size(fit);
2185
2186                 load_end = load + len;
2187                 if (image_type != IH_TYPE_KERNEL &&
2188                     load < image_end && load_end > image_start) {
2189                         printf("Error: %s overwritten\n", prop_name);
2190                         return -EXDEV;
2191                 }
2192
2193                 printf("   Loading %s from 0x%08lx to 0x%08lx\n",
2194                        prop_name, data, load);
2195         } else {
2196                 load = data;    /* No load address specified */
2197         }
2198
2199         comp = IH_COMP_NONE;
2200         loadbuf = buf;
2201         /* Kernel images get decompressed later in bootm_load_os(). */
2202         if (!fit_image_get_comp(fit, noffset, &comp) &&
2203             comp != IH_COMP_NONE &&
2204             !(image_type == IH_TYPE_KERNEL ||
2205               image_type == IH_TYPE_KERNEL_NOLOAD ||
2206               image_type == IH_TYPE_RAMDISK)) {
2207                 ulong max_decomp_len = len * 20;
2208                 if (load == data) {
2209                         loadbuf = malloc(max_decomp_len);
2210                         load = map_to_sysmem(loadbuf);
2211                 } else {
2212                         loadbuf = map_sysmem(load, max_decomp_len);
2213                 }
2214                 if (image_decomp(comp, load, data, image_type,
2215                                 loadbuf, buf, len, max_decomp_len, &load_end)) {
2216                         printf("Error decompressing %s\n", prop_name);
2217
2218                         return -ENOEXEC;
2219                 }
2220                 len = load_end - load;
2221         } else if (load != data) {
2222                 loadbuf = map_sysmem(load, len);
2223                 memcpy(loadbuf, buf, len);
2224         }
2225
2226         if (image_type == IH_TYPE_RAMDISK && comp != IH_COMP_NONE)
2227                 puts("WARNING: 'compression' nodes for ramdisks are deprecated,"
2228                      " please fix your .its file!\n");
2229
2230         /* verify that image data is a proper FDT blob */
2231         if (image_type == IH_TYPE_FLATDT && fdt_check_header(loadbuf)) {
2232                 puts("Subimage data is not a FDT");
2233                 return -ENOEXEC;
2234         }
2235
2236         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_LOAD);
2237
2238         *datap = load;
2239         *lenp = len;
2240         if (fit_unamep)
2241                 *fit_unamep = (char *)fit_uname;
2242         if (fit_uname_configp)
2243                 *fit_uname_configp = (char *)(fit_uname_config ? :
2244                                               fit_base_uname_config);
2245
2246         return noffset;
2247 }
2248
2249 int boot_get_setup_fit(struct bootm_headers *images, uint8_t arch,
2250                        ulong *setup_start, ulong *setup_len)
2251 {
2252         int noffset;
2253         ulong addr;
2254         ulong len;
2255         int ret;
2256
2257         addr = map_to_sysmem(images->fit_hdr_os);
2258         noffset = fit_get_node_from_config(images, FIT_SETUP_PROP, addr);
2259         if (noffset < 0)
2260                 return noffset;
2261
2262         ret = fit_image_load(images, addr, NULL, NULL, arch,
2263                              IH_TYPE_X86_SETUP, BOOTSTAGE_ID_FIT_SETUP_START,
2264                              FIT_LOAD_REQUIRED, setup_start, &len);
2265
2266         return ret;
2267 }
2268
2269 #ifndef USE_HOSTCC
2270 int boot_get_fdt_fit(struct bootm_headers *images, ulong addr,
2271                      const char **fit_unamep, const char **fit_uname_configp,
2272                      int arch, ulong *datap, ulong *lenp)
2273 {
2274         int fdt_noffset, cfg_noffset, count;
2275         const void *fit;
2276         const char *fit_uname = NULL;
2277         const char *fit_uname_config = NULL;
2278         char *fit_uname_config_copy = NULL;
2279         char *next_config = NULL;
2280         ulong load, len;
2281 #ifdef CONFIG_OF_LIBFDT_OVERLAY
2282         ulong image_start, image_end;
2283         ulong ovload, ovlen, ovcopylen;
2284         const char *uconfig;
2285         const char *uname;
2286         void *base, *ov, *ovcopy = NULL;
2287         int i, err, noffset, ov_noffset;
2288 #endif
2289
2290         fit_uname = fit_unamep ? *fit_unamep : NULL;
2291
2292         if (fit_uname_configp && *fit_uname_configp) {
2293                 fit_uname_config_copy = strdup(*fit_uname_configp);
2294                 if (!fit_uname_config_copy)
2295                         return -ENOMEM;
2296
2297                 next_config = strchr(fit_uname_config_copy, '#');
2298                 if (next_config)
2299                         *next_config++ = '\0';
2300                 if (next_config - 1 > fit_uname_config_copy)
2301                         fit_uname_config = fit_uname_config_copy;
2302         }
2303
2304         fdt_noffset = fit_image_load(images,
2305                 addr, &fit_uname, &fit_uname_config,
2306                 arch, IH_TYPE_FLATDT,
2307                 BOOTSTAGE_ID_FIT_FDT_START,
2308                 FIT_LOAD_OPTIONAL, &load, &len);
2309
2310         if (fdt_noffset < 0)
2311                 goto out;
2312
2313         debug("fit_uname=%s, fit_uname_config=%s\n",
2314                         fit_uname ? fit_uname : "<NULL>",
2315                         fit_uname_config ? fit_uname_config : "<NULL>");
2316
2317         fit = map_sysmem(addr, 0);
2318
2319         cfg_noffset = fit_conf_get_node(fit, fit_uname_config);
2320
2321         /* single blob, or error just return as well */
2322         count = fit_conf_get_prop_node_count(fit, cfg_noffset, FIT_FDT_PROP);
2323         if (count <= 1 && !next_config)
2324                 goto out;
2325
2326         /* we need to apply overlays */
2327
2328 #ifdef CONFIG_OF_LIBFDT_OVERLAY
2329         image_start = addr;
2330         image_end = addr + fit_get_size(fit);
2331         /* verify that relocation took place by load address not being in fit */
2332         if (load >= image_start && load < image_end) {
2333                 /* check is simplified; fit load checks for overlaps */
2334                 printf("Overlayed FDT requires relocation\n");
2335                 fdt_noffset = -EBADF;
2336                 goto out;
2337         }
2338
2339         base = map_sysmem(load, len);
2340
2341         /* apply extra configs in FIT first, followed by args */
2342         for (i = 1; ; i++) {
2343                 if (i < count) {
2344                         noffset = fit_conf_get_prop_node_index(fit, cfg_noffset,
2345                                                                FIT_FDT_PROP, i);
2346                         uname = fit_get_name(fit, noffset, NULL);
2347                         uconfig = NULL;
2348                 } else {
2349                         if (!next_config)
2350                                 break;
2351                         uconfig = next_config;
2352                         next_config = strchr(next_config, '#');
2353                         if (next_config)
2354                                 *next_config++ = '\0';
2355                         uname = NULL;
2356
2357                         /*
2358                          * fit_image_load() would load the first FDT from the
2359                          * extra config only when uconfig is specified.
2360                          * Check if the extra config contains multiple FDTs and
2361                          * if so, load them.
2362                          */
2363                         cfg_noffset = fit_conf_get_node(fit, uconfig);
2364
2365                         i = 0;
2366                         count = fit_conf_get_prop_node_count(fit, cfg_noffset,
2367                                                              FIT_FDT_PROP);
2368                 }
2369
2370                 debug("%d: using uname=%s uconfig=%s\n", i, uname, uconfig);
2371
2372                 ov_noffset = fit_image_load(images,
2373                         addr, &uname, &uconfig,
2374                         arch, IH_TYPE_FLATDT,
2375                         BOOTSTAGE_ID_FIT_FDT_START,
2376                         FIT_LOAD_IGNORED, &ovload, &ovlen);
2377                 if (ov_noffset < 0) {
2378                         printf("load of %s failed\n", uname);
2379                         continue;
2380                 }
2381                 debug("%s loaded at 0x%08lx len=0x%08lx\n",
2382                                 uname, ovload, ovlen);
2383                 ov = map_sysmem(ovload, ovlen);
2384
2385                 ovcopylen = ALIGN(fdt_totalsize(ov), SZ_4K);
2386                 ovcopy = malloc(ovcopylen);
2387                 if (!ovcopy) {
2388                         printf("failed to duplicate DTO before application\n");
2389                         fdt_noffset = -ENOMEM;
2390                         goto out;
2391                 }
2392
2393                 err = fdt_open_into(ov, ovcopy, ovcopylen);
2394                 if (err < 0) {
2395                         printf("failed on fdt_open_into for DTO\n");
2396                         fdt_noffset = err;
2397                         goto out;
2398                 }
2399
2400                 base = map_sysmem(load, len + ovlen);
2401                 err = fdt_open_into(base, base, len + ovlen);
2402                 if (err < 0) {
2403                         printf("failed on fdt_open_into\n");
2404                         fdt_noffset = err;
2405                         goto out;
2406                 }
2407
2408                 /* the verbose method prints out messages on error */
2409                 err = fdt_overlay_apply_verbose(base, ovcopy);
2410                 if (err < 0) {
2411                         fdt_noffset = err;
2412                         goto out;
2413                 }
2414                 fdt_pack(base);
2415                 len = fdt_totalsize(base);
2416         }
2417 #else
2418         printf("config with overlays but CONFIG_OF_LIBFDT_OVERLAY not set\n");
2419         fdt_noffset = -EBADF;
2420 #endif
2421
2422 out:
2423         if (datap)
2424                 *datap = load;
2425         if (lenp)
2426                 *lenp = len;
2427         if (fit_unamep)
2428                 *fit_unamep = fit_uname;
2429         if (fit_uname_configp)
2430                 *fit_uname_configp = fit_uname_config;
2431
2432 #ifdef CONFIG_OF_LIBFDT_OVERLAY
2433         free(ovcopy);
2434 #endif
2435         free(fit_uname_config_copy);
2436         return fdt_noffset;
2437 }
2438 #endif