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