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