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