include/image.h

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