blob: 340105658c02554597e84951e8d8f9bde571f54b [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
wdenk5b1d7132002-11-03 00:07:02 +0000122/*
123 * Operating System Codes
124 */
125#define IH_OS_INVALID 0 /* Invalid OS */
126#define IH_OS_OPENBSD 1 /* OpenBSD */
127#define IH_OS_NETBSD 2 /* NetBSD */
128#define IH_OS_FREEBSD 3 /* FreeBSD */
129#define IH_OS_4_4BSD 4 /* 4.4BSD */
130#define IH_OS_LINUX 5 /* Linux */
131#define IH_OS_SVR4 6 /* SVR4 */
132#define IH_OS_ESIX 7 /* Esix */
133#define IH_OS_SOLARIS 8 /* Solaris */
134#define IH_OS_IRIX 9 /* Irix */
135#define IH_OS_SCO 10 /* SCO */
136#define IH_OS_DELL 11 /* Dell */
137#define IH_OS_NCR 12 /* NCR */
138#define IH_OS_LYNXOS 13 /* LynxOS */
139#define IH_OS_VXWORKS 14 /* VxWorks */
140#define IH_OS_PSOS 15 /* pSOS */
141#define IH_OS_QNX 16 /* QNX */
142#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000143#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000144#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000145#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500146#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200147#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000148#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000149
150/*
151 * CPU Architecture Codes (supported by Linux)
152 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100153#define IH_ARCH_INVALID 0 /* Invalid CPU */
154#define IH_ARCH_ALPHA 1 /* Alpha */
155#define IH_ARCH_ARM 2 /* ARM */
156#define IH_ARCH_I386 3 /* Intel x86 */
157#define IH_ARCH_IA64 4 /* IA64 */
158#define IH_ARCH_MIPS 5 /* MIPS */
159#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
160#define IH_ARCH_PPC 7 /* PowerPC */
161#define IH_ARCH_S390 8 /* IBM S390 */
162#define IH_ARCH_SH 9 /* SuperH */
163#define IH_ARCH_SPARC 10 /* Sparc */
164#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
165#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100166#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
167#define IH_ARCH_NIOS2 15 /* Nios-II */
168#define IH_ARCH_BLACKFIN 16 /* Blackfin */
169#define IH_ARCH_AVR32 17 /* AVR32 */
170#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000171#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000172#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000173#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
David Feng0ae76532013-12-14 11:47:35 +0800174#define IH_ARCH_ARM64 22 /* ARM64 */
Alexey Brodkinbc5d5422014-02-04 12:56:16 +0400175#define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
wdenk5b1d7132002-11-03 00:07:02 +0000176
177/*
178 * Image Types
179 *
180 * "Standalone Programs" are directly runnable in the environment
181 * provided by U-Boot; it is expected that (if they behave
182 * well) you can continue to work in U-Boot after return from
183 * the Standalone Program.
184 * "OS Kernel Images" are usually images of some Embedded OS which
185 * will take over control completely. Usually these programs
186 * will install their own set of exception handlers, device
187 * drivers, set up the MMU, etc. - this means, that you cannot
188 * expect to re-enter U-Boot except by resetting the CPU.
189 * "RAMDisk Images" are more or less just data blocks, and their
190 * parameters (address, size) are passed to an OS kernel that is
191 * being started.
192 * "Multi-File Images" contain several images, typically an OS
193 * (Linux) kernel image and one or more data images like
194 * RAMDisks. This construct is useful for instance when you want
195 * to boot over the network using BOOTP etc., where the boot
196 * server provides just a single image file, but you want to get
197 * for instance an OS kernel and a RAMDisk image.
198 *
199 * "Multi-File Images" start with a list of image sizes, each
200 * image size (in bytes) specified by an "uint32_t" in network
201 * byte order. This list is terminated by an "(uint32_t)0".
202 * Immediately after the terminating 0 follow the images, one by
203 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000204 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000205 *
206 * "Firmware Images" are binary images containing firmware (like
207 * U-Boot or FPGA images) which usually will be programmed to
208 * flash memory.
209 *
210 * "Script files" are command sequences that will be executed by
211 * U-Boot's command interpreter; this feature is especially
212 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000213 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000214 */
215
216#define IH_TYPE_INVALID 0 /* Invalid Image */
217#define IH_TYPE_STANDALONE 1 /* Standalone Program */
218#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
219#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
220#define IH_TYPE_MULTI 4 /* Multi-File Image */
221#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
222#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000223#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500224#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530225#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100226#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000227#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400228#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000229#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e82011-11-10 13:17:53 -0700230#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000231#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
Marek Vasutbce88372013-08-26 20:43:33 +0200232#define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
Karicheri, Muralidharanbf411ea2014-04-04 13:16:48 -0400233#define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
Andreas Bießmann7b1a4112014-05-19 14:23:39 +0200234#define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
wdenk5b1d7132002-11-03 00:07:02 +0000235
236/*
237 * Compression Types
238 */
239#define IH_COMP_NONE 0 /* No Compression Used */
240#define IH_COMP_GZIP 1 /* gzip Compression Used */
241#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200242#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100243#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000244
245#define IH_MAGIC 0x27051956 /* Image Magic Number */
246#define IH_NMLEN 32 /* Image Name Length */
247
Fabio Estevam1411fb32013-01-03 08:24:33 +0000248/* Reused from common.h */
249#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
250
wdenk5b1d7132002-11-03 00:07:02 +0000251/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100252 * Legacy format image header,
253 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000254 */
wdenk5b1d7132002-11-03 00:07:02 +0000255typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000256 __be32 ih_magic; /* Image Header Magic Number */
257 __be32 ih_hcrc; /* Image Header CRC Checksum */
258 __be32 ih_time; /* Image Creation Timestamp */
259 __be32 ih_size; /* Image Data Size */
260 __be32 ih_load; /* Data Load Address */
261 __be32 ih_ep; /* Entry Point Address */
262 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000263 uint8_t ih_os; /* Operating System */
264 uint8_t ih_arch; /* CPU architecture */
265 uint8_t ih_type; /* Image Type */
266 uint8_t ih_comp; /* Compression Type */
267 uint8_t ih_name[IH_NMLEN]; /* Image Name */
268} image_header_t;
269
Kumar Gala396f6352008-08-15 08:24:41 -0500270typedef struct image_info {
271 ulong start, end; /* start/end of blob */
272 ulong image_start, image_len; /* start of image within blob, len of image */
273 ulong load; /* load addr for the image */
274 uint8_t comp, type, os; /* compression, type of image, os type */
275} image_info_t;
276
Marian Balakowicz559316f2008-01-08 18:11:44 +0100277/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100278 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
279 * routines.
280 */
281typedef struct bootm_headers {
282 /*
283 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100284 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100285 * data from second and third component accordingly.
286 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200287 image_header_t *legacy_hdr_os; /* image header pointer */
288 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100289 ulong legacy_hdr_valid;
290
291#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100292 const char *fit_uname_cfg; /* configuration node unit name */
293
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100294 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100295 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100296 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100297
298 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100299 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
300 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100301
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100302 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100303 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
304 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100305#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100306
Kumar Gala49c3a862008-10-21 17:25:45 -0500307#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500308 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500309 ulong ep; /* entry point of OS */
310
Kumar Galac4f94192008-08-15 08:24:37 -0500311 ulong rd_start, rd_end;/* ramdisk start/end */
312
Kumar Gala06a09912008-08-15 08:24:38 -0500313 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500314 ulong ft_len; /* length of flat device tree */
315
Kumar Gala49c3a862008-10-21 17:25:45 -0500316 ulong initrd_start;
317 ulong initrd_end;
318 ulong cmdline_start;
319 ulong cmdline_end;
320 bd_t *kbd;
321#endif
322
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100323 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500324
325#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700326#define BOOTM_STATE_FINDOS (0x00000002)
327#define BOOTM_STATE_FINDOTHER (0x00000004)
328#define BOOTM_STATE_LOADOS (0x00000008)
329#define BOOTM_STATE_RAMDISK (0x00000010)
330#define BOOTM_STATE_FDT (0x00000020)
331#define BOOTM_STATE_OS_CMDLINE (0x00000040)
332#define BOOTM_STATE_OS_BD_T (0x00000080)
333#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700334#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
335#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500336 int state;
337
Mike Frysingera16028d2009-11-03 11:35:59 -0500338#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500339 struct lmb lmb; /* for memory mgmt */
340#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100341} bootm_headers_t;
342
Simon Schwarz1648a372012-03-15 04:01:34 +0000343extern bootm_headers_t images;
344
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100345/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100346 * Some systems (for example LWMON) have very short watchdog periods;
347 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200348 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100349 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200350#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100351#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200352#endif
353
354#ifndef CHUNKSZ_CRC32
355#define CHUNKSZ_CRC32 (64 * 1024)
356#endif
357
358#ifndef CHUNKSZ_MD5
359#define CHUNKSZ_MD5 (64 * 1024)
360#endif
361
362#ifndef CHUNKSZ_SHA1
363#define CHUNKSZ_SHA1 (64 * 1024)
364#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100365
Mike Frysinger37566092009-07-02 19:23:25 -0400366#define uimage_to_cpu(x) be32_to_cpu(x)
367#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000368
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530369/*
370 * Translation table for entries of a specific type; used by
371 * get_table_entry_id() and get_table_entry_name().
372 */
373typedef struct table_entry {
374 int id;
375 char *sname; /* short (input) name to find table entry */
376 char *lname; /* long (output) name to print for messages */
377} table_entry_t;
378
379/*
380 * get_table_entry_id() scans the translation table trying to find an
381 * entry that matches the given short name. If a matching entry is
382 * found, it's id is returned to the caller.
383 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400384int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530385 const char *table_name, const char *name);
386/*
387 * get_table_entry_name() scans the translation table trying to find
388 * an entry that matches the given id. If a matching entry is found,
389 * its long name is returned to the caller.
390 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400391char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530392
Stephen Warren712fbcf2011-10-18 11:11:49 +0000393const char *genimg_get_os_name(uint8_t os);
394const char *genimg_get_arch_name(uint8_t arch);
395const char *genimg_get_type_name(uint8_t type);
396const char *genimg_get_comp_name(uint8_t comp);
397int genimg_get_os_id(const char *name);
398int genimg_get_arch_id(const char *name);
399int genimg_get_type_id(const char *name);
400int genimg_get_comp_id(const char *name);
401void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100402
Simon Glass859e92b2013-05-07 06:11:51 +0000403#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
404 defined(USE_HOSTCC)
405#define IMAGE_ENABLE_TIMESTAMP 1
406#else
407#define IMAGE_ENABLE_TIMESTAMP 0
408#endif
409void genimg_print_time(time_t timestamp);
410
Simon Glass782cfbb2013-05-16 13:53:21 +0000411/* What to do with a image load address ('load = <> 'in the FIT) */
412enum fit_load_op {
413 FIT_LOAD_IGNORED, /* Ignore load address */
414 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600415 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000416 FIT_LOAD_REQUIRED, /* Must be provided */
417};
418
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100419#ifndef USE_HOSTCC
420/* Image format types, returned by _get_format() routine */
421#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher21d29f72014-05-28 11:33:33 +0200422#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100423#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200424#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100425#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500426#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100427
Bryan Wu6c454fe2014-08-15 16:51:38 -0700428ulong genimg_get_kernel_addr_fit(char * const img_addr,
429 const char **fit_uname_config,
430 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700431ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000432int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000433int genimg_has_config(bootm_headers_t *images);
434ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100435
Stephen Warren712fbcf2011-10-18 11:11:49 +0000436int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100437 uint8_t arch, ulong *rd_start, ulong *rd_end);
Simon Glassce1400f2014-06-12 07:24:53 -0600438#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100439
Simon Glass782cfbb2013-05-16 13:53:21 +0000440/**
441 * fit_image_load() - load an image from a FIT
442 *
443 * This deals with all aspects of loading an image from a FIT, including
444 * selecting the right image based on configuration, verifying it, printing
445 * out progress messages, checking the type/arch/os and optionally copying it
446 * to the right load address.
447 *
Simon Glass126cc862014-06-12 07:24:47 -0600448 * The property to look up is defined by image_type.
449 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000450 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000451 * @param addr Address of FIT in memory
452 * @param fit_unamep On entry this is the requested image name
453 * (e.g. "kernel@1") or NULL to use the default. On exit
454 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700455 * @param fit_uname_configp On entry this is the requested configuration
456 * name (e.g. "conf@1") or NULL to use the default. On
457 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000458 * @param arch Expected architecture (IH_ARCH_...)
459 * @param image_type Required image type (IH_TYPE_...). If this is
460 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
461 * also.
462 * @param bootstage_id ID of starting bootstage to use for progress updates.
463 * This will be added to the BOOTSTAGE_SUB values when
464 * calling bootstage_mark()
465 * @param load_op Decribes what to do with the load address
466 * @param datap Returns address of loaded image
467 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600468 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000469 */
Simon Glass126cc862014-06-12 07:24:47 -0600470int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700471 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000472 int arch, int image_type, int bootstage_id,
473 enum fit_load_op load_op, ulong *datap, ulong *lenp);
474
Simon Glassce1400f2014-06-12 07:24:53 -0600475#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000476/**
477 * fit_get_node_from_config() - Look up an image a FIT by type
478 *
479 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
480 * particular image type (e.g. "kernel") and then finds the image that is
481 * referred to.
482 *
483 * For example, for something like:
484 *
485 * images {
486 * kernel@1 {
487 * ...
488 * };
489 * };
490 * configurations {
491 * conf@1 {
492 * kernel = "kernel@1";
493 * };
494 * };
495 *
496 * the function will return the node offset of the kernel@1 node, assuming
497 * that conf@1 is the chosen configuration.
498 *
499 * @param images Boot images structure
500 * @param prop_name Property name to look up (FIT_..._PROP)
501 * @param addr Address of FIT in memory
502 */
503int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
504 ulong addr);
505
Simon Glass53f375f2013-05-16 13:53:23 +0000506int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
507 bootm_headers_t *images,
508 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000509void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000510int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500511
Stephen Warren712fbcf2011-10-18 11:11:49 +0000512int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100513 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000514int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600515#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000516int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600517#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100518#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100519
520/*******************************************************************/
521/* Legacy format specific code (prefixed with image_) */
522/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000523static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100524{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000525 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100526}
527
528#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200529 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100530 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000531 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100532 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000533image_get_hdr_l(magic) /* image_get_magic */
534image_get_hdr_l(hcrc) /* image_get_hcrc */
535image_get_hdr_l(time) /* image_get_time */
536image_get_hdr_l(size) /* image_get_size */
537image_get_hdr_l(load) /* image_get_load */
538image_get_hdr_l(ep) /* image_get_ep */
539image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100540
541#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200542 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100543 { \
544 return hdr->ih_##f; \
545 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000546image_get_hdr_b(os) /* image_get_os */
547image_get_hdr_b(arch) /* image_get_arch */
548image_get_hdr_b(type) /* image_get_type */
549image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100550
Stephen Warren712fbcf2011-10-18 11:11:49 +0000551static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100552{
553 return (char *)hdr->ih_name;
554}
555
Stephen Warren712fbcf2011-10-18 11:11:49 +0000556static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100557{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000558 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100559}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100560
561/**
562 * image_get_data - get image payload start address
563 * @hdr: image header
564 *
565 * image_get_data() returns address of the image payload. For single
566 * component images it is image data start. For multi component
567 * images it points to the null terminated table of sub-images sizes.
568 *
569 * returns:
570 * image payload data start address
571 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000572static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100573{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000574 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100575}
576
Stephen Warren712fbcf2011-10-18 11:11:49 +0000577static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100578{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000579 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100580}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000581static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100582{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000583 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100584}
585
586#define image_set_hdr_l(f) \
587 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
588 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000589 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100590 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000591image_set_hdr_l(magic) /* image_set_magic */
592image_set_hdr_l(hcrc) /* image_set_hcrc */
593image_set_hdr_l(time) /* image_set_time */
594image_set_hdr_l(size) /* image_set_size */
595image_set_hdr_l(load) /* image_set_load */
596image_set_hdr_l(ep) /* image_set_ep */
597image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100598
599#define image_set_hdr_b(f) \
600 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
601 { \
602 hdr->ih_##f = val; \
603 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000604image_set_hdr_b(os) /* image_set_os */
605image_set_hdr_b(arch) /* image_set_arch */
606image_set_hdr_b(type) /* image_set_type */
607image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100608
Stephen Warren712fbcf2011-10-18 11:11:49 +0000609static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100610{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000611 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100612}
613
Stephen Warren712fbcf2011-10-18 11:11:49 +0000614int image_check_hcrc(const image_header_t *hdr);
615int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100616#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600617ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500618phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000619phys_size_t getenv_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100620#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600621void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100622
Stephen Warren712fbcf2011-10-18 11:11:49 +0000623static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100624{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000625 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100626}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000627static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100628{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000629 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100630}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000631static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100632{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000633 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100634}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000635static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100636{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000637 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100638}
639
Stephen Warren712fbcf2011-10-18 11:11:49 +0000640ulong image_multi_count(const image_header_t *hdr);
641void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100642 ulong *data, ulong *len);
643
Stephen Warren712fbcf2011-10-18 11:11:49 +0000644void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100645
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100646#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000647static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100648{
Mike Frysinger476af292011-10-03 14:50:33 +0000649#ifndef IH_ARCH_DEFAULT
650# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100651#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000652 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100653}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100654#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100655
Simon Glass13d06982013-05-08 08:06:01 +0000656/**
657 * Set up properties in the FDT
658 *
659 * This sets up properties in the FDT that is to be passed to linux.
660 *
661 * @images: Images information
662 * @blob: FDT to update
663 * @of_size: Size of the FDT
664 * @lmb: Points to logical memory block structure
665 * @return 0 if ok, <0 on failure
666 */
667int image_setup_libfdt(bootm_headers_t *images, void *blob,
668 int of_size, struct lmb *lmb);
669
670/**
671 * Set up the FDT to use for booting a kernel
672 *
673 * This performs ramdisk setup, sets up the FDT if required, and adds
674 * paramters to the FDT if libfdt is available.
675 *
676 * @param images Images information
677 * @return 0 if ok, <0 on failure
678 */
679int image_setup_linux(bootm_headers_t *images);
680
Simon Glassa5266d62013-07-04 13:26:10 -0700681/**
682 * bootz_setup() - Extract stat and size of a Linux xImage
683 *
684 * @image: Address of image
685 * @start: Returns start address of image
686 * @end : Returns end address of image
687 * @return 0 if OK, 1 if the image was not recognised
688 */
689int bootz_setup(ulong image, ulong *start, ulong *end);
690
691
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100692/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100693/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100694/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100695#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100696
697#define FIT_IMAGES_PATH "/images"
698#define FIT_CONFS_PATH "/configurations"
699
Simon Glass3e569a62013-06-13 15:10:00 -0700700/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100701#define FIT_HASH_NODENAME "hash"
702#define FIT_ALGO_PROP "algo"
703#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000704#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700705#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100706
707/* image node */
708#define FIT_DATA_PROP "data"
709#define FIT_TIMESTAMP_PROP "timestamp"
710#define FIT_DESC_PROP "description"
711#define FIT_ARCH_PROP "arch"
712#define FIT_TYPE_PROP "type"
713#define FIT_OS_PROP "os"
714#define FIT_COMP_PROP "compression"
715#define FIT_ENTRY_PROP "entry"
716#define FIT_LOAD_PROP "load"
717
718/* configuration node */
719#define FIT_KERNEL_PROP "kernel"
720#define FIT_RAMDISK_PROP "ramdisk"
721#define FIT_FDT_PROP "fdt"
722#define FIT_DEFAULT_PROP "default"
723
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200724#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100725
726/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000727int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100728 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000729int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100730 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100731
Stephen Warren712fbcf2011-10-18 11:11:49 +0000732void fit_print_contents(const void *fit);
733void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100734
735/**
736 * fit_get_end - get FIT image size
737 * @fit: pointer to the FIT format image header
738 *
739 * returns:
740 * size of the FIT image (blob) in memory
741 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000742static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100743{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000744 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100745}
746
747/**
748 * fit_get_end - get FIT image end
749 * @fit: pointer to the FIT format image header
750 *
751 * returns:
752 * end address of the FIT image (blob) in memory
753 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000754static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100755{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000756 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100757}
758
759/**
760 * fit_get_name - get FIT node name
761 * @fit: pointer to the FIT format image header
762 *
763 * returns:
764 * NULL, on error
765 * pointer to node name, on success
766 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000767static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100768 int noffset, int *len)
769{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000770 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100771}
772
Stephen Warren712fbcf2011-10-18 11:11:49 +0000773int fit_get_desc(const void *fit, int noffset, char **desc);
774int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100775
Stephen Warren712fbcf2011-10-18 11:11:49 +0000776int fit_image_get_node(const void *fit, const char *image_uname);
777int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
778int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
779int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
780int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
781int fit_image_get_load(const void *fit, int noffset, ulong *load);
782int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
783int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100784 const void **data, size_t *size);
785
Stephen Warren712fbcf2011-10-18 11:11:49 +0000786int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
787int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100788 int *value_len);
789
Stephen Warren712fbcf2011-10-18 11:11:49 +0000790int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000791
792/**
Simon Glass56518e72013-06-13 15:10:01 -0700793 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000794 *
Simon Glass56518e72013-06-13 15:10:01 -0700795 * @keydir: Directory containing keys
796 * @kwydest: FDT blob to write public key information to
797 * @fit: Pointer to the FIT format image header
798 * @comment: Comment to add to signature nodes
799 * @require_keys: Mark all keys as 'required'
800 *
801 * Adds hash values for all component images in the FIT blob.
802 * Hashes are calculated for all component images which have hash subnodes
803 * with algorithm property set to one of the supported hash algorithms.
804 *
805 * Also add signatures if signature nodes are present.
806 *
807 * returns
808 * 0, on success
809 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000810 */
Simon Glass56518e72013-06-13 15:10:01 -0700811int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
812 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100813
Simon Glassb8da8362013-05-07 06:11:57 +0000814int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000815int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000816int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000817int fit_image_check_os(const void *fit, int noffset, uint8_t os);
818int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
819int fit_image_check_type(const void *fit, int noffset, uint8_t type);
820int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
821int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100822
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000823int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000824int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100825
Simon Glass003efd72013-05-07 06:12:00 +0000826/**
827 * fit_conf_get_prop_node() - Get node refered to by a configuration
828 * @fit: FIT to check
829 * @noffset: Offset of conf@xxx node to check
830 * @prop_name: Property to read from the conf node
831 *
832 * The conf@ nodes contain references to other nodes, using properties
833 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
834 * return the offset of the node referred to (e.g. offset of node
835 * "/images/kernel@1".
836 */
837int fit_conf_get_prop_node(const void *fit, int noffset,
838 const char *prop_name);
839
Stephen Warren712fbcf2011-10-18 11:11:49 +0000840void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100841
Simon Glass61a439a2013-05-07 06:11:52 +0000842int fit_check_ramdisk(const void *fit, int os_noffset,
843 uint8_t arch, int verify);
844
Simon Glass604f23d2013-05-07 06:11:54 +0000845int calculate_hash(const void *data, int data_len, const char *algo,
846 uint8_t *value, int *value_len);
847
Simon Glass782cfbb2013-05-16 13:53:21 +0000848/*
Simon Glass3e569a62013-06-13 15:10:00 -0700849 * At present we only support signing on the host, and verification on the
850 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000851 */
852#if defined(CONFIG_FIT_SIGNATURE)
853# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700854# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +0100855# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +0100856# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +0000857#else
Simon Glass3e569a62013-06-13 15:10:00 -0700858# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000859# define IMAGE_ENABLE_VERIFY 1
860# endif
861#else
Simon Glass3e569a62013-06-13 15:10:00 -0700862# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000863# define IMAGE_ENABLE_VERIFY 0
864#endif
865
866#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +0100867void *image_get_host_blob(void);
868void image_set_host_blob(void *host_blob);
869# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +0000870#else
871# define gd_fdt_blob() (gd->fdt_blob)
872#endif
873
874#ifdef CONFIG_FIT_BEST_MATCH
875#define IMAGE_ENABLE_BEST_MATCH 1
876#else
877#define IMAGE_ENABLE_BEST_MATCH 0
878#endif
879
Simon Glass3e569a62013-06-13 15:10:00 -0700880/* Information passed to the signing routines */
881struct image_sign_info {
882 const char *keydir; /* Directory conaining keys */
883 const char *keyname; /* Name of key to use */
884 void *fit; /* Pointer to FIT blob */
885 int node_offset; /* Offset of signature node */
886 struct image_sig_algo *algo; /* Algorithm information */
887 const void *fdt_blob; /* FDT containing public keys */
888 int required_keynode; /* Node offset of key to use: -1=any */
889 const char *require_keys; /* Value for 'required' property */
890};
891
892/* A part of an image, used for hashing */
893struct image_region {
894 const void *data;
895 int size;
896};
897
Heiko Schocher646257d2014-03-03 12:19:26 +0100898#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +0200899# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +0100900#endif
901struct checksum_algo {
902 const char *name;
903 const int checksum_len;
Heiko Schocherdb1b5f32014-03-03 12:19:27 +0100904 const int pad_len;
Heiko Schocher646257d2014-03-03 12:19:26 +0100905#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +0100906 const EVP_MD *(*calculate_sign)(void);
907#endif
Heiko Schocher646257d2014-03-03 12:19:26 +0100908 void (*calculate)(const struct image_region region[],
909 int region_count, uint8_t *checksum);
910 const uint8_t *rsa_padding;
Heiko Schocher646257d2014-03-03 12:19:26 +0100911};
912
Simon Glass3e569a62013-06-13 15:10:00 -0700913struct image_sig_algo {
914 const char *name; /* Name of algorithm */
915
916 /**
917 * sign() - calculate and return signature for given input data
918 *
919 * @info: Specifies key and FIT information
920 * @data: Pointer to the input data
921 * @data_len: Data length
922 * @sigp: Set to an allocated buffer holding the signature
923 * @sig_len: Set to length of the calculated hash
924 *
925 * This computes input data signature according to selected algorithm.
926 * Resulting signature value is placed in an allocated buffer, the
927 * pointer is returned as *sigp. The length of the calculated
928 * signature is returned via the sig_len pointer argument. The caller
929 * should free *sigp.
930 *
931 * @return: 0, on success, -ve on error
932 */
933 int (*sign)(struct image_sign_info *info,
934 const struct image_region region[],
935 int region_count, uint8_t **sigp, uint *sig_len);
936
937 /**
938 * add_verify_data() - Add verification information to FDT
939 *
940 * Add public key information to the FDT node, suitable for
941 * verification at run-time. The information added depends on the
942 * algorithm being used.
943 *
944 * @info: Specifies key and FIT information
945 * @keydest: Destination FDT blob for public key data
946 * @return: 0, on success, -ve on error
947 */
948 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
949
950 /**
951 * verify() - Verify a signature against some data
952 *
953 * @info: Specifies key and FIT information
954 * @data: Pointer to the input data
955 * @data_len: Data length
956 * @sig: Signature
957 * @sig_len: Number of bytes in signature
958 * @return 0 if verified, -ve on error
959 */
960 int (*verify)(struct image_sign_info *info,
961 const struct image_region region[], int region_count,
962 uint8_t *sig, uint sig_len);
Heiko Schocher646257d2014-03-03 12:19:26 +0100963
964 /* pointer to checksum algorithm */
965 struct checksum_algo *checksum;
Simon Glass3e569a62013-06-13 15:10:00 -0700966};
967
968/**
969 * image_get_sig_algo() - Look up a signature algortihm
970 *
971 * @param name Name of algorithm
972 * @return pointer to algorithm information, or NULL if not found
973 */
974struct image_sig_algo *image_get_sig_algo(const char *name);
975
Simon Glass56518e72013-06-13 15:10:01 -0700976/**
977 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
978 *
979 * @fit: FIT to check
980 * @image_noffset: Offset of image node to check
981 * @data: Image data to check
982 * @size: Size of image data
983 * @sig_blob: FDT containing public keys
984 * @no_sigsp: Returns 1 if no signatures were required, and
985 * therefore nothing was checked. The caller may wish
986 * to fall back to other mechanisms, or refuse to
987 * boot.
988 * @return 0 if all verified ok, <0 on error
989 */
990int fit_image_verify_required_sigs(const void *fit, int image_noffset,
991 const char *data, size_t size, const void *sig_blob,
992 int *no_sigsp);
993
994/**
995 * fit_image_check_sig() - Check a single image signature node
996 *
997 * @fit: FIT to check
998 * @noffset: Offset of signature node to check
999 * @data: Image data to check
1000 * @size: Size of image data
1001 * @required_keynode: Offset in the control FDT of the required key node,
1002 * if any. If this is given, then the image wil not
1003 * pass verification unless that key is used. If this is
1004 * -1 then any signature will do.
1005 * @err_msgp: In the event of an error, this will be pointed to a
1006 * help error string to display to the user.
1007 * @return 0 if all verified ok, <0 on error
1008 */
1009int fit_image_check_sig(const void *fit, int noffset, const void *data,
1010 size_t size, int required_keynode, char **err_msgp);
1011
Simon Glass4d098522013-06-13 15:10:09 -07001012/**
1013 * fit_region_make_list() - Make a list of regions to hash
1014 *
1015 * Given a list of FIT regions (offset, size) provided by libfdt, create
1016 * a list of regions (void *, size) for use by the signature creationg
1017 * and verification code.
1018 *
1019 * @fit: FIT image to process
1020 * @fdt_regions: Regions as returned by libfdt
1021 * @count: Number of regions returned by libfdt
1022 * @region: Place to put list of regions (NULL to allocate it)
1023 * @return pointer to list of regions, or NULL if out of memory
1024 */
1025struct image_region *fit_region_make_list(const void *fit,
1026 struct fdt_region *fdt_regions, int count,
1027 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001028
Stephen Warren712fbcf2011-10-18 11:11:49 +00001029static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001030{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001031#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001032 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001033#else
1034 return 0;
1035#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001036}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001037
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001038#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001039#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001040 "FIT images not supported for '%s'\n", \
1041 __FILE__, __LINE__, (msg))
1042
Stephen Warren712fbcf2011-10-18 11:11:49 +00001043#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001044 "FIT images not supported for '%s' " \
1045 "- must reset board to recover!\n", \
1046 __FILE__, __LINE__, (msg))
1047#else
1048#define fit_unsupported(msg)
1049#define fit_unsupported_reset(msg)
1050#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001051#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001052
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001053#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1054struct andr_img_hdr;
1055int android_image_check_header(const struct andr_img_hdr *hdr);
1056int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1057 ulong *os_data, ulong *os_len);
1058int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1059 ulong *rd_data, ulong *rd_len);
1060ulong android_image_get_end(const struct andr_img_hdr *hdr);
1061ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1062
1063#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1064
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001065#endif /* __IMAGE_H__ */