blob: e5f6649291e24ccd524f67e211cd2bb63bf482a4 [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 */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000167#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000168
169/*
170 * Compression Types
171 */
172#define IH_COMP_NONE 0 /* No Compression Used */
173#define IH_COMP_GZIP 1 /* gzip Compression Used */
174#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200175#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100176#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000177
178#define IH_MAGIC 0x27051956 /* Image Magic Number */
179#define IH_NMLEN 32 /* Image Name Length */
180
wdenk5b1d7132002-11-03 00:07:02 +0000181/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100182 * Legacy format image header,
183 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000184 */
wdenk5b1d7132002-11-03 00:07:02 +0000185typedef struct image_header {
186 uint32_t ih_magic; /* Image Header Magic Number */
187 uint32_t ih_hcrc; /* Image Header CRC Checksum */
188 uint32_t ih_time; /* Image Creation Timestamp */
189 uint32_t ih_size; /* Image Data Size */
190 uint32_t ih_load; /* Data Load Address */
191 uint32_t ih_ep; /* Entry Point Address */
192 uint32_t ih_dcrc; /* Image Data CRC Checksum */
193 uint8_t ih_os; /* Operating System */
194 uint8_t ih_arch; /* CPU architecture */
195 uint8_t ih_type; /* Image Type */
196 uint8_t ih_comp; /* Compression Type */
197 uint8_t ih_name[IH_NMLEN]; /* Image Name */
198} image_header_t;
199
Kumar Gala396f6352008-08-15 08:24:41 -0500200typedef struct image_info {
201 ulong start, end; /* start/end of blob */
202 ulong image_start, image_len; /* start of image within blob, len of image */
203 ulong load; /* load addr for the image */
204 uint8_t comp, type, os; /* compression, type of image, os type */
205} image_info_t;
206
Marian Balakowicz559316f2008-01-08 18:11:44 +0100207/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100208 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
209 * routines.
210 */
211typedef struct bootm_headers {
212 /*
213 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100214 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100215 * data from second and third component accordingly.
216 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200217 image_header_t *legacy_hdr_os; /* image header pointer */
218 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100219 ulong legacy_hdr_valid;
220
221#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100222 const char *fit_uname_cfg; /* configuration node unit name */
223
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100224 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100225 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100226 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100227
228 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100229 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
230 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100231
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100232 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100233 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
234 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100235#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100236
Kumar Gala49c3a862008-10-21 17:25:45 -0500237#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500238 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500239 ulong ep; /* entry point of OS */
240
Kumar Galac4f94192008-08-15 08:24:37 -0500241 ulong rd_start, rd_end;/* ramdisk start/end */
242
Kumar Gala06a09912008-08-15 08:24:38 -0500243#ifdef CONFIG_OF_LIBFDT
244 char *ft_addr; /* flat dev tree address */
245#endif
246 ulong ft_len; /* length of flat device tree */
247
Kumar Gala49c3a862008-10-21 17:25:45 -0500248 ulong initrd_start;
249 ulong initrd_end;
250 ulong cmdline_start;
251 ulong cmdline_end;
252 bd_t *kbd;
253#endif
254
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100255 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500256
257#define BOOTM_STATE_START (0x00000001)
258#define BOOTM_STATE_LOADOS (0x00000002)
259#define BOOTM_STATE_RAMDISK (0x00000004)
260#define BOOTM_STATE_FDT (0x00000008)
261#define BOOTM_STATE_OS_CMDLINE (0x00000010)
262#define BOOTM_STATE_OS_BD_T (0x00000020)
263#define BOOTM_STATE_OS_PREP (0x00000040)
264#define BOOTM_STATE_OS_GO (0x00000080)
265 int state;
266
Mike Frysingera16028d2009-11-03 11:35:59 -0500267#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500268 struct lmb lmb; /* for memory mgmt */
269#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100270} bootm_headers_t;
271
Simon Schwarz1648a372012-03-15 04:01:34 +0000272extern bootm_headers_t images;
273
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100274/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100275 * Some systems (for example LWMON) have very short watchdog periods;
276 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200277 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100278 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200279#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100280#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200281#endif
282
283#ifndef CHUNKSZ_CRC32
284#define CHUNKSZ_CRC32 (64 * 1024)
285#endif
286
287#ifndef CHUNKSZ_MD5
288#define CHUNKSZ_MD5 (64 * 1024)
289#endif
290
291#ifndef CHUNKSZ_SHA1
292#define CHUNKSZ_SHA1 (64 * 1024)
293#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100294
Mike Frysinger37566092009-07-02 19:23:25 -0400295#define uimage_to_cpu(x) be32_to_cpu(x)
296#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000297
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530298/*
299 * Translation table for entries of a specific type; used by
300 * get_table_entry_id() and get_table_entry_name().
301 */
302typedef struct table_entry {
303 int id;
304 char *sname; /* short (input) name to find table entry */
305 char *lname; /* long (output) name to print for messages */
306} table_entry_t;
307
308/*
309 * get_table_entry_id() scans the translation table trying to find an
310 * entry that matches the given short name. If a matching entry is
311 * found, it's id is returned to the caller.
312 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400313int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530314 const char *table_name, const char *name);
315/*
316 * get_table_entry_name() scans the translation table trying to find
317 * an entry that matches the given id. If a matching entry is found,
318 * its long name is returned to the caller.
319 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400320char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530321
Stephen Warren712fbcf2011-10-18 11:11:49 +0000322const char *genimg_get_os_name(uint8_t os);
323const char *genimg_get_arch_name(uint8_t arch);
324const char *genimg_get_type_name(uint8_t type);
325const char *genimg_get_comp_name(uint8_t comp);
326int genimg_get_os_id(const char *name);
327int genimg_get_arch_id(const char *name);
328int genimg_get_type_id(const char *name);
329int genimg_get_comp_id(const char *name);
330void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100331
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100332#ifndef USE_HOSTCC
333/* Image format types, returned by _get_format() routine */
334#define IMAGE_FORMAT_INVALID 0x00
335#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
336#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
337
Stephen Warren712fbcf2011-10-18 11:11:49 +0000338int genimg_get_format(void *img_addr);
339int genimg_has_config(bootm_headers_t *images);
340ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100341
Stephen Warren712fbcf2011-10-18 11:11:49 +0000342int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100343 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100344
Kumar Gala06a09912008-08-15 08:24:38 -0500345
346#ifdef CONFIG_OF_LIBFDT
Stephen Warren712fbcf2011-10-18 11:11:49 +0000347int boot_get_fdt(int flag, int argc, char * const argv[],
348 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000349void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000350int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500351#endif
352
John Rigbyfca43cc2010-10-13 13:57:35 -0600353#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Stephen Warren712fbcf2011-10-18 11:11:49 +0000354int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100355 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600356#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
357#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000358int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600359#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
360#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000361int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600362#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100363#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100364
365/*******************************************************************/
366/* Legacy format specific code (prefixed with image_) */
367/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000368static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100369{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000370 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100371}
372
373#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200374 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100375 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000376 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100377 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000378image_get_hdr_l(magic) /* image_get_magic */
379image_get_hdr_l(hcrc) /* image_get_hcrc */
380image_get_hdr_l(time) /* image_get_time */
381image_get_hdr_l(size) /* image_get_size */
382image_get_hdr_l(load) /* image_get_load */
383image_get_hdr_l(ep) /* image_get_ep */
384image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100385
386#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200387 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100388 { \
389 return hdr->ih_##f; \
390 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000391image_get_hdr_b(os) /* image_get_os */
392image_get_hdr_b(arch) /* image_get_arch */
393image_get_hdr_b(type) /* image_get_type */
394image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100395
Stephen Warren712fbcf2011-10-18 11:11:49 +0000396static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100397{
398 return (char *)hdr->ih_name;
399}
400
Stephen Warren712fbcf2011-10-18 11:11:49 +0000401static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100402{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000403 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100404}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100405
406/**
407 * image_get_data - get image payload start address
408 * @hdr: image header
409 *
410 * image_get_data() returns address of the image payload. For single
411 * component images it is image data start. For multi component
412 * images it points to the null terminated table of sub-images sizes.
413 *
414 * returns:
415 * image payload data start address
416 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000417static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100418{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000419 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100420}
421
Stephen Warren712fbcf2011-10-18 11:11:49 +0000422static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100423{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000424 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100425}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000426static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100427{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000428 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100429}
430
431#define image_set_hdr_l(f) \
432 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
433 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000434 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100435 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000436image_set_hdr_l(magic) /* image_set_magic */
437image_set_hdr_l(hcrc) /* image_set_hcrc */
438image_set_hdr_l(time) /* image_set_time */
439image_set_hdr_l(size) /* image_set_size */
440image_set_hdr_l(load) /* image_set_load */
441image_set_hdr_l(ep) /* image_set_ep */
442image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100443
444#define image_set_hdr_b(f) \
445 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
446 { \
447 hdr->ih_##f = val; \
448 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000449image_set_hdr_b(os) /* image_set_os */
450image_set_hdr_b(arch) /* image_set_arch */
451image_set_hdr_b(type) /* image_set_type */
452image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100453
Stephen Warren712fbcf2011-10-18 11:11:49 +0000454static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100455{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000456 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100457}
458
Stephen Warren712fbcf2011-10-18 11:11:49 +0000459int image_check_hcrc(const image_header_t *hdr);
460int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100461#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000462int getenv_yesno(char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600463ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500464phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000465phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000466void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100467#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100468
Stephen Warren712fbcf2011-10-18 11:11:49 +0000469static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100470{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000471 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100472}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000473static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100474{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000475 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100476}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000477static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100478{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000479 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100480}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000481static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100482{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000483 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100484}
485
Stephen Warren712fbcf2011-10-18 11:11:49 +0000486ulong image_multi_count(const image_header_t *hdr);
487void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100488 ulong *data, ulong *len);
489
Stephen Warren712fbcf2011-10-18 11:11:49 +0000490void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100491
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100492#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000493static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100494{
Mike Frysinger476af292011-10-03 14:50:33 +0000495#ifndef IH_ARCH_DEFAULT
496# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100497#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000498 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100499}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100500#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100501
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100502/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100503/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100504/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100505#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100506
507#define FIT_IMAGES_PATH "/images"
508#define FIT_CONFS_PATH "/configurations"
509
510/* hash node */
511#define FIT_HASH_NODENAME "hash"
512#define FIT_ALGO_PROP "algo"
513#define FIT_VALUE_PROP "value"
514
515/* image node */
516#define FIT_DATA_PROP "data"
517#define FIT_TIMESTAMP_PROP "timestamp"
518#define FIT_DESC_PROP "description"
519#define FIT_ARCH_PROP "arch"
520#define FIT_TYPE_PROP "type"
521#define FIT_OS_PROP "os"
522#define FIT_COMP_PROP "compression"
523#define FIT_ENTRY_PROP "entry"
524#define FIT_LOAD_PROP "load"
525
526/* configuration node */
527#define FIT_KERNEL_PROP "kernel"
528#define FIT_RAMDISK_PROP "ramdisk"
529#define FIT_FDT_PROP "fdt"
530#define FIT_DEFAULT_PROP "default"
531
532#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
533
534/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000535int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100536 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000537int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100538 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100539
Stephen Warren712fbcf2011-10-18 11:11:49 +0000540void fit_print_contents(const void *fit);
541void fit_image_print(const void *fit, int noffset, const char *p);
542void fit_image_print_hash(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100543
544/**
545 * fit_get_end - get FIT image size
546 * @fit: pointer to the FIT format image header
547 *
548 * returns:
549 * size of the FIT image (blob) in memory
550 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000551static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100552{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000553 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100554}
555
556/**
557 * fit_get_end - get FIT image end
558 * @fit: pointer to the FIT format image header
559 *
560 * returns:
561 * end address of the FIT image (blob) in memory
562 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000563static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100564{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000565 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100566}
567
568/**
569 * fit_get_name - get FIT node name
570 * @fit: pointer to the FIT format image header
571 *
572 * returns:
573 * NULL, on error
574 * pointer to node name, on success
575 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000576static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100577 int noffset, int *len)
578{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000579 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100580}
581
Stephen Warren712fbcf2011-10-18 11:11:49 +0000582int fit_get_desc(const void *fit, int noffset, char **desc);
583int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100584
Stephen Warren712fbcf2011-10-18 11:11:49 +0000585int fit_image_get_node(const void *fit, const char *image_uname);
586int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
587int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
588int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
589int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
590int fit_image_get_load(const void *fit, int noffset, ulong *load);
591int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
592int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100593 const void **data, size_t *size);
594
Stephen Warren712fbcf2011-10-18 11:11:49 +0000595int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
596int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100597 int *value_len);
598
Stephen Warren712fbcf2011-10-18 11:11:49 +0000599int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
600int fit_set_hashes(void *fit);
601int fit_image_set_hashes(void *fit, int image_noffset);
602int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100603 int value_len);
604
Stephen Warren712fbcf2011-10-18 11:11:49 +0000605int fit_image_check_hashes(const void *fit, int noffset);
606int fit_all_image_check_hashes(const void *fit);
607int fit_image_check_os(const void *fit, int noffset, uint8_t os);
608int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
609int fit_image_check_type(const void *fit, int noffset, uint8_t type);
610int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
611int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100612
Stephen Warren712fbcf2011-10-18 11:11:49 +0000613int fit_conf_get_node(const void *fit, const char *conf_uname);
614int fit_conf_get_kernel_node(const void *fit, int noffset);
615int fit_conf_get_ramdisk_node(const void *fit, int noffset);
616int fit_conf_get_fdt_node(const void *fit, int noffset);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100617
Stephen Warren712fbcf2011-10-18 11:11:49 +0000618void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100619
620#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000621static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100622{
Thierry Reding75668322011-10-27 08:58:25 +0000623 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100624}
625#endif /* USE_HOSTCC */
626
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100627#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000628#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100629 "FIT images not supported for '%s'\n", \
630 __FILE__, __LINE__, (msg))
631
Stephen Warren712fbcf2011-10-18 11:11:49 +0000632#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100633 "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 Balakowiczf50433d2008-02-21 17:20:20 +0100640#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100641
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100642#endif /* __IMAGE_H__ */