blob: 82e63457f9171a9634060944c1e84c979afb0864 [file] [log] [blame]
wdenk5b1d7132002-11-03 00:07:02 +00001/*
Marian Balakowicz41d71ed2008-01-08 18:14:09 +01002 * (C) Copyright 2008 Semihalf
3 *
Wolfgang Denkf3f45182005-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 Denkf3f45182005-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 Balakowicz41d71ed2008-01-08 18:14:09 +010036#include <asm/byteorder.h>
Marian Balakowicz95418502008-01-31 13:55:39 +010037#include <command.h>
Marian Balakowiczf4891a12008-02-21 17:20:18 +010038
Marian Balakowicz41d71ed2008-01-08 18:14:09 +010039#ifndef USE_HOSTCC
Kumar Gala6d7bfa82008-02-27 21:51:47 -060040#include <lmb.h>
Marian Balakowicz41d71ed2008-01-08 18:14:09 +010041#include <linux/string.h>
Marian Balakowicz9c701e82008-01-31 13:57:17 +010042#include <asm/u-boot.h>
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010043
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010044#else
Marian Balakowiczf4891a12008-02-21 17:20:18 +010045
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010046/* new uImage format support enabled on host */
Marian Balakowiczf4891a12008-02-21 17:20:18 +010047#define CONFIG_FIT 1
48#define CONFIG_OF_LIBFDT 1
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010049#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
Marian Balakowiczf4891a12008-02-21 17:20:18 +010050
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010051#endif /* USE_HOSTCC */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +010052
Marian Balakowiczf4891a12008-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 Balakowicz41d71ed2008-01-08 18:14:09 +010055#endif
Marian Balakowicze227fbb2008-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 Sieka2e6f2852008-03-14 16:22:34 +010061#define CONFIG_MD5 /* FIT images need MD5 support */
Marian Balakowicze227fbb2008-02-29 21:24:06 +010062#endif
Marian Balakowicz41d71ed2008-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 */
wdenk92bbe3f2003-04-20 14:04:18 +000085#define IH_OS_RTEMS 18 /* RTEMS */
wdenk0893c472003-05-20 14:25:27 +000086#define IH_OS_ARTOS 19 /* ARTOS */
wdenk874ac262003-07-24 23:38:38 +000087#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyser56b8dd12008-09-08 14:56:49 -050088#define IH_OS_INTEGRITY 21 /* INTEGRITY */
wdenk5b1d7132002-11-03 00:07:02 +000089
90/*
91 * CPU Architecture Codes (supported by Linux)
92 */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +010093#define IH_ARCH_INVALID 0 /* Invalid CPU */
94#define IH_ARCH_ALPHA 1 /* Alpha */
95#define IH_ARCH_ARM 2 /* ARM */
96#define IH_ARCH_I386 3 /* Intel x86 */
97#define IH_ARCH_IA64 4 /* IA64 */
98#define IH_ARCH_MIPS 5 /* MIPS */
99#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
100#define IH_ARCH_PPC 7 /* PowerPC */
101#define IH_ARCH_S390 8 /* IBM S390 */
102#define IH_ARCH_SH 9 /* SuperH */
103#define IH_ARCH_SPARC 10 /* Sparc */
104#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
105#define IH_ARCH_M68K 12 /* M68K */
106#define IH_ARCH_NIOS 13 /* Nios-32 */
107#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
108#define IH_ARCH_NIOS2 15 /* Nios-II */
109#define IH_ARCH_BLACKFIN 16 /* Blackfin */
110#define IH_ARCH_AVR32 17 /* AVR32 */
111#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
wdenk5b1d7132002-11-03 00:07:02 +0000112
113/*
114 * Image Types
115 *
116 * "Standalone Programs" are directly runnable in the environment
117 * provided by U-Boot; it is expected that (if they behave
118 * well) you can continue to work in U-Boot after return from
119 * the Standalone Program.
120 * "OS Kernel Images" are usually images of some Embedded OS which
121 * will take over control completely. Usually these programs
122 * will install their own set of exception handlers, device
123 * drivers, set up the MMU, etc. - this means, that you cannot
124 * expect to re-enter U-Boot except by resetting the CPU.
125 * "RAMDisk Images" are more or less just data blocks, and their
126 * parameters (address, size) are passed to an OS kernel that is
127 * being started.
128 * "Multi-File Images" contain several images, typically an OS
129 * (Linux) kernel image and one or more data images like
130 * RAMDisks. This construct is useful for instance when you want
131 * to boot over the network using BOOTP etc., where the boot
132 * server provides just a single image file, but you want to get
133 * for instance an OS kernel and a RAMDisk image.
134 *
135 * "Multi-File Images" start with a list of image sizes, each
136 * image size (in bytes) specified by an "uint32_t" in network
137 * byte order. This list is terminated by an "(uint32_t)0".
138 * Immediately after the terminating 0 follow the images, one by
139 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenk391b5742004-10-10 23:27:33 +0000140 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000141 *
142 * "Firmware Images" are binary images containing firmware (like
143 * U-Boot or FPGA images) which usually will be programmed to
144 * flash memory.
145 *
146 * "Script files" are command sequences that will be executed by
147 * U-Boot's command interpreter; this feature is especially
148 * useful when you configure U-Boot to use a real shell (hush)
wdenk874ac262003-07-24 23:38:38 +0000149 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000150 */
151
152#define IH_TYPE_INVALID 0 /* Invalid Image */
153#define IH_TYPE_STANDALONE 1 /* Standalone Program */
154#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
155#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
156#define IH_TYPE_MULTI 4 /* Multi-File Image */
157#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
158#define IH_TYPE_SCRIPT 6 /* Script file */
wdenk7182b0f2003-10-06 21:55:32 +0000159#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock16485a62006-08-16 10:54:09 -0500160#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
wdenk5b1d7132002-11-03 00:07:02 +0000161
162/*
163 * Compression Types
164 */
165#define IH_COMP_NONE 0 /* No Compression Used */
166#define IH_COMP_GZIP 1 /* gzip Compression Used */
167#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +0200168#define IH_COMP_LZMA 3 /* lzma Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000169
170#define IH_MAGIC 0x27051956 /* Image Magic Number */
171#define IH_NMLEN 32 /* Image Name Length */
172
wdenk5b1d7132002-11-03 00:07:02 +0000173/*
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100174 * Legacy format image header,
175 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000176 */
wdenk5b1d7132002-11-03 00:07:02 +0000177typedef struct image_header {
178 uint32_t ih_magic; /* Image Header Magic Number */
179 uint32_t ih_hcrc; /* Image Header CRC Checksum */
180 uint32_t ih_time; /* Image Creation Timestamp */
181 uint32_t ih_size; /* Image Data Size */
182 uint32_t ih_load; /* Data Load Address */
183 uint32_t ih_ep; /* Entry Point Address */
184 uint32_t ih_dcrc; /* Image Data CRC Checksum */
185 uint8_t ih_os; /* Operating System */
186 uint8_t ih_arch; /* CPU architecture */
187 uint8_t ih_type; /* Image Type */
188 uint8_t ih_comp; /* Compression Type */
189 uint8_t ih_name[IH_NMLEN]; /* Image Name */
190} image_header_t;
191
Kumar Galabd70bbe2008-08-15 08:24:41 -0500192typedef struct image_info {
193 ulong start, end; /* start/end of blob */
194 ulong image_start, image_len; /* start of image within blob, len of image */
195 ulong load; /* load addr for the image */
196 uint8_t comp, type, os; /* compression, type of image, os type */
197} image_info_t;
198
Marian Balakowicz20c43722008-01-08 18:11:44 +0100199/*
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100200 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
201 * routines.
202 */
203typedef struct bootm_headers {
204 /*
205 * Legacy os image header, if it is a multi component image
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100206 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100207 * data from second and third component accordingly.
208 */
Marian Balakowiczab00e022008-04-11 11:07:49 +0200209 image_header_t *legacy_hdr_os; /* image header pointer */
210 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100211 ulong legacy_hdr_valid;
212
213#if defined(CONFIG_FIT)
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100214 const char *fit_uname_cfg; /* configuration node unit name */
215
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100216 void *fit_hdr_os; /* os FIT image header */
Marian Balakowicz6a2b2c22008-03-10 17:53:49 +0100217 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100218 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100219
220 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100221 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
222 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100223
224#if defined(CONFIG_PPC)
225 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100226 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
227 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100228#endif
Marian Balakowiczaa6aae42008-03-12 10:35:52 +0100229#endif
230
Kumar Galabd70bbe2008-08-15 08:24:41 -0500231 image_info_t os; /* os image info */
Kumar Gala93467bc2008-08-15 08:24:36 -0500232 ulong ep; /* entry point of OS */
233
Kumar Galafffb1432008-08-15 08:24:37 -0500234 ulong rd_start, rd_end;/* ramdisk start/end */
235
Kumar Galaa5130ad2008-08-15 08:24:38 -0500236#ifdef CONFIG_OF_LIBFDT
237 char *ft_addr; /* flat dev tree address */
238#endif
239 ulong ft_len; /* length of flat device tree */
240
Marian Balakowicz61fde552008-02-27 11:01:04 +0100241 int verify; /* getenv("verify")[0] != 'n' */
Kumar Galabd70bbe2008-08-15 08:24:41 -0500242 int valid; /* set to 1 if we've set values in the header */
Kumar Galada6d11e2008-08-15 08:24:40 -0500243#ifndef USE_HOSTCC
244 struct lmb lmb; /* for memory mgmt */
245#endif
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100246} bootm_headers_t;
247
248/*
Marian Balakowicz20c43722008-01-08 18:11:44 +0100249 * Some systems (for example LWMON) have very short watchdog periods;
250 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200251 * checksum calculations into reasonable chunks.
Marian Balakowicz20c43722008-01-08 18:11:44 +0100252 */
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200253#ifndef CHUNKSZ
Marian Balakowicz20c43722008-01-08 18:11:44 +0100254#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200255#endif
256
257#ifndef CHUNKSZ_CRC32
258#define CHUNKSZ_CRC32 (64 * 1024)
259#endif
260
261#ifndef CHUNKSZ_MD5
262#define CHUNKSZ_MD5 (64 * 1024)
263#endif
264
265#ifndef CHUNKSZ_SHA1
266#define CHUNKSZ_SHA1 (64 * 1024)
267#endif
Marian Balakowicz20c43722008-01-08 18:11:44 +0100268
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100269#define uimage_to_cpu(x) ntohl(x)
270#define cpu_to_uimage(x) htonl(x)
271
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100272const char *genimg_get_os_name (uint8_t os);
273const char *genimg_get_arch_name (uint8_t arch);
274const char *genimg_get_type_name (uint8_t type);
275const char *genimg_get_comp_name (uint8_t comp);
276int genimg_get_os_id (const char *name);
277int genimg_get_arch_id (const char *name);
278int genimg_get_type_id (const char *name);
279int genimg_get_comp_id (const char *name);
280
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100281#ifndef USE_HOSTCC
282/* Image format types, returned by _get_format() routine */
283#define IMAGE_FORMAT_INVALID 0x00
284#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
285#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
286
287int genimg_get_format (void *img_addr);
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100288int genimg_has_config (bootm_headers_t *images);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100289ulong genimg_get_image (ulong img_addr);
290
Marian Balakowicza0ffb422008-03-12 10:14:38 +0100291int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
292 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100293
Kumar Galaa5130ad2008-08-15 08:24:38 -0500294
295#ifdef CONFIG_OF_LIBFDT
296int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
297 char **of_flat_tree, ulong *of_size);
298int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
299 char **of_flat_tree, ulong *of_size);
300#endif
301
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100302#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
303int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
304 ulong *initrd_start, ulong *initrd_end);
305
306int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
307 ulong bootmap_base);
308int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
309#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100310#endif /* !USE_HOSTCC */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100311
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100312/*******************************************************************/
313/* Legacy format specific code (prefixed with image_) */
314/*******************************************************************/
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100315static inline uint32_t image_get_header_size (void)
316{
317 return (sizeof (image_header_t));
318}
319
320#define image_get_hdr_l(f) \
321 static inline uint32_t image_get_##f(image_header_t *hdr) \
322 { \
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100323 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100324 }
325image_get_hdr_l (magic);
326image_get_hdr_l (hcrc);
327image_get_hdr_l (time);
328image_get_hdr_l (size);
329image_get_hdr_l (load);
330image_get_hdr_l (ep);
331image_get_hdr_l (dcrc);
332
333#define image_get_hdr_b(f) \
334 static inline uint8_t image_get_##f(image_header_t *hdr) \
335 { \
336 return hdr->ih_##f; \
337 }
338image_get_hdr_b (os);
339image_get_hdr_b (arch);
340image_get_hdr_b (type);
341image_get_hdr_b (comp);
342
343static inline char *image_get_name (image_header_t *hdr)
344{
345 return (char *)hdr->ih_name;
346}
347
348static inline uint32_t image_get_data_size (image_header_t *hdr)
349{
350 return image_get_size (hdr);
351}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100352
353/**
354 * image_get_data - get image payload start address
355 * @hdr: image header
356 *
357 * image_get_data() returns address of the image payload. For single
358 * component images it is image data start. For multi component
359 * images it points to the null terminated table of sub-images sizes.
360 *
361 * returns:
362 * image payload data start address
363 */
364static inline ulong image_get_data (image_header_t *hdr)
365{
366 return ((ulong)hdr + image_get_header_size ());
367}
368
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100369static inline uint32_t image_get_image_size (image_header_t *hdr)
370{
371 return (image_get_size (hdr) + image_get_header_size ());
372}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100373static inline ulong image_get_image_end (image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100374{
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100375 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100376}
377
378#define image_set_hdr_l(f) \
379 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
380 { \
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100381 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100382 }
383image_set_hdr_l (magic);
384image_set_hdr_l (hcrc);
385image_set_hdr_l (time);
386image_set_hdr_l (size);
387image_set_hdr_l (load);
388image_set_hdr_l (ep);
389image_set_hdr_l (dcrc);
390
391#define image_set_hdr_b(f) \
392 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
393 { \
394 hdr->ih_##f = val; \
395 }
396image_set_hdr_b (os);
397image_set_hdr_b (arch);
398image_set_hdr_b (type);
399image_set_hdr_b (comp);
400
401static inline void image_set_name (image_header_t *hdr, const char *name)
402{
403 strncpy (image_get_name (hdr), name, IH_NMLEN);
404}
405
406int image_check_hcrc (image_header_t *hdr);
407int image_check_dcrc (image_header_t *hdr);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100408#ifndef USE_HOSTCC
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200409int getenv_yesno (char *var);
Kumar Galac5bacfd2008-02-27 21:51:50 -0600410ulong getenv_bootm_low(void);
Becky Bruced26d67c2008-06-09 20:37:18 -0500411phys_size_t getenv_bootm_size(void);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100412void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
413#endif
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100414
415static inline int image_check_magic (image_header_t *hdr)
416{
417 return (image_get_magic (hdr) == IH_MAGIC);
418}
419static inline int image_check_type (image_header_t *hdr, uint8_t type)
420{
421 return (image_get_type (hdr) == type);
422}
423static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
424{
425 return (image_get_arch (hdr) == arch);
426}
427static inline int image_check_os (image_header_t *hdr, uint8_t os)
428{
429 return (image_get_os (hdr) == os);
430}
431
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100432ulong image_multi_count (image_header_t *hdr);
433void image_multi_getimg (image_header_t *hdr, ulong idx,
434 ulong *data, ulong *len);
435
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200436void image_print_contents (image_header_t *hdr);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100437
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100438#ifndef USE_HOSTCC
439static inline int image_check_target_arch (image_header_t *hdr)
440{
441#if defined(__ARM__)
442 if (!image_check_arch (hdr, IH_ARCH_ARM))
443#elif defined(__avr32__)
444 if (!image_check_arch (hdr, IH_ARCH_AVR32))
445#elif defined(__bfin__)
446 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
447#elif defined(__I386__)
448 if (!image_check_arch (hdr, IH_ARCH_I386))
449#elif defined(__M68K__)
450 if (!image_check_arch (hdr, IH_ARCH_M68K))
451#elif defined(__microblaze__)
452 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
453#elif defined(__mips__)
454 if (!image_check_arch (hdr, IH_ARCH_MIPS))
455#elif defined(__nios__)
456 if (!image_check_arch (hdr, IH_ARCH_NIOS))
457#elif defined(__nios2__)
458 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
459#elif defined(__PPC__)
460 if (!image_check_arch (hdr, IH_ARCH_PPC))
461#elif defined(__sh__)
462 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombb9c8292008-03-28 08:29:26 +0100463#elif defined(__sparc__)
464 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100465#else
466# error Unknown CPU type
467#endif
468 return 0;
469
470 return 1;
471}
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100472#endif /* USE_HOSTCC */
wdenk5b1d7132002-11-03 00:07:02 +0000473
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100474/*******************************************************************/
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100475/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100476/*******************************************************************/
Marian Balakowicz3413e222008-02-21 17:20:20 +0100477#if defined(CONFIG_FIT)
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100478
479#define FIT_IMAGES_PATH "/images"
480#define FIT_CONFS_PATH "/configurations"
481
482/* hash node */
483#define FIT_HASH_NODENAME "hash"
484#define FIT_ALGO_PROP "algo"
485#define FIT_VALUE_PROP "value"
486
487/* image node */
488#define FIT_DATA_PROP "data"
489#define FIT_TIMESTAMP_PROP "timestamp"
490#define FIT_DESC_PROP "description"
491#define FIT_ARCH_PROP "arch"
492#define FIT_TYPE_PROP "type"
493#define FIT_OS_PROP "os"
494#define FIT_COMP_PROP "compression"
495#define FIT_ENTRY_PROP "entry"
496#define FIT_LOAD_PROP "load"
497
498/* configuration node */
499#define FIT_KERNEL_PROP "kernel"
500#define FIT_RAMDISK_PROP "ramdisk"
501#define FIT_FDT_PROP "fdt"
502#define FIT_DEFAULT_PROP "default"
503
504#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
505
506/* cmdline argument format parsing */
Marian Balakowicz3413e222008-02-21 17:20:20 +0100507inline int fit_parse_conf (const char *spec, ulong addr_curr,
508 ulong *addr, const char **conf_name);
509inline int fit_parse_subimage (const char *spec, ulong addr_curr,
510 ulong *addr, const char **image_name);
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100511
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200512void fit_print_contents (const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100513void fit_image_print (const void *fit, int noffset, const char *p);
514void fit_image_print_hash (const void *fit, int noffset, const char *p);
515
516/**
517 * fit_get_end - get FIT image size
518 * @fit: pointer to the FIT format image header
519 *
520 * returns:
521 * size of the FIT image (blob) in memory
522 */
523static inline ulong fit_get_size (const void *fit)
524{
525 return fdt_totalsize (fit);
526}
527
528/**
529 * fit_get_end - get FIT image end
530 * @fit: pointer to the FIT format image header
531 *
532 * returns:
533 * end address of the FIT image (blob) in memory
534 */
535static inline ulong fit_get_end (const void *fit)
536{
537 return (ulong)fit + fdt_totalsize (fit);
538}
539
540/**
541 * fit_get_name - get FIT node name
542 * @fit: pointer to the FIT format image header
543 *
544 * returns:
545 * NULL, on error
546 * pointer to node name, on success
547 */
548static inline const char *fit_get_name (const void *fit_hdr,
549 int noffset, int *len)
550{
551 return fdt_get_name (fit_hdr, noffset, len);
552}
553
554int fit_get_desc (const void *fit, int noffset, char **desc);
555int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
556
557int fit_image_get_node (const void *fit, const char *image_uname);
558int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
559int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
560int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
561int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
562int fit_image_get_load (const void *fit, int noffset, ulong *load);
563int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
564int fit_image_get_data (const void *fit, int noffset,
565 const void **data, size_t *size);
566
567int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
568int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
569 int *value_len);
570
571int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
572int fit_set_hashes (void *fit);
573int fit_image_set_hashes (void *fit, int image_noffset);
574int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
575 int value_len);
576
577int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka1557a542008-09-09 12:58:15 +0200578int fit_all_image_check_hashes (const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100579int fit_image_check_os (const void *fit, int noffset, uint8_t os);
580int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
581int fit_image_check_type (const void *fit, int noffset, uint8_t type);
582int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
583int fit_check_format (const void *fit);
584
585int fit_conf_get_node (const void *fit, const char *conf_uname);
586int fit_conf_get_kernel_node (const void *fit, int noffset);
587int fit_conf_get_ramdisk_node (const void *fit, int noffset);
588int fit_conf_get_fdt_node (const void *fit, int noffset);
589
590void fit_conf_print (const void *fit, int noffset, const char *p);
591
592#ifndef USE_HOSTCC
593static inline int fit_image_check_target_arch (const void *fdt, int node)
594{
595#if defined(__ARM__)
596 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
597#elif defined(__avr32__)
598 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
599#elif defined(__bfin__)
600 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
601#elif defined(__I386__)
602 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
603#elif defined(__M68K__)
604 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
605#elif defined(__microblaze__)
606 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
607#elif defined(__mips__)
608 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
609#elif defined(__nios__)
610 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
611#elif defined(__nios2__)
612 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
613#elif defined(__PPC__)
614 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
615#elif defined(__sh__)
616 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombb9c8292008-03-28 08:29:26 +0100617#elif defined(__sparc__)
618 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100619#else
620# error Unknown CPU type
621#endif
622 return 0;
623
624 return 1;
625}
626#endif /* USE_HOSTCC */
627
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100628#ifdef CONFIG_FIT_VERBOSE
629#define fit_unsupported(msg) printf ("! %s:%d " \
630 "FIT images not supported for '%s'\n", \
631 __FILE__, __LINE__, (msg))
632
633#define fit_unsupported_reset(msg) printf ("! %s:%d " \
634 "FIT images not supported for '%s' " \
635 "- must reset board to recover!\n", \
636 __FILE__, __LINE__, (msg))
637#else
638#define fit_unsupported(msg)
639#define fit_unsupported_reset(msg)
640#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowicz3413e222008-02-21 17:20:20 +0100641#endif /* CONFIG_FIT */
Marian Balakowicz95418502008-01-31 13:55:39 +0100642
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100643#endif /* __IMAGE_H__ */