blob: bfce86186e78bc4b9e5080f01f695419db38feae [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
Simon Glassab9efc62013-05-07 06:11:58 +000046#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000047#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000048
Wolfgang Denkdef08192008-10-21 11:23:56 +020049#else
50
51#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020052#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050053#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020054
Simon Glassab9efc62013-05-07 06:11:58 +000055/* Take notice of the 'ignore' property for hashes */
56#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000057#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000058
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010059#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010060
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010061#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010062#include <libfdt.h>
63#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000064# ifdef CONFIG_SPL_BUILD
65# ifdef CONFIG_SPL_CRC32_SUPPORT
66# define IMAGE_ENABLE_CRC32 1
67# endif
68# ifdef CONFIG_SPL_MD5_SUPPORT
69# define IMAGE_ENABLE_MD5 1
70# endif
71# ifdef CONFIG_SPL_SHA1_SUPPORT
72# define IMAGE_ENABLE_SHA1 1
73# endif
74# else
75# define CONFIG_CRC32 /* FIT images need CRC32 support */
76# define CONFIG_MD5 /* and MD5 */
77# define CONFIG_SHA1 /* and SHA1 */
78# define IMAGE_ENABLE_CRC32 1
79# define IMAGE_ENABLE_MD5 1
80# define IMAGE_ENABLE_SHA1 1
81# endif
82
83#ifndef IMAGE_ENABLE_CRC32
84#define IMAGE_ENABLE_CRC32 0
85#endif
86
87#ifndef IMAGE_ENABLE_MD5
88#define IMAGE_ENABLE_MD5 0
89#endif
90
91#ifndef IMAGE_ENABLE_SHA1
92#define IMAGE_ENABLE_SHA1 0
93#endif
94
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010095#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010096
wdenk5b1d7132002-11-03 00:07:02 +000097/*
98 * Operating System Codes
99 */
100#define IH_OS_INVALID 0 /* Invalid OS */
101#define IH_OS_OPENBSD 1 /* OpenBSD */
102#define IH_OS_NETBSD 2 /* NetBSD */
103#define IH_OS_FREEBSD 3 /* FreeBSD */
104#define IH_OS_4_4BSD 4 /* 4.4BSD */
105#define IH_OS_LINUX 5 /* Linux */
106#define IH_OS_SVR4 6 /* SVR4 */
107#define IH_OS_ESIX 7 /* Esix */
108#define IH_OS_SOLARIS 8 /* Solaris */
109#define IH_OS_IRIX 9 /* Irix */
110#define IH_OS_SCO 10 /* SCO */
111#define IH_OS_DELL 11 /* Dell */
112#define IH_OS_NCR 12 /* NCR */
113#define IH_OS_LYNXOS 13 /* LynxOS */
114#define IH_OS_VXWORKS 14 /* VxWorks */
115#define IH_OS_PSOS 15 /* pSOS */
116#define IH_OS_QNX 16 /* QNX */
117#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000118#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000119#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000120#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500121#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200122#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000123#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000124
125/*
126 * CPU Architecture Codes (supported by Linux)
127 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100128#define IH_ARCH_INVALID 0 /* Invalid CPU */
129#define IH_ARCH_ALPHA 1 /* Alpha */
130#define IH_ARCH_ARM 2 /* ARM */
131#define IH_ARCH_I386 3 /* Intel x86 */
132#define IH_ARCH_IA64 4 /* IA64 */
133#define IH_ARCH_MIPS 5 /* MIPS */
134#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
135#define IH_ARCH_PPC 7 /* PowerPC */
136#define IH_ARCH_S390 8 /* IBM S390 */
137#define IH_ARCH_SH 9 /* SuperH */
138#define IH_ARCH_SPARC 10 /* Sparc */
139#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
140#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100141#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
142#define IH_ARCH_NIOS2 15 /* Nios-II */
143#define IH_ARCH_BLACKFIN 16 /* Blackfin */
144#define IH_ARCH_AVR32 17 /* AVR32 */
145#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000146#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000147#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000148#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
wdenk5b1d7132002-11-03 00:07:02 +0000149
150/*
151 * Image Types
152 *
153 * "Standalone Programs" are directly runnable in the environment
154 * provided by U-Boot; it is expected that (if they behave
155 * well) you can continue to work in U-Boot after return from
156 * the Standalone Program.
157 * "OS Kernel Images" are usually images of some Embedded OS which
158 * will take over control completely. Usually these programs
159 * will install their own set of exception handlers, device
160 * drivers, set up the MMU, etc. - this means, that you cannot
161 * expect to re-enter U-Boot except by resetting the CPU.
162 * "RAMDisk Images" are more or less just data blocks, and their
163 * parameters (address, size) are passed to an OS kernel that is
164 * being started.
165 * "Multi-File Images" contain several images, typically an OS
166 * (Linux) kernel image and one or more data images like
167 * RAMDisks. This construct is useful for instance when you want
168 * to boot over the network using BOOTP etc., where the boot
169 * server provides just a single image file, but you want to get
170 * for instance an OS kernel and a RAMDisk image.
171 *
172 * "Multi-File Images" start with a list of image sizes, each
173 * image size (in bytes) specified by an "uint32_t" in network
174 * byte order. This list is terminated by an "(uint32_t)0".
175 * Immediately after the terminating 0 follow the images, one by
176 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000177 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000178 *
179 * "Firmware Images" are binary images containing firmware (like
180 * U-Boot or FPGA images) which usually will be programmed to
181 * flash memory.
182 *
183 * "Script files" are command sequences that will be executed by
184 * U-Boot's command interpreter; this feature is especially
185 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000186 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000187 */
188
189#define IH_TYPE_INVALID 0 /* Invalid Image */
190#define IH_TYPE_STANDALONE 1 /* Standalone Program */
191#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
192#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
193#define IH_TYPE_MULTI 4 /* Multi-File Image */
194#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
195#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000196#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500197#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530198#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100199#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000200#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400201#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000202#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e892011-11-10 13:17:53 -0700203#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000204#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000205
206/*
207 * Compression Types
208 */
209#define IH_COMP_NONE 0 /* No Compression Used */
210#define IH_COMP_GZIP 1 /* gzip Compression Used */
211#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200212#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100213#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000214
215#define IH_MAGIC 0x27051956 /* Image Magic Number */
216#define IH_NMLEN 32 /* Image Name Length */
217
Fabio Estevam1411fb32013-01-03 08:24:33 +0000218/* Reused from common.h */
219#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
220
wdenk5b1d7132002-11-03 00:07:02 +0000221/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100222 * Legacy format image header,
223 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000224 */
wdenk5b1d7132002-11-03 00:07:02 +0000225typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000226 __be32 ih_magic; /* Image Header Magic Number */
227 __be32 ih_hcrc; /* Image Header CRC Checksum */
228 __be32 ih_time; /* Image Creation Timestamp */
229 __be32 ih_size; /* Image Data Size */
230 __be32 ih_load; /* Data Load Address */
231 __be32 ih_ep; /* Entry Point Address */
232 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000233 uint8_t ih_os; /* Operating System */
234 uint8_t ih_arch; /* CPU architecture */
235 uint8_t ih_type; /* Image Type */
236 uint8_t ih_comp; /* Compression Type */
237 uint8_t ih_name[IH_NMLEN]; /* Image Name */
238} image_header_t;
239
Kumar Gala396f6352008-08-15 08:24:41 -0500240typedef struct image_info {
241 ulong start, end; /* start/end of blob */
242 ulong image_start, image_len; /* start of image within blob, len of image */
243 ulong load; /* load addr for the image */
244 uint8_t comp, type, os; /* compression, type of image, os type */
245} image_info_t;
246
Marian Balakowicz559316f2008-01-08 18:11:44 +0100247/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100248 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
249 * routines.
250 */
251typedef struct bootm_headers {
252 /*
253 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100254 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100255 * data from second and third component accordingly.
256 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200257 image_header_t *legacy_hdr_os; /* image header pointer */
258 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100259 ulong legacy_hdr_valid;
260
261#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100262 const char *fit_uname_cfg; /* configuration node unit name */
263
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100264 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100265 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100266 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100267
268 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100269 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
270 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100271
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100272 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100273 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
274 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100275#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100276
Kumar Gala49c3a862008-10-21 17:25:45 -0500277#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500278 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500279 ulong ep; /* entry point of OS */
280
Kumar Galac4f94192008-08-15 08:24:37 -0500281 ulong rd_start, rd_end;/* ramdisk start/end */
282
Kumar Gala06a09912008-08-15 08:24:38 -0500283#ifdef CONFIG_OF_LIBFDT
284 char *ft_addr; /* flat dev tree address */
285#endif
286 ulong ft_len; /* length of flat device tree */
287
Kumar Gala49c3a862008-10-21 17:25:45 -0500288 ulong initrd_start;
289 ulong initrd_end;
290 ulong cmdline_start;
291 ulong cmdline_end;
292 bd_t *kbd;
293#endif
294
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100295 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500296
297#define BOOTM_STATE_START (0x00000001)
298#define BOOTM_STATE_LOADOS (0x00000002)
299#define BOOTM_STATE_RAMDISK (0x00000004)
300#define BOOTM_STATE_FDT (0x00000008)
301#define BOOTM_STATE_OS_CMDLINE (0x00000010)
302#define BOOTM_STATE_OS_BD_T (0x00000020)
303#define BOOTM_STATE_OS_PREP (0x00000040)
304#define BOOTM_STATE_OS_GO (0x00000080)
305 int state;
306
Mike Frysingera16028d2009-11-03 11:35:59 -0500307#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500308 struct lmb lmb; /* for memory mgmt */
309#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100310} bootm_headers_t;
311
Simon Schwarz1648a372012-03-15 04:01:34 +0000312extern bootm_headers_t images;
313
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100314/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100315 * Some systems (for example LWMON) have very short watchdog periods;
316 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200317 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100318 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200319#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100320#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200321#endif
322
323#ifndef CHUNKSZ_CRC32
324#define CHUNKSZ_CRC32 (64 * 1024)
325#endif
326
327#ifndef CHUNKSZ_MD5
328#define CHUNKSZ_MD5 (64 * 1024)
329#endif
330
331#ifndef CHUNKSZ_SHA1
332#define CHUNKSZ_SHA1 (64 * 1024)
333#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100334
Mike Frysinger37566092009-07-02 19:23:25 -0400335#define uimage_to_cpu(x) be32_to_cpu(x)
336#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000337
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530338/*
339 * Translation table for entries of a specific type; used by
340 * get_table_entry_id() and get_table_entry_name().
341 */
342typedef struct table_entry {
343 int id;
344 char *sname; /* short (input) name to find table entry */
345 char *lname; /* long (output) name to print for messages */
346} table_entry_t;
347
348/*
349 * get_table_entry_id() scans the translation table trying to find an
350 * entry that matches the given short name. If a matching entry is
351 * found, it's id is returned to the caller.
352 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400353int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530354 const char *table_name, const char *name);
355/*
356 * get_table_entry_name() scans the translation table trying to find
357 * an entry that matches the given id. If a matching entry is found,
358 * its long name is returned to the caller.
359 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400360char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530361
Stephen Warren712fbcf2011-10-18 11:11:49 +0000362const char *genimg_get_os_name(uint8_t os);
363const char *genimg_get_arch_name(uint8_t arch);
364const char *genimg_get_type_name(uint8_t type);
365const char *genimg_get_comp_name(uint8_t comp);
366int genimg_get_os_id(const char *name);
367int genimg_get_arch_id(const char *name);
368int genimg_get_type_id(const char *name);
369int genimg_get_comp_id(const char *name);
370void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100371
Simon Glass859e92b2013-05-07 06:11:51 +0000372#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
373 defined(USE_HOSTCC)
374#define IMAGE_ENABLE_TIMESTAMP 1
375#else
376#define IMAGE_ENABLE_TIMESTAMP 0
377#endif
378void genimg_print_time(time_t timestamp);
379
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100380#ifndef USE_HOSTCC
381/* Image format types, returned by _get_format() routine */
382#define IMAGE_FORMAT_INVALID 0x00
383#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
384#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
385
Simon Glass35e7b0f2013-05-07 06:12:03 +0000386int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000387int genimg_has_config(bootm_headers_t *images);
388ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100389
Stephen Warren712fbcf2011-10-18 11:11:49 +0000390int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100391 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100392
Kumar Gala06a09912008-08-15 08:24:38 -0500393
394#ifdef CONFIG_OF_LIBFDT
Stephen Warren712fbcf2011-10-18 11:11:49 +0000395int boot_get_fdt(int flag, int argc, char * const argv[],
396 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000397void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000398int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500399#endif
400
John Rigbyfca43cc2010-10-13 13:57:35 -0600401#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Stephen Warren712fbcf2011-10-18 11:11:49 +0000402int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100403 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600404#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
405#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000406int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600407#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
408#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000409int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600410#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100411#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100412
413/*******************************************************************/
414/* Legacy format specific code (prefixed with image_) */
415/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000416static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100417{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000418 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100419}
420
421#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200422 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100423 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000424 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100425 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000426image_get_hdr_l(magic) /* image_get_magic */
427image_get_hdr_l(hcrc) /* image_get_hcrc */
428image_get_hdr_l(time) /* image_get_time */
429image_get_hdr_l(size) /* image_get_size */
430image_get_hdr_l(load) /* image_get_load */
431image_get_hdr_l(ep) /* image_get_ep */
432image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100433
434#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200435 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100436 { \
437 return hdr->ih_##f; \
438 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000439image_get_hdr_b(os) /* image_get_os */
440image_get_hdr_b(arch) /* image_get_arch */
441image_get_hdr_b(type) /* image_get_type */
442image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100443
Stephen Warren712fbcf2011-10-18 11:11:49 +0000444static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100445{
446 return (char *)hdr->ih_name;
447}
448
Stephen Warren712fbcf2011-10-18 11:11:49 +0000449static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100450{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000451 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100452}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100453
454/**
455 * image_get_data - get image payload start address
456 * @hdr: image header
457 *
458 * image_get_data() returns address of the image payload. For single
459 * component images it is image data start. For multi component
460 * images it points to the null terminated table of sub-images sizes.
461 *
462 * returns:
463 * image payload data start address
464 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000465static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100466{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000467 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100468}
469
Stephen Warren712fbcf2011-10-18 11:11:49 +0000470static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100471{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000472 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100473}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000474static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100475{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000476 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100477}
478
479#define image_set_hdr_l(f) \
480 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
481 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000482 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100483 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000484image_set_hdr_l(magic) /* image_set_magic */
485image_set_hdr_l(hcrc) /* image_set_hcrc */
486image_set_hdr_l(time) /* image_set_time */
487image_set_hdr_l(size) /* image_set_size */
488image_set_hdr_l(load) /* image_set_load */
489image_set_hdr_l(ep) /* image_set_ep */
490image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100491
492#define image_set_hdr_b(f) \
493 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
494 { \
495 hdr->ih_##f = val; \
496 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000497image_set_hdr_b(os) /* image_set_os */
498image_set_hdr_b(arch) /* image_set_arch */
499image_set_hdr_b(type) /* image_set_type */
500image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100501
Stephen Warren712fbcf2011-10-18 11:11:49 +0000502static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100503{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000504 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100505}
506
Stephen Warren712fbcf2011-10-18 11:11:49 +0000507int image_check_hcrc(const image_header_t *hdr);
508int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100509#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600510ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500511phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000512phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000513void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100514#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100515
Stephen Warren712fbcf2011-10-18 11:11:49 +0000516static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100517{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000518 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100519}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000520static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100521{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000522 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100523}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000524static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100525{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000526 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100527}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000528static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100529{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000530 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100531}
532
Stephen Warren712fbcf2011-10-18 11:11:49 +0000533ulong image_multi_count(const image_header_t *hdr);
534void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100535 ulong *data, ulong *len);
536
Stephen Warren712fbcf2011-10-18 11:11:49 +0000537void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100538
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100539#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000540static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100541{
Mike Frysinger476af292011-10-03 14:50:33 +0000542#ifndef IH_ARCH_DEFAULT
543# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100544#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000545 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100546}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100547#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100548
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100549/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100550/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100551/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100552#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100553
554#define FIT_IMAGES_PATH "/images"
555#define FIT_CONFS_PATH "/configurations"
556
557/* hash node */
558#define FIT_HASH_NODENAME "hash"
559#define FIT_ALGO_PROP "algo"
560#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000561#define FIT_IGNORE_PROP "uboot-ignore"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100562
563/* image node */
564#define FIT_DATA_PROP "data"
565#define FIT_TIMESTAMP_PROP "timestamp"
566#define FIT_DESC_PROP "description"
567#define FIT_ARCH_PROP "arch"
568#define FIT_TYPE_PROP "type"
569#define FIT_OS_PROP "os"
570#define FIT_COMP_PROP "compression"
571#define FIT_ENTRY_PROP "entry"
572#define FIT_LOAD_PROP "load"
573
574/* configuration node */
575#define FIT_KERNEL_PROP "kernel"
576#define FIT_RAMDISK_PROP "ramdisk"
577#define FIT_FDT_PROP "fdt"
578#define FIT_DEFAULT_PROP "default"
579
580#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
581
582/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000583int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100584 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000585int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100586 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100587
Stephen Warren712fbcf2011-10-18 11:11:49 +0000588void fit_print_contents(const void *fit);
589void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100590
591/**
592 * fit_get_end - get FIT image size
593 * @fit: pointer to the FIT format image header
594 *
595 * returns:
596 * size of the FIT image (blob) in memory
597 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000598static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100599{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000600 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100601}
602
603/**
604 * fit_get_end - get FIT image end
605 * @fit: pointer to the FIT format image header
606 *
607 * returns:
608 * end address of the FIT image (blob) in memory
609 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000610static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100611{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000612 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100613}
614
615/**
616 * fit_get_name - get FIT node name
617 * @fit: pointer to the FIT format image header
618 *
619 * returns:
620 * NULL, on error
621 * pointer to node name, on success
622 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000623static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100624 int noffset, int *len)
625{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000626 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100627}
628
Stephen Warren712fbcf2011-10-18 11:11:49 +0000629int fit_get_desc(const void *fit, int noffset, char **desc);
630int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100631
Stephen Warren712fbcf2011-10-18 11:11:49 +0000632int fit_image_get_node(const void *fit, const char *image_uname);
633int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
634int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
635int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
636int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
637int fit_image_get_load(const void *fit, int noffset, ulong *load);
638int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
639int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100640 const void **data, size_t *size);
641
Stephen Warren712fbcf2011-10-18 11:11:49 +0000642int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
643int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100644 int *value_len);
645
Stephen Warren712fbcf2011-10-18 11:11:49 +0000646int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000647
648/**
649 * fit_add_verification_data() - Calculate and add hashes to FIT
650 *
651 * @fit: Fit image to process
652 * @return 0 if ok, <0 for error
653 */
654int fit_add_verification_data(void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100655
Simon Glassb8da8362013-05-07 06:11:57 +0000656int fit_image_verify(const void *fit, int noffset);
657int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000658int fit_image_check_os(const void *fit, int noffset, uint8_t os);
659int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
660int fit_image_check_type(const void *fit, int noffset, uint8_t type);
661int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
662int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100663
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000664int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000665int fit_conf_get_node(const void *fit, const char *conf_uname);
666int fit_conf_get_kernel_node(const void *fit, int noffset);
667int fit_conf_get_ramdisk_node(const void *fit, int noffset);
668int fit_conf_get_fdt_node(const void *fit, int noffset);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100669
Simon Glass003efd72013-05-07 06:12:00 +0000670/**
671 * fit_conf_get_prop_node() - Get node refered to by a configuration
672 * @fit: FIT to check
673 * @noffset: Offset of conf@xxx node to check
674 * @prop_name: Property to read from the conf node
675 *
676 * The conf@ nodes contain references to other nodes, using properties
677 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
678 * return the offset of the node referred to (e.g. offset of node
679 * "/images/kernel@1".
680 */
681int fit_conf_get_prop_node(const void *fit, int noffset,
682 const char *prop_name);
683
Stephen Warren712fbcf2011-10-18 11:11:49 +0000684void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100685
Simon Glass61a439a2013-05-07 06:11:52 +0000686int fit_check_ramdisk(const void *fit, int os_noffset,
687 uint8_t arch, int verify);
688
Simon Glass604f23d2013-05-07 06:11:54 +0000689int calculate_hash(const void *data, int data_len, const char *algo,
690 uint8_t *value, int *value_len);
691
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100692#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000693static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100694{
Thierry Reding75668322011-10-27 08:58:25 +0000695 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100696}
697#endif /* USE_HOSTCC */
698
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100699#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000700#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100701 "FIT images not supported for '%s'\n", \
702 __FILE__, __LINE__, (msg))
703
Stephen Warren712fbcf2011-10-18 11:11:49 +0000704#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100705 "FIT images not supported for '%s' " \
706 "- must reset board to recover!\n", \
707 __FILE__, __LINE__, (msg))
708#else
709#define fit_unsupported(msg)
710#define fit_unsupported_reset(msg)
711#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100712#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100713
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100714#endif /* __IMAGE_H__ */