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