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