blob: c1065c06f9bdbcb1b63727c20086ab2f8edc9b05 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk5b1d7132002-11-03 00:07:02 +00002/*
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01003 * (C) Copyright 2008 Semihalf
4 *
Wolfgang Denkf08abe32005-11-25 16:38:03 +01005 * (C) Copyright 2000-2005
wdenk5b1d7132002-11-03 00:07:02 +00006 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
Wolfgang Denkf08abe32005-11-25 16:38:03 +01007 ********************************************************************
8 * NOTE: This header file defines an interface to U-Boot. Including
9 * this (unmodified) header file in another file is considered normal
10 * use of U-Boot, and does *not* fall under the heading of "derived
11 * work".
12 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000013 */
14
15#ifndef __IMAGE_H__
16#define __IMAGE_H__
17
Mike Frysinger37566092009-07-02 19:23:25 -040018#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000019#include <asm/byteorder.h>
Marek Vasut7f13b372018-06-13 06:13:32 +020020#include <stdbool.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;
Masahiro Yamada641599a2018-03-21 18:03:35 +090024struct fdt_region;
Simon Glass13d06982013-05-08 08:06:01 +000025
Mike Frysinger37566092009-07-02 19:23:25 -040026#ifdef USE_HOSTCC
Jörg Krause26e355d2015-04-22 21:36:22 +020027#include <sys/types.h>
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010028
29/* new uImage format support enabled on host */
Simon Glassaa34fbc2016-02-22 22:55:45 -070030#define IMAGE_ENABLE_FIT 1
31#define IMAGE_ENABLE_OF_LIBFDT 1
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010032#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
Philippe Reynes061daa02018-11-14 13:51:01 +010033#define CONFIG_FIT_ENABLE_RSASSA_PSS_SUPPORT 1
Tom Rini0db7f682017-05-15 12:17:48 -040034#define CONFIG_FIT_ENABLE_SHA256_SUPPORT
Tom Rini089df182017-05-15 12:17:49 -040035#define CONFIG_SHA1
36#define CONFIG_SHA256
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010037
Simon Glassab9efc62013-05-07 06:11:58 +000038#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000039#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000040
Wolfgang Denkdef08192008-10-21 11:23:56 +020041#else
42
43#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020044#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050045#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020046
Simon Glassab9efc62013-05-07 06:11:58 +000047/* Take notice of the 'ignore' property for hashes */
48#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000049#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000050
Simon Glassaa34fbc2016-02-22 22:55:45 -070051#define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
52#define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
Simon Glass73223f02016-02-22 22:55:43 -070053
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010054#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010055
Simon Glass73223f02016-02-22 22:55:43 -070056#if IMAGE_ENABLE_FIT
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020057#include <hash.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090058#include <linux/libfdt.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010059#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000060# ifdef CONFIG_SPL_BUILD
Masahiro Yamada6f417512016-05-31 20:41:54 +090061# ifdef CONFIG_SPL_CRC32_SUPPORT
62# define IMAGE_ENABLE_CRC32 1
63# endif
64# ifdef CONFIG_SPL_MD5_SUPPORT
65# define IMAGE_ENABLE_MD5 1
66# endif
67# ifdef CONFIG_SPL_SHA1_SUPPORT
68# define IMAGE_ENABLE_SHA1 1
69# endif
Simon Glass87ebee32013-05-08 08:05:59 +000070# else
Simon Glass87ebee32013-05-08 08:05:59 +000071# define IMAGE_ENABLE_CRC32 1
72# define IMAGE_ENABLE_MD5 1
73# define IMAGE_ENABLE_SHA1 1
74# endif
Masahiro Yamada6f417512016-05-31 20:41:54 +090075
Masahiro Yamada6f417512016-05-31 20:41:54 +090076#ifndef IMAGE_ENABLE_CRC32
77#define IMAGE_ENABLE_CRC32 0
78#endif
79
80#ifndef IMAGE_ENABLE_MD5
81#define IMAGE_ENABLE_MD5 0
82#endif
83
84#ifndef IMAGE_ENABLE_SHA1
85#define IMAGE_ENABLE_SHA1 0
86#endif
87
Tom Rini0db7f682017-05-15 12:17:48 -040088#if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
89 defined(CONFIG_SPL_SHA256_SUPPORT)
Tom Rini0db7f682017-05-15 12:17:48 -040090#define IMAGE_ENABLE_SHA256 1
91#else
Masahiro Yamada6f417512016-05-31 20:41:54 +090092#define IMAGE_ENABLE_SHA256 0
93#endif
94
Simon Glass73223f02016-02-22 22:55:43 -070095#endif /* IMAGE_ENABLE_FIT */
Simon Glass13d06982013-05-08 08:06:01 +000096
Masahiro Yamada6f417512016-05-31 20:41:54 +090097#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
98# define IMAGE_BOOT_GET_CMDLINE 1
99#else
100# define IMAGE_BOOT_GET_CMDLINE 0
101#endif
102
103#ifdef CONFIG_OF_BOARD_SETUP
104# define IMAGE_OF_BOARD_SETUP 1
105#else
106# define IMAGE_OF_BOARD_SETUP 0
107#endif
108
109#ifdef CONFIG_OF_SYSTEM_SETUP
110# define IMAGE_OF_SYSTEM_SETUP 1
111#else
112# define IMAGE_OF_SYSTEM_SETUP 0
113#endif
Simon Glassc654b512014-10-23 18:58:54 -0600114
Simon Glass56d7ab72016-06-30 10:52:14 -0600115enum ih_category {
116 IH_ARCH,
117 IH_COMP,
118 IH_OS,
119 IH_TYPE,
120
121 IH_COUNT,
122};
123
wdenk5b1d7132002-11-03 00:07:02 +0000124/*
125 * Operating System Codes
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900126 *
127 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100128 * New IDs *MUST* be appended at the end of the list and *NEVER*
129 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000130 */
Simon Glass555f45d2016-06-30 10:52:13 -0600131enum {
132 IH_OS_INVALID = 0, /* Invalid OS */
133 IH_OS_OPENBSD, /* OpenBSD */
134 IH_OS_NETBSD, /* NetBSD */
135 IH_OS_FREEBSD, /* FreeBSD */
136 IH_OS_4_4BSD, /* 4.4BSD */
137 IH_OS_LINUX, /* Linux */
138 IH_OS_SVR4, /* SVR4 */
139 IH_OS_ESIX, /* Esix */
140 IH_OS_SOLARIS, /* Solaris */
141 IH_OS_IRIX, /* Irix */
142 IH_OS_SCO, /* SCO */
143 IH_OS_DELL, /* Dell */
144 IH_OS_NCR, /* NCR */
145 IH_OS_LYNXOS, /* LynxOS */
146 IH_OS_VXWORKS, /* VxWorks */
147 IH_OS_PSOS, /* pSOS */
148 IH_OS_QNX, /* QNX */
149 IH_OS_U_BOOT, /* Firmware */
150 IH_OS_RTEMS, /* RTEMS */
151 IH_OS_ARTOS, /* ARTOS */
152 IH_OS_UNITY, /* Unity OS */
153 IH_OS_INTEGRITY, /* INTEGRITY */
154 IH_OS_OSE, /* OSE */
155 IH_OS_PLAN9, /* Plan 9 */
156 IH_OS_OPENRTOS, /* OpenRTOS */
Philipp Tomsich4914af12017-09-13 21:29:29 +0200157 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
Bryan O'Donoghue45b55712018-03-13 16:50:35 +0000158 IH_OS_TEE, /* Trusted Execution Environment */
Lukas Auer5e30e452019-08-21 21:14:44 +0200159 IH_OS_OPENSBI, /* RISC-V OpenSBI */
Simon Glass555f45d2016-06-30 10:52:13 -0600160
161 IH_OS_COUNT,
162};
wdenk5b1d7132002-11-03 00:07:02 +0000163
164/*
165 * CPU Architecture Codes (supported by Linux)
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900166 *
167 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100168 * New IDs *MUST* be appended at the end of the list and *NEVER*
169 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000170 */
Simon Glass555f45d2016-06-30 10:52:13 -0600171enum {
172 IH_ARCH_INVALID = 0, /* Invalid CPU */
173 IH_ARCH_ALPHA, /* Alpha */
174 IH_ARCH_ARM, /* ARM */
175 IH_ARCH_I386, /* Intel x86 */
176 IH_ARCH_IA64, /* IA64 */
177 IH_ARCH_MIPS, /* MIPS */
178 IH_ARCH_MIPS64, /* MIPS 64 Bit */
179 IH_ARCH_PPC, /* PowerPC */
180 IH_ARCH_S390, /* IBM S390 */
181 IH_ARCH_SH, /* SuperH */
182 IH_ARCH_SPARC, /* Sparc */
183 IH_ARCH_SPARC64, /* Sparc 64 Bit */
184 IH_ARCH_M68K, /* M68K */
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900185 IH_ARCH_NIOS, /* Nios-32 */
Simon Glass555f45d2016-06-30 10:52:13 -0600186 IH_ARCH_MICROBLAZE, /* MicroBlaze */
187 IH_ARCH_NIOS2, /* Nios-II */
188 IH_ARCH_BLACKFIN, /* Blackfin */
189 IH_ARCH_AVR32, /* AVR32 */
190 IH_ARCH_ST200, /* STMicroelectronics ST200 */
191 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
192 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
193 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
194 IH_ARCH_ARM64, /* ARM64 */
195 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
196 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
Chris Zankelde5e5ce2016-08-10 18:36:43 +0300197 IH_ARCH_XTENSA, /* Xtensa */
Rick Chen068feb92017-12-26 13:55:58 +0800198 IH_ARCH_RISCV, /* RISC-V */
Simon Glass555f45d2016-06-30 10:52:13 -0600199
200 IH_ARCH_COUNT,
201};
wdenk5b1d7132002-11-03 00:07:02 +0000202
203/*
204 * Image Types
205 *
206 * "Standalone Programs" are directly runnable in the environment
207 * provided by U-Boot; it is expected that (if they behave
208 * well) you can continue to work in U-Boot after return from
209 * the Standalone Program.
210 * "OS Kernel Images" are usually images of some Embedded OS which
211 * will take over control completely. Usually these programs
212 * will install their own set of exception handlers, device
213 * drivers, set up the MMU, etc. - this means, that you cannot
214 * expect to re-enter U-Boot except by resetting the CPU.
215 * "RAMDisk Images" are more or less just data blocks, and their
216 * parameters (address, size) are passed to an OS kernel that is
217 * being started.
218 * "Multi-File Images" contain several images, typically an OS
219 * (Linux) kernel image and one or more data images like
220 * RAMDisks. This construct is useful for instance when you want
221 * to boot over the network using BOOTP etc., where the boot
222 * server provides just a single image file, but you want to get
223 * for instance an OS kernel and a RAMDisk image.
224 *
225 * "Multi-File Images" start with a list of image sizes, each
226 * image size (in bytes) specified by an "uint32_t" in network
227 * byte order. This list is terminated by an "(uint32_t)0".
228 * Immediately after the terminating 0 follow the images, one by
229 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000230 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000231 *
232 * "Firmware Images" are binary images containing firmware (like
233 * U-Boot or FPGA images) which usually will be programmed to
234 * flash memory.
235 *
236 * "Script files" are command sequences that will be executed by
237 * U-Boot's command interpreter; this feature is especially
238 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000239 * as command interpreter (=> Shell Scripts).
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900240 *
241 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100242 * New IDs *MUST* be appended at the end of the list and *NEVER*
243 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000244 */
245
Simon Glass555f45d2016-06-30 10:52:13 -0600246enum {
247 IH_TYPE_INVALID = 0, /* Invalid Image */
248 IH_TYPE_STANDALONE, /* Standalone Program */
249 IH_TYPE_KERNEL, /* OS Kernel Image */
250 IH_TYPE_RAMDISK, /* RAMDisk Image */
251 IH_TYPE_MULTI, /* Multi-File Image */
252 IH_TYPE_FIRMWARE, /* Firmware Image */
253 IH_TYPE_SCRIPT, /* Script file */
254 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
255 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
256 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
257 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
258 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
259 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
260 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
261 /* OS Kernel Image, can run from any load address */
262 IH_TYPE_KERNEL_NOLOAD,
263 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
264 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
265 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
266 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
Marek Vasut662abc42018-04-15 13:15:33 +0200267 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
Simon Glass555f45d2016-06-30 10:52:13 -0600268 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
269 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
270 IH_TYPE_LOADABLE, /* A list of typeless images */
271 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
272 IH_TYPE_RKSD, /* Rockchip SD card */
273 IH_TYPE_RKSPI, /* Rockchip SPI image */
274 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
275 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
Alexander Graf6915dcf2018-04-13 14:18:52 +0200276 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
Simon Glass555f45d2016-06-30 10:52:13 -0600277 IH_TYPE_FPGA, /* FPGA Image */
Albert ARIBAUD \(3ADEV\)ed0c2c02016-09-26 09:08:06 +0200278 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
Andrew F. Davis7e719ee2016-11-29 16:33:21 -0600279 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
Sven Ebenfeldd21bd692016-11-06 16:37:56 +0100280 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
Andrew F. Davis6442c962017-07-31 10:58:20 -0500281 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
Patrick Delaunay81260e32018-03-12 10:46:04 +0100282 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
Marek Vasut662abc42018-04-15 13:15:33 +0200283 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
Ryder Lee3b975a12018-11-15 10:07:49 +0800284 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
Stefano Babic24431ad2018-12-17 11:02:00 +0100285 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
286 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
Patrick Delaunaye7fabe72019-08-02 15:07:19 +0200287 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
wdenk5b1d7132002-11-03 00:07:02 +0000288
Simon Glass555f45d2016-06-30 10:52:13 -0600289 IH_TYPE_COUNT, /* Number of image types */
290};
Simon Glass5b9d44d2015-06-23 15:38:25 -0600291
wdenk5b1d7132002-11-03 00:07:02 +0000292/*
293 * Compression Types
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900294 *
295 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100296 * New IDs *MUST* be appended at the end of the list and *NEVER*
297 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000298 */
Simon Glass555f45d2016-06-30 10:52:13 -0600299enum {
300 IH_COMP_NONE = 0, /* No Compression Used */
301 IH_COMP_GZIP, /* gzip Compression Used */
302 IH_COMP_BZIP2, /* bzip2 Compression Used */
303 IH_COMP_LZMA, /* lzma Compression Used */
304 IH_COMP_LZO, /* lzo Compression Used */
305 IH_COMP_LZ4, /* lz4 Compression Used */
306
307 IH_COMP_COUNT,
308};
wdenk5b1d7132002-11-03 00:07:02 +0000309
Eugeniu Rosca829ceb22019-04-08 17:35:27 +0200310#define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
wdenk5b1d7132002-11-03 00:07:02 +0000311#define IH_MAGIC 0x27051956 /* Image Magic Number */
312#define IH_NMLEN 32 /* Image Name Length */
313
Fabio Estevam1411fb32013-01-03 08:24:33 +0000314/* Reused from common.h */
315#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
316
wdenk5b1d7132002-11-03 00:07:02 +0000317/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100318 * Legacy format image header,
319 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000320 */
wdenk5b1d7132002-11-03 00:07:02 +0000321typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000322 __be32 ih_magic; /* Image Header Magic Number */
323 __be32 ih_hcrc; /* Image Header CRC Checksum */
324 __be32 ih_time; /* Image Creation Timestamp */
325 __be32 ih_size; /* Image Data Size */
326 __be32 ih_load; /* Data Load Address */
327 __be32 ih_ep; /* Entry Point Address */
328 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000329 uint8_t ih_os; /* Operating System */
330 uint8_t ih_arch; /* CPU architecture */
331 uint8_t ih_type; /* Image Type */
332 uint8_t ih_comp; /* Compression Type */
333 uint8_t ih_name[IH_NMLEN]; /* Image Name */
334} image_header_t;
335
Kumar Gala396f6352008-08-15 08:24:41 -0500336typedef struct image_info {
337 ulong start, end; /* start/end of blob */
338 ulong image_start, image_len; /* start of image within blob, len of image */
339 ulong load; /* load addr for the image */
340 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass90268b82014-10-19 21:11:24 -0600341 uint8_t arch; /* CPU architecture */
Kumar Gala396f6352008-08-15 08:24:41 -0500342} image_info_t;
343
Marian Balakowicz559316f2008-01-08 18:11:44 +0100344/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100345 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
346 * routines.
347 */
348typedef struct bootm_headers {
349 /*
350 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100351 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100352 * data from second and third component accordingly.
353 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200354 image_header_t *legacy_hdr_os; /* image header pointer */
355 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100356 ulong legacy_hdr_valid;
357
Simon Glass73223f02016-02-22 22:55:43 -0700358#if IMAGE_ENABLE_FIT
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100359 const char *fit_uname_cfg; /* configuration node unit name */
360
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100361 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100362 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100363 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100364
365 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100366 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
367 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100368
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100369 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100370 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
371 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass90268b82014-10-19 21:11:24 -0600372
373 void *fit_hdr_setup; /* x86 setup FIT image header */
374 const char *fit_uname_setup; /* x86 setup subimage node name */
375 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100376#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100377
Kumar Gala49c3a862008-10-21 17:25:45 -0500378#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500379 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500380 ulong ep; /* entry point of OS */
381
Kumar Galac4f94192008-08-15 08:24:37 -0500382 ulong rd_start, rd_end;/* ramdisk start/end */
383
Kumar Gala06a09912008-08-15 08:24:38 -0500384 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500385 ulong ft_len; /* length of flat device tree */
386
Kumar Gala49c3a862008-10-21 17:25:45 -0500387 ulong initrd_start;
388 ulong initrd_end;
389 ulong cmdline_start;
390 ulong cmdline_end;
391 bd_t *kbd;
392#endif
393
Simon Glass00caae62017-08-03 12:22:12 -0600394 int verify; /* env_get("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500395
396#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700397#define BOOTM_STATE_FINDOS (0x00000002)
398#define BOOTM_STATE_FINDOTHER (0x00000004)
399#define BOOTM_STATE_LOADOS (0x00000008)
400#define BOOTM_STATE_RAMDISK (0x00000010)
401#define BOOTM_STATE_FDT (0x00000020)
402#define BOOTM_STATE_OS_CMDLINE (0x00000040)
403#define BOOTM_STATE_OS_BD_T (0x00000080)
404#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700405#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
406#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500407 int state;
408
Mike Frysingera16028d2009-11-03 11:35:59 -0500409#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500410 struct lmb lmb; /* for memory mgmt */
411#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100412} bootm_headers_t;
413
Simon Schwarz1648a372012-03-15 04:01:34 +0000414extern bootm_headers_t images;
415
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100416/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100417 * Some systems (for example LWMON) have very short watchdog periods;
418 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200419 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100420 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200421#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100422#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200423#endif
424
425#ifndef CHUNKSZ_CRC32
426#define CHUNKSZ_CRC32 (64 * 1024)
427#endif
428
429#ifndef CHUNKSZ_MD5
430#define CHUNKSZ_MD5 (64 * 1024)
431#endif
432
433#ifndef CHUNKSZ_SHA1
434#define CHUNKSZ_SHA1 (64 * 1024)
435#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100436
Mike Frysinger37566092009-07-02 19:23:25 -0400437#define uimage_to_cpu(x) be32_to_cpu(x)
438#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000439
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530440/*
441 * Translation table for entries of a specific type; used by
442 * get_table_entry_id() and get_table_entry_name().
443 */
444typedef struct table_entry {
445 int id;
446 char *sname; /* short (input) name to find table entry */
447 char *lname; /* long (output) name to print for messages */
448} table_entry_t;
449
450/*
451 * get_table_entry_id() scans the translation table trying to find an
452 * entry that matches the given short name. If a matching entry is
453 * found, it's id is returned to the caller.
454 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400455int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530456 const char *table_name, const char *name);
457/*
458 * get_table_entry_name() scans the translation table trying to find
459 * an entry that matches the given id. If a matching entry is found,
460 * its long name is returned to the caller.
461 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400462char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530463
Stephen Warren712fbcf2011-10-18 11:11:49 +0000464const char *genimg_get_os_name(uint8_t os);
Simon Glasscef2e512016-02-22 22:55:50 -0700465
466/**
467 * genimg_get_os_short_name() - get the short name for an OS
468 *
469 * @param os OS (IH_OS_...)
470 * @return OS short name, or "unknown" if unknown
471 */
472const char *genimg_get_os_short_name(uint8_t comp);
473
Stephen Warren712fbcf2011-10-18 11:11:49 +0000474const char *genimg_get_arch_name(uint8_t arch);
Simon Glasscef2e512016-02-22 22:55:50 -0700475
476/**
477 * genimg_get_arch_short_name() - get the short name for an architecture
478 *
479 * @param arch Architecture type (IH_ARCH_...)
480 * @return architecture short name, or "unknown" if unknown
481 */
482const char *genimg_get_arch_short_name(uint8_t arch);
483
Stephen Warren712fbcf2011-10-18 11:11:49 +0000484const char *genimg_get_type_name(uint8_t type);
Simon Glass5b9d44d2015-06-23 15:38:25 -0600485
486/**
487 * genimg_get_type_short_name() - get the short name for an image type
488 *
489 * @param type Image type (IH_TYPE_...)
490 * @return image short name, or "unknown" if unknown
491 */
492const char *genimg_get_type_short_name(uint8_t type);
493
Stephen Warren712fbcf2011-10-18 11:11:49 +0000494const char *genimg_get_comp_name(uint8_t comp);
Simon Glasscef2e512016-02-22 22:55:50 -0700495
496/**
497 * genimg_get_comp_short_name() - get the short name for a compression method
498 *
499 * @param comp compression method (IH_COMP_...)
500 * @return compression method short name, or "unknown" if unknown
501 */
502const char *genimg_get_comp_short_name(uint8_t comp);
503
Simon Glass14262202016-06-30 10:52:16 -0600504/**
505 * genimg_get_cat_name() - Get the name of an item in a category
506 *
507 * @category: Category of item
508 * @id: Item ID
509 * @return name of item, or "Unknown ..." if unknown
510 */
511const char *genimg_get_cat_name(enum ih_category category, uint id);
512
513/**
514 * genimg_get_cat_short_name() - Get the short name of an item in a category
515 *
516 * @category: Category of item
517 * @id: Item ID
518 * @return short name of item, or "Unknown ..." if unknown
519 */
520const char *genimg_get_cat_short_name(enum ih_category category, uint id);
521
522/**
523 * genimg_get_cat_count() - Get the number of items in a category
524 *
525 * @category: Category to check
526 * @return the number of items in the category (IH_xxx_COUNT)
527 */
528int genimg_get_cat_count(enum ih_category category);
529
530/**
531 * genimg_get_cat_desc() - Get the description of a category
532 *
533 * @return the description of a category, e.g. "architecture". This
534 * effectively converts the enum to a string.
535 */
536const char *genimg_get_cat_desc(enum ih_category category);
537
Stephen Warren712fbcf2011-10-18 11:11:49 +0000538int genimg_get_os_id(const char *name);
539int genimg_get_arch_id(const char *name);
540int genimg_get_type_id(const char *name);
541int genimg_get_comp_id(const char *name);
542void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100543
Simon Glass859e92b2013-05-07 06:11:51 +0000544#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
545 defined(USE_HOSTCC)
546#define IMAGE_ENABLE_TIMESTAMP 1
547#else
548#define IMAGE_ENABLE_TIMESTAMP 0
549#endif
550void genimg_print_time(time_t timestamp);
551
Simon Glass782cfbb2013-05-16 13:53:21 +0000552/* What to do with a image load address ('load = <> 'in the FIT) */
553enum fit_load_op {
554 FIT_LOAD_IGNORED, /* Ignore load address */
555 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600556 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000557 FIT_LOAD_REQUIRED, /* Must be provided */
558};
559
Simon Glass90268b82014-10-19 21:11:24 -0600560int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
561 ulong *setup_len);
562
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100563#ifndef USE_HOSTCC
564/* Image format types, returned by _get_format() routine */
565#define IMAGE_FORMAT_INVALID 0x00
Tom Rinic76c93a2019-05-23 07:14:07 -0400566#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100567#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200568#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100569#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500570#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100571
Bryan Wu6c454fe2014-08-15 16:51:38 -0700572ulong genimg_get_kernel_addr_fit(char * const img_addr,
573 const char **fit_uname_config,
574 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700575ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000576int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000577int genimg_has_config(bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100578
Michal Simek62afc602016-05-17 14:03:50 +0200579int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
580 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000581int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100582 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite84a07db2015-05-21 09:52:48 -0400583
584/**
585 * boot_get_loadable - routine to load a list of binaries to memory
586 * @argc: Ignored Argument
587 * @argv: Ignored Argument
588 * @images: pointer to the bootm images structure
589 * @arch: expected architecture for the image
590 * @ld_start: Ignored Argument
591 * @ld_len: Ignored Argument
592 *
593 * boot_get_loadable() will take the given FIT configuration, and look
594 * for a field named "loadables". Loadables, is a list of elements in
595 * the FIT given as strings. exe:
Andre Przywarab2267e82017-12-04 02:05:10 +0000596 * loadables = "linux_kernel", "fdt-2";
Karl Apsite84a07db2015-05-21 09:52:48 -0400597 * this function will attempt to parse each string, and load the
598 * corresponding element from the FIT into memory. Once placed,
599 * no aditional actions are taken.
600 *
601 * @return:
602 * 0, if only valid images or no images are found
603 * error code, if an error occurs during fit_image_load
604 */
605int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
606 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
607#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100608
Simon Glass90268b82014-10-19 21:11:24 -0600609int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
610 ulong *setup_start, ulong *setup_len);
611
Simon Glass782cfbb2013-05-16 13:53:21 +0000612/**
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300613 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
614 *
615 * This deals with all aspects of loading an DTB from a FIT.
616 * The correct base image based on configuration will be selected, and
617 * then any overlays specified will be applied (as present in fit_uname_configp).
618 *
619 * @param images Boot images structure
620 * @param addr Address of FIT in memory
621 * @param fit_unamep On entry this is the requested image name
Andre Przywarab2267e82017-12-04 02:05:10 +0000622 * (e.g. "kernel") or NULL to use the default. On exit
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300623 * points to the selected image name
624 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000625 * name (e.g. "conf-1") or NULL to use the default. On
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300626 * exit points to the selected configuration name.
627 * @param arch Expected architecture (IH_ARCH_...)
628 * @param datap Returns address of loaded image
629 * @param lenp Returns length of loaded image
630 *
631 * @return node offset of base image, or -ve error code on error
632 */
633int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
634 const char **fit_unamep, const char **fit_uname_configp,
635 int arch, ulong *datap, ulong *lenp);
636
637/**
Simon Glass782cfbb2013-05-16 13:53:21 +0000638 * fit_image_load() - load an image from a FIT
639 *
640 * This deals with all aspects of loading an image from a FIT, including
641 * selecting the right image based on configuration, verifying it, printing
642 * out progress messages, checking the type/arch/os and optionally copying it
643 * to the right load address.
644 *
Simon Glass126cc862014-06-12 07:24:47 -0600645 * The property to look up is defined by image_type.
646 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000647 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000648 * @param addr Address of FIT in memory
649 * @param fit_unamep On entry this is the requested image name
Andre Przywarab2267e82017-12-04 02:05:10 +0000650 * (e.g. "kernel") or NULL to use the default. On exit
Simon Glass782cfbb2013-05-16 13:53:21 +0000651 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700652 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000653 * name (e.g. "conf-1") or NULL to use the default. On
Simon Glassf320a4d2013-07-10 23:08:10 -0700654 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000655 * @param arch Expected architecture (IH_ARCH_...)
656 * @param image_type Required image type (IH_TYPE_...). If this is
657 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
658 * also.
659 * @param bootstage_id ID of starting bootstage to use for progress updates.
660 * This will be added to the BOOTSTAGE_SUB values when
661 * calling bootstage_mark()
662 * @param load_op Decribes what to do with the load address
663 * @param datap Returns address of loaded image
664 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600665 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000666 */
Simon Glass126cc862014-06-12 07:24:47 -0600667int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700668 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000669 int arch, int image_type, int bootstage_id,
670 enum fit_load_op load_op, ulong *datap, ulong *lenp);
671
Simon Glassce1400f2014-06-12 07:24:53 -0600672#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000673/**
674 * fit_get_node_from_config() - Look up an image a FIT by type
675 *
Andre Przywarab2267e82017-12-04 02:05:10 +0000676 * This looks in the selected conf- node (images->fit_uname_cfg) for a
Simon Glass782cfbb2013-05-16 13:53:21 +0000677 * particular image type (e.g. "kernel") and then finds the image that is
678 * referred to.
679 *
680 * For example, for something like:
681 *
682 * images {
Andre Przywarab2267e82017-12-04 02:05:10 +0000683 * kernel {
Simon Glass782cfbb2013-05-16 13:53:21 +0000684 * ...
685 * };
686 * };
687 * configurations {
Andre Przywarab2267e82017-12-04 02:05:10 +0000688 * conf-1 {
689 * kernel = "kernel";
Simon Glass782cfbb2013-05-16 13:53:21 +0000690 * };
691 * };
692 *
693 * the function will return the node offset of the kernel@1 node, assuming
Andre Przywarab2267e82017-12-04 02:05:10 +0000694 * that conf-1 is the chosen configuration.
Simon Glass782cfbb2013-05-16 13:53:21 +0000695 *
696 * @param images Boot images structure
697 * @param prop_name Property name to look up (FIT_..._PROP)
698 * @param addr Address of FIT in memory
699 */
700int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
701 ulong addr);
702
Simon Glass53f375f2013-05-16 13:53:23 +0000703int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
704 bootm_headers_t *images,
705 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000706void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000707int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500708
Stephen Warren712fbcf2011-10-18 11:11:49 +0000709int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100710 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000711int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600712#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000713int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600714#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100715#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100716
717/*******************************************************************/
718/* Legacy format specific code (prefixed with image_) */
719/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000720static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100721{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000722 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100723}
724
725#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200726 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100727 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000728 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100729 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000730image_get_hdr_l(magic) /* image_get_magic */
731image_get_hdr_l(hcrc) /* image_get_hcrc */
732image_get_hdr_l(time) /* image_get_time */
733image_get_hdr_l(size) /* image_get_size */
734image_get_hdr_l(load) /* image_get_load */
735image_get_hdr_l(ep) /* image_get_ep */
736image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100737
738#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200739 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100740 { \
741 return hdr->ih_##f; \
742 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000743image_get_hdr_b(os) /* image_get_os */
744image_get_hdr_b(arch) /* image_get_arch */
745image_get_hdr_b(type) /* image_get_type */
746image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100747
Stephen Warren712fbcf2011-10-18 11:11:49 +0000748static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100749{
750 return (char *)hdr->ih_name;
751}
752
Stephen Warren712fbcf2011-10-18 11:11:49 +0000753static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100754{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000755 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100756}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100757
758/**
759 * image_get_data - get image payload start address
760 * @hdr: image header
761 *
762 * image_get_data() returns address of the image payload. For single
763 * component images it is image data start. For multi component
764 * images it points to the null terminated table of sub-images sizes.
765 *
766 * returns:
767 * image payload data start address
768 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000769static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100770{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000771 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100772}
773
Stephen Warren712fbcf2011-10-18 11:11:49 +0000774static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100775{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000776 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100777}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000778static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100779{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000780 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100781}
782
783#define image_set_hdr_l(f) \
784 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
785 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000786 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100787 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000788image_set_hdr_l(magic) /* image_set_magic */
789image_set_hdr_l(hcrc) /* image_set_hcrc */
790image_set_hdr_l(time) /* image_set_time */
791image_set_hdr_l(size) /* image_set_size */
792image_set_hdr_l(load) /* image_set_load */
793image_set_hdr_l(ep) /* image_set_ep */
794image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100795
796#define image_set_hdr_b(f) \
797 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
798 { \
799 hdr->ih_##f = val; \
800 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000801image_set_hdr_b(os) /* image_set_os */
802image_set_hdr_b(arch) /* image_set_arch */
803image_set_hdr_b(type) /* image_set_type */
804image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100805
Stephen Warren712fbcf2011-10-18 11:11:49 +0000806static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100807{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000808 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100809}
810
Stephen Warren712fbcf2011-10-18 11:11:49 +0000811int image_check_hcrc(const image_header_t *hdr);
812int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100813#ifndef USE_HOSTCC
Simon Glass723806c2017-08-03 12:22:15 -0600814ulong env_get_bootm_low(void);
815phys_size_t env_get_bootm_size(void);
816phys_size_t env_get_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100817#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600818void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100819
Stephen Warren712fbcf2011-10-18 11:11:49 +0000820static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100821{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000822 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100823}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000824static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100825{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000826 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100827}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000828static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100829{
Alison Wang4ac0a322017-06-06 15:32:40 +0800830 return (image_get_arch(hdr) == arch) ||
831 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100832}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000833static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100834{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000835 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100836}
837
Stephen Warren712fbcf2011-10-18 11:11:49 +0000838ulong image_multi_count(const image_header_t *hdr);
839void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100840 ulong *data, ulong *len);
841
Stephen Warren712fbcf2011-10-18 11:11:49 +0000842void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100843
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100844#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000845static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100846{
Mike Frysinger476af292011-10-03 14:50:33 +0000847#ifndef IH_ARCH_DEFAULT
848# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100849#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000850 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100851}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100852#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100853
Simon Glass13d06982013-05-08 08:06:01 +0000854/**
Julius Werner20908542019-07-24 19:37:54 -0700855 * image_decomp() - decompress an image
856 *
857 * @comp: Compression algorithm that is used (IH_COMP_...)
858 * @load: Destination load address in U-Boot memory
859 * @image_start Image start address (where we are decompressing from)
860 * @type: OS type (IH_OS_...)
861 * @load_bug: Place to decompress to
862 * @image_buf: Address to decompress from
863 * @image_len: Number of bytes in @image_buf to decompress
864 * @unc_len: Available space for decompression
865 * @return 0 if OK, -ve on error (BOOTM_ERR_...)
866 */
867int image_decomp(int comp, ulong load, ulong image_start, int type,
868 void *load_buf, void *image_buf, ulong image_len,
869 uint unc_len, ulong *load_end);
870
871/**
Simon Glass13d06982013-05-08 08:06:01 +0000872 * Set up properties in the FDT
873 *
874 * This sets up properties in the FDT that is to be passed to linux.
875 *
876 * @images: Images information
877 * @blob: FDT to update
878 * @of_size: Size of the FDT
879 * @lmb: Points to logical memory block structure
880 * @return 0 if ok, <0 on failure
881 */
882int image_setup_libfdt(bootm_headers_t *images, void *blob,
883 int of_size, struct lmb *lmb);
884
885/**
886 * Set up the FDT to use for booting a kernel
887 *
888 * This performs ramdisk setup, sets up the FDT if required, and adds
889 * paramters to the FDT if libfdt is available.
890 *
891 * @param images Images information
892 * @return 0 if ok, <0 on failure
893 */
894int image_setup_linux(bootm_headers_t *images);
895
Simon Glassa5266d62013-07-04 13:26:10 -0700896/**
897 * bootz_setup() - Extract stat and size of a Linux xImage
898 *
899 * @image: Address of image
900 * @start: Returns start address of image
901 * @end : Returns end address of image
902 * @return 0 if OK, 1 if the image was not recognised
903 */
904int bootz_setup(ulong image, ulong *start, ulong *end);
905
Bin Chen6808ef92018-01-27 16:59:09 +1100906/**
907 * Return the correct start address and size of a Linux aarch64 Image.
908 *
909 * @image: Address of image
910 * @start: Returns start address of image
911 * @size : Returns size image
Marek Vasut7f13b372018-06-13 06:13:32 +0200912 * @force_reloc: Ignore image->ep field, always place image to RAM start
Bin Chen6808ef92018-01-27 16:59:09 +1100913 * @return 0 if OK, 1 if the image was not recognised
914 */
Marek Vasut7f13b372018-06-13 06:13:32 +0200915int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
916 bool force_reloc);
Simon Glassa5266d62013-07-04 13:26:10 -0700917
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100918/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100919/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100920/*******************************************************************/
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100921
922#define FIT_IMAGES_PATH "/images"
923#define FIT_CONFS_PATH "/configurations"
924
Simon Glass3e569a62013-06-13 15:10:00 -0700925/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100926#define FIT_HASH_NODENAME "hash"
927#define FIT_ALGO_PROP "algo"
928#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000929#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700930#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100931
932/* image node */
933#define FIT_DATA_PROP "data"
Peng Fana1be94b2017-12-05 13:20:59 +0800934#define FIT_DATA_POSITION_PROP "data-position"
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +0200935#define FIT_DATA_OFFSET_PROP "data-offset"
936#define FIT_DATA_SIZE_PROP "data-size"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100937#define FIT_TIMESTAMP_PROP "timestamp"
938#define FIT_DESC_PROP "description"
939#define FIT_ARCH_PROP "arch"
940#define FIT_TYPE_PROP "type"
941#define FIT_OS_PROP "os"
942#define FIT_COMP_PROP "compression"
943#define FIT_ENTRY_PROP "entry"
944#define FIT_LOAD_PROP "load"
945
946/* configuration node */
947#define FIT_KERNEL_PROP "kernel"
948#define FIT_RAMDISK_PROP "ramdisk"
949#define FIT_FDT_PROP "fdt"
Karl Apsiteecf8cd62015-05-21 09:52:47 -0400950#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100951#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -0600952#define FIT_SETUP_PROP "setup"
Michal Simeked0cea72016-05-17 13:58:44 +0200953#define FIT_FPGA_PROP "fpga"
Michal Simek1f8e4bf2018-03-26 16:31:26 +0200954#define FIT_FIRMWARE_PROP "firmware"
Marek Vasut0298d202018-05-13 00:22:54 +0200955#define FIT_STANDALONE_PROP "standalone"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100956
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200957#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100958
Simon Glassf1dcee52016-02-22 22:55:56 -0700959#if IMAGE_ENABLE_FIT
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100960/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000961int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100962 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000963int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100964 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100965
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200966int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000967void fit_print_contents(const void *fit);
968void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100969
970/**
971 * fit_get_end - get FIT image size
972 * @fit: pointer to the FIT format image header
973 *
974 * returns:
975 * size of the FIT image (blob) in memory
976 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000977static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100978{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000979 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100980}
981
982/**
983 * fit_get_end - get FIT image end
984 * @fit: pointer to the FIT format image header
985 *
986 * returns:
987 * end address of the FIT image (blob) in memory
988 */
Simon Glass7a80de42016-02-24 09:14:42 -0700989ulong fit_get_end(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100990
991/**
992 * fit_get_name - get FIT node name
993 * @fit: pointer to the FIT format image header
994 *
995 * returns:
996 * NULL, on error
997 * pointer to node name, on success
998 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000999static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001000 int noffset, int *len)
1001{
Stephen Warren712fbcf2011-10-18 11:11:49 +00001002 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001003}
1004
Stephen Warren712fbcf2011-10-18 11:11:49 +00001005int fit_get_desc(const void *fit, int noffset, char **desc);
1006int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001007
Stephen Warren712fbcf2011-10-18 11:11:49 +00001008int fit_image_get_node(const void *fit, const char *image_uname);
1009int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1010int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1011int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1012int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1013int fit_image_get_load(const void *fit, int noffset, ulong *load);
1014int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1015int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001016 const void **data, size_t *size);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001017int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
Peng Fana1be94b2017-12-05 13:20:59 +08001018int fit_image_get_data_position(const void *fit, int noffset,
1019 int *data_position);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001020int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
Kelvin Cheungc3c86382018-05-19 18:21:37 +08001021int fit_image_get_data_and_size(const void *fit, int noffset,
1022 const void **data, size_t *size);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001023
Stephen Warren712fbcf2011-10-18 11:11:49 +00001024int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1025int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001026 int *value_len);
1027
Stephen Warren712fbcf2011-10-18 11:11:49 +00001028int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +00001029
1030/**
Simon Glass56518e72013-06-13 15:10:01 -07001031 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +00001032 *
Simon Glass56518e72013-06-13 15:10:01 -07001033 * @keydir: Directory containing keys
1034 * @kwydest: FDT blob to write public key information to
1035 * @fit: Pointer to the FIT format image header
1036 * @comment: Comment to add to signature nodes
1037 * @require_keys: Mark all keys as 'required'
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001038 * @engine_id: Engine to use for signing
Alex Kiernan795f4522018-06-20 20:10:52 +00001039 * @cmdname: Command name used when reporting errors
Simon Glass56518e72013-06-13 15:10:01 -07001040 *
1041 * Adds hash values for all component images in the FIT blob.
1042 * Hashes are calculated for all component images which have hash subnodes
1043 * with algorithm property set to one of the supported hash algorithms.
1044 *
1045 * Also add signatures if signature nodes are present.
1046 *
1047 * returns
1048 * 0, on success
1049 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +00001050 */
Simon Glass56518e72013-06-13 15:10:01 -07001051int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001052 const char *comment, int require_keys,
Alex Kiernan795f4522018-06-20 20:10:52 +00001053 const char *engine_id, const char *cmdname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001054
Jun Nie5c643db2018-02-27 16:55:58 +08001055int fit_image_verify_with_data(const void *fit, int image_noffset,
1056 const void *data, size_t size);
Simon Glassb8da8362013-05-07 06:11:57 +00001057int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +00001058int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +00001059int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001060int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1061int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1062int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1063int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1064int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001065
Gabe Blackd95f6ec2012-10-25 16:31:10 +00001066int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001067int fit_conf_get_node(const void *fit, const char *conf_uname);
Tien Fong Chee0a42a132019-05-07 17:42:28 +08001068int fit_conf_get_prop_node_count(const void *fit, int noffset,
1069 const char *prop_name);
1070int fit_conf_get_prop_node_index(const void *fit, int noffset,
1071 const char *prop_name, int index);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001072
Simon Glass003efd72013-05-07 06:12:00 +00001073/**
1074 * fit_conf_get_prop_node() - Get node refered to by a configuration
1075 * @fit: FIT to check
1076 * @noffset: Offset of conf@xxx node to check
1077 * @prop_name: Property to read from the conf node
1078 *
Andre Przywarab2267e82017-12-04 02:05:10 +00001079 * The conf- nodes contain references to other nodes, using properties
1080 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
Simon Glass003efd72013-05-07 06:12:00 +00001081 * return the offset of the node referred to (e.g. offset of node
Andre Przywarab2267e82017-12-04 02:05:10 +00001082 * "/images/kernel".
Simon Glass003efd72013-05-07 06:12:00 +00001083 */
1084int fit_conf_get_prop_node(const void *fit, int noffset,
1085 const char *prop_name);
1086
Simon Glass61a439a2013-05-07 06:11:52 +00001087int fit_check_ramdisk(const void *fit, int os_noffset,
1088 uint8_t arch, int verify);
1089
Simon Glass604f23d2013-05-07 06:11:54 +00001090int calculate_hash(const void *data, int data_len, const char *algo,
1091 uint8_t *value, int *value_len);
1092
Simon Glass782cfbb2013-05-16 13:53:21 +00001093/*
Simon Glass3e569a62013-06-13 15:10:00 -07001094 * At present we only support signing on the host, and verification on the
1095 * device
Simon Glass782cfbb2013-05-16 13:53:21 +00001096 */
Alex Kiernan89665f22019-04-18 20:34:55 +00001097#if defined(USE_HOSTCC)
1098# if defined(CONFIG_FIT_SIGNATURE)
Simon Glass3e569a62013-06-13 15:10:00 -07001099# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +01001100# define IMAGE_ENABLE_VERIFY 1
Alex Kiernan89665f22019-04-18 20:34:55 +00001101# include <openssl/evp.h>
1102# else
Simon Glass3e569a62013-06-13 15:10:00 -07001103# define IMAGE_ENABLE_SIGN 0
Alex Kiernan89665f22019-04-18 20:34:55 +00001104# define IMAGE_ENABLE_VERIFY 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001105# endif
1106#else
Simon Glass3e569a62013-06-13 15:10:00 -07001107# define IMAGE_ENABLE_SIGN 0
Alex Kiernan89665f22019-04-18 20:34:55 +00001108# define IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
Simon Glass782cfbb2013-05-16 13:53:21 +00001109#endif
1110
1111#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +01001112void *image_get_host_blob(void);
1113void image_set_host_blob(void *host_blob);
1114# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +00001115#else
1116# define gd_fdt_blob() (gd->fdt_blob)
1117#endif
1118
1119#ifdef CONFIG_FIT_BEST_MATCH
1120#define IMAGE_ENABLE_BEST_MATCH 1
1121#else
1122#define IMAGE_ENABLE_BEST_MATCH 0
1123#endif
1124
Simon Glass3e569a62013-06-13 15:10:00 -07001125/* Information passed to the signing routines */
1126struct image_sign_info {
1127 const char *keydir; /* Directory conaining keys */
1128 const char *keyname; /* Name of key to use */
1129 void *fit; /* Pointer to FIT blob */
1130 int node_offset; /* Offset of signature node */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001131 const char *name; /* Algorithm name */
1132 struct checksum_algo *checksum; /* Checksum algorithm information */
Philippe Reynes20031562018-11-14 13:51:00 +01001133 struct padding_algo *padding; /* Padding algorithm information */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001134 struct crypto_algo *crypto; /* Crypto algorithm information */
Simon Glass3e569a62013-06-13 15:10:00 -07001135 const void *fdt_blob; /* FDT containing public keys */
1136 int required_keynode; /* Node offset of key to use: -1=any */
1137 const char *require_keys; /* Value for 'required' property */
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001138 const char *engine_id; /* Engine to use for signing */
Simon Glass3e569a62013-06-13 15:10:00 -07001139};
Simon Glass73223f02016-02-22 22:55:43 -07001140#endif /* Allow struct image_region to always be defined for rsa.h */
Simon Glass3e569a62013-06-13 15:10:00 -07001141
1142/* A part of an image, used for hashing */
1143struct image_region {
1144 const void *data;
1145 int size;
1146};
1147
Simon Glass73223f02016-02-22 22:55:43 -07001148#if IMAGE_ENABLE_FIT
1149
Heiko Schocher646257d2014-03-03 12:19:26 +01001150#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +02001151# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +01001152#endif
1153struct checksum_algo {
1154 const char *name;
1155 const int checksum_len;
Andrew Dudada29f292016-11-08 18:53:40 +00001156 const int der_len;
1157 const uint8_t *der_prefix;
Heiko Schocher646257d2014-03-03 12:19:26 +01001158#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +01001159 const EVP_MD *(*calculate_sign)(void);
1160#endif
Ruchika Guptab37b46f2015-01-23 16:01:59 +05301161 int (*calculate)(const char *name,
1162 const struct image_region region[],
1163 int region_count, uint8_t *checksum);
Heiko Schocher646257d2014-03-03 12:19:26 +01001164};
1165
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001166struct crypto_algo {
Simon Glass3e569a62013-06-13 15:10:00 -07001167 const char *name; /* Name of algorithm */
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001168 const int key_len;
Simon Glass3e569a62013-06-13 15:10:00 -07001169
1170 /**
1171 * sign() - calculate and return signature for given input data
1172 *
1173 * @info: Specifies key and FIT information
1174 * @data: Pointer to the input data
1175 * @data_len: Data length
1176 * @sigp: Set to an allocated buffer holding the signature
1177 * @sig_len: Set to length of the calculated hash
1178 *
1179 * This computes input data signature according to selected algorithm.
1180 * Resulting signature value is placed in an allocated buffer, the
1181 * pointer is returned as *sigp. The length of the calculated
1182 * signature is returned via the sig_len pointer argument. The caller
1183 * should free *sigp.
1184 *
1185 * @return: 0, on success, -ve on error
1186 */
1187 int (*sign)(struct image_sign_info *info,
1188 const struct image_region region[],
1189 int region_count, uint8_t **sigp, uint *sig_len);
1190
1191 /**
1192 * add_verify_data() - Add verification information to FDT
1193 *
1194 * Add public key information to the FDT node, suitable for
1195 * verification at run-time. The information added depends on the
1196 * algorithm being used.
1197 *
1198 * @info: Specifies key and FIT information
1199 * @keydest: Destination FDT blob for public key data
1200 * @return: 0, on success, -ve on error
1201 */
1202 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1203
1204 /**
1205 * verify() - Verify a signature against some data
1206 *
1207 * @info: Specifies key and FIT information
1208 * @data: Pointer to the input data
1209 * @data_len: Data length
1210 * @sig: Signature
1211 * @sig_len: Number of bytes in signature
1212 * @return 0 if verified, -ve on error
1213 */
1214 int (*verify)(struct image_sign_info *info,
1215 const struct image_region region[], int region_count,
1216 uint8_t *sig, uint sig_len);
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001217};
Heiko Schocher646257d2014-03-03 12:19:26 +01001218
Philippe Reynes20031562018-11-14 13:51:00 +01001219struct padding_algo {
1220 const char *name;
1221 int (*verify)(struct image_sign_info *info,
1222 uint8_t *pad, int pad_len,
1223 const uint8_t *hash, int hash_len);
1224};
1225
Simon Glass3e569a62013-06-13 15:10:00 -07001226/**
Andrew Duda83dd98e2016-11-08 18:53:41 +00001227 * image_get_checksum_algo() - Look up a checksum algorithm
Simon Glass3e569a62013-06-13 15:10:00 -07001228 *
Andrew Duda83dd98e2016-11-08 18:53:41 +00001229 * @param full_name Name of algorithm in the form "checksum,crypto"
Simon Glass3e569a62013-06-13 15:10:00 -07001230 * @return pointer to algorithm information, or NULL if not found
1231 */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001232struct checksum_algo *image_get_checksum_algo(const char *full_name);
1233
1234/**
1235 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1236 *
1237 * @param full_name Name of algorithm in the form "checksum,crypto"
1238 * @return pointer to algorithm information, or NULL if not found
1239 */
1240struct crypto_algo *image_get_crypto_algo(const char *full_name);
Simon Glass3e569a62013-06-13 15:10:00 -07001241
Simon Glass56518e72013-06-13 15:10:01 -07001242/**
Philippe Reynes20031562018-11-14 13:51:00 +01001243 * image_get_padding_algo() - Look up a padding algorithm
1244 *
1245 * @param name Name of padding algorithm
1246 * @return pointer to algorithm information, or NULL if not found
1247 */
1248struct padding_algo *image_get_padding_algo(const char *name);
1249
1250/**
Simon Glass56518e72013-06-13 15:10:01 -07001251 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1252 *
1253 * @fit: FIT to check
1254 * @image_noffset: Offset of image node to check
1255 * @data: Image data to check
1256 * @size: Size of image data
1257 * @sig_blob: FDT containing public keys
1258 * @no_sigsp: Returns 1 if no signatures were required, and
1259 * therefore nothing was checked. The caller may wish
1260 * to fall back to other mechanisms, or refuse to
1261 * boot.
1262 * @return 0 if all verified ok, <0 on error
1263 */
1264int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1265 const char *data, size_t size, const void *sig_blob,
1266 int *no_sigsp);
1267
1268/**
1269 * fit_image_check_sig() - Check a single image signature node
1270 *
1271 * @fit: FIT to check
1272 * @noffset: Offset of signature node to check
1273 * @data: Image data to check
1274 * @size: Size of image data
1275 * @required_keynode: Offset in the control FDT of the required key node,
1276 * if any. If this is given, then the image wil not
1277 * pass verification unless that key is used. If this is
1278 * -1 then any signature will do.
1279 * @err_msgp: In the event of an error, this will be pointed to a
1280 * help error string to display to the user.
1281 * @return 0 if all verified ok, <0 on error
1282 */
1283int fit_image_check_sig(const void *fit, int noffset, const void *data,
1284 size_t size, int required_keynode, char **err_msgp);
1285
Simon Glass4d098522013-06-13 15:10:09 -07001286/**
1287 * fit_region_make_list() - Make a list of regions to hash
1288 *
1289 * Given a list of FIT regions (offset, size) provided by libfdt, create
1290 * a list of regions (void *, size) for use by the signature creationg
1291 * and verification code.
1292 *
1293 * @fit: FIT image to process
1294 * @fdt_regions: Regions as returned by libfdt
1295 * @count: Number of regions returned by libfdt
1296 * @region: Place to put list of regions (NULL to allocate it)
1297 * @return pointer to list of regions, or NULL if out of memory
1298 */
1299struct image_region *fit_region_make_list(const void *fit,
1300 struct fdt_region *fdt_regions, int count,
1301 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001302
Stephen Warren712fbcf2011-10-18 11:11:49 +00001303static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001304{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001305#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001306 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001307#else
1308 return 0;
1309#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001310}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001311
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001312#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001313#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001314 "FIT images not supported for '%s'\n", \
1315 __FILE__, __LINE__, (msg))
1316
Stephen Warren712fbcf2011-10-18 11:11:49 +00001317#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001318 "FIT images not supported for '%s' " \
1319 "- must reset board to recover!\n", \
1320 __FILE__, __LINE__, (msg))
1321#else
1322#define fit_unsupported(msg)
1323#define fit_unsupported_reset(msg)
1324#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001325#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001326
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001327#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1328struct andr_img_hdr;
1329int android_image_check_header(const struct andr_img_hdr *hdr);
1330int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1331 ulong *os_data, ulong *os_len);
1332int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1333 ulong *rd_data, ulong *rd_len);
Bin Chen10481612018-01-27 16:59:08 +11001334int android_image_get_second(const struct andr_img_hdr *hdr,
1335 ulong *second_data, ulong *second_len);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001336ulong android_image_get_end(const struct andr_img_hdr *hdr);
1337ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Eugeniu Rosca829ceb22019-04-08 17:35:27 +02001338ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
Michael Trimarchi4f1318b2016-06-10 19:54:37 +02001339void android_print_contents(const struct andr_img_hdr *hdr);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001340
1341#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1342
Simon Glass4b307f22016-02-22 22:55:55 -07001343/**
1344 * board_fit_config_name_match() - Check for a matching board name
1345 *
1346 * This is used when SPL loads a FIT containing multiple device tree files
1347 * and wants to work out which one to use. The description of each one is
1348 * passed to this function. The description comes from the 'description' field
1349 * in each (FDT) image node.
1350 *
1351 * @name: Device tree description
1352 * @return 0 if this device tree should be used, non-zero to try the next
1353 */
1354int board_fit_config_name_match(const char *name);
1355
Madan Srinivasa5c7e412017-04-07 10:00:02 -05001356#if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1357 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
Daniel Allredda74d1f2016-06-27 09:19:21 -05001358/**
1359 * board_fit_image_post_process() - Do any post-process on FIT binary data
1360 *
1361 * This is used to do any sort of image manipulation, verification, decryption
1362 * etc. in a platform or board specific way. Obviously, anything done here would
1363 * need to be comprehended in how the images were prepared before being injected
1364 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1365 * before being added to the FIT image).
1366 *
1367 * @image: pointer to the image start pointer
1368 * @size: pointer to the image size
1369 * @return no return value (failure should be handled internally)
1370 */
1371void board_fit_image_post_process(void **p_image, size_t *p_size);
1372#endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1373
Cooper Jr., Franklin3863f842017-06-16 17:25:05 -05001374#define FDT_ERROR ((ulong)(-1))
1375
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001376ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
Jean-Jacques Hiblot02035d02017-09-15 12:57:27 +02001377
1378/**
1379 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1380 *
1381 * A FIT image contains one or more DTBs. This function parses the
1382 * configurations described in the FIT images and returns the node of
1383 * the first matching DTB. To check if a DTB matches a board, this function
1384 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1385 * the node described by the default configuration if it exists.
1386 *
1387 * @fdt: pointer to flat device tree
1388 * @return the node if found, -ve otherwise
1389 */
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001390int fit_find_config_node(const void *fdt);
1391
Andrew F. Davisd7be5092016-11-29 16:33:20 -06001392/**
1393 * Mapping of image types to function handlers to be invoked on the associated
1394 * loaded images
1395 *
1396 * @type: Type of image, I.E. IH_TYPE_*
1397 * @handler: Function to call on loaded image
1398 */
1399struct fit_loadable_tbl {
1400 int type;
1401 /**
1402 * handler() - Process a loaded image
1403 *
1404 * @data: Pointer to start of loaded image data
1405 * @size: Size of loaded image data
1406 */
1407 void (*handler)(ulong data, size_t size);
1408};
1409
1410/*
1411 * Define a FIT loadable image type handler
1412 *
1413 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1414 * _handler is the handler function to call after this image type is loaded
1415 */
1416#define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1417 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1418 .type = _type, \
1419 .handler = _handler, \
1420 }
1421
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001422#endif /* __IMAGE_H__ */