blob: 4a7bf7820a8e0ad55ecb04113730986d23a9fa50 [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
Mike Frysinger37566092009-07-02 19:23:25 -040036#include "compiler.h"
37
38#ifdef USE_HOSTCC
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010039
40/* new uImage format support enabled on host */
41#define CONFIG_FIT 1
42#define CONFIG_OF_LIBFDT 1
43#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
44
Wolfgang Denkdef08192008-10-21 11:23:56 +020045#else
46
47#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020048#include <asm/u-boot.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020049
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010050#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010051
Wolfgang Denkdef08192008-10-21 11:23:56 +020052#include <command.h>
53
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010054#if defined(CONFIG_FIT)
55#include <fdt.h>
56#include <libfdt.h>
57#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010058#define CONFIG_MD5 /* FIT images need MD5 support */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010059#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010060
wdenk5b1d7132002-11-03 00:07:02 +000061/*
62 * Operating System Codes
63 */
64#define IH_OS_INVALID 0 /* Invalid OS */
65#define IH_OS_OPENBSD 1 /* OpenBSD */
66#define IH_OS_NETBSD 2 /* NetBSD */
67#define IH_OS_FREEBSD 3 /* FreeBSD */
68#define IH_OS_4_4BSD 4 /* 4.4BSD */
69#define IH_OS_LINUX 5 /* Linux */
70#define IH_OS_SVR4 6 /* SVR4 */
71#define IH_OS_ESIX 7 /* Esix */
72#define IH_OS_SOLARIS 8 /* Solaris */
73#define IH_OS_IRIX 9 /* Irix */
74#define IH_OS_SCO 10 /* SCO */
75#define IH_OS_DELL 11 /* Dell */
76#define IH_OS_NCR 12 /* NCR */
77#define IH_OS_LYNXOS 13 /* LynxOS */
78#define IH_OS_VXWORKS 14 /* VxWorks */
79#define IH_OS_PSOS 15 /* pSOS */
80#define IH_OS_QNX 16 /* QNX */
81#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +000082#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +000083#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +000084#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -050085#define IH_OS_INTEGRITY 21 /* INTEGRITY */
wdenk5b1d7132002-11-03 00:07:02 +000086
87/*
88 * CPU Architecture Codes (supported by Linux)
89 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010090#define IH_ARCH_INVALID 0 /* Invalid CPU */
91#define IH_ARCH_ALPHA 1 /* Alpha */
92#define IH_ARCH_ARM 2 /* ARM */
93#define IH_ARCH_I386 3 /* Intel x86 */
94#define IH_ARCH_IA64 4 /* IA64 */
95#define IH_ARCH_MIPS 5 /* MIPS */
96#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
97#define IH_ARCH_PPC 7 /* PowerPC */
98#define IH_ARCH_S390 8 /* IBM S390 */
99#define IH_ARCH_SH 9 /* SuperH */
100#define IH_ARCH_SPARC 10 /* Sparc */
101#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
102#define IH_ARCH_M68K 12 /* M68K */
103#define IH_ARCH_NIOS 13 /* Nios-32 */
104#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
105#define IH_ARCH_NIOS2 15 /* Nios-II */
106#define IH_ARCH_BLACKFIN 16 /* Blackfin */
107#define IH_ARCH_AVR32 17 /* AVR32 */
108#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
wdenk5b1d7132002-11-03 00:07:02 +0000109
110/*
111 * Image Types
112 *
113 * "Standalone Programs" are directly runnable in the environment
114 * provided by U-Boot; it is expected that (if they behave
115 * well) you can continue to work in U-Boot after return from
116 * the Standalone Program.
117 * "OS Kernel Images" are usually images of some Embedded OS which
118 * will take over control completely. Usually these programs
119 * will install their own set of exception handlers, device
120 * drivers, set up the MMU, etc. - this means, that you cannot
121 * expect to re-enter U-Boot except by resetting the CPU.
122 * "RAMDisk Images" are more or less just data blocks, and their
123 * parameters (address, size) are passed to an OS kernel that is
124 * being started.
125 * "Multi-File Images" contain several images, typically an OS
126 * (Linux) kernel image and one or more data images like
127 * RAMDisks. This construct is useful for instance when you want
128 * to boot over the network using BOOTP etc., where the boot
129 * server provides just a single image file, but you want to get
130 * for instance an OS kernel and a RAMDisk image.
131 *
132 * "Multi-File Images" start with a list of image sizes, each
133 * image size (in bytes) specified by an "uint32_t" in network
134 * byte order. This list is terminated by an "(uint32_t)0".
135 * Immediately after the terminating 0 follow the images, one by
136 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000137 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000138 *
139 * "Firmware Images" are binary images containing firmware (like
140 * U-Boot or FPGA images) which usually will be programmed to
141 * flash memory.
142 *
143 * "Script files" are command sequences that will be executed by
144 * U-Boot's command interpreter; this feature is especially
145 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000146 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000147 */
148
149#define IH_TYPE_INVALID 0 /* Invalid Image */
150#define IH_TYPE_STANDALONE 1 /* Standalone Program */
151#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
152#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
153#define IH_TYPE_MULTI 4 /* Multi-File Image */
154#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
155#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000156#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500157#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
wdenk5b1d7132002-11-03 00:07:02 +0000158
159/*
160 * Compression Types
161 */
162#define IH_COMP_NONE 0 /* No Compression Used */
163#define IH_COMP_GZIP 1 /* gzip Compression Used */
164#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200165#define IH_COMP_LZMA 3 /* lzma Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000166
167#define IH_MAGIC 0x27051956 /* Image Magic Number */
168#define IH_NMLEN 32 /* Image Name Length */
169
wdenk5b1d7132002-11-03 00:07:02 +0000170/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100171 * Legacy format image header,
172 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000173 */
wdenk5b1d7132002-11-03 00:07:02 +0000174typedef struct image_header {
175 uint32_t ih_magic; /* Image Header Magic Number */
176 uint32_t ih_hcrc; /* Image Header CRC Checksum */
177 uint32_t ih_time; /* Image Creation Timestamp */
178 uint32_t ih_size; /* Image Data Size */
179 uint32_t ih_load; /* Data Load Address */
180 uint32_t ih_ep; /* Entry Point Address */
181 uint32_t ih_dcrc; /* Image Data CRC Checksum */
182 uint8_t ih_os; /* Operating System */
183 uint8_t ih_arch; /* CPU architecture */
184 uint8_t ih_type; /* Image Type */
185 uint8_t ih_comp; /* Compression Type */
186 uint8_t ih_name[IH_NMLEN]; /* Image Name */
187} image_header_t;
188
Kumar Gala396f6352008-08-15 08:24:41 -0500189typedef struct image_info {
190 ulong start, end; /* start/end of blob */
191 ulong image_start, image_len; /* start of image within blob, len of image */
192 ulong load; /* load addr for the image */
193 uint8_t comp, type, os; /* compression, type of image, os type */
194} image_info_t;
195
Marian Balakowicz559316f2008-01-08 18:11:44 +0100196/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100197 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
198 * routines.
199 */
200typedef struct bootm_headers {
201 /*
202 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100203 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100204 * data from second and third component accordingly.
205 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200206 image_header_t *legacy_hdr_os; /* image header pointer */
207 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100208 ulong legacy_hdr_valid;
209
210#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100211 const char *fit_uname_cfg; /* configuration node unit name */
212
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100213 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100214 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100215 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100216
217 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100218 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
219 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100220
221#if defined(CONFIG_PPC)
222 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100223 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
224 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100225#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100226#endif
227
Kumar Gala49c3a862008-10-21 17:25:45 -0500228#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500229 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500230 ulong ep; /* entry point of OS */
231
Kumar Galac4f94192008-08-15 08:24:37 -0500232 ulong rd_start, rd_end;/* ramdisk start/end */
233
Kumar Gala06a09912008-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
Kumar Gala49c3a862008-10-21 17:25:45 -0500239 ulong initrd_start;
240 ulong initrd_end;
241 ulong cmdline_start;
242 ulong cmdline_end;
243 bd_t *kbd;
244#endif
245
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100246 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500247
248#define BOOTM_STATE_START (0x00000001)
249#define BOOTM_STATE_LOADOS (0x00000002)
250#define BOOTM_STATE_RAMDISK (0x00000004)
251#define BOOTM_STATE_FDT (0x00000008)
252#define BOOTM_STATE_OS_CMDLINE (0x00000010)
253#define BOOTM_STATE_OS_BD_T (0x00000020)
254#define BOOTM_STATE_OS_PREP (0x00000040)
255#define BOOTM_STATE_OS_GO (0x00000080)
256 int state;
257
Kumar Galae906cfa2008-08-15 08:24:40 -0500258#ifndef USE_HOSTCC
259 struct lmb lmb; /* for memory mgmt */
260#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100261} bootm_headers_t;
262
263/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100264 * Some systems (for example LWMON) have very short watchdog periods;
265 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200266 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100267 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200268#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100269#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200270#endif
271
272#ifndef CHUNKSZ_CRC32
273#define CHUNKSZ_CRC32 (64 * 1024)
274#endif
275
276#ifndef CHUNKSZ_MD5
277#define CHUNKSZ_MD5 (64 * 1024)
278#endif
279
280#ifndef CHUNKSZ_SHA1
281#define CHUNKSZ_SHA1 (64 * 1024)
282#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100283
Mike Frysinger37566092009-07-02 19:23:25 -0400284#define uimage_to_cpu(x) be32_to_cpu(x)
285#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000286
Marian Balakowicz570abb02008-02-29 15:59:59 +0100287const char *genimg_get_os_name (uint8_t os);
288const char *genimg_get_arch_name (uint8_t arch);
289const char *genimg_get_type_name (uint8_t type);
290const char *genimg_get_comp_name (uint8_t comp);
291int genimg_get_os_id (const char *name);
292int genimg_get_arch_id (const char *name);
293int genimg_get_type_id (const char *name);
294int genimg_get_comp_id (const char *name);
Prafulla Wadaskar6e869822009-09-07 14:59:07 +0530295void genimg_print_size (uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100296
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100297#ifndef USE_HOSTCC
298/* Image format types, returned by _get_format() routine */
299#define IMAGE_FORMAT_INVALID 0x00
300#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
301#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
302
303int genimg_get_format (void *img_addr);
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100304int genimg_has_config (bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100305ulong genimg_get_image (ulong img_addr);
306
Marian Balakowiczd985c842008-03-12 10:14:38 +0100307int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
308 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100309
Kumar Gala06a09912008-08-15 08:24:38 -0500310
311#ifdef CONFIG_OF_LIBFDT
312int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
313 char **of_flat_tree, ulong *of_size);
314int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
315 char **of_flat_tree, ulong *of_size);
316#endif
317
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100318#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
319int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
320 ulong *initrd_start, ulong *initrd_end);
321
322int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
323 ulong bootmap_base);
324int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
325#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100326#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100327
328/*******************************************************************/
329/* Legacy format specific code (prefixed with image_) */
330/*******************************************************************/
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100331static inline uint32_t image_get_header_size (void)
332{
333 return (sizeof (image_header_t));
334}
335
336#define image_get_hdr_l(f) \
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200337 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100338 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100339 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100340 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200341image_get_hdr_l (magic); /* image_get_magic */
342image_get_hdr_l (hcrc); /* image_get_hcrc */
343image_get_hdr_l (time); /* image_get_time */
344image_get_hdr_l (size); /* image_get_size */
345image_get_hdr_l (load); /* image_get_load */
346image_get_hdr_l (ep); /* image_get_ep */
347image_get_hdr_l (dcrc); /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100348
349#define image_get_hdr_b(f) \
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200350 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100351 { \
352 return hdr->ih_##f; \
353 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200354image_get_hdr_b (os); /* image_get_os */
355image_get_hdr_b (arch); /* image_get_arch */
356image_get_hdr_b (type); /* image_get_type */
357image_get_hdr_b (comp); /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100358
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200359static inline char *image_get_name (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100360{
361 return (char *)hdr->ih_name;
362}
363
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200364static inline uint32_t image_get_data_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100365{
366 return image_get_size (hdr);
367}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100368
369/**
370 * image_get_data - get image payload start address
371 * @hdr: image header
372 *
373 * image_get_data() returns address of the image payload. For single
374 * component images it is image data start. For multi component
375 * images it points to the null terminated table of sub-images sizes.
376 *
377 * returns:
378 * image payload data start address
379 */
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200380static inline ulong image_get_data (const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100381{
382 return ((ulong)hdr + image_get_header_size ());
383}
384
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200385static inline uint32_t image_get_image_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100386{
387 return (image_get_size (hdr) + image_get_header_size ());
388}
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200389static inline ulong image_get_image_end (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100390{
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100391 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100392}
393
394#define image_set_hdr_l(f) \
395 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
396 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100397 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100398 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200399image_set_hdr_l (magic); /* image_set_magic */
400image_set_hdr_l (hcrc); /* image_set_hcrc */
401image_set_hdr_l (time); /* image_set_time */
402image_set_hdr_l (size); /* image_set_size */
403image_set_hdr_l (load); /* image_set_load */
404image_set_hdr_l (ep); /* image_set_ep */
405image_set_hdr_l (dcrc); /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100406
407#define image_set_hdr_b(f) \
408 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
409 { \
410 hdr->ih_##f = val; \
411 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200412image_set_hdr_b (os); /* image_set_os */
413image_set_hdr_b (arch); /* image_set_arch */
414image_set_hdr_b (type); /* image_set_type */
415image_set_hdr_b (comp); /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100416
417static inline void image_set_name (image_header_t *hdr, const char *name)
418{
419 strncpy (image_get_name (hdr), name, IH_NMLEN);
420}
421
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200422int image_check_hcrc (const image_header_t *hdr);
423int image_check_dcrc (const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100424#ifndef USE_HOSTCC
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200425int getenv_yesno (char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600426ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500427phys_size_t getenv_bootm_size(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100428void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
429#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100430
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200431static inline int image_check_magic (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100432{
433 return (image_get_magic (hdr) == IH_MAGIC);
434}
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200435static inline int image_check_type (const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100436{
437 return (image_get_type (hdr) == type);
438}
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200439static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100440{
441 return (image_get_arch (hdr) == arch);
442}
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200443static inline int image_check_os (const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100444{
445 return (image_get_os (hdr) == os);
446}
447
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200448ulong image_multi_count (const image_header_t *hdr);
449void image_multi_getimg (const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100450 ulong *data, ulong *len);
451
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200452void image_print_contents (const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100453
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100454#ifndef USE_HOSTCC
Wolfgang Denkc928d1d2009-08-19 11:42:56 +0200455static inline int image_check_target_arch (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100456{
457#if defined(__ARM__)
458 if (!image_check_arch (hdr, IH_ARCH_ARM))
459#elif defined(__avr32__)
460 if (!image_check_arch (hdr, IH_ARCH_AVR32))
461#elif defined(__bfin__)
462 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
463#elif defined(__I386__)
464 if (!image_check_arch (hdr, IH_ARCH_I386))
465#elif defined(__M68K__)
466 if (!image_check_arch (hdr, IH_ARCH_M68K))
467#elif defined(__microblaze__)
468 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
469#elif defined(__mips__)
470 if (!image_check_arch (hdr, IH_ARCH_MIPS))
471#elif defined(__nios__)
472 if (!image_check_arch (hdr, IH_ARCH_NIOS))
473#elif defined(__nios2__)
474 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
475#elif defined(__PPC__)
476 if (!image_check_arch (hdr, IH_ARCH_PPC))
477#elif defined(__sh__)
478 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100479#elif defined(__sparc__)
480 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100481#else
482# error Unknown CPU type
483#endif
484 return 0;
485
486 return 1;
487}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100488#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100489
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100490/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100491/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100492/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100493#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100494
495#define FIT_IMAGES_PATH "/images"
496#define FIT_CONFS_PATH "/configurations"
497
498/* hash node */
499#define FIT_HASH_NODENAME "hash"
500#define FIT_ALGO_PROP "algo"
501#define FIT_VALUE_PROP "value"
502
503/* image node */
504#define FIT_DATA_PROP "data"
505#define FIT_TIMESTAMP_PROP "timestamp"
506#define FIT_DESC_PROP "description"
507#define FIT_ARCH_PROP "arch"
508#define FIT_TYPE_PROP "type"
509#define FIT_OS_PROP "os"
510#define FIT_COMP_PROP "compression"
511#define FIT_ENTRY_PROP "entry"
512#define FIT_LOAD_PROP "load"
513
514/* configuration node */
515#define FIT_KERNEL_PROP "kernel"
516#define FIT_RAMDISK_PROP "ramdisk"
517#define FIT_FDT_PROP "fdt"
518#define FIT_DEFAULT_PROP "default"
519
520#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
521
522/* cmdline argument format parsing */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100523inline int fit_parse_conf (const char *spec, ulong addr_curr,
524 ulong *addr, const char **conf_name);
525inline int fit_parse_subimage (const char *spec, ulong addr_curr,
526 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100527
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200528void fit_print_contents (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100529void fit_image_print (const void *fit, int noffset, const char *p);
530void fit_image_print_hash (const void *fit, int noffset, const char *p);
531
532/**
533 * fit_get_end - get FIT image size
534 * @fit: pointer to the FIT format image header
535 *
536 * returns:
537 * size of the FIT image (blob) in memory
538 */
539static inline ulong fit_get_size (const void *fit)
540{
541 return fdt_totalsize (fit);
542}
543
544/**
545 * fit_get_end - get FIT image end
546 * @fit: pointer to the FIT format image header
547 *
548 * returns:
549 * end address of the FIT image (blob) in memory
550 */
551static inline ulong fit_get_end (const void *fit)
552{
553 return (ulong)fit + fdt_totalsize (fit);
554}
555
556/**
557 * fit_get_name - get FIT node name
558 * @fit: pointer to the FIT format image header
559 *
560 * returns:
561 * NULL, on error
562 * pointer to node name, on success
563 */
564static inline const char *fit_get_name (const void *fit_hdr,
565 int noffset, int *len)
566{
567 return fdt_get_name (fit_hdr, noffset, len);
568}
569
570int fit_get_desc (const void *fit, int noffset, char **desc);
571int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
572
573int fit_image_get_node (const void *fit, const char *image_uname);
574int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
575int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
576int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
577int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
578int fit_image_get_load (const void *fit, int noffset, ulong *load);
579int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
580int fit_image_get_data (const void *fit, int noffset,
581 const void **data, size_t *size);
582
583int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
584int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
585 int *value_len);
586
587int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
588int fit_set_hashes (void *fit);
589int fit_image_set_hashes (void *fit, int image_noffset);
590int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
591 int value_len);
592
593int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka919f5502008-09-09 12:58:15 +0200594int fit_all_image_check_hashes (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100595int fit_image_check_os (const void *fit, int noffset, uint8_t os);
596int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
597int fit_image_check_type (const void *fit, int noffset, uint8_t type);
598int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
599int fit_check_format (const void *fit);
600
601int fit_conf_get_node (const void *fit, const char *conf_uname);
602int fit_conf_get_kernel_node (const void *fit, int noffset);
603int fit_conf_get_ramdisk_node (const void *fit, int noffset);
604int fit_conf_get_fdt_node (const void *fit, int noffset);
605
606void fit_conf_print (const void *fit, int noffset, const char *p);
607
608#ifndef USE_HOSTCC
609static inline int fit_image_check_target_arch (const void *fdt, int node)
610{
611#if defined(__ARM__)
612 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
613#elif defined(__avr32__)
614 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
615#elif defined(__bfin__)
616 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
617#elif defined(__I386__)
618 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
619#elif defined(__M68K__)
620 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
621#elif defined(__microblaze__)
622 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
623#elif defined(__mips__)
624 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
625#elif defined(__nios__)
626 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
627#elif defined(__nios2__)
628 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
629#elif defined(__PPC__)
630 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
631#elif defined(__sh__)
632 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100633#elif defined(__sparc__)
634 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100635#else
636# error Unknown CPU type
637#endif
638 return 0;
639
640 return 1;
641}
642#endif /* USE_HOSTCC */
643
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100644#ifdef CONFIG_FIT_VERBOSE
645#define fit_unsupported(msg) printf ("! %s:%d " \
646 "FIT images not supported for '%s'\n", \
647 __FILE__, __LINE__, (msg))
648
649#define fit_unsupported_reset(msg) printf ("! %s:%d " \
650 "FIT images not supported for '%s' " \
651 "- must reset board to recover!\n", \
652 __FILE__, __LINE__, (msg))
653#else
654#define fit_unsupported(msg)
655#define fit_unsupported_reset(msg)
656#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100657#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100658
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100659#endif /* __IMAGE_H__ */