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
 330         IH_COMP_COUNT,
 331 };
 332
 333 #define LZ4F_MAGIC      0x184D2204      /* LZ4 Magic Number             */
 334 #define IH_MAGIC        0x27051956      /* Image Magic Number           */
 335 #define IH_NMLEN                32      /* Image Name Length            */
 336
 337 /* Reused from common.h */
 338 #define ROUND(a, b)             (((a) + (b) - 1) & ~((b) - 1))
 339
 340 /*
 341  * Legacy format image header,
 342  * all data in network byte order (aka natural aka bigendian).
 343  */
 344 typedef struct image_header {
 345         uint32_t        ih_magic;       /* Image Header Magic Number    */
 346         uint32_t        ih_hcrc;        /* Image Header CRC Checksum    */
 347         uint32_t        ih_time;        /* Image Creation Timestamp     */
 348         uint32_t        ih_size;        /* Image Data Size              */
 349         uint32_t        ih_load;        /* Data  Load  Address          */
 350         uint32_t        ih_ep;          /* Entry Point Address          */
 351         uint32_t        ih_dcrc;        /* Image Data CRC Checksum      */
 352         uint8_t         ih_os;          /* Operating System             */
 353         uint8_t         ih_arch;        /* CPU architecture             */
 354         uint8_t         ih_type;        /* Image Type                   */
 355         uint8_t         ih_comp;        /* Compression Type             */
 356         uint8_t         ih_name[IH_NMLEN];      /* Image Name           */
 357 } image_header_t;
 358
 359 typedef struct image_info {
 360         ulong           start, end;             /* start/end of blob */
 361         ulong           image_start, image_len; /* start of image within blob, len of image */
 362         ulong           load;                   /* load addr for the image */
 363         uint8_t         comp, type, os;         /* compression, type of image, os type */
 364         uint8_t         arch;                   /* CPU architecture */
 365 } image_info_t;
 366
 367 /*
 368  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
 369  * routines.
 370  */
 371 typedef struct bootm_headers {
 372         /*
 373          * Legacy os image header, if it is a multi component image
 374          * then boot_get_ramdisk() and get_fdt() will attempt to get
 375          * data from second and third component accordingly.
 376          */
 377         image_header_t  *legacy_hdr_os;         /* image header pointer */
 378         image_header_t  legacy_hdr_os_copy;     /* header copy */
 379         ulong           legacy_hdr_valid;
 380
 381 #if IMAGE_ENABLE_FIT
 382         const char      *fit_uname_cfg; /* configuration node unit name */
 383
 384         void            *fit_hdr_os;    /* os FIT image header */
 385         const char      *fit_uname_os;  /* os subimage node unit name */
 386         int             fit_noffset_os; /* os subimage node offset */
 387
 388         void            *fit_hdr_rd;    /* init ramdisk FIT image header */
 389         const char      *fit_uname_rd;  /* init ramdisk subimage node unit name */
 390         int             fit_noffset_rd; /* init ramdisk subimage node offset */
 391
 392         void            *fit_hdr_fdt;   /* FDT blob FIT image header */
 393         const char      *fit_uname_fdt; /* FDT blob subimage node unit name */
 394         int             fit_noffset_fdt;/* FDT blob subimage node offset */
 395
 396         void            *fit_hdr_setup; /* x86 setup FIT image header */
 397         const char      *fit_uname_setup; /* x86 setup subimage node name */
 398         int             fit_noffset_setup;/* x86 setup subimage node offset */
 399 #endif
 400
 401 #ifndef USE_HOSTCC
 402         image_info_t    os;             /* os image info */
 403         ulong           ep;             /* entry point of OS */
 404
 405         ulong           rd_start, rd_end;/* ramdisk start/end */
 406
 407         char            *ft_addr;       /* flat dev tree address */
 408         ulong           ft_len;         /* length of flat device tree */
 409
 410         ulong           initrd_start;
 411         ulong           initrd_end;
 412         ulong           cmdline_start;
 413         ulong           cmdline_end;
 414         bd_t            *kbd;
 415 #endif
 416
 417         int             verify;         /* env_get("verify")[0] != 'n' */
 418
 419 #define BOOTM_STATE_START       (0x00000001)
 420 #define BOOTM_STATE_FINDOS      (0x00000002)
 421 #define BOOTM_STATE_FINDOTHER   (0x00000004)
 422 #define BOOTM_STATE_LOADOS      (0x00000008)
 423 #define BOOTM_STATE_RAMDISK     (0x00000010)
 424 #define BOOTM_STATE_FDT         (0x00000020)
 425 #define BOOTM_STATE_OS_CMDLINE  (0x00000040)
 426 #define BOOTM_STATE_OS_BD_T     (0x00000080)
 427 #define BOOTM_STATE_OS_PREP     (0x00000100)
 428 #define BOOTM_STATE_OS_FAKE_GO  (0x00000200)    /* 'Almost' run the OS */
 429 #define BOOTM_STATE_OS_GO       (0x00000400)
 430         int             state;
 431
 432 #ifdef CONFIG_LMB
 433         struct lmb      lmb;            /* for memory mgmt */
 434 #endif
 435 } bootm_headers_t;
 436
 437 extern bootm_headers_t images;
 438
 439 /*
 440  * Some systems (for example LWMON) have very short watchdog periods;
 441  * we must make sure to split long operations like memmove() or
 442  * checksum calculations into reasonable chunks.
 443  */
 444 #ifndef CHUNKSZ
 445 #define CHUNKSZ (64 * 1024)
 446 #endif
 447
 448 #ifndef CHUNKSZ_CRC32
 449 #define CHUNKSZ_CRC32 (64 * 1024)
 450 #endif
 451
 452 #ifndef CHUNKSZ_MD5
 453 #define CHUNKSZ_MD5 (64 * 1024)
 454 #endif
 455
 456 #ifndef CHUNKSZ_SHA1
 457 #define CHUNKSZ_SHA1 (64 * 1024)
 458 #endif
 459
 460 #define uimage_to_cpu(x)                be32_to_cpu(x)
 461 #define cpu_to_uimage(x)                cpu_to_be32(x)
 462
 463 /*
 464  * Translation table for entries of a specific type; used by
 465  * get_table_entry_id() and get_table_entry_name().
 466  */
 467 typedef struct table_entry {
 468         int     id;
 469         char    *sname;         /* short (input) name to find table entry */
 470         char    *lname;         /* long (output) name to print for messages */
 471 } table_entry_t;
 472
 473 /*
 474  * Compression type and magic number mapping table.
 475  */
 476 struct comp_magic_map {
 477         int             comp_id;
 478         const char      *name;
 479         unsigned char   magic[2];
 480 };
 481
 482 /*
 483  * get_table_entry_id() scans the translation table trying to find an
 484  * entry that matches the given short name. If a matching entry is
 485  * found, it's id is returned to the caller.
 486  */
 487 int get_table_entry_id(const table_entry_t *table,
 488                 const char *table_name, const char *name);
 489 /*
 490  * get_table_entry_name() scans the translation table trying to find
 491  * an entry that matches the given id. If a matching entry is found,
 492  * its long name is returned to the caller.
 493  */
 494 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
 495
 496 const char *genimg_get_os_name(uint8_t os);
 497
 498 /**
 499  * genimg_get_os_short_name() - get the short name for an OS
 500  *
 501  * @param os    OS (IH_OS_...)
 502  * @return OS short name, or "unknown" if unknown
 503  */
 504 const char *genimg_get_os_short_name(uint8_t comp);
 505
 506 const char *genimg_get_arch_name(uint8_t arch);
 507
 508 /**
 509  * genimg_get_arch_short_name() - get the short name for an architecture
 510  *
 511  * @param arch  Architecture type (IH_ARCH_...)
 512  * @return architecture short name, or "unknown" if unknown
 513  */
 514 const char *genimg_get_arch_short_name(uint8_t arch);
 515
 516 const char *genimg_get_type_name(uint8_t type);
 517
 518 /**
 519  * genimg_get_type_short_name() - get the short name for an image type
 520  *
 521  * @param type  Image type (IH_TYPE_...)
 522  * @return image short name, or "unknown" if unknown
 523  */
 524 const char *genimg_get_type_short_name(uint8_t type);
 525
 526 const char *genimg_get_comp_name(uint8_t comp);
 527
 528 /**
 529  * genimg_get_comp_short_name() - get the short name for a compression method
 530  *
 531  * @param comp  compression method (IH_COMP_...)
 532  * @return compression method short name, or "unknown" if unknown
 533  */
 534 const char *genimg_get_comp_short_name(uint8_t comp);
 535
 536 /**
 537  * genimg_get_cat_name() - Get the name of an item in a category
 538  *
 539  * @category:   Category of item
 540  * @id:         Item ID
 541  * @return name of item, or "Unknown ..." if unknown
 542  */
 543 const char *genimg_get_cat_name(enum ih_category category, uint id);
 544
 545 /**
 546  * genimg_get_cat_short_name() - Get the short name of an item in a category
 547  *
 548  * @category:   Category of item
 549  * @id:         Item ID
 550  * @return short name of item, or "Unknown ..." if unknown
 551  */
 552 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
 553
 554 /**
 555  * genimg_get_cat_count() - Get the number of items in a category
 556  *
 557  * @category:   Category to check
 558  * @return the number of items in the category (IH_xxx_COUNT)
 559  */
 560 int genimg_get_cat_count(enum ih_category category);
 561
 562 /**
 563  * genimg_get_cat_desc() - Get the description of a category
 564  *
 565  * @return the description of a category, e.g. "architecture". This
 566  * effectively converts the enum to a string.
 567  */
 568 const char *genimg_get_cat_desc(enum ih_category category);
 569
 570 int genimg_get_os_id(const char *name);
 571 int genimg_get_arch_id(const char *name);
 572 int genimg_get_type_id(const char *name);
 573 int genimg_get_comp_id(const char *name);
 574 void genimg_print_size(uint32_t size);
 575
 576 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
 577         defined(USE_HOSTCC)
 578 #define IMAGE_ENABLE_TIMESTAMP 1
 579 #else
 580 #define IMAGE_ENABLE_TIMESTAMP 0
 581 #endif
 582 void genimg_print_time(time_t timestamp);
 583
 584 /* What to do with a image load address ('load = <> 'in the FIT) */
 585 enum fit_load_op {
 586         FIT_LOAD_IGNORED,       /* Ignore load address */
 587         FIT_LOAD_OPTIONAL,      /* Can be provided, but optional */
 588         FIT_LOAD_OPTIONAL_NON_ZERO,     /* Optional, a value of 0 is ignored */
 589         FIT_LOAD_REQUIRED,      /* Must be provided */
 590 };
 591
 592 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
 593                    ulong *setup_len);
 594
 595 #ifndef USE_HOSTCC
 596 /* Image format types, returned by _get_format() routine */
 597 #define IMAGE_FORMAT_INVALID    0x00
 598 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 599 #define IMAGE_FORMAT_LEGACY     0x01    /* legacy image_header based format */
 600 #endif
 601 #define IMAGE_FORMAT_FIT        0x02    /* new, libfdt based format */
 602 #define IMAGE_FORMAT_ANDROID    0x03    /* Android boot image */
 603
 604 ulong genimg_get_kernel_addr_fit(char * const img_addr,
 605                                  const char **fit_uname_config,
 606                                  const char **fit_uname_kernel);
 607 ulong genimg_get_kernel_addr(char * const img_addr);
 608 int genimg_get_format(const void *img_addr);
 609 int genimg_has_config(bootm_headers_t *images);
 610
 611 int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
 612                   uint8_t arch, const ulong *ld_start, ulong * const ld_len);
 613 int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
 614                      uint8_t arch, ulong *rd_start, ulong *rd_end);
 615
 616 /**
 617  * boot_get_loadable - routine to load a list of binaries to memory
 618  * @argc: Ignored Argument
 619  * @argv: Ignored Argument
 620  * @images: pointer to the bootm images structure
 621  * @arch: expected architecture for the image
 622  * @ld_start: Ignored Argument
 623  * @ld_len: Ignored Argument
 624  *
 625  * boot_get_loadable() will take the given FIT configuration, and look
 626  * for a field named "loadables".  Loadables, is a list of elements in
 627  * the FIT given as strings.  exe:
 628  *   loadables = "linux_kernel", "fdt-2";
 629  * this function will attempt to parse each string, and load the
 630  * corresponding element from the FIT into memory.  Once placed,
 631  * no aditional actions are taken.
 632  *
 633  * @return:
 634  *     0, if only valid images or no images are found
 635  *     error code, if an error occurs during fit_image_load
 636  */
 637 int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
 638                       uint8_t arch, const ulong *ld_start, ulong *const ld_len);
 639 #endif /* !USE_HOSTCC */
 640
 641 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
 642                        ulong *setup_start, ulong *setup_len);
 643
 644 /**
 645  * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
 646  *
 647  * This deals with all aspects of loading an DTB from a FIT.
 648  * The correct base image based on configuration will be selected, and
 649  * then any overlays specified will be applied (as present in fit_uname_configp).
 650  *
 651  * @param images        Boot images structure
 652  * @param addr          Address of FIT in memory
 653  * @param fit_unamep    On entry this is the requested image name
 654  *                      (e.g. "kernel") or NULL to use the default. On exit
 655  *                      points to the selected image name
 656  * @param fit_uname_configp     On entry this is the requested configuration
 657  *                      name (e.g. "conf-1") or NULL to use the default. On
 658  *                      exit points to the selected configuration name.
 659  * @param arch          Expected architecture (IH_ARCH_...)
 660  * @param datap         Returns address of loaded image
 661  * @param lenp          Returns length of loaded image
 662  *
 663  * @return node offset of base image, or -ve error code on error
 664  */
 665 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
 666                    const char **fit_unamep, const char **fit_uname_configp,
 667                    int arch, ulong *datap, ulong *lenp);
 668
 669 /**
 670  * fit_image_load() - load an image from a FIT
 671  *
 672  * This deals with all aspects of loading an image from a FIT, including
 673  * selecting the right image based on configuration, verifying it, printing
 674  * out progress messages, checking the type/arch/os and optionally copying it
 675  * to the right load address.
 676  *
 677  * The property to look up is defined by image_type.
 678  *
 679  * @param images        Boot images structure
 680  * @param addr          Address of FIT in memory
 681  * @param fit_unamep    On entry this is the requested image name
 682  *                      (e.g. "kernel") or NULL to use the default. On exit
 683  *                      points to the selected image name
 684  * @param fit_uname_configp     On entry this is the requested configuration
 685  *                      name (e.g. "conf-1") or NULL to use the default. On
 686  *                      exit points to the selected configuration name.
 687  * @param arch          Expected architecture (IH_ARCH_...)
 688  * @param image_type    Required image type (IH_TYPE_...). If this is
 689  *                      IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
 690  *                      also.
 691  * @param bootstage_id  ID of starting bootstage to use for progress updates.
 692  *                      This will be added to the BOOTSTAGE_SUB values when
 693  *                      calling bootstage_mark()
 694  * @param load_op       Decribes what to do with the load address
 695  * @param datap         Returns address of loaded image
 696  * @param lenp          Returns length of loaded image
 697  * @return node offset of image, or -ve error code on error
 698  */
 699 int fit_image_load(bootm_headers_t *images, ulong addr,
 700                    const char **fit_unamep, const char **fit_uname_configp,
 701                    int arch, int image_type, int bootstage_id,
 702                    enum fit_load_op load_op, ulong *datap, ulong *lenp);
 703
 704 /**
 705  * image_source_script() - Execute a script
 706  *
 707  * Executes a U-Boot script at a particular address in memory. The script should
 708  * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
 709  *
 710  * @addr: Address of script
 711  * @fit_uname: FIT subimage name
 712  * @return result code (enum command_ret_t)
 713  */
 714 int image_source_script(ulong addr, const char *fit_uname);
 715
 716 #ifndef USE_HOSTCC
 717 /**
 718  * fit_get_node_from_config() - Look up an image a FIT by type
 719  *
 720  * This looks in the selected conf- node (images->fit_uname_cfg) for a
 721  * particular image type (e.g. "kernel") and then finds the image that is
 722  * referred to.
 723  *
 724  * For example, for something like:
 725  *
 726  * images {
 727  *      kernel {
 728  *              ...
 729  *      };
 730  * };
 731  * configurations {
 732  *      conf-1 {
 733  *              kernel = "kernel";
 734  *      };
 735  * };
 736  *
 737  * the function will return the node offset of the kernel@1 node, assuming
 738  * that conf-1 is the chosen configuration.
 739  *
 740  * @param images        Boot images structure
 741  * @param prop_name     Property name to look up (FIT_..._PROP)
 742  * @param addr          Address of FIT in memory
 743  */
 744 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
 745                         ulong addr);
 746
 747 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
 748                  bootm_headers_t *images,
 749                  char **of_flat_tree, ulong *of_size);
 750 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
 751 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
 752
 753 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
 754                   ulong *initrd_start, ulong *initrd_end);
 755 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
 756 #ifdef CONFIG_SYS_BOOT_GET_KBD
 757 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
 758 #endif /* CONFIG_SYS_BOOT_GET_KBD */
 759 #endif /* !USE_HOSTCC */
 760
 761 /*******************************************************************/
 762 /* Legacy format specific code (prefixed with image_) */
 763 /*******************************************************************/
 764 static inline uint32_t image_get_header_size(void)
 765 {
 766         return (sizeof(image_header_t));
 767 }
 768
 769 #define image_get_hdr_l(f) \
 770         static inline uint32_t image_get_##f(const image_header_t *hdr) \
 771         { \
 772                 return uimage_to_cpu(hdr->ih_##f); \
 773         }
 774 image_get_hdr_l(magic)          /* image_get_magic */
 775 image_get_hdr_l(hcrc)           /* image_get_hcrc */
 776 image_get_hdr_l(time)           /* image_get_time */
 777 image_get_hdr_l(size)           /* image_get_size */
 778 image_get_hdr_l(load)           /* image_get_load */
 779 image_get_hdr_l(ep)             /* image_get_ep */
 780 image_get_hdr_l(dcrc)           /* image_get_dcrc */
 781
 782 #define image_get_hdr_b(f) \
 783         static inline uint8_t image_get_##f(const image_header_t *hdr) \
 784         { \
 785                 return hdr->ih_##f; \
 786         }
 787 image_get_hdr_b(os)             /* image_get_os */
 788 image_get_hdr_b(arch)           /* image_get_arch */
 789 image_get_hdr_b(type)           /* image_get_type */
 790 image_get_hdr_b(comp)           /* image_get_comp */
 791
 792 static inline char *image_get_name(const image_header_t *hdr)
 793 {
 794         return (char *)hdr->ih_name;
 795 }
 796
 797 static inline uint32_t image_get_data_size(const image_header_t *hdr)
 798 {
 799         return image_get_size(hdr);
 800 }
 801
 802 /**
 803  * image_get_data - get image payload start address
 804  * @hdr: image header
 805  *
 806  * image_get_data() returns address of the image payload. For single
 807  * component images it is image data start. For multi component
 808  * images it points to the null terminated table of sub-images sizes.
 809  *
 810  * returns:
 811  *     image payload data start address
 812  */
 813 static inline ulong image_get_data(const image_header_t *hdr)
 814 {
 815         return ((ulong)hdr + image_get_header_size());
 816 }
 817
 818 static inline uint32_t image_get_image_size(const image_header_t *hdr)
 819 {
 820         return (image_get_size(hdr) + image_get_header_size());
 821 }
 822 static inline ulong image_get_image_end(const image_header_t *hdr)
 823 {
 824         return ((ulong)hdr + image_get_image_size(hdr));
 825 }
 826
 827 #define image_set_hdr_l(f) \
 828         static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
 829         { \
 830                 hdr->ih_##f = cpu_to_uimage(val); \
 831         }
 832 image_set_hdr_l(magic)          /* image_set_magic */
 833 image_set_hdr_l(hcrc)           /* image_set_hcrc */
 834 image_set_hdr_l(time)           /* image_set_time */
 835 image_set_hdr_l(size)           /* image_set_size */
 836 image_set_hdr_l(load)           /* image_set_load */
 837 image_set_hdr_l(ep)             /* image_set_ep */
 838 image_set_hdr_l(dcrc)           /* image_set_dcrc */
 839
 840 #define image_set_hdr_b(f) \
 841         static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
 842         { \
 843                 hdr->ih_##f = val; \
 844         }
 845 image_set_hdr_b(os)             /* image_set_os */
 846 image_set_hdr_b(arch)           /* image_set_arch */
 847 image_set_hdr_b(type)           /* image_set_type */
 848 image_set_hdr_b(comp)           /* image_set_comp */
 849
 850 static inline void image_set_name(image_header_t *hdr, const char *name)
 851 {
 852         strncpy(image_get_name(hdr), name, IH_NMLEN);
 853 }
 854
 855 int image_check_hcrc(const image_header_t *hdr);
 856 int image_check_dcrc(const image_header_t *hdr);
 857 #ifndef USE_HOSTCC
 858 ulong env_get_bootm_low(void);
 859 phys_size_t env_get_bootm_size(void);
 860 phys_size_t env_get_bootm_mapsize(void);
 861 #endif
 862 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
 863
 864 static inline int image_check_magic(const image_header_t *hdr)
 865 {
 866         return (image_get_magic(hdr) == IH_MAGIC);
 867 }
 868 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
 869 {
 870         return (image_get_type(hdr) == type);
 871 }
 872 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
 873 {
 874         return (image_get_arch(hdr) == arch) ||
 875                 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
 876 }
 877 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
 878 {
 879         return (image_get_os(hdr) == os);
 880 }
 881
 882 ulong image_multi_count(const image_header_t *hdr);
 883 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 884                         ulong *data, ulong *len);
 885
 886 void image_print_contents(const void *hdr);
 887
 888 #ifndef USE_HOSTCC
 889 static inline int image_check_target_arch(const image_header_t *hdr)
 890 {
 891 #ifndef IH_ARCH_DEFAULT
 892 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
 893 #endif
 894         return image_check_arch(hdr, IH_ARCH_DEFAULT);
 895 }
 896 #endif /* USE_HOSTCC */
 897
 898 /**
 899  * image_decomp_type() - Find out compression type of an image
 900  *
 901  * @buf:        Address in U-Boot memory where image is loaded.
 902  * @len:        Length of the compressed image.
 903  * @return      compression type or IH_COMP_NONE if not compressed.
 904  *
 905  * Note: Only following compression types are supported now.
 906  * lzo, lzma, gzip, bzip2
 907  */
 908 int image_decomp_type(const unsigned char *buf, ulong len);
 909
 910 /**
 911  * image_decomp() - decompress an image
 912  *
 913  * @comp:       Compression algorithm that is used (IH_COMP_...)
 914  * @load:       Destination load address in U-Boot memory
 915  * @image_start Image start address (where we are decompressing from)
 916  * @type:       OS type (IH_OS_...)
 917  * @load_bug:   Place to decompress to
 918  * @image_buf:  Address to decompress from
 919  * @image_len:  Number of bytes in @image_buf to decompress
 920  * @unc_len:    Available space for decompression
 921  * @return 0 if OK, -ve on error (BOOTM_ERR_...)
 922  */
 923 int image_decomp(int comp, ulong load, ulong image_start, int type,
 924                  void *load_buf, void *image_buf, ulong image_len,
 925                  uint unc_len, ulong *load_end);
 926
 927 /**
 928  * Set up properties in the FDT
 929  *
 930  * This sets up properties in the FDT that is to be passed to linux.
 931  *
 932  * @images:     Images information
 933  * @blob:       FDT to update
 934  * @of_size:    Size of the FDT
 935  * @lmb:        Points to logical memory block structure
 936  * @return 0 if ok, <0 on failure
 937  */
 938 int image_setup_libfdt(bootm_headers_t *images, void *blob,
 939                        int of_size, struct lmb *lmb);
 940
 941 /**
 942  * Set up the FDT to use for booting a kernel
 943  *
 944  * This performs ramdisk setup, sets up the FDT if required, and adds
 945  * paramters to the FDT if libfdt is available.
 946  *
 947  * @param images        Images information
 948  * @return 0 if ok, <0 on failure
 949  */
 950 int image_setup_linux(bootm_headers_t *images);
 951
 952 /**
 953  * bootz_setup() - Extract stat and size of a Linux xImage
 954  *
 955  * @image: Address of image
 956  * @start: Returns start address of image
 957  * @end : Returns end address of image
 958  * @return 0 if OK, 1 if the image was not recognised
 959  */
 960 int bootz_setup(ulong image, ulong *start, ulong *end);
 961
 962 /**
 963  * Return the correct start address and size of a Linux aarch64 Image.
 964  *
 965  * @image: Address of image
 966  * @start: Returns start address of image
 967  * @size : Returns size image
 968  * @force_reloc: Ignore image->ep field, always place image to RAM start
 969  * @return 0 if OK, 1 if the image was not recognised
 970  */
 971 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
 972                 bool force_reloc);
 973
 974 /*******************************************************************/
 975 /* New uImage format specific code (prefixed with fit_) */
 976 /*******************************************************************/
 977
 978 #define FIT_IMAGES_PATH         "/images"
 979 #define FIT_CONFS_PATH          "/configurations"
 980
 981 /* hash/signature/key node */
 982 #define FIT_HASH_NODENAME       "hash"
 983 #define FIT_ALGO_PROP           "algo"
 984 #define FIT_VALUE_PROP          "value"
 985 #define FIT_IGNORE_PROP         "uboot-ignore"
 986 #define FIT_SIG_NODENAME        "signature"
 987 #define FIT_KEY_REQUIRED        "required"
 988 #define FIT_KEY_HINT            "key-name-hint"
 989
 990 /* cipher node */
 991 #define FIT_CIPHER_NODENAME     "cipher"
 992 #define FIT_ALGO_PROP           "algo"
 993
 994 /* image node */
 995 #define FIT_DATA_PROP           "data"
 996 #define FIT_DATA_POSITION_PROP  "data-position"
 997 #define FIT_DATA_OFFSET_PROP    "data-offset"
 998 #define FIT_DATA_SIZE_PROP      "data-size"
 999 #define FIT_TIMESTAMP_PROP      "timestamp"
1000 #define FIT_DESC_PROP           "description"
1001 #define FIT_ARCH_PROP           "arch"
1002 #define FIT_TYPE_PROP           "type"
1003 #define FIT_OS_PROP             "os"
1004 #define FIT_COMP_PROP           "compression"
1005 #define FIT_ENTRY_PROP          "entry"
1006 #define FIT_LOAD_PROP           "load"
1007
1008 /* configuration node */
1009 #define FIT_KERNEL_PROP         "kernel"
1010 #define FIT_RAMDISK_PROP        "ramdisk"
1011 #define FIT_FDT_PROP            "fdt"
1012 #define FIT_LOADABLE_PROP       "loadables"
1013 #define FIT_DEFAULT_PROP        "default"
1014 #define FIT_SETUP_PROP          "setup"
1015 #define FIT_FPGA_PROP           "fpga"
1016 #define FIT_FIRMWARE_PROP       "firmware"
1017 #define FIT_STANDALONE_PROP     "standalone"
1018
1019 #define FIT_MAX_HASH_LEN        HASH_MAX_DIGEST_SIZE
1020
1021 #if IMAGE_ENABLE_FIT
1022 /* cmdline argument format parsing */
1023 int fit_parse_conf(const char *spec, ulong addr_curr,
1024                 ulong *addr, const char **conf_name);
1025 int fit_parse_subimage(const char *spec, ulong addr_curr,
1026                 ulong *addr, const char **image_name);
1027
1028 int fit_get_subimage_count(const void *fit, int images_noffset);
1029 void fit_print_contents(const void *fit);
1030 void fit_image_print(const void *fit, int noffset, const char *p);
1031
1032 /**
1033  * fit_get_end - get FIT image size
1034  * @fit: pointer to the FIT format image header
1035  *
1036  * returns:
1037  *     size of the FIT image (blob) in memory
1038  */
1039 static inline ulong fit_get_size(const void *fit)
1040 {
1041         return fdt_totalsize(fit);
1042 }
1043
1044 /**
1045  * fit_get_end - get FIT image end
1046  * @fit: pointer to the FIT format image header
1047  *
1048  * returns:
1049  *     end address of the FIT image (blob) in memory
1050  */
1051 ulong fit_get_end(const void *fit);
1052
1053 /**
1054  * fit_get_name - get FIT node name
1055  * @fit: pointer to the FIT format image header
1056  *
1057  * returns:
1058  *     NULL, on error
1059  *     pointer to node name, on success
1060  */
1061 static inline const char *fit_get_name(const void *fit_hdr,
1062                 int noffset, int *len)
1063 {
1064         return fdt_get_name(fit_hdr, noffset, len);
1065 }
1066
1067 int fit_get_desc(const void *fit, int noffset, char **desc);
1068 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1069
1070 int fit_image_get_node(const void *fit, const char *image_uname);
1071 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1072 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1073 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1074 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1075 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1076 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1077 int fit_image_get_data(const void *fit, int noffset,
1078                                 const void **data, size_t *size);
1079 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1080 int fit_image_get_data_position(const void *fit, int noffset,
1081                                 int *data_position);
1082 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1083 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1084                                        size_t *data_size);
1085 int fit_image_get_data_and_size(const void *fit, int noffset,
1086                                 const void **data, size_t *size);
1087
1088 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1089 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1090                                 int *value_len);
1091
1092 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1093
1094 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1095                     const char *comment, int require_keys,
1096                     const char *engine_id, const char *cmdname);
1097
1098 /**
1099  * fit_add_verification_data() - add verification data to FIT image nodes
1100  *
1101  * @keydir:     Directory containing keys
1102  * @kwydest:    FDT blob to write public key information to
1103  * @fit:        Pointer to the FIT format image header
1104  * @comment:    Comment to add to signature nodes
1105  * @require_keys: Mark all keys as 'required'
1106  * @engine_id:  Engine to use for signing
1107  * @cmdname:    Command name used when reporting errors
1108  *
1109  * Adds hash values for all component images in the FIT blob.
1110  * Hashes are calculated for all component images which have hash subnodes
1111  * with algorithm property set to one of the supported hash algorithms.
1112  *
1113  * Also add signatures if signature nodes are present.
1114  *
1115  * returns
1116  *     0, on success
1117  *     libfdt error code, on failure
1118  */
1119 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
1120                               const char *comment, int require_keys,
1121                               const char *engine_id, const char *cmdname);
1122
1123 int fit_image_verify_with_data(const void *fit, int image_noffset,
1124                                const void *data, size_t size);
1125 int fit_image_verify(const void *fit, int noffset);
1126 int fit_config_verify(const void *fit, int conf_noffset);
1127 int fit_all_image_verify(const void *fit);
1128 int fit_config_decrypt(const void *fit, int conf_noffset);
1129 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1130 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1131 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1132 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1133 int fit_check_format(const void *fit);
1134
1135 int fit_conf_find_compat(const void *fit, const void *fdt);
1136
1137 /**
1138  * fit_conf_get_node - get node offset for configuration of a given unit name
1139  * @fit: pointer to the FIT format image header
1140  * @conf_uname: configuration node unit name (NULL to use default)
1141  *
1142  * fit_conf_get_node() finds a configuration (within the '/configurations'
1143  * parent node) of a provided unit name. If configuration is found its node
1144  * offset is returned to the caller.
1145  *
1146  * When NULL is provided in second argument fit_conf_get_node() will search
1147  * for a default configuration node instead. Default configuration node unit
1148  * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1149  * node.
1150  *
1151  * returns:
1152  *     configuration node offset when found (>=0)
1153  *     negative number on failure (FDT_ERR_* code)
1154  */
1155 int fit_conf_get_node(const void *fit, const char *conf_uname);
1156
1157 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1158                 const char *prop_name);
1159 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1160                 const char *prop_name, int index);
1161
1162 /**
1163  * fit_conf_get_prop_node() - Get node refered to by a configuration
1164  * @fit:        FIT to check
1165  * @noffset:    Offset of conf@xxx node to check
1166  * @prop_name:  Property to read from the conf node
1167  *
1168  * The conf- nodes contain references to other nodes, using properties
1169  * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1170  * return the offset of the node referred to (e.g. offset of node
1171  * "/images/kernel".
1172  */
1173 int fit_conf_get_prop_node(const void *fit, int noffset,
1174                 const char *prop_name);
1175
1176 int fit_check_ramdisk(const void *fit, int os_noffset,
1177                 uint8_t arch, int verify);
1178 #endif /* IMAGE_ENABLE_FIT */
1179
1180 int calculate_hash(const void *data, int data_len, const char *algo,
1181                         uint8_t *value, int *value_len);
1182
1183 /*
1184  * At present we only support signing on the host, and verification on the
1185  * device
1186  */
1187 #if defined(USE_HOSTCC)
1188 # if defined(CONFIG_FIT_SIGNATURE)
1189 #  define IMAGE_ENABLE_SIGN     1
1190 #  define IMAGE_ENABLE_VERIFY   1
1191 #  define FIT_IMAGE_ENABLE_VERIFY       1
1192 #  include <openssl/evp.h>
1193 # else
1194 #  define IMAGE_ENABLE_SIGN     0
1195 #  define IMAGE_ENABLE_VERIFY   0
1196 #  define FIT_IMAGE_ENABLE_VERIFY       0
1197 # endif
1198 #else
1199 # define IMAGE_ENABLE_SIGN      0
1200 # define IMAGE_ENABLE_VERIFY            CONFIG_IS_ENABLED(RSA_VERIFY)
1201 # define FIT_IMAGE_ENABLE_VERIFY        CONFIG_IS_ENABLED(FIT_SIGNATURE)
1202 #endif
1203
1204 #if IMAGE_ENABLE_FIT
1205 #ifdef USE_HOSTCC
1206 void *image_get_host_blob(void);
1207 void image_set_host_blob(void *host_blob);
1208 # define gd_fdt_blob()          image_get_host_blob()
1209 #else
1210 # define gd_fdt_blob()          (gd->fdt_blob)
1211 #endif
1212
1213 #ifdef CONFIG_FIT_BEST_MATCH
1214 #define IMAGE_ENABLE_BEST_MATCH 1
1215 #else
1216 #define IMAGE_ENABLE_BEST_MATCH 0
1217 #endif
1218 #endif /* IMAGE_ENABLE_FIT */
1219
1220 /* Information passed to the signing routines */
1221 struct image_sign_info {
1222         const char *keydir;             /* Directory conaining keys */
1223         const char *keyname;            /* Name of key to use */
1224         void *fit;                      /* Pointer to FIT blob */
1225         int node_offset;                /* Offset of signature node */
1226         const char *name;               /* Algorithm name */
1227         struct checksum_algo *checksum; /* Checksum algorithm information */
1228         struct padding_algo *padding;   /* Padding algorithm information */
1229         struct crypto_algo *crypto;     /* Crypto algorithm information */
1230         const void *fdt_blob;           /* FDT containing public keys */
1231         int required_keynode;           /* Node offset of key to use: -1=any */
1232         const char *require_keys;       /* Value for 'required' property */
1233         const char *engine_id;          /* Engine to use for signing */
1234         /*
1235          * Note: the following two fields are always valid even w/o
1236          * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1237          * the same on target and host. Otherwise, vboot test may fail.
1238          */
1239         const void *key;                /* Pointer to public key in DER */
1240         int keylen;                     /* Length of public key */
1241 };
1242
1243 /* A part of an image, used for hashing */
1244 struct image_region {
1245         const void *data;
1246         int size;
1247 };
1248
1249 #if IMAGE_ENABLE_VERIFY
1250 # include <u-boot/rsa-checksum.h>
1251 #endif
1252 struct checksum_algo {
1253         const char *name;
1254         const int checksum_len;
1255         const int der_len;
1256         const uint8_t *der_prefix;
1257 #if IMAGE_ENABLE_SIGN
1258         const EVP_MD *(*calculate_sign)(void);
1259 #endif
1260         int (*calculate)(const char *name,
1261                          const struct image_region region[],
1262                          int region_count, uint8_t *checksum);
1263 };
1264
1265 struct crypto_algo {
1266         const char *name;               /* Name of algorithm */
1267         const int key_len;
1268
1269         /**
1270          * sign() - calculate and return signature for given input data
1271          *
1272          * @info:       Specifies key and FIT information
1273          * @data:       Pointer to the input data
1274          * @data_len:   Data length
1275          * @sigp:       Set to an allocated buffer holding the signature
1276          * @sig_len:    Set to length of the calculated hash
1277          *
1278          * This computes input data signature according to selected algorithm.
1279          * Resulting signature value is placed in an allocated buffer, the
1280          * pointer is returned as *sigp. The length of the calculated
1281          * signature is returned via the sig_len pointer argument. The caller
1282          * should free *sigp.
1283          *
1284          * @return: 0, on success, -ve on error
1285          */
1286         int (*sign)(struct image_sign_info *info,
1287                     const struct image_region region[],
1288                     int region_count, uint8_t **sigp, uint *sig_len);
1289
1290         /**
1291          * add_verify_data() - Add verification information to FDT
1292          *
1293          * Add public key information to the FDT node, suitable for
1294          * verification at run-time. The information added depends on the
1295          * algorithm being used.
1296          *
1297          * @info:       Specifies key and FIT information
1298          * @keydest:    Destination FDT blob for public key data
1299          * @return: 0, on success, -ve on error
1300          */
1301         int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1302
1303         /**
1304          * verify() - Verify a signature against some data
1305          *
1306          * @info:       Specifies key and FIT information
1307          * @data:       Pointer to the input data
1308          * @data_len:   Data length
1309          * @sig:        Signature
1310          * @sig_len:    Number of bytes in signature
1311          * @return 0 if verified, -ve on error
1312          */
1313         int (*verify)(struct image_sign_info *info,
1314                       const struct image_region region[], int region_count,
1315                       uint8_t *sig, uint sig_len);
1316 };
1317
1318 struct padding_algo {
1319         const char *name;
1320         int (*verify)(struct image_sign_info *info,
1321                       uint8_t *pad, int pad_len,
1322                       const uint8_t *hash, int hash_len);
1323 };
1324
1325 /**
1326  * image_get_checksum_algo() - Look up a checksum algorithm
1327  *
1328  * @param full_name     Name of algorithm in the form "checksum,crypto"
1329  * @return pointer to algorithm information, or NULL if not found
1330  */
1331 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1332
1333 /**
1334  * image_get_crypto_algo() - Look up a cryptosystem algorithm
1335  *
1336  * @param full_name     Name of algorithm in the form "checksum,crypto"
1337  * @return pointer to algorithm information, or NULL if not found
1338  */
1339 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1340
1341 /**
1342  * image_get_padding_algo() - Look up a padding algorithm
1343  *
1344  * @param name          Name of padding algorithm
1345  * @return pointer to algorithm information, or NULL if not found
1346  */
1347 struct padding_algo *image_get_padding_algo(const char *name);
1348
1349 #if IMAGE_ENABLE_FIT
1350
1351 /**
1352  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1353  *
1354  * @fit:                FIT to check
1355  * @image_noffset:      Offset of image node to check
1356  * @data:               Image data to check
1357  * @size:               Size of image data
1358  * @sig_blob:           FDT containing public keys
1359  * @no_sigsp:           Returns 1 if no signatures were required, and
1360  *                      therefore nothing was checked. The caller may wish
1361  *                      to fall back to other mechanisms, or refuse to
1362  *                      boot.
1363  * @return 0 if all verified ok, <0 on error
1364  */
1365 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1366                 const char *data, size_t size, const void *sig_blob,
1367                 int *no_sigsp);
1368
1369 /**
1370  * fit_image_check_sig() - Check a single image signature node
1371  *
1372  * @fit:                FIT to check
1373  * @noffset:            Offset of signature node to check
1374  * @data:               Image data to check
1375  * @size:               Size of image data
1376  * @required_keynode:   Offset in the control FDT of the required key node,
1377  *                      if any. If this is given, then the image wil not
1378  *                      pass verification unless that key is used. If this is
1379  *                      -1 then any signature will do.
1380  * @err_msgp:           In the event of an error, this will be pointed to a
1381  *                      help error string to display to the user.
1382  * @return 0 if all verified ok, <0 on error
1383  */
1384 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1385                 size_t size, int required_keynode, char **err_msgp);
1386
1387 int fit_image_decrypt_data(const void *fit,
1388                            int image_noffset, int cipher_noffset,
1389                            const void *data, size_t size,
1390                            void **data_unciphered, size_t *size_unciphered);
1391
1392 /**
1393  * fit_region_make_list() - Make a list of regions to hash
1394  *
1395  * Given a list of FIT regions (offset, size) provided by libfdt, create
1396  * a list of regions (void *, size) for use by the signature creationg
1397  * and verification code.
1398  *
1399  * @fit:                FIT image to process
1400  * @fdt_regions:        Regions as returned by libfdt
1401  * @count:              Number of regions returned by libfdt
1402  * @region:             Place to put list of regions (NULL to allocate it)
1403  * @return pointer to list of regions, or NULL if out of memory
1404  */
1405 struct image_region *fit_region_make_list(const void *fit,
1406                 struct fdt_region *fdt_regions, int count,
1407                 struct image_region *region);
1408
1409 static inline int fit_image_check_target_arch(const void *fdt, int node)
1410 {
1411 #ifndef USE_HOSTCC
1412         return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1413 #else
1414         return 0;
1415 #endif
1416 }
1417
1418 /*
1419  * At present we only support ciphering on the host, and unciphering on the
1420  * device
1421  */
1422 #if defined(USE_HOSTCC)
1423 # if defined(CONFIG_FIT_CIPHER)
1424 #  define IMAGE_ENABLE_ENCRYPT  1
1425 #  define IMAGE_ENABLE_DECRYPT  1
1426 #  include <openssl/evp.h>
1427 # else
1428 #  define IMAGE_ENABLE_ENCRYPT  0
1429 #  define IMAGE_ENABLE_DECRYPT  0
1430 # endif
1431 #else
1432 # define IMAGE_ENABLE_ENCRYPT   0
1433 # define IMAGE_ENABLE_DECRYPT   CONFIG_IS_ENABLED(FIT_CIPHER)
1434 #endif
1435
1436 /* Information passed to the ciphering routines */
1437 struct image_cipher_info {
1438         const char *keydir;             /* Directory containing keys */
1439         const char *keyname;            /* Name of key to use */
1440         const char *ivname;             /* Name of IV to use */
1441         const void *fit;                /* Pointer to FIT blob */
1442         int node_noffset;               /* Offset of the cipher node */
1443         const char *name;               /* Algorithm name */
1444         struct cipher_algo *cipher;     /* Cipher algorithm information */
1445         const void *fdt_blob;           /* FDT containing key and IV */
1446         const void *key;                /* Value of the key */
1447         const void *iv;                 /* Value of the IV */
1448         size_t size_unciphered;         /* Size of the unciphered data */
1449 };
1450
1451 struct cipher_algo {
1452         const char *name;               /* Name of algorithm */
1453         int key_len;                    /* Length of the key */
1454         int iv_len;                     /* Length of the IV */
1455
1456 #if IMAGE_ENABLE_ENCRYPT
1457         const EVP_CIPHER * (*calculate_type)(void);
1458 #endif
1459
1460         int (*encrypt)(struct image_cipher_info *info,
1461                        const unsigned char *data, int data_len,
1462                        unsigned char **cipher, int *cipher_len);
1463
1464         int (*add_cipher_data)(struct image_cipher_info *info,
1465                                void *keydest);
1466
1467         int (*decrypt)(struct image_cipher_info *info,
1468                        const void *cipher, size_t cipher_len,
1469                        void **data, size_t *data_len);
1470 };
1471
1472 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1473
1474 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1475
1476 #ifdef CONFIG_FIT_VERBOSE
1477 #define fit_unsupported(msg)    printf("! %s:%d " \
1478                                 "FIT images not supported for '%s'\n", \
1479                                 __FILE__, __LINE__, (msg))
1480
1481 #define fit_unsupported_reset(msg)      printf("! %s:%d " \
1482                                 "FIT images not supported for '%s' " \
1483                                 "- must reset board to recover!\n", \
1484                                 __FILE__, __LINE__, (msg))
1485 #else
1486 #define fit_unsupported(msg)
1487 #define fit_unsupported_reset(msg)
1488 #endif /* CONFIG_FIT_VERBOSE */
1489 #endif /* CONFIG_FIT */
1490
1491 #if !defined(USE_HOSTCC)
1492 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1493 struct andr_img_hdr;
1494 int android_image_check_header(const struct andr_img_hdr *hdr);
1495 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1496                              ulong *os_data, ulong *os_len);
1497 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1498                               ulong *rd_data, ulong *rd_len);
1499 int android_image_get_second(const struct andr_img_hdr *hdr,
1500                               ulong *second_data, ulong *second_len);
1501 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1502 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1503                                     u32 *size);
1504 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1505 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1506 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1507 void android_print_contents(const struct andr_img_hdr *hdr);
1508 #if !defined(CONFIG_SPL_BUILD)
1509 bool android_image_print_dtb_contents(ulong hdr_addr);
1510 #endif
1511
1512 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1513 #endif /* !USE_HOSTCC */
1514
1515 /**
1516  * board_fit_config_name_match() - Check for a matching board name
1517  *
1518  * This is used when SPL loads a FIT containing multiple device tree files
1519  * and wants to work out which one to use. The description of each one is
1520  * passed to this function. The description comes from the 'description' field
1521  * in each (FDT) image node.
1522  *
1523  * @name: Device tree description
1524  * @return 0 if this device tree should be used, non-zero to try the next
1525  */
1526 int board_fit_config_name_match(const char *name);
1527
1528 #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1529         defined(CONFIG_FIT_IMAGE_POST_PROCESS)
1530 /**
1531  * board_fit_image_post_process() - Do any post-process on FIT binary data
1532  *
1533  * This is used to do any sort of image manipulation, verification, decryption
1534  * etc. in a platform or board specific way. Obviously, anything done here would
1535  * need to be comprehended in how the images were prepared before being injected
1536  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1537  * before being added to the FIT image).
1538  *
1539  * @image: pointer to the image start pointer
1540  * @size: pointer to the image size
1541  * @return no return value (failure should be handled internally)
1542  */
1543 void board_fit_image_post_process(void **p_image, size_t *p_size);
1544 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1545
1546 #define FDT_ERROR       ((ulong)(-1))
1547
1548 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1549
1550 /**
1551  * fit_find_config_node() - Find the node for the best DTB in a FIT image
1552  *
1553  * A FIT image contains one or more DTBs. This function parses the
1554  * configurations described in the FIT images and returns the node of
1555  * the first matching DTB. To check if a DTB matches a board, this function
1556  * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1557  * the node described by the default configuration if it exists.
1558  *
1559  * @fdt: pointer to flat device tree
1560  * @return the node if found, -ve otherwise
1561  */
1562 int fit_find_config_node(const void *fdt);
1563
1564 /**
1565  * Mapping of image types to function handlers to be invoked on the associated
1566  * loaded images
1567  *
1568  * @type: Type of image, I.E. IH_TYPE_*
1569  * @handler: Function to call on loaded image
1570  */
1571 struct fit_loadable_tbl {
1572         int type;
1573         /**
1574          * handler() - Process a loaded image
1575          *
1576          * @data: Pointer to start of loaded image data
1577          * @size: Size of loaded image data
1578          */
1579         void (*handler)(ulong data, size_t size);
1580 };
1581
1582 /*
1583  * Define a FIT loadable image type handler
1584  *
1585  * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1586  * _handler is the handler function to call after this image type is loaded
1587  */
1588 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1589         ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1590                 .type = _type, \
1591                 .handler = _handler, \
1592         }
1593
1594 #endif  /* __IMAGE_H__ */