blob: 36143e25acfe3684a751a4ee6a5cf945524ef424 [file] [log] [blame]
wdenk5b1d7132002-11-03 00:07:02 +00001/*
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01002 * (C) Copyright 2008 Semihalf
3 *
Wolfgang Denkf08abe32005-11-25 16:38:03 +01004 * (C) Copyright 2000-2005
wdenk5b1d7132002-11-03 00:07:02 +00005 * 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
Wolfgang Denkf08abe32005-11-25 16:38:03 +010024 *
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 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000031 */
32
33#ifndef __IMAGE_H__
34#define __IMAGE_H__
35
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010036#include <asm/byteorder.h>
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +010037#include <command.h>
Marian Balakowicz75d3e8f2008-02-21 17:20:18 +010038
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010039#ifndef USE_HOSTCC
Kumar Gala4ed65522008-02-27 21:51:47 -060040#include <lmb.h>
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010041#include <linux/string.h>
Marian Balakowiczceaed2b2008-01-31 13:57:17 +010042#include <asm/u-boot.h>
Marian Balakowicz75d3e8f2008-02-21 17:20:18 +010043
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010044#else
45
46/* new uImage format support enabled on host */
47#define CONFIG_FIT 1
48#define CONFIG_OF_LIBFDT 1
49#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
50
51#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010052
Marian Balakowicz75d3e8f2008-02-21 17:20:18 +010053#if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
54#error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010055#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010056
57#if defined(CONFIG_FIT)
58#include <fdt.h>
59#include <libfdt.h>
60#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010061#define CONFIG_MD5 /* FIT images need MD5 support */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010062#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010063
wdenk5b1d7132002-11-03 00:07:02 +000064/*
65 * Operating System Codes
66 */
67#define IH_OS_INVALID 0 /* Invalid OS */
68#define IH_OS_OPENBSD 1 /* OpenBSD */
69#define IH_OS_NETBSD 2 /* NetBSD */
70#define IH_OS_FREEBSD 3 /* FreeBSD */
71#define IH_OS_4_4BSD 4 /* 4.4BSD */
72#define IH_OS_LINUX 5 /* Linux */
73#define IH_OS_SVR4 6 /* SVR4 */
74#define IH_OS_ESIX 7 /* Esix */
75#define IH_OS_SOLARIS 8 /* Solaris */
76#define IH_OS_IRIX 9 /* Irix */
77#define IH_OS_SCO 10 /* SCO */
78#define IH_OS_DELL 11 /* Dell */
79#define IH_OS_NCR 12 /* NCR */
80#define IH_OS_LYNXOS 13 /* LynxOS */
81#define IH_OS_VXWORKS 14 /* VxWorks */
82#define IH_OS_PSOS 15 /* pSOS */
83#define IH_OS_QNX 16 /* QNX */
84#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +000085#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +000086#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +000087#define IH_OS_UNITY 20 /* Unity OS */
wdenk5b1d7132002-11-03 00:07:02 +000088
89/*
90 * CPU Architecture Codes (supported by Linux)
91 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010092#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_NIOS 13 /* Nios-32 */
106#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
107#define IH_ARCH_NIOS2 15 /* Nios-II */
108#define IH_ARCH_BLACKFIN 16 /* Blackfin */
109#define IH_ARCH_AVR32 17 /* AVR32 */
110#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
wdenk5b1d7132002-11-03 00:07:02 +0000111
112/*
113 * Image Types
114 *
115 * "Standalone Programs" are directly runnable in the environment
116 * provided by U-Boot; it is expected that (if they behave
117 * well) you can continue to work in U-Boot after return from
118 * the Standalone Program.
119 * "OS Kernel Images" are usually images of some Embedded OS which
120 * will take over control completely. Usually these programs
121 * will install their own set of exception handlers, device
122 * drivers, set up the MMU, etc. - this means, that you cannot
123 * expect to re-enter U-Boot except by resetting the CPU.
124 * "RAMDisk Images" are more or less just data blocks, and their
125 * parameters (address, size) are passed to an OS kernel that is
126 * being started.
127 * "Multi-File Images" contain several images, typically an OS
128 * (Linux) kernel image and one or more data images like
129 * RAMDisks. This construct is useful for instance when you want
130 * to boot over the network using BOOTP etc., where the boot
131 * server provides just a single image file, but you want to get
132 * for instance an OS kernel and a RAMDisk image.
133 *
134 * "Multi-File Images" start with a list of image sizes, each
135 * image size (in bytes) specified by an "uint32_t" in network
136 * byte order. This list is terminated by an "(uint32_t)0".
137 * Immediately after the terminating 0 follow the images, one by
138 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000139 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000140 *
141 * "Firmware Images" are binary images containing firmware (like
142 * U-Boot or FPGA images) which usually will be programmed to
143 * flash memory.
144 *
145 * "Script files" are command sequences that will be executed by
146 * U-Boot's command interpreter; this feature is especially
147 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000148 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000149 */
150
151#define IH_TYPE_INVALID 0 /* Invalid Image */
152#define IH_TYPE_STANDALONE 1 /* Standalone Program */
153#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
154#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
155#define IH_TYPE_MULTI 4 /* Multi-File Image */
156#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
157#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000158#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500159#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
wdenk5b1d7132002-11-03 00:07:02 +0000160
161/*
162 * Compression Types
163 */
164#define IH_COMP_NONE 0 /* No Compression Used */
165#define IH_COMP_GZIP 1 /* gzip Compression Used */
166#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
167
168#define IH_MAGIC 0x27051956 /* Image Magic Number */
169#define IH_NMLEN 32 /* Image Name Length */
170
wdenk5b1d7132002-11-03 00:07:02 +0000171/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100172 * Legacy format image header,
173 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000174 */
wdenk5b1d7132002-11-03 00:07:02 +0000175typedef struct image_header {
176 uint32_t ih_magic; /* Image Header Magic Number */
177 uint32_t ih_hcrc; /* Image Header CRC Checksum */
178 uint32_t ih_time; /* Image Creation Timestamp */
179 uint32_t ih_size; /* Image Data Size */
180 uint32_t ih_load; /* Data Load Address */
181 uint32_t ih_ep; /* Entry Point Address */
182 uint32_t ih_dcrc; /* Image Data CRC Checksum */
183 uint8_t ih_os; /* Operating System */
184 uint8_t ih_arch; /* CPU architecture */
185 uint8_t ih_type; /* Image Type */
186 uint8_t ih_comp; /* Compression Type */
187 uint8_t ih_name[IH_NMLEN]; /* Image Name */
188} image_header_t;
189
Marian Balakowicz559316f2008-01-08 18:11:44 +0100190/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100191 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
192 * routines.
193 */
194typedef struct bootm_headers {
195 /*
196 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100197 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100198 * data from second and third component accordingly.
199 */
200 image_header_t *legacy_hdr_os;
201 ulong legacy_hdr_valid;
202
203#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100204 const char *fit_uname_cfg; /* configuration node unit name */
205
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100206 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100207 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100208 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100209
210 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100211 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
212 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100213
214#if defined(CONFIG_PPC)
215 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100216 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
217 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100218#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100219#endif
220
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100221 int verify; /* getenv("verify")[0] != 'n' */
Kumar Galaf5614e72008-02-27 21:51:48 -0600222 int autostart; /* getenv("autostart")[0] != 'n' */
Kumar Gala4ed65522008-02-27 21:51:47 -0600223 struct lmb *lmb; /* for memory mgmt */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100224} bootm_headers_t;
225
226/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100227 * Some systems (for example LWMON) have very short watchdog periods;
228 * we must make sure to split long operations like memmove() or
229 * crc32() into reasonable chunks.
230 */
231#define CHUNKSZ (64 * 1024)
232
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100233#define uimage_to_cpu(x) ntohl(x)
234#define cpu_to_uimage(x) htonl(x)
wdenk5b1d7132002-11-03 00:07:02 +0000235
Marian Balakowicz570abb02008-02-29 15:59:59 +0100236const char *genimg_get_os_name (uint8_t os);
237const char *genimg_get_arch_name (uint8_t arch);
238const char *genimg_get_type_name (uint8_t type);
239const char *genimg_get_comp_name (uint8_t comp);
240int genimg_get_os_id (const char *name);
241int genimg_get_arch_id (const char *name);
242int genimg_get_type_id (const char *name);
243int genimg_get_comp_id (const char *name);
244
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100245#ifndef USE_HOSTCC
246/* Image format types, returned by _get_format() routine */
247#define IMAGE_FORMAT_INVALID 0x00
248#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
249#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
250
251int genimg_get_format (void *img_addr);
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100252int genimg_has_config (bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100253ulong genimg_get_image (ulong img_addr);
254
Marian Balakowiczd985c842008-03-12 10:14:38 +0100255int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
256 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100257
258#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
259int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
260 ulong *initrd_start, ulong *initrd_end);
261
262int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
263 ulong bootmap_base);
264int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
265#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100266#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100267
268/*******************************************************************/
269/* Legacy format specific code (prefixed with image_) */
270/*******************************************************************/
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100271static inline uint32_t image_get_header_size (void)
272{
273 return (sizeof (image_header_t));
274}
275
276#define image_get_hdr_l(f) \
277 static inline uint32_t image_get_##f(image_header_t *hdr) \
278 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100279 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100280 }
281image_get_hdr_l (magic);
282image_get_hdr_l (hcrc);
283image_get_hdr_l (time);
284image_get_hdr_l (size);
285image_get_hdr_l (load);
286image_get_hdr_l (ep);
287image_get_hdr_l (dcrc);
288
289#define image_get_hdr_b(f) \
290 static inline uint8_t image_get_##f(image_header_t *hdr) \
291 { \
292 return hdr->ih_##f; \
293 }
294image_get_hdr_b (os);
295image_get_hdr_b (arch);
296image_get_hdr_b (type);
297image_get_hdr_b (comp);
298
299static inline char *image_get_name (image_header_t *hdr)
300{
301 return (char *)hdr->ih_name;
302}
303
304static inline uint32_t image_get_data_size (image_header_t *hdr)
305{
306 return image_get_size (hdr);
307}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100308
309/**
310 * image_get_data - get image payload start address
311 * @hdr: image header
312 *
313 * image_get_data() returns address of the image payload. For single
314 * component images it is image data start. For multi component
315 * images it points to the null terminated table of sub-images sizes.
316 *
317 * returns:
318 * image payload data start address
319 */
320static inline ulong image_get_data (image_header_t *hdr)
321{
322 return ((ulong)hdr + image_get_header_size ());
323}
324
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100325static inline uint32_t image_get_image_size (image_header_t *hdr)
326{
327 return (image_get_size (hdr) + image_get_header_size ());
328}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100329static inline ulong image_get_image_end (image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100330{
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100331 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100332}
333
334#define image_set_hdr_l(f) \
335 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
336 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100337 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100338 }
339image_set_hdr_l (magic);
340image_set_hdr_l (hcrc);
341image_set_hdr_l (time);
342image_set_hdr_l (size);
343image_set_hdr_l (load);
344image_set_hdr_l (ep);
345image_set_hdr_l (dcrc);
346
347#define image_set_hdr_b(f) \
348 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
349 { \
350 hdr->ih_##f = val; \
351 }
352image_set_hdr_b (os);
353image_set_hdr_b (arch);
354image_set_hdr_b (type);
355image_set_hdr_b (comp);
356
357static inline void image_set_name (image_header_t *hdr, const char *name)
358{
359 strncpy (image_get_name (hdr), name, IH_NMLEN);
360}
361
362int image_check_hcrc (image_header_t *hdr);
363int image_check_dcrc (image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100364#ifndef USE_HOSTCC
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100365int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
366int getenv_verify (void);
Kumar Galaf5614e72008-02-27 21:51:48 -0600367int getenv_autostart (void);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600368ulong getenv_bootm_low(void);
369ulong getenv_bootm_size(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100370void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
371#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100372
373static inline int image_check_magic (image_header_t *hdr)
374{
375 return (image_get_magic (hdr) == IH_MAGIC);
376}
377static inline int image_check_type (image_header_t *hdr, uint8_t type)
378{
379 return (image_get_type (hdr) == type);
380}
381static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
382{
383 return (image_get_arch (hdr) == arch);
384}
385static inline int image_check_os (image_header_t *hdr, uint8_t os)
386{
387 return (image_get_os (hdr) == os);
388}
389
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100390ulong image_multi_count (image_header_t *hdr);
391void image_multi_getimg (image_header_t *hdr, ulong idx,
392 ulong *data, ulong *len);
393
Marian Balakowicz570abb02008-02-29 15:59:59 +0100394inline void image_print_contents (image_header_t *hdr);
395inline void image_print_contents_noindent (image_header_t *hdr);
396
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100397#ifndef USE_HOSTCC
398static inline int image_check_target_arch (image_header_t *hdr)
399{
400#if defined(__ARM__)
401 if (!image_check_arch (hdr, IH_ARCH_ARM))
402#elif defined(__avr32__)
403 if (!image_check_arch (hdr, IH_ARCH_AVR32))
404#elif defined(__bfin__)
405 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
406#elif defined(__I386__)
407 if (!image_check_arch (hdr, IH_ARCH_I386))
408#elif defined(__M68K__)
409 if (!image_check_arch (hdr, IH_ARCH_M68K))
410#elif defined(__microblaze__)
411 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
412#elif defined(__mips__)
413 if (!image_check_arch (hdr, IH_ARCH_MIPS))
414#elif defined(__nios__)
415 if (!image_check_arch (hdr, IH_ARCH_NIOS))
416#elif defined(__nios2__)
417 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
418#elif defined(__PPC__)
419 if (!image_check_arch (hdr, IH_ARCH_PPC))
420#elif defined(__sh__)
421 if (!image_check_arch (hdr, IH_ARCH_SH))
422#else
423# error Unknown CPU type
424#endif
425 return 0;
426
427 return 1;
428}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100429#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100430
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100431/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100432/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100433/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100434#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100435
436#define FIT_IMAGES_PATH "/images"
437#define FIT_CONFS_PATH "/configurations"
438
439/* hash node */
440#define FIT_HASH_NODENAME "hash"
441#define FIT_ALGO_PROP "algo"
442#define FIT_VALUE_PROP "value"
443
444/* image node */
445#define FIT_DATA_PROP "data"
446#define FIT_TIMESTAMP_PROP "timestamp"
447#define FIT_DESC_PROP "description"
448#define FIT_ARCH_PROP "arch"
449#define FIT_TYPE_PROP "type"
450#define FIT_OS_PROP "os"
451#define FIT_COMP_PROP "compression"
452#define FIT_ENTRY_PROP "entry"
453#define FIT_LOAD_PROP "load"
454
455/* configuration node */
456#define FIT_KERNEL_PROP "kernel"
457#define FIT_RAMDISK_PROP "ramdisk"
458#define FIT_FDT_PROP "fdt"
459#define FIT_DEFAULT_PROP "default"
460
461#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
462
463/* cmdline argument format parsing */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100464inline int fit_parse_conf (const char *spec, ulong addr_curr,
465 ulong *addr, const char **conf_name);
466inline int fit_parse_subimage (const char *spec, ulong addr_curr,
467 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100468
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100469inline void fit_print_contents (const void *fit);
470inline void fit_print_contents_noindent (const void *fit);
471void fit_image_print (const void *fit, int noffset, const char *p);
472void fit_image_print_hash (const void *fit, int noffset, const char *p);
473
474/**
475 * fit_get_end - get FIT image size
476 * @fit: pointer to the FIT format image header
477 *
478 * returns:
479 * size of the FIT image (blob) in memory
480 */
481static inline ulong fit_get_size (const void *fit)
482{
483 return fdt_totalsize (fit);
484}
485
486/**
487 * fit_get_end - get FIT image end
488 * @fit: pointer to the FIT format image header
489 *
490 * returns:
491 * end address of the FIT image (blob) in memory
492 */
493static inline ulong fit_get_end (const void *fit)
494{
495 return (ulong)fit + fdt_totalsize (fit);
496}
497
498/**
499 * fit_get_name - get FIT node name
500 * @fit: pointer to the FIT format image header
501 *
502 * returns:
503 * NULL, on error
504 * pointer to node name, on success
505 */
506static inline const char *fit_get_name (const void *fit_hdr,
507 int noffset, int *len)
508{
509 return fdt_get_name (fit_hdr, noffset, len);
510}
511
512int fit_get_desc (const void *fit, int noffset, char **desc);
513int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
514
515int fit_image_get_node (const void *fit, const char *image_uname);
516int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
517int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
518int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
519int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
520int fit_image_get_load (const void *fit, int noffset, ulong *load);
521int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
522int fit_image_get_data (const void *fit, int noffset,
523 const void **data, size_t *size);
524
525int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
526int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
527 int *value_len);
528
529int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
530int fit_set_hashes (void *fit);
531int fit_image_set_hashes (void *fit, int image_noffset);
532int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
533 int value_len);
534
535int fit_image_check_hashes (const void *fit, int noffset);
536int fit_image_check_os (const void *fit, int noffset, uint8_t os);
537int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
538int fit_image_check_type (const void *fit, int noffset, uint8_t type);
539int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
540int fit_check_format (const void *fit);
541
542int fit_conf_get_node (const void *fit, const char *conf_uname);
543int fit_conf_get_kernel_node (const void *fit, int noffset);
544int fit_conf_get_ramdisk_node (const void *fit, int noffset);
545int fit_conf_get_fdt_node (const void *fit, int noffset);
546
547void fit_conf_print (const void *fit, int noffset, const char *p);
548
549#ifndef USE_HOSTCC
550static inline int fit_image_check_target_arch (const void *fdt, int node)
551{
552#if defined(__ARM__)
553 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
554#elif defined(__avr32__)
555 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
556#elif defined(__bfin__)
557 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
558#elif defined(__I386__)
559 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
560#elif defined(__M68K__)
561 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
562#elif defined(__microblaze__)
563 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
564#elif defined(__mips__)
565 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
566#elif defined(__nios__)
567 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
568#elif defined(__nios2__)
569 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
570#elif defined(__PPC__)
571 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
572#elif defined(__sh__)
573 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
574#else
575# error Unknown CPU type
576#endif
577 return 0;
578
579 return 1;
580}
581#endif /* USE_HOSTCC */
582
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100583#ifdef CONFIG_FIT_VERBOSE
584#define fit_unsupported(msg) printf ("! %s:%d " \
585 "FIT images not supported for '%s'\n", \
586 __FILE__, __LINE__, (msg))
587
588#define fit_unsupported_reset(msg) printf ("! %s:%d " \
589 "FIT images not supported for '%s' " \
590 "- must reset board to recover!\n", \
591 __FILE__, __LINE__, (msg))
592#else
593#define fit_unsupported(msg)
594#define fit_unsupported_reset(msg)
595#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100596#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100597
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100598#endif /* __IMAGE_H__ */