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