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