blob: 0a895f2044c21a4b81245caae79ef95af6a6b999 [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"
Kim Phillips2f220502012-10-29 13:34:30 +000037#include <asm/byteorder.h>
Mike Frysinger37566092009-07-02 19:23:25 -040038
39#ifdef USE_HOSTCC
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010040
41/* new uImage format support enabled on host */
42#define CONFIG_FIT 1
43#define CONFIG_OF_LIBFDT 1
44#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
45
Wolfgang Denkdef08192008-10-21 11:23:56 +020046#else
47
48#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020049#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050050#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020051
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010052#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010053
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 */
Mike Frysingerdac4d7e2010-01-17 21:08:00 -050059#define CONFIG_SHA1 /* and SHA1 */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010060#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010061
wdenk5b1d7132002-11-03 00:07:02 +000062/*
63 * Operating System Codes
64 */
65#define IH_OS_INVALID 0 /* Invalid OS */
66#define IH_OS_OPENBSD 1 /* OpenBSD */
67#define IH_OS_NETBSD 2 /* NetBSD */
68#define IH_OS_FREEBSD 3 /* FreeBSD */
69#define IH_OS_4_4BSD 4 /* 4.4BSD */
70#define IH_OS_LINUX 5 /* Linux */
71#define IH_OS_SVR4 6 /* SVR4 */
72#define IH_OS_ESIX 7 /* Esix */
73#define IH_OS_SOLARIS 8 /* Solaris */
74#define IH_OS_IRIX 9 /* Irix */
75#define IH_OS_SCO 10 /* SCO */
76#define IH_OS_DELL 11 /* Dell */
77#define IH_OS_NCR 12 /* NCR */
78#define IH_OS_LYNXOS 13 /* LynxOS */
79#define IH_OS_VXWORKS 14 /* VxWorks */
80#define IH_OS_PSOS 15 /* pSOS */
81#define IH_OS_QNX 16 /* QNX */
82#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +000083#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +000084#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +000085#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -050086#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +020087#define IH_OS_OSE 22 /* OSE */
wdenk5b1d7132002-11-03 00:07:02 +000088
89/*
90 * CPU Architecture Codes (supported by Linux)
91 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010092#define IH_ARCH_INVALID 0 /* Invalid CPU */
93#define IH_ARCH_ALPHA 1 /* Alpha */
94#define IH_ARCH_ARM 2 /* ARM */
95#define IH_ARCH_I386 3 /* Intel x86 */
96#define IH_ARCH_IA64 4 /* IA64 */
97#define IH_ARCH_MIPS 5 /* MIPS */
98#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
99#define IH_ARCH_PPC 7 /* PowerPC */
100#define IH_ARCH_S390 8 /* IBM S390 */
101#define IH_ARCH_SH 9 /* SuperH */
102#define IH_ARCH_SPARC 10 /* Sparc */
103#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
104#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100105#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
106#define IH_ARCH_NIOS2 15 /* Nios-II */
107#define IH_ARCH_BLACKFIN 16 /* Blackfin */
108#define IH_ARCH_AVR32 17 /* AVR32 */
109#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000110#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000111#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000112#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
wdenk5b1d7132002-11-03 00:07:02 +0000113
114/*
115 * Image Types
116 *
117 * "Standalone Programs" are directly runnable in the environment
118 * provided by U-Boot; it is expected that (if they behave
119 * well) you can continue to work in U-Boot after return from
120 * the Standalone Program.
121 * "OS Kernel Images" are usually images of some Embedded OS which
122 * will take over control completely. Usually these programs
123 * will install their own set of exception handlers, device
124 * drivers, set up the MMU, etc. - this means, that you cannot
125 * expect to re-enter U-Boot except by resetting the CPU.
126 * "RAMDisk Images" are more or less just data blocks, and their
127 * parameters (address, size) are passed to an OS kernel that is
128 * being started.
129 * "Multi-File Images" contain several images, typically an OS
130 * (Linux) kernel image and one or more data images like
131 * RAMDisks. This construct is useful for instance when you want
132 * to boot over the network using BOOTP etc., where the boot
133 * server provides just a single image file, but you want to get
134 * for instance an OS kernel and a RAMDisk image.
135 *
136 * "Multi-File Images" start with a list of image sizes, each
137 * image size (in bytes) specified by an "uint32_t" in network
138 * byte order. This list is terminated by an "(uint32_t)0".
139 * Immediately after the terminating 0 follow the images, one by
140 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000141 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000142 *
143 * "Firmware Images" are binary images containing firmware (like
144 * U-Boot or FPGA images) which usually will be programmed to
145 * flash memory.
146 *
147 * "Script files" are command sequences that will be executed by
148 * U-Boot's command interpreter; this feature is especially
149 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000150 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000151 */
152
153#define IH_TYPE_INVALID 0 /* Invalid Image */
154#define IH_TYPE_STANDALONE 1 /* Standalone Program */
155#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
156#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
157#define IH_TYPE_MULTI 4 /* Multi-File Image */
158#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
159#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000160#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500161#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530162#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100163#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000164#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400165#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000166#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e892011-11-10 13:17:53 -0700167#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000168#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000169
170/*
171 * Compression Types
172 */
173#define IH_COMP_NONE 0 /* No Compression Used */
174#define IH_COMP_GZIP 1 /* gzip Compression Used */
175#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200176#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100177#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000178
179#define IH_MAGIC 0x27051956 /* Image Magic Number */
180#define IH_NMLEN 32 /* Image Name Length */
181
wdenk5b1d7132002-11-03 00:07:02 +0000182/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100183 * Legacy format image header,
184 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000185 */
wdenk5b1d7132002-11-03 00:07:02 +0000186typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000187 __be32 ih_magic; /* Image Header Magic Number */
188 __be32 ih_hcrc; /* Image Header CRC Checksum */
189 __be32 ih_time; /* Image Creation Timestamp */
190 __be32 ih_size; /* Image Data Size */
191 __be32 ih_load; /* Data Load Address */
192 __be32 ih_ep; /* Entry Point Address */
193 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000194 uint8_t ih_os; /* Operating System */
195 uint8_t ih_arch; /* CPU architecture */
196 uint8_t ih_type; /* Image Type */
197 uint8_t ih_comp; /* Compression Type */
198 uint8_t ih_name[IH_NMLEN]; /* Image Name */
199} image_header_t;
200
Kumar Gala396f6352008-08-15 08:24:41 -0500201typedef struct image_info {
202 ulong start, end; /* start/end of blob */
203 ulong image_start, image_len; /* start of image within blob, len of image */
204 ulong load; /* load addr for the image */
205 uint8_t comp, type, os; /* compression, type of image, os type */
206} image_info_t;
207
Marian Balakowicz559316f2008-01-08 18:11:44 +0100208/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100209 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
210 * routines.
211 */
212typedef struct bootm_headers {
213 /*
214 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100215 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100216 * data from second and third component accordingly.
217 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200218 image_header_t *legacy_hdr_os; /* image header pointer */
219 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100220 ulong legacy_hdr_valid;
221
222#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100223 const char *fit_uname_cfg; /* configuration node unit name */
224
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100225 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100226 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100227 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100228
229 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100230 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
231 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100232
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100233 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100234 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
235 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100236#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100237
Kumar Gala49c3a862008-10-21 17:25:45 -0500238#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500239 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500240 ulong ep; /* entry point of OS */
241
Kumar Galac4f94192008-08-15 08:24:37 -0500242 ulong rd_start, rd_end;/* ramdisk start/end */
243
Kumar Gala06a09912008-08-15 08:24:38 -0500244#ifdef CONFIG_OF_LIBFDT
245 char *ft_addr; /* flat dev tree address */
246#endif
247 ulong ft_len; /* length of flat device tree */
248
Kumar Gala49c3a862008-10-21 17:25:45 -0500249 ulong initrd_start;
250 ulong initrd_end;
251 ulong cmdline_start;
252 ulong cmdline_end;
253 bd_t *kbd;
254#endif
255
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100256 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500257
258#define BOOTM_STATE_START (0x00000001)
259#define BOOTM_STATE_LOADOS (0x00000002)
260#define BOOTM_STATE_RAMDISK (0x00000004)
261#define BOOTM_STATE_FDT (0x00000008)
262#define BOOTM_STATE_OS_CMDLINE (0x00000010)
263#define BOOTM_STATE_OS_BD_T (0x00000020)
264#define BOOTM_STATE_OS_PREP (0x00000040)
265#define BOOTM_STATE_OS_GO (0x00000080)
266 int state;
267
Mike Frysingera16028d2009-11-03 11:35:59 -0500268#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500269 struct lmb lmb; /* for memory mgmt */
270#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100271} bootm_headers_t;
272
Simon Schwarz1648a372012-03-15 04:01:34 +0000273extern bootm_headers_t images;
274
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100275/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100276 * Some systems (for example LWMON) have very short watchdog periods;
277 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200278 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100279 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200280#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100281#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200282#endif
283
284#ifndef CHUNKSZ_CRC32
285#define CHUNKSZ_CRC32 (64 * 1024)
286#endif
287
288#ifndef CHUNKSZ_MD5
289#define CHUNKSZ_MD5 (64 * 1024)
290#endif
291
292#ifndef CHUNKSZ_SHA1
293#define CHUNKSZ_SHA1 (64 * 1024)
294#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100295
Mike Frysinger37566092009-07-02 19:23:25 -0400296#define uimage_to_cpu(x) be32_to_cpu(x)
297#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000298
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530299/*
300 * Translation table for entries of a specific type; used by
301 * get_table_entry_id() and get_table_entry_name().
302 */
303typedef struct table_entry {
304 int id;
305 char *sname; /* short (input) name to find table entry */
306 char *lname; /* long (output) name to print for messages */
307} table_entry_t;
308
309/*
310 * get_table_entry_id() scans the translation table trying to find an
311 * entry that matches the given short name. If a matching entry is
312 * found, it's id is returned to the caller.
313 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400314int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530315 const char *table_name, const char *name);
316/*
317 * get_table_entry_name() scans the translation table trying to find
318 * an entry that matches the given id. If a matching entry is found,
319 * its long name is returned to the caller.
320 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400321char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530322
Stephen Warren712fbcf2011-10-18 11:11:49 +0000323const char *genimg_get_os_name(uint8_t os);
324const char *genimg_get_arch_name(uint8_t arch);
325const char *genimg_get_type_name(uint8_t type);
326const char *genimg_get_comp_name(uint8_t comp);
327int genimg_get_os_id(const char *name);
328int genimg_get_arch_id(const char *name);
329int genimg_get_type_id(const char *name);
330int genimg_get_comp_id(const char *name);
331void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100332
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100333#ifndef USE_HOSTCC
334/* Image format types, returned by _get_format() routine */
335#define IMAGE_FORMAT_INVALID 0x00
336#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
337#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
338
Stephen Warren712fbcf2011-10-18 11:11:49 +0000339int genimg_get_format(void *img_addr);
340int genimg_has_config(bootm_headers_t *images);
341ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100342
Stephen Warren712fbcf2011-10-18 11:11:49 +0000343int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100344 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100345
Kumar Gala06a09912008-08-15 08:24:38 -0500346
347#ifdef CONFIG_OF_LIBFDT
Stephen Warren712fbcf2011-10-18 11:11:49 +0000348int boot_get_fdt(int flag, int argc, char * const argv[],
349 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000350void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000351int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500352#endif
353
John Rigbyfca43cc2010-10-13 13:57:35 -0600354#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Stephen Warren712fbcf2011-10-18 11:11:49 +0000355int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100356 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600357#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
358#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000359int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600360#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
361#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000362int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600363#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100364#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100365
366/*******************************************************************/
367/* Legacy format specific code (prefixed with image_) */
368/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000369static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100370{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000371 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100372}
373
374#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200375 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100376 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000377 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100378 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000379image_get_hdr_l(magic) /* image_get_magic */
380image_get_hdr_l(hcrc) /* image_get_hcrc */
381image_get_hdr_l(time) /* image_get_time */
382image_get_hdr_l(size) /* image_get_size */
383image_get_hdr_l(load) /* image_get_load */
384image_get_hdr_l(ep) /* image_get_ep */
385image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100386
387#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200388 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100389 { \
390 return hdr->ih_##f; \
391 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000392image_get_hdr_b(os) /* image_get_os */
393image_get_hdr_b(arch) /* image_get_arch */
394image_get_hdr_b(type) /* image_get_type */
395image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100396
Stephen Warren712fbcf2011-10-18 11:11:49 +0000397static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100398{
399 return (char *)hdr->ih_name;
400}
401
Stephen Warren712fbcf2011-10-18 11:11:49 +0000402static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100403{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000404 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100405}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100406
407/**
408 * image_get_data - get image payload start address
409 * @hdr: image header
410 *
411 * image_get_data() returns address of the image payload. For single
412 * component images it is image data start. For multi component
413 * images it points to the null terminated table of sub-images sizes.
414 *
415 * returns:
416 * image payload data start address
417 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000418static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100419{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000420 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100421}
422
Stephen Warren712fbcf2011-10-18 11:11:49 +0000423static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100424{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000425 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100426}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000427static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100428{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000429 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100430}
431
432#define image_set_hdr_l(f) \
433 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
434 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000435 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100436 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000437image_set_hdr_l(magic) /* image_set_magic */
438image_set_hdr_l(hcrc) /* image_set_hcrc */
439image_set_hdr_l(time) /* image_set_time */
440image_set_hdr_l(size) /* image_set_size */
441image_set_hdr_l(load) /* image_set_load */
442image_set_hdr_l(ep) /* image_set_ep */
443image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100444
445#define image_set_hdr_b(f) \
446 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
447 { \
448 hdr->ih_##f = val; \
449 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000450image_set_hdr_b(os) /* image_set_os */
451image_set_hdr_b(arch) /* image_set_arch */
452image_set_hdr_b(type) /* image_set_type */
453image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100454
Stephen Warren712fbcf2011-10-18 11:11:49 +0000455static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100456{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000457 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100458}
459
Stephen Warren712fbcf2011-10-18 11:11:49 +0000460int image_check_hcrc(const image_header_t *hdr);
461int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100462#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000463int getenv_yesno(char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600464ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500465phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000466phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000467void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100468#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100469
Stephen Warren712fbcf2011-10-18 11:11:49 +0000470static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100471{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000472 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100473}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000474static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100475{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000476 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100477}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000478static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100479{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000480 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100481}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000482static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100483{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000484 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100485}
486
Stephen Warren712fbcf2011-10-18 11:11:49 +0000487ulong image_multi_count(const image_header_t *hdr);
488void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100489 ulong *data, ulong *len);
490
Stephen Warren712fbcf2011-10-18 11:11:49 +0000491void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100492
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100493#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000494static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100495{
Mike Frysinger476af292011-10-03 14:50:33 +0000496#ifndef IH_ARCH_DEFAULT
497# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100498#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000499 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100500}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100501#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100502
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100503/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100504/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100505/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100506#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100507
508#define FIT_IMAGES_PATH "/images"
509#define FIT_CONFS_PATH "/configurations"
510
511/* hash node */
512#define FIT_HASH_NODENAME "hash"
513#define FIT_ALGO_PROP "algo"
514#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000515#define FIT_IGNORE_PROP "uboot-ignore"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100516
517/* image node */
518#define FIT_DATA_PROP "data"
519#define FIT_TIMESTAMP_PROP "timestamp"
520#define FIT_DESC_PROP "description"
521#define FIT_ARCH_PROP "arch"
522#define FIT_TYPE_PROP "type"
523#define FIT_OS_PROP "os"
524#define FIT_COMP_PROP "compression"
525#define FIT_ENTRY_PROP "entry"
526#define FIT_LOAD_PROP "load"
527
528/* configuration node */
529#define FIT_KERNEL_PROP "kernel"
530#define FIT_RAMDISK_PROP "ramdisk"
531#define FIT_FDT_PROP "fdt"
532#define FIT_DEFAULT_PROP "default"
533
534#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
535
536/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000537int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100538 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000539int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100540 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100541
Stephen Warren712fbcf2011-10-18 11:11:49 +0000542void fit_print_contents(const void *fit);
543void fit_image_print(const void *fit, int noffset, const char *p);
544void fit_image_print_hash(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100545
546/**
547 * fit_get_end - get FIT image size
548 * @fit: pointer to the FIT format image header
549 *
550 * returns:
551 * size of the FIT image (blob) in memory
552 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000553static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100554{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000555 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100556}
557
558/**
559 * fit_get_end - get FIT image end
560 * @fit: pointer to the FIT format image header
561 *
562 * returns:
563 * end address of the FIT image (blob) in memory
564 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000565static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100566{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000567 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100568}
569
570/**
571 * fit_get_name - get FIT node name
572 * @fit: pointer to the FIT format image header
573 *
574 * returns:
575 * NULL, on error
576 * pointer to node name, on success
577 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000578static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100579 int noffset, int *len)
580{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000581 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100582}
583
Stephen Warren712fbcf2011-10-18 11:11:49 +0000584int fit_get_desc(const void *fit, int noffset, char **desc);
585int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100586
Stephen Warren712fbcf2011-10-18 11:11:49 +0000587int fit_image_get_node(const void *fit, const char *image_uname);
588int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
589int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
590int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
591int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
592int fit_image_get_load(const void *fit, int noffset, ulong *load);
593int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
594int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100595 const void **data, size_t *size);
596
Stephen Warren712fbcf2011-10-18 11:11:49 +0000597int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
598int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100599 int *value_len);
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000600#ifndef USE_HOSTCC
601int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore);
602#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100603
Stephen Warren712fbcf2011-10-18 11:11:49 +0000604int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
605int fit_set_hashes(void *fit);
606int fit_image_set_hashes(void *fit, int image_noffset);
607int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100608 int value_len);
609
Stephen Warren712fbcf2011-10-18 11:11:49 +0000610int fit_image_check_hashes(const void *fit, int noffset);
611int fit_all_image_check_hashes(const void *fit);
612int fit_image_check_os(const void *fit, int noffset, uint8_t os);
613int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
614int fit_image_check_type(const void *fit, int noffset, uint8_t type);
615int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
616int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100617
Stephen Warren712fbcf2011-10-18 11:11:49 +0000618int fit_conf_get_node(const void *fit, const char *conf_uname);
619int fit_conf_get_kernel_node(const void *fit, int noffset);
620int fit_conf_get_ramdisk_node(const void *fit, int noffset);
621int fit_conf_get_fdt_node(const void *fit, int noffset);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100622
Stephen Warren712fbcf2011-10-18 11:11:49 +0000623void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100624
625#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000626static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100627{
Thierry Reding75668322011-10-27 08:58:25 +0000628 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100629}
630#endif /* USE_HOSTCC */
631
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100632#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000633#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100634 "FIT images not supported for '%s'\n", \
635 __FILE__, __LINE__, (msg))
636
Stephen Warren712fbcf2011-10-18 11:11:49 +0000637#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100638 "FIT images not supported for '%s' " \
639 "- must reset board to recover!\n", \
640 __FILE__, __LINE__, (msg))
641#else
642#define fit_unsupported(msg)
643#define fit_unsupported_reset(msg)
644#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100645#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100646
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100647#endif /* __IMAGE_H__ */