include/image.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2008 Semihalf
   4  *
   5  * (C) Copyright 2000-2005
   6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  ********************************************************************
   8  * NOTE: This header file defines an interface to U-Boot. Including
   9  * this (unmodified) header file in another file is considered normal
  10  * use of U-Boot, and does *not* fall under the heading of "derived
  11  * work".
  12  ********************************************************************
  13  */
  14
  15 #ifndef __IMAGE_H__
  16 #define __IMAGE_H__
  17
  18 #include "compiler.h"
  19 #include <asm/byteorder.h>
  20 #include <stdbool.h>
  21
  22 /* Define this to avoid #ifdefs later on */
  23 struct lmb;
  24 struct fdt_region;
  25
  26 #ifdef USE_HOSTCC
  27 #include <sys/types.h>
  28 #include <linux/kconfig.h>
  29
  30 #define IMAGE_ENABLE_IGNORE     0
  31 #define IMAGE_INDENT_STRING     ""
  32
  33 #else
  34
  35 #include <lmb.h>
  36 #include <asm/u-boot.h>
  37 #include <command.h>
  38 #include <linker_lists.h>
  39
  40 /* Take notice of the 'ignore' property for hashes */
  41 #define IMAGE_ENABLE_IGNORE     1
  42 #define IMAGE_INDENT_STRING     "   "
  43
  44 #endif /* USE_HOSTCC */
  45
  46 #if CONFIG_IS_ENABLED(FIT)
  47 #include <hash.h>
  48 #include <linux/libfdt.h>
  49 #include <fdt_support.h>
  50 #endif /* FIT */
  51
  52 #ifdef CONFIG_OF_BOARD_SETUP
  53 # define IMAGE_OF_BOARD_SETUP           1
  54 #else
  55 # define IMAGE_OF_BOARD_SETUP           0
  56 #endif
  57
  58 #ifdef CONFIG_OF_SYSTEM_SETUP
  59 # define IMAGE_OF_SYSTEM_SETUP  1
  60 #else
  61 # define IMAGE_OF_SYSTEM_SETUP  0
  62 #endif
  63
  64 extern ulong image_load_addr;           /* Default Load Address */
  65 extern ulong image_save_addr;           /* Default Save Address */
  66 extern ulong image_save_size;           /* Default Save Size */
  67
  68 /* An invalid size, meaning that the image size is not known */
  69 #define IMAGE_SIZE_INVAL        (-1UL)
  70
  71 enum ih_category {
  72         IH_ARCH,
  73         IH_COMP,
  74         IH_OS,
  75         IH_TYPE,
  76
  77         IH_COUNT,
  78 };
  79
  80 /*
  81  * Operating System Codes
  82  *
  83  * The following are exposed to uImage header.
  84  * New IDs *MUST* be appended at the end of the list and *NEVER*
  85  * inserted for backward compatibility.
  86  */
  87 enum {
  88         IH_OS_INVALID           = 0,    /* Invalid OS   */
  89         IH_OS_OPENBSD,                  /* OpenBSD      */
  90         IH_OS_NETBSD,                   /* NetBSD       */
  91         IH_OS_FREEBSD,                  /* FreeBSD      */
  92         IH_OS_4_4BSD,                   /* 4.4BSD       */
  93         IH_OS_LINUX,                    /* Linux        */
  94         IH_OS_SVR4,                     /* SVR4         */
  95         IH_OS_ESIX,                     /* Esix         */
  96         IH_OS_SOLARIS,                  /* Solaris      */
  97         IH_OS_IRIX,                     /* Irix         */
  98         IH_OS_SCO,                      /* SCO          */
  99         IH_OS_DELL,                     /* Dell         */
 100         IH_OS_NCR,                      /* NCR          */
 101         IH_OS_LYNXOS,                   /* LynxOS       */
 102         IH_OS_VXWORKS,                  /* VxWorks      */
 103         IH_OS_PSOS,                     /* pSOS         */
 104         IH_OS_QNX,                      /* QNX          */
 105         IH_OS_U_BOOT,                   /* Firmware     */
 106         IH_OS_RTEMS,                    /* RTEMS        */
 107         IH_OS_ARTOS,                    /* ARTOS        */
 108         IH_OS_UNITY,                    /* Unity OS     */
 109         IH_OS_INTEGRITY,                /* INTEGRITY    */
 110         IH_OS_OSE,                      /* OSE          */
 111         IH_OS_PLAN9,                    /* Plan 9       */
 112         IH_OS_OPENRTOS,         /* OpenRTOS     */
 113         IH_OS_ARM_TRUSTED_FIRMWARE,     /* ARM Trusted Firmware */
 114         IH_OS_TEE,                      /* Trusted Execution Environment */
 115         IH_OS_OPENSBI,                  /* RISC-V OpenSBI */
 116         IH_OS_EFI,                      /* EFI Firmware (e.g. GRUB2) */
 117
 118         IH_OS_COUNT,
 119 };
 120
 121 /*
 122  * CPU Architecture Codes (supported by Linux)
 123  *
 124  * The following are exposed to uImage header.
 125  * New IDs *MUST* be appended at the end of the list and *NEVER*
 126  * inserted for backward compatibility.
 127  */
 128 enum {
 129         IH_ARCH_INVALID         = 0,    /* Invalid CPU  */
 130         IH_ARCH_ALPHA,                  /* Alpha        */
 131         IH_ARCH_ARM,                    /* ARM          */
 132         IH_ARCH_I386,                   /* Intel x86    */
 133         IH_ARCH_IA64,                   /* IA64         */
 134         IH_ARCH_MIPS,                   /* MIPS         */
 135         IH_ARCH_MIPS64,                 /* MIPS  64 Bit */
 136         IH_ARCH_PPC,                    /* PowerPC      */
 137         IH_ARCH_S390,                   /* IBM S390     */
 138         IH_ARCH_SH,                     /* SuperH       */
 139         IH_ARCH_SPARC,                  /* Sparc        */
 140         IH_ARCH_SPARC64,                /* Sparc 64 Bit */
 141         IH_ARCH_M68K,                   /* M68K         */
 142         IH_ARCH_NIOS,                   /* Nios-32      */
 143         IH_ARCH_MICROBLAZE,             /* MicroBlaze   */
 144         IH_ARCH_NIOS2,                  /* Nios-II      */
 145         IH_ARCH_BLACKFIN,               /* Blackfin     */
 146         IH_ARCH_AVR32,                  /* AVR32        */
 147         IH_ARCH_ST200,                  /* STMicroelectronics ST200  */
 148         IH_ARCH_SANDBOX,                /* Sandbox architecture (test only) */
 149         IH_ARCH_NDS32,                  /* ANDES Technology - NDS32  */
 150         IH_ARCH_OPENRISC,               /* OpenRISC 1000  */
 151         IH_ARCH_ARM64,                  /* ARM64        */
 152         IH_ARCH_ARC,                    /* Synopsys DesignWare ARC */
 153         IH_ARCH_X86_64,                 /* AMD x86_64, Intel and Via */
 154         IH_ARCH_XTENSA,                 /* Xtensa       */
 155         IH_ARCH_RISCV,                  /* RISC-V */
 156
 157         IH_ARCH_COUNT,
 158 };
 159
 160 /*
 161  * Image Types
 162  *
 163  * "Standalone Programs" are directly runnable in the environment
 164  *      provided by U-Boot; it is expected that (if they behave
 165  *      well) you can continue to work in U-Boot after return from
 166  *      the Standalone Program.
 167  * "OS Kernel Images" are usually images of some Embedded OS which
 168  *      will take over control completely. Usually these programs
 169  *      will install their own set of exception handlers, device
 170  *      drivers, set up the MMU, etc. - this means, that you cannot
 171  *      expect to re-enter U-Boot except by resetting the CPU.
 172  * "RAMDisk Images" are more or less just data blocks, and their
 173  *      parameters (address, size) are passed to an OS kernel that is
 174  *      being started.
 175  * "Multi-File Images" contain several images, typically an OS
 176  *      (Linux) kernel image and one or more data images like
 177  *      RAMDisks. This construct is useful for instance when you want
 178  *      to boot over the network using BOOTP etc., where the boot
 179  *      server provides just a single image file, but you want to get
 180  *      for instance an OS kernel and a RAMDisk image.
 181  *
 182  *      "Multi-File Images" start with a list of image sizes, each
 183  *      image size (in bytes) specified by an "uint32_t" in network
 184  *      byte order. This list is terminated by an "(uint32_t)0".
 185  *      Immediately after the terminating 0 follow the images, one by
 186  *      one, all aligned on "uint32_t" boundaries (size rounded up to
 187  *      a multiple of 4 bytes - except for the last file).
 188  *
 189  * "Firmware Images" are binary images containing firmware (like
 190  *      U-Boot or FPGA images) which usually will be programmed to
 191  *      flash memory.
 192  *
 193  * "Script files" are command sequences that will be executed by
 194  *      U-Boot's command interpreter; this feature is especially
 195  *      useful when you configure U-Boot to use a real shell (hush)
 196  *      as command interpreter (=> Shell Scripts).
 197  *
 198  * The following are exposed to uImage header.
 199  * New IDs *MUST* be appended at the end of the list and *NEVER*
 200  * inserted for backward compatibility.
 201  */
 202
 203 enum {
 204         IH_TYPE_INVALID         = 0,    /* Invalid Image                */
 205         IH_TYPE_STANDALONE,             /* Standalone Program           */
 206         IH_TYPE_KERNEL,                 /* OS Kernel Image              */
 207         IH_TYPE_RAMDISK,                /* RAMDisk Image                */
 208         IH_TYPE_MULTI,                  /* Multi-File Image             */
 209         IH_TYPE_FIRMWARE,               /* Firmware Image               */
 210         IH_TYPE_SCRIPT,                 /* Script file                  */
 211         IH_TYPE_FILESYSTEM,             /* Filesystem Image (any type)  */
 212         IH_TYPE_FLATDT,                 /* Binary Flat Device Tree Blob */
 213         IH_TYPE_KWBIMAGE,               /* Kirkwood Boot Image          */
 214         IH_TYPE_IMXIMAGE,               /* Freescale IMXBoot Image      */
 215         IH_TYPE_UBLIMAGE,               /* Davinci UBL Image            */
 216         IH_TYPE_OMAPIMAGE,              /* TI OMAP Config Header Image  */
 217         IH_TYPE_AISIMAGE,               /* TI Davinci AIS Image         */
 218         /* OS Kernel Image, can run from any load address */
 219         IH_TYPE_KERNEL_NOLOAD,
 220         IH_TYPE_PBLIMAGE,               /* Freescale PBL Boot Image     */
 221         IH_TYPE_MXSIMAGE,               /* Freescale MXSBoot Image      */
 222         IH_TYPE_GPIMAGE,                /* TI Keystone GPHeader Image   */
 223         IH_TYPE_ATMELIMAGE,             /* ATMEL ROM bootable Image     */
 224         IH_TYPE_SOCFPGAIMAGE,           /* Altera SOCFPGA CV/AV Preloader */
 225         IH_TYPE_X86_SETUP,              /* x86 setup.bin Image          */
 226         IH_TYPE_LPC32XXIMAGE,           /* x86 setup.bin Image          */
 227         IH_TYPE_LOADABLE,               /* A list of typeless images    */
 228         IH_TYPE_RKIMAGE,                /* Rockchip Boot Image          */
 229         IH_TYPE_RKSD,                   /* Rockchip SD card             */
 230         IH_TYPE_RKSPI,                  /* Rockchip SPI image           */
 231         IH_TYPE_ZYNQIMAGE,              /* Xilinx Zynq Boot Image */
 232         IH_TYPE_ZYNQMPIMAGE,            /* Xilinx ZynqMP Boot Image */
 233         IH_TYPE_ZYNQMPBIF,              /* Xilinx ZynqMP Boot Image (bif) */
 234         IH_TYPE_FPGA,                   /* FPGA Image */
 235         IH_TYPE_VYBRIDIMAGE,    /* VYBRID .vyb Image */
 236         IH_TYPE_TEE,            /* Trusted Execution Environment OS Image */
 237         IH_TYPE_FIRMWARE_IVT,           /* Firmware Image with HABv4 IVT */
 238         IH_TYPE_PMMC,            /* TI Power Management Micro-Controller Firmware */
 239         IH_TYPE_STM32IMAGE,             /* STMicroelectronics STM32 Image */
 240         IH_TYPE_SOCFPGAIMAGE_V1,        /* Altera SOCFPGA A10 Preloader */
 241         IH_TYPE_MTKIMAGE,               /* MediaTek BootROM loadable Image */
 242         IH_TYPE_IMX8MIMAGE,             /* Freescale IMX8MBoot Image    */
 243         IH_TYPE_IMX8IMAGE,              /* Freescale IMX8Boot Image     */
 244         IH_TYPE_COPRO,                  /* Coprocessor Image for remoteproc*/
 245         IH_TYPE_SUNXI_EGON,             /* Allwinner eGON Boot Image */
 246
 247         IH_TYPE_COUNT,                  /* Number of image types */
 248 };
 249
 250 /*
 251  * Compression Types
 252  *
 253  * The following are exposed to uImage header.
 254  * New IDs *MUST* be appended at the end of the list and *NEVER*
 255  * inserted for backward compatibility.
 256  */
 257 enum {
 258         IH_COMP_NONE            = 0,    /*  No   Compression Used       */
 259         IH_COMP_GZIP,                   /* gzip  Compression Used       */
 260         IH_COMP_BZIP2,                  /* bzip2 Compression Used       */
 261         IH_COMP_LZMA,                   /* lzma  Compression Used       */
 262         IH_COMP_LZO,                    /* lzo   Compression Used       */
 263         IH_COMP_LZ4,                    /* lz4   Compression Used       */
 264         IH_COMP_ZSTD,                   /* zstd   Compression Used      */
 265
 266         IH_COMP_COUNT,
 267 };
 268
 269 #define LZ4F_MAGIC      0x184D2204      /* LZ4 Magic Number             */
 270 #define IH_MAGIC        0x27051956      /* Image Magic Number           */
 271 #define IH_NMLEN                32      /* Image Name Length            */
 272
 273 /* Reused from common.h */
 274 #define ROUND(a, b)             (((a) + (b) - 1) & ~((b) - 1))
 275
 276 /*
 277  * Legacy format image header,
 278  * all data in network byte order (aka natural aka bigendian).
 279  */
 280 typedef struct image_header {
 281         uint32_t        ih_magic;       /* Image Header Magic Number    */
 282         uint32_t        ih_hcrc;        /* Image Header CRC Checksum    */
 283         uint32_t        ih_time;        /* Image Creation Timestamp     */
 284         uint32_t        ih_size;        /* Image Data Size              */
 285         uint32_t        ih_load;        /* Data  Load  Address          */
 286         uint32_t        ih_ep;          /* Entry Point Address          */
 287         uint32_t        ih_dcrc;        /* Image Data CRC Checksum      */
 288         uint8_t         ih_os;          /* Operating System             */
 289         uint8_t         ih_arch;        /* CPU architecture             */
 290         uint8_t         ih_type;        /* Image Type                   */
 291         uint8_t         ih_comp;        /* Compression Type             */
 292         uint8_t         ih_name[IH_NMLEN];      /* Image Name           */
 293 } image_header_t;
 294
 295 typedef struct image_info {
 296         ulong           start, end;             /* start/end of blob */
 297         ulong           image_start, image_len; /* start of image within blob, len of image */
 298         ulong           load;                   /* load addr for the image */
 299         uint8_t         comp, type, os;         /* compression, type of image, os type */
 300         uint8_t         arch;                   /* CPU architecture */
 301 } image_info_t;
 302
 303 /*
 304  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
 305  * routines.
 306  */
 307 typedef struct bootm_headers {
 308         /*
 309          * Legacy os image header, if it is a multi component image
 310          * then boot_get_ramdisk() and get_fdt() will attempt to get
 311          * data from second and third component accordingly.
 312          */
 313         image_header_t  *legacy_hdr_os;         /* image header pointer */
 314         image_header_t  legacy_hdr_os_copy;     /* header copy */
 315         ulong           legacy_hdr_valid;
 316
 317 #if CONFIG_IS_ENABLED(FIT)
 318         const char      *fit_uname_cfg; /* configuration node unit name */
 319
 320         void            *fit_hdr_os;    /* os FIT image header */
 321         const char      *fit_uname_os;  /* os subimage node unit name */
 322         int             fit_noffset_os; /* os subimage node offset */
 323
 324         void            *fit_hdr_rd;    /* init ramdisk FIT image header */
 325         const char      *fit_uname_rd;  /* init ramdisk subimage node unit name */
 326         int             fit_noffset_rd; /* init ramdisk subimage node offset */
 327
 328         void            *fit_hdr_fdt;   /* FDT blob FIT image header */
 329         const char      *fit_uname_fdt; /* FDT blob subimage node unit name */
 330         int             fit_noffset_fdt;/* FDT blob subimage node offset */
 331
 332         void            *fit_hdr_setup; /* x86 setup FIT image header */
 333         const char      *fit_uname_setup; /* x86 setup subimage node name */
 334         int             fit_noffset_setup;/* x86 setup subimage node offset */
 335 #endif
 336
 337 #ifndef USE_HOSTCC
 338         image_info_t    os;             /* os image info */
 339         ulong           ep;             /* entry point of OS */
 340
 341         ulong           rd_start, rd_end;/* ramdisk start/end */
 342
 343         char            *ft_addr;       /* flat dev tree address */
 344         ulong           ft_len;         /* length of flat device tree */
 345
 346         ulong           initrd_start;
 347         ulong           initrd_end;
 348         ulong           cmdline_start;
 349         ulong           cmdline_end;
 350         struct bd_info          *kbd;
 351 #endif
 352
 353         int             verify;         /* env_get("verify")[0] != 'n' */
 354
 355 #define BOOTM_STATE_START       (0x00000001)
 356 #define BOOTM_STATE_FINDOS      (0x00000002)
 357 #define BOOTM_STATE_FINDOTHER   (0x00000004)
 358 #define BOOTM_STATE_LOADOS      (0x00000008)
 359 #define BOOTM_STATE_RAMDISK     (0x00000010)
 360 #define BOOTM_STATE_FDT         (0x00000020)
 361 #define BOOTM_STATE_OS_CMDLINE  (0x00000040)
 362 #define BOOTM_STATE_OS_BD_T     (0x00000080)
 363 #define BOOTM_STATE_OS_PREP     (0x00000100)
 364 #define BOOTM_STATE_OS_FAKE_GO  (0x00000200)    /* 'Almost' run the OS */
 365 #define BOOTM_STATE_OS_GO       (0x00000400)
 366         int             state;
 367
 368 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
 369         struct lmb      lmb;            /* for memory mgmt */
 370 #endif
 371 } bootm_headers_t;
 372
 373 extern bootm_headers_t images;
 374
 375 /*
 376  * Some systems (for example LWMON) have very short watchdog periods;
 377  * we must make sure to split long operations like memmove() or
 378  * checksum calculations into reasonable chunks.
 379  */
 380 #ifndef CHUNKSZ
 381 #define CHUNKSZ (64 * 1024)
 382 #endif
 383
 384 #ifndef CHUNKSZ_CRC32
 385 #define CHUNKSZ_CRC32 (64 * 1024)
 386 #endif
 387
 388 #ifndef CHUNKSZ_MD5
 389 #define CHUNKSZ_MD5 (64 * 1024)
 390 #endif
 391
 392 #ifndef CHUNKSZ_SHA1
 393 #define CHUNKSZ_SHA1 (64 * 1024)
 394 #endif
 395
 396 #define uimage_to_cpu(x)                be32_to_cpu(x)
 397 #define cpu_to_uimage(x)                cpu_to_be32(x)
 398
 399 /*
 400  * Translation table for entries of a specific type; used by
 401  * get_table_entry_id() and get_table_entry_name().
 402  */
 403 typedef struct table_entry {
 404         int     id;
 405         char    *sname;         /* short (input) name to find table entry */
 406         char    *lname;         /* long (output) name to print for messages */
 407 } table_entry_t;
 408
 409 /*
 410  * Compression type and magic number mapping table.
 411  */
 412 struct comp_magic_map {
 413         int             comp_id;
 414         const char      *name;
 415         unsigned char   magic[2];
 416 };
 417
 418 /*
 419  * get_table_entry_id() scans the translation table trying to find an
 420  * entry that matches the given short name. If a matching entry is
 421  * found, it's id is returned to the caller.
 422  */
 423 int get_table_entry_id(const table_entry_t *table,
 424                 const char *table_name, const char *name);
 425 /*
 426  * get_table_entry_name() scans the translation table trying to find
 427  * an entry that matches the given id. If a matching entry is found,
 428  * its long name is returned to the caller.
 429  */
 430 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
 431
 432 const char *genimg_get_os_name(uint8_t os);
 433
 434 /**
 435  * genimg_get_os_short_name() - get the short name for an OS
 436  *
 437  * @param os    OS (IH_OS_...)
 438  * @return OS short name, or "unknown" if unknown
 439  */
 440 const char *genimg_get_os_short_name(uint8_t comp);
 441
 442 const char *genimg_get_arch_name(uint8_t arch);
 443
 444 /**
 445  * genimg_get_arch_short_name() - get the short name for an architecture
 446  *
 447  * @param arch  Architecture type (IH_ARCH_...)
 448  * @return architecture short name, or "unknown" if unknown
 449  */
 450 const char *genimg_get_arch_short_name(uint8_t arch);
 451
 452 const char *genimg_get_type_name(uint8_t type);
 453
 454 /**
 455  * genimg_get_type_short_name() - get the short name for an image type
 456  *
 457  * @param type  Image type (IH_TYPE_...)
 458  * @return image short name, or "unknown" if unknown
 459  */
 460 const char *genimg_get_type_short_name(uint8_t type);
 461
 462 const char *genimg_get_comp_name(uint8_t comp);
 463
 464 /**
 465  * genimg_get_comp_short_name() - get the short name for a compression method
 466  *
 467  * @param comp  compression method (IH_COMP_...)
 468  * @return compression method short name, or "unknown" if unknown
 469  */
 470 const char *genimg_get_comp_short_name(uint8_t comp);
 471
 472 /**
 473  * genimg_get_cat_name() - Get the name of an item in a category
 474  *
 475  * @category:   Category of item
 476  * @id:         Item ID
 477  * @return name of item, or "Unknown ..." if unknown
 478  */
 479 const char *genimg_get_cat_name(enum ih_category category, uint id);
 480
 481 /**
 482  * genimg_get_cat_short_name() - Get the short name of an item in a category
 483  *
 484  * @category:   Category of item
 485  * @id:         Item ID
 486  * @return short name of item, or "Unknown ..." if unknown
 487  */
 488 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
 489
 490 /**
 491  * genimg_get_cat_count() - Get the number of items in a category
 492  *
 493  * @category:   Category to check
 494  * @return the number of items in the category (IH_xxx_COUNT)
 495  */
 496 int genimg_get_cat_count(enum ih_category category);
 497
 498 /**
 499  * genimg_get_cat_desc() - Get the description of a category
 500  *
 501  * @category:   Category to check
 502  * @return the description of a category, e.g. "architecture". This
 503  * effectively converts the enum to a string.
 504  */
 505 const char *genimg_get_cat_desc(enum ih_category category);
 506
 507 /**
 508  * genimg_cat_has_id() - Check whether a category has an item
 509  *
 510  * @category:   Category to check
 511  * @id:         Item ID
 512  * @return true or false as to whether a category has an item
 513  */
 514 bool genimg_cat_has_id(enum ih_category category, uint id);
 515
 516 int genimg_get_os_id(const char *name);
 517 int genimg_get_arch_id(const char *name);
 518 int genimg_get_type_id(const char *name);
 519 int genimg_get_comp_id(const char *name);
 520 void genimg_print_size(uint32_t size);
 521
 522 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
 523         defined(USE_HOSTCC)
 524 #define IMAGE_ENABLE_TIMESTAMP 1
 525 #else
 526 #define IMAGE_ENABLE_TIMESTAMP 0
 527 #endif
 528 void genimg_print_time(time_t timestamp);
 529
 530 /* What to do with a image load address ('load = <> 'in the FIT) */
 531 enum fit_load_op {
 532         FIT_LOAD_IGNORED,       /* Ignore load address */
 533         FIT_LOAD_OPTIONAL,      /* Can be provided, but optional */
 534         FIT_LOAD_OPTIONAL_NON_ZERO,     /* Optional, a value of 0 is ignored */
 535         FIT_LOAD_REQUIRED,      /* Must be provided */
 536 };
 537
 538 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
 539                    ulong *setup_len);
 540
 541 #ifndef USE_HOSTCC
 542 /* Image format types, returned by _get_format() routine */
 543 #define IMAGE_FORMAT_INVALID    0x00
 544 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 545 #define IMAGE_FORMAT_LEGACY     0x01    /* legacy image_header based format */
 546 #endif
 547 #define IMAGE_FORMAT_FIT        0x02    /* new, libfdt based format */
 548 #define IMAGE_FORMAT_ANDROID    0x03    /* Android boot image */
 549
 550 ulong genimg_get_kernel_addr_fit(char * const img_addr,
 551                                  const char **fit_uname_config,
 552                                  const char **fit_uname_kernel);
 553 ulong genimg_get_kernel_addr(char * const img_addr);
 554 int genimg_get_format(const void *img_addr);
 555 int genimg_has_config(bootm_headers_t *images);
 556
 557 int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
 558                   uint8_t arch, const ulong *ld_start, ulong * const ld_len);
 559 int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
 560                      uint8_t arch, ulong *rd_start, ulong *rd_end);
 561
 562 /**
 563  * boot_get_loadable - routine to load a list of binaries to memory
 564  * @argc: Ignored Argument
 565  * @argv: Ignored Argument
 566  * @images: pointer to the bootm images structure
 567  * @arch: expected architecture for the image
 568  * @ld_start: Ignored Argument
 569  * @ld_len: Ignored Argument
 570  *
 571  * boot_get_loadable() will take the given FIT configuration, and look
 572  * for a field named "loadables".  Loadables, is a list of elements in
 573  * the FIT given as strings.  exe:
 574  *   loadables = "linux_kernel", "fdt-2";
 575  * this function will attempt to parse each string, and load the
 576  * corresponding element from the FIT into memory.  Once placed,
 577  * no aditional actions are taken.
 578  *
 579  * @return:
 580  *     0, if only valid images or no images are found
 581  *     error code, if an error occurs during fit_image_load
 582  */
 583 int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
 584                       uint8_t arch, const ulong *ld_start, ulong *const ld_len);
 585 #endif /* !USE_HOSTCC */
 586
 587 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
 588                        ulong *setup_start, ulong *setup_len);
 589
 590 /**
 591  * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
 592  *
 593  * This deals with all aspects of loading an DTB from a FIT.
 594  * The correct base image based on configuration will be selected, and
 595  * then any overlays specified will be applied (as present in fit_uname_configp).
 596  *
 597  * @param images        Boot images structure
 598  * @param addr          Address of FIT in memory
 599  * @param fit_unamep    On entry this is the requested image name
 600  *                      (e.g. "kernel") or NULL to use the default. On exit
 601  *                      points to the selected image name
 602  * @param fit_uname_configp     On entry this is the requested configuration
 603  *                      name (e.g. "conf-1") or NULL to use the default. On
 604  *                      exit points to the selected configuration name.
 605  * @param arch          Expected architecture (IH_ARCH_...)
 606  * @param datap         Returns address of loaded image
 607  * @param lenp          Returns length of loaded image
 608  *
 609  * @return node offset of base image, or -ve error code on error
 610  */
 611 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
 612                    const char **fit_unamep, const char **fit_uname_configp,
 613                    int arch, ulong *datap, ulong *lenp);
 614
 615 /**
 616  * fit_image_load() - load an image from a FIT
 617  *
 618  * This deals with all aspects of loading an image from a FIT, including
 619  * selecting the right image based on configuration, verifying it, printing
 620  * out progress messages, checking the type/arch/os and optionally copying it
 621  * to the right load address.
 622  *
 623  * The property to look up is defined by image_type.
 624  *
 625  * @param images        Boot images structure
 626  * @param addr          Address of FIT in memory
 627  * @param fit_unamep    On entry this is the requested image name
 628  *                      (e.g. "kernel") or NULL to use the default. On exit
 629  *                      points to the selected image name
 630  * @param fit_uname_configp     On entry this is the requested configuration
 631  *                      name (e.g. "conf-1") or NULL to use the default. On
 632  *                      exit points to the selected configuration name.
 633  * @param arch          Expected architecture (IH_ARCH_...)
 634  * @param image_type    Required image type (IH_TYPE_...). If this is
 635  *                      IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
 636  *                      also.
 637  * @param bootstage_id  ID of starting bootstage to use for progress updates.
 638  *                      This will be added to the BOOTSTAGE_SUB values when
 639  *                      calling bootstage_mark()
 640  * @param load_op       Decribes what to do with the load address
 641  * @param datap         Returns address of loaded image
 642  * @param lenp          Returns length of loaded image
 643  * @return node offset of image, or -ve error code on error
 644  */
 645 int fit_image_load(bootm_headers_t *images, ulong addr,
 646                    const char **fit_unamep, const char **fit_uname_configp,
 647                    int arch, int image_type, int bootstage_id,
 648                    enum fit_load_op load_op, ulong *datap, ulong *lenp);
 649
 650 /**
 651  * image_source_script() - Execute a script
 652  *
 653  * Executes a U-Boot script at a particular address in memory. The script should
 654  * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
 655  *
 656  * @addr: Address of script
 657  * @fit_uname: FIT subimage name
 658  * @return result code (enum command_ret_t)
 659  */
 660 int image_source_script(ulong addr, const char *fit_uname);
 661
 662 #ifndef USE_HOSTCC
 663 /**
 664  * fit_get_node_from_config() - Look up an image a FIT by type
 665  *
 666  * This looks in the selected conf- node (images->fit_uname_cfg) for a
 667  * particular image type (e.g. "kernel") and then finds the image that is
 668  * referred to.
 669  *
 670  * For example, for something like:
 671  *
 672  * images {
 673  *      kernel {
 674  *              ...
 675  *      };
 676  * };
 677  * configurations {
 678  *      conf-1 {
 679  *              kernel = "kernel";
 680  *      };
 681  * };
 682  *
 683  * the function will return the node offset of the kernel@1 node, assuming
 684  * that conf-1 is the chosen configuration.
 685  *
 686  * @param images        Boot images structure
 687  * @param prop_name     Property name to look up (FIT_..._PROP)
 688  * @param addr          Address of FIT in memory
 689  */
 690 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
 691                         ulong addr);
 692
 693 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
 694                  bootm_headers_t *images,
 695                  char **of_flat_tree, ulong *of_size);
 696 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
 697 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
 698
 699 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
 700                   ulong *initrd_start, ulong *initrd_end);
 701 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
 702 #ifdef CONFIG_SYS_BOOT_GET_KBD
 703 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
 704 #endif /* CONFIG_SYS_BOOT_GET_KBD */
 705 #endif /* !USE_HOSTCC */
 706
 707 /*******************************************************************/
 708 /* Legacy format specific code (prefixed with image_) */
 709 /*******************************************************************/
 710 static inline uint32_t image_get_header_size(void)
 711 {
 712         return (sizeof(image_header_t));
 713 }
 714
 715 #define image_get_hdr_l(f) \
 716         static inline uint32_t image_get_##f(const image_header_t *hdr) \
 717         { \
 718                 return uimage_to_cpu(hdr->ih_##f); \
 719         }
 720 image_get_hdr_l(magic)          /* image_get_magic */
 721 image_get_hdr_l(hcrc)           /* image_get_hcrc */
 722 image_get_hdr_l(time)           /* image_get_time */
 723 image_get_hdr_l(size)           /* image_get_size */
 724 image_get_hdr_l(load)           /* image_get_load */
 725 image_get_hdr_l(ep)             /* image_get_ep */
 726 image_get_hdr_l(dcrc)           /* image_get_dcrc */
 727
 728 #define image_get_hdr_b(f) \
 729         static inline uint8_t image_get_##f(const image_header_t *hdr) \
 730         { \
 731                 return hdr->ih_##f; \
 732         }
 733 image_get_hdr_b(os)             /* image_get_os */
 734 image_get_hdr_b(arch)           /* image_get_arch */
 735 image_get_hdr_b(type)           /* image_get_type */
 736 image_get_hdr_b(comp)           /* image_get_comp */
 737
 738 static inline char *image_get_name(const image_header_t *hdr)
 739 {
 740         return (char *)hdr->ih_name;
 741 }
 742
 743 static inline uint32_t image_get_data_size(const image_header_t *hdr)
 744 {
 745         return image_get_size(hdr);
 746 }
 747
 748 /**
 749  * image_get_data - get image payload start address
 750  * @hdr: image header
 751  *
 752  * image_get_data() returns address of the image payload. For single
 753  * component images it is image data start. For multi component
 754  * images it points to the null terminated table of sub-images sizes.
 755  *
 756  * returns:
 757  *     image payload data start address
 758  */
 759 static inline ulong image_get_data(const image_header_t *hdr)
 760 {
 761         return ((ulong)hdr + image_get_header_size());
 762 }
 763
 764 static inline uint32_t image_get_image_size(const image_header_t *hdr)
 765 {
 766         return (image_get_size(hdr) + image_get_header_size());
 767 }
 768 static inline ulong image_get_image_end(const image_header_t *hdr)
 769 {
 770         return ((ulong)hdr + image_get_image_size(hdr));
 771 }
 772
 773 #define image_set_hdr_l(f) \
 774         static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
 775         { \
 776                 hdr->ih_##f = cpu_to_uimage(val); \
 777         }
 778 image_set_hdr_l(magic)          /* image_set_magic */
 779 image_set_hdr_l(hcrc)           /* image_set_hcrc */
 780 image_set_hdr_l(time)           /* image_set_time */
 781 image_set_hdr_l(size)           /* image_set_size */
 782 image_set_hdr_l(load)           /* image_set_load */
 783 image_set_hdr_l(ep)             /* image_set_ep */
 784 image_set_hdr_l(dcrc)           /* image_set_dcrc */
 785
 786 #define image_set_hdr_b(f) \
 787         static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
 788         { \
 789                 hdr->ih_##f = val; \
 790         }
 791 image_set_hdr_b(os)             /* image_set_os */
 792 image_set_hdr_b(arch)           /* image_set_arch */
 793 image_set_hdr_b(type)           /* image_set_type */
 794 image_set_hdr_b(comp)           /* image_set_comp */
 795
 796 static inline void image_set_name(image_header_t *hdr, const char *name)
 797 {
 798         strncpy(image_get_name(hdr), name, IH_NMLEN);
 799 }
 800
 801 int image_check_hcrc(const image_header_t *hdr);
 802 int image_check_dcrc(const image_header_t *hdr);
 803 #ifndef USE_HOSTCC
 804 ulong env_get_bootm_low(void);
 805 phys_size_t env_get_bootm_size(void);
 806 phys_size_t env_get_bootm_mapsize(void);
 807 #endif
 808 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
 809
 810 static inline int image_check_magic(const image_header_t *hdr)
 811 {
 812         return (image_get_magic(hdr) == IH_MAGIC);
 813 }
 814 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
 815 {
 816         return (image_get_type(hdr) == type);
 817 }
 818 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
 819 {
 820 #ifndef USE_HOSTCC
 821         /* Let's assume that sandbox can load any architecture */
 822         if (IS_ENABLED(CONFIG_SANDBOX))
 823                 return true;
 824 #endif
 825         return (image_get_arch(hdr) == arch) ||
 826                 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
 827 }
 828 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
 829 {
 830         return (image_get_os(hdr) == os);
 831 }
 832
 833 ulong image_multi_count(const image_header_t *hdr);
 834 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 835                         ulong *data, ulong *len);
 836
 837 void image_print_contents(const void *hdr);
 838
 839 #ifndef USE_HOSTCC
 840 static inline int image_check_target_arch(const image_header_t *hdr)
 841 {
 842 #ifndef IH_ARCH_DEFAULT
 843 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
 844 #endif
 845         return image_check_arch(hdr, IH_ARCH_DEFAULT);
 846 }
 847 #endif /* USE_HOSTCC */
 848
 849 /**
 850  * image_decomp_type() - Find out compression type of an image
 851  *
 852  * @buf:        Address in U-Boot memory where image is loaded.
 853  * @len:        Length of the compressed image.
 854  * @return      compression type or IH_COMP_NONE if not compressed.
 855  *
 856  * Note: Only following compression types are supported now.
 857  * lzo, lzma, gzip, bzip2
 858  */
 859 int image_decomp_type(const unsigned char *buf, ulong len);
 860
 861 /**
 862  * image_decomp() - decompress an image
 863  *
 864  * @comp:       Compression algorithm that is used (IH_COMP_...)
 865  * @load:       Destination load address in U-Boot memory
 866  * @image_start Image start address (where we are decompressing from)
 867  * @type:       OS type (IH_OS_...)
 868  * @load_bug:   Place to decompress to
 869  * @image_buf:  Address to decompress from
 870  * @image_len:  Number of bytes in @image_buf to decompress
 871  * @unc_len:    Available space for decompression
 872  * @return 0 if OK, -ve on error (BOOTM_ERR_...)
 873  */
 874 int image_decomp(int comp, ulong load, ulong image_start, int type,
 875                  void *load_buf, void *image_buf, ulong image_len,
 876                  uint unc_len, ulong *load_end);
 877
 878 /**
 879  * Set up properties in the FDT
 880  *
 881  * This sets up properties in the FDT that is to be passed to linux.
 882  *
 883  * @images:     Images information
 884  * @blob:       FDT to update
 885  * @of_size:    Size of the FDT
 886  * @lmb:        Points to logical memory block structure
 887  * @return 0 if ok, <0 on failure
 888  */
 889 int image_setup_libfdt(bootm_headers_t *images, void *blob,
 890                        int of_size, struct lmb *lmb);
 891
 892 /**
 893  * Set up the FDT to use for booting a kernel
 894  *
 895  * This performs ramdisk setup, sets up the FDT if required, and adds
 896  * paramters to the FDT if libfdt is available.
 897  *
 898  * @param images        Images information
 899  * @return 0 if ok, <0 on failure
 900  */
 901 int image_setup_linux(bootm_headers_t *images);
 902
 903 /**
 904  * bootz_setup() - Extract stat and size of a Linux xImage
 905  *
 906  * @image: Address of image
 907  * @start: Returns start address of image
 908  * @end : Returns end address of image
 909  * @return 0 if OK, 1 if the image was not recognised
 910  */
 911 int bootz_setup(ulong image, ulong *start, ulong *end);
 912
 913 /**
 914  * Return the correct start address and size of a Linux aarch64 Image.
 915  *
 916  * @image: Address of image
 917  * @start: Returns start address of image
 918  * @size : Returns size image
 919  * @force_reloc: Ignore image->ep field, always place image to RAM start
 920  * @return 0 if OK, 1 if the image was not recognised
 921  */
 922 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
 923                 bool force_reloc);
 924
 925 /*******************************************************************/
 926 /* New uImage format specific code (prefixed with fit_) */
 927 /*******************************************************************/
 928
 929 #define FIT_IMAGES_PATH         "/images"
 930 #define FIT_CONFS_PATH          "/configurations"
 931
 932 /* hash/signature/key node */
 933 #define FIT_HASH_NODENAME       "hash"
 934 #define FIT_ALGO_PROP           "algo"
 935 #define FIT_VALUE_PROP          "value"
 936 #define FIT_IGNORE_PROP         "uboot-ignore"
 937 #define FIT_SIG_NODENAME        "signature"
 938 #define FIT_KEY_REQUIRED        "required"
 939 #define FIT_KEY_HINT            "key-name-hint"
 940
 941 /* cipher node */
 942 #define FIT_CIPHER_NODENAME     "cipher"
 943 #define FIT_ALGO_PROP           "algo"
 944
 945 /* image node */
 946 #define FIT_DATA_PROP           "data"
 947 #define FIT_DATA_POSITION_PROP  "data-position"
 948 #define FIT_DATA_OFFSET_PROP    "data-offset"
 949 #define FIT_DATA_SIZE_PROP      "data-size"
 950 #define FIT_TIMESTAMP_PROP      "timestamp"
 951 #define FIT_DESC_PROP           "description"
 952 #define FIT_ARCH_PROP           "arch"
 953 #define FIT_TYPE_PROP           "type"
 954 #define FIT_OS_PROP             "os"
 955 #define FIT_COMP_PROP           "compression"
 956 #define FIT_ENTRY_PROP          "entry"
 957 #define FIT_LOAD_PROP           "load"
 958
 959 /* configuration node */
 960 #define FIT_KERNEL_PROP         "kernel"
 961 #define FIT_RAMDISK_PROP        "ramdisk"
 962 #define FIT_FDT_PROP            "fdt"
 963 #define FIT_LOADABLE_PROP       "loadables"
 964 #define FIT_DEFAULT_PROP        "default"
 965 #define FIT_SETUP_PROP          "setup"
 966 #define FIT_FPGA_PROP           "fpga"
 967 #define FIT_FIRMWARE_PROP       "firmware"
 968 #define FIT_STANDALONE_PROP     "standalone"
 969
 970 #define FIT_MAX_HASH_LEN        HASH_MAX_DIGEST_SIZE
 971
 972 #if CONFIG_IS_ENABLED(FIT)
 973 /* cmdline argument format parsing */
 974 int fit_parse_conf(const char *spec, ulong addr_curr,
 975                 ulong *addr, const char **conf_name);
 976 int fit_parse_subimage(const char *spec, ulong addr_curr,
 977                 ulong *addr, const char **image_name);
 978
 979 int fit_get_subimage_count(const void *fit, int images_noffset);
 980 void fit_print_contents(const void *fit);
 981 void fit_image_print(const void *fit, int noffset, const char *p);
 982
 983 /**
 984  * fit_get_end - get FIT image size
 985  * @fit: pointer to the FIT format image header
 986  *
 987  * returns:
 988  *     size of the FIT image (blob) in memory
 989  */
 990 static inline ulong fit_get_size(const void *fit)
 991 {
 992         return fdt_totalsize(fit);
 993 }
 994
 995 /**
 996  * fit_get_end - get FIT image end
 997  * @fit: pointer to the FIT format image header
 998  *
 999  * returns:
1000  *     end address of the FIT image (blob) in memory
1001  */
1002 ulong fit_get_end(const void *fit);
1003
1004 /**
1005  * fit_get_name - get FIT node name
1006  * @fit: pointer to the FIT format image header
1007  *
1008  * returns:
1009  *     NULL, on error
1010  *     pointer to node name, on success
1011  */
1012 static inline const char *fit_get_name(const void *fit_hdr,
1013                 int noffset, int *len)
1014 {
1015         return fdt_get_name(fit_hdr, noffset, len);
1016 }
1017
1018 int fit_get_desc(const void *fit, int noffset, char **desc);
1019 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1020
1021 int fit_image_get_node(const void *fit, const char *image_uname);
1022 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1023 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1024 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1025 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1026 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1027 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1028 int fit_image_get_data(const void *fit, int noffset,
1029                                 const void **data, size_t *size);
1030 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1031 int fit_image_get_data_position(const void *fit, int noffset,
1032                                 int *data_position);
1033 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1034 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1035                                        size_t *data_size);
1036 int fit_image_get_data_and_size(const void *fit, int noffset,
1037                                 const void **data, size_t *size);
1038
1039 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1040 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1041                                 int *value_len);
1042
1043 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1044
1045 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1046                     const char *comment, int require_keys,
1047                     const char *engine_id, const char *cmdname);
1048
1049 /**
1050  * fit_add_verification_data() - add verification data to FIT image nodes
1051  *
1052  * @keydir:     Directory containing keys
1053  * @kwydest:    FDT blob to write public key information to
1054  * @fit:        Pointer to the FIT format image header
1055  * @comment:    Comment to add to signature nodes
1056  * @require_keys: Mark all keys as 'required'
1057  * @engine_id:  Engine to use for signing
1058  * @cmdname:    Command name used when reporting errors
1059  *
1060  * Adds hash values for all component images in the FIT blob.
1061  * Hashes are calculated for all component images which have hash subnodes
1062  * with algorithm property set to one of the supported hash algorithms.
1063  *
1064  * Also add signatures if signature nodes are present.
1065  *
1066  * returns
1067  *     0, on success
1068  *     libfdt error code, on failure
1069  */
1070 int fit_add_verification_data(const char *keydir, const char *keyfile,
1071                               void *keydest, void *fit, const char *comment,
1072                               int require_keys, const char *engine_id,
1073                               const char *cmdname);
1074
1075 int fit_image_verify_with_data(const void *fit, int image_noffset,
1076                                const void *data, size_t size);
1077 int fit_image_verify(const void *fit, int noffset);
1078 int fit_config_verify(const void *fit, int conf_noffset);
1079 int fit_all_image_verify(const void *fit);
1080 int fit_config_decrypt(const void *fit, int conf_noffset);
1081 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1082 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1083 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1084 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1085
1086 /**
1087  * fit_check_format() - Check that the FIT is valid
1088  *
1089  * This performs various checks on the FIT to make sure it is suitable for
1090  * use, looking for mandatory properties, nodes, etc.
1091  *
1092  * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1093  * sure that there are no strange tags or broken nodes in the FIT.
1094  *
1095  * @fit: pointer to the FIT format image header
1096  * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1097  *      failed (e.g. due to bad structure), -ENOMSG if the description is
1098  *      missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1099  *      path is missing
1100  */
1101 int fit_check_format(const void *fit, ulong size);
1102
1103 int fit_conf_find_compat(const void *fit, const void *fdt);
1104
1105 /**
1106  * fit_conf_get_node - get node offset for configuration of a given unit name
1107  * @fit: pointer to the FIT format image header
1108  * @conf_uname: configuration node unit name (NULL to use default)
1109  *
1110  * fit_conf_get_node() finds a configuration (within the '/configurations'
1111  * parent node) of a provided unit name. If configuration is found its node
1112  * offset is returned to the caller.
1113  *
1114  * When NULL is provided in second argument fit_conf_get_node() will search
1115  * for a default configuration node instead. Default configuration node unit
1116  * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1117  * node.
1118  *
1119  * returns:
1120  *     configuration node offset when found (>=0)
1121  *     negative number on failure (FDT_ERR_* code)
1122  */
1123 int fit_conf_get_node(const void *fit, const char *conf_uname);
1124
1125 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1126                 const char *prop_name);
1127 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1128                 const char *prop_name, int index);
1129
1130 /**
1131  * fit_conf_get_prop_node() - Get node refered to by a configuration
1132  * @fit:        FIT to check
1133  * @noffset:    Offset of conf@xxx node to check
1134  * @prop_name:  Property to read from the conf node
1135  *
1136  * The conf- nodes contain references to other nodes, using properties
1137  * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1138  * return the offset of the node referred to (e.g. offset of node
1139  * "/images/kernel".
1140  */
1141 int fit_conf_get_prop_node(const void *fit, int noffset,
1142                 const char *prop_name);
1143
1144 int fit_check_ramdisk(const void *fit, int os_noffset,
1145                 uint8_t arch, int verify);
1146 #endif /* FIT */
1147
1148 int calculate_hash(const void *data, int data_len, const char *algo,
1149                         uint8_t *value, int *value_len);
1150
1151 /*
1152  * At present we only support signing on the host, and verification on the
1153  * device
1154  */
1155 #if defined(USE_HOSTCC)
1156 # if defined(CONFIG_FIT_SIGNATURE)
1157 #  define IMAGE_ENABLE_SIGN     1
1158 #  define FIT_IMAGE_ENABLE_VERIFY       1
1159 #  include <openssl/evp.h>
1160 # else
1161 #  define IMAGE_ENABLE_SIGN     0
1162 #  define FIT_IMAGE_ENABLE_VERIFY       0
1163 # endif
1164 #else
1165 # define IMAGE_ENABLE_SIGN      0
1166 # define FIT_IMAGE_ENABLE_VERIFY        CONFIG_IS_ENABLED(FIT_SIGNATURE)
1167 #endif
1168
1169 #if CONFIG_IS_ENABLED(FIT)
1170 #ifdef USE_HOSTCC
1171 void *image_get_host_blob(void);
1172 void image_set_host_blob(void *host_blob);
1173 # define gd_fdt_blob()          image_get_host_blob()
1174 #else
1175 # define gd_fdt_blob()          (gd->fdt_blob)
1176 #endif
1177
1178 #endif /* IMAGE_ENABLE_FIT */
1179
1180 /*
1181  * Information passed to the signing routines
1182  *
1183  * Either 'keydir',  'keyname', or 'keyfile' can be NULL. However, either
1184  * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1185  * neither are valid, some operations might fail with EINVAL.
1186  */
1187 struct image_sign_info {
1188         const char *keydir;             /* Directory conaining keys */
1189         const char *keyname;            /* Name of key to use */
1190         const char *keyfile;            /* Filename of private or public key */
1191         void *fit;                      /* Pointer to FIT blob */
1192         int node_offset;                /* Offset of signature node */
1193         const char *name;               /* Algorithm name */
1194         struct checksum_algo *checksum; /* Checksum algorithm information */
1195         struct padding_algo *padding;   /* Padding algorithm information */
1196         struct crypto_algo *crypto;     /* Crypto algorithm information */
1197         const void *fdt_blob;           /* FDT containing public keys */
1198         int required_keynode;           /* Node offset of key to use: -1=any */
1199         const char *require_keys;       /* Value for 'required' property */
1200         const char *engine_id;          /* Engine to use for signing */
1201         /*
1202          * Note: the following two fields are always valid even w/o
1203          * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1204          * the same on target and host. Otherwise, vboot test may fail.
1205          */
1206         const void *key;                /* Pointer to public key in DER */
1207         int keylen;                     /* Length of public key */
1208 };
1209
1210 /* A part of an image, used for hashing */
1211 struct image_region {
1212         const void *data;
1213         int size;
1214 };
1215
1216 #if FIT_IMAGE_ENABLE_VERIFY
1217 # include <u-boot/hash-checksum.h>
1218 #endif
1219 struct checksum_algo {
1220         const char *name;
1221         const int checksum_len;
1222         const int der_len;
1223         const uint8_t *der_prefix;
1224 #if IMAGE_ENABLE_SIGN
1225         const EVP_MD *(*calculate_sign)(void);
1226 #endif
1227         int (*calculate)(const char *name,
1228                          const struct image_region region[],
1229                          int region_count, uint8_t *checksum);
1230 };
1231
1232 struct crypto_algo {
1233         const char *name;               /* Name of algorithm */
1234         const int key_len;
1235
1236         /**
1237          * sign() - calculate and return signature for given input data
1238          *
1239          * @info:       Specifies key and FIT information
1240          * @data:       Pointer to the input data
1241          * @data_len:   Data length
1242          * @sigp:       Set to an allocated buffer holding the signature
1243          * @sig_len:    Set to length of the calculated hash
1244          *
1245          * This computes input data signature according to selected algorithm.
1246          * Resulting signature value is placed in an allocated buffer, the
1247          * pointer is returned as *sigp. The length of the calculated
1248          * signature is returned via the sig_len pointer argument. The caller
1249          * should free *sigp.
1250          *
1251          * @return: 0, on success, -ve on error
1252          */
1253         int (*sign)(struct image_sign_info *info,
1254                     const struct image_region region[],
1255                     int region_count, uint8_t **sigp, uint *sig_len);
1256
1257         /**
1258          * add_verify_data() - Add verification information to FDT
1259          *
1260          * Add public key information to the FDT node, suitable for
1261          * verification at run-time. The information added depends on the
1262          * algorithm being used.
1263          *
1264          * @info:       Specifies key and FIT information
1265          * @keydest:    Destination FDT blob for public key data
1266          * @return: 0, on success, -ve on error
1267          */
1268         int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1269
1270         /**
1271          * verify() - Verify a signature against some data
1272          *
1273          * @info:       Specifies key and FIT information
1274          * @data:       Pointer to the input data
1275          * @data_len:   Data length
1276          * @sig:        Signature
1277          * @sig_len:    Number of bytes in signature
1278          * @return 0 if verified, -ve on error
1279          */
1280         int (*verify)(struct image_sign_info *info,
1281                       const struct image_region region[], int region_count,
1282                       uint8_t *sig, uint sig_len);
1283 };
1284
1285 /* Declare a new U-Boot crypto algorithm handler */
1286 #define U_BOOT_CRYPTO_ALGO(__name)                                              \
1287 ll_entry_declare(struct crypto_algo, __name, cryptos)
1288
1289 struct padding_algo {
1290         const char *name;
1291         int (*verify)(struct image_sign_info *info,
1292                       uint8_t *pad, int pad_len,
1293                       const uint8_t *hash, int hash_len);
1294 };
1295
1296 /* Declare a new U-Boot padding algorithm handler */
1297 #define U_BOOT_PADDING_ALGO(__name)                                             \
1298 ll_entry_declare(struct padding_algo, __name, paddings)
1299
1300 /**
1301  * image_get_checksum_algo() - Look up a checksum algorithm
1302  *
1303  * @param full_name     Name of algorithm in the form "checksum,crypto"
1304  * @return pointer to algorithm information, or NULL if not found
1305  */
1306 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1307
1308 /**
1309  * image_get_crypto_algo() - Look up a cryptosystem algorithm
1310  *
1311  * @param full_name     Name of algorithm in the form "checksum,crypto"
1312  * @return pointer to algorithm information, or NULL if not found
1313  */
1314 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1315
1316 /**
1317  * image_get_padding_algo() - Look up a padding algorithm
1318  *
1319  * @param name          Name of padding algorithm
1320  * @return pointer to algorithm information, or NULL if not found
1321  */
1322 struct padding_algo *image_get_padding_algo(const char *name);
1323
1324 #if CONFIG_IS_ENABLED(FIT)
1325
1326 /**
1327  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1328  *
1329  * @fit:                FIT to check
1330  * @image_noffset:      Offset of image node to check
1331  * @data:               Image data to check
1332  * @size:               Size of image data
1333  * @sig_blob:           FDT containing public keys
1334  * @no_sigsp:           Returns 1 if no signatures were required, and
1335  *                      therefore nothing was checked. The caller may wish
1336  *                      to fall back to other mechanisms, or refuse to
1337  *                      boot.
1338  * @return 0 if all verified ok, <0 on error
1339  */
1340 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1341                 const char *data, size_t size, const void *sig_blob,
1342                 int *no_sigsp);
1343
1344 /**
1345  * fit_image_check_sig() - Check a single image signature node
1346  *
1347  * @fit:                FIT to check
1348  * @noffset:            Offset of signature node to check
1349  * @data:               Image data to check
1350  * @size:               Size of image data
1351  * @required_keynode:   Offset in the control FDT of the required key node,
1352  *                      if any. If this is given, then the image wil not
1353  *                      pass verification unless that key is used. If this is
1354  *                      -1 then any signature will do.
1355  * @err_msgp:           In the event of an error, this will be pointed to a
1356  *                      help error string to display to the user.
1357  * @return 0 if all verified ok, <0 on error
1358  */
1359 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1360                 size_t size, int required_keynode, char **err_msgp);
1361
1362 int fit_image_decrypt_data(const void *fit,
1363                            int image_noffset, int cipher_noffset,
1364                            const void *data, size_t size,
1365                            void **data_unciphered, size_t *size_unciphered);
1366
1367 /**
1368  * fit_region_make_list() - Make a list of regions to hash
1369  *
1370  * Given a list of FIT regions (offset, size) provided by libfdt, create
1371  * a list of regions (void *, size) for use by the signature creationg
1372  * and verification code.
1373  *
1374  * @fit:                FIT image to process
1375  * @fdt_regions:        Regions as returned by libfdt
1376  * @count:              Number of regions returned by libfdt
1377  * @region:             Place to put list of regions (NULL to allocate it)
1378  * @return pointer to list of regions, or NULL if out of memory
1379  */
1380 struct image_region *fit_region_make_list(const void *fit,
1381                 struct fdt_region *fdt_regions, int count,
1382                 struct image_region *region);
1383
1384 static inline int fit_image_check_target_arch(const void *fdt, int node)
1385 {
1386 #ifndef USE_HOSTCC
1387         return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1388 #else
1389         return 0;
1390 #endif
1391 }
1392
1393 /*
1394  * At present we only support ciphering on the host, and unciphering on the
1395  * device
1396  */
1397 #if defined(USE_HOSTCC)
1398 # if defined(CONFIG_FIT_CIPHER)
1399 #  define IMAGE_ENABLE_ENCRYPT  1
1400 #  define IMAGE_ENABLE_DECRYPT  1
1401 #  include <openssl/evp.h>
1402 # else
1403 #  define IMAGE_ENABLE_ENCRYPT  0
1404 #  define IMAGE_ENABLE_DECRYPT  0
1405 # endif
1406 #else
1407 # define IMAGE_ENABLE_ENCRYPT   0
1408 # define IMAGE_ENABLE_DECRYPT   CONFIG_IS_ENABLED(FIT_CIPHER)
1409 #endif
1410
1411 /* Information passed to the ciphering routines */
1412 struct image_cipher_info {
1413         const char *keydir;             /* Directory containing keys */
1414         const char *keyname;            /* Name of key to use */
1415         const char *ivname;             /* Name of IV to use */
1416         const void *fit;                /* Pointer to FIT blob */
1417         int node_noffset;               /* Offset of the cipher node */
1418         const char *name;               /* Algorithm name */
1419         struct cipher_algo *cipher;     /* Cipher algorithm information */
1420         const void *fdt_blob;           /* FDT containing key and IV */
1421         const void *key;                /* Value of the key */
1422         const void *iv;                 /* Value of the IV */
1423         size_t size_unciphered;         /* Size of the unciphered data */
1424 };
1425
1426 struct cipher_algo {
1427         const char *name;               /* Name of algorithm */
1428         int key_len;                    /* Length of the key */
1429         int iv_len;                     /* Length of the IV */
1430
1431 #if IMAGE_ENABLE_ENCRYPT
1432         const EVP_CIPHER * (*calculate_type)(void);
1433 #endif
1434
1435         int (*encrypt)(struct image_cipher_info *info,
1436                        const unsigned char *data, int data_len,
1437                        unsigned char **cipher, int *cipher_len);
1438
1439         int (*add_cipher_data)(struct image_cipher_info *info,
1440                                void *keydest, void *fit, int node_noffset);
1441
1442         int (*decrypt)(struct image_cipher_info *info,
1443                        const void *cipher, size_t cipher_len,
1444                        void **data, size_t *data_len);
1445 };
1446
1447 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1448
1449 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1450
1451 #if CONFIG_IS_ENABLED(FIT_VERBOSE)
1452 #define fit_unsupported(msg)    printf("! %s:%d " \
1453                                 "FIT images not supported for '%s'\n", \
1454                                 __FILE__, __LINE__, (msg))
1455
1456 #define fit_unsupported_reset(msg)      printf("! %s:%d " \
1457                                 "FIT images not supported for '%s' " \
1458                                 "- must reset board to recover!\n", \
1459                                 __FILE__, __LINE__, (msg))
1460 #else
1461 #define fit_unsupported(msg)
1462 #define fit_unsupported_reset(msg)
1463 #endif /* FIT_VERBOSE */
1464 #endif /* CONFIG_FIT */
1465
1466 #if !defined(USE_HOSTCC)
1467 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1468 struct andr_img_hdr;
1469 int android_image_check_header(const struct andr_img_hdr *hdr);
1470 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1471                              ulong *os_data, ulong *os_len);
1472 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1473                               ulong *rd_data, ulong *rd_len);
1474 int android_image_get_second(const struct andr_img_hdr *hdr,
1475                               ulong *second_data, ulong *second_len);
1476 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1477 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1478                                     u32 *size);
1479 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1480 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1481 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1482 void android_print_contents(const struct andr_img_hdr *hdr);
1483 #if !defined(CONFIG_SPL_BUILD)
1484 bool android_image_print_dtb_contents(ulong hdr_addr);
1485 #endif
1486
1487 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1488 #endif /* !USE_HOSTCC */
1489
1490 /**
1491  * board_fit_config_name_match() - Check for a matching board name
1492  *
1493  * This is used when SPL loads a FIT containing multiple device tree files
1494  * and wants to work out which one to use. The description of each one is
1495  * passed to this function. The description comes from the 'description' field
1496  * in each (FDT) image node.
1497  *
1498  * @name: Device tree description
1499  * @return 0 if this device tree should be used, non-zero to try the next
1500  */
1501 int board_fit_config_name_match(const char *name);
1502
1503 /**
1504  * board_fit_image_post_process() - Do any post-process on FIT binary data
1505  *
1506  * This is used to do any sort of image manipulation, verification, decryption
1507  * etc. in a platform or board specific way. Obviously, anything done here would
1508  * need to be comprehended in how the images were prepared before being injected
1509  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1510  * before being added to the FIT image).
1511  *
1512  * @fit: pointer to fit image
1513  * @node: offset of image node
1514  * @image: pointer to the image start pointer
1515  * @size: pointer to the image size
1516  * @return no return value (failure should be handled internally)
1517  */
1518 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1519                                   size_t *p_size);
1520
1521 #define FDT_ERROR       ((ulong)(-1))
1522
1523 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1524
1525 /**
1526  * fit_find_config_node() - Find the node for the best DTB in a FIT image
1527  *
1528  * A FIT image contains one or more DTBs. This function parses the
1529  * configurations described in the FIT images and returns the node of
1530  * the first matching DTB. To check if a DTB matches a board, this function
1531  * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1532  * the node described by the default configuration if it exists.
1533  *
1534  * @fdt: pointer to flat device tree
1535  * @return the node if found, -ve otherwise
1536  */
1537 int fit_find_config_node(const void *fdt);
1538
1539 /**
1540  * Mapping of image types to function handlers to be invoked on the associated
1541  * loaded images
1542  *
1543  * @type: Type of image, I.E. IH_TYPE_*
1544  * @handler: Function to call on loaded image
1545  */
1546 struct fit_loadable_tbl {
1547         int type;
1548         /**
1549          * handler() - Process a loaded image
1550          *
1551          * @data: Pointer to start of loaded image data
1552          * @size: Size of loaded image data
1553          */
1554         void (*handler)(ulong data, size_t size);
1555 };
1556
1557 /*
1558  * Define a FIT loadable image type handler
1559  *
1560  * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1561  * _handler is the handler function to call after this image type is loaded
1562  */
1563 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1564         ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1565                 .type = _type, \
1566                 .handler = _handler, \
1567         }
1568
1569 /**
1570  * fit_update - update storage with FIT image
1571  * @fit:        Pointer to FIT image
1572  *
1573  * Update firmware on storage using FIT image as input.
1574  * The storage area to be update will be identified by the name
1575  * in FIT and matching it to "dfu_alt_info" variable.
1576  *
1577  * Return:      0 on success, non-zero otherwise
1578  */
1579 int fit_update(const void *fit);
1580
1581 #endif  /* __IMAGE_H__ */