include/image.h

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