blob: 8c63686d4de1768f5c5e766f043ef67fe54df611 [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 */
168
169#define IH_MAGIC 0x27051956 /* Image Magic Number */
170#define IH_NMLEN 32 /* Image Name Length */
171
wdenk5b1d7132002-11-03 00:07:02 +0000172/*
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100173 * Legacy format image header,
174 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000175 */
wdenk5b1d7132002-11-03 00:07:02 +0000176typedef struct image_header {
177 uint32_t ih_magic; /* Image Header Magic Number */
178 uint32_t ih_hcrc; /* Image Header CRC Checksum */
179 uint32_t ih_time; /* Image Creation Timestamp */
180 uint32_t ih_size; /* Image Data Size */
181 uint32_t ih_load; /* Data Load Address */
182 uint32_t ih_ep; /* Entry Point Address */
183 uint32_t ih_dcrc; /* Image Data CRC Checksum */
184 uint8_t ih_os; /* Operating System */
185 uint8_t ih_arch; /* CPU architecture */
186 uint8_t ih_type; /* Image Type */
187 uint8_t ih_comp; /* Compression Type */
188 uint8_t ih_name[IH_NMLEN]; /* Image Name */
189} image_header_t;
190
Kumar Galabd70bbe2008-08-15 08:24:41 -0500191typedef struct image_info {
192 ulong start, end; /* start/end of blob */
193 ulong image_start, image_len; /* start of image within blob, len of image */
194 ulong load; /* load addr for the image */
195 uint8_t comp, type, os; /* compression, type of image, os type */
196} image_info_t;
197
Marian Balakowicz20c43722008-01-08 18:11:44 +0100198/*
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100199 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
200 * routines.
201 */
202typedef struct bootm_headers {
203 /*
204 * Legacy os image header, if it is a multi component image
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100205 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100206 * data from second and third component accordingly.
207 */
Marian Balakowiczab00e022008-04-11 11:07:49 +0200208 image_header_t *legacy_hdr_os; /* image header pointer */
209 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100210 ulong legacy_hdr_valid;
211
212#if defined(CONFIG_FIT)
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100213 const char *fit_uname_cfg; /* configuration node unit name */
214
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100215 void *fit_hdr_os; /* os FIT image header */
Marian Balakowicz6a2b2c22008-03-10 17:53:49 +0100216 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100217 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100218
219 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100220 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
221 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100222
223#if defined(CONFIG_PPC)
224 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100225 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
226 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100227#endif
Marian Balakowiczaa6aae42008-03-12 10:35:52 +0100228#endif
229
Kumar Galabd70bbe2008-08-15 08:24:41 -0500230 image_info_t os; /* os image info */
Kumar Gala93467bc2008-08-15 08:24:36 -0500231 ulong ep; /* entry point of OS */
232
Kumar Galafffb1432008-08-15 08:24:37 -0500233 ulong rd_start, rd_end;/* ramdisk start/end */
234
Kumar Galaa5130ad2008-08-15 08:24:38 -0500235#ifdef CONFIG_OF_LIBFDT
236 char *ft_addr; /* flat dev tree address */
237#endif
238 ulong ft_len; /* length of flat device tree */
239
Marian Balakowicz61fde552008-02-27 11:01:04 +0100240 int verify; /* getenv("verify")[0] != 'n' */
Kumar Galabd70bbe2008-08-15 08:24:41 -0500241 int valid; /* set to 1 if we've set values in the header */
Kumar Galada6d11e2008-08-15 08:24:40 -0500242#ifndef USE_HOSTCC
243 struct lmb lmb; /* for memory mgmt */
244#endif
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100245} bootm_headers_t;
246
247/*
Marian Balakowicz20c43722008-01-08 18:11:44 +0100248 * Some systems (for example LWMON) have very short watchdog periods;
249 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200250 * checksum calculations into reasonable chunks.
Marian Balakowicz20c43722008-01-08 18:11:44 +0100251 */
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200252#ifndef CHUNKSZ
Marian Balakowicz20c43722008-01-08 18:11:44 +0100253#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200254#endif
255
256#ifndef CHUNKSZ_CRC32
257#define CHUNKSZ_CRC32 (64 * 1024)
258#endif
259
260#ifndef CHUNKSZ_MD5
261#define CHUNKSZ_MD5 (64 * 1024)
262#endif
263
264#ifndef CHUNKSZ_SHA1
265#define CHUNKSZ_SHA1 (64 * 1024)
266#endif
Marian Balakowicz20c43722008-01-08 18:11:44 +0100267
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100268#define uimage_to_cpu(x) ntohl(x)
269#define cpu_to_uimage(x) htonl(x)
270
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100271const char *genimg_get_os_name (uint8_t os);
272const char *genimg_get_arch_name (uint8_t arch);
273const char *genimg_get_type_name (uint8_t type);
274const char *genimg_get_comp_name (uint8_t comp);
275int genimg_get_os_id (const char *name);
276int genimg_get_arch_id (const char *name);
277int genimg_get_type_id (const char *name);
278int genimg_get_comp_id (const char *name);
279
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100280#ifndef USE_HOSTCC
281/* Image format types, returned by _get_format() routine */
282#define IMAGE_FORMAT_INVALID 0x00
283#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
284#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
285
286int genimg_get_format (void *img_addr);
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100287int genimg_has_config (bootm_headers_t *images);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100288ulong genimg_get_image (ulong img_addr);
289
Marian Balakowicza0ffb422008-03-12 10:14:38 +0100290int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
291 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100292
Kumar Galaa5130ad2008-08-15 08:24:38 -0500293
294#ifdef CONFIG_OF_LIBFDT
295int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
296 char **of_flat_tree, ulong *of_size);
297int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
298 char **of_flat_tree, ulong *of_size);
299#endif
300
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100301#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
302int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
303 ulong *initrd_start, ulong *initrd_end);
304
305int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
306 ulong bootmap_base);
307int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
308#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100309#endif /* !USE_HOSTCC */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100310
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100311/*******************************************************************/
312/* Legacy format specific code (prefixed with image_) */
313/*******************************************************************/
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100314static inline uint32_t image_get_header_size (void)
315{
316 return (sizeof (image_header_t));
317}
318
319#define image_get_hdr_l(f) \
320 static inline uint32_t image_get_##f(image_header_t *hdr) \
321 { \
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100322 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100323 }
324image_get_hdr_l (magic);
325image_get_hdr_l (hcrc);
326image_get_hdr_l (time);
327image_get_hdr_l (size);
328image_get_hdr_l (load);
329image_get_hdr_l (ep);
330image_get_hdr_l (dcrc);
331
332#define image_get_hdr_b(f) \
333 static inline uint8_t image_get_##f(image_header_t *hdr) \
334 { \
335 return hdr->ih_##f; \
336 }
337image_get_hdr_b (os);
338image_get_hdr_b (arch);
339image_get_hdr_b (type);
340image_get_hdr_b (comp);
341
342static inline char *image_get_name (image_header_t *hdr)
343{
344 return (char *)hdr->ih_name;
345}
346
347static inline uint32_t image_get_data_size (image_header_t *hdr)
348{
349 return image_get_size (hdr);
350}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100351
352/**
353 * image_get_data - get image payload start address
354 * @hdr: image header
355 *
356 * image_get_data() returns address of the image payload. For single
357 * component images it is image data start. For multi component
358 * images it points to the null terminated table of sub-images sizes.
359 *
360 * returns:
361 * image payload data start address
362 */
363static inline ulong image_get_data (image_header_t *hdr)
364{
365 return ((ulong)hdr + image_get_header_size ());
366}
367
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100368static inline uint32_t image_get_image_size (image_header_t *hdr)
369{
370 return (image_get_size (hdr) + image_get_header_size ());
371}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100372static inline ulong image_get_image_end (image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100373{
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100374 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100375}
376
377#define image_set_hdr_l(f) \
378 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
379 { \
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100380 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100381 }
382image_set_hdr_l (magic);
383image_set_hdr_l (hcrc);
384image_set_hdr_l (time);
385image_set_hdr_l (size);
386image_set_hdr_l (load);
387image_set_hdr_l (ep);
388image_set_hdr_l (dcrc);
389
390#define image_set_hdr_b(f) \
391 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
392 { \
393 hdr->ih_##f = val; \
394 }
395image_set_hdr_b (os);
396image_set_hdr_b (arch);
397image_set_hdr_b (type);
398image_set_hdr_b (comp);
399
400static inline void image_set_name (image_header_t *hdr, const char *name)
401{
402 strncpy (image_get_name (hdr), name, IH_NMLEN);
403}
404
405int image_check_hcrc (image_header_t *hdr);
406int image_check_dcrc (image_header_t *hdr);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100407#ifndef USE_HOSTCC
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200408int getenv_yesno (char *var);
Kumar Galac5bacfd2008-02-27 21:51:50 -0600409ulong getenv_bootm_low(void);
Becky Bruced26d67c2008-06-09 20:37:18 -0500410phys_size_t getenv_bootm_size(void);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100411void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
412#endif
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100413
414static inline int image_check_magic (image_header_t *hdr)
415{
416 return (image_get_magic (hdr) == IH_MAGIC);
417}
418static inline int image_check_type (image_header_t *hdr, uint8_t type)
419{
420 return (image_get_type (hdr) == type);
421}
422static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
423{
424 return (image_get_arch (hdr) == arch);
425}
426static inline int image_check_os (image_header_t *hdr, uint8_t os)
427{
428 return (image_get_os (hdr) == os);
429}
430
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100431ulong image_multi_count (image_header_t *hdr);
432void image_multi_getimg (image_header_t *hdr, ulong idx,
433 ulong *data, ulong *len);
434
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200435void image_print_contents (image_header_t *hdr);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100436
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100437#ifndef USE_HOSTCC
438static inline int image_check_target_arch (image_header_t *hdr)
439{
440#if defined(__ARM__)
441 if (!image_check_arch (hdr, IH_ARCH_ARM))
442#elif defined(__avr32__)
443 if (!image_check_arch (hdr, IH_ARCH_AVR32))
444#elif defined(__bfin__)
445 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
446#elif defined(__I386__)
447 if (!image_check_arch (hdr, IH_ARCH_I386))
448#elif defined(__M68K__)
449 if (!image_check_arch (hdr, IH_ARCH_M68K))
450#elif defined(__microblaze__)
451 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
452#elif defined(__mips__)
453 if (!image_check_arch (hdr, IH_ARCH_MIPS))
454#elif defined(__nios__)
455 if (!image_check_arch (hdr, IH_ARCH_NIOS))
456#elif defined(__nios2__)
457 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
458#elif defined(__PPC__)
459 if (!image_check_arch (hdr, IH_ARCH_PPC))
460#elif defined(__sh__)
461 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombb9c8292008-03-28 08:29:26 +0100462#elif defined(__sparc__)
463 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100464#else
465# error Unknown CPU type
466#endif
467 return 0;
468
469 return 1;
470}
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100471#endif /* USE_HOSTCC */
wdenk5b1d7132002-11-03 00:07:02 +0000472
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100473/*******************************************************************/
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100474/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100475/*******************************************************************/
Marian Balakowicz3413e222008-02-21 17:20:20 +0100476#if defined(CONFIG_FIT)
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100477
478#define FIT_IMAGES_PATH "/images"
479#define FIT_CONFS_PATH "/configurations"
480
481/* hash node */
482#define FIT_HASH_NODENAME "hash"
483#define FIT_ALGO_PROP "algo"
484#define FIT_VALUE_PROP "value"
485
486/* image node */
487#define FIT_DATA_PROP "data"
488#define FIT_TIMESTAMP_PROP "timestamp"
489#define FIT_DESC_PROP "description"
490#define FIT_ARCH_PROP "arch"
491#define FIT_TYPE_PROP "type"
492#define FIT_OS_PROP "os"
493#define FIT_COMP_PROP "compression"
494#define FIT_ENTRY_PROP "entry"
495#define FIT_LOAD_PROP "load"
496
497/* configuration node */
498#define FIT_KERNEL_PROP "kernel"
499#define FIT_RAMDISK_PROP "ramdisk"
500#define FIT_FDT_PROP "fdt"
501#define FIT_DEFAULT_PROP "default"
502
503#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
504
505/* cmdline argument format parsing */
Marian Balakowicz3413e222008-02-21 17:20:20 +0100506inline int fit_parse_conf (const char *spec, ulong addr_curr,
507 ulong *addr, const char **conf_name);
508inline int fit_parse_subimage (const char *spec, ulong addr_curr,
509 ulong *addr, const char **image_name);
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100510
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200511void fit_print_contents (const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100512void fit_image_print (const void *fit, int noffset, const char *p);
513void fit_image_print_hash (const void *fit, int noffset, const char *p);
514
515/**
516 * fit_get_end - get FIT image size
517 * @fit: pointer to the FIT format image header
518 *
519 * returns:
520 * size of the FIT image (blob) in memory
521 */
522static inline ulong fit_get_size (const void *fit)
523{
524 return fdt_totalsize (fit);
525}
526
527/**
528 * fit_get_end - get FIT image end
529 * @fit: pointer to the FIT format image header
530 *
531 * returns:
532 * end address of the FIT image (blob) in memory
533 */
534static inline ulong fit_get_end (const void *fit)
535{
536 return (ulong)fit + fdt_totalsize (fit);
537}
538
539/**
540 * fit_get_name - get FIT node name
541 * @fit: pointer to the FIT format image header
542 *
543 * returns:
544 * NULL, on error
545 * pointer to node name, on success
546 */
547static inline const char *fit_get_name (const void *fit_hdr,
548 int noffset, int *len)
549{
550 return fdt_get_name (fit_hdr, noffset, len);
551}
552
553int fit_get_desc (const void *fit, int noffset, char **desc);
554int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
555
556int fit_image_get_node (const void *fit, const char *image_uname);
557int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
558int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
559int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
560int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
561int fit_image_get_load (const void *fit, int noffset, ulong *load);
562int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
563int fit_image_get_data (const void *fit, int noffset,
564 const void **data, size_t *size);
565
566int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
567int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
568 int *value_len);
569
570int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
571int fit_set_hashes (void *fit);
572int fit_image_set_hashes (void *fit, int image_noffset);
573int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
574 int value_len);
575
576int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka1557a542008-09-09 12:58:15 +0200577int fit_all_image_check_hashes (const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100578int fit_image_check_os (const void *fit, int noffset, uint8_t os);
579int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
580int fit_image_check_type (const void *fit, int noffset, uint8_t type);
581int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
582int fit_check_format (const void *fit);
583
584int fit_conf_get_node (const void *fit, const char *conf_uname);
585int fit_conf_get_kernel_node (const void *fit, int noffset);
586int fit_conf_get_ramdisk_node (const void *fit, int noffset);
587int fit_conf_get_fdt_node (const void *fit, int noffset);
588
589void fit_conf_print (const void *fit, int noffset, const char *p);
590
591#ifndef USE_HOSTCC
592static inline int fit_image_check_target_arch (const void *fdt, int node)
593{
594#if defined(__ARM__)
595 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
596#elif defined(__avr32__)
597 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
598#elif defined(__bfin__)
599 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
600#elif defined(__I386__)
601 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
602#elif defined(__M68K__)
603 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
604#elif defined(__microblaze__)
605 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
606#elif defined(__mips__)
607 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
608#elif defined(__nios__)
609 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
610#elif defined(__nios2__)
611 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
612#elif defined(__PPC__)
613 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
614#elif defined(__sh__)
615 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombb9c8292008-03-28 08:29:26 +0100616#elif defined(__sparc__)
617 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100618#else
619# error Unknown CPU type
620#endif
621 return 0;
622
623 return 1;
624}
625#endif /* USE_HOSTCC */
626
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100627#ifdef CONFIG_FIT_VERBOSE
628#define fit_unsupported(msg) printf ("! %s:%d " \
629 "FIT images not supported for '%s'\n", \
630 __FILE__, __LINE__, (msg))
631
632#define fit_unsupported_reset(msg) printf ("! %s:%d " \
633 "FIT images not supported for '%s' " \
634 "- must reset board to recover!\n", \
635 __FILE__, __LINE__, (msg))
636#else
637#define fit_unsupported(msg)
638#define fit_unsupported_reset(msg)
639#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowicz3413e222008-02-21 17:20:20 +0100640#endif /* CONFIG_FIT */
Marian Balakowicz95418502008-01-31 13:55:39 +0100641
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100642#endif /* __IMAGE_H__ */