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