include/image.h

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