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