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_MTKIMAGE,               /* MediaTek BootROM loadable Image */
 283
 284         IH_TYPE_COUNT,                  /* Number of image types */
 285 };
 286
 287 /*
 288  * Compression Types
 289  *
 290  * The following are exposed to uImage header.
 291  * Do not change values for backward compatibility.
 292  */
 293 enum {
 294         IH_COMP_NONE            = 0,    /*  No   Compression Used       */
 295         IH_COMP_GZIP,                   /* gzip  Compression Used       */
 296         IH_COMP_BZIP2,                  /* bzip2 Compression Used       */
 297         IH_COMP_LZMA,                   /* lzma  Compression Used       */
 298         IH_COMP_LZO,                    /* lzo   Compression Used       */
 299         IH_COMP_LZ4,                    /* lz4   Compression Used       */
 300
 301         IH_COMP_COUNT,
 302 };
 303
 304 #define IH_MAGIC        0x27051956      /* Image Magic Number           */
 305 #define IH_NMLEN                32      /* Image Name Length            */
 306
 307 /* Reused from common.h */
 308 #define ROUND(a, b)             (((a) + (b) - 1) & ~((b) - 1))
 309
 310 /*
 311  * Legacy format image header,
 312  * all data in network byte order (aka natural aka bigendian).
 313  */
 314 typedef struct image_header {
 315         __be32          ih_magic;       /* Image Header Magic Number    */
 316         __be32          ih_hcrc;        /* Image Header CRC Checksum    */
 317         __be32          ih_time;        /* Image Creation Timestamp     */
 318         __be32          ih_size;        /* Image Data Size              */
 319         __be32          ih_load;        /* Data  Load  Address          */
 320         __be32          ih_ep;          /* Entry Point Address          */
 321         __be32          ih_dcrc;        /* Image Data CRC Checksum      */
 322         uint8_t         ih_os;          /* Operating System             */
 323         uint8_t         ih_arch;        /* CPU architecture             */
 324         uint8_t         ih_type;        /* Image Type                   */
 325         uint8_t         ih_comp;        /* Compression Type             */
 326         uint8_t         ih_name[IH_NMLEN];      /* Image Name           */
 327 } image_header_t;
 328
 329 typedef struct image_info {
 330         ulong           start, end;             /* start/end of blob */
 331         ulong           image_start, image_len; /* start of image within blob, len of image */
 332         ulong           load;                   /* load addr for the image */
 333         uint8_t         comp, type, os;         /* compression, type of image, os type */
 334         uint8_t         arch;                   /* CPU architecture */
 335 } image_info_t;
 336
 337 /*
 338  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
 339  * routines.
 340  */
 341 typedef struct bootm_headers {
 342         /*
 343          * Legacy os image header, if it is a multi component image
 344          * then boot_get_ramdisk() and get_fdt() will attempt to get
 345          * data from second and third component accordingly.
 346          */
 347         image_header_t  *legacy_hdr_os;         /* image header pointer */
 348         image_header_t  legacy_hdr_os_copy;     /* header copy */
 349         ulong           legacy_hdr_valid;
 350
 351 #if IMAGE_ENABLE_FIT
 352         const char      *fit_uname_cfg; /* configuration node unit name */
 353
 354         void            *fit_hdr_os;    /* os FIT image header */
 355         const char      *fit_uname_os;  /* os subimage node unit name */
 356         int             fit_noffset_os; /* os subimage node offset */
 357
 358         void            *fit_hdr_rd;    /* init ramdisk FIT image header */
 359         const char      *fit_uname_rd;  /* init ramdisk subimage node unit name */
 360         int             fit_noffset_rd; /* init ramdisk subimage node offset */
 361
 362         void            *fit_hdr_fdt;   /* FDT blob FIT image header */
 363         const char      *fit_uname_fdt; /* FDT blob subimage node unit name */
 364         int             fit_noffset_fdt;/* FDT blob subimage node offset */
 365
 366         void            *fit_hdr_setup; /* x86 setup FIT image header */
 367         const char      *fit_uname_setup; /* x86 setup subimage node name */
 368         int             fit_noffset_setup;/* x86 setup subimage node offset */
 369 #endif
 370
 371 #ifndef USE_HOSTCC
 372         image_info_t    os;             /* os image info */
 373         ulong           ep;             /* entry point of OS */
 374
 375         ulong           rd_start, rd_end;/* ramdisk start/end */
 376
 377         char            *ft_addr;       /* flat dev tree address */
 378         ulong           ft_len;         /* length of flat device tree */
 379
 380         ulong           initrd_start;
 381         ulong           initrd_end;
 382         ulong           cmdline_start;
 383         ulong           cmdline_end;
 384         bd_t            *kbd;
 385 #endif
 386
 387         int             verify;         /* env_get("verify")[0] != 'n' */
 388
 389 #define BOOTM_STATE_START       (0x00000001)
 390 #define BOOTM_STATE_FINDOS      (0x00000002)
 391 #define BOOTM_STATE_FINDOTHER   (0x00000004)
 392 #define BOOTM_STATE_LOADOS      (0x00000008)
 393 #define BOOTM_STATE_RAMDISK     (0x00000010)
 394 #define BOOTM_STATE_FDT         (0x00000020)
 395 #define BOOTM_STATE_OS_CMDLINE  (0x00000040)
 396 #define BOOTM_STATE_OS_BD_T     (0x00000080)
 397 #define BOOTM_STATE_OS_PREP     (0x00000100)
 398 #define BOOTM_STATE_OS_FAKE_GO  (0x00000200)    /* 'Almost' run the OS */
 399 #define BOOTM_STATE_OS_GO       (0x00000400)
 400         int             state;
 401
 402 #ifdef CONFIG_LMB
 403         struct lmb      lmb;            /* for memory mgmt */
 404 #endif
 405 } bootm_headers_t;
 406
 407 extern bootm_headers_t images;
 408
 409 /*
 410  * Some systems (for example LWMON) have very short watchdog periods;
 411  * we must make sure to split long operations like memmove() or
 412  * checksum calculations into reasonable chunks.
 413  */
 414 #ifndef CHUNKSZ
 415 #define CHUNKSZ (64 * 1024)
 416 #endif
 417
 418 #ifndef CHUNKSZ_CRC32
 419 #define CHUNKSZ_CRC32 (64 * 1024)
 420 #endif
 421
 422 #ifndef CHUNKSZ_MD5
 423 #define CHUNKSZ_MD5 (64 * 1024)
 424 #endif
 425
 426 #ifndef CHUNKSZ_SHA1
 427 #define CHUNKSZ_SHA1 (64 * 1024)
 428 #endif
 429
 430 #define uimage_to_cpu(x)                be32_to_cpu(x)
 431 #define cpu_to_uimage(x)                cpu_to_be32(x)
 432
 433 /*
 434  * Translation table for entries of a specific type; used by
 435  * get_table_entry_id() and get_table_entry_name().
 436  */
 437 typedef struct table_entry {
 438         int     id;
 439         char    *sname;         /* short (input) name to find table entry */
 440         char    *lname;         /* long (output) name to print for messages */
 441 } table_entry_t;
 442
 443 /*
 444  * get_table_entry_id() scans the translation table trying to find an
 445  * entry that matches the given short name. If a matching entry is
 446  * found, it's id is returned to the caller.
 447  */
 448 int get_table_entry_id(const table_entry_t *table,
 449                 const char *table_name, const char *name);
 450 /*
 451  * get_table_entry_name() scans the translation table trying to find
 452  * an entry that matches the given id. If a matching entry is found,
 453  * its long name is returned to the caller.
 454  */
 455 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
 456
 457 const char *genimg_get_os_name(uint8_t os);
 458
 459 /**
 460  * genimg_get_os_short_name() - get the short name for an OS
 461  *
 462  * @param os    OS (IH_OS_...)
 463  * @return OS short name, or "unknown" if unknown
 464  */
 465 const char *genimg_get_os_short_name(uint8_t comp);
 466
 467 const char *genimg_get_arch_name(uint8_t arch);
 468
 469 /**
 470  * genimg_get_arch_short_name() - get the short name for an architecture
 471  *
 472  * @param arch  Architecture type (IH_ARCH_...)
 473  * @return architecture short name, or "unknown" if unknown
 474  */
 475 const char *genimg_get_arch_short_name(uint8_t arch);
 476
 477 const char *genimg_get_type_name(uint8_t type);
 478
 479 /**
 480  * genimg_get_type_short_name() - get the short name for an image type
 481  *
 482  * @param type  Image type (IH_TYPE_...)
 483  * @return image short name, or "unknown" if unknown
 484  */
 485 const char *genimg_get_type_short_name(uint8_t type);
 486
 487 const char *genimg_get_comp_name(uint8_t comp);
 488
 489 /**
 490  * genimg_get_comp_short_name() - get the short name for a compression method
 491  *
 492  * @param comp  compression method (IH_COMP_...)
 493  * @return compression method short name, or "unknown" if unknown
 494  */
 495 const char *genimg_get_comp_short_name(uint8_t comp);
 496
 497 /**
 498  * genimg_get_cat_name() - Get the name of an item in a category
 499  *
 500  * @category:   Category of item
 501  * @id:         Item ID
 502  * @return name of item, or "Unknown ..." if unknown
 503  */
 504 const char *genimg_get_cat_name(enum ih_category category, uint id);
 505
 506 /**
 507  * genimg_get_cat_short_name() - Get the short name of an item in a category
 508  *
 509  * @category:   Category of item
 510  * @id:         Item ID
 511  * @return short name of item, or "Unknown ..." if unknown
 512  */
 513 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
 514
 515 /**
 516  * genimg_get_cat_count() - Get the number of items in a category
 517  *
 518  * @category:   Category to check
 519  * @return the number of items in the category (IH_xxx_COUNT)
 520  */
 521 int genimg_get_cat_count(enum ih_category category);
 522
 523 /**
 524  * genimg_get_cat_desc() - Get the description of a category
 525  *
 526  * @return the description of a category, e.g. "architecture". This
 527  * effectively converts the enum to a string.
 528  */
 529 const char *genimg_get_cat_desc(enum ih_category category);
 530
 531 int genimg_get_os_id(const char *name);
 532 int genimg_get_arch_id(const char *name);
 533 int genimg_get_type_id(const char *name);
 534 int genimg_get_comp_id(const char *name);
 535 void genimg_print_size(uint32_t size);
 536
 537 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
 538         defined(USE_HOSTCC)
 539 #define IMAGE_ENABLE_TIMESTAMP 1
 540 #else
 541 #define IMAGE_ENABLE_TIMESTAMP 0
 542 #endif
 543 void genimg_print_time(time_t timestamp);
 544
 545 /* What to do with a image load address ('load = <> 'in the FIT) */
 546 enum fit_load_op {
 547         FIT_LOAD_IGNORED,       /* Ignore load address */
 548         FIT_LOAD_OPTIONAL,      /* Can be provided, but optional */
 549         FIT_LOAD_OPTIONAL_NON_ZERO,     /* Optional, a value of 0 is ignored */
 550         FIT_LOAD_REQUIRED,      /* Must be provided */
 551 };
 552
 553 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
 554                    ulong *setup_len);
 555
 556 #ifndef USE_HOSTCC
 557 /* Image format types, returned by _get_format() routine */
 558 #define IMAGE_FORMAT_INVALID    0x00
 559 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 560 #define IMAGE_FORMAT_LEGACY     0x01    /* legacy image_header based format */
 561 #endif
 562 #define IMAGE_FORMAT_FIT        0x02    /* new, libfdt based format */
 563 #define IMAGE_FORMAT_ANDROID    0x03    /* Android boot image */
 564
 565 ulong genimg_get_kernel_addr_fit(char * const img_addr,
 566                                  const char **fit_uname_config,
 567                                  const char **fit_uname_kernel);
 568 ulong genimg_get_kernel_addr(char * const img_addr);
 569 int genimg_get_format(const void *img_addr);
 570 int genimg_has_config(bootm_headers_t *images);
 571
 572 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
 573                 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
 574 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
 575                 uint8_t arch, ulong *rd_start, ulong *rd_end);
 576
 577 /**
 578  * boot_get_loadable - routine to load a list of binaries to memory
 579  * @argc: Ignored Argument
 580  * @argv: Ignored Argument
 581  * @images: pointer to the bootm images structure
 582  * @arch: expected architecture for the image
 583  * @ld_start: Ignored Argument
 584  * @ld_len: Ignored Argument
 585  *
 586  * boot_get_loadable() will take the given FIT configuration, and look
 587  * for a field named "loadables".  Loadables, is a list of elements in
 588  * the FIT given as strings.  exe:
 589  *   loadables = "linux_kernel", "fdt-2";
 590  * this function will attempt to parse each string, and load the
 591  * corresponding element from the FIT into memory.  Once placed,
 592  * no aditional actions are taken.
 593  *
 594  * @return:
 595  *     0, if only valid images or no images are found
 596  *     error code, if an error occurs during fit_image_load
 597  */
 598 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
 599                 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
 600 #endif /* !USE_HOSTCC */
 601
 602 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
 603                        ulong *setup_start, ulong *setup_len);
 604
 605 /**
 606  * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
 607  *
 608  * This deals with all aspects of loading an DTB from a FIT.
 609  * The correct base image based on configuration will be selected, and
 610  * then any overlays specified will be applied (as present in fit_uname_configp).
 611  *
 612  * @param images        Boot images structure
 613  * @param addr          Address of FIT in memory
 614  * @param fit_unamep    On entry this is the requested image name
 615  *                      (e.g. "kernel") or NULL to use the default. On exit
 616  *                      points to the selected image name
 617  * @param fit_uname_configp     On entry this is the requested configuration
 618  *                      name (e.g. "conf-1") or NULL to use the default. On
 619  *                      exit points to the selected configuration name.
 620  * @param arch          Expected architecture (IH_ARCH_...)
 621  * @param datap         Returns address of loaded image
 622  * @param lenp          Returns length of loaded image
 623  *
 624  * @return node offset of base image, or -ve error code on error
 625  */
 626 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
 627                    const char **fit_unamep, const char **fit_uname_configp,
 628                    int arch, ulong *datap, ulong *lenp);
 629
 630 /**
 631  * fit_image_load() - load an image from a FIT
 632  *
 633  * This deals with all aspects of loading an image from a FIT, including
 634  * selecting the right image based on configuration, verifying it, printing
 635  * out progress messages, checking the type/arch/os and optionally copying it
 636  * to the right load address.
 637  *
 638  * The property to look up is defined by image_type.
 639  *
 640  * @param images        Boot images structure
 641  * @param addr          Address of FIT in memory
 642  * @param fit_unamep    On entry this is the requested image name
 643  *                      (e.g. "kernel") or NULL to use the default. On exit
 644  *                      points to the selected image name
 645  * @param fit_uname_configp     On entry this is the requested configuration
 646  *                      name (e.g. "conf-1") or NULL to use the default. On
 647  *                      exit points to the selected configuration name.
 648  * @param arch          Expected architecture (IH_ARCH_...)
 649  * @param image_type    Required image type (IH_TYPE_...). If this is
 650  *                      IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
 651  *                      also.
 652  * @param bootstage_id  ID of starting bootstage to use for progress updates.
 653  *                      This will be added to the BOOTSTAGE_SUB values when
 654  *                      calling bootstage_mark()
 655  * @param load_op       Decribes what to do with the load address
 656  * @param datap         Returns address of loaded image
 657  * @param lenp          Returns length of loaded image
 658  * @return node offset of image, or -ve error code on error
 659  */
 660 int fit_image_load(bootm_headers_t *images, ulong addr,
 661                    const char **fit_unamep, const char **fit_uname_configp,
 662                    int arch, int image_type, int bootstage_id,
 663                    enum fit_load_op load_op, ulong *datap, ulong *lenp);
 664
 665 #ifndef USE_HOSTCC
 666 /**
 667  * fit_get_node_from_config() - Look up an image a FIT by type
 668  *
 669  * This looks in the selected conf- node (images->fit_uname_cfg) for a
 670  * particular image type (e.g. "kernel") and then finds the image that is
 671  * referred to.
 672  *
 673  * For example, for something like:
 674  *
 675  * images {
 676  *      kernel {
 677  *              ...
 678  *      };
 679  * };
 680  * configurations {
 681  *      conf-1 {
 682  *              kernel = "kernel";
 683  *      };
 684  * };
 685  *
 686  * the function will return the node offset of the kernel@1 node, assuming
 687  * that conf-1 is the chosen configuration.
 688  *
 689  * @param images        Boot images structure
 690  * @param prop_name     Property name to look up (FIT_..._PROP)
 691  * @param addr          Address of FIT in memory
 692  */
 693 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
 694                         ulong addr);
 695
 696 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
 697                  bootm_headers_t *images,
 698                  char **of_flat_tree, ulong *of_size);
 699 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
 700 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
 701
 702 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
 703                   ulong *initrd_start, ulong *initrd_end);
 704 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
 705 #ifdef CONFIG_SYS_BOOT_GET_KBD
 706 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
 707 #endif /* CONFIG_SYS_BOOT_GET_KBD */
 708 #endif /* !USE_HOSTCC */
 709
 710 /*******************************************************************/
 711 /* Legacy format specific code (prefixed with image_) */
 712 /*******************************************************************/
 713 static inline uint32_t image_get_header_size(void)
 714 {
 715         return (sizeof(image_header_t));
 716 }
 717
 718 #define image_get_hdr_l(f) \
 719         static inline uint32_t image_get_##f(const image_header_t *hdr) \
 720         { \
 721                 return uimage_to_cpu(hdr->ih_##f); \
 722         }
 723 image_get_hdr_l(magic)          /* image_get_magic */
 724 image_get_hdr_l(hcrc)           /* image_get_hcrc */
 725 image_get_hdr_l(time)           /* image_get_time */
 726 image_get_hdr_l(size)           /* image_get_size */
 727 image_get_hdr_l(load)           /* image_get_load */
 728 image_get_hdr_l(ep)             /* image_get_ep */
 729 image_get_hdr_l(dcrc)           /* image_get_dcrc */
 730
 731 #define image_get_hdr_b(f) \
 732         static inline uint8_t image_get_##f(const image_header_t *hdr) \
 733         { \
 734                 return hdr->ih_##f; \
 735         }
 736 image_get_hdr_b(os)             /* image_get_os */
 737 image_get_hdr_b(arch)           /* image_get_arch */
 738 image_get_hdr_b(type)           /* image_get_type */
 739 image_get_hdr_b(comp)           /* image_get_comp */
 740
 741 static inline char *image_get_name(const image_header_t *hdr)
 742 {
 743         return (char *)hdr->ih_name;
 744 }
 745
 746 static inline uint32_t image_get_data_size(const image_header_t *hdr)
 747 {
 748         return image_get_size(hdr);
 749 }
 750
 751 /**
 752  * image_get_data - get image payload start address
 753  * @hdr: image header
 754  *
 755  * image_get_data() returns address of the image payload. For single
 756  * component images it is image data start. For multi component
 757  * images it points to the null terminated table of sub-images sizes.
 758  *
 759  * returns:
 760  *     image payload data start address
 761  */
 762 static inline ulong image_get_data(const image_header_t *hdr)
 763 {
 764         return ((ulong)hdr + image_get_header_size());
 765 }
 766
 767 static inline uint32_t image_get_image_size(const image_header_t *hdr)
 768 {
 769         return (image_get_size(hdr) + image_get_header_size());
 770 }
 771 static inline ulong image_get_image_end(const image_header_t *hdr)
 772 {
 773         return ((ulong)hdr + image_get_image_size(hdr));
 774 }
 775
 776 #define image_set_hdr_l(f) \
 777         static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
 778         { \
 779                 hdr->ih_##f = cpu_to_uimage(val); \
 780         }
 781 image_set_hdr_l(magic)          /* image_set_magic */
 782 image_set_hdr_l(hcrc)           /* image_set_hcrc */
 783 image_set_hdr_l(time)           /* image_set_time */
 784 image_set_hdr_l(size)           /* image_set_size */
 785 image_set_hdr_l(load)           /* image_set_load */
 786 image_set_hdr_l(ep)             /* image_set_ep */
 787 image_set_hdr_l(dcrc)           /* image_set_dcrc */
 788
 789 #define image_set_hdr_b(f) \
 790         static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
 791         { \
 792                 hdr->ih_##f = val; \
 793         }
 794 image_set_hdr_b(os)             /* image_set_os */
 795 image_set_hdr_b(arch)           /* image_set_arch */
 796 image_set_hdr_b(type)           /* image_set_type */
 797 image_set_hdr_b(comp)           /* image_set_comp */
 798
 799 static inline void image_set_name(image_header_t *hdr, const char *name)
 800 {
 801         strncpy(image_get_name(hdr), name, IH_NMLEN);
 802 }
 803
 804 int image_check_hcrc(const image_header_t *hdr);
 805 int image_check_dcrc(const image_header_t *hdr);
 806 #ifndef USE_HOSTCC
 807 ulong env_get_bootm_low(void);
 808 phys_size_t env_get_bootm_size(void);
 809 phys_size_t env_get_bootm_mapsize(void);
 810 #endif
 811 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
 812
 813 static inline int image_check_magic(const image_header_t *hdr)
 814 {
 815         return (image_get_magic(hdr) == IH_MAGIC);
 816 }
 817 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
 818 {
 819         return (image_get_type(hdr) == type);
 820 }
 821 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
 822 {
 823         return (image_get_arch(hdr) == arch) ||
 824                 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
 825 }
 826 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
 827 {
 828         return (image_get_os(hdr) == os);
 829 }
 830
 831 ulong image_multi_count(const image_header_t *hdr);
 832 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 833                         ulong *data, ulong *len);
 834
 835 void image_print_contents(const void *hdr);
 836
 837 #ifndef USE_HOSTCC
 838 static inline int image_check_target_arch(const image_header_t *hdr)
 839 {
 840 #ifndef IH_ARCH_DEFAULT
 841 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
 842 #endif
 843         return image_check_arch(hdr, IH_ARCH_DEFAULT);
 844 }
 845 #endif /* USE_HOSTCC */
 846
 847 /**
 848  * Set up properties in the FDT
 849  *
 850  * This sets up properties in the FDT that is to be passed to linux.
 851  *
 852  * @images:     Images information
 853  * @blob:       FDT to update
 854  * @of_size:    Size of the FDT
 855  * @lmb:        Points to logical memory block structure
 856  * @return 0 if ok, <0 on failure
 857  */
 858 int image_setup_libfdt(bootm_headers_t *images, void *blob,
 859                        int of_size, struct lmb *lmb);
 860
 861 /**
 862  * Set up the FDT to use for booting a kernel
 863  *
 864  * This performs ramdisk setup, sets up the FDT if required, and adds
 865  * paramters to the FDT if libfdt is available.
 866  *
 867  * @param images        Images information
 868  * @return 0 if ok, <0 on failure
 869  */
 870 int image_setup_linux(bootm_headers_t *images);
 871
 872 /**
 873  * bootz_setup() - Extract stat and size of a Linux xImage
 874  *
 875  * @image: Address of image
 876  * @start: Returns start address of image
 877  * @end : Returns end address of image
 878  * @return 0 if OK, 1 if the image was not recognised
 879  */
 880 int bootz_setup(ulong image, ulong *start, ulong *end);
 881
 882 /**
 883  * Return the correct start address and size of a Linux aarch64 Image.
 884  *
 885  * @image: Address of image
 886  * @start: Returns start address of image
 887  * @size : Returns size image
 888  * @force_reloc: Ignore image->ep field, always place image to RAM start
 889  * @return 0 if OK, 1 if the image was not recognised
 890  */
 891 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
 892                 bool force_reloc);
 893
 894 /*******************************************************************/
 895 /* New uImage format specific code (prefixed with fit_) */
 896 /*******************************************************************/
 897
 898 #define FIT_IMAGES_PATH         "/images"
 899 #define FIT_CONFS_PATH          "/configurations"
 900
 901 /* hash/signature node */
 902 #define FIT_HASH_NODENAME       "hash"
 903 #define FIT_ALGO_PROP           "algo"
 904 #define FIT_VALUE_PROP          "value"
 905 #define FIT_IGNORE_PROP         "uboot-ignore"
 906 #define FIT_SIG_NODENAME        "signature"
 907
 908 /* image node */
 909 #define FIT_DATA_PROP           "data"
 910 #define FIT_DATA_POSITION_PROP  "data-position"
 911 #define FIT_DATA_OFFSET_PROP    "data-offset"
 912 #define FIT_DATA_SIZE_PROP      "data-size"
 913 #define FIT_TIMESTAMP_PROP      "timestamp"
 914 #define FIT_DESC_PROP           "description"
 915 #define FIT_ARCH_PROP           "arch"
 916 #define FIT_TYPE_PROP           "type"
 917 #define FIT_OS_PROP             "os"
 918 #define FIT_COMP_PROP           "compression"
 919 #define FIT_ENTRY_PROP          "entry"
 920 #define FIT_LOAD_PROP           "load"
 921
 922 /* configuration node */
 923 #define FIT_KERNEL_PROP         "kernel"
 924 #define FIT_RAMDISK_PROP        "ramdisk"
 925 #define FIT_FDT_PROP            "fdt"
 926 #define FIT_LOADABLE_PROP       "loadables"
 927 #define FIT_DEFAULT_PROP        "default"
 928 #define FIT_SETUP_PROP          "setup"
 929 #define FIT_FPGA_PROP           "fpga"
 930 #define FIT_FIRMWARE_PROP       "firmware"
 931 #define FIT_STANDALONE_PROP     "standalone"
 932
 933 #define FIT_MAX_HASH_LEN        HASH_MAX_DIGEST_SIZE
 934
 935 #if IMAGE_ENABLE_FIT
 936 /* cmdline argument format parsing */
 937 int fit_parse_conf(const char *spec, ulong addr_curr,
 938                 ulong *addr, const char **conf_name);
 939 int fit_parse_subimage(const char *spec, ulong addr_curr,
 940                 ulong *addr, const char **image_name);
 941
 942 int fit_get_subimage_count(const void *fit, int images_noffset);
 943 void fit_print_contents(const void *fit);
 944 void fit_image_print(const void *fit, int noffset, const char *p);
 945
 946 /**
 947  * fit_get_end - get FIT image size
 948  * @fit: pointer to the FIT format image header
 949  *
 950  * returns:
 951  *     size of the FIT image (blob) in memory
 952  */
 953 static inline ulong fit_get_size(const void *fit)
 954 {
 955         return fdt_totalsize(fit);
 956 }
 957
 958 /**
 959  * fit_get_end - get FIT image end
 960  * @fit: pointer to the FIT format image header
 961  *
 962  * returns:
 963  *     end address of the FIT image (blob) in memory
 964  */
 965 ulong fit_get_end(const void *fit);
 966
 967 /**
 968  * fit_get_name - get FIT node name
 969  * @fit: pointer to the FIT format image header
 970  *
 971  * returns:
 972  *     NULL, on error
 973  *     pointer to node name, on success
 974  */
 975 static inline const char *fit_get_name(const void *fit_hdr,
 976                 int noffset, int *len)
 977 {
 978         return fdt_get_name(fit_hdr, noffset, len);
 979 }
 980
 981 int fit_get_desc(const void *fit, int noffset, char **desc);
 982 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
 983
 984 int fit_image_get_node(const void *fit, const char *image_uname);
 985 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
 986 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
 987 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
 988 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
 989 int fit_image_get_load(const void *fit, int noffset, ulong *load);
 990 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
 991 int fit_image_get_data(const void *fit, int noffset,
 992                                 const void **data, size_t *size);
 993 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
 994 int fit_image_get_data_position(const void *fit, int noffset,
 995                                 int *data_position);
 996 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
 997 int fit_image_get_data_and_size(const void *fit, int noffset,
 998                                 const void **data, size_t *size);
 999
1000 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1001 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1002                                 int *value_len);
1003
1004 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1005
1006 /**
1007  * fit_add_verification_data() - add verification data to FIT image nodes
1008  *
1009  * @keydir:     Directory containing keys
1010  * @kwydest:    FDT blob to write public key information to
1011  * @fit:        Pointer to the FIT format image header
1012  * @comment:    Comment to add to signature nodes
1013  * @require_keys: Mark all keys as 'required'
1014  * @engine_id:  Engine to use for signing
1015  * @cmdname:    Command name used when reporting errors
1016  *
1017  * Adds hash values for all component images in the FIT blob.
1018  * Hashes are calculated for all component images which have hash subnodes
1019  * with algorithm property set to one of the supported hash algorithms.
1020  *
1021  * Also add signatures if signature nodes are present.
1022  *
1023  * returns
1024  *     0, on success
1025  *     libfdt error code, on failure
1026  */
1027 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
1028                               const char *comment, int require_keys,
1029                               const char *engine_id, const char *cmdname);
1030
1031 int fit_image_verify_with_data(const void *fit, int image_noffset,
1032                                const void *data, size_t size);
1033 int fit_image_verify(const void *fit, int noffset);
1034 int fit_config_verify(const void *fit, int conf_noffset);
1035 int fit_all_image_verify(const void *fit);
1036 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1037 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1038 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1039 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1040 int fit_check_format(const void *fit);
1041
1042 int fit_conf_find_compat(const void *fit, const void *fdt);
1043 int fit_conf_get_node(const void *fit, const char *conf_uname);
1044
1045 /**
1046  * fit_conf_get_prop_node() - Get node refered to by a configuration
1047  * @fit:        FIT to check
1048  * @noffset:    Offset of conf@xxx node to check
1049  * @prop_name:  Property to read from the conf node
1050  *
1051  * The conf- nodes contain references to other nodes, using properties
1052  * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1053  * return the offset of the node referred to (e.g. offset of node
1054  * "/images/kernel".
1055  */
1056 int fit_conf_get_prop_node(const void *fit, int noffset,
1057                 const char *prop_name);
1058
1059 int fit_check_ramdisk(const void *fit, int os_noffset,
1060                 uint8_t arch, int verify);
1061
1062 int calculate_hash(const void *data, int data_len, const char *algo,
1063                         uint8_t *value, int *value_len);
1064
1065 /*
1066  * At present we only support signing on the host, and verification on the
1067  * device
1068  */
1069 #if defined(CONFIG_FIT_SIGNATURE)
1070 # ifdef USE_HOSTCC
1071 #  define IMAGE_ENABLE_SIGN     1
1072 #  define IMAGE_ENABLE_VERIFY   1
1073 # include  <openssl/evp.h>
1074 #else
1075 #  define IMAGE_ENABLE_SIGN     0
1076 #  define IMAGE_ENABLE_VERIFY   1
1077 # endif
1078 #else
1079 # define IMAGE_ENABLE_SIGN      0
1080 # define IMAGE_ENABLE_VERIFY    0
1081 #endif
1082
1083 #ifdef USE_HOSTCC
1084 void *image_get_host_blob(void);
1085 void image_set_host_blob(void *host_blob);
1086 # define gd_fdt_blob()          image_get_host_blob()
1087 #else
1088 # define gd_fdt_blob()          (gd->fdt_blob)
1089 #endif
1090
1091 #ifdef CONFIG_FIT_BEST_MATCH
1092 #define IMAGE_ENABLE_BEST_MATCH 1
1093 #else
1094 #define IMAGE_ENABLE_BEST_MATCH 0
1095 #endif
1096
1097 /* Information passed to the signing routines */
1098 struct image_sign_info {
1099         const char *keydir;             /* Directory conaining keys */
1100         const char *keyname;            /* Name of key to use */
1101         void *fit;                      /* Pointer to FIT blob */
1102         int node_offset;                /* Offset of signature node */
1103         const char *name;               /* Algorithm name */
1104         struct checksum_algo *checksum; /* Checksum algorithm information */
1105         struct padding_algo *padding;   /* Padding algorithm information */
1106         struct crypto_algo *crypto;     /* Crypto algorithm information */
1107         const void *fdt_blob;           /* FDT containing public keys */
1108         int required_keynode;           /* Node offset of key to use: -1=any */
1109         const char *require_keys;       /* Value for 'required' property */
1110         const char *engine_id;          /* Engine to use for signing */
1111 };
1112 #endif /* Allow struct image_region to always be defined for rsa.h */
1113
1114 /* A part of an image, used for hashing */
1115 struct image_region {
1116         const void *data;
1117         int size;
1118 };
1119
1120 #if IMAGE_ENABLE_FIT
1121
1122 #if IMAGE_ENABLE_VERIFY
1123 # include <u-boot/rsa-checksum.h>
1124 #endif
1125 struct checksum_algo {
1126         const char *name;
1127         const int checksum_len;
1128         const int der_len;
1129         const uint8_t *der_prefix;
1130 #if IMAGE_ENABLE_SIGN
1131         const EVP_MD *(*calculate_sign)(void);
1132 #endif
1133         int (*calculate)(const char *name,
1134                          const struct image_region region[],
1135                          int region_count, uint8_t *checksum);
1136 };
1137
1138 struct crypto_algo {
1139         const char *name;               /* Name of algorithm */
1140         const int key_len;
1141
1142         /**
1143          * sign() - calculate and return signature for given input data
1144          *
1145          * @info:       Specifies key and FIT information
1146          * @data:       Pointer to the input data
1147          * @data_len:   Data length
1148          * @sigp:       Set to an allocated buffer holding the signature
1149          * @sig_len:    Set to length of the calculated hash
1150          *
1151          * This computes input data signature according to selected algorithm.
1152          * Resulting signature value is placed in an allocated buffer, the
1153          * pointer is returned as *sigp. The length of the calculated
1154          * signature is returned via the sig_len pointer argument. The caller
1155          * should free *sigp.
1156          *
1157          * @return: 0, on success, -ve on error
1158          */
1159         int (*sign)(struct image_sign_info *info,
1160                     const struct image_region region[],
1161                     int region_count, uint8_t **sigp, uint *sig_len);
1162
1163         /**
1164          * add_verify_data() - Add verification information to FDT
1165          *
1166          * Add public key information to the FDT node, suitable for
1167          * verification at run-time. The information added depends on the
1168          * algorithm being used.
1169          *
1170          * @info:       Specifies key and FIT information
1171          * @keydest:    Destination FDT blob for public key data
1172          * @return: 0, on success, -ve on error
1173          */
1174         int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1175
1176         /**
1177          * verify() - Verify a signature against some data
1178          *
1179          * @info:       Specifies key and FIT information
1180          * @data:       Pointer to the input data
1181          * @data_len:   Data length
1182          * @sig:        Signature
1183          * @sig_len:    Number of bytes in signature
1184          * @return 0 if verified, -ve on error
1185          */
1186         int (*verify)(struct image_sign_info *info,
1187                       const struct image_region region[], int region_count,
1188                       uint8_t *sig, uint sig_len);
1189 };
1190
1191 struct padding_algo {
1192         const char *name;
1193         int (*verify)(struct image_sign_info *info,
1194                       uint8_t *pad, int pad_len,
1195                       const uint8_t *hash, int hash_len);
1196 };
1197
1198 /**
1199  * image_get_checksum_algo() - Look up a checksum algorithm
1200  *
1201  * @param full_name     Name of algorithm in the form "checksum,crypto"
1202  * @return pointer to algorithm information, or NULL if not found
1203  */
1204 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1205
1206 /**
1207  * image_get_crypto_algo() - Look up a cryptosystem algorithm
1208  *
1209  * @param full_name     Name of algorithm in the form "checksum,crypto"
1210  * @return pointer to algorithm information, or NULL if not found
1211  */
1212 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1213
1214 /**
1215  * image_get_padding_algo() - Look up a padding algorithm
1216  *
1217  * @param name          Name of padding algorithm
1218  * @return pointer to algorithm information, or NULL if not found
1219  */
1220 struct padding_algo *image_get_padding_algo(const char *name);
1221
1222 /**
1223  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1224  *
1225  * @fit:                FIT to check
1226  * @image_noffset:      Offset of image node to check
1227  * @data:               Image data to check
1228  * @size:               Size of image data
1229  * @sig_blob:           FDT containing public keys
1230  * @no_sigsp:           Returns 1 if no signatures were required, and
1231  *                      therefore nothing was checked. The caller may wish
1232  *                      to fall back to other mechanisms, or refuse to
1233  *                      boot.
1234  * @return 0 if all verified ok, <0 on error
1235  */
1236 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1237                 const char *data, size_t size, const void *sig_blob,
1238                 int *no_sigsp);
1239
1240 /**
1241  * fit_image_check_sig() - Check a single image signature node
1242  *
1243  * @fit:                FIT to check
1244  * @noffset:            Offset of signature node to check
1245  * @data:               Image data to check
1246  * @size:               Size of image data
1247  * @required_keynode:   Offset in the control FDT of the required key node,
1248  *                      if any. If this is given, then the image wil not
1249  *                      pass verification unless that key is used. If this is
1250  *                      -1 then any signature will do.
1251  * @err_msgp:           In the event of an error, this will be pointed to a
1252  *                      help error string to display to the user.
1253  * @return 0 if all verified ok, <0 on error
1254  */
1255 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1256                 size_t size, int required_keynode, char **err_msgp);
1257
1258 /**
1259  * fit_region_make_list() - Make a list of regions to hash
1260  *
1261  * Given a list of FIT regions (offset, size) provided by libfdt, create
1262  * a list of regions (void *, size) for use by the signature creationg
1263  * and verification code.
1264  *
1265  * @fit:                FIT image to process
1266  * @fdt_regions:        Regions as returned by libfdt
1267  * @count:              Number of regions returned by libfdt
1268  * @region:             Place to put list of regions (NULL to allocate it)
1269  * @return pointer to list of regions, or NULL if out of memory
1270  */
1271 struct image_region *fit_region_make_list(const void *fit,
1272                 struct fdt_region *fdt_regions, int count,
1273                 struct image_region *region);
1274
1275 static inline int fit_image_check_target_arch(const void *fdt, int node)
1276 {
1277 #ifndef USE_HOSTCC
1278         return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1279 #else
1280         return 0;
1281 #endif
1282 }
1283
1284 #ifdef CONFIG_FIT_VERBOSE
1285 #define fit_unsupported(msg)    printf("! %s:%d " \
1286                                 "FIT images not supported for '%s'\n", \
1287                                 __FILE__, __LINE__, (msg))
1288
1289 #define fit_unsupported_reset(msg)      printf("! %s:%d " \
1290                                 "FIT images not supported for '%s' " \
1291                                 "- must reset board to recover!\n", \
1292                                 __FILE__, __LINE__, (msg))
1293 #else
1294 #define fit_unsupported(msg)
1295 #define fit_unsupported_reset(msg)
1296 #endif /* CONFIG_FIT_VERBOSE */
1297 #endif /* CONFIG_FIT */
1298
1299 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1300 struct andr_img_hdr;
1301 int android_image_check_header(const struct andr_img_hdr *hdr);
1302 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1303                              ulong *os_data, ulong *os_len);
1304 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1305                               ulong *rd_data, ulong *rd_len);
1306 int android_image_get_second(const struct andr_img_hdr *hdr,
1307                               ulong *second_data, ulong *second_len);
1308 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1309 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1310 void android_print_contents(const struct andr_img_hdr *hdr);
1311
1312 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1313
1314 /**
1315  * board_fit_config_name_match() - Check for a matching board name
1316  *
1317  * This is used when SPL loads a FIT containing multiple device tree files
1318  * and wants to work out which one to use. The description of each one is
1319  * passed to this function. The description comes from the 'description' field
1320  * in each (FDT) image node.
1321  *
1322  * @name: Device tree description
1323  * @return 0 if this device tree should be used, non-zero to try the next
1324  */
1325 int board_fit_config_name_match(const char *name);
1326
1327 #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1328         defined(CONFIG_FIT_IMAGE_POST_PROCESS)
1329 /**
1330  * board_fit_image_post_process() - Do any post-process on FIT binary data
1331  *
1332  * This is used to do any sort of image manipulation, verification, decryption
1333  * etc. in a platform or board specific way. Obviously, anything done here would
1334  * need to be comprehended in how the images were prepared before being injected
1335  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1336  * before being added to the FIT image).
1337  *
1338  * @image: pointer to the image start pointer
1339  * @size: pointer to the image size
1340  * @return no return value (failure should be handled internally)
1341  */
1342 void board_fit_image_post_process(void **p_image, size_t *p_size);
1343 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1344
1345 #define FDT_ERROR       ((ulong)(-1))
1346
1347 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1348
1349 /**
1350  * fit_find_config_node() - Find the node for the best DTB in a FIT image
1351  *
1352  * A FIT image contains one or more DTBs. This function parses the
1353  * configurations described in the FIT images and returns the node of
1354  * the first matching DTB. To check if a DTB matches a board, this function
1355  * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1356  * the node described by the default configuration if it exists.
1357  *
1358  * @fdt: pointer to flat device tree
1359  * @return the node if found, -ve otherwise
1360  */
1361 int fit_find_config_node(const void *fdt);
1362
1363 /**
1364  * Mapping of image types to function handlers to be invoked on the associated
1365  * loaded images
1366  *
1367  * @type: Type of image, I.E. IH_TYPE_*
1368  * @handler: Function to call on loaded image
1369  */
1370 struct fit_loadable_tbl {
1371         int type;
1372         /**
1373          * handler() - Process a loaded image
1374          *
1375          * @data: Pointer to start of loaded image data
1376          * @size: Size of loaded image data
1377          */
1378         void (*handler)(ulong data, size_t size);
1379 };
1380
1381 /*
1382  * Define a FIT loadable image type handler
1383  *
1384  * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1385  * _handler is the handler function to call after this image type is loaded
1386  */
1387 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1388         ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1389                 .type = _type, \
1390                 .handler = _handler, \
1391         }
1392
1393 #endif  /* __IMAGE_H__ */