blob: df701e34705a3aa3e881e267192da05f3c3d87e7 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk5b1d7132002-11-03 00:07:02 +00002/*
Marian Balakowicz41d71ed2008-01-08 18:14:09 +01003 * (C) Copyright 2008 Semihalf
4 *
Wolfgang Denkf3f45182005-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 Denkf3f45182005-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 Frysinger4ad8e9f2009-07-02 19:23:25 -040018#include "compiler.h"
Kim Phillipse69030c2012-10-29 13:34:30 +000019#include <asm/byteorder.h>
Mike Frysinger4ad8e9f2009-07-02 19:23:25 -040020
Simon Glass9ca37422013-05-08 08:06:01 +000021/* Define this to avoid #ifdefs later on */
22struct lmb;
Masahiro Yamadafe11aee2018-03-21 18:03:35 +090023struct fdt_region;
Simon Glass9ca37422013-05-08 08:06:01 +000024
Mike Frysinger4ad8e9f2009-07-02 19:23:25 -040025#ifdef USE_HOSTCC
Jörg Krause983487f2015-04-22 21:36:22 +020026#include <sys/types.h>
Marian Balakowiczf4891a12008-02-21 17:20:18 +010027
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010028/* new uImage format support enabled on host */
Simon Glass8b426922016-02-22 22:55:45 -070029#define IMAGE_ENABLE_FIT 1
30#define IMAGE_ENABLE_OF_LIBFDT 1
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010031#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
Tom Rinicc54a102017-05-15 12:17:48 -040032#define CONFIG_FIT_ENABLE_SHA256_SUPPORT
Tom Rini5bdd9192017-05-15 12:17:49 -040033#define CONFIG_SHA1
34#define CONFIG_SHA256
Marian Balakowiczf4891a12008-02-21 17:20:18 +010035
Simon Glassf0fd5112013-05-07 06:11:58 +000036#define IMAGE_ENABLE_IGNORE 0
Simon Glass1030f162013-05-08 08:05:58 +000037#define IMAGE_INDENT_STRING ""
Simon Glassf0fd5112013-05-07 06:11:58 +000038
Wolfgang Denkbf368772008-10-21 11:23:56 +020039#else
40
41#include <lmb.h>
Wolfgang Denkbf368772008-10-21 11:23:56 +020042#include <asm/u-boot.h>
Mike Frysinger175467a2010-01-21 04:03:20 -050043#include <command.h>
Wolfgang Denkbf368772008-10-21 11:23:56 +020044
Simon Glassf0fd5112013-05-07 06:11:58 +000045/* Take notice of the 'ignore' property for hashes */
46#define IMAGE_ENABLE_IGNORE 1
Simon Glass1030f162013-05-08 08:05:58 +000047#define IMAGE_INDENT_STRING " "
Simon Glassf0fd5112013-05-07 06:11:58 +000048
Simon Glass8b426922016-02-22 22:55:45 -070049#define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
50#define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
Simon Glasse3ee2fb2016-02-22 22:55:43 -070051
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010052#endif /* USE_HOSTCC */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +010053
Simon Glasse3ee2fb2016-02-22 22:55:43 -070054#if IMAGE_ENABLE_FIT
Michael van der Westhuizene36c6c32014-05-30 20:59:00 +020055#include <hash.h>
Masahiro Yamada75f82d02018-03-05 01:20:11 +090056#include <linux/libfdt.h>
Marian Balakowicze227fbb2008-02-29 21:24:06 +010057#include <fdt_support.h>
Simon Glass82d94532013-05-08 08:05:59 +000058# ifdef CONFIG_SPL_BUILD
Masahiro Yamada191413c2016-05-31 20:41:54 +090059# ifdef CONFIG_SPL_CRC32_SUPPORT
60# define IMAGE_ENABLE_CRC32 1
61# endif
62# ifdef CONFIG_SPL_MD5_SUPPORT
63# define IMAGE_ENABLE_MD5 1
64# endif
65# ifdef CONFIG_SPL_SHA1_SUPPORT
66# define IMAGE_ENABLE_SHA1 1
67# endif
Simon Glass82d94532013-05-08 08:05:59 +000068# else
69# define CONFIG_CRC32 /* FIT images need CRC32 support */
Simon Glass82d94532013-05-08 08:05:59 +000070# define IMAGE_ENABLE_CRC32 1
71# define IMAGE_ENABLE_MD5 1
72# define IMAGE_ENABLE_SHA1 1
73# endif
Masahiro Yamada191413c2016-05-31 20:41:54 +090074
Masahiro Yamada191413c2016-05-31 20:41:54 +090075#ifndef IMAGE_ENABLE_CRC32
76#define IMAGE_ENABLE_CRC32 0
77#endif
78
79#ifndef IMAGE_ENABLE_MD5
80#define IMAGE_ENABLE_MD5 0
81#endif
82
83#ifndef IMAGE_ENABLE_SHA1
84#define IMAGE_ENABLE_SHA1 0
85#endif
86
Tom Rinicc54a102017-05-15 12:17:48 -040087#if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
88 defined(CONFIG_SPL_SHA256_SUPPORT)
Tom Rinicc54a102017-05-15 12:17:48 -040089#define IMAGE_ENABLE_SHA256 1
90#else
Masahiro Yamada191413c2016-05-31 20:41:54 +090091#define IMAGE_ENABLE_SHA256 0
92#endif
93
Simon Glasse3ee2fb2016-02-22 22:55:43 -070094#endif /* IMAGE_ENABLE_FIT */
Simon Glass9ca37422013-05-08 08:06:01 +000095
Masahiro Yamada191413c2016-05-31 20:41:54 +090096#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
97# define IMAGE_BOOT_GET_CMDLINE 1
98#else
99# define IMAGE_BOOT_GET_CMDLINE 0
100#endif
101
102#ifdef CONFIG_OF_BOARD_SETUP
103# define IMAGE_OF_BOARD_SETUP 1
104#else
105# define IMAGE_OF_BOARD_SETUP 0
106#endif
107
108#ifdef CONFIG_OF_SYSTEM_SETUP
109# define IMAGE_OF_SYSTEM_SETUP 1
110#else
111# define IMAGE_OF_SYSTEM_SETUP 0
112#endif
Simon Glass6c0be912014-10-23 18:58:54 -0600113
Simon Glass7da41d52016-06-30 10:52:14 -0600114enum ih_category {
115 IH_ARCH,
116 IH_COMP,
117 IH_OS,
118 IH_TYPE,
119
120 IH_COUNT,
121};
122
wdenk5b1d7132002-11-03 00:07:02 +0000123/*
124 * Operating System Codes
Masahiro Yamada166829f2016-07-21 15:16:00 +0900125 *
126 * The following are exposed to uImage header.
127 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000128 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600129enum {
130 IH_OS_INVALID = 0, /* Invalid OS */
131 IH_OS_OPENBSD, /* OpenBSD */
132 IH_OS_NETBSD, /* NetBSD */
133 IH_OS_FREEBSD, /* FreeBSD */
134 IH_OS_4_4BSD, /* 4.4BSD */
135 IH_OS_LINUX, /* Linux */
136 IH_OS_SVR4, /* SVR4 */
137 IH_OS_ESIX, /* Esix */
138 IH_OS_SOLARIS, /* Solaris */
139 IH_OS_IRIX, /* Irix */
140 IH_OS_SCO, /* SCO */
141 IH_OS_DELL, /* Dell */
142 IH_OS_NCR, /* NCR */
143 IH_OS_LYNXOS, /* LynxOS */
144 IH_OS_VXWORKS, /* VxWorks */
145 IH_OS_PSOS, /* pSOS */
146 IH_OS_QNX, /* QNX */
147 IH_OS_U_BOOT, /* Firmware */
148 IH_OS_RTEMS, /* RTEMS */
149 IH_OS_ARTOS, /* ARTOS */
150 IH_OS_UNITY, /* Unity OS */
151 IH_OS_INTEGRITY, /* INTEGRITY */
152 IH_OS_OSE, /* OSE */
153 IH_OS_PLAN9, /* Plan 9 */
154 IH_OS_OPENRTOS, /* OpenRTOS */
Philipp Tomsich1bf3eb22017-09-13 21:29:29 +0200155 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
Bryan O'Donoghue2f72dec2018-03-13 16:50:35 +0000156 IH_OS_TEE, /* Trusted Execution Environment */
Simon Glass3c536ed2016-06-30 10:52:13 -0600157
158 IH_OS_COUNT,
159};
wdenk5b1d7132002-11-03 00:07:02 +0000160
161/*
162 * CPU Architecture Codes (supported by Linux)
Masahiro Yamada166829f2016-07-21 15:16:00 +0900163 *
164 * The following are exposed to uImage header.
165 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000166 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600167enum {
168 IH_ARCH_INVALID = 0, /* Invalid CPU */
169 IH_ARCH_ALPHA, /* Alpha */
170 IH_ARCH_ARM, /* ARM */
171 IH_ARCH_I386, /* Intel x86 */
172 IH_ARCH_IA64, /* IA64 */
173 IH_ARCH_MIPS, /* MIPS */
174 IH_ARCH_MIPS64, /* MIPS 64 Bit */
175 IH_ARCH_PPC, /* PowerPC */
176 IH_ARCH_S390, /* IBM S390 */
177 IH_ARCH_SH, /* SuperH */
178 IH_ARCH_SPARC, /* Sparc */
179 IH_ARCH_SPARC64, /* Sparc 64 Bit */
180 IH_ARCH_M68K, /* M68K */
Masahiro Yamada166829f2016-07-21 15:16:00 +0900181 IH_ARCH_NIOS, /* Nios-32 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600182 IH_ARCH_MICROBLAZE, /* MicroBlaze */
183 IH_ARCH_NIOS2, /* Nios-II */
184 IH_ARCH_BLACKFIN, /* Blackfin */
185 IH_ARCH_AVR32, /* AVR32 */
186 IH_ARCH_ST200, /* STMicroelectronics ST200 */
187 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
188 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
189 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
190 IH_ARCH_ARM64, /* ARM64 */
191 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
192 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
Chris Zankel41e37372016-08-10 18:36:43 +0300193 IH_ARCH_XTENSA, /* Xtensa */
Rick Chen3301bfc2017-12-26 13:55:58 +0800194 IH_ARCH_RISCV, /* RISC-V */
Simon Glass3c536ed2016-06-30 10:52:13 -0600195
196 IH_ARCH_COUNT,
197};
wdenk5b1d7132002-11-03 00:07:02 +0000198
199/*
200 * Image Types
201 *
202 * "Standalone Programs" are directly runnable in the environment
203 * provided by U-Boot; it is expected that (if they behave
204 * well) you can continue to work in U-Boot after return from
205 * the Standalone Program.
206 * "OS Kernel Images" are usually images of some Embedded OS which
207 * will take over control completely. Usually these programs
208 * will install their own set of exception handlers, device
209 * drivers, set up the MMU, etc. - this means, that you cannot
210 * expect to re-enter U-Boot except by resetting the CPU.
211 * "RAMDisk Images" are more or less just data blocks, and their
212 * parameters (address, size) are passed to an OS kernel that is
213 * being started.
214 * "Multi-File Images" contain several images, typically an OS
215 * (Linux) kernel image and one or more data images like
216 * RAMDisks. This construct is useful for instance when you want
217 * to boot over the network using BOOTP etc., where the boot
218 * server provides just a single image file, but you want to get
219 * for instance an OS kernel and a RAMDisk image.
220 *
221 * "Multi-File Images" start with a list of image sizes, each
222 * image size (in bytes) specified by an "uint32_t" in network
223 * byte order. This list is terminated by an "(uint32_t)0".
224 * Immediately after the terminating 0 follow the images, one by
225 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenk391b5742004-10-10 23:27:33 +0000226 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000227 *
228 * "Firmware Images" are binary images containing firmware (like
229 * U-Boot or FPGA images) which usually will be programmed to
230 * flash memory.
231 *
232 * "Script files" are command sequences that will be executed by
233 * U-Boot's command interpreter; this feature is especially
234 * useful when you configure U-Boot to use a real shell (hush)
wdenk874ac262003-07-24 23:38:38 +0000235 * as command interpreter (=> Shell Scripts).
Masahiro Yamada166829f2016-07-21 15:16:00 +0900236 *
237 * The following are exposed to uImage header.
238 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000239 */
240
Simon Glass3c536ed2016-06-30 10:52:13 -0600241enum {
242 IH_TYPE_INVALID = 0, /* Invalid Image */
243 IH_TYPE_STANDALONE, /* Standalone Program */
244 IH_TYPE_KERNEL, /* OS Kernel Image */
245 IH_TYPE_RAMDISK, /* RAMDisk Image */
246 IH_TYPE_MULTI, /* Multi-File Image */
247 IH_TYPE_FIRMWARE, /* Firmware Image */
248 IH_TYPE_SCRIPT, /* Script file */
249 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
250 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
251 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
252 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
253 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
254 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
255 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
256 /* OS Kernel Image, can run from any load address */
257 IH_TYPE_KERNEL_NOLOAD,
258 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
259 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
260 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
261 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
Marek Vasut83f69282018-04-15 13:15:33 +0200262 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
Simon Glass3c536ed2016-06-30 10:52:13 -0600263 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
264 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
265 IH_TYPE_LOADABLE, /* A list of typeless images */
266 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
267 IH_TYPE_RKSD, /* Rockchip SD card */
268 IH_TYPE_RKSPI, /* Rockchip SPI image */
269 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
270 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
Alexander Graf5329d672018-04-13 14:18:52 +0200271 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
Simon Glass3c536ed2016-06-30 10:52:13 -0600272 IH_TYPE_FPGA, /* FPGA Image */
Albert ARIBAUD \(3ADEV\)2e9f4942016-09-26 09:08:06 +0200273 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
Andrew F. Davis378bcff2016-11-29 16:33:21 -0600274 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
Sven Ebenfeld59697a22016-11-06 16:37:56 +0100275 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
Andrew F. Davis30f9d562017-07-31 10:58:20 -0500276 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
Patrick Delaunaye6db5df2018-03-12 10:46:04 +0100277 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
Marek Vasut83f69282018-04-15 13:15:33 +0200278 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
wdenk5b1d7132002-11-03 00:07:02 +0000279
Simon Glass3c536ed2016-06-30 10:52:13 -0600280 IH_TYPE_COUNT, /* Number of image types */
281};
Simon Glass434a31b2015-06-23 15:38:25 -0600282
wdenk5b1d7132002-11-03 00:07:02 +0000283/*
284 * Compression Types
Masahiro Yamada166829f2016-07-21 15:16:00 +0900285 *
286 * The following are exposed to uImage header.
287 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000288 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600289enum {
290 IH_COMP_NONE = 0, /* No Compression Used */
291 IH_COMP_GZIP, /* gzip Compression Used */
292 IH_COMP_BZIP2, /* bzip2 Compression Used */
293 IH_COMP_LZMA, /* lzma Compression Used */
294 IH_COMP_LZO, /* lzo Compression Used */
295 IH_COMP_LZ4, /* lz4 Compression Used */
296
297 IH_COMP_COUNT,
298};
wdenk5b1d7132002-11-03 00:07:02 +0000299
300#define IH_MAGIC 0x27051956 /* Image Magic Number */
301#define IH_NMLEN 32 /* Image Name Length */
302
Fabio Estevam5fd7c5d2013-01-03 08:24:33 +0000303/* Reused from common.h */
304#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
305
wdenk5b1d7132002-11-03 00:07:02 +0000306/*
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100307 * Legacy format image header,
308 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000309 */
wdenk5b1d7132002-11-03 00:07:02 +0000310typedef struct image_header {
Kim Phillipse69030c2012-10-29 13:34:30 +0000311 __be32 ih_magic; /* Image Header Magic Number */
312 __be32 ih_hcrc; /* Image Header CRC Checksum */
313 __be32 ih_time; /* Image Creation Timestamp */
314 __be32 ih_size; /* Image Data Size */
315 __be32 ih_load; /* Data Load Address */
316 __be32 ih_ep; /* Entry Point Address */
317 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000318 uint8_t ih_os; /* Operating System */
319 uint8_t ih_arch; /* CPU architecture */
320 uint8_t ih_type; /* Image Type */
321 uint8_t ih_comp; /* Compression Type */
322 uint8_t ih_name[IH_NMLEN]; /* Image Name */
323} image_header_t;
324
Kumar Galabd70bbe2008-08-15 08:24:41 -0500325typedef struct image_info {
326 ulong start, end; /* start/end of blob */
327 ulong image_start, image_len; /* start of image within blob, len of image */
328 ulong load; /* load addr for the image */
329 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass0129b522014-10-19 21:11:24 -0600330 uint8_t arch; /* CPU architecture */
Kumar Galabd70bbe2008-08-15 08:24:41 -0500331} image_info_t;
332
Marian Balakowicz20c43722008-01-08 18:11:44 +0100333/*
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100334 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
335 * routines.
336 */
337typedef struct bootm_headers {
338 /*
339 * Legacy os image header, if it is a multi component image
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100340 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100341 * data from second and third component accordingly.
342 */
Marian Balakowiczab00e022008-04-11 11:07:49 +0200343 image_header_t *legacy_hdr_os; /* image header pointer */
344 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100345 ulong legacy_hdr_valid;
346
Simon Glasse3ee2fb2016-02-22 22:55:43 -0700347#if IMAGE_ENABLE_FIT
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100348 const char *fit_uname_cfg; /* configuration node unit name */
349
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100350 void *fit_hdr_os; /* os FIT image header */
Marian Balakowicz6a2b2c22008-03-10 17:53:49 +0100351 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100352 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100353
354 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100355 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
356 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100357
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100358 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100359 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
360 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass0129b522014-10-19 21:11:24 -0600361
362 void *fit_hdr_setup; /* x86 setup FIT image header */
363 const char *fit_uname_setup; /* x86 setup subimage node name */
364 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100365#endif
Marian Balakowiczaa6aae42008-03-12 10:35:52 +0100366
Kumar Gala18178bc2008-10-21 17:25:45 -0500367#ifndef USE_HOSTCC
Kumar Galabd70bbe2008-08-15 08:24:41 -0500368 image_info_t os; /* os image info */
Kumar Gala93467bc2008-08-15 08:24:36 -0500369 ulong ep; /* entry point of OS */
370
Kumar Galafffb1432008-08-15 08:24:37 -0500371 ulong rd_start, rd_end;/* ramdisk start/end */
372
Kumar Galaa5130ad2008-08-15 08:24:38 -0500373 char *ft_addr; /* flat dev tree address */
Kumar Galaa5130ad2008-08-15 08:24:38 -0500374 ulong ft_len; /* length of flat device tree */
375
Kumar Gala18178bc2008-10-21 17:25:45 -0500376 ulong initrd_start;
377 ulong initrd_end;
378 ulong cmdline_start;
379 ulong cmdline_end;
380 bd_t *kbd;
381#endif
382
Simon Glass64b723f2017-08-03 12:22:12 -0600383 int verify; /* env_get("verify")[0] != 'n' */
Kumar Gala18178bc2008-10-21 17:25:45 -0500384
385#define BOOTM_STATE_START (0x00000001)
Simon Glass3081e2e2013-06-11 11:14:47 -0700386#define BOOTM_STATE_FINDOS (0x00000002)
387#define BOOTM_STATE_FINDOTHER (0x00000004)
388#define BOOTM_STATE_LOADOS (0x00000008)
389#define BOOTM_STATE_RAMDISK (0x00000010)
390#define BOOTM_STATE_FDT (0x00000020)
391#define BOOTM_STATE_OS_CMDLINE (0x00000040)
392#define BOOTM_STATE_OS_BD_T (0x00000080)
393#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glass00134882013-06-11 11:14:48 -0700394#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
395#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala18178bc2008-10-21 17:25:45 -0500396 int state;
397
Mike Frysingera0dadf82009-11-03 11:35:59 -0500398#ifdef CONFIG_LMB
Kumar Galada6d11e2008-08-15 08:24:40 -0500399 struct lmb lmb; /* for memory mgmt */
400#endif
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100401} bootm_headers_t;
402
Simon Schwarzaf775a02012-03-15 04:01:34 +0000403extern bootm_headers_t images;
404
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100405/*
Marian Balakowicz20c43722008-01-08 18:11:44 +0100406 * Some systems (for example LWMON) have very short watchdog periods;
407 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200408 * checksum calculations into reasonable chunks.
Marian Balakowicz20c43722008-01-08 18:11:44 +0100409 */
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200410#ifndef CHUNKSZ
Marian Balakowicz20c43722008-01-08 18:11:44 +0100411#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200412#endif
413
414#ifndef CHUNKSZ_CRC32
415#define CHUNKSZ_CRC32 (64 * 1024)
416#endif
417
418#ifndef CHUNKSZ_MD5
419#define CHUNKSZ_MD5 (64 * 1024)
420#endif
421
422#ifndef CHUNKSZ_SHA1
423#define CHUNKSZ_SHA1 (64 * 1024)
424#endif
Marian Balakowicz20c43722008-01-08 18:11:44 +0100425
Mike Frysinger4ad8e9f2009-07-02 19:23:25 -0400426#define uimage_to_cpu(x) be32_to_cpu(x)
427#define cpu_to_uimage(x) cpu_to_be32(x)
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100428
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530429/*
430 * Translation table for entries of a specific type; used by
431 * get_table_entry_id() and get_table_entry_name().
432 */
433typedef struct table_entry {
434 int id;
435 char *sname; /* short (input) name to find table entry */
436 char *lname; /* long (output) name to print for messages */
437} table_entry_t;
438
439/*
440 * get_table_entry_id() scans the translation table trying to find an
441 * entry that matches the given short name. If a matching entry is
442 * found, it's id is returned to the caller.
443 */
Mike Frysingercf2feb12010-10-20 07:17:39 -0400444int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530445 const char *table_name, const char *name);
446/*
447 * get_table_entry_name() scans the translation table trying to find
448 * an entry that matches the given id. If a matching entry is found,
449 * its long name is returned to the caller.
450 */
Mike Frysingercf2feb12010-10-20 07:17:39 -0400451char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530452
Stephen Warren6904b6e2011-10-18 11:11:49 +0000453const char *genimg_get_os_name(uint8_t os);
Simon Glass86c362d2016-02-22 22:55:50 -0700454
455/**
456 * genimg_get_os_short_name() - get the short name for an OS
457 *
458 * @param os OS (IH_OS_...)
459 * @return OS short name, or "unknown" if unknown
460 */
461const char *genimg_get_os_short_name(uint8_t comp);
462
Stephen Warren6904b6e2011-10-18 11:11:49 +0000463const char *genimg_get_arch_name(uint8_t arch);
Simon Glass86c362d2016-02-22 22:55:50 -0700464
465/**
466 * genimg_get_arch_short_name() - get the short name for an architecture
467 *
468 * @param arch Architecture type (IH_ARCH_...)
469 * @return architecture short name, or "unknown" if unknown
470 */
471const char *genimg_get_arch_short_name(uint8_t arch);
472
Stephen Warren6904b6e2011-10-18 11:11:49 +0000473const char *genimg_get_type_name(uint8_t type);
Simon Glass434a31b2015-06-23 15:38:25 -0600474
475/**
476 * genimg_get_type_short_name() - get the short name for an image type
477 *
478 * @param type Image type (IH_TYPE_...)
479 * @return image short name, or "unknown" if unknown
480 */
481const char *genimg_get_type_short_name(uint8_t type);
482
Stephen Warren6904b6e2011-10-18 11:11:49 +0000483const char *genimg_get_comp_name(uint8_t comp);
Simon Glass86c362d2016-02-22 22:55:50 -0700484
485/**
486 * genimg_get_comp_short_name() - get the short name for a compression method
487 *
488 * @param comp compression method (IH_COMP_...)
489 * @return compression method short name, or "unknown" if unknown
490 */
491const char *genimg_get_comp_short_name(uint8_t comp);
492
Simon Glass19864332016-06-30 10:52:16 -0600493/**
494 * genimg_get_cat_name() - Get the name of an item in a category
495 *
496 * @category: Category of item
497 * @id: Item ID
498 * @return name of item, or "Unknown ..." if unknown
499 */
500const char *genimg_get_cat_name(enum ih_category category, uint id);
501
502/**
503 * genimg_get_cat_short_name() - Get the short name of an item in a category
504 *
505 * @category: Category of item
506 * @id: Item ID
507 * @return short name of item, or "Unknown ..." if unknown
508 */
509const char *genimg_get_cat_short_name(enum ih_category category, uint id);
510
511/**
512 * genimg_get_cat_count() - Get the number of items in a category
513 *
514 * @category: Category to check
515 * @return the number of items in the category (IH_xxx_COUNT)
516 */
517int genimg_get_cat_count(enum ih_category category);
518
519/**
520 * genimg_get_cat_desc() - Get the description of a category
521 *
522 * @return the description of a category, e.g. "architecture". This
523 * effectively converts the enum to a string.
524 */
525const char *genimg_get_cat_desc(enum ih_category category);
526
Stephen Warren6904b6e2011-10-18 11:11:49 +0000527int genimg_get_os_id(const char *name);
528int genimg_get_arch_id(const char *name);
529int genimg_get_type_id(const char *name);
530int genimg_get_comp_id(const char *name);
531void genimg_print_size(uint32_t size);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100532
Simon Glassaf0ec0d2013-05-07 06:11:51 +0000533#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
534 defined(USE_HOSTCC)
535#define IMAGE_ENABLE_TIMESTAMP 1
536#else
537#define IMAGE_ENABLE_TIMESTAMP 0
538#endif
539void genimg_print_time(time_t timestamp);
540
Simon Glass384d86d2013-05-16 13:53:21 +0000541/* What to do with a image load address ('load = <> 'in the FIT) */
542enum fit_load_op {
543 FIT_LOAD_IGNORED, /* Ignore load address */
544 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glass05a9ad72014-08-22 14:26:43 -0600545 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass384d86d2013-05-16 13:53:21 +0000546 FIT_LOAD_REQUIRED, /* Must be provided */
547};
548
Simon Glass0129b522014-10-19 21:11:24 -0600549int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
550 ulong *setup_len);
551
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100552#ifndef USE_HOSTCC
553/* Image format types, returned by _get_format() routine */
554#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher515eb122014-05-28 11:33:33 +0200555#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100556#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher515eb122014-05-28 11:33:33 +0200557#endif
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100558#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior686d6672014-05-05 15:08:09 -0500559#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100560
Bryan Wuf5c377a2014-08-15 16:51:38 -0700561ulong genimg_get_kernel_addr_fit(char * const img_addr,
562 const char **fit_uname_config,
563 const char **fit_uname_kernel);
Bryan Wuaf7b0de2014-07-31 17:39:58 -0700564ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass49648062013-05-07 06:12:03 +0000565int genimg_get_format(const void *img_addr);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000566int genimg_has_config(bootm_headers_t *images);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100567
Michal Simekebae78b2016-05-17 14:03:50 +0200568int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
569 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000570int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowicza0ffb422008-03-12 10:14:38 +0100571 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite1b21c282015-05-21 09:52:48 -0400572
573/**
574 * boot_get_loadable - routine to load a list of binaries to memory
575 * @argc: Ignored Argument
576 * @argv: Ignored Argument
577 * @images: pointer to the bootm images structure
578 * @arch: expected architecture for the image
579 * @ld_start: Ignored Argument
580 * @ld_len: Ignored Argument
581 *
582 * boot_get_loadable() will take the given FIT configuration, and look
583 * for a field named "loadables". Loadables, is a list of elements in
584 * the FIT given as strings. exe:
Andre Przywara3234ecd2017-12-04 02:05:10 +0000585 * loadables = "linux_kernel", "fdt-2";
Karl Apsite1b21c282015-05-21 09:52:48 -0400586 * this function will attempt to parse each string, and load the
587 * corresponding element from the FIT into memory. Once placed,
588 * no aditional actions are taken.
589 *
590 * @return:
591 * 0, if only valid images or no images are found
592 * error code, if an error occurs during fit_image_load
593 */
594int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
595 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
596#endif /* !USE_HOSTCC */
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100597
Simon Glass0129b522014-10-19 21:11:24 -0600598int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
599 ulong *setup_start, ulong *setup_len);
600
Simon Glass384d86d2013-05-16 13:53:21 +0000601/**
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300602 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
603 *
604 * This deals with all aspects of loading an DTB from a FIT.
605 * The correct base image based on configuration will be selected, and
606 * then any overlays specified will be applied (as present in fit_uname_configp).
607 *
608 * @param images Boot images structure
609 * @param addr Address of FIT in memory
610 * @param fit_unamep On entry this is the requested image name
Andre Przywara3234ecd2017-12-04 02:05:10 +0000611 * (e.g. "kernel") or NULL to use the default. On exit
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300612 * points to the selected image name
613 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywara3234ecd2017-12-04 02:05:10 +0000614 * name (e.g. "conf-1") or NULL to use the default. On
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300615 * exit points to the selected configuration name.
616 * @param arch Expected architecture (IH_ARCH_...)
617 * @param datap Returns address of loaded image
618 * @param lenp Returns length of loaded image
619 *
620 * @return node offset of base image, or -ve error code on error
621 */
622int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
623 const char **fit_unamep, const char **fit_uname_configp,
624 int arch, ulong *datap, ulong *lenp);
625
626/**
Simon Glass384d86d2013-05-16 13:53:21 +0000627 * fit_image_load() - load an image from a FIT
628 *
629 * This deals with all aspects of loading an image from a FIT, including
630 * selecting the right image based on configuration, verifying it, printing
631 * out progress messages, checking the type/arch/os and optionally copying it
632 * to the right load address.
633 *
Simon Glassa0c0b632014-06-12 07:24:47 -0600634 * The property to look up is defined by image_type.
635 *
Simon Glass384d86d2013-05-16 13:53:21 +0000636 * @param images Boot images structure
Simon Glass384d86d2013-05-16 13:53:21 +0000637 * @param addr Address of FIT in memory
638 * @param fit_unamep On entry this is the requested image name
Andre Przywara3234ecd2017-12-04 02:05:10 +0000639 * (e.g. "kernel") or NULL to use the default. On exit
Simon Glass384d86d2013-05-16 13:53:21 +0000640 * points to the selected image name
Simon Glassad68fc32013-07-10 23:08:10 -0700641 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywara3234ecd2017-12-04 02:05:10 +0000642 * name (e.g. "conf-1") or NULL to use the default. On
Simon Glassad68fc32013-07-10 23:08:10 -0700643 * exit points to the selected configuration name.
Simon Glass384d86d2013-05-16 13:53:21 +0000644 * @param arch Expected architecture (IH_ARCH_...)
645 * @param image_type Required image type (IH_TYPE_...). If this is
646 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
647 * also.
648 * @param bootstage_id ID of starting bootstage to use for progress updates.
649 * This will be added to the BOOTSTAGE_SUB values when
650 * calling bootstage_mark()
651 * @param load_op Decribes what to do with the load address
652 * @param datap Returns address of loaded image
653 * @param lenp Returns length of loaded image
Simon Glassa51991d2014-06-12 07:24:53 -0600654 * @return node offset of image, or -ve error code on error
Simon Glass384d86d2013-05-16 13:53:21 +0000655 */
Simon Glassa0c0b632014-06-12 07:24:47 -0600656int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassad68fc32013-07-10 23:08:10 -0700657 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass384d86d2013-05-16 13:53:21 +0000658 int arch, int image_type, int bootstage_id,
659 enum fit_load_op load_op, ulong *datap, ulong *lenp);
660
Simon Glassa51991d2014-06-12 07:24:53 -0600661#ifndef USE_HOSTCC
Simon Glass384d86d2013-05-16 13:53:21 +0000662/**
663 * fit_get_node_from_config() - Look up an image a FIT by type
664 *
Andre Przywara3234ecd2017-12-04 02:05:10 +0000665 * This looks in the selected conf- node (images->fit_uname_cfg) for a
Simon Glass384d86d2013-05-16 13:53:21 +0000666 * particular image type (e.g. "kernel") and then finds the image that is
667 * referred to.
668 *
669 * For example, for something like:
670 *
671 * images {
Andre Przywara3234ecd2017-12-04 02:05:10 +0000672 * kernel {
Simon Glass384d86d2013-05-16 13:53:21 +0000673 * ...
674 * };
675 * };
676 * configurations {
Andre Przywara3234ecd2017-12-04 02:05:10 +0000677 * conf-1 {
678 * kernel = "kernel";
Simon Glass384d86d2013-05-16 13:53:21 +0000679 * };
680 * };
681 *
682 * the function will return the node offset of the kernel@1 node, assuming
Andre Przywara3234ecd2017-12-04 02:05:10 +0000683 * that conf-1 is the chosen configuration.
Simon Glass384d86d2013-05-16 13:53:21 +0000684 *
685 * @param images Boot images structure
686 * @param prop_name Property name to look up (FIT_..._PROP)
687 * @param addr Address of FIT in memory
688 */
689int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
690 ulong addr);
691
Simon Glassb1b79922013-05-16 13:53:23 +0000692int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
693 bootm_headers_t *images,
694 char **of_flat_tree, ulong *of_size);
Grant Likely20f54922011-03-28 09:59:01 +0000695void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000696int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Galaa5130ad2008-08-15 08:24:38 -0500697
Stephen Warren6904b6e2011-10-18 11:11:49 +0000698int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100699 ulong *initrd_start, ulong *initrd_end);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000700int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyeea8e692010-10-13 13:57:35 -0600701#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren6904b6e2011-10-18 11:11:49 +0000702int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyeea8e692010-10-13 13:57:35 -0600703#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100704#endif /* !USE_HOSTCC */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100705
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100706/*******************************************************************/
707/* Legacy format specific code (prefixed with image_) */
708/*******************************************************************/
Stephen Warren6904b6e2011-10-18 11:11:49 +0000709static inline uint32_t image_get_header_size(void)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100710{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000711 return (sizeof(image_header_t));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100712}
713
714#define image_get_hdr_l(f) \
Wolfgang Denk3b506772009-08-19 11:42:56 +0200715 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100716 { \
Stephen Warren6904b6e2011-10-18 11:11:49 +0000717 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100718 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000719image_get_hdr_l(magic) /* image_get_magic */
720image_get_hdr_l(hcrc) /* image_get_hcrc */
721image_get_hdr_l(time) /* image_get_time */
722image_get_hdr_l(size) /* image_get_size */
723image_get_hdr_l(load) /* image_get_load */
724image_get_hdr_l(ep) /* image_get_ep */
725image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100726
727#define image_get_hdr_b(f) \
Wolfgang Denk3b506772009-08-19 11:42:56 +0200728 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100729 { \
730 return hdr->ih_##f; \
731 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000732image_get_hdr_b(os) /* image_get_os */
733image_get_hdr_b(arch) /* image_get_arch */
734image_get_hdr_b(type) /* image_get_type */
735image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100736
Stephen Warren6904b6e2011-10-18 11:11:49 +0000737static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100738{
739 return (char *)hdr->ih_name;
740}
741
Stephen Warren6904b6e2011-10-18 11:11:49 +0000742static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100743{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000744 return image_get_size(hdr);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100745}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100746
747/**
748 * image_get_data - get image payload start address
749 * @hdr: image header
750 *
751 * image_get_data() returns address of the image payload. For single
752 * component images it is image data start. For multi component
753 * images it points to the null terminated table of sub-images sizes.
754 *
755 * returns:
756 * image payload data start address
757 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000758static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100759{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000760 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100761}
762
Stephen Warren6904b6e2011-10-18 11:11:49 +0000763static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100764{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000765 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100766}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000767static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100768{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000769 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100770}
771
772#define image_set_hdr_l(f) \
773 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
774 { \
Stephen Warren6904b6e2011-10-18 11:11:49 +0000775 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100776 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000777image_set_hdr_l(magic) /* image_set_magic */
778image_set_hdr_l(hcrc) /* image_set_hcrc */
779image_set_hdr_l(time) /* image_set_time */
780image_set_hdr_l(size) /* image_set_size */
781image_set_hdr_l(load) /* image_set_load */
782image_set_hdr_l(ep) /* image_set_ep */
783image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100784
785#define image_set_hdr_b(f) \
786 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
787 { \
788 hdr->ih_##f = val; \
789 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000790image_set_hdr_b(os) /* image_set_os */
791image_set_hdr_b(arch) /* image_set_arch */
792image_set_hdr_b(type) /* image_set_type */
793image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100794
Stephen Warren6904b6e2011-10-18 11:11:49 +0000795static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100796{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000797 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100798}
799
Stephen Warren6904b6e2011-10-18 11:11:49 +0000800int image_check_hcrc(const image_header_t *hdr);
801int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100802#ifndef USE_HOSTCC
Simon Glassda1a1342017-08-03 12:22:15 -0600803ulong env_get_bootm_low(void);
804phys_size_t env_get_bootm_size(void);
805phys_size_t env_get_bootm_mapsize(void);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100806#endif
Simon Glassa51991d2014-06-12 07:24:53 -0600807void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100808
Stephen Warren6904b6e2011-10-18 11:11:49 +0000809static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100810{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000811 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100812}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000813static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100814{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000815 return (image_get_type(hdr) == type);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100816}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000817static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100818{
Alison Wang42664e02017-06-06 15:32:40 +0800819 return (image_get_arch(hdr) == arch) ||
820 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100821}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000822static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100823{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000824 return (image_get_os(hdr) == os);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100825}
826
Stephen Warren6904b6e2011-10-18 11:11:49 +0000827ulong image_multi_count(const image_header_t *hdr);
828void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100829 ulong *data, ulong *len);
830
Stephen Warren6904b6e2011-10-18 11:11:49 +0000831void image_print_contents(const void *hdr);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100832
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100833#ifndef USE_HOSTCC
Stephen Warren6904b6e2011-10-18 11:11:49 +0000834static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100835{
Mike Frysinger5da0bed2011-10-03 14:50:33 +0000836#ifndef IH_ARCH_DEFAULT
837# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100838#endif
Mike Frysinger5da0bed2011-10-03 14:50:33 +0000839 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100840}
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100841#endif /* USE_HOSTCC */
wdenk5b1d7132002-11-03 00:07:02 +0000842
Simon Glass9ca37422013-05-08 08:06:01 +0000843/**
844 * Set up properties in the FDT
845 *
846 * This sets up properties in the FDT that is to be passed to linux.
847 *
848 * @images: Images information
849 * @blob: FDT to update
850 * @of_size: Size of the FDT
851 * @lmb: Points to logical memory block structure
852 * @return 0 if ok, <0 on failure
853 */
854int image_setup_libfdt(bootm_headers_t *images, void *blob,
855 int of_size, struct lmb *lmb);
856
857/**
858 * Set up the FDT to use for booting a kernel
859 *
860 * This performs ramdisk setup, sets up the FDT if required, and adds
861 * paramters to the FDT if libfdt is available.
862 *
863 * @param images Images information
864 * @return 0 if ok, <0 on failure
865 */
866int image_setup_linux(bootm_headers_t *images);
867
Simon Glass5f1afdd2013-07-04 13:26:10 -0700868/**
869 * bootz_setup() - Extract stat and size of a Linux xImage
870 *
871 * @image: Address of image
872 * @start: Returns start address of image
873 * @end : Returns end address of image
874 * @return 0 if OK, 1 if the image was not recognised
875 */
876int bootz_setup(ulong image, ulong *start, ulong *end);
877
Bin Chendac184b2018-01-27 16:59:09 +1100878/**
879 * Return the correct start address and size of a Linux aarch64 Image.
880 *
881 * @image: Address of image
882 * @start: Returns start address of image
883 * @size : Returns size image
884 * @return 0 if OK, 1 if the image was not recognised
885 */
886int booti_setup(ulong image, ulong *relocated_addr, ulong *size);
Simon Glass5f1afdd2013-07-04 13:26:10 -0700887
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100888/*******************************************************************/
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100889/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100890/*******************************************************************/
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100891
892#define FIT_IMAGES_PATH "/images"
893#define FIT_CONFS_PATH "/configurations"
894
Simon Glass58fe7e52013-06-13 15:10:00 -0700895/* hash/signature node */
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100896#define FIT_HASH_NODENAME "hash"
897#define FIT_ALGO_PROP "algo"
898#define FIT_VALUE_PROP "value"
Joe Hershberger8b7d32a2012-08-17 10:34:39 +0000899#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass58fe7e52013-06-13 15:10:00 -0700900#define FIT_SIG_NODENAME "signature"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100901
902/* image node */
903#define FIT_DATA_PROP "data"
Peng Fan8876c7e2017-12-05 13:20:59 +0800904#define FIT_DATA_POSITION_PROP "data-position"
tomas.melin@vaisala.com45ee7902017-01-13 13:20:14 +0200905#define FIT_DATA_OFFSET_PROP "data-offset"
906#define FIT_DATA_SIZE_PROP "data-size"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100907#define FIT_TIMESTAMP_PROP "timestamp"
908#define FIT_DESC_PROP "description"
909#define FIT_ARCH_PROP "arch"
910#define FIT_TYPE_PROP "type"
911#define FIT_OS_PROP "os"
912#define FIT_COMP_PROP "compression"
913#define FIT_ENTRY_PROP "entry"
914#define FIT_LOAD_PROP "load"
915
916/* configuration node */
917#define FIT_KERNEL_PROP "kernel"
918#define FIT_RAMDISK_PROP "ramdisk"
919#define FIT_FDT_PROP "fdt"
Karl Apsite8f0537d2015-05-21 09:52:47 -0400920#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100921#define FIT_DEFAULT_PROP "default"
Simon Glass0129b522014-10-19 21:11:24 -0600922#define FIT_SETUP_PROP "setup"
Michal Simek0a130b12016-05-17 13:58:44 +0200923#define FIT_FPGA_PROP "fpga"
Michal Simekb766e8f2018-03-26 16:31:26 +0200924#define FIT_FIRMWARE_PROP "firmware"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100925
Michael van der Westhuizene36c6c32014-05-30 20:59:00 +0200926#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100927
Simon Glassa6131a22016-02-22 22:55:56 -0700928#if IMAGE_ENABLE_FIT
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100929/* cmdline argument format parsing */
Mike Frysinger711453d2012-04-22 06:59:06 +0000930int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowicz3413e222008-02-21 17:20:20 +0100931 ulong *addr, const char **conf_name);
Mike Frysinger711453d2012-04-22 06:59:06 +0000932int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowicz3413e222008-02-21 17:20:20 +0100933 ulong *addr, const char **image_name);
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100934
Guilherme Maciel Ferreira3c46bcd2015-01-15 02:54:42 -0200935int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000936void fit_print_contents(const void *fit);
937void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100938
939/**
940 * fit_get_end - get FIT image size
941 * @fit: pointer to the FIT format image header
942 *
943 * returns:
944 * size of the FIT image (blob) in memory
945 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000946static inline ulong fit_get_size(const void *fit)
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100947{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000948 return fdt_totalsize(fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100949}
950
951/**
952 * fit_get_end - get FIT image end
953 * @fit: pointer to the FIT format image header
954 *
955 * returns:
956 * end address of the FIT image (blob) in memory
957 */
Simon Glass5b539a02016-02-24 09:14:42 -0700958ulong fit_get_end(const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100959
960/**
961 * fit_get_name - get FIT node name
962 * @fit: pointer to the FIT format image header
963 *
964 * returns:
965 * NULL, on error
966 * pointer to node name, on success
967 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000968static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100969 int noffset, int *len)
970{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000971 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100972}
973
Stephen Warren6904b6e2011-10-18 11:11:49 +0000974int fit_get_desc(const void *fit, int noffset, char **desc);
975int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100976
Stephen Warren6904b6e2011-10-18 11:11:49 +0000977int fit_image_get_node(const void *fit, const char *image_uname);
978int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
979int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
980int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
981int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
982int fit_image_get_load(const void *fit, int noffset, ulong *load);
983int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
984int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100985 const void **data, size_t *size);
tomas.melin@vaisala.com45ee7902017-01-13 13:20:14 +0200986int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
Peng Fan8876c7e2017-12-05 13:20:59 +0800987int fit_image_get_data_position(const void *fit, int noffset,
988 int *data_position);
tomas.melin@vaisala.com45ee7902017-01-13 13:20:14 +0200989int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100990
Stephen Warren6904b6e2011-10-18 11:11:49 +0000991int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
992int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100993 int *value_len);
994
Stephen Warren6904b6e2011-10-18 11:11:49 +0000995int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassee382652013-05-07 06:12:01 +0000996
997/**
Simon Glassfbabc0f2013-06-13 15:10:01 -0700998 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassee382652013-05-07 06:12:01 +0000999 *
Simon Glassfbabc0f2013-06-13 15:10:01 -07001000 * @keydir: Directory containing keys
1001 * @kwydest: FDT blob to write public key information to
1002 * @fit: Pointer to the FIT format image header
1003 * @comment: Comment to add to signature nodes
1004 * @require_keys: Mark all keys as 'required'
George McCollister23d14892017-01-06 13:14:17 -06001005 * @engine_id: Engine to use for signing
Simon Glassfbabc0f2013-06-13 15:10:01 -07001006 *
1007 * Adds hash values for all component images in the FIT blob.
1008 * Hashes are calculated for all component images which have hash subnodes
1009 * with algorithm property set to one of the supported hash algorithms.
1010 *
1011 * Also add signatures if signature nodes are present.
1012 *
1013 * returns
1014 * 0, on success
1015 * libfdt error code, on failure
Simon Glassee382652013-05-07 06:12:01 +00001016 */
Simon Glassfbabc0f2013-06-13 15:10:01 -07001017int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
George McCollister23d14892017-01-06 13:14:17 -06001018 const char *comment, int require_keys,
1019 const char *engine_id);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001020
Jun Nieadf5d1c2018-02-27 16:55:58 +08001021int fit_image_verify_with_data(const void *fit, int image_noffset,
1022 const void *data, size_t size);
Simon Glass7428ad12013-05-07 06:11:57 +00001023int fit_image_verify(const void *fit, int noffset);
Simon Glass384d86d2013-05-16 13:53:21 +00001024int fit_config_verify(const void *fit, int conf_noffset);
Simon Glass7428ad12013-05-07 06:11:57 +00001025int fit_all_image_verify(const void *fit);
Stephen Warren6904b6e2011-10-18 11:11:49 +00001026int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1027int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1028int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1029int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1030int fit_check_format(const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001031
Gabe Blackd572e162012-10-25 16:31:10 +00001032int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren6904b6e2011-10-18 11:11:49 +00001033int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001034
Simon Glassdc0f52c2013-05-07 06:12:00 +00001035/**
1036 * fit_conf_get_prop_node() - Get node refered to by a configuration
1037 * @fit: FIT to check
1038 * @noffset: Offset of conf@xxx node to check
1039 * @prop_name: Property to read from the conf node
1040 *
Andre Przywara3234ecd2017-12-04 02:05:10 +00001041 * The conf- nodes contain references to other nodes, using properties
1042 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
Simon Glassdc0f52c2013-05-07 06:12:00 +00001043 * return the offset of the node referred to (e.g. offset of node
Andre Przywara3234ecd2017-12-04 02:05:10 +00001044 * "/images/kernel".
Simon Glassdc0f52c2013-05-07 06:12:00 +00001045 */
1046int fit_conf_get_prop_node(const void *fit, int noffset,
1047 const char *prop_name);
1048
Stephen Warren6904b6e2011-10-18 11:11:49 +00001049void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001050
Simon Glass36b916a2013-05-07 06:11:52 +00001051int fit_check_ramdisk(const void *fit, int os_noffset,
1052 uint8_t arch, int verify);
1053
Simon Glass10a1eca2013-05-07 06:11:54 +00001054int calculate_hash(const void *data, int data_len, const char *algo,
1055 uint8_t *value, int *value_len);
1056
Simon Glass384d86d2013-05-16 13:53:21 +00001057/*
Simon Glass58fe7e52013-06-13 15:10:00 -07001058 * At present we only support signing on the host, and verification on the
1059 * device
Simon Glass384d86d2013-05-16 13:53:21 +00001060 */
1061#if defined(CONFIG_FIT_SIGNATURE)
1062# ifdef USE_HOSTCC
Simon Glass58fe7e52013-06-13 15:10:00 -07001063# define IMAGE_ENABLE_SIGN 1
Heiko Schocherd7b42322014-03-03 12:19:30 +01001064# define IMAGE_ENABLE_VERIFY 1
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001065# include <openssl/evp.h>
Simon Glass384d86d2013-05-16 13:53:21 +00001066#else
Simon Glass58fe7e52013-06-13 15:10:00 -07001067# define IMAGE_ENABLE_SIGN 0
Simon Glass384d86d2013-05-16 13:53:21 +00001068# define IMAGE_ENABLE_VERIFY 1
1069# endif
1070#else
Simon Glass58fe7e52013-06-13 15:10:00 -07001071# define IMAGE_ENABLE_SIGN 0
Simon Glass384d86d2013-05-16 13:53:21 +00001072# define IMAGE_ENABLE_VERIFY 0
1073#endif
1074
1075#ifdef USE_HOSTCC
Heiko Schocherd7b42322014-03-03 12:19:30 +01001076void *image_get_host_blob(void);
1077void image_set_host_blob(void *host_blob);
1078# define gd_fdt_blob() image_get_host_blob()
Simon Glass384d86d2013-05-16 13:53:21 +00001079#else
1080# define gd_fdt_blob() (gd->fdt_blob)
1081#endif
1082
1083#ifdef CONFIG_FIT_BEST_MATCH
1084#define IMAGE_ENABLE_BEST_MATCH 1
1085#else
1086#define IMAGE_ENABLE_BEST_MATCH 0
1087#endif
1088
Simon Glass58fe7e52013-06-13 15:10:00 -07001089/* Information passed to the signing routines */
1090struct image_sign_info {
1091 const char *keydir; /* Directory conaining keys */
1092 const char *keyname; /* Name of key to use */
1093 void *fit; /* Pointer to FIT blob */
1094 int node_offset; /* Offset of signature node */
Andrew Duda6616c822016-11-08 18:53:41 +00001095 const char *name; /* Algorithm name */
1096 struct checksum_algo *checksum; /* Checksum algorithm information */
1097 struct crypto_algo *crypto; /* Crypto algorithm information */
Simon Glass58fe7e52013-06-13 15:10:00 -07001098 const void *fdt_blob; /* FDT containing public keys */
1099 int required_keynode; /* Node offset of key to use: -1=any */
1100 const char *require_keys; /* Value for 'required' property */
George McCollister23d14892017-01-06 13:14:17 -06001101 const char *engine_id; /* Engine to use for signing */
Simon Glass58fe7e52013-06-13 15:10:00 -07001102};
Simon Glasse3ee2fb2016-02-22 22:55:43 -07001103#endif /* Allow struct image_region to always be defined for rsa.h */
Simon Glass58fe7e52013-06-13 15:10:00 -07001104
1105/* A part of an image, used for hashing */
1106struct image_region {
1107 const void *data;
1108 int size;
1109};
1110
Simon Glasse3ee2fb2016-02-22 22:55:43 -07001111#if IMAGE_ENABLE_FIT
1112
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001113#if IMAGE_ENABLE_VERIFY
Jeroen Hofsteebfe88fe2014-06-12 22:27:12 +02001114# include <u-boot/rsa-checksum.h>
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001115#endif
1116struct checksum_algo {
1117 const char *name;
1118 const int checksum_len;
Andrew Duda3db9ff02016-11-08 18:53:40 +00001119 const int der_len;
1120 const uint8_t *der_prefix;
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001121#if IMAGE_ENABLE_SIGN
Heiko Schocherd7b42322014-03-03 12:19:30 +01001122 const EVP_MD *(*calculate_sign)(void);
1123#endif
Ruchika Gupta2c8987f2015-01-23 16:01:59 +05301124 int (*calculate)(const char *name,
1125 const struct image_region region[],
1126 int region_count, uint8_t *checksum);
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001127};
1128
Andrew Duda06ca6d62016-11-08 18:53:41 +00001129struct crypto_algo {
Simon Glass58fe7e52013-06-13 15:10:00 -07001130 const char *name; /* Name of algorithm */
Andrew Duda06ca6d62016-11-08 18:53:41 +00001131 const int key_len;
Simon Glass58fe7e52013-06-13 15:10:00 -07001132
1133 /**
1134 * sign() - calculate and return signature for given input data
1135 *
1136 * @info: Specifies key and FIT information
1137 * @data: Pointer to the input data
1138 * @data_len: Data length
1139 * @sigp: Set to an allocated buffer holding the signature
1140 * @sig_len: Set to length of the calculated hash
1141 *
1142 * This computes input data signature according to selected algorithm.
1143 * Resulting signature value is placed in an allocated buffer, the
1144 * pointer is returned as *sigp. The length of the calculated
1145 * signature is returned via the sig_len pointer argument. The caller
1146 * should free *sigp.
1147 *
1148 * @return: 0, on success, -ve on error
1149 */
1150 int (*sign)(struct image_sign_info *info,
1151 const struct image_region region[],
1152 int region_count, uint8_t **sigp, uint *sig_len);
1153
1154 /**
1155 * add_verify_data() - Add verification information to FDT
1156 *
1157 * Add public key information to the FDT node, suitable for
1158 * verification at run-time. The information added depends on the
1159 * algorithm being used.
1160 *
1161 * @info: Specifies key and FIT information
1162 * @keydest: Destination FDT blob for public key data
1163 * @return: 0, on success, -ve on error
1164 */
1165 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1166
1167 /**
1168 * verify() - Verify a signature against some data
1169 *
1170 * @info: Specifies key and FIT information
1171 * @data: Pointer to the input data
1172 * @data_len: Data length
1173 * @sig: Signature
1174 * @sig_len: Number of bytes in signature
1175 * @return 0 if verified, -ve on error
1176 */
1177 int (*verify)(struct image_sign_info *info,
1178 const struct image_region region[], int region_count,
1179 uint8_t *sig, uint sig_len);
Andrew Duda06ca6d62016-11-08 18:53:41 +00001180};
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001181
Andrew Duda6616c822016-11-08 18:53:41 +00001182/**
1183 * image_get_checksum_algo() - Look up a checksum algorithm
1184 *
1185 * @param full_name Name of algorithm in the form "checksum,crypto"
1186 * @return pointer to algorithm information, or NULL if not found
1187 */
1188struct checksum_algo *image_get_checksum_algo(const char *full_name);
Simon Glass58fe7e52013-06-13 15:10:00 -07001189
1190/**
Andrew Duda6616c822016-11-08 18:53:41 +00001191 * image_get_crypto_algo() - Look up a cryptosystem algorithm
Simon Glass58fe7e52013-06-13 15:10:00 -07001192 *
Andrew Duda6616c822016-11-08 18:53:41 +00001193 * @param full_name Name of algorithm in the form "checksum,crypto"
Simon Glass58fe7e52013-06-13 15:10:00 -07001194 * @return pointer to algorithm information, or NULL if not found
1195 */
Andrew Duda6616c822016-11-08 18:53:41 +00001196struct crypto_algo *image_get_crypto_algo(const char *full_name);
Simon Glass58fe7e52013-06-13 15:10:00 -07001197
Simon Glassfbabc0f2013-06-13 15:10:01 -07001198/**
1199 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1200 *
1201 * @fit: FIT to check
1202 * @image_noffset: Offset of image node to check
1203 * @data: Image data to check
1204 * @size: Size of image data
1205 * @sig_blob: FDT containing public keys
1206 * @no_sigsp: Returns 1 if no signatures were required, and
1207 * therefore nothing was checked. The caller may wish
1208 * to fall back to other mechanisms, or refuse to
1209 * boot.
1210 * @return 0 if all verified ok, <0 on error
1211 */
1212int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1213 const char *data, size_t size, const void *sig_blob,
1214 int *no_sigsp);
1215
1216/**
1217 * fit_image_check_sig() - Check a single image signature node
1218 *
1219 * @fit: FIT to check
1220 * @noffset: Offset of signature node to check
1221 * @data: Image data to check
1222 * @size: Size of image data
1223 * @required_keynode: Offset in the control FDT of the required key node,
1224 * if any. If this is given, then the image wil not
1225 * pass verification unless that key is used. If this is
1226 * -1 then any signature will do.
1227 * @err_msgp: In the event of an error, this will be pointed to a
1228 * help error string to display to the user.
1229 * @return 0 if all verified ok, <0 on error
1230 */
1231int fit_image_check_sig(const void *fit, int noffset, const void *data,
1232 size_t size, int required_keynode, char **err_msgp);
1233
Simon Glass56ab8d62013-06-13 15:10:09 -07001234/**
1235 * fit_region_make_list() - Make a list of regions to hash
1236 *
1237 * Given a list of FIT regions (offset, size) provided by libfdt, create
1238 * a list of regions (void *, size) for use by the signature creationg
1239 * and verification code.
1240 *
1241 * @fit: FIT image to process
1242 * @fdt_regions: Regions as returned by libfdt
1243 * @count: Number of regions returned by libfdt
1244 * @region: Place to put list of regions (NULL to allocate it)
1245 * @return pointer to list of regions, or NULL if out of memory
1246 */
1247struct image_region *fit_region_make_list(const void *fit,
1248 struct fdt_region *fdt_regions, int count,
1249 struct image_region *region);
Simon Glassfbabc0f2013-06-13 15:10:01 -07001250
Stephen Warren6904b6e2011-10-18 11:11:49 +00001251static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001252{
Heiko Schocherd7b42322014-03-03 12:19:30 +01001253#ifndef USE_HOSTCC
Thierry Reding7d731a92011-10-27 08:58:25 +00001254 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocherd7b42322014-03-03 12:19:30 +01001255#else
1256 return 0;
1257#endif
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001258}
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001259
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +01001260#ifdef CONFIG_FIT_VERBOSE
Stephen Warren6904b6e2011-10-18 11:11:49 +00001261#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +01001262 "FIT images not supported for '%s'\n", \
1263 __FILE__, __LINE__, (msg))
1264
Stephen Warren6904b6e2011-10-18 11:11:49 +00001265#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +01001266 "FIT images not supported for '%s' " \
1267 "- must reset board to recover!\n", \
1268 __FILE__, __LINE__, (msg))
1269#else
1270#define fit_unsupported(msg)
1271#define fit_unsupported_reset(msg)
1272#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowicz3413e222008-02-21 17:20:20 +01001273#endif /* CONFIG_FIT */
Marian Balakowicz95418502008-01-31 13:55:39 +01001274
Sebastian Siewior686d6672014-05-05 15:08:09 -05001275#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1276struct andr_img_hdr;
1277int android_image_check_header(const struct andr_img_hdr *hdr);
1278int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1279 ulong *os_data, ulong *os_len);
1280int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1281 ulong *rd_data, ulong *rd_len);
Bin Chen909f1402018-01-27 16:59:08 +11001282int android_image_get_second(const struct andr_img_hdr *hdr,
1283 ulong *second_data, ulong *second_len);
Sebastian Siewior686d6672014-05-05 15:08:09 -05001284ulong android_image_get_end(const struct andr_img_hdr *hdr);
1285ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Michael Trimarchi44af20b2016-06-10 19:54:37 +02001286void android_print_contents(const struct andr_img_hdr *hdr);
Sebastian Siewior686d6672014-05-05 15:08:09 -05001287
1288#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1289
Simon Glassf287dfd2016-02-22 22:55:55 -07001290/**
1291 * board_fit_config_name_match() - Check for a matching board name
1292 *
1293 * This is used when SPL loads a FIT containing multiple device tree files
1294 * and wants to work out which one to use. The description of each one is
1295 * passed to this function. The description comes from the 'description' field
1296 * in each (FDT) image node.
1297 *
1298 * @name: Device tree description
1299 * @return 0 if this device tree should be used, non-zero to try the next
1300 */
1301int board_fit_config_name_match(const char *name);
1302
Madan Srinivasa2f8c942017-04-07 10:00:02 -05001303#if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1304 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
Daniel Allredcf839bd2016-06-27 09:19:21 -05001305/**
1306 * board_fit_image_post_process() - Do any post-process on FIT binary data
1307 *
1308 * This is used to do any sort of image manipulation, verification, decryption
1309 * etc. in a platform or board specific way. Obviously, anything done here would
1310 * need to be comprehended in how the images were prepared before being injected
1311 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1312 * before being added to the FIT image).
1313 *
1314 * @image: pointer to the image start pointer
1315 * @size: pointer to the image size
1316 * @return no return value (failure should be handled internally)
1317 */
1318void board_fit_image_post_process(void **p_image, size_t *p_size);
1319#endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1320
Cooper Jr., Frankline6792402017-06-16 17:25:05 -05001321#define FDT_ERROR ((ulong)(-1))
1322
Cooper Jr., Franklin899aad22017-06-16 17:25:06 -05001323ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
Jean-Jacques Hiblot5e7c12e2017-09-15 12:57:27 +02001324
1325/**
1326 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1327 *
1328 * A FIT image contains one or more DTBs. This function parses the
1329 * configurations described in the FIT images and returns the node of
1330 * the first matching DTB. To check if a DTB matches a board, this function
1331 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1332 * the node described by the default configuration if it exists.
1333 *
1334 * @fdt: pointer to flat device tree
1335 * @return the node if found, -ve otherwise
1336 */
Cooper Jr., Franklin899aad22017-06-16 17:25:06 -05001337int fit_find_config_node(const void *fdt);
1338
Andrew F. Davis28b28f72016-11-29 16:33:20 -06001339/**
1340 * Mapping of image types to function handlers to be invoked on the associated
1341 * loaded images
1342 *
1343 * @type: Type of image, I.E. IH_TYPE_*
1344 * @handler: Function to call on loaded image
1345 */
1346struct fit_loadable_tbl {
1347 int type;
1348 /**
1349 * handler() - Process a loaded image
1350 *
1351 * @data: Pointer to start of loaded image data
1352 * @size: Size of loaded image data
1353 */
1354 void (*handler)(ulong data, size_t size);
1355};
1356
1357/*
1358 * Define a FIT loadable image type handler
1359 *
1360 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1361 * _handler is the handler function to call after this image type is loaded
1362 */
1363#define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1364 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1365 .type = _type, \
1366 .handler = _handler, \
1367 }
1368
Marian Balakowiczb4a12a92008-01-08 18:12:17 +01001369#endif /* __IMAGE_H__ */