include/image.h

   1 /*
   2  * (C) Copyright 2008 Semihalf
   3  *
   4  * (C) Copyright 2000-2005
   5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   6  *
   7  * SPDX-License-Identifier:     GPL-2.0+
   8  ********************************************************************
   9  * NOTE: This header file defines an interface to U-Boot. Including
  10  * this (unmodified) header file in another file is considered normal
  11  * use of U-Boot, and does *not* fall under the heading of "derived
  12  * work".
  13  ********************************************************************
  14  */
  15
  16 #ifndef __IMAGE_H__
  17 #define __IMAGE_H__
  18
  19 #include "compiler.h"
  20 #include <asm/byteorder.h>
  21
  22 /* Define this to avoid #ifdefs later on */
  23 struct lmb;
  24
  25 #ifdef USE_HOSTCC
  26
  27 /* new uImage format support enabled on host */
  28 #define CONFIG_FIT              1
  29 #define CONFIG_OF_LIBFDT        1
  30 #define CONFIG_FIT_VERBOSE      1 /* enable fit_format_{error,warning}() */
  31
  32 #define IMAGE_ENABLE_IGNORE     0
  33 #define IMAGE_INDENT_STRING     ""
  34
  35 #else
  36
  37 #include <lmb.h>
  38 #include <asm/u-boot.h>
  39 #include <command.h>
  40
  41 /* Take notice of the 'ignore' property for hashes */
  42 #define IMAGE_ENABLE_IGNORE     1
  43 #define IMAGE_INDENT_STRING     "   "
  44
  45 #endif /* USE_HOSTCC */
  46
  47 #if defined(CONFIG_FIT)
  48 #include <hash.h>
  49 #include <libfdt.h>
  50 #include <fdt_support.h>
  51 # ifdef CONFIG_SPL_BUILD
  52 #  ifdef CONFIG_SPL_CRC32_SUPPORT
  53 #   define IMAGE_ENABLE_CRC32   1
  54 #  endif
  55 #  ifdef CONFIG_SPL_MD5_SUPPORT
  56 #   define IMAGE_ENABLE_MD5     1
  57 #  endif
  58 #  ifdef CONFIG_SPL_SHA1_SUPPORT
  59 #   define IMAGE_ENABLE_SHA1    1
  60 #  endif
  61 #  ifdef CONFIG_SPL_SHA256_SUPPORT
  62 #   define IMAGE_ENABLE_SHA256  1
  63 #  endif
  64 # else
  65 #  define CONFIG_CRC32          /* FIT images need CRC32 support */
  66 #  define CONFIG_MD5            /* and MD5 */
  67 #  define CONFIG_SHA1           /* and SHA1 */
  68 #  define CONFIG_SHA256         /* and SHA256 */
  69 #  define IMAGE_ENABLE_CRC32    1
  70 #  define IMAGE_ENABLE_MD5      1
  71 #  define IMAGE_ENABLE_SHA1     1
  72 #  define IMAGE_ENABLE_SHA256   1
  73 # endif
  74
  75 #ifndef IMAGE_ENABLE_CRC32
  76 #define IMAGE_ENABLE_CRC32      0
  77 #endif
  78
  79 #ifndef IMAGE_ENABLE_MD5
  80 #define IMAGE_ENABLE_MD5        0
  81 #endif
  82
  83 #ifndef IMAGE_ENABLE_SHA1
  84 #define IMAGE_ENABLE_SHA1       0
  85 #endif
  86
  87 #ifndef IMAGE_ENABLE_SHA256
  88 #define IMAGE_ENABLE_SHA256     0
  89 #endif
  90
  91 #endif /* CONFIG_FIT */
  92
  93 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
  94 # define IMAGE_ENABLE_RAMDISK_HIGH      1
  95 #else
  96 # define IMAGE_ENABLE_RAMDISK_HIGH      0
  97 #endif
  98
  99 #ifdef CONFIG_OF_LIBFDT
 100 # define IMAGE_ENABLE_OF_LIBFDT 1
 101 #else
 102 # define IMAGE_ENABLE_OF_LIBFDT 0
 103 #endif
 104
 105 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
 106 # define IMAGE_BOOT_GET_CMDLINE         1
 107 #else
 108 # define IMAGE_BOOT_GET_CMDLINE         0
 109 #endif
 110
 111 #ifdef CONFIG_OF_BOARD_SETUP
 112 # define IMAGE_OF_BOARD_SETUP           1
 113 #else
 114 # define IMAGE_OF_BOARD_SETUP           0
 115 #endif
 116
 117 /*
 118  * Operating System Codes
 119  */
 120 #define IH_OS_INVALID           0       /* Invalid OS   */
 121 #define IH_OS_OPENBSD           1       /* OpenBSD      */
 122 #define IH_OS_NETBSD            2       /* NetBSD       */
 123 #define IH_OS_FREEBSD           3       /* FreeBSD      */
 124 #define IH_OS_4_4BSD            4       /* 4.4BSD       */
 125 #define IH_OS_LINUX             5       /* Linux        */
 126 #define IH_OS_SVR4              6       /* SVR4         */
 127 #define IH_OS_ESIX              7       /* Esix         */
 128 #define IH_OS_SOLARIS           8       /* Solaris      */
 129 #define IH_OS_IRIX              9       /* Irix         */
 130 #define IH_OS_SCO               10      /* SCO          */
 131 #define IH_OS_DELL              11      /* Dell         */
 132 #define IH_OS_NCR               12      /* NCR          */
 133 #define IH_OS_LYNXOS            13      /* LynxOS       */
 134 #define IH_OS_VXWORKS           14      /* VxWorks      */
 135 #define IH_OS_PSOS              15      /* pSOS         */
 136 #define IH_OS_QNX               16      /* QNX          */
 137 #define IH_OS_U_BOOT            17      /* Firmware     */
 138 #define IH_OS_RTEMS             18      /* RTEMS        */
 139 #define IH_OS_ARTOS             19      /* ARTOS        */
 140 #define IH_OS_UNITY             20      /* Unity OS     */
 141 #define IH_OS_INTEGRITY         21      /* INTEGRITY    */
 142 #define IH_OS_OSE               22      /* OSE          */
 143 #define IH_OS_PLAN9             23      /* Plan 9       */
 144
 145 /*
 146  * CPU Architecture Codes (supported by Linux)
 147  */
 148 #define IH_ARCH_INVALID         0       /* Invalid CPU  */
 149 #define IH_ARCH_ALPHA           1       /* Alpha        */
 150 #define IH_ARCH_ARM             2       /* ARM          */
 151 #define IH_ARCH_I386            3       /* Intel x86    */
 152 #define IH_ARCH_IA64            4       /* IA64         */
 153 #define IH_ARCH_MIPS            5       /* MIPS         */
 154 #define IH_ARCH_MIPS64          6       /* MIPS  64 Bit */
 155 #define IH_ARCH_PPC             7       /* PowerPC      */
 156 #define IH_ARCH_S390            8       /* IBM S390     */
 157 #define IH_ARCH_SH              9       /* SuperH       */
 158 #define IH_ARCH_SPARC           10      /* Sparc        */
 159 #define IH_ARCH_SPARC64         11      /* Sparc 64 Bit */
 160 #define IH_ARCH_M68K            12      /* M68K         */
 161 #define IH_ARCH_MICROBLAZE      14      /* MicroBlaze   */
 162 #define IH_ARCH_NIOS2           15      /* Nios-II      */
 163 #define IH_ARCH_BLACKFIN        16      /* Blackfin     */
 164 #define IH_ARCH_AVR32           17      /* AVR32        */
 165 #define IH_ARCH_ST200           18      /* STMicroelectronics ST200  */
 166 #define IH_ARCH_SANDBOX         19      /* Sandbox architecture (test only) */
 167 #define IH_ARCH_NDS32           20      /* ANDES Technology - NDS32  */
 168 #define IH_ARCH_OPENRISC        21      /* OpenRISC 1000  */
 169 #define IH_ARCH_ARM64           22      /* ARM64        */
 170 #define IH_ARCH_ARC             23      /* Synopsys DesignWare ARC */
 171
 172 /*
 173  * Image Types
 174  *
 175  * "Standalone Programs" are directly runnable in the environment
 176  *      provided by U-Boot; it is expected that (if they behave
 177  *      well) you can continue to work in U-Boot after return from
 178  *      the Standalone Program.
 179  * "OS Kernel Images" are usually images of some Embedded OS which
 180  *      will take over control completely. Usually these programs
 181  *      will install their own set of exception handlers, device
 182  *      drivers, set up the MMU, etc. - this means, that you cannot
 183  *      expect to re-enter U-Boot except by resetting the CPU.
 184  * "RAMDisk Images" are more or less just data blocks, and their
 185  *      parameters (address, size) are passed to an OS kernel that is
 186  *      being started.
 187  * "Multi-File Images" contain several images, typically an OS
 188  *      (Linux) kernel image and one or more data images like
 189  *      RAMDisks. This construct is useful for instance when you want
 190  *      to boot over the network using BOOTP etc., where the boot
 191  *      server provides just a single image file, but you want to get
 192  *      for instance an OS kernel and a RAMDisk image.
 193  *
 194  *      "Multi-File Images" start with a list of image sizes, each
 195  *      image size (in bytes) specified by an "uint32_t" in network
 196  *      byte order. This list is terminated by an "(uint32_t)0".
 197  *      Immediately after the terminating 0 follow the images, one by
 198  *      one, all aligned on "uint32_t" boundaries (size rounded up to
 199  *      a multiple of 4 bytes - except for the last file).
 200  *
 201  * "Firmware Images" are binary images containing firmware (like
 202  *      U-Boot or FPGA images) which usually will be programmed to
 203  *      flash memory.
 204  *
 205  * "Script files" are command sequences that will be executed by
 206  *      U-Boot's command interpreter; this feature is especially
 207  *      useful when you configure U-Boot to use a real shell (hush)
 208  *      as command interpreter (=> Shell Scripts).
 209  */
 210
 211 #define IH_TYPE_INVALID         0       /* Invalid Image                */
 212 #define IH_TYPE_STANDALONE      1       /* Standalone Program           */
 213 #define IH_TYPE_KERNEL          2       /* OS Kernel Image              */
 214 #define IH_TYPE_RAMDISK         3       /* RAMDisk Image                */
 215 #define IH_TYPE_MULTI           4       /* Multi-File Image             */
 216 #define IH_TYPE_FIRMWARE        5       /* Firmware Image               */
 217 #define IH_TYPE_SCRIPT          6       /* Script file                  */
 218 #define IH_TYPE_FILESYSTEM      7       /* Filesystem Image (any type)  */
 219 #define IH_TYPE_FLATDT          8       /* Binary Flat Device Tree Blob */
 220 #define IH_TYPE_KWBIMAGE        9       /* Kirkwood Boot Image          */
 221 #define IH_TYPE_IMXIMAGE        10      /* Freescale IMXBoot Image      */
 222 #define IH_TYPE_UBLIMAGE        11      /* Davinci UBL Image            */
 223 #define IH_TYPE_OMAPIMAGE       12      /* TI OMAP Config Header Image  */
 224 #define IH_TYPE_AISIMAGE        13      /* TI Davinci AIS Image         */
 225 #define IH_TYPE_KERNEL_NOLOAD   14      /* OS Kernel Image, can run from any load address */
 226 #define IH_TYPE_PBLIMAGE        15      /* Freescale PBL Boot Image     */
 227 #define IH_TYPE_MXSIMAGE        16      /* Freescale MXSBoot Image      */
 228 #define IH_TYPE_GPIMAGE         17      /* TI Keystone GPHeader Image   */
 229 #define IH_TYPE_ATMELIMAGE      18      /* ATMEL ROM bootable Image     */
 230
 231 /*
 232  * Compression Types
 233  */
 234 #define IH_COMP_NONE            0       /*  No   Compression Used       */
 235 #define IH_COMP_GZIP            1       /* gzip  Compression Used       */
 236 #define IH_COMP_BZIP2           2       /* bzip2 Compression Used       */
 237 #define IH_COMP_LZMA            3       /* lzma  Compression Used       */
 238 #define IH_COMP_LZO             4       /* lzo   Compression Used       */
 239
 240 #define IH_MAGIC        0x27051956      /* Image Magic Number           */
 241 #define IH_NMLEN                32      /* Image Name Length            */
 242
 243 /* Reused from common.h */
 244 #define ROUND(a, b)             (((a) + (b) - 1) & ~((b) - 1))
 245
 246 /*
 247  * Legacy format image header,
 248  * all data in network byte order (aka natural aka bigendian).
 249  */
 250 typedef struct image_header {
 251         __be32          ih_magic;       /* Image Header Magic Number    */
 252         __be32          ih_hcrc;        /* Image Header CRC Checksum    */
 253         __be32          ih_time;        /* Image Creation Timestamp     */
 254         __be32          ih_size;        /* Image Data Size              */
 255         __be32          ih_load;        /* Data  Load  Address          */
 256         __be32          ih_ep;          /* Entry Point Address          */
 257         __be32          ih_dcrc;        /* Image Data CRC Checksum      */
 258         uint8_t         ih_os;          /* Operating System             */
 259         uint8_t         ih_arch;        /* CPU architecture             */
 260         uint8_t         ih_type;        /* Image Type                   */
 261         uint8_t         ih_comp;        /* Compression Type             */
 262         uint8_t         ih_name[IH_NMLEN];      /* Image Name           */
 263 } image_header_t;
 264
 265 typedef struct image_info {
 266         ulong           start, end;             /* start/end of blob */
 267         ulong           image_start, image_len; /* start of image within blob, len of image */
 268         ulong           load;                   /* load addr for the image */
 269         uint8_t         comp, type, os;         /* compression, type of image, os type */
 270 } image_info_t;
 271
 272 /*
 273  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
 274  * routines.
 275  */
 276 typedef struct bootm_headers {
 277         /*
 278          * Legacy os image header, if it is a multi component image
 279          * then boot_get_ramdisk() and get_fdt() will attempt to get
 280          * data from second and third component accordingly.
 281          */
 282         image_header_t  *legacy_hdr_os;         /* image header pointer */
 283         image_header_t  legacy_hdr_os_copy;     /* header copy */
 284         ulong           legacy_hdr_valid;
 285
 286 #if defined(CONFIG_FIT)
 287         const char      *fit_uname_cfg; /* configuration node unit name */
 288
 289         void            *fit_hdr_os;    /* os FIT image header */
 290         const char      *fit_uname_os;  /* os subimage node unit name */
 291         int             fit_noffset_os; /* os subimage node offset */
 292
 293         void            *fit_hdr_rd;    /* init ramdisk FIT image header */
 294         const char      *fit_uname_rd;  /* init ramdisk subimage node unit name */
 295         int             fit_noffset_rd; /* init ramdisk subimage node offset */
 296
 297         void            *fit_hdr_fdt;   /* FDT blob FIT image header */
 298         const char      *fit_uname_fdt; /* FDT blob subimage node unit name */
 299         int             fit_noffset_fdt;/* FDT blob subimage node offset */
 300 #endif
 301
 302 #ifndef USE_HOSTCC
 303         image_info_t    os;             /* os image info */
 304         ulong           ep;             /* entry point of OS */
 305
 306         ulong           rd_start, rd_end;/* ramdisk start/end */
 307
 308         char            *ft_addr;       /* flat dev tree address */
 309         ulong           ft_len;         /* length of flat device tree */
 310
 311         ulong           initrd_start;
 312         ulong           initrd_end;
 313         ulong           cmdline_start;
 314         ulong           cmdline_end;
 315         bd_t            *kbd;
 316 #endif
 317
 318         int             verify;         /* getenv("verify")[0] != 'n' */
 319
 320 #define BOOTM_STATE_START       (0x00000001)
 321 #define BOOTM_STATE_FINDOS      (0x00000002)
 322 #define BOOTM_STATE_FINDOTHER   (0x00000004)
 323 #define BOOTM_STATE_LOADOS      (0x00000008)
 324 #define BOOTM_STATE_RAMDISK     (0x00000010)
 325 #define BOOTM_STATE_FDT         (0x00000020)
 326 #define BOOTM_STATE_OS_CMDLINE  (0x00000040)
 327 #define BOOTM_STATE_OS_BD_T     (0x00000080)
 328 #define BOOTM_STATE_OS_PREP     (0x00000100)
 329 #define BOOTM_STATE_OS_FAKE_GO  (0x00000200)    /* 'Almost' run the OS */
 330 #define BOOTM_STATE_OS_GO       (0x00000400)
 331         int             state;
 332
 333 #ifdef CONFIG_LMB
 334         struct lmb      lmb;            /* for memory mgmt */
 335 #endif
 336 } bootm_headers_t;
 337
 338 extern bootm_headers_t images;
 339
 340 /*
 341  * Some systems (for example LWMON) have very short watchdog periods;
 342  * we must make sure to split long operations like memmove() or
 343  * checksum calculations into reasonable chunks.
 344  */
 345 #ifndef CHUNKSZ
 346 #define CHUNKSZ (64 * 1024)
 347 #endif
 348
 349 #ifndef CHUNKSZ_CRC32
 350 #define CHUNKSZ_CRC32 (64 * 1024)
 351 #endif
 352
 353 #ifndef CHUNKSZ_MD5
 354 #define CHUNKSZ_MD5 (64 * 1024)
 355 #endif
 356
 357 #ifndef CHUNKSZ_SHA1
 358 #define CHUNKSZ_SHA1 (64 * 1024)
 359 #endif
 360
 361 #define uimage_to_cpu(x)                be32_to_cpu(x)
 362 #define cpu_to_uimage(x)                cpu_to_be32(x)
 363
 364 /*
 365  * Translation table for entries of a specific type; used by
 366  * get_table_entry_id() and get_table_entry_name().
 367  */
 368 typedef struct table_entry {
 369         int     id;
 370         char    *sname;         /* short (input) name to find table entry */
 371         char    *lname;         /* long (output) name to print for messages */
 372 } table_entry_t;
 373
 374 /*
 375  * get_table_entry_id() scans the translation table trying to find an
 376  * entry that matches the given short name. If a matching entry is
 377  * found, it's id is returned to the caller.
 378  */
 379 int get_table_entry_id(const table_entry_t *table,
 380                 const char *table_name, const char *name);
 381 /*
 382  * get_table_entry_name() scans the translation table trying to find
 383  * an entry that matches the given id. If a matching entry is found,
 384  * its long name is returned to the caller.
 385  */
 386 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
 387
 388 const char *genimg_get_os_name(uint8_t os);
 389 const char *genimg_get_arch_name(uint8_t arch);
 390 const char *genimg_get_type_name(uint8_t type);
 391 const char *genimg_get_comp_name(uint8_t comp);
 392 int genimg_get_os_id(const char *name);
 393 int genimg_get_arch_id(const char *name);
 394 int genimg_get_type_id(const char *name);
 395 int genimg_get_comp_id(const char *name);
 396 void genimg_print_size(uint32_t size);
 397
 398 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
 399         defined(USE_HOSTCC)
 400 #define IMAGE_ENABLE_TIMESTAMP 1
 401 #else
 402 #define IMAGE_ENABLE_TIMESTAMP 0
 403 #endif
 404 void genimg_print_time(time_t timestamp);
 405
 406 /* What to do with a image load address ('load = <> 'in the FIT) */
 407 enum fit_load_op {
 408         FIT_LOAD_IGNORED,       /* Ignore load address */
 409         FIT_LOAD_OPTIONAL,      /* Can be provided, but optional */
 410         FIT_LOAD_REQUIRED,      /* Must be provided */
 411 };
 412
 413 #ifndef USE_HOSTCC
 414 /* Image format types, returned by _get_format() routine */
 415 #define IMAGE_FORMAT_INVALID    0x00
 416 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 417 #define IMAGE_FORMAT_LEGACY     0x01    /* legacy image_header based format */
 418 #endif
 419 #define IMAGE_FORMAT_FIT        0x02    /* new, libfdt based format */
 420 #define IMAGE_FORMAT_ANDROID    0x03    /* Android boot image */
 421
 422 int genimg_get_format(const void *img_addr);
 423 int genimg_has_config(bootm_headers_t *images);
 424 ulong genimg_get_image(ulong img_addr);
 425
 426 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
 427                 uint8_t arch, ulong *rd_start, ulong *rd_end);
 428
 429 /**
 430  * fit_image_load() - load an image from a FIT
 431  *
 432  * This deals with all aspects of loading an image from a FIT, including
 433  * selecting the right image based on configuration, verifying it, printing
 434  * out progress messages, checking the type/arch/os and optionally copying it
 435  * to the right load address.
 436  *
 437  * @param images        Boot images structure
 438  * @param prop_name     Property name to look up (FIT_..._PROP)
 439  * @param addr          Address of FIT in memory
 440  * @param fit_unamep    On entry this is the requested image name
 441  *                      (e.g. "kernel@1") or NULL to use the default. On exit
 442  *                      points to the selected image name
 443  * @param fit_uname_configp     On entry this is the requested configuration
 444  *                      name (e.g. "conf@1") or NULL to use the default. On
 445  *                      exit points to the selected configuration name.
 446  * @param arch          Expected architecture (IH_ARCH_...)
 447  * @param image_type    Required image type (IH_TYPE_...). If this is
 448  *                      IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
 449  *                      also.
 450  * @param bootstage_id  ID of starting bootstage to use for progress updates.
 451  *                      This will be added to the BOOTSTAGE_SUB values when
 452  *                      calling bootstage_mark()
 453  * @param load_op       Decribes what to do with the load address
 454  * @param datap         Returns address of loaded image
 455  * @param lenp          Returns length of loaded image
 456  */
 457 int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
 458                    const char **fit_unamep, const char **fit_uname_configp,
 459                    int arch, int image_type, int bootstage_id,
 460                    enum fit_load_op load_op, ulong *datap, ulong *lenp);
 461
 462 /**
 463  * fit_get_node_from_config() - Look up an image a FIT by type
 464  *
 465  * This looks in the selected conf@ node (images->fit_uname_cfg) for a
 466  * particular image type (e.g. "kernel") and then finds the image that is
 467  * referred to.
 468  *
 469  * For example, for something like:
 470  *
 471  * images {
 472  *      kernel@1 {
 473  *              ...
 474  *      };
 475  * };
 476  * configurations {
 477  *      conf@1 {
 478  *              kernel = "kernel@1";
 479  *      };
 480  * };
 481  *
 482  * the function will return the node offset of the kernel@1 node, assuming
 483  * that conf@1 is the chosen configuration.
 484  *
 485  * @param images        Boot images structure
 486  * @param prop_name     Property name to look up (FIT_..._PROP)
 487  * @param addr          Address of FIT in memory
 488  */
 489 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
 490                         ulong addr);
 491
 492 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
 493                  bootm_headers_t *images,
 494                  char **of_flat_tree, ulong *of_size);
 495 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
 496 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
 497
 498 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
 499                   ulong *initrd_start, ulong *initrd_end);
 500 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
 501 #ifdef CONFIG_SYS_BOOT_GET_KBD
 502 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
 503 #endif /* CONFIG_SYS_BOOT_GET_KBD */
 504 #endif /* !USE_HOSTCC */
 505
 506 /*******************************************************************/
 507 /* Legacy format specific code (prefixed with image_) */
 508 /*******************************************************************/
 509 static inline uint32_t image_get_header_size(void)
 510 {
 511         return (sizeof(image_header_t));
 512 }
 513
 514 #define image_get_hdr_l(f) \
 515         static inline uint32_t image_get_##f(const image_header_t *hdr) \
 516         { \
 517                 return uimage_to_cpu(hdr->ih_##f); \
 518         }
 519 image_get_hdr_l(magic)          /* image_get_magic */
 520 image_get_hdr_l(hcrc)           /* image_get_hcrc */
 521 image_get_hdr_l(time)           /* image_get_time */
 522 image_get_hdr_l(size)           /* image_get_size */
 523 image_get_hdr_l(load)           /* image_get_load */
 524 image_get_hdr_l(ep)             /* image_get_ep */
 525 image_get_hdr_l(dcrc)           /* image_get_dcrc */
 526
 527 #define image_get_hdr_b(f) \
 528         static inline uint8_t image_get_##f(const image_header_t *hdr) \
 529         { \
 530                 return hdr->ih_##f; \
 531         }
 532 image_get_hdr_b(os)             /* image_get_os */
 533 image_get_hdr_b(arch)           /* image_get_arch */
 534 image_get_hdr_b(type)           /* image_get_type */
 535 image_get_hdr_b(comp)           /* image_get_comp */
 536
 537 static inline char *image_get_name(const image_header_t *hdr)
 538 {
 539         return (char *)hdr->ih_name;
 540 }
 541
 542 static inline uint32_t image_get_data_size(const image_header_t *hdr)
 543 {
 544         return image_get_size(hdr);
 545 }
 546
 547 /**
 548  * image_get_data - get image payload start address
 549  * @hdr: image header
 550  *
 551  * image_get_data() returns address of the image payload. For single
 552  * component images it is image data start. For multi component
 553  * images it points to the null terminated table of sub-images sizes.
 554  *
 555  * returns:
 556  *     image payload data start address
 557  */
 558 static inline ulong image_get_data(const image_header_t *hdr)
 559 {
 560         return ((ulong)hdr + image_get_header_size());
 561 }
 562
 563 static inline uint32_t image_get_image_size(const image_header_t *hdr)
 564 {
 565         return (image_get_size(hdr) + image_get_header_size());
 566 }
 567 static inline ulong image_get_image_end(const image_header_t *hdr)
 568 {
 569         return ((ulong)hdr + image_get_image_size(hdr));
 570 }
 571
 572 #define image_set_hdr_l(f) \
 573         static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
 574         { \
 575                 hdr->ih_##f = cpu_to_uimage(val); \
 576         }
 577 image_set_hdr_l(magic)          /* image_set_magic */
 578 image_set_hdr_l(hcrc)           /* image_set_hcrc */
 579 image_set_hdr_l(time)           /* image_set_time */
 580 image_set_hdr_l(size)           /* image_set_size */
 581 image_set_hdr_l(load)           /* image_set_load */
 582 image_set_hdr_l(ep)             /* image_set_ep */
 583 image_set_hdr_l(dcrc)           /* image_set_dcrc */
 584
 585 #define image_set_hdr_b(f) \
 586         static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
 587         { \
 588                 hdr->ih_##f = val; \
 589         }
 590 image_set_hdr_b(os)             /* image_set_os */
 591 image_set_hdr_b(arch)           /* image_set_arch */
 592 image_set_hdr_b(type)           /* image_set_type */
 593 image_set_hdr_b(comp)           /* image_set_comp */
 594
 595 static inline void image_set_name(image_header_t *hdr, const char *name)
 596 {
 597         strncpy(image_get_name(hdr), name, IH_NMLEN);
 598 }
 599
 600 int image_check_hcrc(const image_header_t *hdr);
 601 int image_check_dcrc(const image_header_t *hdr);
 602 #ifndef USE_HOSTCC
 603 ulong getenv_bootm_low(void);
 604 phys_size_t getenv_bootm_size(void);
 605 phys_size_t getenv_bootm_mapsize(void);
 606 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
 607 #endif
 608
 609 static inline int image_check_magic(const image_header_t *hdr)
 610 {
 611         return (image_get_magic(hdr) == IH_MAGIC);
 612 }
 613 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
 614 {
 615         return (image_get_type(hdr) == type);
 616 }
 617 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
 618 {
 619         return (image_get_arch(hdr) == arch);
 620 }
 621 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
 622 {
 623         return (image_get_os(hdr) == os);
 624 }
 625
 626 ulong image_multi_count(const image_header_t *hdr);
 627 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 628                         ulong *data, ulong *len);
 629
 630 void image_print_contents(const void *hdr);
 631
 632 #ifndef USE_HOSTCC
 633 static inline int image_check_target_arch(const image_header_t *hdr)
 634 {
 635 #ifndef IH_ARCH_DEFAULT
 636 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
 637 #endif
 638         return image_check_arch(hdr, IH_ARCH_DEFAULT);
 639 }
 640 #endif /* USE_HOSTCC */
 641
 642 /**
 643  * Set up properties in the FDT
 644  *
 645  * This sets up properties in the FDT that is to be passed to linux.
 646  *
 647  * @images:     Images information
 648  * @blob:       FDT to update
 649  * @of_size:    Size of the FDT
 650  * @lmb:        Points to logical memory block structure
 651  * @return 0 if ok, <0 on failure
 652  */
 653 int image_setup_libfdt(bootm_headers_t *images, void *blob,
 654                        int of_size, struct lmb *lmb);
 655
 656 /**
 657  * Set up the FDT to use for booting a kernel
 658  *
 659  * This performs ramdisk setup, sets up the FDT if required, and adds
 660  * paramters to the FDT if libfdt is available.
 661  *
 662  * @param images        Images information
 663  * @return 0 if ok, <0 on failure
 664  */
 665 int image_setup_linux(bootm_headers_t *images);
 666
 667 /**
 668  * bootz_setup() - Extract stat and size of a Linux xImage
 669  *
 670  * @image: Address of image
 671  * @start: Returns start address of image
 672  * @end : Returns end address of image
 673  * @return 0 if OK, 1 if the image was not recognised
 674  */
 675 int bootz_setup(ulong image, ulong *start, ulong *end);
 676
 677
 678 /*******************************************************************/
 679 /* New uImage format specific code (prefixed with fit_) */
 680 /*******************************************************************/
 681 #if defined(CONFIG_FIT)
 682
 683 #define FIT_IMAGES_PATH         "/images"
 684 #define FIT_CONFS_PATH          "/configurations"
 685
 686 /* hash/signature node */
 687 #define FIT_HASH_NODENAME       "hash"
 688 #define FIT_ALGO_PROP           "algo"
 689 #define FIT_VALUE_PROP          "value"
 690 #define FIT_IGNORE_PROP         "uboot-ignore"
 691 #define FIT_SIG_NODENAME        "signature"
 692
 693 /* image node */
 694 #define FIT_DATA_PROP           "data"
 695 #define FIT_TIMESTAMP_PROP      "timestamp"
 696 #define FIT_DESC_PROP           "description"
 697 #define FIT_ARCH_PROP           "arch"
 698 #define FIT_TYPE_PROP           "type"
 699 #define FIT_OS_PROP             "os"
 700 #define FIT_COMP_PROP           "compression"
 701 #define FIT_ENTRY_PROP          "entry"
 702 #define FIT_LOAD_PROP           "load"
 703
 704 /* configuration node */
 705 #define FIT_KERNEL_PROP         "kernel"
 706 #define FIT_RAMDISK_PROP        "ramdisk"
 707 #define FIT_FDT_PROP            "fdt"
 708 #define FIT_DEFAULT_PROP        "default"
 709
 710 #define FIT_MAX_HASH_LEN        HASH_MAX_DIGEST_SIZE
 711
 712 /* cmdline argument format parsing */
 713 int fit_parse_conf(const char *spec, ulong addr_curr,
 714                 ulong *addr, const char **conf_name);
 715 int fit_parse_subimage(const char *spec, ulong addr_curr,
 716                 ulong *addr, const char **image_name);
 717
 718 void fit_print_contents(const void *fit);
 719 void fit_image_print(const void *fit, int noffset, const char *p);
 720
 721 /**
 722  * fit_get_end - get FIT image size
 723  * @fit: pointer to the FIT format image header
 724  *
 725  * returns:
 726  *     size of the FIT image (blob) in memory
 727  */
 728 static inline ulong fit_get_size(const void *fit)
 729 {
 730         return fdt_totalsize(fit);
 731 }
 732
 733 /**
 734  * fit_get_end - get FIT image end
 735  * @fit: pointer to the FIT format image header
 736  *
 737  * returns:
 738  *     end address of the FIT image (blob) in memory
 739  */
 740 static inline ulong fit_get_end(const void *fit)
 741 {
 742         return (ulong)fit + fdt_totalsize(fit);
 743 }
 744
 745 /**
 746  * fit_get_name - get FIT node name
 747  * @fit: pointer to the FIT format image header
 748  *
 749  * returns:
 750  *     NULL, on error
 751  *     pointer to node name, on success
 752  */
 753 static inline const char *fit_get_name(const void *fit_hdr,
 754                 int noffset, int *len)
 755 {
 756         return fdt_get_name(fit_hdr, noffset, len);
 757 }
 758
 759 int fit_get_desc(const void *fit, int noffset, char **desc);
 760 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
 761
 762 int fit_image_get_node(const void *fit, const char *image_uname);
 763 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
 764 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
 765 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
 766 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
 767 int fit_image_get_load(const void *fit, int noffset, ulong *load);
 768 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
 769 int fit_image_get_data(const void *fit, int noffset,
 770                                 const void **data, size_t *size);
 771
 772 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
 773 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
 774                                 int *value_len);
 775
 776 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
 777
 778 /**
 779  * fit_add_verification_data() - add verification data to FIT image nodes
 780  *
 781  * @keydir:     Directory containing keys
 782  * @kwydest:    FDT blob to write public key information to
 783  * @fit:        Pointer to the FIT format image header
 784  * @comment:    Comment to add to signature nodes
 785  * @require_keys: Mark all keys as 'required'
 786  *
 787  * Adds hash values for all component images in the FIT blob.
 788  * Hashes are calculated for all component images which have hash subnodes
 789  * with algorithm property set to one of the supported hash algorithms.
 790  *
 791  * Also add signatures if signature nodes are present.
 792  *
 793  * returns
 794  *     0, on success
 795  *     libfdt error code, on failure
 796  */
 797 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
 798                               const char *comment, int require_keys);
 799
 800 int fit_image_verify(const void *fit, int noffset);
 801 int fit_config_verify(const void *fit, int conf_noffset);
 802 int fit_all_image_verify(const void *fit);
 803 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
 804 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
 805 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
 806 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
 807 int fit_check_format(const void *fit);
 808
 809 int fit_conf_find_compat(const void *fit, const void *fdt);
 810 int fit_conf_get_node(const void *fit, const char *conf_uname);
 811
 812 /**
 813  * fit_conf_get_prop_node() - Get node refered to by a configuration
 814  * @fit:        FIT to check
 815  * @noffset:    Offset of conf@xxx node to check
 816  * @prop_name:  Property to read from the conf node
 817  *
 818  * The conf@ nodes contain references to other nodes, using properties
 819  * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
 820  * return the offset of the node referred to (e.g. offset of node
 821  * "/images/kernel@1".
 822  */
 823 int fit_conf_get_prop_node(const void *fit, int noffset,
 824                 const char *prop_name);
 825
 826 void fit_conf_print(const void *fit, int noffset, const char *p);
 827
 828 int fit_check_ramdisk(const void *fit, int os_noffset,
 829                 uint8_t arch, int verify);
 830
 831 int calculate_hash(const void *data, int data_len, const char *algo,
 832                         uint8_t *value, int *value_len);
 833
 834 /*
 835  * At present we only support signing on the host, and verification on the
 836  * device
 837  */
 838 #if defined(CONFIG_FIT_SIGNATURE)
 839 # ifdef USE_HOSTCC
 840 #  define IMAGE_ENABLE_SIGN     1
 841 #  define IMAGE_ENABLE_VERIFY   1
 842 # include  <openssl/evp.h>
 843 #else
 844 #  define IMAGE_ENABLE_SIGN     0
 845 #  define IMAGE_ENABLE_VERIFY   1
 846 # endif
 847 #else
 848 # define IMAGE_ENABLE_SIGN      0
 849 # define IMAGE_ENABLE_VERIFY    0
 850 #endif
 851
 852 #ifdef USE_HOSTCC
 853 void *image_get_host_blob(void);
 854 void image_set_host_blob(void *host_blob);
 855 # define gd_fdt_blob()          image_get_host_blob()
 856 #else
 857 # define gd_fdt_blob()          (gd->fdt_blob)
 858 #endif
 859
 860 #ifdef CONFIG_FIT_BEST_MATCH
 861 #define IMAGE_ENABLE_BEST_MATCH 1
 862 #else
 863 #define IMAGE_ENABLE_BEST_MATCH 0
 864 #endif
 865
 866 /* Information passed to the signing routines */
 867 struct image_sign_info {
 868         const char *keydir;             /* Directory conaining keys */
 869         const char *keyname;            /* Name of key to use */
 870         void *fit;                      /* Pointer to FIT blob */
 871         int node_offset;                /* Offset of signature node */
 872         struct image_sig_algo *algo;    /* Algorithm information */
 873         const void *fdt_blob;           /* FDT containing public keys */
 874         int required_keynode;           /* Node offset of key to use: -1=any */
 875         const char *require_keys;       /* Value for 'required' property */
 876 };
 877
 878 /* A part of an image, used for hashing */
 879 struct image_region {
 880         const void *data;
 881         int size;
 882 };
 883
 884 #if IMAGE_ENABLE_VERIFY
 885 # include <rsa-checksum.h>
 886 #endif
 887 struct checksum_algo {
 888         const char *name;
 889         const int checksum_len;
 890         const int pad_len;
 891 #if IMAGE_ENABLE_SIGN
 892         const EVP_MD *(*calculate_sign)(void);
 893 #endif
 894         void (*calculate)(const struct image_region region[],
 895                           int region_count, uint8_t *checksum);
 896         const uint8_t *rsa_padding;
 897 };
 898
 899 struct image_sig_algo {
 900         const char *name;               /* Name of algorithm */
 901
 902         /**
 903          * sign() - calculate and return signature for given input data
 904          *
 905          * @info:       Specifies key and FIT information
 906          * @data:       Pointer to the input data
 907          * @data_len:   Data length
 908          * @sigp:       Set to an allocated buffer holding the signature
 909          * @sig_len:    Set to length of the calculated hash
 910          *
 911          * This computes input data signature according to selected algorithm.
 912          * Resulting signature value is placed in an allocated buffer, the
 913          * pointer is returned as *sigp. The length of the calculated
 914          * signature is returned via the sig_len pointer argument. The caller
 915          * should free *sigp.
 916          *
 917          * @return: 0, on success, -ve on error
 918          */
 919         int (*sign)(struct image_sign_info *info,
 920                     const struct image_region region[],
 921                     int region_count, uint8_t **sigp, uint *sig_len);
 922
 923         /**
 924          * add_verify_data() - Add verification information to FDT
 925          *
 926          * Add public key information to the FDT node, suitable for
 927          * verification at run-time. The information added depends on the
 928          * algorithm being used.
 929          *
 930          * @info:       Specifies key and FIT information
 931          * @keydest:    Destination FDT blob for public key data
 932          * @return: 0, on success, -ve on error
 933          */
 934         int (*add_verify_data)(struct image_sign_info *info, void *keydest);
 935
 936         /**
 937          * verify() - Verify a signature against some data
 938          *
 939          * @info:       Specifies key and FIT information
 940          * @data:       Pointer to the input data
 941          * @data_len:   Data length
 942          * @sig:        Signature
 943          * @sig_len:    Number of bytes in signature
 944          * @return 0 if verified, -ve on error
 945          */
 946         int (*verify)(struct image_sign_info *info,
 947                       const struct image_region region[], int region_count,
 948                       uint8_t *sig, uint sig_len);
 949
 950         /* pointer to checksum algorithm */
 951         struct checksum_algo *checksum;
 952 };
 953
 954 /**
 955  * image_get_sig_algo() - Look up a signature algortihm
 956  *
 957  * @param name          Name of algorithm
 958  * @return pointer to algorithm information, or NULL if not found
 959  */
 960 struct image_sig_algo *image_get_sig_algo(const char *name);
 961
 962 /**
 963  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
 964  *
 965  * @fit:                FIT to check
 966  * @image_noffset:      Offset of image node to check
 967  * @data:               Image data to check
 968  * @size:               Size of image data
 969  * @sig_blob:           FDT containing public keys
 970  * @no_sigsp:           Returns 1 if no signatures were required, and
 971  *                      therefore nothing was checked. The caller may wish
 972  *                      to fall back to other mechanisms, or refuse to
 973  *                      boot.
 974  * @return 0 if all verified ok, <0 on error
 975  */
 976 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
 977                 const char *data, size_t size, const void *sig_blob,
 978                 int *no_sigsp);
 979
 980 /**
 981  * fit_image_check_sig() - Check a single image signature node
 982  *
 983  * @fit:                FIT to check
 984  * @noffset:            Offset of signature node to check
 985  * @data:               Image data to check
 986  * @size:               Size of image data
 987  * @required_keynode:   Offset in the control FDT of the required key node,
 988  *                      if any. If this is given, then the image wil not
 989  *                      pass verification unless that key is used. If this is
 990  *                      -1 then any signature will do.
 991  * @err_msgp:           In the event of an error, this will be pointed to a
 992  *                      help error string to display to the user.
 993  * @return 0 if all verified ok, <0 on error
 994  */
 995 int fit_image_check_sig(const void *fit, int noffset, const void *data,
 996                 size_t size, int required_keynode, char **err_msgp);
 997
 998 /**
 999  * fit_region_make_list() - Make a list of regions to hash
1000  *
1001  * Given a list of FIT regions (offset, size) provided by libfdt, create
1002  * a list of regions (void *, size) for use by the signature creationg
1003  * and verification code.
1004  *
1005  * @fit:                FIT image to process
1006  * @fdt_regions:        Regions as returned by libfdt
1007  * @count:              Number of regions returned by libfdt
1008  * @region:             Place to put list of regions (NULL to allocate it)
1009  * @return pointer to list of regions, or NULL if out of memory
1010  */
1011 struct image_region *fit_region_make_list(const void *fit,
1012                 struct fdt_region *fdt_regions, int count,
1013                 struct image_region *region);
1014
1015 static inline int fit_image_check_target_arch(const void *fdt, int node)
1016 {
1017 #ifndef USE_HOSTCC
1018         return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1019 #else
1020         return 0;
1021 #endif
1022 }
1023
1024 #ifdef CONFIG_FIT_VERBOSE
1025 #define fit_unsupported(msg)    printf("! %s:%d " \
1026                                 "FIT images not supported for '%s'\n", \
1027                                 __FILE__, __LINE__, (msg))
1028
1029 #define fit_unsupported_reset(msg)      printf("! %s:%d " \
1030                                 "FIT images not supported for '%s' " \
1031                                 "- must reset board to recover!\n", \
1032                                 __FILE__, __LINE__, (msg))
1033 #else
1034 #define fit_unsupported(msg)
1035 #define fit_unsupported_reset(msg)
1036 #endif /* CONFIG_FIT_VERBOSE */
1037 #endif /* CONFIG_FIT */
1038
1039 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1040 struct andr_img_hdr;
1041 int android_image_check_header(const struct andr_img_hdr *hdr);
1042 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1043                              ulong *os_data, ulong *os_len);
1044 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1045                               ulong *rd_data, ulong *rd_len);
1046 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1047 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1048
1049 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1050
1051 #endif  /* __IMAGE_H__ */