blob: af30d601585e3bf0124b590a41a3cf863e494a31 [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 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02007 * SPDX-License-Identifier: GPL-2.0+
Wolfgang Denkf08abe32005-11-25 16:38:03 +01008 ********************************************************************
9 * NOTE: This header file defines an interface to U-Boot. Including
10 * this (unmodified) header file in another file is considered normal
11 * use of U-Boot, and does *not* fall under the heading of "derived
12 * work".
13 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000014 */
15
16#ifndef __IMAGE_H__
17#define __IMAGE_H__
18
Mike Frysinger37566092009-07-02 19:23:25 -040019#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000020#include <asm/byteorder.h>
Mike Frysinger37566092009-07-02 19:23:25 -040021
Simon Glass13d06982013-05-08 08:06:01 +000022/* Define this to avoid #ifdefs later on */
23struct lmb;
24
Mike Frysinger37566092009-07-02 19:23:25 -040025#ifdef USE_HOSTCC
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010026
27/* new uImage format support enabled on host */
28#define CONFIG_FIT 1
29#define CONFIG_OF_LIBFDT 1
30#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
31
Simon Glassab9efc62013-05-07 06:11:58 +000032#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000033#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000034
Wolfgang Denkdef08192008-10-21 11:23:56 +020035#else
36
37#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020038#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050039#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020040
Simon Glassab9efc62013-05-07 06:11:58 +000041/* Take notice of the 'ignore' property for hashes */
42#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000043#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000044
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010045#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010046
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010047#if defined(CONFIG_FIT)
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020048#include <hash.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010049#include <libfdt.h>
50#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000051# ifdef CONFIG_SPL_BUILD
52# ifdef CONFIG_SPL_CRC32_SUPPORT
53# define IMAGE_ENABLE_CRC32 1
54# endif
55# ifdef CONFIG_SPL_MD5_SUPPORT
56# define IMAGE_ENABLE_MD5 1
57# endif
58# ifdef CONFIG_SPL_SHA1_SUPPORT
59# define IMAGE_ENABLE_SHA1 1
60# endif
Heiko Schocher2842c1c2014-03-03 12:19:25 +010061# ifdef CONFIG_SPL_SHA256_SUPPORT
62# define IMAGE_ENABLE_SHA256 1
63# endif
Simon Glass87ebee32013-05-08 08:05:59 +000064# else
65# define CONFIG_CRC32 /* FIT images need CRC32 support */
66# define CONFIG_MD5 /* and MD5 */
67# define CONFIG_SHA1 /* and SHA1 */
Heiko Schocher2842c1c2014-03-03 12:19:25 +010068# define CONFIG_SHA256 /* and SHA256 */
Simon Glass87ebee32013-05-08 08:05:59 +000069# define IMAGE_ENABLE_CRC32 1
70# define IMAGE_ENABLE_MD5 1
71# define IMAGE_ENABLE_SHA1 1
Heiko Schocher2842c1c2014-03-03 12:19:25 +010072# define IMAGE_ENABLE_SHA256 1
Simon Glass87ebee32013-05-08 08:05:59 +000073# endif
74
Dirk Eibach9a4f4792014-07-03 09:28:26 +020075#ifdef CONFIG_FIT_DISABLE_SHA256
76#undef CONFIG_SHA256
77#undef IMAGE_ENABLE_SHA256
78#endif
79
Simon Glass87ebee32013-05-08 08:05:59 +000080#ifndef IMAGE_ENABLE_CRC32
81#define IMAGE_ENABLE_CRC32 0
82#endif
83
84#ifndef IMAGE_ENABLE_MD5
85#define IMAGE_ENABLE_MD5 0
86#endif
87
88#ifndef IMAGE_ENABLE_SHA1
89#define IMAGE_ENABLE_SHA1 0
90#endif
91
Heiko Schocher2842c1c2014-03-03 12:19:25 +010092#ifndef IMAGE_ENABLE_SHA256
93#define IMAGE_ENABLE_SHA256 0
94#endif
95
Simon Glass13d06982013-05-08 08:06:01 +000096#endif /* CONFIG_FIT */
97
98#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
99# define IMAGE_ENABLE_RAMDISK_HIGH 1
100#else
101# define IMAGE_ENABLE_RAMDISK_HIGH 0
102#endif
103
104#ifdef CONFIG_OF_LIBFDT
105# define IMAGE_ENABLE_OF_LIBFDT 1
106#else
107# define IMAGE_ENABLE_OF_LIBFDT 0
108#endif
109
110#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
111# define IMAGE_BOOT_GET_CMDLINE 1
112#else
113# define IMAGE_BOOT_GET_CMDLINE 0
114#endif
115
116#ifdef CONFIG_OF_BOARD_SETUP
Masahiro Yamada95f70622014-01-29 16:29:16 +0900117# define IMAGE_OF_BOARD_SETUP 1
Simon Glass13d06982013-05-08 08:06:01 +0000118#else
Masahiro Yamada95f70622014-01-29 16:29:16 +0900119# define IMAGE_OF_BOARD_SETUP 0
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100120#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100121
Simon Glassc654b512014-10-23 18:58:54 -0600122#ifdef CONFIG_OF_SYSTEM_SETUP
123# define IMAGE_OF_SYSTEM_SETUP 1
124#else
125# define IMAGE_OF_SYSTEM_SETUP 0
126#endif
127
wdenk5b1d7132002-11-03 00:07:02 +0000128/*
129 * Operating System Codes
130 */
131#define IH_OS_INVALID 0 /* Invalid OS */
132#define IH_OS_OPENBSD 1 /* OpenBSD */
133#define IH_OS_NETBSD 2 /* NetBSD */
134#define IH_OS_FREEBSD 3 /* FreeBSD */
135#define IH_OS_4_4BSD 4 /* 4.4BSD */
136#define IH_OS_LINUX 5 /* Linux */
137#define IH_OS_SVR4 6 /* SVR4 */
138#define IH_OS_ESIX 7 /* Esix */
139#define IH_OS_SOLARIS 8 /* Solaris */
140#define IH_OS_IRIX 9 /* Irix */
141#define IH_OS_SCO 10 /* SCO */
142#define IH_OS_DELL 11 /* Dell */
143#define IH_OS_NCR 12 /* NCR */
144#define IH_OS_LYNXOS 13 /* LynxOS */
145#define IH_OS_VXWORKS 14 /* VxWorks */
146#define IH_OS_PSOS 15 /* pSOS */
147#define IH_OS_QNX 16 /* QNX */
148#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000149#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000150#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000151#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500152#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200153#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000154#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000155
156/*
157 * CPU Architecture Codes (supported by Linux)
158 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100159#define IH_ARCH_INVALID 0 /* Invalid CPU */
160#define IH_ARCH_ALPHA 1 /* Alpha */
161#define IH_ARCH_ARM 2 /* ARM */
162#define IH_ARCH_I386 3 /* Intel x86 */
163#define IH_ARCH_IA64 4 /* IA64 */
164#define IH_ARCH_MIPS 5 /* MIPS */
165#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
166#define IH_ARCH_PPC 7 /* PowerPC */
167#define IH_ARCH_S390 8 /* IBM S390 */
168#define IH_ARCH_SH 9 /* SuperH */
169#define IH_ARCH_SPARC 10 /* Sparc */
170#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
171#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100172#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
173#define IH_ARCH_NIOS2 15 /* Nios-II */
174#define IH_ARCH_BLACKFIN 16 /* Blackfin */
175#define IH_ARCH_AVR32 17 /* AVR32 */
176#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000177#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000178#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000179#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
David Feng0ae76532013-12-14 11:47:35 +0800180#define IH_ARCH_ARM64 22 /* ARM64 */
Alexey Brodkinbc5d5422014-02-04 12:56:16 +0400181#define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
Simon Glass5bda35c2014-10-10 08:21:57 -0600182#define IH_ARCH_X86_64 24 /* AMD x86_64, Intel and Via */
wdenk5b1d7132002-11-03 00:07:02 +0000183
184/*
185 * Image Types
186 *
187 * "Standalone Programs" are directly runnable in the environment
188 * provided by U-Boot; it is expected that (if they behave
189 * well) you can continue to work in U-Boot after return from
190 * the Standalone Program.
191 * "OS Kernel Images" are usually images of some Embedded OS which
192 * will take over control completely. Usually these programs
193 * will install their own set of exception handlers, device
194 * drivers, set up the MMU, etc. - this means, that you cannot
195 * expect to re-enter U-Boot except by resetting the CPU.
196 * "RAMDisk Images" are more or less just data blocks, and their
197 * parameters (address, size) are passed to an OS kernel that is
198 * being started.
199 * "Multi-File Images" contain several images, typically an OS
200 * (Linux) kernel image and one or more data images like
201 * RAMDisks. This construct is useful for instance when you want
202 * to boot over the network using BOOTP etc., where the boot
203 * server provides just a single image file, but you want to get
204 * for instance an OS kernel and a RAMDisk image.
205 *
206 * "Multi-File Images" start with a list of image sizes, each
207 * image size (in bytes) specified by an "uint32_t" in network
208 * byte order. This list is terminated by an "(uint32_t)0".
209 * Immediately after the terminating 0 follow the images, one by
210 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000211 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000212 *
213 * "Firmware Images" are binary images containing firmware (like
214 * U-Boot or FPGA images) which usually will be programmed to
215 * flash memory.
216 *
217 * "Script files" are command sequences that will be executed by
218 * U-Boot's command interpreter; this feature is especially
219 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000220 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000221 */
222
223#define IH_TYPE_INVALID 0 /* Invalid Image */
224#define IH_TYPE_STANDALONE 1 /* Standalone Program */
225#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
226#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
227#define IH_TYPE_MULTI 4 /* Multi-File Image */
228#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
229#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000230#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500231#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530232#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100233#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000234#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400235#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000236#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e82011-11-10 13:17:53 -0700237#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000238#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
Marek Vasutbce88372013-08-26 20:43:33 +0200239#define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
Karicheri, Muralidharanbf411ea2014-04-04 13:16:48 -0400240#define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
Andreas Bießmann7b1a4112014-05-19 14:23:39 +0200241#define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
Charles Manning832472a2014-03-06 15:40:50 +1300242#define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */
Simon Glass90268b82014-10-19 21:11:24 -0600243#define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */
wdenk5b1d7132002-11-03 00:07:02 +0000244
245/*
246 * Compression Types
247 */
248#define IH_COMP_NONE 0 /* No Compression Used */
249#define IH_COMP_GZIP 1 /* gzip Compression Used */
250#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200251#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100252#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000253
254#define IH_MAGIC 0x27051956 /* Image Magic Number */
255#define IH_NMLEN 32 /* Image Name Length */
256
Fabio Estevam1411fb32013-01-03 08:24:33 +0000257/* Reused from common.h */
258#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
259
wdenk5b1d7132002-11-03 00:07:02 +0000260/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100261 * Legacy format image header,
262 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000263 */
wdenk5b1d7132002-11-03 00:07:02 +0000264typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000265 __be32 ih_magic; /* Image Header Magic Number */
266 __be32 ih_hcrc; /* Image Header CRC Checksum */
267 __be32 ih_time; /* Image Creation Timestamp */
268 __be32 ih_size; /* Image Data Size */
269 __be32 ih_load; /* Data Load Address */
270 __be32 ih_ep; /* Entry Point Address */
271 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000272 uint8_t ih_os; /* Operating System */
273 uint8_t ih_arch; /* CPU architecture */
274 uint8_t ih_type; /* Image Type */
275 uint8_t ih_comp; /* Compression Type */
276 uint8_t ih_name[IH_NMLEN]; /* Image Name */
277} image_header_t;
278
Kumar Gala396f6352008-08-15 08:24:41 -0500279typedef struct image_info {
280 ulong start, end; /* start/end of blob */
281 ulong image_start, image_len; /* start of image within blob, len of image */
282 ulong load; /* load addr for the image */
283 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass90268b82014-10-19 21:11:24 -0600284 uint8_t arch; /* CPU architecture */
Kumar Gala396f6352008-08-15 08:24:41 -0500285} image_info_t;
286
Marian Balakowicz559316f2008-01-08 18:11:44 +0100287/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100288 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
289 * routines.
290 */
291typedef struct bootm_headers {
292 /*
293 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100294 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100295 * data from second and third component accordingly.
296 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200297 image_header_t *legacy_hdr_os; /* image header pointer */
298 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100299 ulong legacy_hdr_valid;
300
301#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100302 const char *fit_uname_cfg; /* configuration node unit name */
303
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100304 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100305 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100306 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100307
308 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100309 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
310 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100311
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100312 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100313 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
314 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass90268b82014-10-19 21:11:24 -0600315
316 void *fit_hdr_setup; /* x86 setup FIT image header */
317 const char *fit_uname_setup; /* x86 setup subimage node name */
318 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100319#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100320
Kumar Gala49c3a862008-10-21 17:25:45 -0500321#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500322 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500323 ulong ep; /* entry point of OS */
324
Kumar Galac4f94192008-08-15 08:24:37 -0500325 ulong rd_start, rd_end;/* ramdisk start/end */
326
Kumar Gala06a09912008-08-15 08:24:38 -0500327 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500328 ulong ft_len; /* length of flat device tree */
329
Kumar Gala49c3a862008-10-21 17:25:45 -0500330 ulong initrd_start;
331 ulong initrd_end;
332 ulong cmdline_start;
333 ulong cmdline_end;
334 bd_t *kbd;
335#endif
336
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100337 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500338
339#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700340#define BOOTM_STATE_FINDOS (0x00000002)
341#define BOOTM_STATE_FINDOTHER (0x00000004)
342#define BOOTM_STATE_LOADOS (0x00000008)
343#define BOOTM_STATE_RAMDISK (0x00000010)
344#define BOOTM_STATE_FDT (0x00000020)
345#define BOOTM_STATE_OS_CMDLINE (0x00000040)
346#define BOOTM_STATE_OS_BD_T (0x00000080)
347#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700348#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
349#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500350 int state;
351
Mike Frysingera16028d2009-11-03 11:35:59 -0500352#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500353 struct lmb lmb; /* for memory mgmt */
354#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100355} bootm_headers_t;
356
Simon Schwarz1648a372012-03-15 04:01:34 +0000357extern bootm_headers_t images;
358
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100359/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100360 * Some systems (for example LWMON) have very short watchdog periods;
361 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200362 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100363 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200364#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100365#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200366#endif
367
368#ifndef CHUNKSZ_CRC32
369#define CHUNKSZ_CRC32 (64 * 1024)
370#endif
371
372#ifndef CHUNKSZ_MD5
373#define CHUNKSZ_MD5 (64 * 1024)
374#endif
375
376#ifndef CHUNKSZ_SHA1
377#define CHUNKSZ_SHA1 (64 * 1024)
378#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100379
Mike Frysinger37566092009-07-02 19:23:25 -0400380#define uimage_to_cpu(x) be32_to_cpu(x)
381#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000382
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530383/*
384 * Translation table for entries of a specific type; used by
385 * get_table_entry_id() and get_table_entry_name().
386 */
387typedef struct table_entry {
388 int id;
389 char *sname; /* short (input) name to find table entry */
390 char *lname; /* long (output) name to print for messages */
391} table_entry_t;
392
393/*
394 * get_table_entry_id() scans the translation table trying to find an
395 * entry that matches the given short name. If a matching entry is
396 * found, it's id is returned to the caller.
397 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400398int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530399 const char *table_name, const char *name);
400/*
401 * get_table_entry_name() scans the translation table trying to find
402 * an entry that matches the given id. If a matching entry is found,
403 * its long name is returned to the caller.
404 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400405char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530406
Stephen Warren712fbcf2011-10-18 11:11:49 +0000407const char *genimg_get_os_name(uint8_t os);
408const char *genimg_get_arch_name(uint8_t arch);
409const char *genimg_get_type_name(uint8_t type);
410const char *genimg_get_comp_name(uint8_t comp);
411int genimg_get_os_id(const char *name);
412int genimg_get_arch_id(const char *name);
413int genimg_get_type_id(const char *name);
414int genimg_get_comp_id(const char *name);
415void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100416
Simon Glass859e92b2013-05-07 06:11:51 +0000417#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
418 defined(USE_HOSTCC)
419#define IMAGE_ENABLE_TIMESTAMP 1
420#else
421#define IMAGE_ENABLE_TIMESTAMP 0
422#endif
423void genimg_print_time(time_t timestamp);
424
Simon Glass782cfbb2013-05-16 13:53:21 +0000425/* What to do with a image load address ('load = <> 'in the FIT) */
426enum fit_load_op {
427 FIT_LOAD_IGNORED, /* Ignore load address */
428 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600429 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000430 FIT_LOAD_REQUIRED, /* Must be provided */
431};
432
Simon Glass90268b82014-10-19 21:11:24 -0600433int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
434 ulong *setup_len);
435
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100436#ifndef USE_HOSTCC
437/* Image format types, returned by _get_format() routine */
438#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher21d29f72014-05-28 11:33:33 +0200439#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100440#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200441#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100442#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500443#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100444
Bryan Wu6c454fe2014-08-15 16:51:38 -0700445ulong genimg_get_kernel_addr_fit(char * const img_addr,
446 const char **fit_uname_config,
447 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700448ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000449int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000450int genimg_has_config(bootm_headers_t *images);
451ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100452
Stephen Warren712fbcf2011-10-18 11:11:49 +0000453int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100454 uint8_t arch, ulong *rd_start, ulong *rd_end);
Simon Glassce1400f2014-06-12 07:24:53 -0600455#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100456
Simon Glass90268b82014-10-19 21:11:24 -0600457int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
458 ulong *setup_start, ulong *setup_len);
459
Simon Glass782cfbb2013-05-16 13:53:21 +0000460/**
461 * fit_image_load() - load an image from a FIT
462 *
463 * This deals with all aspects of loading an image from a FIT, including
464 * selecting the right image based on configuration, verifying it, printing
465 * out progress messages, checking the type/arch/os and optionally copying it
466 * to the right load address.
467 *
Simon Glass126cc862014-06-12 07:24:47 -0600468 * The property to look up is defined by image_type.
469 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000470 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000471 * @param addr Address of FIT in memory
472 * @param fit_unamep On entry this is the requested image name
473 * (e.g. "kernel@1") or NULL to use the default. On exit
474 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700475 * @param fit_uname_configp On entry this is the requested configuration
476 * name (e.g. "conf@1") or NULL to use the default. On
477 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000478 * @param arch Expected architecture (IH_ARCH_...)
479 * @param image_type Required image type (IH_TYPE_...). If this is
480 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
481 * also.
482 * @param bootstage_id ID of starting bootstage to use for progress updates.
483 * This will be added to the BOOTSTAGE_SUB values when
484 * calling bootstage_mark()
485 * @param load_op Decribes what to do with the load address
486 * @param datap Returns address of loaded image
487 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600488 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000489 */
Simon Glass126cc862014-06-12 07:24:47 -0600490int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700491 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000492 int arch, int image_type, int bootstage_id,
493 enum fit_load_op load_op, ulong *datap, ulong *lenp);
494
Simon Glassce1400f2014-06-12 07:24:53 -0600495#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000496/**
497 * fit_get_node_from_config() - Look up an image a FIT by type
498 *
499 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
500 * particular image type (e.g. "kernel") and then finds the image that is
501 * referred to.
502 *
503 * For example, for something like:
504 *
505 * images {
506 * kernel@1 {
507 * ...
508 * };
509 * };
510 * configurations {
511 * conf@1 {
512 * kernel = "kernel@1";
513 * };
514 * };
515 *
516 * the function will return the node offset of the kernel@1 node, assuming
517 * that conf@1 is the chosen configuration.
518 *
519 * @param images Boot images structure
520 * @param prop_name Property name to look up (FIT_..._PROP)
521 * @param addr Address of FIT in memory
522 */
523int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
524 ulong addr);
525
Simon Glass53f375f2013-05-16 13:53:23 +0000526int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
527 bootm_headers_t *images,
528 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000529void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000530int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500531
Stephen Warren712fbcf2011-10-18 11:11:49 +0000532int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100533 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000534int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600535#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000536int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600537#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100538#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100539
540/*******************************************************************/
541/* Legacy format specific code (prefixed with image_) */
542/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000543static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100544{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000545 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100546}
547
548#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200549 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100550 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000551 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100552 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000553image_get_hdr_l(magic) /* image_get_magic */
554image_get_hdr_l(hcrc) /* image_get_hcrc */
555image_get_hdr_l(time) /* image_get_time */
556image_get_hdr_l(size) /* image_get_size */
557image_get_hdr_l(load) /* image_get_load */
558image_get_hdr_l(ep) /* image_get_ep */
559image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100560
561#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200562 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100563 { \
564 return hdr->ih_##f; \
565 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000566image_get_hdr_b(os) /* image_get_os */
567image_get_hdr_b(arch) /* image_get_arch */
568image_get_hdr_b(type) /* image_get_type */
569image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100570
Stephen Warren712fbcf2011-10-18 11:11:49 +0000571static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100572{
573 return (char *)hdr->ih_name;
574}
575
Stephen Warren712fbcf2011-10-18 11:11:49 +0000576static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100577{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000578 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100579}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100580
581/**
582 * image_get_data - get image payload start address
583 * @hdr: image header
584 *
585 * image_get_data() returns address of the image payload. For single
586 * component images it is image data start. For multi component
587 * images it points to the null terminated table of sub-images sizes.
588 *
589 * returns:
590 * image payload data start address
591 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000592static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100593{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000594 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100595}
596
Stephen Warren712fbcf2011-10-18 11:11:49 +0000597static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100598{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000599 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100600}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000601static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100602{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000603 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100604}
605
606#define image_set_hdr_l(f) \
607 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
608 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000609 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100610 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000611image_set_hdr_l(magic) /* image_set_magic */
612image_set_hdr_l(hcrc) /* image_set_hcrc */
613image_set_hdr_l(time) /* image_set_time */
614image_set_hdr_l(size) /* image_set_size */
615image_set_hdr_l(load) /* image_set_load */
616image_set_hdr_l(ep) /* image_set_ep */
617image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100618
619#define image_set_hdr_b(f) \
620 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
621 { \
622 hdr->ih_##f = val; \
623 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000624image_set_hdr_b(os) /* image_set_os */
625image_set_hdr_b(arch) /* image_set_arch */
626image_set_hdr_b(type) /* image_set_type */
627image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100628
Stephen Warren712fbcf2011-10-18 11:11:49 +0000629static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100630{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000631 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100632}
633
Stephen Warren712fbcf2011-10-18 11:11:49 +0000634int image_check_hcrc(const image_header_t *hdr);
635int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100636#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600637ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500638phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000639phys_size_t getenv_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100640#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600641void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100642
Stephen Warren712fbcf2011-10-18 11:11:49 +0000643static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100644{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000645 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100646}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000647static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100648{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000649 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100650}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000651static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100652{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000653 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100654}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000655static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100656{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000657 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100658}
659
Stephen Warren712fbcf2011-10-18 11:11:49 +0000660ulong image_multi_count(const image_header_t *hdr);
661void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100662 ulong *data, ulong *len);
663
Stephen Warren712fbcf2011-10-18 11:11:49 +0000664void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100665
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100666#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000667static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100668{
Mike Frysinger476af292011-10-03 14:50:33 +0000669#ifndef IH_ARCH_DEFAULT
670# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100671#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000672 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100673}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100674#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100675
Simon Glass13d06982013-05-08 08:06:01 +0000676/**
677 * Set up properties in the FDT
678 *
679 * This sets up properties in the FDT that is to be passed to linux.
680 *
681 * @images: Images information
682 * @blob: FDT to update
683 * @of_size: Size of the FDT
684 * @lmb: Points to logical memory block structure
685 * @return 0 if ok, <0 on failure
686 */
687int image_setup_libfdt(bootm_headers_t *images, void *blob,
688 int of_size, struct lmb *lmb);
689
690/**
691 * Set up the FDT to use for booting a kernel
692 *
693 * This performs ramdisk setup, sets up the FDT if required, and adds
694 * paramters to the FDT if libfdt is available.
695 *
696 * @param images Images information
697 * @return 0 if ok, <0 on failure
698 */
699int image_setup_linux(bootm_headers_t *images);
700
Simon Glassa5266d62013-07-04 13:26:10 -0700701/**
702 * bootz_setup() - Extract stat and size of a Linux xImage
703 *
704 * @image: Address of image
705 * @start: Returns start address of image
706 * @end : Returns end address of image
707 * @return 0 if OK, 1 if the image was not recognised
708 */
709int bootz_setup(ulong image, ulong *start, ulong *end);
710
711
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100712/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100713/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100714/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100715#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100716
717#define FIT_IMAGES_PATH "/images"
718#define FIT_CONFS_PATH "/configurations"
719
Simon Glass3e569a62013-06-13 15:10:00 -0700720/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100721#define FIT_HASH_NODENAME "hash"
722#define FIT_ALGO_PROP "algo"
723#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000724#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700725#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100726
727/* image node */
728#define FIT_DATA_PROP "data"
729#define FIT_TIMESTAMP_PROP "timestamp"
730#define FIT_DESC_PROP "description"
731#define FIT_ARCH_PROP "arch"
732#define FIT_TYPE_PROP "type"
733#define FIT_OS_PROP "os"
734#define FIT_COMP_PROP "compression"
735#define FIT_ENTRY_PROP "entry"
736#define FIT_LOAD_PROP "load"
737
738/* configuration node */
739#define FIT_KERNEL_PROP "kernel"
740#define FIT_RAMDISK_PROP "ramdisk"
741#define FIT_FDT_PROP "fdt"
742#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -0600743#define FIT_SETUP_PROP "setup"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100744
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200745#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100746
747/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000748int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100749 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000750int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100751 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100752
Stephen Warren712fbcf2011-10-18 11:11:49 +0000753void fit_print_contents(const void *fit);
754void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100755
756/**
757 * fit_get_end - get FIT image size
758 * @fit: pointer to the FIT format image header
759 *
760 * returns:
761 * size of the FIT image (blob) in memory
762 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000763static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100764{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000765 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100766}
767
768/**
769 * fit_get_end - get FIT image end
770 * @fit: pointer to the FIT format image header
771 *
772 * returns:
773 * end address of the FIT image (blob) in memory
774 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000775static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100776{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000777 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100778}
779
780/**
781 * fit_get_name - get FIT node name
782 * @fit: pointer to the FIT format image header
783 *
784 * returns:
785 * NULL, on error
786 * pointer to node name, on success
787 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000788static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100789 int noffset, int *len)
790{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000791 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100792}
793
Stephen Warren712fbcf2011-10-18 11:11:49 +0000794int fit_get_desc(const void *fit, int noffset, char **desc);
795int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100796
Stephen Warren712fbcf2011-10-18 11:11:49 +0000797int fit_image_get_node(const void *fit, const char *image_uname);
798int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
799int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
800int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
801int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
802int fit_image_get_load(const void *fit, int noffset, ulong *load);
803int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
804int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100805 const void **data, size_t *size);
806
Stephen Warren712fbcf2011-10-18 11:11:49 +0000807int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
808int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100809 int *value_len);
810
Stephen Warren712fbcf2011-10-18 11:11:49 +0000811int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000812
813/**
Simon Glass56518e72013-06-13 15:10:01 -0700814 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000815 *
Simon Glass56518e72013-06-13 15:10:01 -0700816 * @keydir: Directory containing keys
817 * @kwydest: FDT blob to write public key information to
818 * @fit: Pointer to the FIT format image header
819 * @comment: Comment to add to signature nodes
820 * @require_keys: Mark all keys as 'required'
821 *
822 * Adds hash values for all component images in the FIT blob.
823 * Hashes are calculated for all component images which have hash subnodes
824 * with algorithm property set to one of the supported hash algorithms.
825 *
826 * Also add signatures if signature nodes are present.
827 *
828 * returns
829 * 0, on success
830 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000831 */
Simon Glass56518e72013-06-13 15:10:01 -0700832int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
833 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100834
Simon Glassb8da8362013-05-07 06:11:57 +0000835int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000836int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000837int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000838int fit_image_check_os(const void *fit, int noffset, uint8_t os);
839int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
840int fit_image_check_type(const void *fit, int noffset, uint8_t type);
841int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
842int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100843
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000844int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000845int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100846
Simon Glass003efd72013-05-07 06:12:00 +0000847/**
848 * fit_conf_get_prop_node() - Get node refered to by a configuration
849 * @fit: FIT to check
850 * @noffset: Offset of conf@xxx node to check
851 * @prop_name: Property to read from the conf node
852 *
853 * The conf@ nodes contain references to other nodes, using properties
854 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
855 * return the offset of the node referred to (e.g. offset of node
856 * "/images/kernel@1".
857 */
858int fit_conf_get_prop_node(const void *fit, int noffset,
859 const char *prop_name);
860
Stephen Warren712fbcf2011-10-18 11:11:49 +0000861void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100862
Simon Glass61a439a2013-05-07 06:11:52 +0000863int fit_check_ramdisk(const void *fit, int os_noffset,
864 uint8_t arch, int verify);
865
Simon Glass604f23d2013-05-07 06:11:54 +0000866int calculate_hash(const void *data, int data_len, const char *algo,
867 uint8_t *value, int *value_len);
868
Simon Glass782cfbb2013-05-16 13:53:21 +0000869/*
Simon Glass3e569a62013-06-13 15:10:00 -0700870 * At present we only support signing on the host, and verification on the
871 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000872 */
873#if defined(CONFIG_FIT_SIGNATURE)
874# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700875# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +0100876# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +0100877# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +0000878#else
Simon Glass3e569a62013-06-13 15:10:00 -0700879# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000880# define IMAGE_ENABLE_VERIFY 1
881# endif
882#else
Simon Glass3e569a62013-06-13 15:10:00 -0700883# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000884# define IMAGE_ENABLE_VERIFY 0
885#endif
886
887#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +0100888void *image_get_host_blob(void);
889void image_set_host_blob(void *host_blob);
890# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +0000891#else
892# define gd_fdt_blob() (gd->fdt_blob)
893#endif
894
895#ifdef CONFIG_FIT_BEST_MATCH
896#define IMAGE_ENABLE_BEST_MATCH 1
897#else
898#define IMAGE_ENABLE_BEST_MATCH 0
899#endif
900
Simon Glass3e569a62013-06-13 15:10:00 -0700901/* Information passed to the signing routines */
902struct image_sign_info {
903 const char *keydir; /* Directory conaining keys */
904 const char *keyname; /* Name of key to use */
905 void *fit; /* Pointer to FIT blob */
906 int node_offset; /* Offset of signature node */
907 struct image_sig_algo *algo; /* Algorithm information */
908 const void *fdt_blob; /* FDT containing public keys */
909 int required_keynode; /* Node offset of key to use: -1=any */
910 const char *require_keys; /* Value for 'required' property */
911};
912
913/* A part of an image, used for hashing */
914struct image_region {
915 const void *data;
916 int size;
917};
918
Heiko Schocher646257d2014-03-03 12:19:26 +0100919#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +0200920# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +0100921#endif
922struct checksum_algo {
923 const char *name;
924 const int checksum_len;
Heiko Schocherdb1b5f32014-03-03 12:19:27 +0100925 const int pad_len;
Heiko Schocher646257d2014-03-03 12:19:26 +0100926#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +0100927 const EVP_MD *(*calculate_sign)(void);
928#endif
Heiko Schocher646257d2014-03-03 12:19:26 +0100929 void (*calculate)(const struct image_region region[],
930 int region_count, uint8_t *checksum);
931 const uint8_t *rsa_padding;
Heiko Schocher646257d2014-03-03 12:19:26 +0100932};
933
Simon Glass3e569a62013-06-13 15:10:00 -0700934struct image_sig_algo {
935 const char *name; /* Name of algorithm */
936
937 /**
938 * sign() - calculate and return signature for given input data
939 *
940 * @info: Specifies key and FIT information
941 * @data: Pointer to the input data
942 * @data_len: Data length
943 * @sigp: Set to an allocated buffer holding the signature
944 * @sig_len: Set to length of the calculated hash
945 *
946 * This computes input data signature according to selected algorithm.
947 * Resulting signature value is placed in an allocated buffer, the
948 * pointer is returned as *sigp. The length of the calculated
949 * signature is returned via the sig_len pointer argument. The caller
950 * should free *sigp.
951 *
952 * @return: 0, on success, -ve on error
953 */
954 int (*sign)(struct image_sign_info *info,
955 const struct image_region region[],
956 int region_count, uint8_t **sigp, uint *sig_len);
957
958 /**
959 * add_verify_data() - Add verification information to FDT
960 *
961 * Add public key information to the FDT node, suitable for
962 * verification at run-time. The information added depends on the
963 * algorithm being used.
964 *
965 * @info: Specifies key and FIT information
966 * @keydest: Destination FDT blob for public key data
967 * @return: 0, on success, -ve on error
968 */
969 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
970
971 /**
972 * verify() - Verify a signature against some data
973 *
974 * @info: Specifies key and FIT information
975 * @data: Pointer to the input data
976 * @data_len: Data length
977 * @sig: Signature
978 * @sig_len: Number of bytes in signature
979 * @return 0 if verified, -ve on error
980 */
981 int (*verify)(struct image_sign_info *info,
982 const struct image_region region[], int region_count,
983 uint8_t *sig, uint sig_len);
Heiko Schocher646257d2014-03-03 12:19:26 +0100984
985 /* pointer to checksum algorithm */
986 struct checksum_algo *checksum;
Simon Glass3e569a62013-06-13 15:10:00 -0700987};
988
989/**
990 * image_get_sig_algo() - Look up a signature algortihm
991 *
992 * @param name Name of algorithm
993 * @return pointer to algorithm information, or NULL if not found
994 */
995struct image_sig_algo *image_get_sig_algo(const char *name);
996
Simon Glass56518e72013-06-13 15:10:01 -0700997/**
998 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
999 *
1000 * @fit: FIT to check
1001 * @image_noffset: Offset of image node to check
1002 * @data: Image data to check
1003 * @size: Size of image data
1004 * @sig_blob: FDT containing public keys
1005 * @no_sigsp: Returns 1 if no signatures were required, and
1006 * therefore nothing was checked. The caller may wish
1007 * to fall back to other mechanisms, or refuse to
1008 * boot.
1009 * @return 0 if all verified ok, <0 on error
1010 */
1011int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1012 const char *data, size_t size, const void *sig_blob,
1013 int *no_sigsp);
1014
1015/**
1016 * fit_image_check_sig() - Check a single image signature node
1017 *
1018 * @fit: FIT to check
1019 * @noffset: Offset of signature node to check
1020 * @data: Image data to check
1021 * @size: Size of image data
1022 * @required_keynode: Offset in the control FDT of the required key node,
1023 * if any. If this is given, then the image wil not
1024 * pass verification unless that key is used. If this is
1025 * -1 then any signature will do.
1026 * @err_msgp: In the event of an error, this will be pointed to a
1027 * help error string to display to the user.
1028 * @return 0 if all verified ok, <0 on error
1029 */
1030int fit_image_check_sig(const void *fit, int noffset, const void *data,
1031 size_t size, int required_keynode, char **err_msgp);
1032
Simon Glass4d098522013-06-13 15:10:09 -07001033/**
1034 * fit_region_make_list() - Make a list of regions to hash
1035 *
1036 * Given a list of FIT regions (offset, size) provided by libfdt, create
1037 * a list of regions (void *, size) for use by the signature creationg
1038 * and verification code.
1039 *
1040 * @fit: FIT image to process
1041 * @fdt_regions: Regions as returned by libfdt
1042 * @count: Number of regions returned by libfdt
1043 * @region: Place to put list of regions (NULL to allocate it)
1044 * @return pointer to list of regions, or NULL if out of memory
1045 */
1046struct image_region *fit_region_make_list(const void *fit,
1047 struct fdt_region *fdt_regions, int count,
1048 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001049
Stephen Warren712fbcf2011-10-18 11:11:49 +00001050static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001051{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001052#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001053 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001054#else
1055 return 0;
1056#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001057}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001058
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001059#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001060#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001061 "FIT images not supported for '%s'\n", \
1062 __FILE__, __LINE__, (msg))
1063
Stephen Warren712fbcf2011-10-18 11:11:49 +00001064#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001065 "FIT images not supported for '%s' " \
1066 "- must reset board to recover!\n", \
1067 __FILE__, __LINE__, (msg))
1068#else
1069#define fit_unsupported(msg)
1070#define fit_unsupported_reset(msg)
1071#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001072#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001073
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001074#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1075struct andr_img_hdr;
1076int android_image_check_header(const struct andr_img_hdr *hdr);
1077int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1078 ulong *os_data, ulong *os_len);
1079int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1080 ulong *rd_data, ulong *rd_len);
1081ulong android_image_get_end(const struct andr_img_hdr *hdr);
1082ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1083
1084#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1085
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001086#endif /* __IMAGE_H__ */