blob: 518a4f5291f929809a57526bbbeaa1200bd6f719 [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
Jörg Krause26e355d2015-04-22 21:36:22 +020026#include <sys/types.h>
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010027
28/* new uImage format support enabled on host */
29#define CONFIG_FIT 1
30#define CONFIG_OF_LIBFDT 1
31#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
32
Simon Glassab9efc62013-05-07 06:11:58 +000033#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000034#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000035
Wolfgang Denkdef08192008-10-21 11:23:56 +020036#else
37
38#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020039#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050040#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020041
Simon Glassab9efc62013-05-07 06:11:58 +000042/* Take notice of the 'ignore' property for hashes */
43#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000044#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000045
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010046#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010047
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010048#if defined(CONFIG_FIT)
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020049#include <hash.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010050#include <libfdt.h>
51#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000052# ifdef CONFIG_SPL_BUILD
53# ifdef CONFIG_SPL_CRC32_SUPPORT
54# define IMAGE_ENABLE_CRC32 1
55# endif
56# ifdef CONFIG_SPL_MD5_SUPPORT
57# define IMAGE_ENABLE_MD5 1
58# endif
59# ifdef CONFIG_SPL_SHA1_SUPPORT
60# define IMAGE_ENABLE_SHA1 1
61# endif
Heiko Schocher2842c1c2014-03-03 12:19:25 +010062# ifdef CONFIG_SPL_SHA256_SUPPORT
63# define IMAGE_ENABLE_SHA256 1
64# endif
Simon Glass87ebee32013-05-08 08:05:59 +000065# else
66# define CONFIG_CRC32 /* FIT images need CRC32 support */
67# define CONFIG_MD5 /* and MD5 */
68# define CONFIG_SHA1 /* and SHA1 */
Heiko Schocher2842c1c2014-03-03 12:19:25 +010069# define CONFIG_SHA256 /* and SHA256 */
Simon Glass87ebee32013-05-08 08:05:59 +000070# define IMAGE_ENABLE_CRC32 1
71# define IMAGE_ENABLE_MD5 1
72# define IMAGE_ENABLE_SHA1 1
Heiko Schocher2842c1c2014-03-03 12:19:25 +010073# define IMAGE_ENABLE_SHA256 1
Simon Glass87ebee32013-05-08 08:05:59 +000074# endif
75
Dirk Eibach9a4f4792014-07-03 09:28:26 +020076#ifdef CONFIG_FIT_DISABLE_SHA256
77#undef CONFIG_SHA256
78#undef IMAGE_ENABLE_SHA256
79#endif
80
Simon Glass87ebee32013-05-08 08:05:59 +000081#ifndef IMAGE_ENABLE_CRC32
82#define IMAGE_ENABLE_CRC32 0
83#endif
84
85#ifndef IMAGE_ENABLE_MD5
86#define IMAGE_ENABLE_MD5 0
87#endif
88
89#ifndef IMAGE_ENABLE_SHA1
90#define IMAGE_ENABLE_SHA1 0
91#endif
92
Heiko Schocher2842c1c2014-03-03 12:19:25 +010093#ifndef IMAGE_ENABLE_SHA256
94#define IMAGE_ENABLE_SHA256 0
95#endif
96
Simon Glass13d06982013-05-08 08:06:01 +000097#endif /* CONFIG_FIT */
98
99#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
100# define IMAGE_ENABLE_RAMDISK_HIGH 1
101#else
102# define IMAGE_ENABLE_RAMDISK_HIGH 0
103#endif
104
105#ifdef CONFIG_OF_LIBFDT
106# define IMAGE_ENABLE_OF_LIBFDT 1
107#else
108# define IMAGE_ENABLE_OF_LIBFDT 0
109#endif
110
111#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
112# define IMAGE_BOOT_GET_CMDLINE 1
113#else
114# define IMAGE_BOOT_GET_CMDLINE 0
115#endif
116
117#ifdef CONFIG_OF_BOARD_SETUP
Masahiro Yamada95f70622014-01-29 16:29:16 +0900118# define IMAGE_OF_BOARD_SETUP 1
Simon Glass13d06982013-05-08 08:06:01 +0000119#else
Masahiro Yamada95f70622014-01-29 16:29:16 +0900120# define IMAGE_OF_BOARD_SETUP 0
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100121#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100122
Simon Glassc654b512014-10-23 18:58:54 -0600123#ifdef CONFIG_OF_SYSTEM_SETUP
124# define IMAGE_OF_SYSTEM_SETUP 1
125#else
126# define IMAGE_OF_SYSTEM_SETUP 0
127#endif
128
wdenk5b1d7132002-11-03 00:07:02 +0000129/*
130 * Operating System Codes
131 */
132#define IH_OS_INVALID 0 /* Invalid OS */
133#define IH_OS_OPENBSD 1 /* OpenBSD */
134#define IH_OS_NETBSD 2 /* NetBSD */
135#define IH_OS_FREEBSD 3 /* FreeBSD */
136#define IH_OS_4_4BSD 4 /* 4.4BSD */
137#define IH_OS_LINUX 5 /* Linux */
138#define IH_OS_SVR4 6 /* SVR4 */
139#define IH_OS_ESIX 7 /* Esix */
140#define IH_OS_SOLARIS 8 /* Solaris */
141#define IH_OS_IRIX 9 /* Irix */
142#define IH_OS_SCO 10 /* SCO */
143#define IH_OS_DELL 11 /* Dell */
144#define IH_OS_NCR 12 /* NCR */
145#define IH_OS_LYNXOS 13 /* LynxOS */
146#define IH_OS_VXWORKS 14 /* VxWorks */
147#define IH_OS_PSOS 15 /* pSOS */
148#define IH_OS_QNX 16 /* QNX */
149#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000150#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000151#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000152#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500153#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200154#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000155#define IH_OS_PLAN9 23 /* Plan 9 */
Marek Vasut67ddd952014-12-16 14:07:21 +0100156#define IH_OS_OPENRTOS 24 /* OpenRTOS */
wdenk5b1d7132002-11-03 00:07:02 +0000157
158/*
159 * CPU Architecture Codes (supported by Linux)
160 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100161#define IH_ARCH_INVALID 0 /* Invalid CPU */
162#define IH_ARCH_ALPHA 1 /* Alpha */
163#define IH_ARCH_ARM 2 /* ARM */
164#define IH_ARCH_I386 3 /* Intel x86 */
165#define IH_ARCH_IA64 4 /* IA64 */
166#define IH_ARCH_MIPS 5 /* MIPS */
167#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
168#define IH_ARCH_PPC 7 /* PowerPC */
169#define IH_ARCH_S390 8 /* IBM S390 */
170#define IH_ARCH_SH 9 /* SuperH */
171#define IH_ARCH_SPARC 10 /* Sparc */
172#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
173#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100174#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
175#define IH_ARCH_NIOS2 15 /* Nios-II */
176#define IH_ARCH_BLACKFIN 16 /* Blackfin */
177#define IH_ARCH_AVR32 17 /* AVR32 */
178#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000179#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000180#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000181#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
David Feng0ae76532013-12-14 11:47:35 +0800182#define IH_ARCH_ARM64 22 /* ARM64 */
Alexey Brodkinbc5d5422014-02-04 12:56:16 +0400183#define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
Simon Glass5bda35c2014-10-10 08:21:57 -0600184#define IH_ARCH_X86_64 24 /* AMD x86_64, Intel and Via */
wdenk5b1d7132002-11-03 00:07:02 +0000185
186/*
187 * Image Types
188 *
189 * "Standalone Programs" are directly runnable in the environment
190 * provided by U-Boot; it is expected that (if they behave
191 * well) you can continue to work in U-Boot after return from
192 * the Standalone Program.
193 * "OS Kernel Images" are usually images of some Embedded OS which
194 * will take over control completely. Usually these programs
195 * will install their own set of exception handlers, device
196 * drivers, set up the MMU, etc. - this means, that you cannot
197 * expect to re-enter U-Boot except by resetting the CPU.
198 * "RAMDisk Images" are more or less just data blocks, and their
199 * parameters (address, size) are passed to an OS kernel that is
200 * being started.
201 * "Multi-File Images" contain several images, typically an OS
202 * (Linux) kernel image and one or more data images like
203 * RAMDisks. This construct is useful for instance when you want
204 * to boot over the network using BOOTP etc., where the boot
205 * server provides just a single image file, but you want to get
206 * for instance an OS kernel and a RAMDisk image.
207 *
208 * "Multi-File Images" start with a list of image sizes, each
209 * image size (in bytes) specified by an "uint32_t" in network
210 * byte order. This list is terminated by an "(uint32_t)0".
211 * Immediately after the terminating 0 follow the images, one by
212 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000213 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000214 *
215 * "Firmware Images" are binary images containing firmware (like
216 * U-Boot or FPGA images) which usually will be programmed to
217 * flash memory.
218 *
219 * "Script files" are command sequences that will be executed by
220 * U-Boot's command interpreter; this feature is especially
221 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000222 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000223 */
224
225#define IH_TYPE_INVALID 0 /* Invalid Image */
226#define IH_TYPE_STANDALONE 1 /* Standalone Program */
227#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
228#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
229#define IH_TYPE_MULTI 4 /* Multi-File Image */
230#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
231#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000232#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500233#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530234#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100235#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000236#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400237#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000238#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e892011-11-10 13:17:53 -0700239#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000240#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
Marek Vasutbce88372013-08-26 20:43:33 +0200241#define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
Karicheri, Muralidharanbf411ea2014-04-04 13:16:48 -0400242#define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
Andreas Bießmann7b1a4112014-05-19 14:23:39 +0200243#define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
Charles Manning832472a2014-03-06 15:40:50 +1300244#define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */
Simon Glass90268b82014-10-19 21:11:24 -0600245#define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */
Albert ARIBAUD \(3ADEV\)39f520b2015-03-31 11:40:49 +0200246#define IH_TYPE_LPC32XXIMAGE 21 /* x86 setup.bin Image */
Karl Apsite84a07db2015-05-21 09:52:48 -0400247#define IH_TYPE_LOADABLE 22 /* A list of typeless images */
Simon Glassa131c1f2015-08-30 16:55:24 -0600248#define IH_TYPE_RKIMAGE 23 /* Rockchip Boot Image */
Simon Glassf9a3c272015-08-30 16:55:25 -0600249#define IH_TYPE_RKSD 24 /* Rockchip SD card */
Simon Glass10b84fe2015-08-30 16:55:26 -0600250#define IH_TYPE_RKSPI 25 /* Rockchip SPI image */
Nathan Rossi66eef1e2015-11-17 22:56:56 +1000251#define IH_TYPE_ZYNQIMAGE 26 /* Xilinx Zynq Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000252
Nathan Rossi66eef1e2015-11-17 22:56:56 +1000253#define IH_TYPE_COUNT 27 /* Number of image types */
Simon Glass5b9d44d2015-06-23 15:38:25 -0600254
wdenk5b1d7132002-11-03 00:07:02 +0000255/*
256 * Compression Types
257 */
258#define IH_COMP_NONE 0 /* No Compression Used */
259#define IH_COMP_GZIP 1 /* gzip Compression Used */
260#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200261#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100262#define IH_COMP_LZO 4 /* lzo Compression Used */
Julius Werner027b7282015-10-06 20:03:53 -0700263#define IH_COMP_LZ4 5 /* lz4 Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000264
265#define IH_MAGIC 0x27051956 /* Image Magic Number */
266#define IH_NMLEN 32 /* Image Name Length */
267
Fabio Estevam1411fb32013-01-03 08:24:33 +0000268/* Reused from common.h */
269#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
270
wdenk5b1d7132002-11-03 00:07:02 +0000271/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100272 * Legacy format image header,
273 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000274 */
wdenk5b1d7132002-11-03 00:07:02 +0000275typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000276 __be32 ih_magic; /* Image Header Magic Number */
277 __be32 ih_hcrc; /* Image Header CRC Checksum */
278 __be32 ih_time; /* Image Creation Timestamp */
279 __be32 ih_size; /* Image Data Size */
280 __be32 ih_load; /* Data Load Address */
281 __be32 ih_ep; /* Entry Point Address */
282 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000283 uint8_t ih_os; /* Operating System */
284 uint8_t ih_arch; /* CPU architecture */
285 uint8_t ih_type; /* Image Type */
286 uint8_t ih_comp; /* Compression Type */
287 uint8_t ih_name[IH_NMLEN]; /* Image Name */
288} image_header_t;
289
Kumar Gala396f6352008-08-15 08:24:41 -0500290typedef struct image_info {
291 ulong start, end; /* start/end of blob */
292 ulong image_start, image_len; /* start of image within blob, len of image */
293 ulong load; /* load addr for the image */
294 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass90268b82014-10-19 21:11:24 -0600295 uint8_t arch; /* CPU architecture */
Kumar Gala396f6352008-08-15 08:24:41 -0500296} image_info_t;
297
Marian Balakowicz559316f2008-01-08 18:11:44 +0100298/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100299 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
300 * routines.
301 */
302typedef struct bootm_headers {
303 /*
304 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100305 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100306 * data from second and third component accordingly.
307 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200308 image_header_t *legacy_hdr_os; /* image header pointer */
309 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100310 ulong legacy_hdr_valid;
311
312#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100313 const char *fit_uname_cfg; /* configuration node unit name */
314
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100315 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100316 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100317 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100318
319 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100320 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
321 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100322
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100323 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100324 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
325 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass90268b82014-10-19 21:11:24 -0600326
327 void *fit_hdr_setup; /* x86 setup FIT image header */
328 const char *fit_uname_setup; /* x86 setup subimage node name */
329 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100330#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100331
Kumar Gala49c3a862008-10-21 17:25:45 -0500332#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500333 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500334 ulong ep; /* entry point of OS */
335
Kumar Galac4f94192008-08-15 08:24:37 -0500336 ulong rd_start, rd_end;/* ramdisk start/end */
337
Kumar Gala06a09912008-08-15 08:24:38 -0500338 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500339 ulong ft_len; /* length of flat device tree */
340
Kumar Gala49c3a862008-10-21 17:25:45 -0500341 ulong initrd_start;
342 ulong initrd_end;
343 ulong cmdline_start;
344 ulong cmdline_end;
345 bd_t *kbd;
346#endif
347
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100348 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500349
350#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700351#define BOOTM_STATE_FINDOS (0x00000002)
352#define BOOTM_STATE_FINDOTHER (0x00000004)
353#define BOOTM_STATE_LOADOS (0x00000008)
354#define BOOTM_STATE_RAMDISK (0x00000010)
355#define BOOTM_STATE_FDT (0x00000020)
356#define BOOTM_STATE_OS_CMDLINE (0x00000040)
357#define BOOTM_STATE_OS_BD_T (0x00000080)
358#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700359#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
360#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500361 int state;
362
Mike Frysingera16028d2009-11-03 11:35:59 -0500363#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500364 struct lmb lmb; /* for memory mgmt */
365#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100366} bootm_headers_t;
367
Simon Schwarz1648a372012-03-15 04:01:34 +0000368extern bootm_headers_t images;
369
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100370/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100371 * Some systems (for example LWMON) have very short watchdog periods;
372 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200373 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100374 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200375#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100376#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200377#endif
378
379#ifndef CHUNKSZ_CRC32
380#define CHUNKSZ_CRC32 (64 * 1024)
381#endif
382
383#ifndef CHUNKSZ_MD5
384#define CHUNKSZ_MD5 (64 * 1024)
385#endif
386
387#ifndef CHUNKSZ_SHA1
388#define CHUNKSZ_SHA1 (64 * 1024)
389#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100390
Mike Frysinger37566092009-07-02 19:23:25 -0400391#define uimage_to_cpu(x) be32_to_cpu(x)
392#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000393
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530394/*
395 * Translation table for entries of a specific type; used by
396 * get_table_entry_id() and get_table_entry_name().
397 */
398typedef struct table_entry {
399 int id;
400 char *sname; /* short (input) name to find table entry */
401 char *lname; /* long (output) name to print for messages */
402} table_entry_t;
403
404/*
405 * get_table_entry_id() scans the translation table trying to find an
406 * entry that matches the given short name. If a matching entry is
407 * found, it's id is returned to the caller.
408 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400409int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530410 const char *table_name, const char *name);
411/*
412 * get_table_entry_name() scans the translation table trying to find
413 * an entry that matches the given id. If a matching entry is found,
414 * its long name is returned to the caller.
415 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400416char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530417
Stephen Warren712fbcf2011-10-18 11:11:49 +0000418const char *genimg_get_os_name(uint8_t os);
419const char *genimg_get_arch_name(uint8_t arch);
420const char *genimg_get_type_name(uint8_t type);
Simon Glass5b9d44d2015-06-23 15:38:25 -0600421
422/**
423 * genimg_get_type_short_name() - get the short name for an image type
424 *
425 * @param type Image type (IH_TYPE_...)
426 * @return image short name, or "unknown" if unknown
427 */
428const char *genimg_get_type_short_name(uint8_t type);
429
Stephen Warren712fbcf2011-10-18 11:11:49 +0000430const char *genimg_get_comp_name(uint8_t comp);
431int genimg_get_os_id(const char *name);
432int genimg_get_arch_id(const char *name);
433int genimg_get_type_id(const char *name);
434int genimg_get_comp_id(const char *name);
435void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100436
Simon Glass859e92b2013-05-07 06:11:51 +0000437#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
438 defined(USE_HOSTCC)
439#define IMAGE_ENABLE_TIMESTAMP 1
440#else
441#define IMAGE_ENABLE_TIMESTAMP 0
442#endif
443void genimg_print_time(time_t timestamp);
444
Simon Glass782cfbb2013-05-16 13:53:21 +0000445/* What to do with a image load address ('load = <> 'in the FIT) */
446enum fit_load_op {
447 FIT_LOAD_IGNORED, /* Ignore load address */
448 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600449 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000450 FIT_LOAD_REQUIRED, /* Must be provided */
451};
452
Simon Glass90268b82014-10-19 21:11:24 -0600453int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
454 ulong *setup_len);
455
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100456#ifndef USE_HOSTCC
457/* Image format types, returned by _get_format() routine */
458#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher21d29f72014-05-28 11:33:33 +0200459#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100460#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200461#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100462#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500463#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100464
Bryan Wu6c454fe2014-08-15 16:51:38 -0700465ulong genimg_get_kernel_addr_fit(char * const img_addr,
466 const char **fit_uname_config,
467 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700468ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000469int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000470int genimg_has_config(bootm_headers_t *images);
471ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100472
Stephen Warren712fbcf2011-10-18 11:11:49 +0000473int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100474 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite84a07db2015-05-21 09:52:48 -0400475
476/**
477 * boot_get_loadable - routine to load a list of binaries to memory
478 * @argc: Ignored Argument
479 * @argv: Ignored Argument
480 * @images: pointer to the bootm images structure
481 * @arch: expected architecture for the image
482 * @ld_start: Ignored Argument
483 * @ld_len: Ignored Argument
484 *
485 * boot_get_loadable() will take the given FIT configuration, and look
486 * for a field named "loadables". Loadables, is a list of elements in
487 * the FIT given as strings. exe:
488 * loadables = "linux_kernel@1", "fdt@2";
489 * this function will attempt to parse each string, and load the
490 * corresponding element from the FIT into memory. Once placed,
491 * no aditional actions are taken.
492 *
493 * @return:
494 * 0, if only valid images or no images are found
495 * error code, if an error occurs during fit_image_load
496 */
497int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
498 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
499#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100500
Simon Glass90268b82014-10-19 21:11:24 -0600501int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
502 ulong *setup_start, ulong *setup_len);
503
Simon Glass782cfbb2013-05-16 13:53:21 +0000504/**
505 * fit_image_load() - load an image from a FIT
506 *
507 * This deals with all aspects of loading an image from a FIT, including
508 * selecting the right image based on configuration, verifying it, printing
509 * out progress messages, checking the type/arch/os and optionally copying it
510 * to the right load address.
511 *
Simon Glass126cc862014-06-12 07:24:47 -0600512 * The property to look up is defined by image_type.
513 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000514 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000515 * @param addr Address of FIT in memory
516 * @param fit_unamep On entry this is the requested image name
517 * (e.g. "kernel@1") or NULL to use the default. On exit
518 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700519 * @param fit_uname_configp On entry this is the requested configuration
520 * name (e.g. "conf@1") or NULL to use the default. On
521 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000522 * @param arch Expected architecture (IH_ARCH_...)
523 * @param image_type Required image type (IH_TYPE_...). If this is
524 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
525 * also.
526 * @param bootstage_id ID of starting bootstage to use for progress updates.
527 * This will be added to the BOOTSTAGE_SUB values when
528 * calling bootstage_mark()
529 * @param load_op Decribes what to do with the load address
530 * @param datap Returns address of loaded image
531 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600532 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000533 */
Simon Glass126cc862014-06-12 07:24:47 -0600534int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700535 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000536 int arch, int image_type, int bootstage_id,
537 enum fit_load_op load_op, ulong *datap, ulong *lenp);
538
Simon Glassce1400f2014-06-12 07:24:53 -0600539#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000540/**
541 * fit_get_node_from_config() - Look up an image a FIT by type
542 *
543 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
544 * particular image type (e.g. "kernel") and then finds the image that is
545 * referred to.
546 *
547 * For example, for something like:
548 *
549 * images {
550 * kernel@1 {
551 * ...
552 * };
553 * };
554 * configurations {
555 * conf@1 {
556 * kernel = "kernel@1";
557 * };
558 * };
559 *
560 * the function will return the node offset of the kernel@1 node, assuming
561 * that conf@1 is the chosen configuration.
562 *
563 * @param images Boot images structure
564 * @param prop_name Property name to look up (FIT_..._PROP)
565 * @param addr Address of FIT in memory
566 */
567int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
568 ulong addr);
569
Simon Glass53f375f2013-05-16 13:53:23 +0000570int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
571 bootm_headers_t *images,
572 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000573void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000574int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500575
Stephen Warren712fbcf2011-10-18 11:11:49 +0000576int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100577 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000578int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600579#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000580int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600581#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100582#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100583
584/*******************************************************************/
585/* Legacy format specific code (prefixed with image_) */
586/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000587static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100588{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000589 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100590}
591
592#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200593 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100594 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000595 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100596 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000597image_get_hdr_l(magic) /* image_get_magic */
598image_get_hdr_l(hcrc) /* image_get_hcrc */
599image_get_hdr_l(time) /* image_get_time */
600image_get_hdr_l(size) /* image_get_size */
601image_get_hdr_l(load) /* image_get_load */
602image_get_hdr_l(ep) /* image_get_ep */
603image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100604
605#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200606 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100607 { \
608 return hdr->ih_##f; \
609 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000610image_get_hdr_b(os) /* image_get_os */
611image_get_hdr_b(arch) /* image_get_arch */
612image_get_hdr_b(type) /* image_get_type */
613image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100614
Stephen Warren712fbcf2011-10-18 11:11:49 +0000615static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100616{
617 return (char *)hdr->ih_name;
618}
619
Stephen Warren712fbcf2011-10-18 11:11:49 +0000620static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100621{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000622 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100623}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100624
625/**
626 * image_get_data - get image payload start address
627 * @hdr: image header
628 *
629 * image_get_data() returns address of the image payload. For single
630 * component images it is image data start. For multi component
631 * images it points to the null terminated table of sub-images sizes.
632 *
633 * returns:
634 * image payload data start address
635 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000636static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100637{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000638 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100639}
640
Stephen Warren712fbcf2011-10-18 11:11:49 +0000641static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100642{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000643 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100644}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000645static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100646{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000647 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100648}
649
650#define image_set_hdr_l(f) \
651 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
652 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000653 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100654 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000655image_set_hdr_l(magic) /* image_set_magic */
656image_set_hdr_l(hcrc) /* image_set_hcrc */
657image_set_hdr_l(time) /* image_set_time */
658image_set_hdr_l(size) /* image_set_size */
659image_set_hdr_l(load) /* image_set_load */
660image_set_hdr_l(ep) /* image_set_ep */
661image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100662
663#define image_set_hdr_b(f) \
664 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
665 { \
666 hdr->ih_##f = val; \
667 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000668image_set_hdr_b(os) /* image_set_os */
669image_set_hdr_b(arch) /* image_set_arch */
670image_set_hdr_b(type) /* image_set_type */
671image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100672
Stephen Warren712fbcf2011-10-18 11:11:49 +0000673static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100674{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000675 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100676}
677
Stephen Warren712fbcf2011-10-18 11:11:49 +0000678int image_check_hcrc(const image_header_t *hdr);
679int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100680#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600681ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500682phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000683phys_size_t getenv_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100684#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600685void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100686
Stephen Warren712fbcf2011-10-18 11:11:49 +0000687static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100688{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000689 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100690}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000691static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100692{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000693 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100694}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000695static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100696{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000697 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100698}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000699static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100700{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000701 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100702}
703
Stephen Warren712fbcf2011-10-18 11:11:49 +0000704ulong image_multi_count(const image_header_t *hdr);
705void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100706 ulong *data, ulong *len);
707
Stephen Warren712fbcf2011-10-18 11:11:49 +0000708void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100709
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100710#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000711static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100712{
Mike Frysinger476af292011-10-03 14:50:33 +0000713#ifndef IH_ARCH_DEFAULT
714# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100715#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000716 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100717}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100718#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100719
Simon Glass13d06982013-05-08 08:06:01 +0000720/**
721 * Set up properties in the FDT
722 *
723 * This sets up properties in the FDT that is to be passed to linux.
724 *
725 * @images: Images information
726 * @blob: FDT to update
727 * @of_size: Size of the FDT
728 * @lmb: Points to logical memory block structure
729 * @return 0 if ok, <0 on failure
730 */
731int image_setup_libfdt(bootm_headers_t *images, void *blob,
732 int of_size, struct lmb *lmb);
733
734/**
735 * Set up the FDT to use for booting a kernel
736 *
737 * This performs ramdisk setup, sets up the FDT if required, and adds
738 * paramters to the FDT if libfdt is available.
739 *
740 * @param images Images information
741 * @return 0 if ok, <0 on failure
742 */
743int image_setup_linux(bootm_headers_t *images);
744
Simon Glassa5266d62013-07-04 13:26:10 -0700745/**
746 * bootz_setup() - Extract stat and size of a Linux xImage
747 *
748 * @image: Address of image
749 * @start: Returns start address of image
750 * @end : Returns end address of image
751 * @return 0 if OK, 1 if the image was not recognised
752 */
753int bootz_setup(ulong image, ulong *start, ulong *end);
754
755
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100756/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100757/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100758/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100759#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100760
761#define FIT_IMAGES_PATH "/images"
762#define FIT_CONFS_PATH "/configurations"
763
Simon Glass3e569a62013-06-13 15:10:00 -0700764/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100765#define FIT_HASH_NODENAME "hash"
766#define FIT_ALGO_PROP "algo"
767#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000768#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700769#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100770
771/* image node */
772#define FIT_DATA_PROP "data"
773#define FIT_TIMESTAMP_PROP "timestamp"
774#define FIT_DESC_PROP "description"
775#define FIT_ARCH_PROP "arch"
776#define FIT_TYPE_PROP "type"
777#define FIT_OS_PROP "os"
778#define FIT_COMP_PROP "compression"
779#define FIT_ENTRY_PROP "entry"
780#define FIT_LOAD_PROP "load"
781
782/* configuration node */
783#define FIT_KERNEL_PROP "kernel"
784#define FIT_RAMDISK_PROP "ramdisk"
785#define FIT_FDT_PROP "fdt"
Karl Apsiteecf8cd62015-05-21 09:52:47 -0400786#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100787#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -0600788#define FIT_SETUP_PROP "setup"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100789
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200790#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100791
792/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000793int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100794 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000795int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100796 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100797
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200798int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000799void fit_print_contents(const void *fit);
800void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100801
802/**
803 * fit_get_end - get FIT image size
804 * @fit: pointer to the FIT format image header
805 *
806 * returns:
807 * size of the FIT image (blob) in memory
808 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000809static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100810{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000811 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100812}
813
814/**
815 * fit_get_end - get FIT image end
816 * @fit: pointer to the FIT format image header
817 *
818 * returns:
819 * end address of the FIT image (blob) in memory
820 */
Simon Glass7a80de42016-02-24 09:14:42 -0700821ulong fit_get_end(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100822
823/**
824 * fit_get_name - get FIT node name
825 * @fit: pointer to the FIT format image header
826 *
827 * returns:
828 * NULL, on error
829 * pointer to node name, on success
830 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000831static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100832 int noffset, int *len)
833{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000834 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100835}
836
Stephen Warren712fbcf2011-10-18 11:11:49 +0000837int fit_get_desc(const void *fit, int noffset, char **desc);
838int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100839
Stephen Warren712fbcf2011-10-18 11:11:49 +0000840int fit_image_get_node(const void *fit, const char *image_uname);
841int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
842int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
843int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
844int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
845int fit_image_get_load(const void *fit, int noffset, ulong *load);
846int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
847int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100848 const void **data, size_t *size);
849
Stephen Warren712fbcf2011-10-18 11:11:49 +0000850int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
851int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100852 int *value_len);
853
Stephen Warren712fbcf2011-10-18 11:11:49 +0000854int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000855
856/**
Simon Glass56518e72013-06-13 15:10:01 -0700857 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000858 *
Simon Glass56518e72013-06-13 15:10:01 -0700859 * @keydir: Directory containing keys
860 * @kwydest: FDT blob to write public key information to
861 * @fit: Pointer to the FIT format image header
862 * @comment: Comment to add to signature nodes
863 * @require_keys: Mark all keys as 'required'
864 *
865 * Adds hash values for all component images in the FIT blob.
866 * Hashes are calculated for all component images which have hash subnodes
867 * with algorithm property set to one of the supported hash algorithms.
868 *
869 * Also add signatures if signature nodes are present.
870 *
871 * returns
872 * 0, on success
873 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000874 */
Simon Glass56518e72013-06-13 15:10:01 -0700875int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
876 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100877
Simon Glassb8da8362013-05-07 06:11:57 +0000878int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000879int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000880int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000881int fit_image_check_os(const void *fit, int noffset, uint8_t os);
882int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
883int fit_image_check_type(const void *fit, int noffset, uint8_t type);
884int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
885int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100886
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000887int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000888int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100889
Simon Glass003efd72013-05-07 06:12:00 +0000890/**
891 * fit_conf_get_prop_node() - Get node refered to by a configuration
892 * @fit: FIT to check
893 * @noffset: Offset of conf@xxx node to check
894 * @prop_name: Property to read from the conf node
895 *
896 * The conf@ nodes contain references to other nodes, using properties
897 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
898 * return the offset of the node referred to (e.g. offset of node
899 * "/images/kernel@1".
900 */
901int fit_conf_get_prop_node(const void *fit, int noffset,
902 const char *prop_name);
903
Stephen Warren712fbcf2011-10-18 11:11:49 +0000904void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100905
Simon Glass61a439a2013-05-07 06:11:52 +0000906int fit_check_ramdisk(const void *fit, int os_noffset,
907 uint8_t arch, int verify);
908
Simon Glass604f23d2013-05-07 06:11:54 +0000909int calculate_hash(const void *data, int data_len, const char *algo,
910 uint8_t *value, int *value_len);
911
Simon Glass782cfbb2013-05-16 13:53:21 +0000912/*
Simon Glass3e569a62013-06-13 15:10:00 -0700913 * At present we only support signing on the host, and verification on the
914 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000915 */
916#if defined(CONFIG_FIT_SIGNATURE)
917# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700918# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +0100919# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +0100920# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +0000921#else
Simon Glass3e569a62013-06-13 15:10:00 -0700922# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000923# define IMAGE_ENABLE_VERIFY 1
924# endif
925#else
Simon Glass3e569a62013-06-13 15:10:00 -0700926# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000927# define IMAGE_ENABLE_VERIFY 0
928#endif
929
930#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +0100931void *image_get_host_blob(void);
932void image_set_host_blob(void *host_blob);
933# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +0000934#else
935# define gd_fdt_blob() (gd->fdt_blob)
936#endif
937
938#ifdef CONFIG_FIT_BEST_MATCH
939#define IMAGE_ENABLE_BEST_MATCH 1
940#else
941#define IMAGE_ENABLE_BEST_MATCH 0
942#endif
943
Simon Glass3e569a62013-06-13 15:10:00 -0700944/* Information passed to the signing routines */
945struct image_sign_info {
946 const char *keydir; /* Directory conaining keys */
947 const char *keyname; /* Name of key to use */
948 void *fit; /* Pointer to FIT blob */
949 int node_offset; /* Offset of signature node */
950 struct image_sig_algo *algo; /* Algorithm information */
951 const void *fdt_blob; /* FDT containing public keys */
952 int required_keynode; /* Node offset of key to use: -1=any */
953 const char *require_keys; /* Value for 'required' property */
954};
955
956/* A part of an image, used for hashing */
957struct image_region {
958 const void *data;
959 int size;
960};
961
Heiko Schocher646257d2014-03-03 12:19:26 +0100962#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +0200963# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +0100964#endif
965struct checksum_algo {
966 const char *name;
967 const int checksum_len;
Heiko Schocherdb1b5f32014-03-03 12:19:27 +0100968 const int pad_len;
Heiko Schocher646257d2014-03-03 12:19:26 +0100969#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +0100970 const EVP_MD *(*calculate_sign)(void);
971#endif
Ruchika Guptab37b46f2015-01-23 16:01:59 +0530972 int (*calculate)(const char *name,
973 const struct image_region region[],
974 int region_count, uint8_t *checksum);
Heiko Schocher646257d2014-03-03 12:19:26 +0100975 const uint8_t *rsa_padding;
Heiko Schocher646257d2014-03-03 12:19:26 +0100976};
977
Simon Glass3e569a62013-06-13 15:10:00 -0700978struct image_sig_algo {
979 const char *name; /* Name of algorithm */
980
981 /**
982 * sign() - calculate and return signature for given input data
983 *
984 * @info: Specifies key and FIT information
985 * @data: Pointer to the input data
986 * @data_len: Data length
987 * @sigp: Set to an allocated buffer holding the signature
988 * @sig_len: Set to length of the calculated hash
989 *
990 * This computes input data signature according to selected algorithm.
991 * Resulting signature value is placed in an allocated buffer, the
992 * pointer is returned as *sigp. The length of the calculated
993 * signature is returned via the sig_len pointer argument. The caller
994 * should free *sigp.
995 *
996 * @return: 0, on success, -ve on error
997 */
998 int (*sign)(struct image_sign_info *info,
999 const struct image_region region[],
1000 int region_count, uint8_t **sigp, uint *sig_len);
1001
1002 /**
1003 * add_verify_data() - Add verification information to FDT
1004 *
1005 * Add public key information to the FDT node, suitable for
1006 * verification at run-time. The information added depends on the
1007 * algorithm being used.
1008 *
1009 * @info: Specifies key and FIT information
1010 * @keydest: Destination FDT blob for public key data
1011 * @return: 0, on success, -ve on error
1012 */
1013 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1014
1015 /**
1016 * verify() - Verify a signature against some data
1017 *
1018 * @info: Specifies key and FIT information
1019 * @data: Pointer to the input data
1020 * @data_len: Data length
1021 * @sig: Signature
1022 * @sig_len: Number of bytes in signature
1023 * @return 0 if verified, -ve on error
1024 */
1025 int (*verify)(struct image_sign_info *info,
1026 const struct image_region region[], int region_count,
1027 uint8_t *sig, uint sig_len);
Heiko Schocher646257d2014-03-03 12:19:26 +01001028
1029 /* pointer to checksum algorithm */
1030 struct checksum_algo *checksum;
Simon Glass3e569a62013-06-13 15:10:00 -07001031};
1032
1033/**
1034 * image_get_sig_algo() - Look up a signature algortihm
1035 *
1036 * @param name Name of algorithm
1037 * @return pointer to algorithm information, or NULL if not found
1038 */
1039struct image_sig_algo *image_get_sig_algo(const char *name);
1040
Simon Glass56518e72013-06-13 15:10:01 -07001041/**
1042 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1043 *
1044 * @fit: FIT to check
1045 * @image_noffset: Offset of image node to check
1046 * @data: Image data to check
1047 * @size: Size of image data
1048 * @sig_blob: FDT containing public keys
1049 * @no_sigsp: Returns 1 if no signatures were required, and
1050 * therefore nothing was checked. The caller may wish
1051 * to fall back to other mechanisms, or refuse to
1052 * boot.
1053 * @return 0 if all verified ok, <0 on error
1054 */
1055int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1056 const char *data, size_t size, const void *sig_blob,
1057 int *no_sigsp);
1058
1059/**
1060 * fit_image_check_sig() - Check a single image signature node
1061 *
1062 * @fit: FIT to check
1063 * @noffset: Offset of signature node to check
1064 * @data: Image data to check
1065 * @size: Size of image data
1066 * @required_keynode: Offset in the control FDT of the required key node,
1067 * if any. If this is given, then the image wil not
1068 * pass verification unless that key is used. If this is
1069 * -1 then any signature will do.
1070 * @err_msgp: In the event of an error, this will be pointed to a
1071 * help error string to display to the user.
1072 * @return 0 if all verified ok, <0 on error
1073 */
1074int fit_image_check_sig(const void *fit, int noffset, const void *data,
1075 size_t size, int required_keynode, char **err_msgp);
1076
Simon Glass4d098522013-06-13 15:10:09 -07001077/**
1078 * fit_region_make_list() - Make a list of regions to hash
1079 *
1080 * Given a list of FIT regions (offset, size) provided by libfdt, create
1081 * a list of regions (void *, size) for use by the signature creationg
1082 * and verification code.
1083 *
1084 * @fit: FIT image to process
1085 * @fdt_regions: Regions as returned by libfdt
1086 * @count: Number of regions returned by libfdt
1087 * @region: Place to put list of regions (NULL to allocate it)
1088 * @return pointer to list of regions, or NULL if out of memory
1089 */
1090struct image_region *fit_region_make_list(const void *fit,
1091 struct fdt_region *fdt_regions, int count,
1092 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001093
Stephen Warren712fbcf2011-10-18 11:11:49 +00001094static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001095{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001096#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001097 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001098#else
1099 return 0;
1100#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001101}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001102
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001103#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001104#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001105 "FIT images not supported for '%s'\n", \
1106 __FILE__, __LINE__, (msg))
1107
Stephen Warren712fbcf2011-10-18 11:11:49 +00001108#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001109 "FIT images not supported for '%s' " \
1110 "- must reset board to recover!\n", \
1111 __FILE__, __LINE__, (msg))
1112#else
1113#define fit_unsupported(msg)
1114#define fit_unsupported_reset(msg)
1115#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001116#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001117
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001118#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1119struct andr_img_hdr;
1120int android_image_check_header(const struct andr_img_hdr *hdr);
1121int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1122 ulong *os_data, ulong *os_len);
1123int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1124 ulong *rd_data, ulong *rd_len);
1125ulong android_image_get_end(const struct andr_img_hdr *hdr);
1126ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1127
1128#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1129
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001130#endif /* __IMAGE_H__ */