blob: 889305cbefdb932c994a290174f51fa850aa0832 [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
71# define CONFIG_CRC32 /* FIT images need CRC32 support */
Simon Glass87ebee32013-05-08 08:05:59 +000072# define IMAGE_ENABLE_CRC32 1
73# define IMAGE_ENABLE_MD5 1
74# define IMAGE_ENABLE_SHA1 1
75# endif
Masahiro Yamada6f417512016-05-31 20:41:54 +090076
Masahiro Yamada6f417512016-05-31 20:41:54 +090077#ifndef IMAGE_ENABLE_CRC32
78#define IMAGE_ENABLE_CRC32 0
79#endif
80
81#ifndef IMAGE_ENABLE_MD5
82#define IMAGE_ENABLE_MD5 0
83#endif
84
85#ifndef IMAGE_ENABLE_SHA1
86#define IMAGE_ENABLE_SHA1 0
87#endif
88
Tom Rini0db7f682017-05-15 12:17:48 -040089#if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
90 defined(CONFIG_SPL_SHA256_SUPPORT)
Tom Rini0db7f682017-05-15 12:17:48 -040091#define IMAGE_ENABLE_SHA256 1
92#else
Masahiro Yamada6f417512016-05-31 20:41:54 +090093#define IMAGE_ENABLE_SHA256 0
94#endif
95
Simon Glass73223f02016-02-22 22:55:43 -070096#endif /* IMAGE_ENABLE_FIT */
Simon Glass13d06982013-05-08 08:06:01 +000097
Masahiro Yamada6f417512016-05-31 20:41:54 +090098#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
99# define IMAGE_BOOT_GET_CMDLINE 1
100#else
101# define IMAGE_BOOT_GET_CMDLINE 0
102#endif
103
104#ifdef CONFIG_OF_BOARD_SETUP
105# define IMAGE_OF_BOARD_SETUP 1
106#else
107# define IMAGE_OF_BOARD_SETUP 0
108#endif
109
110#ifdef CONFIG_OF_SYSTEM_SETUP
111# define IMAGE_OF_SYSTEM_SETUP 1
112#else
113# define IMAGE_OF_SYSTEM_SETUP 0
114#endif
Simon Glassc654b512014-10-23 18:58:54 -0600115
Simon Glass56d7ab72016-06-30 10:52:14 -0600116enum ih_category {
117 IH_ARCH,
118 IH_COMP,
119 IH_OS,
120 IH_TYPE,
121
122 IH_COUNT,
123};
124
wdenk5b1d7132002-11-03 00:07:02 +0000125/*
126 * Operating System Codes
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900127 *
128 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100129 * New IDs *MUST* be appended at the end of the list and *NEVER*
130 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000131 */
Simon Glass555f45d2016-06-30 10:52:13 -0600132enum {
133 IH_OS_INVALID = 0, /* Invalid OS */
134 IH_OS_OPENBSD, /* OpenBSD */
135 IH_OS_NETBSD, /* NetBSD */
136 IH_OS_FREEBSD, /* FreeBSD */
137 IH_OS_4_4BSD, /* 4.4BSD */
138 IH_OS_LINUX, /* Linux */
139 IH_OS_SVR4, /* SVR4 */
140 IH_OS_ESIX, /* Esix */
141 IH_OS_SOLARIS, /* Solaris */
142 IH_OS_IRIX, /* Irix */
143 IH_OS_SCO, /* SCO */
144 IH_OS_DELL, /* Dell */
145 IH_OS_NCR, /* NCR */
146 IH_OS_LYNXOS, /* LynxOS */
147 IH_OS_VXWORKS, /* VxWorks */
148 IH_OS_PSOS, /* pSOS */
149 IH_OS_QNX, /* QNX */
150 IH_OS_U_BOOT, /* Firmware */
151 IH_OS_RTEMS, /* RTEMS */
152 IH_OS_ARTOS, /* ARTOS */
153 IH_OS_UNITY, /* Unity OS */
154 IH_OS_INTEGRITY, /* INTEGRITY */
155 IH_OS_OSE, /* OSE */
156 IH_OS_PLAN9, /* Plan 9 */
157 IH_OS_OPENRTOS, /* OpenRTOS */
Philipp Tomsich4914af12017-09-13 21:29:29 +0200158 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
Bryan O'Donoghue45b55712018-03-13 16:50:35 +0000159 IH_OS_TEE, /* Trusted Execution Environment */
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 */
wdenk5b1d7132002-11-03 00:07:02 +0000287
Simon Glass555f45d2016-06-30 10:52:13 -0600288 IH_TYPE_COUNT, /* Number of image types */
289};
Simon Glass5b9d44d2015-06-23 15:38:25 -0600290
wdenk5b1d7132002-11-03 00:07:02 +0000291/*
292 * Compression Types
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900293 *
294 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100295 * New IDs *MUST* be appended at the end of the list and *NEVER*
296 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000297 */
Simon Glass555f45d2016-06-30 10:52:13 -0600298enum {
299 IH_COMP_NONE = 0, /* No Compression Used */
300 IH_COMP_GZIP, /* gzip Compression Used */
301 IH_COMP_BZIP2, /* bzip2 Compression Used */
302 IH_COMP_LZMA, /* lzma Compression Used */
303 IH_COMP_LZO, /* lzo Compression Used */
304 IH_COMP_LZ4, /* lz4 Compression Used */
305
306 IH_COMP_COUNT,
307};
wdenk5b1d7132002-11-03 00:07:02 +0000308
Eugeniu Rosca829ceb22019-04-08 17:35:27 +0200309#define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
wdenk5b1d7132002-11-03 00:07:02 +0000310#define IH_MAGIC 0x27051956 /* Image Magic Number */
311#define IH_NMLEN 32 /* Image Name Length */
312
Fabio Estevam1411fb32013-01-03 08:24:33 +0000313/* Reused from common.h */
314#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
315
wdenk5b1d7132002-11-03 00:07:02 +0000316/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100317 * Legacy format image header,
318 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000319 */
wdenk5b1d7132002-11-03 00:07:02 +0000320typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000321 __be32 ih_magic; /* Image Header Magic Number */
322 __be32 ih_hcrc; /* Image Header CRC Checksum */
323 __be32 ih_time; /* Image Creation Timestamp */
324 __be32 ih_size; /* Image Data Size */
325 __be32 ih_load; /* Data Load Address */
326 __be32 ih_ep; /* Entry Point Address */
327 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000328 uint8_t ih_os; /* Operating System */
329 uint8_t ih_arch; /* CPU architecture */
330 uint8_t ih_type; /* Image Type */
331 uint8_t ih_comp; /* Compression Type */
332 uint8_t ih_name[IH_NMLEN]; /* Image Name */
333} image_header_t;
334
Kumar Gala396f6352008-08-15 08:24:41 -0500335typedef struct image_info {
336 ulong start, end; /* start/end of blob */
337 ulong image_start, image_len; /* start of image within blob, len of image */
338 ulong load; /* load addr for the image */
339 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass90268b82014-10-19 21:11:24 -0600340 uint8_t arch; /* CPU architecture */
Kumar Gala396f6352008-08-15 08:24:41 -0500341} image_info_t;
342
Marian Balakowicz559316f2008-01-08 18:11:44 +0100343/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100344 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
345 * routines.
346 */
347typedef struct bootm_headers {
348 /*
349 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100350 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100351 * data from second and third component accordingly.
352 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200353 image_header_t *legacy_hdr_os; /* image header pointer */
354 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100355 ulong legacy_hdr_valid;
356
Simon Glass73223f02016-02-22 22:55:43 -0700357#if IMAGE_ENABLE_FIT
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100358 const char *fit_uname_cfg; /* configuration node unit name */
359
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100360 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100361 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100362 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100363
364 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100365 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
366 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100367
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100368 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100369 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
370 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass90268b82014-10-19 21:11:24 -0600371
372 void *fit_hdr_setup; /* x86 setup FIT image header */
373 const char *fit_uname_setup; /* x86 setup subimage node name */
374 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100375#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100376
Kumar Gala49c3a862008-10-21 17:25:45 -0500377#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500378 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500379 ulong ep; /* entry point of OS */
380
Kumar Galac4f94192008-08-15 08:24:37 -0500381 ulong rd_start, rd_end;/* ramdisk start/end */
382
Kumar Gala06a09912008-08-15 08:24:38 -0500383 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500384 ulong ft_len; /* length of flat device tree */
385
Kumar Gala49c3a862008-10-21 17:25:45 -0500386 ulong initrd_start;
387 ulong initrd_end;
388 ulong cmdline_start;
389 ulong cmdline_end;
390 bd_t *kbd;
391#endif
392
Simon Glass00caae62017-08-03 12:22:12 -0600393 int verify; /* env_get("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500394
395#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700396#define BOOTM_STATE_FINDOS (0x00000002)
397#define BOOTM_STATE_FINDOTHER (0x00000004)
398#define BOOTM_STATE_LOADOS (0x00000008)
399#define BOOTM_STATE_RAMDISK (0x00000010)
400#define BOOTM_STATE_FDT (0x00000020)
401#define BOOTM_STATE_OS_CMDLINE (0x00000040)
402#define BOOTM_STATE_OS_BD_T (0x00000080)
403#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700404#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
405#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500406 int state;
407
Mike Frysingera16028d2009-11-03 11:35:59 -0500408#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500409 struct lmb lmb; /* for memory mgmt */
410#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100411} bootm_headers_t;
412
Simon Schwarz1648a372012-03-15 04:01:34 +0000413extern bootm_headers_t images;
414
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100415/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100416 * Some systems (for example LWMON) have very short watchdog periods;
417 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200418 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100419 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200420#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100421#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200422#endif
423
424#ifndef CHUNKSZ_CRC32
425#define CHUNKSZ_CRC32 (64 * 1024)
426#endif
427
428#ifndef CHUNKSZ_MD5
429#define CHUNKSZ_MD5 (64 * 1024)
430#endif
431
432#ifndef CHUNKSZ_SHA1
433#define CHUNKSZ_SHA1 (64 * 1024)
434#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100435
Mike Frysinger37566092009-07-02 19:23:25 -0400436#define uimage_to_cpu(x) be32_to_cpu(x)
437#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000438
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530439/*
440 * Translation table for entries of a specific type; used by
441 * get_table_entry_id() and get_table_entry_name().
442 */
443typedef struct table_entry {
444 int id;
445 char *sname; /* short (input) name to find table entry */
446 char *lname; /* long (output) name to print for messages */
447} table_entry_t;
448
449/*
450 * get_table_entry_id() scans the translation table trying to find an
451 * entry that matches the given short name. If a matching entry is
452 * found, it's id is returned to the caller.
453 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400454int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530455 const char *table_name, const char *name);
456/*
457 * get_table_entry_name() scans the translation table trying to find
458 * an entry that matches the given id. If a matching entry is found,
459 * its long name is returned to the caller.
460 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400461char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530462
Stephen Warren712fbcf2011-10-18 11:11:49 +0000463const char *genimg_get_os_name(uint8_t os);
Simon Glasscef2e512016-02-22 22:55:50 -0700464
465/**
466 * genimg_get_os_short_name() - get the short name for an OS
467 *
468 * @param os OS (IH_OS_...)
469 * @return OS short name, or "unknown" if unknown
470 */
471const char *genimg_get_os_short_name(uint8_t comp);
472
Stephen Warren712fbcf2011-10-18 11:11:49 +0000473const char *genimg_get_arch_name(uint8_t arch);
Simon Glasscef2e512016-02-22 22:55:50 -0700474
475/**
476 * genimg_get_arch_short_name() - get the short name for an architecture
477 *
478 * @param arch Architecture type (IH_ARCH_...)
479 * @return architecture short name, or "unknown" if unknown
480 */
481const char *genimg_get_arch_short_name(uint8_t arch);
482
Stephen Warren712fbcf2011-10-18 11:11:49 +0000483const char *genimg_get_type_name(uint8_t type);
Simon Glass5b9d44d2015-06-23 15:38:25 -0600484
485/**
486 * genimg_get_type_short_name() - get the short name for an image type
487 *
488 * @param type Image type (IH_TYPE_...)
489 * @return image short name, or "unknown" if unknown
490 */
491const char *genimg_get_type_short_name(uint8_t type);
492
Stephen Warren712fbcf2011-10-18 11:11:49 +0000493const char *genimg_get_comp_name(uint8_t comp);
Simon Glasscef2e512016-02-22 22:55:50 -0700494
495/**
496 * genimg_get_comp_short_name() - get the short name for a compression method
497 *
498 * @param comp compression method (IH_COMP_...)
499 * @return compression method short name, or "unknown" if unknown
500 */
501const char *genimg_get_comp_short_name(uint8_t comp);
502
Simon Glass14262202016-06-30 10:52:16 -0600503/**
504 * genimg_get_cat_name() - Get the name of an item in a category
505 *
506 * @category: Category of item
507 * @id: Item ID
508 * @return name of item, or "Unknown ..." if unknown
509 */
510const char *genimg_get_cat_name(enum ih_category category, uint id);
511
512/**
513 * genimg_get_cat_short_name() - Get the short name of an item in a category
514 *
515 * @category: Category of item
516 * @id: Item ID
517 * @return short name of item, or "Unknown ..." if unknown
518 */
519const char *genimg_get_cat_short_name(enum ih_category category, uint id);
520
521/**
522 * genimg_get_cat_count() - Get the number of items in a category
523 *
524 * @category: Category to check
525 * @return the number of items in the category (IH_xxx_COUNT)
526 */
527int genimg_get_cat_count(enum ih_category category);
528
529/**
530 * genimg_get_cat_desc() - Get the description of a category
531 *
532 * @return the description of a category, e.g. "architecture". This
533 * effectively converts the enum to a string.
534 */
535const char *genimg_get_cat_desc(enum ih_category category);
536
Stephen Warren712fbcf2011-10-18 11:11:49 +0000537int genimg_get_os_id(const char *name);
538int genimg_get_arch_id(const char *name);
539int genimg_get_type_id(const char *name);
540int genimg_get_comp_id(const char *name);
541void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100542
Simon Glass859e92b2013-05-07 06:11:51 +0000543#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
544 defined(USE_HOSTCC)
545#define IMAGE_ENABLE_TIMESTAMP 1
546#else
547#define IMAGE_ENABLE_TIMESTAMP 0
548#endif
549void genimg_print_time(time_t timestamp);
550
Simon Glass782cfbb2013-05-16 13:53:21 +0000551/* What to do with a image load address ('load = <> 'in the FIT) */
552enum fit_load_op {
553 FIT_LOAD_IGNORED, /* Ignore load address */
554 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600555 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000556 FIT_LOAD_REQUIRED, /* Must be provided */
557};
558
Simon Glass90268b82014-10-19 21:11:24 -0600559int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
560 ulong *setup_len);
561
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100562#ifndef USE_HOSTCC
563/* Image format types, returned by _get_format() routine */
564#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher21d29f72014-05-28 11:33:33 +0200565#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100566#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200567#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100568#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500569#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100570
Bryan Wu6c454fe2014-08-15 16:51:38 -0700571ulong genimg_get_kernel_addr_fit(char * const img_addr,
572 const char **fit_uname_config,
573 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700574ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000575int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000576int genimg_has_config(bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100577
Michal Simek62afc602016-05-17 14:03:50 +0200578int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
579 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000580int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100581 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite84a07db2015-05-21 09:52:48 -0400582
583/**
584 * boot_get_loadable - routine to load a list of binaries to memory
585 * @argc: Ignored Argument
586 * @argv: Ignored Argument
587 * @images: pointer to the bootm images structure
588 * @arch: expected architecture for the image
589 * @ld_start: Ignored Argument
590 * @ld_len: Ignored Argument
591 *
592 * boot_get_loadable() will take the given FIT configuration, and look
593 * for a field named "loadables". Loadables, is a list of elements in
594 * the FIT given as strings. exe:
Andre Przywarab2267e82017-12-04 02:05:10 +0000595 * loadables = "linux_kernel", "fdt-2";
Karl Apsite84a07db2015-05-21 09:52:48 -0400596 * this function will attempt to parse each string, and load the
597 * corresponding element from the FIT into memory. Once placed,
598 * no aditional actions are taken.
599 *
600 * @return:
601 * 0, if only valid images or no images are found
602 * error code, if an error occurs during fit_image_load
603 */
604int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
605 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
606#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100607
Simon Glass90268b82014-10-19 21:11:24 -0600608int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
609 ulong *setup_start, ulong *setup_len);
610
Simon Glass782cfbb2013-05-16 13:53:21 +0000611/**
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300612 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
613 *
614 * This deals with all aspects of loading an DTB from a FIT.
615 * The correct base image based on configuration will be selected, and
616 * then any overlays specified will be applied (as present in fit_uname_configp).
617 *
618 * @param images Boot images structure
619 * @param addr Address of FIT in memory
620 * @param fit_unamep On entry this is the requested image name
Andre Przywarab2267e82017-12-04 02:05:10 +0000621 * (e.g. "kernel") or NULL to use the default. On exit
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300622 * points to the selected image name
623 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000624 * name (e.g. "conf-1") or NULL to use the default. On
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300625 * exit points to the selected configuration name.
626 * @param arch Expected architecture (IH_ARCH_...)
627 * @param datap Returns address of loaded image
628 * @param lenp Returns length of loaded image
629 *
630 * @return node offset of base image, or -ve error code on error
631 */
632int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
633 const char **fit_unamep, const char **fit_uname_configp,
634 int arch, ulong *datap, ulong *lenp);
635
636/**
Simon Glass782cfbb2013-05-16 13:53:21 +0000637 * fit_image_load() - load an image from a FIT
638 *
639 * This deals with all aspects of loading an image from a FIT, including
640 * selecting the right image based on configuration, verifying it, printing
641 * out progress messages, checking the type/arch/os and optionally copying it
642 * to the right load address.
643 *
Simon Glass126cc862014-06-12 07:24:47 -0600644 * The property to look up is defined by image_type.
645 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000646 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000647 * @param addr Address of FIT in memory
648 * @param fit_unamep On entry this is the requested image name
Andre Przywarab2267e82017-12-04 02:05:10 +0000649 * (e.g. "kernel") or NULL to use the default. On exit
Simon Glass782cfbb2013-05-16 13:53:21 +0000650 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700651 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000652 * name (e.g. "conf-1") or NULL to use the default. On
Simon Glassf320a4d2013-07-10 23:08:10 -0700653 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000654 * @param arch Expected architecture (IH_ARCH_...)
655 * @param image_type Required image type (IH_TYPE_...). If this is
656 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
657 * also.
658 * @param bootstage_id ID of starting bootstage to use for progress updates.
659 * This will be added to the BOOTSTAGE_SUB values when
660 * calling bootstage_mark()
661 * @param load_op Decribes what to do with the load address
662 * @param datap Returns address of loaded image
663 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600664 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000665 */
Simon Glass126cc862014-06-12 07:24:47 -0600666int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700667 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000668 int arch, int image_type, int bootstage_id,
669 enum fit_load_op load_op, ulong *datap, ulong *lenp);
670
Simon Glassce1400f2014-06-12 07:24:53 -0600671#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000672/**
673 * fit_get_node_from_config() - Look up an image a FIT by type
674 *
Andre Przywarab2267e82017-12-04 02:05:10 +0000675 * This looks in the selected conf- node (images->fit_uname_cfg) for a
Simon Glass782cfbb2013-05-16 13:53:21 +0000676 * particular image type (e.g. "kernel") and then finds the image that is
677 * referred to.
678 *
679 * For example, for something like:
680 *
681 * images {
Andre Przywarab2267e82017-12-04 02:05:10 +0000682 * kernel {
Simon Glass782cfbb2013-05-16 13:53:21 +0000683 * ...
684 * };
685 * };
686 * configurations {
Andre Przywarab2267e82017-12-04 02:05:10 +0000687 * conf-1 {
688 * kernel = "kernel";
Simon Glass782cfbb2013-05-16 13:53:21 +0000689 * };
690 * };
691 *
692 * the function will return the node offset of the kernel@1 node, assuming
Andre Przywarab2267e82017-12-04 02:05:10 +0000693 * that conf-1 is the chosen configuration.
Simon Glass782cfbb2013-05-16 13:53:21 +0000694 *
695 * @param images Boot images structure
696 * @param prop_name Property name to look up (FIT_..._PROP)
697 * @param addr Address of FIT in memory
698 */
699int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
700 ulong addr);
701
Simon Glass53f375f2013-05-16 13:53:23 +0000702int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
703 bootm_headers_t *images,
704 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000705void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000706int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500707
Stephen Warren712fbcf2011-10-18 11:11:49 +0000708int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100709 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000710int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600711#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000712int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600713#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100714#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100715
716/*******************************************************************/
717/* Legacy format specific code (prefixed with image_) */
718/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000719static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100720{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000721 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100722}
723
724#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200725 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100726 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000727 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100728 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000729image_get_hdr_l(magic) /* image_get_magic */
730image_get_hdr_l(hcrc) /* image_get_hcrc */
731image_get_hdr_l(time) /* image_get_time */
732image_get_hdr_l(size) /* image_get_size */
733image_get_hdr_l(load) /* image_get_load */
734image_get_hdr_l(ep) /* image_get_ep */
735image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100736
737#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200738 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100739 { \
740 return hdr->ih_##f; \
741 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000742image_get_hdr_b(os) /* image_get_os */
743image_get_hdr_b(arch) /* image_get_arch */
744image_get_hdr_b(type) /* image_get_type */
745image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100746
Stephen Warren712fbcf2011-10-18 11:11:49 +0000747static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100748{
749 return (char *)hdr->ih_name;
750}
751
Stephen Warren712fbcf2011-10-18 11:11:49 +0000752static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100753{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000754 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100755}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100756
757/**
758 * image_get_data - get image payload start address
759 * @hdr: image header
760 *
761 * image_get_data() returns address of the image payload. For single
762 * component images it is image data start. For multi component
763 * images it points to the null terminated table of sub-images sizes.
764 *
765 * returns:
766 * image payload data start address
767 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000768static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100769{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000770 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100771}
772
Stephen Warren712fbcf2011-10-18 11:11:49 +0000773static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100774{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000775 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100776}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000777static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100778{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000779 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100780}
781
782#define image_set_hdr_l(f) \
783 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
784 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000785 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100786 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000787image_set_hdr_l(magic) /* image_set_magic */
788image_set_hdr_l(hcrc) /* image_set_hcrc */
789image_set_hdr_l(time) /* image_set_time */
790image_set_hdr_l(size) /* image_set_size */
791image_set_hdr_l(load) /* image_set_load */
792image_set_hdr_l(ep) /* image_set_ep */
793image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100794
795#define image_set_hdr_b(f) \
796 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
797 { \
798 hdr->ih_##f = val; \
799 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000800image_set_hdr_b(os) /* image_set_os */
801image_set_hdr_b(arch) /* image_set_arch */
802image_set_hdr_b(type) /* image_set_type */
803image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100804
Stephen Warren712fbcf2011-10-18 11:11:49 +0000805static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100806{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000807 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100808}
809
Stephen Warren712fbcf2011-10-18 11:11:49 +0000810int image_check_hcrc(const image_header_t *hdr);
811int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100812#ifndef USE_HOSTCC
Simon Glass723806c2017-08-03 12:22:15 -0600813ulong env_get_bootm_low(void);
814phys_size_t env_get_bootm_size(void);
815phys_size_t env_get_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100816#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600817void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100818
Stephen Warren712fbcf2011-10-18 11:11:49 +0000819static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100820{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000821 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100822}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000823static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100824{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000825 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100826}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000827static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100828{
Alison Wang4ac0a322017-06-06 15:32:40 +0800829 return (image_get_arch(hdr) == arch) ||
830 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100831}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000832static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100833{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000834 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100835}
836
Stephen Warren712fbcf2011-10-18 11:11:49 +0000837ulong image_multi_count(const image_header_t *hdr);
838void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100839 ulong *data, ulong *len);
840
Stephen Warren712fbcf2011-10-18 11:11:49 +0000841void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100842
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100843#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000844static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100845{
Mike Frysinger476af292011-10-03 14:50:33 +0000846#ifndef IH_ARCH_DEFAULT
847# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100848#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000849 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100850}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100851#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100852
Simon Glass13d06982013-05-08 08:06:01 +0000853/**
854 * Set up properties in the FDT
855 *
856 * This sets up properties in the FDT that is to be passed to linux.
857 *
858 * @images: Images information
859 * @blob: FDT to update
860 * @of_size: Size of the FDT
861 * @lmb: Points to logical memory block structure
862 * @return 0 if ok, <0 on failure
863 */
864int image_setup_libfdt(bootm_headers_t *images, void *blob,
865 int of_size, struct lmb *lmb);
866
867/**
868 * Set up the FDT to use for booting a kernel
869 *
870 * This performs ramdisk setup, sets up the FDT if required, and adds
871 * paramters to the FDT if libfdt is available.
872 *
873 * @param images Images information
874 * @return 0 if ok, <0 on failure
875 */
876int image_setup_linux(bootm_headers_t *images);
877
Simon Glassa5266d62013-07-04 13:26:10 -0700878/**
879 * bootz_setup() - Extract stat and size of a Linux xImage
880 *
881 * @image: Address of image
882 * @start: Returns start address of image
883 * @end : Returns end address of image
884 * @return 0 if OK, 1 if the image was not recognised
885 */
886int bootz_setup(ulong image, ulong *start, ulong *end);
887
Bin Chen6808ef92018-01-27 16:59:09 +1100888/**
889 * Return the correct start address and size of a Linux aarch64 Image.
890 *
891 * @image: Address of image
892 * @start: Returns start address of image
893 * @size : Returns size image
Marek Vasut7f13b372018-06-13 06:13:32 +0200894 * @force_reloc: Ignore image->ep field, always place image to RAM start
Bin Chen6808ef92018-01-27 16:59:09 +1100895 * @return 0 if OK, 1 if the image was not recognised
896 */
Marek Vasut7f13b372018-06-13 06:13:32 +0200897int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
898 bool force_reloc);
Simon Glassa5266d62013-07-04 13:26:10 -0700899
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100900/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100901/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100902/*******************************************************************/
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100903
904#define FIT_IMAGES_PATH "/images"
905#define FIT_CONFS_PATH "/configurations"
906
Simon Glass3e569a62013-06-13 15:10:00 -0700907/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100908#define FIT_HASH_NODENAME "hash"
909#define FIT_ALGO_PROP "algo"
910#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000911#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700912#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100913
914/* image node */
915#define FIT_DATA_PROP "data"
Peng Fana1be94b2017-12-05 13:20:59 +0800916#define FIT_DATA_POSITION_PROP "data-position"
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +0200917#define FIT_DATA_OFFSET_PROP "data-offset"
918#define FIT_DATA_SIZE_PROP "data-size"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100919#define FIT_TIMESTAMP_PROP "timestamp"
920#define FIT_DESC_PROP "description"
921#define FIT_ARCH_PROP "arch"
922#define FIT_TYPE_PROP "type"
923#define FIT_OS_PROP "os"
924#define FIT_COMP_PROP "compression"
925#define FIT_ENTRY_PROP "entry"
926#define FIT_LOAD_PROP "load"
927
928/* configuration node */
929#define FIT_KERNEL_PROP "kernel"
930#define FIT_RAMDISK_PROP "ramdisk"
931#define FIT_FDT_PROP "fdt"
Karl Apsiteecf8cd62015-05-21 09:52:47 -0400932#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100933#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -0600934#define FIT_SETUP_PROP "setup"
Michal Simeked0cea72016-05-17 13:58:44 +0200935#define FIT_FPGA_PROP "fpga"
Michal Simek1f8e4bf2018-03-26 16:31:26 +0200936#define FIT_FIRMWARE_PROP "firmware"
Marek Vasut0298d202018-05-13 00:22:54 +0200937#define FIT_STANDALONE_PROP "standalone"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100938
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200939#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100940
Simon Glassf1dcee52016-02-22 22:55:56 -0700941#if IMAGE_ENABLE_FIT
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100942/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000943int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100944 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000945int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100946 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100947
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200948int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000949void fit_print_contents(const void *fit);
950void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100951
952/**
953 * fit_get_end - get FIT image size
954 * @fit: pointer to the FIT format image header
955 *
956 * returns:
957 * size of the FIT image (blob) in memory
958 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000959static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100960{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000961 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100962}
963
964/**
965 * fit_get_end - get FIT image end
966 * @fit: pointer to the FIT format image header
967 *
968 * returns:
969 * end address of the FIT image (blob) in memory
970 */
Simon Glass7a80de42016-02-24 09:14:42 -0700971ulong fit_get_end(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100972
973/**
974 * fit_get_name - get FIT node name
975 * @fit: pointer to the FIT format image header
976 *
977 * returns:
978 * NULL, on error
979 * pointer to node name, on success
980 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000981static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100982 int noffset, int *len)
983{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000984 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100985}
986
Stephen Warren712fbcf2011-10-18 11:11:49 +0000987int fit_get_desc(const void *fit, int noffset, char **desc);
988int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100989
Stephen Warren712fbcf2011-10-18 11:11:49 +0000990int fit_image_get_node(const void *fit, const char *image_uname);
991int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
992int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
993int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
994int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
995int fit_image_get_load(const void *fit, int noffset, ulong *load);
996int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
997int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100998 const void **data, size_t *size);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +0200999int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
Peng Fana1be94b2017-12-05 13:20:59 +08001000int fit_image_get_data_position(const void *fit, int noffset,
1001 int *data_position);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001002int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
Kelvin Cheungc3c86382018-05-19 18:21:37 +08001003int fit_image_get_data_and_size(const void *fit, int noffset,
1004 const void **data, size_t *size);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001005
Stephen Warren712fbcf2011-10-18 11:11:49 +00001006int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1007int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001008 int *value_len);
1009
Stephen Warren712fbcf2011-10-18 11:11:49 +00001010int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +00001011
1012/**
Simon Glass56518e72013-06-13 15:10:01 -07001013 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +00001014 *
Simon Glass56518e72013-06-13 15:10:01 -07001015 * @keydir: Directory containing keys
1016 * @kwydest: FDT blob to write public key information to
1017 * @fit: Pointer to the FIT format image header
1018 * @comment: Comment to add to signature nodes
1019 * @require_keys: Mark all keys as 'required'
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001020 * @engine_id: Engine to use for signing
Alex Kiernan795f4522018-06-20 20:10:52 +00001021 * @cmdname: Command name used when reporting errors
Simon Glass56518e72013-06-13 15:10:01 -07001022 *
1023 * Adds hash values for all component images in the FIT blob.
1024 * Hashes are calculated for all component images which have hash subnodes
1025 * with algorithm property set to one of the supported hash algorithms.
1026 *
1027 * Also add signatures if signature nodes are present.
1028 *
1029 * returns
1030 * 0, on success
1031 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +00001032 */
Simon Glass56518e72013-06-13 15:10:01 -07001033int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001034 const char *comment, int require_keys,
Alex Kiernan795f4522018-06-20 20:10:52 +00001035 const char *engine_id, const char *cmdname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001036
Jun Nie5c643db2018-02-27 16:55:58 +08001037int fit_image_verify_with_data(const void *fit, int image_noffset,
1038 const void *data, size_t size);
Simon Glassb8da8362013-05-07 06:11:57 +00001039int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +00001040int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +00001041int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001042int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1043int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1044int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1045int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1046int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001047
Gabe Blackd95f6ec2012-10-25 16:31:10 +00001048int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001049int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001050
Simon Glass003efd72013-05-07 06:12:00 +00001051/**
1052 * fit_conf_get_prop_node() - Get node refered to by a configuration
1053 * @fit: FIT to check
1054 * @noffset: Offset of conf@xxx node to check
1055 * @prop_name: Property to read from the conf node
1056 *
Andre Przywarab2267e82017-12-04 02:05:10 +00001057 * The conf- nodes contain references to other nodes, using properties
1058 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
Simon Glass003efd72013-05-07 06:12:00 +00001059 * return the offset of the node referred to (e.g. offset of node
Andre Przywarab2267e82017-12-04 02:05:10 +00001060 * "/images/kernel".
Simon Glass003efd72013-05-07 06:12:00 +00001061 */
1062int fit_conf_get_prop_node(const void *fit, int noffset,
1063 const char *prop_name);
1064
Simon Glass61a439a2013-05-07 06:11:52 +00001065int fit_check_ramdisk(const void *fit, int os_noffset,
1066 uint8_t arch, int verify);
1067
Simon Glass604f23d2013-05-07 06:11:54 +00001068int calculate_hash(const void *data, int data_len, const char *algo,
1069 uint8_t *value, int *value_len);
1070
Simon Glass782cfbb2013-05-16 13:53:21 +00001071/*
Simon Glass3e569a62013-06-13 15:10:00 -07001072 * At present we only support signing on the host, and verification on the
1073 * device
Simon Glass782cfbb2013-05-16 13:53:21 +00001074 */
1075#if defined(CONFIG_FIT_SIGNATURE)
1076# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -07001077# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +01001078# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +01001079# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +00001080#else
Simon Glass3e569a62013-06-13 15:10:00 -07001081# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001082# define IMAGE_ENABLE_VERIFY 1
1083# endif
1084#else
Simon Glass3e569a62013-06-13 15:10:00 -07001085# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001086# define IMAGE_ENABLE_VERIFY 0
1087#endif
1088
1089#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +01001090void *image_get_host_blob(void);
1091void image_set_host_blob(void *host_blob);
1092# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +00001093#else
1094# define gd_fdt_blob() (gd->fdt_blob)
1095#endif
1096
1097#ifdef CONFIG_FIT_BEST_MATCH
1098#define IMAGE_ENABLE_BEST_MATCH 1
1099#else
1100#define IMAGE_ENABLE_BEST_MATCH 0
1101#endif
1102
Simon Glass3e569a62013-06-13 15:10:00 -07001103/* Information passed to the signing routines */
1104struct image_sign_info {
1105 const char *keydir; /* Directory conaining keys */
1106 const char *keyname; /* Name of key to use */
1107 void *fit; /* Pointer to FIT blob */
1108 int node_offset; /* Offset of signature node */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001109 const char *name; /* Algorithm name */
1110 struct checksum_algo *checksum; /* Checksum algorithm information */
Philippe Reynes20031562018-11-14 13:51:00 +01001111 struct padding_algo *padding; /* Padding algorithm information */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001112 struct crypto_algo *crypto; /* Crypto algorithm information */
Simon Glass3e569a62013-06-13 15:10:00 -07001113 const void *fdt_blob; /* FDT containing public keys */
1114 int required_keynode; /* Node offset of key to use: -1=any */
1115 const char *require_keys; /* Value for 'required' property */
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001116 const char *engine_id; /* Engine to use for signing */
Simon Glass3e569a62013-06-13 15:10:00 -07001117};
Simon Glass73223f02016-02-22 22:55:43 -07001118#endif /* Allow struct image_region to always be defined for rsa.h */
Simon Glass3e569a62013-06-13 15:10:00 -07001119
1120/* A part of an image, used for hashing */
1121struct image_region {
1122 const void *data;
1123 int size;
1124};
1125
Simon Glass73223f02016-02-22 22:55:43 -07001126#if IMAGE_ENABLE_FIT
1127
Heiko Schocher646257d2014-03-03 12:19:26 +01001128#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +02001129# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +01001130#endif
1131struct checksum_algo {
1132 const char *name;
1133 const int checksum_len;
Andrew Dudada29f292016-11-08 18:53:40 +00001134 const int der_len;
1135 const uint8_t *der_prefix;
Heiko Schocher646257d2014-03-03 12:19:26 +01001136#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +01001137 const EVP_MD *(*calculate_sign)(void);
1138#endif
Ruchika Guptab37b46f2015-01-23 16:01:59 +05301139 int (*calculate)(const char *name,
1140 const struct image_region region[],
1141 int region_count, uint8_t *checksum);
Heiko Schocher646257d2014-03-03 12:19:26 +01001142};
1143
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001144struct crypto_algo {
Simon Glass3e569a62013-06-13 15:10:00 -07001145 const char *name; /* Name of algorithm */
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001146 const int key_len;
Simon Glass3e569a62013-06-13 15:10:00 -07001147
1148 /**
1149 * sign() - calculate and return signature for given input data
1150 *
1151 * @info: Specifies key and FIT information
1152 * @data: Pointer to the input data
1153 * @data_len: Data length
1154 * @sigp: Set to an allocated buffer holding the signature
1155 * @sig_len: Set to length of the calculated hash
1156 *
1157 * This computes input data signature according to selected algorithm.
1158 * Resulting signature value is placed in an allocated buffer, the
1159 * pointer is returned as *sigp. The length of the calculated
1160 * signature is returned via the sig_len pointer argument. The caller
1161 * should free *sigp.
1162 *
1163 * @return: 0, on success, -ve on error
1164 */
1165 int (*sign)(struct image_sign_info *info,
1166 const struct image_region region[],
1167 int region_count, uint8_t **sigp, uint *sig_len);
1168
1169 /**
1170 * add_verify_data() - Add verification information to FDT
1171 *
1172 * Add public key information to the FDT node, suitable for
1173 * verification at run-time. The information added depends on the
1174 * algorithm being used.
1175 *
1176 * @info: Specifies key and FIT information
1177 * @keydest: Destination FDT blob for public key data
1178 * @return: 0, on success, -ve on error
1179 */
1180 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1181
1182 /**
1183 * verify() - Verify a signature against some data
1184 *
1185 * @info: Specifies key and FIT information
1186 * @data: Pointer to the input data
1187 * @data_len: Data length
1188 * @sig: Signature
1189 * @sig_len: Number of bytes in signature
1190 * @return 0 if verified, -ve on error
1191 */
1192 int (*verify)(struct image_sign_info *info,
1193 const struct image_region region[], int region_count,
1194 uint8_t *sig, uint sig_len);
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001195};
Heiko Schocher646257d2014-03-03 12:19:26 +01001196
Philippe Reynes20031562018-11-14 13:51:00 +01001197struct padding_algo {
1198 const char *name;
1199 int (*verify)(struct image_sign_info *info,
1200 uint8_t *pad, int pad_len,
1201 const uint8_t *hash, int hash_len);
1202};
1203
Simon Glass3e569a62013-06-13 15:10:00 -07001204/**
Andrew Duda83dd98e2016-11-08 18:53:41 +00001205 * image_get_checksum_algo() - Look up a checksum algorithm
Simon Glass3e569a62013-06-13 15:10:00 -07001206 *
Andrew Duda83dd98e2016-11-08 18:53:41 +00001207 * @param full_name Name of algorithm in the form "checksum,crypto"
Simon Glass3e569a62013-06-13 15:10:00 -07001208 * @return pointer to algorithm information, or NULL if not found
1209 */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001210struct checksum_algo *image_get_checksum_algo(const char *full_name);
1211
1212/**
1213 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1214 *
1215 * @param full_name Name of algorithm in the form "checksum,crypto"
1216 * @return pointer to algorithm information, or NULL if not found
1217 */
1218struct crypto_algo *image_get_crypto_algo(const char *full_name);
Simon Glass3e569a62013-06-13 15:10:00 -07001219
Simon Glass56518e72013-06-13 15:10:01 -07001220/**
Philippe Reynes20031562018-11-14 13:51:00 +01001221 * image_get_padding_algo() - Look up a padding algorithm
1222 *
1223 * @param name Name of padding algorithm
1224 * @return pointer to algorithm information, or NULL if not found
1225 */
1226struct padding_algo *image_get_padding_algo(const char *name);
1227
1228/**
Simon Glass56518e72013-06-13 15:10:01 -07001229 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1230 *
1231 * @fit: FIT to check
1232 * @image_noffset: Offset of image node to check
1233 * @data: Image data to check
1234 * @size: Size of image data
1235 * @sig_blob: FDT containing public keys
1236 * @no_sigsp: Returns 1 if no signatures were required, and
1237 * therefore nothing was checked. The caller may wish
1238 * to fall back to other mechanisms, or refuse to
1239 * boot.
1240 * @return 0 if all verified ok, <0 on error
1241 */
1242int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1243 const char *data, size_t size, const void *sig_blob,
1244 int *no_sigsp);
1245
1246/**
1247 * fit_image_check_sig() - Check a single image signature node
1248 *
1249 * @fit: FIT to check
1250 * @noffset: Offset of signature node to check
1251 * @data: Image data to check
1252 * @size: Size of image data
1253 * @required_keynode: Offset in the control FDT of the required key node,
1254 * if any. If this is given, then the image wil not
1255 * pass verification unless that key is used. If this is
1256 * -1 then any signature will do.
1257 * @err_msgp: In the event of an error, this will be pointed to a
1258 * help error string to display to the user.
1259 * @return 0 if all verified ok, <0 on error
1260 */
1261int fit_image_check_sig(const void *fit, int noffset, const void *data,
1262 size_t size, int required_keynode, char **err_msgp);
1263
Simon Glass4d098522013-06-13 15:10:09 -07001264/**
1265 * fit_region_make_list() - Make a list of regions to hash
1266 *
1267 * Given a list of FIT regions (offset, size) provided by libfdt, create
1268 * a list of regions (void *, size) for use by the signature creationg
1269 * and verification code.
1270 *
1271 * @fit: FIT image to process
1272 * @fdt_regions: Regions as returned by libfdt
1273 * @count: Number of regions returned by libfdt
1274 * @region: Place to put list of regions (NULL to allocate it)
1275 * @return pointer to list of regions, or NULL if out of memory
1276 */
1277struct image_region *fit_region_make_list(const void *fit,
1278 struct fdt_region *fdt_regions, int count,
1279 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001280
Stephen Warren712fbcf2011-10-18 11:11:49 +00001281static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001282{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001283#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001284 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001285#else
1286 return 0;
1287#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001288}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001289
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001290#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001291#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001292 "FIT images not supported for '%s'\n", \
1293 __FILE__, __LINE__, (msg))
1294
Stephen Warren712fbcf2011-10-18 11:11:49 +00001295#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001296 "FIT images not supported for '%s' " \
1297 "- must reset board to recover!\n", \
1298 __FILE__, __LINE__, (msg))
1299#else
1300#define fit_unsupported(msg)
1301#define fit_unsupported_reset(msg)
1302#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001303#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001304
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001305#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1306struct andr_img_hdr;
1307int android_image_check_header(const struct andr_img_hdr *hdr);
1308int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1309 ulong *os_data, ulong *os_len);
1310int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1311 ulong *rd_data, ulong *rd_len);
Bin Chen10481612018-01-27 16:59:08 +11001312int android_image_get_second(const struct andr_img_hdr *hdr,
1313 ulong *second_data, ulong *second_len);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001314ulong android_image_get_end(const struct andr_img_hdr *hdr);
1315ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Eugeniu Rosca829ceb22019-04-08 17:35:27 +02001316ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
Michael Trimarchi4f1318b2016-06-10 19:54:37 +02001317void android_print_contents(const struct andr_img_hdr *hdr);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001318
1319#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1320
Simon Glass4b307f22016-02-22 22:55:55 -07001321/**
1322 * board_fit_config_name_match() - Check for a matching board name
1323 *
1324 * This is used when SPL loads a FIT containing multiple device tree files
1325 * and wants to work out which one to use. The description of each one is
1326 * passed to this function. The description comes from the 'description' field
1327 * in each (FDT) image node.
1328 *
1329 * @name: Device tree description
1330 * @return 0 if this device tree should be used, non-zero to try the next
1331 */
1332int board_fit_config_name_match(const char *name);
1333
Madan Srinivasa5c7e412017-04-07 10:00:02 -05001334#if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1335 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
Daniel Allredda74d1f2016-06-27 09:19:21 -05001336/**
1337 * board_fit_image_post_process() - Do any post-process on FIT binary data
1338 *
1339 * This is used to do any sort of image manipulation, verification, decryption
1340 * etc. in a platform or board specific way. Obviously, anything done here would
1341 * need to be comprehended in how the images were prepared before being injected
1342 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1343 * before being added to the FIT image).
1344 *
1345 * @image: pointer to the image start pointer
1346 * @size: pointer to the image size
1347 * @return no return value (failure should be handled internally)
1348 */
1349void board_fit_image_post_process(void **p_image, size_t *p_size);
1350#endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1351
Cooper Jr., Franklin3863f842017-06-16 17:25:05 -05001352#define FDT_ERROR ((ulong)(-1))
1353
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001354ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
Jean-Jacques Hiblot02035d02017-09-15 12:57:27 +02001355
1356/**
1357 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1358 *
1359 * A FIT image contains one or more DTBs. This function parses the
1360 * configurations described in the FIT images and returns the node of
1361 * the first matching DTB. To check if a DTB matches a board, this function
1362 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1363 * the node described by the default configuration if it exists.
1364 *
1365 * @fdt: pointer to flat device tree
1366 * @return the node if found, -ve otherwise
1367 */
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001368int fit_find_config_node(const void *fdt);
1369
Andrew F. Davisd7be5092016-11-29 16:33:20 -06001370/**
1371 * Mapping of image types to function handlers to be invoked on the associated
1372 * loaded images
1373 *
1374 * @type: Type of image, I.E. IH_TYPE_*
1375 * @handler: Function to call on loaded image
1376 */
1377struct fit_loadable_tbl {
1378 int type;
1379 /**
1380 * handler() - Process a loaded image
1381 *
1382 * @data: Pointer to start of loaded image data
1383 * @size: Size of loaded image data
1384 */
1385 void (*handler)(ulong data, size_t size);
1386};
1387
1388/*
1389 * Define a FIT loadable image type handler
1390 *
1391 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1392 * _handler is the handler function to call after this image type is loaded
1393 */
1394#define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1395 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1396 .type = _type, \
1397 .handler = _handler, \
1398 }
1399
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001400#endif /* __IMAGE_H__ */