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