blob: bbf80f0cac998accfc3f2a5a3e5f64540c11a226 [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>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050049#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020050
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010051#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010052
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010053#if defined(CONFIG_FIT)
54#include <fdt.h>
55#include <libfdt.h>
56#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010057#define CONFIG_MD5 /* FIT images need MD5 support */
Mike Frysingerdac4d7e2010-01-17 21:08:00 -050058#define CONFIG_SHA1 /* and SHA1 */
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 */
Torkel Lundgren3df61952010-09-28 11:05:36 +020086#define IH_OS_OSE 22 /* OSE */
wdenk5b1d7132002-11-03 00:07:02 +000087
88/*
89 * CPU Architecture Codes (supported by Linux)
90 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010091#define IH_ARCH_INVALID 0 /* Invalid CPU */
92#define IH_ARCH_ALPHA 1 /* Alpha */
93#define IH_ARCH_ARM 2 /* ARM */
94#define IH_ARCH_I386 3 /* Intel x86 */
95#define IH_ARCH_IA64 4 /* IA64 */
96#define IH_ARCH_MIPS 5 /* MIPS */
97#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
98#define IH_ARCH_PPC 7 /* PowerPC */
99#define IH_ARCH_S390 8 /* IBM S390 */
100#define IH_ARCH_SH 9 /* SuperH */
101#define IH_ARCH_SPARC 10 /* Sparc */
102#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
103#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100104#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 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000109#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000110#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000111#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
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
wdenke1599e82004-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)
wdenk27b207f2003-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 */
wdenkfbe4b5c2003-10-06 21:55:32 +0000159#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500160#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530161#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100162#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000163#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400164#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000165#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e82011-11-10 13:17:53 -0700166#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
wdenk5b1d7132002-11-03 00:07:02 +0000167
168/*
169 * Compression Types
170 */
171#define IH_COMP_NONE 0 /* No Compression Used */
172#define IH_COMP_GZIP 1 /* gzip Compression Used */
173#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200174#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100175#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000176
177#define IH_MAGIC 0x27051956 /* Image Magic Number */
178#define IH_NMLEN 32 /* Image Name Length */
179
wdenk5b1d7132002-11-03 00:07:02 +0000180/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100181 * Legacy format image header,
182 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000183 */
wdenk5b1d7132002-11-03 00:07:02 +0000184typedef struct image_header {
185 uint32_t ih_magic; /* Image Header Magic Number */
186 uint32_t ih_hcrc; /* Image Header CRC Checksum */
187 uint32_t ih_time; /* Image Creation Timestamp */
188 uint32_t ih_size; /* Image Data Size */
189 uint32_t ih_load; /* Data Load Address */
190 uint32_t ih_ep; /* Entry Point Address */
191 uint32_t ih_dcrc; /* Image Data CRC Checksum */
192 uint8_t ih_os; /* Operating System */
193 uint8_t ih_arch; /* CPU architecture */
194 uint8_t ih_type; /* Image Type */
195 uint8_t ih_comp; /* Compression Type */
196 uint8_t ih_name[IH_NMLEN]; /* Image Name */
197} image_header_t;
198
Kumar Gala396f6352008-08-15 08:24:41 -0500199typedef struct image_info {
200 ulong start, end; /* start/end of blob */
201 ulong image_start, image_len; /* start of image within blob, len of image */
202 ulong load; /* load addr for the image */
203 uint8_t comp, type, os; /* compression, type of image, os type */
204} image_info_t;
205
Marian Balakowicz559316f2008-01-08 18:11:44 +0100206/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100207 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
208 * routines.
209 */
210typedef struct bootm_headers {
211 /*
212 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100213 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100214 * data from second and third component accordingly.
215 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200216 image_header_t *legacy_hdr_os; /* image header pointer */
217 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100218 ulong legacy_hdr_valid;
219
220#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100221 const char *fit_uname_cfg; /* configuration node unit name */
222
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100223 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100224 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100225 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100226
227 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100228 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
229 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100230
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100231 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100232 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
233 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100234#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100235
Kumar Gala49c3a862008-10-21 17:25:45 -0500236#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500237 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500238 ulong ep; /* entry point of OS */
239
Kumar Galac4f94192008-08-15 08:24:37 -0500240 ulong rd_start, rd_end;/* ramdisk start/end */
241
Kumar Gala06a09912008-08-15 08:24:38 -0500242#ifdef CONFIG_OF_LIBFDT
243 char *ft_addr; /* flat dev tree address */
244#endif
245 ulong ft_len; /* length of flat device tree */
246
Kumar Gala49c3a862008-10-21 17:25:45 -0500247 ulong initrd_start;
248 ulong initrd_end;
249 ulong cmdline_start;
250 ulong cmdline_end;
251 bd_t *kbd;
252#endif
253
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100254 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500255
256#define BOOTM_STATE_START (0x00000001)
257#define BOOTM_STATE_LOADOS (0x00000002)
258#define BOOTM_STATE_RAMDISK (0x00000004)
259#define BOOTM_STATE_FDT (0x00000008)
260#define BOOTM_STATE_OS_CMDLINE (0x00000010)
261#define BOOTM_STATE_OS_BD_T (0x00000020)
262#define BOOTM_STATE_OS_PREP (0x00000040)
263#define BOOTM_STATE_OS_GO (0x00000080)
264 int state;
265
Mike Frysingera16028d2009-11-03 11:35:59 -0500266#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500267 struct lmb lmb; /* for memory mgmt */
268#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100269} bootm_headers_t;
270
271/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100272 * Some systems (for example LWMON) have very short watchdog periods;
273 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200274 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100275 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200276#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100277#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200278#endif
279
280#ifndef CHUNKSZ_CRC32
281#define CHUNKSZ_CRC32 (64 * 1024)
282#endif
283
284#ifndef CHUNKSZ_MD5
285#define CHUNKSZ_MD5 (64 * 1024)
286#endif
287
288#ifndef CHUNKSZ_SHA1
289#define CHUNKSZ_SHA1 (64 * 1024)
290#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100291
Mike Frysinger37566092009-07-02 19:23:25 -0400292#define uimage_to_cpu(x) be32_to_cpu(x)
293#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000294
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530295/*
296 * Translation table for entries of a specific type; used by
297 * get_table_entry_id() and get_table_entry_name().
298 */
299typedef struct table_entry {
300 int id;
301 char *sname; /* short (input) name to find table entry */
302 char *lname; /* long (output) name to print for messages */
303} table_entry_t;
304
305/*
306 * get_table_entry_id() scans the translation table trying to find an
307 * entry that matches the given short name. If a matching entry is
308 * found, it's id is returned to the caller.
309 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400310int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530311 const char *table_name, const char *name);
312/*
313 * get_table_entry_name() scans the translation table trying to find
314 * an entry that matches the given id. If a matching entry is found,
315 * its long name is returned to the caller.
316 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400317char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530318
Stephen Warren712fbcf2011-10-18 11:11:49 +0000319const char *genimg_get_os_name(uint8_t os);
320const char *genimg_get_arch_name(uint8_t arch);
321const char *genimg_get_type_name(uint8_t type);
322const char *genimg_get_comp_name(uint8_t comp);
323int genimg_get_os_id(const char *name);
324int genimg_get_arch_id(const char *name);
325int genimg_get_type_id(const char *name);
326int genimg_get_comp_id(const char *name);
327void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100328
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100329#ifndef USE_HOSTCC
330/* Image format types, returned by _get_format() routine */
331#define IMAGE_FORMAT_INVALID 0x00
332#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
333#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
334
Stephen Warren712fbcf2011-10-18 11:11:49 +0000335int genimg_get_format(void *img_addr);
336int genimg_has_config(bootm_headers_t *images);
337ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100338
Stephen Warren712fbcf2011-10-18 11:11:49 +0000339int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100340 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100341
Kumar Gala06a09912008-08-15 08:24:38 -0500342
343#ifdef CONFIG_OF_LIBFDT
Stephen Warren712fbcf2011-10-18 11:11:49 +0000344int boot_get_fdt(int flag, int argc, char * const argv[],
345 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000346void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000347int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500348#endif
349
John Rigbyfca43cc2010-10-13 13:57:35 -0600350#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Stephen Warren712fbcf2011-10-18 11:11:49 +0000351int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100352 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600353#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
354#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000355int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600356#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
357#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000358int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600359#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100360#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100361
362/*******************************************************************/
363/* Legacy format specific code (prefixed with image_) */
364/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000365static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100366{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000367 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100368}
369
370#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200371 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100372 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000373 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100374 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000375image_get_hdr_l(magic) /* image_get_magic */
376image_get_hdr_l(hcrc) /* image_get_hcrc */
377image_get_hdr_l(time) /* image_get_time */
378image_get_hdr_l(size) /* image_get_size */
379image_get_hdr_l(load) /* image_get_load */
380image_get_hdr_l(ep) /* image_get_ep */
381image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100382
383#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200384 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100385 { \
386 return hdr->ih_##f; \
387 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000388image_get_hdr_b(os) /* image_get_os */
389image_get_hdr_b(arch) /* image_get_arch */
390image_get_hdr_b(type) /* image_get_type */
391image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100392
Stephen Warren712fbcf2011-10-18 11:11:49 +0000393static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100394{
395 return (char *)hdr->ih_name;
396}
397
Stephen Warren712fbcf2011-10-18 11:11:49 +0000398static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100399{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000400 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100401}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100402
403/**
404 * image_get_data - get image payload start address
405 * @hdr: image header
406 *
407 * image_get_data() returns address of the image payload. For single
408 * component images it is image data start. For multi component
409 * images it points to the null terminated table of sub-images sizes.
410 *
411 * returns:
412 * image payload data start address
413 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000414static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100415{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000416 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100417}
418
Stephen Warren712fbcf2011-10-18 11:11:49 +0000419static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100420{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000421 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100422}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000423static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100424{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000425 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100426}
427
428#define image_set_hdr_l(f) \
429 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
430 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000431 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100432 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000433image_set_hdr_l(magic) /* image_set_magic */
434image_set_hdr_l(hcrc) /* image_set_hcrc */
435image_set_hdr_l(time) /* image_set_time */
436image_set_hdr_l(size) /* image_set_size */
437image_set_hdr_l(load) /* image_set_load */
438image_set_hdr_l(ep) /* image_set_ep */
439image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100440
441#define image_set_hdr_b(f) \
442 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
443 { \
444 hdr->ih_##f = val; \
445 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000446image_set_hdr_b(os) /* image_set_os */
447image_set_hdr_b(arch) /* image_set_arch */
448image_set_hdr_b(type) /* image_set_type */
449image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100450
Stephen Warren712fbcf2011-10-18 11:11:49 +0000451static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100452{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000453 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100454}
455
Stephen Warren712fbcf2011-10-18 11:11:49 +0000456int image_check_hcrc(const image_header_t *hdr);
457int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100458#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000459int getenv_yesno(char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600460ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500461phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000462phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000463void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100464#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100465
Stephen Warren712fbcf2011-10-18 11:11:49 +0000466static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100467{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000468 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100469}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000470static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100471{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000472 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100473}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000474static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100475{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000476 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100477}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000478static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100479{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000480 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100481}
482
Stephen Warren712fbcf2011-10-18 11:11:49 +0000483ulong image_multi_count(const image_header_t *hdr);
484void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100485 ulong *data, ulong *len);
486
Stephen Warren712fbcf2011-10-18 11:11:49 +0000487void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100488
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100489#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000490static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100491{
Mike Frysinger476af292011-10-03 14:50:33 +0000492#ifndef IH_ARCH_DEFAULT
493# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100494#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000495 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100496}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100497#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100498
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100499/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100500/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100501/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100502#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100503
504#define FIT_IMAGES_PATH "/images"
505#define FIT_CONFS_PATH "/configurations"
506
507/* hash node */
508#define FIT_HASH_NODENAME "hash"
509#define FIT_ALGO_PROP "algo"
510#define FIT_VALUE_PROP "value"
511
512/* image node */
513#define FIT_DATA_PROP "data"
514#define FIT_TIMESTAMP_PROP "timestamp"
515#define FIT_DESC_PROP "description"
516#define FIT_ARCH_PROP "arch"
517#define FIT_TYPE_PROP "type"
518#define FIT_OS_PROP "os"
519#define FIT_COMP_PROP "compression"
520#define FIT_ENTRY_PROP "entry"
521#define FIT_LOAD_PROP "load"
522
523/* configuration node */
524#define FIT_KERNEL_PROP "kernel"
525#define FIT_RAMDISK_PROP "ramdisk"
526#define FIT_FDT_PROP "fdt"
527#define FIT_DEFAULT_PROP "default"
528
529#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
530
531/* cmdline argument format parsing */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000532inline int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100533 ulong *addr, const char **conf_name);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000534inline int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100535 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100536
Stephen Warren712fbcf2011-10-18 11:11:49 +0000537void fit_print_contents(const void *fit);
538void fit_image_print(const void *fit, int noffset, const char *p);
539void fit_image_print_hash(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100540
541/**
542 * fit_get_end - get FIT image size
543 * @fit: pointer to the FIT format image header
544 *
545 * returns:
546 * size of the FIT image (blob) in memory
547 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000548static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100549{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000550 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100551}
552
553/**
554 * fit_get_end - get FIT image end
555 * @fit: pointer to the FIT format image header
556 *
557 * returns:
558 * end address of the FIT image (blob) in memory
559 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000560static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100561{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000562 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100563}
564
565/**
566 * fit_get_name - get FIT node name
567 * @fit: pointer to the FIT format image header
568 *
569 * returns:
570 * NULL, on error
571 * pointer to node name, on success
572 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000573static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100574 int noffset, int *len)
575{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000576 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100577}
578
Stephen Warren712fbcf2011-10-18 11:11:49 +0000579int fit_get_desc(const void *fit, int noffset, char **desc);
580int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100581
Stephen Warren712fbcf2011-10-18 11:11:49 +0000582int fit_image_get_node(const void *fit, const char *image_uname);
583int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
584int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
585int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
586int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
587int fit_image_get_load(const void *fit, int noffset, ulong *load);
588int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
589int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100590 const void **data, size_t *size);
591
Stephen Warren712fbcf2011-10-18 11:11:49 +0000592int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
593int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100594 int *value_len);
595
Stephen Warren712fbcf2011-10-18 11:11:49 +0000596int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
597int fit_set_hashes(void *fit);
598int fit_image_set_hashes(void *fit, int image_noffset);
599int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100600 int value_len);
601
Stephen Warren712fbcf2011-10-18 11:11:49 +0000602int fit_image_check_hashes(const void *fit, int noffset);
603int fit_all_image_check_hashes(const void *fit);
604int fit_image_check_os(const void *fit, int noffset, uint8_t os);
605int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
606int fit_image_check_type(const void *fit, int noffset, uint8_t type);
607int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
608int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100609
Stephen Warren712fbcf2011-10-18 11:11:49 +0000610int fit_conf_get_node(const void *fit, const char *conf_uname);
611int fit_conf_get_kernel_node(const void *fit, int noffset);
612int fit_conf_get_ramdisk_node(const void *fit, int noffset);
613int fit_conf_get_fdt_node(const void *fit, int noffset);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100614
Stephen Warren712fbcf2011-10-18 11:11:49 +0000615void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100616
617#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000618static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100619{
Thierry Reding75668322011-10-27 08:58:25 +0000620 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100621}
622#endif /* USE_HOSTCC */
623
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100624#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000625#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100626 "FIT images not supported for '%s'\n", \
627 __FILE__, __LINE__, (msg))
628
Stephen Warren712fbcf2011-10-18 11:11:49 +0000629#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100630 "FIT images not supported for '%s' " \
631 "- must reset board to recover!\n", \
632 __FILE__, __LINE__, (msg))
633#else
634#define fit_unsupported(msg)
635#define fit_unsupported_reset(msg)
636#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100637#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100638
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100639#endif /* __IMAGE_H__ */