]> git.ipfire.org Git - thirdparty/u-boot.git/blame - include/image.h
image: Move error! string to common place
[thirdparty/u-boot.git] / include / image.h
CommitLineData
5b1d7137 1/*
b97a2a0a
MB
2 * (C) Copyright 2008 Semihalf
3 *
f08abe31 4 * (C) Copyright 2000-2005
5b1d7137
WD
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
f08abe31
WD
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 ********************************************************************
5b1d7137
WD
31 */
32
33#ifndef __IMAGE_H__
34#define __IMAGE_H__
35
37566090 36#include "compiler.h"
2f220500 37#include <asm/byteorder.h>
37566090
MF
38
39#ifdef USE_HOSTCC
9d25438f
BS
40
41/* new uImage format support enabled on host */
75d3e8fb
MB
42#define CONFIG_FIT 1
43#define CONFIG_OF_LIBFDT 1
9d25438f 44#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
75d3e8fb 45
ab9efc66
SG
46#define IMAGE_ENABLE_IGNORE 0
47
def0819e
WD
48#else
49
50#include <lmb.h>
def0819e 51#include <asm/u-boot.h>
5daa1c18 52#include <command.h>
def0819e 53
ab9efc66
SG
54/* Take notice of the 'ignore' property for hashes */
55#define IMAGE_ENABLE_IGNORE 1
56
9d25438f 57#endif /* USE_HOSTCC */
d5934ad7 58
5dfb5213 59#if defined(CONFIG_FIT)
5dfb5213
MB
60#include <libfdt.h>
61#include <fdt_support.h>
766529fc 62#define CONFIG_MD5 /* FIT images need MD5 support */
dac4d7e8 63#define CONFIG_SHA1 /* and SHA1 */
5dfb5213 64#endif
b97a2a0a 65
5b1d7137
WD
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 */
d791b1dc 87#define IH_OS_RTEMS 18 /* RTEMS */
7f70e853 88#define IH_OS_ARTOS 19 /* ARTOS */
27b207fd 89#define IH_OS_UNITY 20 /* Unity OS */
f5ed9e39 90#define IH_OS_INTEGRITY 21 /* INTEGRITY */
3df61957 91#define IH_OS_OSE 22 /* OSE */
04d41409 92#define IH_OS_PLAN9 23 /* Plan 9 */
5b1d7137
WD
93
94/*
95 * CPU Architecture Codes (supported by Linux)
96 */
b97a2a0a
MB
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 */
b97a2a0a
MB
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 */
65bf1d39 115#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
f52138ae 116#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
3ddcaccd 117#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
5b1d7137
WD
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
e1599e83 146 * a multiple of 4 bytes - except for the last file).
5b1d7137
WD
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)
27b207fd 155 * as command interpreter (=> Shell Scripts).
5b1d7137
WD
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 */
fbe4b5cb 165#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
25c751e9 166#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
aa0c7a86 167#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
8edcde5e 168#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
7816f2cf 169#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
3decb14a 170#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
4962e38e 171#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
b9b50e89 172#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
5d898a00 173#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
5b1d7137
WD
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 */
fc9c1727 181#define IH_COMP_LZMA 3 /* lzma Compression Used */
20dde48b 182#define IH_COMP_LZO 4 /* lzo Compression Used */
5b1d7137
WD
183
184#define IH_MAGIC 0x27051956 /* Image Magic Number */
185#define IH_NMLEN 32 /* Image Name Length */
186
1411fb37
FE
187/* Reused from common.h */
188#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
189
5b1d7137 190/*
9a4daad0
MB
191 * Legacy format image header,
192 * all data in network byte order (aka natural aka bigendian).
5b1d7137 193 */
5b1d7137 194typedef struct image_header {
2f220500
KP
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 */
5b1d7137
WD
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
396f635b
KG
209typedef 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
d5934ad7
MB
216/*
217 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
218 * routines.
219 */
220typedef struct bootm_headers {
221 /*
222 * Legacy os image header, if it is a multi component image
9a4daad0 223 * then boot_get_ramdisk() and get_fdt() will attempt to get
d5934ad7
MB
224 * data from second and third component accordingly.
225 */
cb1c4896
MB
226 image_header_t *legacy_hdr_os; /* image header pointer */
227 image_header_t legacy_hdr_os_copy; /* header copy */
d5934ad7
MB
228 ulong legacy_hdr_valid;
229
230#if defined(CONFIG_FIT)
f773bea8
MB
231 const char *fit_uname_cfg; /* configuration node unit name */
232
d5934ad7 233 void *fit_hdr_os; /* os FIT image header */
eb6175ed 234 const char *fit_uname_os; /* os subimage node unit name */
3dfe1101 235 int fit_noffset_os; /* os subimage node offset */
d5934ad7
MB
236
237 void *fit_hdr_rd; /* init ramdisk FIT image header */
3dfe1101
MB
238 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
239 int fit_noffset_rd; /* init ramdisk subimage node offset */
d5934ad7 240
d5934ad7 241 void *fit_hdr_fdt; /* FDT blob FIT image header */
3dfe1101
MB
242 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
243 int fit_noffset_fdt;/* FDT blob subimage node offset */
d5934ad7 244#endif
1ec73761 245
49c3a861 246#ifndef USE_HOSTCC
396f635b 247 image_info_t os; /* os image info */
c160a954
KG
248 ulong ep; /* entry point of OS */
249
c4f9419c
KG
250 ulong rd_start, rd_end;/* ramdisk start/end */
251
06a09918
KG
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
49c3a861
KG
257 ulong initrd_start;
258 ulong initrd_end;
259 ulong cmdline_start;
260 ulong cmdline_end;
261 bd_t *kbd;
262#endif
263
8a5ea3e6 264 int verify; /* getenv("verify")[0] != 'n' */
49c3a861
KG
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
a16028da 276#ifdef CONFIG_LMB
e906cfae
KG
277 struct lmb lmb; /* for memory mgmt */
278#endif
d5934ad7
MB
279} bootm_headers_t;
280
1648a375
SS
281extern bootm_headers_t images;
282
559316fa
MB
283/*
284 * Some systems (for example LWMON) have very short watchdog periods;
285 * we must make sure to split long operations like memmove() or
7590378f 286 * checksum calculations into reasonable chunks.
559316fa 287 */
7590378f 288#ifndef CHUNKSZ
559316fa 289#define CHUNKSZ (64 * 1024)
7590378f
BS
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
559316fa 303
37566090
MF
304#define uimage_to_cpu(x) be32_to_cpu(x)
305#define cpu_to_uimage(x) cpu_to_be32(x)
9a4daad0 306
b029dddc
PW
307/*
308 * Translation table for entries of a specific type; used by
309 * get_table_entry_id() and get_table_entry_name().
310 */
311typedef 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 */
7edb186f 322int get_table_entry_id(const table_entry_t *table,
b029dddc
PW
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 */
7edb186f 329char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
b029dddc 330
712fbcf3
SW
331const char *genimg_get_os_name(uint8_t os);
332const char *genimg_get_arch_name(uint8_t arch);
333const char *genimg_get_type_name(uint8_t type);
334const char *genimg_get_comp_name(uint8_t comp);
335int genimg_get_os_id(const char *name);
336int genimg_get_arch_id(const char *name);
337int genimg_get_type_id(const char *name);
338int genimg_get_comp_id(const char *name);
339void genimg_print_size(uint32_t size);
570abb0a 340
859e92b7
SG
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
347void genimg_print_time(time_t timestamp);
348
9a4daad0
MB
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
712fbcf3
SW
355int genimg_get_format(void *img_addr);
356int genimg_has_config(bootm_headers_t *images);
357ulong genimg_get_image(ulong img_addr);
9a4daad0 358
712fbcf3 359int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
d985c849 360 uint8_t arch, ulong *rd_start, ulong *rd_end);
9a4daad0 361
06a09918
KG
362
363#ifdef CONFIG_OF_LIBFDT
712fbcf3
SW
364int boot_get_fdt(int flag, int argc, char * const argv[],
365 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
55b0a393 366void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
712fbcf3 367int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
06a09918
KG
368#endif
369
fca43cc8 370#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
712fbcf3 371int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
9a4daad0 372 ulong *initrd_start, ulong *initrd_end);
fca43cc8
JR
373#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
374#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
712fbcf3 375int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
fca43cc8
JR
376#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
377#ifdef CONFIG_SYS_BOOT_GET_KBD
712fbcf3 378int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
fca43cc8 379#endif /* CONFIG_SYS_BOOT_GET_KBD */
570abb0a 380#endif /* !USE_HOSTCC */
b97a2a0a 381
9a4daad0
MB
382/*******************************************************************/
383/* Legacy format specific code (prefixed with image_) */
384/*******************************************************************/
712fbcf3 385static inline uint32_t image_get_header_size(void)
b97a2a0a 386{
712fbcf3 387 return (sizeof(image_header_t));
b97a2a0a
MB
388}
389
390#define image_get_hdr_l(f) \
3a2003f6 391 static inline uint32_t image_get_##f(const image_header_t *hdr) \
b97a2a0a 392 { \
712fbcf3 393 return uimage_to_cpu(hdr->ih_##f); \
b97a2a0a 394 }
712fbcf3
SW
395image_get_hdr_l(magic) /* image_get_magic */
396image_get_hdr_l(hcrc) /* image_get_hcrc */
397image_get_hdr_l(time) /* image_get_time */
398image_get_hdr_l(size) /* image_get_size */
399image_get_hdr_l(load) /* image_get_load */
400image_get_hdr_l(ep) /* image_get_ep */
401image_get_hdr_l(dcrc) /* image_get_dcrc */
b97a2a0a
MB
402
403#define image_get_hdr_b(f) \
3a2003f6 404 static inline uint8_t image_get_##f(const image_header_t *hdr) \
b97a2a0a
MB
405 { \
406 return hdr->ih_##f; \
407 }
712fbcf3
SW
408image_get_hdr_b(os) /* image_get_os */
409image_get_hdr_b(arch) /* image_get_arch */
410image_get_hdr_b(type) /* image_get_type */
411image_get_hdr_b(comp) /* image_get_comp */
b97a2a0a 412
712fbcf3 413static inline char *image_get_name(const image_header_t *hdr)
b97a2a0a
MB
414{
415 return (char *)hdr->ih_name;
416}
417
712fbcf3 418static inline uint32_t image_get_data_size(const image_header_t *hdr)
b97a2a0a 419{
712fbcf3 420 return image_get_size(hdr);
b97a2a0a 421}
f13e7b2e
MB
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 */
712fbcf3 434static inline ulong image_get_data(const image_header_t *hdr)
f13e7b2e 435{
712fbcf3 436 return ((ulong)hdr + image_get_header_size());
f13e7b2e
MB
437}
438
712fbcf3 439static inline uint32_t image_get_image_size(const image_header_t *hdr)
b97a2a0a 440{
712fbcf3 441 return (image_get_size(hdr) + image_get_header_size());
b97a2a0a 442}
712fbcf3 443static inline ulong image_get_image_end(const image_header_t *hdr)
b97a2a0a 444{
712fbcf3 445 return ((ulong)hdr + image_get_image_size(hdr));
b97a2a0a
MB
446}
447
448#define image_set_hdr_l(f) \
449 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
450 { \
712fbcf3 451 hdr->ih_##f = cpu_to_uimage(val); \
b97a2a0a 452 }
712fbcf3
SW
453image_set_hdr_l(magic) /* image_set_magic */
454image_set_hdr_l(hcrc) /* image_set_hcrc */
455image_set_hdr_l(time) /* image_set_time */
456image_set_hdr_l(size) /* image_set_size */
457image_set_hdr_l(load) /* image_set_load */
458image_set_hdr_l(ep) /* image_set_ep */
459image_set_hdr_l(dcrc) /* image_set_dcrc */
b97a2a0a
MB
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 }
712fbcf3
SW
466image_set_hdr_b(os) /* image_set_os */
467image_set_hdr_b(arch) /* image_set_arch */
468image_set_hdr_b(type) /* image_set_type */
469image_set_hdr_b(comp) /* image_set_comp */
b97a2a0a 470
712fbcf3 471static inline void image_set_name(image_header_t *hdr, const char *name)
b97a2a0a 472{
712fbcf3 473 strncpy(image_get_name(hdr), name, IH_NMLEN);
b97a2a0a
MB
474}
475
712fbcf3
SW
476int image_check_hcrc(const image_header_t *hdr);
477int image_check_dcrc(const image_header_t *hdr);
af13cdbc 478#ifndef USE_HOSTCC
d3f2fa0d 479ulong getenv_bootm_low(void);
391fd93a 480phys_size_t getenv_bootm_size(void);
c3624e6e 481phys_size_t getenv_bootm_mapsize(void);
712fbcf3 482void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
af13cdbc 483#endif
b97a2a0a 484
712fbcf3 485static inline int image_check_magic(const image_header_t *hdr)
b97a2a0a 486{
712fbcf3 487 return (image_get_magic(hdr) == IH_MAGIC);
b97a2a0a 488}
712fbcf3 489static inline int image_check_type(const image_header_t *hdr, uint8_t type)
b97a2a0a 490{
712fbcf3 491 return (image_get_type(hdr) == type);
b97a2a0a 492}
712fbcf3 493static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
b97a2a0a 494{
712fbcf3 495 return (image_get_arch(hdr) == arch);
b97a2a0a 496}
712fbcf3 497static inline int image_check_os(const image_header_t *hdr, uint8_t os)
b97a2a0a 498{
712fbcf3 499 return (image_get_os(hdr) == os);
b97a2a0a
MB
500}
501
712fbcf3
SW
502ulong image_multi_count(const image_header_t *hdr);
503void image_multi_getimg(const image_header_t *hdr, ulong idx,
42b73e8e
MB
504 ulong *data, ulong *len);
505
712fbcf3 506void image_print_contents(const void *hdr);
570abb0a 507
b97a2a0a 508#ifndef USE_HOSTCC
712fbcf3 509static inline int image_check_target_arch(const image_header_t *hdr)
b97a2a0a 510{
476af299
MF
511#ifndef IH_ARCH_DEFAULT
512# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
b97a2a0a 513#endif
476af299 514 return image_check_arch(hdr, IH_ARCH_DEFAULT);
b97a2a0a 515}
5dfb5213 516#endif /* USE_HOSTCC */
5b1d7137 517
d5934ad7 518/*******************************************************************/
9a4daad0 519/* New uImage format specific code (prefixed with fit_) */
d5934ad7 520/*******************************************************************/
f50433d6 521#if defined(CONFIG_FIT)
5dfb5213
MB
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"
8ac88f2d 530#define FIT_IGNORE_PROP "uboot-ignore"
5dfb5213
MB
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 */
314f634b 552int fit_parse_conf(const char *spec, ulong addr_curr,
f50433d6 553 ulong *addr, const char **conf_name);
314f634b 554int fit_parse_subimage(const char *spec, ulong addr_curr,
f50433d6 555 ulong *addr, const char **image_name);
d5934ad7 556
712fbcf3
SW
557void fit_print_contents(const void *fit);
558void fit_image_print(const void *fit, int noffset, const char *p);
559void fit_image_print_hash(const void *fit, int noffset, const char *p);
5dfb5213
MB
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 */
712fbcf3 568static inline ulong fit_get_size(const void *fit)
5dfb5213 569{
712fbcf3 570 return fdt_totalsize(fit);
5dfb5213
MB
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 */
712fbcf3 580static inline ulong fit_get_end(const void *fit)
5dfb5213 581{
712fbcf3 582 return (ulong)fit + fdt_totalsize(fit);
5dfb5213
MB
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 */
712fbcf3 593static inline const char *fit_get_name(const void *fit_hdr,
5dfb5213
MB
594 int noffset, int *len)
595{
712fbcf3 596 return fdt_get_name(fit_hdr, noffset, len);
5dfb5213
MB
597}
598
712fbcf3
SW
599int fit_get_desc(const void *fit, int noffset, char **desc);
600int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
601
602int fit_image_get_node(const void *fit, const char *image_uname);
603int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
604int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
605int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
606int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
607int fit_image_get_load(const void *fit, int noffset, ulong *load);
608int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
609int fit_image_get_data(const void *fit, int noffset,
5dfb5213
MB
610 const void **data, size_t *size);
611
712fbcf3
SW
612int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
613int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
5dfb5213
MB
614 int *value_len);
615
712fbcf3
SW
616int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
617int fit_set_hashes(void *fit);
618int fit_image_set_hashes(void *fit, int image_noffset);
5dfb5213 619
b8da8366
SG
620int fit_image_verify(const void *fit, int noffset);
621int fit_all_image_verify(const void *fit);
712fbcf3
SW
622int fit_image_check_os(const void *fit, int noffset, uint8_t os);
623int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
624int fit_image_check_type(const void *fit, int noffset, uint8_t type);
625int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
626int fit_check_format(const void *fit);
5dfb5213 627
d95f6ec7 628int fit_conf_find_compat(const void *fit, const void *fdt);
712fbcf3
SW
629int fit_conf_get_node(const void *fit, const char *conf_uname);
630int fit_conf_get_kernel_node(const void *fit, int noffset);
631int fit_conf_get_ramdisk_node(const void *fit, int noffset);
632int fit_conf_get_fdt_node(const void *fit, int noffset);
5dfb5213 633
712fbcf3 634void fit_conf_print(const void *fit, int noffset, const char *p);
5dfb5213 635
61a439a8
SG
636int fit_check_ramdisk(const void *fit, int os_noffset,
637 uint8_t arch, int verify);
638
604f23dd
SG
639int calculate_hash(const void *data, int data_len, const char *algo,
640 uint8_t *value, int *value_len);
641
5dfb5213 642#ifndef USE_HOSTCC
712fbcf3 643static inline int fit_image_check_target_arch(const void *fdt, int node)
5dfb5213 644{
7566832a 645 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
5dfb5213
MB
646}
647#endif /* USE_HOSTCC */
648
d5934ad7 649#ifdef CONFIG_FIT_VERBOSE
712fbcf3 650#define fit_unsupported(msg) printf("! %s:%d " \
d5934ad7
MB
651 "FIT images not supported for '%s'\n", \
652 __FILE__, __LINE__, (msg))
653
712fbcf3 654#define fit_unsupported_reset(msg) printf("! %s:%d " \
d5934ad7
MB
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 */
f50433d6 662#endif /* CONFIG_FIT */
5ad03eb3 663
f13e7b2e 664#endif /* __IMAGE_H__ */