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