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