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  * See file CREDITS for list of people who contributed to this
   8  * project.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation; either version 2 of
  13  * the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  23  * MA 02111-1307 USA
  24  *
  25  ********************************************************************
  26  * NOTE: This header file defines an interface to U-Boot. Including
  27  * this (unmodified) header file in another file is considered normal
  28  * use of U-Boot, and does *not* fall under the heading of "derived
  29  * work".
  30  ********************************************************************
  31  */
  32
  33 #ifndef __IMAGE_H__
  34 #define __IMAGE_H__
  35
  36 #include "compiler.h"
  37 #include <asm/byteorder.h>
  38
  39 #ifdef USE_HOSTCC
  40
  41 /* new uImage format support enabled on host */
  42 #define CONFIG_FIT              1
  43 #define CONFIG_OF_LIBFDT        1
  44 #define CONFIG_FIT_VERBOSE      1 /* enable fit_format_{error,warning}() */
  45
  46 #define IMAGE_ENABLE_IGNORE     0
  47 #define IMAGE_INDENT_STRING     ""
  48
  49 #else
  50
  51 #include <lmb.h>
  52 #include <asm/u-boot.h>
  53 #include <command.h>
  54
  55 /* Take notice of the 'ignore' property for hashes */
  56 #define IMAGE_ENABLE_IGNORE     1
  57 #define IMAGE_INDENT_STRING     "   "
  58
  59 #endif /* USE_HOSTCC */
  60
  61 #if defined(CONFIG_FIT)
  62 #include <libfdt.h>
  63 #include <fdt_support.h>
  64 # ifdef CONFIG_SPL_BUILD
  65 #  ifdef CONFIG_SPL_CRC32_SUPPORT
  66 #   define IMAGE_ENABLE_CRC32   1
  67 #  endif
  68 #  ifdef CONFIG_SPL_MD5_SUPPORT
  69 #   define IMAGE_ENABLE_MD5     1
  70 #  endif
  71 #  ifdef CONFIG_SPL_SHA1_SUPPORT
  72 #   define IMAGE_ENABLE_SHA1    1
  73 #  endif
  74 # else
  75 #  define CONFIG_CRC32          /* FIT images need CRC32 support */
  76 #  define CONFIG_MD5            /* and MD5 */
  77 #  define CONFIG_SHA1           /* and SHA1 */
  78 #  define IMAGE_ENABLE_CRC32    1
  79 #  define IMAGE_ENABLE_MD5      1
  80 #  define IMAGE_ENABLE_SHA1     1
  81 # endif
  82
  83 #ifndef IMAGE_ENABLE_CRC32
  84 #define IMAGE_ENABLE_CRC32      0
  85 #endif
  86
  87 #ifndef IMAGE_ENABLE_MD5
  88 #define IMAGE_ENABLE_MD5        0
  89 #endif
  90
  91 #ifndef IMAGE_ENABLE_SHA1
  92 #define IMAGE_ENABLE_SHA1       0
  93 #endif
  94
  95 #endif
  96
  97 /*
  98  * Operating System Codes
  99  */
 100 #define IH_OS_INVALID           0       /* Invalid OS   */
 101 #define IH_OS_OPENBSD           1       /* OpenBSD      */
 102 #define IH_OS_NETBSD            2       /* NetBSD       */
 103 #define IH_OS_FREEBSD           3       /* FreeBSD      */
 104 #define IH_OS_4_4BSD            4       /* 4.4BSD       */
 105 #define IH_OS_LINUX             5       /* Linux        */
 106 #define IH_OS_SVR4              6       /* SVR4         */
 107 #define IH_OS_ESIX              7       /* Esix         */
 108 #define IH_OS_SOLARIS           8       /* Solaris      */
 109 #define IH_OS_IRIX              9       /* Irix         */
 110 #define IH_OS_SCO               10      /* SCO          */
 111 #define IH_OS_DELL              11      /* Dell         */
 112 #define IH_OS_NCR               12      /* NCR          */
 113 #define IH_OS_LYNXOS            13      /* LynxOS       */
 114 #define IH_OS_VXWORKS           14      /* VxWorks      */
 115 #define IH_OS_PSOS              15      /* pSOS         */
 116 #define IH_OS_QNX               16      /* QNX          */
 117 #define IH_OS_U_BOOT            17      /* Firmware     */
 118 #define IH_OS_RTEMS             18      /* RTEMS        */
 119 #define IH_OS_ARTOS             19      /* ARTOS        */
 120 #define IH_OS_UNITY             20      /* Unity OS     */
 121 #define IH_OS_INTEGRITY         21      /* INTEGRITY    */
 122 #define IH_OS_OSE               22      /* OSE          */
 123 #define IH_OS_PLAN9             23      /* Plan 9       */
 124
 125 /*
 126  * CPU Architecture Codes (supported by Linux)
 127  */
 128 #define IH_ARCH_INVALID         0       /* Invalid CPU  */
 129 #define IH_ARCH_ALPHA           1       /* Alpha        */
 130 #define IH_ARCH_ARM             2       /* ARM          */
 131 #define IH_ARCH_I386            3       /* Intel x86    */
 132 #define IH_ARCH_IA64            4       /* IA64         */
 133 #define IH_ARCH_MIPS            5       /* MIPS         */
 134 #define IH_ARCH_MIPS64          6       /* MIPS  64 Bit */
 135 #define IH_ARCH_PPC             7       /* PowerPC      */
 136 #define IH_ARCH_S390            8       /* IBM S390     */
 137 #define IH_ARCH_SH              9       /* SuperH       */
 138 #define IH_ARCH_SPARC           10      /* Sparc        */
 139 #define IH_ARCH_SPARC64         11      /* Sparc 64 Bit */
 140 #define IH_ARCH_M68K            12      /* M68K         */
 141 #define IH_ARCH_MICROBLAZE      14      /* MicroBlaze   */
 142 #define IH_ARCH_NIOS2           15      /* Nios-II      */
 143 #define IH_ARCH_BLACKFIN        16      /* Blackfin     */
 144 #define IH_ARCH_AVR32           17      /* AVR32        */
 145 #define IH_ARCH_ST200           18      /* STMicroelectronics ST200  */
 146 #define IH_ARCH_SANDBOX         19      /* Sandbox architecture (test only) */
 147 #define IH_ARCH_NDS32           20      /* ANDES Technology - NDS32  */
 148 #define IH_ARCH_OPENRISC        21      /* OpenRISC 1000  */
 149
 150 /*
 151  * Image Types
 152  *
 153  * "Standalone Programs" are directly runnable in the environment
 154  *      provided by U-Boot; it is expected that (if they behave
 155  *      well) you can continue to work in U-Boot after return from
 156  *      the Standalone Program.
 157  * "OS Kernel Images" are usually images of some Embedded OS which
 158  *      will take over control completely. Usually these programs
 159  *      will install their own set of exception handlers, device
 160  *      drivers, set up the MMU, etc. - this means, that you cannot
 161  *      expect to re-enter U-Boot except by resetting the CPU.
 162  * "RAMDisk Images" are more or less just data blocks, and their
 163  *      parameters (address, size) are passed to an OS kernel that is
 164  *      being started.
 165  * "Multi-File Images" contain several images, typically an OS
 166  *      (Linux) kernel image and one or more data images like
 167  *      RAMDisks. This construct is useful for instance when you want
 168  *      to boot over the network using BOOTP etc., where the boot
 169  *      server provides just a single image file, but you want to get
 170  *      for instance an OS kernel and a RAMDisk image.
 171  *
 172  *      "Multi-File Images" start with a list of image sizes, each
 173  *      image size (in bytes) specified by an "uint32_t" in network
 174  *      byte order. This list is terminated by an "(uint32_t)0".
 175  *      Immediately after the terminating 0 follow the images, one by
 176  *      one, all aligned on "uint32_t" boundaries (size rounded up to
 177  *      a multiple of 4 bytes - except for the last file).
 178  *
 179  * "Firmware Images" are binary images containing firmware (like
 180  *      U-Boot or FPGA images) which usually will be programmed to
 181  *      flash memory.
 182  *
 183  * "Script files" are command sequences that will be executed by
 184  *      U-Boot's command interpreter; this feature is especially
 185  *      useful when you configure U-Boot to use a real shell (hush)
 186  *      as command interpreter (=> Shell Scripts).
 187  */
 188
 189 #define IH_TYPE_INVALID         0       /* Invalid Image                */
 190 #define IH_TYPE_STANDALONE      1       /* Standalone Program           */
 191 #define IH_TYPE_KERNEL          2       /* OS Kernel Image              */
 192 #define IH_TYPE_RAMDISK         3       /* RAMDisk Image                */
 193 #define IH_TYPE_MULTI           4       /* Multi-File Image             */
 194 #define IH_TYPE_FIRMWARE        5       /* Firmware Image               */
 195 #define IH_TYPE_SCRIPT          6       /* Script file                  */
 196 #define IH_TYPE_FILESYSTEM      7       /* Filesystem Image (any type)  */
 197 #define IH_TYPE_FLATDT          8       /* Binary Flat Device Tree Blob */
 198 #define IH_TYPE_KWBIMAGE        9       /* Kirkwood Boot Image          */
 199 #define IH_TYPE_IMXIMAGE        10      /* Freescale IMXBoot Image      */
 200 #define IH_TYPE_UBLIMAGE        11      /* Davinci UBL Image            */
 201 #define IH_TYPE_OMAPIMAGE       12      /* TI OMAP Config Header Image  */
 202 #define IH_TYPE_AISIMAGE        13      /* TI Davinci AIS Image         */
 203 #define IH_TYPE_KERNEL_NOLOAD   14      /* OS Kernel Image, can run from any load address */
 204 #define IH_TYPE_PBLIMAGE        15      /* Freescale PBL Boot Image     */
 205
 206 /*
 207  * Compression Types
 208  */
 209 #define IH_COMP_NONE            0       /*  No   Compression Used       */
 210 #define IH_COMP_GZIP            1       /* gzip  Compression Used       */
 211 #define IH_COMP_BZIP2           2       /* bzip2 Compression Used       */
 212 #define IH_COMP_LZMA            3       /* lzma  Compression Used       */
 213 #define IH_COMP_LZO             4       /* lzo   Compression Used       */
 214
 215 #define IH_MAGIC        0x27051956      /* Image Magic Number           */
 216 #define IH_NMLEN                32      /* Image Name Length            */
 217
 218 /* Reused from common.h */
 219 #define ROUND(a, b)             (((a) + (b) - 1) & ~((b) - 1))
 220
 221 /*
 222  * Legacy format image header,
 223  * all data in network byte order (aka natural aka bigendian).
 224  */
 225 typedef struct image_header {
 226         __be32          ih_magic;       /* Image Header Magic Number    */
 227         __be32          ih_hcrc;        /* Image Header CRC Checksum    */
 228         __be32          ih_time;        /* Image Creation Timestamp     */
 229         __be32          ih_size;        /* Image Data Size              */
 230         __be32          ih_load;        /* Data  Load  Address          */
 231         __be32          ih_ep;          /* Entry Point Address          */
 232         __be32          ih_dcrc;        /* Image Data CRC Checksum      */
 233         uint8_t         ih_os;          /* Operating System             */
 234         uint8_t         ih_arch;        /* CPU architecture             */
 235         uint8_t         ih_type;        /* Image Type                   */
 236         uint8_t         ih_comp;        /* Compression Type             */
 237         uint8_t         ih_name[IH_NMLEN];      /* Image Name           */
 238 } image_header_t;
 239
 240 typedef struct image_info {
 241         ulong           start, end;             /* start/end of blob */
 242         ulong           image_start, image_len; /* start of image within blob, len of image */
 243         ulong           load;                   /* load addr for the image */
 244         uint8_t         comp, type, os;         /* compression, type of image, os type */
 245 } image_info_t;
 246
 247 /*
 248  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
 249  * routines.
 250  */
 251 typedef struct bootm_headers {
 252         /*
 253          * Legacy os image header, if it is a multi component image
 254          * then boot_get_ramdisk() and get_fdt() will attempt to get
 255          * data from second and third component accordingly.
 256          */
 257         image_header_t  *legacy_hdr_os;         /* image header pointer */
 258         image_header_t  legacy_hdr_os_copy;     /* header copy */
 259         ulong           legacy_hdr_valid;
 260
 261 #if defined(CONFIG_FIT)
 262         const char      *fit_uname_cfg; /* configuration node unit name */
 263
 264         void            *fit_hdr_os;    /* os FIT image header */
 265         const char      *fit_uname_os;  /* os subimage node unit name */
 266         int             fit_noffset_os; /* os subimage node offset */
 267
 268         void            *fit_hdr_rd;    /* init ramdisk FIT image header */
 269         const char      *fit_uname_rd;  /* init ramdisk subimage node unit name */
 270         int             fit_noffset_rd; /* init ramdisk subimage node offset */
 271
 272         void            *fit_hdr_fdt;   /* FDT blob FIT image header */
 273         const char      *fit_uname_fdt; /* FDT blob subimage node unit name */
 274         int             fit_noffset_fdt;/* FDT blob subimage node offset */
 275 #endif
 276
 277 #ifndef USE_HOSTCC
 278         image_info_t    os;             /* os image info */
 279         ulong           ep;             /* entry point of OS */
 280
 281         ulong           rd_start, rd_end;/* ramdisk start/end */
 282
 283 #ifdef CONFIG_OF_LIBFDT
 284         char            *ft_addr;       /* flat dev tree address */
 285 #endif
 286         ulong           ft_len;         /* length of flat device tree */
 287
 288         ulong           initrd_start;
 289         ulong           initrd_end;
 290         ulong           cmdline_start;
 291         ulong           cmdline_end;
 292         bd_t            *kbd;
 293 #endif
 294
 295         int             verify;         /* getenv("verify")[0] != 'n' */
 296
 297 #define BOOTM_STATE_START       (0x00000001)
 298 #define BOOTM_STATE_LOADOS      (0x00000002)
 299 #define BOOTM_STATE_RAMDISK     (0x00000004)
 300 #define BOOTM_STATE_FDT         (0x00000008)
 301 #define BOOTM_STATE_OS_CMDLINE  (0x00000010)
 302 #define BOOTM_STATE_OS_BD_T     (0x00000020)
 303 #define BOOTM_STATE_OS_PREP     (0x00000040)
 304 #define BOOTM_STATE_OS_GO       (0x00000080)
 305         int             state;
 306
 307 #ifdef CONFIG_LMB
 308         struct lmb      lmb;            /* for memory mgmt */
 309 #endif
 310 } bootm_headers_t;
 311
 312 extern bootm_headers_t images;
 313
 314 /*
 315  * Some systems (for example LWMON) have very short watchdog periods;
 316  * we must make sure to split long operations like memmove() or
 317  * checksum calculations into reasonable chunks.
 318  */
 319 #ifndef CHUNKSZ
 320 #define CHUNKSZ (64 * 1024)
 321 #endif
 322
 323 #ifndef CHUNKSZ_CRC32
 324 #define CHUNKSZ_CRC32 (64 * 1024)
 325 #endif
 326
 327 #ifndef CHUNKSZ_MD5
 328 #define CHUNKSZ_MD5 (64 * 1024)
 329 #endif
 330
 331 #ifndef CHUNKSZ_SHA1
 332 #define CHUNKSZ_SHA1 (64 * 1024)
 333 #endif
 334
 335 #define uimage_to_cpu(x)                be32_to_cpu(x)
 336 #define cpu_to_uimage(x)                cpu_to_be32(x)
 337
 338 /*
 339  * Translation table for entries of a specific type; used by
 340  * get_table_entry_id() and get_table_entry_name().
 341  */
 342 typedef struct table_entry {
 343         int     id;
 344         char    *sname;         /* short (input) name to find table entry */
 345         char    *lname;         /* long (output) name to print for messages */
 346 } table_entry_t;
 347
 348 /*
 349  * get_table_entry_id() scans the translation table trying to find an
 350  * entry that matches the given short name. If a matching entry is
 351  * found, it's id is returned to the caller.
 352  */
 353 int get_table_entry_id(const table_entry_t *table,
 354                 const char *table_name, const char *name);
 355 /*
 356  * get_table_entry_name() scans the translation table trying to find
 357  * an entry that matches the given id. If a matching entry is found,
 358  * its long name is returned to the caller.
 359  */
 360 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
 361
 362 const char *genimg_get_os_name(uint8_t os);
 363 const char *genimg_get_arch_name(uint8_t arch);
 364 const char *genimg_get_type_name(uint8_t type);
 365 const char *genimg_get_comp_name(uint8_t comp);
 366 int genimg_get_os_id(const char *name);
 367 int genimg_get_arch_id(const char *name);
 368 int genimg_get_type_id(const char *name);
 369 int genimg_get_comp_id(const char *name);
 370 void genimg_print_size(uint32_t size);
 371
 372 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
 373         defined(USE_HOSTCC)
 374 #define IMAGE_ENABLE_TIMESTAMP 1
 375 #else
 376 #define IMAGE_ENABLE_TIMESTAMP 0
 377 #endif
 378 void genimg_print_time(time_t timestamp);
 379
 380 #ifndef USE_HOSTCC
 381 /* Image format types, returned by _get_format() routine */
 382 #define IMAGE_FORMAT_INVALID    0x00
 383 #define IMAGE_FORMAT_LEGACY     0x01    /* legacy image_header based format */
 384 #define IMAGE_FORMAT_FIT        0x02    /* new, libfdt based format */
 385
 386 int genimg_get_format(const void *img_addr);
 387 int genimg_has_config(bootm_headers_t *images);
 388 ulong genimg_get_image(ulong img_addr);
 389
 390 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
 391                 uint8_t arch, ulong *rd_start, ulong *rd_end);
 392
 393
 394 #ifdef CONFIG_OF_LIBFDT
 395 int boot_get_fdt(int flag, int argc, char * const argv[],
 396                 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
 397 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
 398 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
 399 #endif
 400
 401 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 402 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
 403                   ulong *initrd_start, ulong *initrd_end);
 404 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
 405 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
 406 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
 407 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
 408 #ifdef CONFIG_SYS_BOOT_GET_KBD
 409 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
 410 #endif /* CONFIG_SYS_BOOT_GET_KBD */
 411 #endif /* !USE_HOSTCC */
 412
 413 /*******************************************************************/
 414 /* Legacy format specific code (prefixed with image_) */
 415 /*******************************************************************/
 416 static inline uint32_t image_get_header_size(void)
 417 {
 418         return (sizeof(image_header_t));
 419 }
 420
 421 #define image_get_hdr_l(f) \
 422         static inline uint32_t image_get_##f(const image_header_t *hdr) \
 423         { \
 424                 return uimage_to_cpu(hdr->ih_##f); \
 425         }
 426 image_get_hdr_l(magic)          /* image_get_magic */
 427 image_get_hdr_l(hcrc)           /* image_get_hcrc */
 428 image_get_hdr_l(time)           /* image_get_time */
 429 image_get_hdr_l(size)           /* image_get_size */
 430 image_get_hdr_l(load)           /* image_get_load */
 431 image_get_hdr_l(ep)             /* image_get_ep */
 432 image_get_hdr_l(dcrc)           /* image_get_dcrc */
 433
 434 #define image_get_hdr_b(f) \
 435         static inline uint8_t image_get_##f(const image_header_t *hdr) \
 436         { \
 437                 return hdr->ih_##f; \
 438         }
 439 image_get_hdr_b(os)             /* image_get_os */
 440 image_get_hdr_b(arch)           /* image_get_arch */
 441 image_get_hdr_b(type)           /* image_get_type */
 442 image_get_hdr_b(comp)           /* image_get_comp */
 443
 444 static inline char *image_get_name(const image_header_t *hdr)
 445 {
 446         return (char *)hdr->ih_name;
 447 }
 448
 449 static inline uint32_t image_get_data_size(const image_header_t *hdr)
 450 {
 451         return image_get_size(hdr);
 452 }
 453
 454 /**
 455  * image_get_data - get image payload start address
 456  * @hdr: image header
 457  *
 458  * image_get_data() returns address of the image payload. For single
 459  * component images it is image data start. For multi component
 460  * images it points to the null terminated table of sub-images sizes.
 461  *
 462  * returns:
 463  *     image payload data start address
 464  */
 465 static inline ulong image_get_data(const image_header_t *hdr)
 466 {
 467         return ((ulong)hdr + image_get_header_size());
 468 }
 469
 470 static inline uint32_t image_get_image_size(const image_header_t *hdr)
 471 {
 472         return (image_get_size(hdr) + image_get_header_size());
 473 }
 474 static inline ulong image_get_image_end(const image_header_t *hdr)
 475 {
 476         return ((ulong)hdr + image_get_image_size(hdr));
 477 }
 478
 479 #define image_set_hdr_l(f) \
 480         static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
 481         { \
 482                 hdr->ih_##f = cpu_to_uimage(val); \
 483         }
 484 image_set_hdr_l(magic)          /* image_set_magic */
 485 image_set_hdr_l(hcrc)           /* image_set_hcrc */
 486 image_set_hdr_l(time)           /* image_set_time */
 487 image_set_hdr_l(size)           /* image_set_size */
 488 image_set_hdr_l(load)           /* image_set_load */
 489 image_set_hdr_l(ep)             /* image_set_ep */
 490 image_set_hdr_l(dcrc)           /* image_set_dcrc */
 491
 492 #define image_set_hdr_b(f) \
 493         static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
 494         { \
 495                 hdr->ih_##f = val; \
 496         }
 497 image_set_hdr_b(os)             /* image_set_os */
 498 image_set_hdr_b(arch)           /* image_set_arch */
 499 image_set_hdr_b(type)           /* image_set_type */
 500 image_set_hdr_b(comp)           /* image_set_comp */
 501
 502 static inline void image_set_name(image_header_t *hdr, const char *name)
 503 {
 504         strncpy(image_get_name(hdr), name, IH_NMLEN);
 505 }
 506
 507 int image_check_hcrc(const image_header_t *hdr);
 508 int image_check_dcrc(const image_header_t *hdr);
 509 #ifndef USE_HOSTCC
 510 ulong getenv_bootm_low(void);
 511 phys_size_t getenv_bootm_size(void);
 512 phys_size_t getenv_bootm_mapsize(void);
 513 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
 514 #endif
 515
 516 static inline int image_check_magic(const image_header_t *hdr)
 517 {
 518         return (image_get_magic(hdr) == IH_MAGIC);
 519 }
 520 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
 521 {
 522         return (image_get_type(hdr) == type);
 523 }
 524 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
 525 {
 526         return (image_get_arch(hdr) == arch);
 527 }
 528 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
 529 {
 530         return (image_get_os(hdr) == os);
 531 }
 532
 533 ulong image_multi_count(const image_header_t *hdr);
 534 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 535                         ulong *data, ulong *len);
 536
 537 void image_print_contents(const void *hdr);
 538
 539 #ifndef USE_HOSTCC
 540 static inline int image_check_target_arch(const image_header_t *hdr)
 541 {
 542 #ifndef IH_ARCH_DEFAULT
 543 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
 544 #endif
 545         return image_check_arch(hdr, IH_ARCH_DEFAULT);
 546 }
 547 #endif /* USE_HOSTCC */
 548
 549 /*******************************************************************/
 550 /* New uImage format specific code (prefixed with fit_) */
 551 /*******************************************************************/
 552 #if defined(CONFIG_FIT)
 553
 554 #define FIT_IMAGES_PATH         "/images"
 555 #define FIT_CONFS_PATH          "/configurations"
 556
 557 /* hash node */
 558 #define FIT_HASH_NODENAME       "hash"
 559 #define FIT_ALGO_PROP           "algo"
 560 #define FIT_VALUE_PROP          "value"
 561 #define FIT_IGNORE_PROP         "uboot-ignore"
 562
 563 /* image node */
 564 #define FIT_DATA_PROP           "data"
 565 #define FIT_TIMESTAMP_PROP      "timestamp"
 566 #define FIT_DESC_PROP           "description"
 567 #define FIT_ARCH_PROP           "arch"
 568 #define FIT_TYPE_PROP           "type"
 569 #define FIT_OS_PROP             "os"
 570 #define FIT_COMP_PROP           "compression"
 571 #define FIT_ENTRY_PROP          "entry"
 572 #define FIT_LOAD_PROP           "load"
 573
 574 /* configuration node */
 575 #define FIT_KERNEL_PROP         "kernel"
 576 #define FIT_RAMDISK_PROP        "ramdisk"
 577 #define FIT_FDT_PROP            "fdt"
 578 #define FIT_DEFAULT_PROP        "default"
 579
 580 #define FIT_MAX_HASH_LEN        20      /* max(crc32_len(4), sha1_len(20)) */
 581
 582 /* cmdline argument format parsing */
 583 int fit_parse_conf(const char *spec, ulong addr_curr,
 584                 ulong *addr, const char **conf_name);
 585 int fit_parse_subimage(const char *spec, ulong addr_curr,
 586                 ulong *addr, const char **image_name);
 587
 588 void fit_print_contents(const void *fit);
 589 void fit_image_print(const void *fit, int noffset, const char *p);
 590
 591 /**
 592  * fit_get_end - get FIT image size
 593  * @fit: pointer to the FIT format image header
 594  *
 595  * returns:
 596  *     size of the FIT image (blob) in memory
 597  */
 598 static inline ulong fit_get_size(const void *fit)
 599 {
 600         return fdt_totalsize(fit);
 601 }
 602
 603 /**
 604  * fit_get_end - get FIT image end
 605  * @fit: pointer to the FIT format image header
 606  *
 607  * returns:
 608  *     end address of the FIT image (blob) in memory
 609  */
 610 static inline ulong fit_get_end(const void *fit)
 611 {
 612         return (ulong)fit + fdt_totalsize(fit);
 613 }
 614
 615 /**
 616  * fit_get_name - get FIT node name
 617  * @fit: pointer to the FIT format image header
 618  *
 619  * returns:
 620  *     NULL, on error
 621  *     pointer to node name, on success
 622  */
 623 static inline const char *fit_get_name(const void *fit_hdr,
 624                 int noffset, int *len)
 625 {
 626         return fdt_get_name(fit_hdr, noffset, len);
 627 }
 628
 629 int fit_get_desc(const void *fit, int noffset, char **desc);
 630 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
 631
 632 int fit_image_get_node(const void *fit, const char *image_uname);
 633 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
 634 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
 635 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
 636 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
 637 int fit_image_get_load(const void *fit, int noffset, ulong *load);
 638 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
 639 int fit_image_get_data(const void *fit, int noffset,
 640                                 const void **data, size_t *size);
 641
 642 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
 643 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
 644                                 int *value_len);
 645
 646 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
 647
 648 /**
 649  * fit_add_verification_data() - Calculate and add hashes to FIT
 650  *
 651  * @fit:        Fit image to process
 652  * @return 0 if ok, <0 for error
 653  */
 654 int fit_add_verification_data(void *fit);
 655
 656 int fit_image_verify(const void *fit, int noffset);
 657 int fit_all_image_verify(const void *fit);
 658 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
 659 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
 660 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
 661 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
 662 int fit_check_format(const void *fit);
 663
 664 int fit_conf_find_compat(const void *fit, const void *fdt);
 665 int fit_conf_get_node(const void *fit, const char *conf_uname);
 666 int fit_conf_get_kernel_node(const void *fit, int noffset);
 667 int fit_conf_get_ramdisk_node(const void *fit, int noffset);
 668 int fit_conf_get_fdt_node(const void *fit, int noffset);
 669
 670 /**
 671  * fit_conf_get_prop_node() - Get node refered to by a configuration
 672  * @fit:        FIT to check
 673  * @noffset:    Offset of conf@xxx node to check
 674  * @prop_name:  Property to read from the conf node
 675  *
 676  * The conf@ nodes contain references to other nodes, using properties
 677  * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
 678  * return the offset of the node referred to (e.g. offset of node
 679  * "/images/kernel@1".
 680  */
 681 int fit_conf_get_prop_node(const void *fit, int noffset,
 682                 const char *prop_name);
 683
 684 void fit_conf_print(const void *fit, int noffset, const char *p);
 685
 686 int fit_check_ramdisk(const void *fit, int os_noffset,
 687                 uint8_t arch, int verify);
 688
 689 int calculate_hash(const void *data, int data_len, const char *algo,
 690                         uint8_t *value, int *value_len);
 691
 692 #ifndef USE_HOSTCC
 693 static inline int fit_image_check_target_arch(const void *fdt, int node)
 694 {
 695         return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
 696 }
 697 #endif /* USE_HOSTCC */
 698
 699 #ifdef CONFIG_FIT_VERBOSE
 700 #define fit_unsupported(msg)    printf("! %s:%d " \
 701                                 "FIT images not supported for '%s'\n", \
 702                                 __FILE__, __LINE__, (msg))
 703
 704 #define fit_unsupported_reset(msg)      printf("! %s:%d " \
 705                                 "FIT images not supported for '%s' " \
 706                                 "- must reset board to recover!\n", \
 707                                 __FILE__, __LINE__, (msg))
 708 #else
 709 #define fit_unsupported(msg)
 710 #define fit_unsupported_reset(msg)
 711 #endif /* CONFIG_FIT_VERBOSE */
 712 #endif /* CONFIG_FIT */
 713
 714 #endif  /* __IMAGE_H__ */