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