blob: 9be806e12d7533033c7bd1f7b3358f8c11b1ed37 [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 */
wdenk5b1d7132002-11-03 00:07:02 +000088
89/*
90 * CPU Architecture Codes (supported by Linux)
91 */
Marian Balakowicz41d71ed2008-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
wdenk391b5742004-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)
wdenk874ac262003-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 */
wdenk7182b0f2003-10-06 21:55:32 +0000158#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock16485a62006-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 Balakowiczd7c88a42008-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
Kumar Galabd70bbe2008-08-15 08:24:41 -0500190typedef struct image_info {
191 ulong start, end; /* start/end of blob */
192 ulong image_start, image_len; /* start of image within blob, len of image */
193 ulong load; /* load addr for the image */
194 uint8_t comp, type, os; /* compression, type of image, os type */
195} image_info_t;
196
Marian Balakowicz20c43722008-01-08 18:11:44 +0100197/*
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100198 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
199 * routines.
200 */
201typedef struct bootm_headers {
202 /*
203 * Legacy os image header, if it is a multi component image
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100204 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100205 * data from second and third component accordingly.
206 */
Marian Balakowiczab00e022008-04-11 11:07:49 +0200207 image_header_t *legacy_hdr_os; /* image header pointer */
208 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100209 ulong legacy_hdr_valid;
210
211#if defined(CONFIG_FIT)
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100212 const char *fit_uname_cfg; /* configuration node unit name */
213
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100214 void *fit_hdr_os; /* os FIT image header */
Marian Balakowicz6a2b2c22008-03-10 17:53:49 +0100215 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100216 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100217
218 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100219 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
220 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100221
222#if defined(CONFIG_PPC)
223 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100224 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
225 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100226#endif
Marian Balakowiczaa6aae42008-03-12 10:35:52 +0100227#endif
228
Kumar Galabd70bbe2008-08-15 08:24:41 -0500229 image_info_t os; /* os image info */
Kumar Gala93467bc2008-08-15 08:24:36 -0500230 ulong ep; /* entry point of OS */
231
Kumar Galafffb1432008-08-15 08:24:37 -0500232 ulong rd_start, rd_end;/* ramdisk start/end */
233
Kumar Galaa5130ad2008-08-15 08:24:38 -0500234#ifdef CONFIG_OF_LIBFDT
235 char *ft_addr; /* flat dev tree address */
236#endif
237 ulong ft_len; /* length of flat device tree */
238
Marian Balakowicz61fde552008-02-27 11:01:04 +0100239 int verify; /* getenv("verify")[0] != 'n' */
Kumar Galabd70bbe2008-08-15 08:24:41 -0500240 int valid; /* set to 1 if we've set values in the header */
Kumar Galada6d11e2008-08-15 08:24:40 -0500241#ifndef USE_HOSTCC
242 struct lmb lmb; /* for memory mgmt */
243#endif
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100244} bootm_headers_t;
245
246/*
Marian Balakowicz20c43722008-01-08 18:11:44 +0100247 * Some systems (for example LWMON) have very short watchdog periods;
248 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200249 * checksum calculations into reasonable chunks.
Marian Balakowicz20c43722008-01-08 18:11:44 +0100250 */
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200251#ifndef CHUNKSZ
Marian Balakowicz20c43722008-01-08 18:11:44 +0100252#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200253#endif
254
255#ifndef CHUNKSZ_CRC32
256#define CHUNKSZ_CRC32 (64 * 1024)
257#endif
258
259#ifndef CHUNKSZ_MD5
260#define CHUNKSZ_MD5 (64 * 1024)
261#endif
262
263#ifndef CHUNKSZ_SHA1
264#define CHUNKSZ_SHA1 (64 * 1024)
265#endif
Marian Balakowicz20c43722008-01-08 18:11:44 +0100266
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100267#define uimage_to_cpu(x) ntohl(x)
268#define cpu_to_uimage(x) htonl(x)
269
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100270const char *genimg_get_os_name (uint8_t os);
271const char *genimg_get_arch_name (uint8_t arch);
272const char *genimg_get_type_name (uint8_t type);
273const char *genimg_get_comp_name (uint8_t comp);
274int genimg_get_os_id (const char *name);
275int genimg_get_arch_id (const char *name);
276int genimg_get_type_id (const char *name);
277int genimg_get_comp_id (const char *name);
278
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100279#ifndef USE_HOSTCC
280/* Image format types, returned by _get_format() routine */
281#define IMAGE_FORMAT_INVALID 0x00
282#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
283#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
284
285int genimg_get_format (void *img_addr);
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100286int genimg_has_config (bootm_headers_t *images);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100287ulong genimg_get_image (ulong img_addr);
288
Marian Balakowicza0ffb422008-03-12 10:14:38 +0100289int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
290 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100291
Kumar Galaa5130ad2008-08-15 08:24:38 -0500292
293#ifdef CONFIG_OF_LIBFDT
294int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
295 char **of_flat_tree, ulong *of_size);
296int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
297 char **of_flat_tree, ulong *of_size);
298#endif
299
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100300#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
301int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
302 ulong *initrd_start, ulong *initrd_end);
303
304int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
305 ulong bootmap_base);
306int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
307#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100308#endif /* !USE_HOSTCC */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100309
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100310/*******************************************************************/
311/* Legacy format specific code (prefixed with image_) */
312/*******************************************************************/
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100313static inline uint32_t image_get_header_size (void)
314{
315 return (sizeof (image_header_t));
316}
317
318#define image_get_hdr_l(f) \
319 static inline uint32_t image_get_##f(image_header_t *hdr) \
320 { \
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100321 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100322 }
323image_get_hdr_l (magic);
324image_get_hdr_l (hcrc);
325image_get_hdr_l (time);
326image_get_hdr_l (size);
327image_get_hdr_l (load);
328image_get_hdr_l (ep);
329image_get_hdr_l (dcrc);
330
331#define image_get_hdr_b(f) \
332 static inline uint8_t image_get_##f(image_header_t *hdr) \
333 { \
334 return hdr->ih_##f; \
335 }
336image_get_hdr_b (os);
337image_get_hdr_b (arch);
338image_get_hdr_b (type);
339image_get_hdr_b (comp);
340
341static inline char *image_get_name (image_header_t *hdr)
342{
343 return (char *)hdr->ih_name;
344}
345
346static inline uint32_t image_get_data_size (image_header_t *hdr)
347{
348 return image_get_size (hdr);
349}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100350
351/**
352 * image_get_data - get image payload start address
353 * @hdr: image header
354 *
355 * image_get_data() returns address of the image payload. For single
356 * component images it is image data start. For multi component
357 * images it points to the null terminated table of sub-images sizes.
358 *
359 * returns:
360 * image payload data start address
361 */
362static inline ulong image_get_data (image_header_t *hdr)
363{
364 return ((ulong)hdr + image_get_header_size ());
365}
366
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100367static inline uint32_t image_get_image_size (image_header_t *hdr)
368{
369 return (image_get_size (hdr) + image_get_header_size ());
370}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100371static inline ulong image_get_image_end (image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100372{
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100373 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100374}
375
376#define image_set_hdr_l(f) \
377 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
378 { \
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100379 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100380 }
381image_set_hdr_l (magic);
382image_set_hdr_l (hcrc);
383image_set_hdr_l (time);
384image_set_hdr_l (size);
385image_set_hdr_l (load);
386image_set_hdr_l (ep);
387image_set_hdr_l (dcrc);
388
389#define image_set_hdr_b(f) \
390 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
391 { \
392 hdr->ih_##f = val; \
393 }
394image_set_hdr_b (os);
395image_set_hdr_b (arch);
396image_set_hdr_b (type);
397image_set_hdr_b (comp);
398
399static inline void image_set_name (image_header_t *hdr, const char *name)
400{
401 strncpy (image_get_name (hdr), name, IH_NMLEN);
402}
403
404int image_check_hcrc (image_header_t *hdr);
405int image_check_dcrc (image_header_t *hdr);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100406#ifndef USE_HOSTCC
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200407int getenv_yesno (char *var);
Kumar Galac5bacfd2008-02-27 21:51:50 -0600408ulong getenv_bootm_low(void);
Becky Bruced26d67c2008-06-09 20:37:18 -0500409phys_size_t getenv_bootm_size(void);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100410void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
411#endif
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100412
413static inline int image_check_magic (image_header_t *hdr)
414{
415 return (image_get_magic (hdr) == IH_MAGIC);
416}
417static inline int image_check_type (image_header_t *hdr, uint8_t type)
418{
419 return (image_get_type (hdr) == type);
420}
421static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
422{
423 return (image_get_arch (hdr) == arch);
424}
425static inline int image_check_os (image_header_t *hdr, uint8_t os)
426{
427 return (image_get_os (hdr) == os);
428}
429
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100430ulong image_multi_count (image_header_t *hdr);
431void image_multi_getimg (image_header_t *hdr, ulong idx,
432 ulong *data, ulong *len);
433
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200434void image_print_contents (image_header_t *hdr);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100435
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100436#ifndef USE_HOSTCC
437static inline int image_check_target_arch (image_header_t *hdr)
438{
439#if defined(__ARM__)
440 if (!image_check_arch (hdr, IH_ARCH_ARM))
441#elif defined(__avr32__)
442 if (!image_check_arch (hdr, IH_ARCH_AVR32))
443#elif defined(__bfin__)
444 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
445#elif defined(__I386__)
446 if (!image_check_arch (hdr, IH_ARCH_I386))
447#elif defined(__M68K__)
448 if (!image_check_arch (hdr, IH_ARCH_M68K))
449#elif defined(__microblaze__)
450 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
451#elif defined(__mips__)
452 if (!image_check_arch (hdr, IH_ARCH_MIPS))
453#elif defined(__nios__)
454 if (!image_check_arch (hdr, IH_ARCH_NIOS))
455#elif defined(__nios2__)
456 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
457#elif defined(__PPC__)
458 if (!image_check_arch (hdr, IH_ARCH_PPC))
459#elif defined(__sh__)
460 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombb9c8292008-03-28 08:29:26 +0100461#elif defined(__sparc__)
462 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100463#else
464# error Unknown CPU type
465#endif
466 return 0;
467
468 return 1;
469}
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100470#endif /* USE_HOSTCC */
wdenk5b1d7132002-11-03 00:07:02 +0000471
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100472/*******************************************************************/
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100473/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100474/*******************************************************************/
Marian Balakowicz3413e222008-02-21 17:20:20 +0100475#if defined(CONFIG_FIT)
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100476
477#define FIT_IMAGES_PATH "/images"
478#define FIT_CONFS_PATH "/configurations"
479
480/* hash node */
481#define FIT_HASH_NODENAME "hash"
482#define FIT_ALGO_PROP "algo"
483#define FIT_VALUE_PROP "value"
484
485/* image node */
486#define FIT_DATA_PROP "data"
487#define FIT_TIMESTAMP_PROP "timestamp"
488#define FIT_DESC_PROP "description"
489#define FIT_ARCH_PROP "arch"
490#define FIT_TYPE_PROP "type"
491#define FIT_OS_PROP "os"
492#define FIT_COMP_PROP "compression"
493#define FIT_ENTRY_PROP "entry"
494#define FIT_LOAD_PROP "load"
495
496/* configuration node */
497#define FIT_KERNEL_PROP "kernel"
498#define FIT_RAMDISK_PROP "ramdisk"
499#define FIT_FDT_PROP "fdt"
500#define FIT_DEFAULT_PROP "default"
501
502#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
503
504/* cmdline argument format parsing */
Marian Balakowicz3413e222008-02-21 17:20:20 +0100505inline int fit_parse_conf (const char *spec, ulong addr_curr,
506 ulong *addr, const char **conf_name);
507inline int fit_parse_subimage (const char *spec, ulong addr_curr,
508 ulong *addr, const char **image_name);
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100509
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200510void fit_print_contents (const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100511void fit_image_print (const void *fit, int noffset, const char *p);
512void fit_image_print_hash (const void *fit, int noffset, const char *p);
513
514/**
515 * fit_get_end - get FIT image size
516 * @fit: pointer to the FIT format image header
517 *
518 * returns:
519 * size of the FIT image (blob) in memory
520 */
521static inline ulong fit_get_size (const void *fit)
522{
523 return fdt_totalsize (fit);
524}
525
526/**
527 * fit_get_end - get FIT image end
528 * @fit: pointer to the FIT format image header
529 *
530 * returns:
531 * end address of the FIT image (blob) in memory
532 */
533static inline ulong fit_get_end (const void *fit)
534{
535 return (ulong)fit + fdt_totalsize (fit);
536}
537
538/**
539 * fit_get_name - get FIT node name
540 * @fit: pointer to the FIT format image header
541 *
542 * returns:
543 * NULL, on error
544 * pointer to node name, on success
545 */
546static inline const char *fit_get_name (const void *fit_hdr,
547 int noffset, int *len)
548{
549 return fdt_get_name (fit_hdr, noffset, len);
550}
551
552int fit_get_desc (const void *fit, int noffset, char **desc);
553int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
554
555int fit_image_get_node (const void *fit, const char *image_uname);
556int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
557int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
558int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
559int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
560int fit_image_get_load (const void *fit, int noffset, ulong *load);
561int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
562int fit_image_get_data (const void *fit, int noffset,
563 const void **data, size_t *size);
564
565int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
566int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
567 int *value_len);
568
569int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
570int fit_set_hashes (void *fit);
571int fit_image_set_hashes (void *fit, int image_noffset);
572int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
573 int value_len);
574
575int fit_image_check_hashes (const void *fit, int noffset);
576int fit_image_check_os (const void *fit, int noffset, uint8_t os);
577int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
578int fit_image_check_type (const void *fit, int noffset, uint8_t type);
579int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
580int fit_check_format (const void *fit);
581
582int fit_conf_get_node (const void *fit, const char *conf_uname);
583int fit_conf_get_kernel_node (const void *fit, int noffset);
584int fit_conf_get_ramdisk_node (const void *fit, int noffset);
585int fit_conf_get_fdt_node (const void *fit, int noffset);
586
587void fit_conf_print (const void *fit, int noffset, const char *p);
588
589#ifndef USE_HOSTCC
590static inline int fit_image_check_target_arch (const void *fdt, int node)
591{
592#if defined(__ARM__)
593 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
594#elif defined(__avr32__)
595 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
596#elif defined(__bfin__)
597 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
598#elif defined(__I386__)
599 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
600#elif defined(__M68K__)
601 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
602#elif defined(__microblaze__)
603 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
604#elif defined(__mips__)
605 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
606#elif defined(__nios__)
607 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
608#elif defined(__nios2__)
609 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
610#elif defined(__PPC__)
611 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
612#elif defined(__sh__)
613 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombb9c8292008-03-28 08:29:26 +0100614#elif defined(__sparc__)
615 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100616#else
617# error Unknown CPU type
618#endif
619 return 0;
620
621 return 1;
622}
623#endif /* USE_HOSTCC */
624
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100625#ifdef CONFIG_FIT_VERBOSE
626#define fit_unsupported(msg) printf ("! %s:%d " \
627 "FIT images not supported for '%s'\n", \
628 __FILE__, __LINE__, (msg))
629
630#define fit_unsupported_reset(msg) printf ("! %s:%d " \
631 "FIT images not supported for '%s' " \
632 "- must reset board to recover!\n", \
633 __FILE__, __LINE__, (msg))
634#else
635#define fit_unsupported(msg)
636#define fit_unsupported_reset(msg)
637#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowicz3413e222008-02-21 17:20:20 +0100638#endif /* CONFIG_FIT */
Marian Balakowicz95418502008-01-31 13:55:39 +0100639
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100640#endif /* __IMAGE_H__ */