blob: 03424f052199822768b240e91fa0ad2a987014d1 [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>
Marek Vasut85ed2892018-06-13 06:13:32 +020020#include <stdbool.h>
Mike Frysinger4ad8e9f2009-07-02 19:23:25 -040021
Simon Glass9ca37422013-05-08 08:06:01 +000022/* Define this to avoid #ifdefs later on */
23struct lmb;
Masahiro Yamadafe11aee2018-03-21 18:03:35 +090024struct fdt_region;
Simon Glass9ca37422013-05-08 08:06:01 +000025
Mike Frysinger4ad8e9f2009-07-02 19:23:25 -040026#ifdef USE_HOSTCC
Jörg Krause983487f2015-04-22 21:36:22 +020027#include <sys/types.h>
Simon Glasse719d3b2021-09-25 19:43:20 -060028#include <linux/kconfig.h>
Marian Balakowiczf4891a12008-02-21 17:20:18 +010029
Simon Glass1030f162013-05-08 08:05:58 +000030#define IMAGE_INDENT_STRING ""
Simon Glassf0fd5112013-05-07 06:11:58 +000031
Wolfgang Denkbf368772008-10-21 11:23:56 +020032#else
33
34#include <lmb.h>
Wolfgang Denkbf368772008-10-21 11:23:56 +020035#include <asm/u-boot.h>
Mike Frysinger175467a2010-01-21 04:03:20 -050036#include <command.h>
Alexandru Gagniucb04e9182021-07-14 17:05:39 -050037#include <linker_lists.h>
Wolfgang Denkbf368772008-10-21 11:23:56 +020038
Simon Glass1030f162013-05-08 08:05:58 +000039#define IMAGE_INDENT_STRING " "
Simon Glassf0fd5112013-05-07 06:11:58 +000040
Bartlomiej Siekad7816fb2008-03-11 12:34:47 +010041#endif /* USE_HOSTCC */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +010042
Michael van der Westhuizene36c6c32014-05-30 20:59:00 +020043#include <hash.h>
Masahiro Yamada75f82d02018-03-05 01:20:11 +090044#include <linux/libfdt.h>
Marian Balakowicze227fbb2008-02-29 21:24:06 +010045#include <fdt_support.h>
Simon Glass2c6a1b02021-09-25 19:43:33 -060046#include <u-boot/hash-checksum.h>
Simon Glass9ca37422013-05-08 08:06:01 +000047
Simon Glass85f13782019-12-28 10:45:03 -070048extern ulong image_load_addr; /* Default Load Address */
49extern ulong image_save_addr; /* Default Save Address */
50extern ulong image_save_size; /* Default Save Size */
Philippe Reynesd28484e2022-03-28 22:56:59 +020051extern ulong image_load_offset; /* Default Load Address Offset */
Simon Glass85f13782019-12-28 10:45:03 -070052
Simon Glassd563c252021-02-15 17:08:09 -070053/* An invalid size, meaning that the image size is not known */
54#define IMAGE_SIZE_INVAL (-1UL)
55
Simon Glass7da41d52016-06-30 10:52:14 -060056enum ih_category {
57 IH_ARCH,
58 IH_COMP,
59 IH_OS,
60 IH_TYPE,
61
62 IH_COUNT,
63};
64
wdenk5b1d7132002-11-03 00:07:02 +000065/*
66 * Operating System Codes
Masahiro Yamada166829f2016-07-21 15:16:00 +090067 *
68 * The following are exposed to uImage header.
Stefano Babic10d7c4b2018-12-17 11:02:00 +010069 * New IDs *MUST* be appended at the end of the list and *NEVER*
70 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +000071 */
Simon Glass3c536ed2016-06-30 10:52:13 -060072enum {
73 IH_OS_INVALID = 0, /* Invalid OS */
74 IH_OS_OPENBSD, /* OpenBSD */
75 IH_OS_NETBSD, /* NetBSD */
76 IH_OS_FREEBSD, /* FreeBSD */
77 IH_OS_4_4BSD, /* 4.4BSD */
78 IH_OS_LINUX, /* Linux */
79 IH_OS_SVR4, /* SVR4 */
80 IH_OS_ESIX, /* Esix */
81 IH_OS_SOLARIS, /* Solaris */
82 IH_OS_IRIX, /* Irix */
83 IH_OS_SCO, /* SCO */
84 IH_OS_DELL, /* Dell */
85 IH_OS_NCR, /* NCR */
86 IH_OS_LYNXOS, /* LynxOS */
87 IH_OS_VXWORKS, /* VxWorks */
88 IH_OS_PSOS, /* pSOS */
89 IH_OS_QNX, /* QNX */
90 IH_OS_U_BOOT, /* Firmware */
91 IH_OS_RTEMS, /* RTEMS */
92 IH_OS_ARTOS, /* ARTOS */
93 IH_OS_UNITY, /* Unity OS */
94 IH_OS_INTEGRITY, /* INTEGRITY */
95 IH_OS_OSE, /* OSE */
96 IH_OS_PLAN9, /* Plan 9 */
97 IH_OS_OPENRTOS, /* OpenRTOS */
Philipp Tomsich1bf3eb22017-09-13 21:29:29 +020098 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
Bryan O'Donoghue2f72dec2018-03-13 16:50:35 +000099 IH_OS_TEE, /* Trusted Execution Environment */
Lukas Auer515b9342019-08-21 21:14:44 +0200100 IH_OS_OPENSBI, /* RISC-V OpenSBI */
Cristian Ciocaltea217f9642019-12-24 18:05:38 +0200101 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
Simon Glass3c536ed2016-06-30 10:52:13 -0600102
103 IH_OS_COUNT,
104};
wdenk5b1d7132002-11-03 00:07:02 +0000105
106/*
107 * CPU Architecture Codes (supported by Linux)
Masahiro Yamada166829f2016-07-21 15:16:00 +0900108 *
109 * The following are exposed to uImage header.
Stefano Babic10d7c4b2018-12-17 11:02:00 +0100110 * New IDs *MUST* be appended at the end of the list and *NEVER*
111 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000112 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600113enum {
114 IH_ARCH_INVALID = 0, /* Invalid CPU */
115 IH_ARCH_ALPHA, /* Alpha */
116 IH_ARCH_ARM, /* ARM */
117 IH_ARCH_I386, /* Intel x86 */
118 IH_ARCH_IA64, /* IA64 */
119 IH_ARCH_MIPS, /* MIPS */
120 IH_ARCH_MIPS64, /* MIPS 64 Bit */
121 IH_ARCH_PPC, /* PowerPC */
122 IH_ARCH_S390, /* IBM S390 */
123 IH_ARCH_SH, /* SuperH */
124 IH_ARCH_SPARC, /* Sparc */
125 IH_ARCH_SPARC64, /* Sparc 64 Bit */
126 IH_ARCH_M68K, /* M68K */
Masahiro Yamada166829f2016-07-21 15:16:00 +0900127 IH_ARCH_NIOS, /* Nios-32 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600128 IH_ARCH_MICROBLAZE, /* MicroBlaze */
129 IH_ARCH_NIOS2, /* Nios-II */
130 IH_ARCH_BLACKFIN, /* Blackfin */
131 IH_ARCH_AVR32, /* AVR32 */
132 IH_ARCH_ST200, /* STMicroelectronics ST200 */
133 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
134 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
135 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
136 IH_ARCH_ARM64, /* ARM64 */
137 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
138 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
Chris Zankel41e37372016-08-10 18:36:43 +0300139 IH_ARCH_XTENSA, /* Xtensa */
Rick Chen3301bfc2017-12-26 13:55:58 +0800140 IH_ARCH_RISCV, /* RISC-V */
Simon Glass3c536ed2016-06-30 10:52:13 -0600141
142 IH_ARCH_COUNT,
143};
wdenk5b1d7132002-11-03 00:07:02 +0000144
145/*
146 * Image Types
147 *
148 * "Standalone Programs" are directly runnable in the environment
149 * provided by U-Boot; it is expected that (if they behave
150 * well) you can continue to work in U-Boot after return from
151 * the Standalone Program.
152 * "OS Kernel Images" are usually images of some Embedded OS which
153 * will take over control completely. Usually these programs
154 * will install their own set of exception handlers, device
155 * drivers, set up the MMU, etc. - this means, that you cannot
156 * expect to re-enter U-Boot except by resetting the CPU.
157 * "RAMDisk Images" are more or less just data blocks, and their
158 * parameters (address, size) are passed to an OS kernel that is
159 * being started.
160 * "Multi-File Images" contain several images, typically an OS
161 * (Linux) kernel image and one or more data images like
162 * RAMDisks. This construct is useful for instance when you want
163 * to boot over the network using BOOTP etc., where the boot
164 * server provides just a single image file, but you want to get
165 * for instance an OS kernel and a RAMDisk image.
166 *
167 * "Multi-File Images" start with a list of image sizes, each
168 * image size (in bytes) specified by an "uint32_t" in network
169 * byte order. This list is terminated by an "(uint32_t)0".
170 * Immediately after the terminating 0 follow the images, one by
171 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenk391b5742004-10-10 23:27:33 +0000172 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000173 *
174 * "Firmware Images" are binary images containing firmware (like
175 * U-Boot or FPGA images) which usually will be programmed to
176 * flash memory.
177 *
178 * "Script files" are command sequences that will be executed by
179 * U-Boot's command interpreter; this feature is especially
180 * useful when you configure U-Boot to use a real shell (hush)
wdenk874ac262003-07-24 23:38:38 +0000181 * as command interpreter (=> Shell Scripts).
Masahiro Yamada166829f2016-07-21 15:16:00 +0900182 *
183 * The following are exposed to uImage header.
Stefano Babic10d7c4b2018-12-17 11:02:00 +0100184 * New IDs *MUST* be appended at the end of the list and *NEVER*
185 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000186 */
187
Simon Glass3c536ed2016-06-30 10:52:13 -0600188enum {
189 IH_TYPE_INVALID = 0, /* Invalid Image */
190 IH_TYPE_STANDALONE, /* Standalone Program */
191 IH_TYPE_KERNEL, /* OS Kernel Image */
192 IH_TYPE_RAMDISK, /* RAMDisk Image */
193 IH_TYPE_MULTI, /* Multi-File Image */
194 IH_TYPE_FIRMWARE, /* Firmware Image */
195 IH_TYPE_SCRIPT, /* Script file */
196 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
197 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
198 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
199 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
200 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
201 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
202 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
203 /* OS Kernel Image, can run from any load address */
204 IH_TYPE_KERNEL_NOLOAD,
205 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
206 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
207 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
208 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
Marek Vasut83f69282018-04-15 13:15:33 +0200209 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
Simon Glass3c536ed2016-06-30 10:52:13 -0600210 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
211 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
212 IH_TYPE_LOADABLE, /* A list of typeless images */
213 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
214 IH_TYPE_RKSD, /* Rockchip SD card */
215 IH_TYPE_RKSPI, /* Rockchip SPI image */
216 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
217 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
Alexander Graf5329d672018-04-13 14:18:52 +0200218 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
Simon Glass3c536ed2016-06-30 10:52:13 -0600219 IH_TYPE_FPGA, /* FPGA Image */
Albert ARIBAUD \(3ADEV\)2e9f4942016-09-26 09:08:06 +0200220 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
Andrew F. Davis378bcff2016-11-29 16:33:21 -0600221 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
Sven Ebenfeld59697a22016-11-06 16:37:56 +0100222 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
Andrew F. Davis30f9d562017-07-31 10:58:20 -0500223 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
Patrick Delaunaye6db5df2018-03-12 10:46:04 +0100224 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
Marek Vasut83f69282018-04-15 13:15:33 +0200225 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
developere1de5d42018-11-15 10:07:49 +0800226 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
Stefano Babic10d7c4b2018-12-17 11:02:00 +0100227 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
228 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
Patrick Delaunay42594db2019-08-02 15:07:19 +0200229 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
Andre Przywarae53f9d92018-12-20 01:15:18 +0000230 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
Samuel Holland75728782022-03-18 00:00:43 -0500231 IH_TYPE_SUNXI_TOC0, /* Allwinner TOC0 Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000232
Simon Glass3c536ed2016-06-30 10:52:13 -0600233 IH_TYPE_COUNT, /* Number of image types */
234};
Simon Glass434a31b2015-06-23 15:38:25 -0600235
wdenk5b1d7132002-11-03 00:07:02 +0000236/*
237 * Compression Types
Masahiro Yamada166829f2016-07-21 15:16:00 +0900238 *
239 * The following are exposed to uImage header.
Stefano Babic10d7c4b2018-12-17 11:02:00 +0100240 * New IDs *MUST* be appended at the end of the list and *NEVER*
241 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000242 */
Simon Glass3c536ed2016-06-30 10:52:13 -0600243enum {
244 IH_COMP_NONE = 0, /* No Compression Used */
245 IH_COMP_GZIP, /* gzip Compression Used */
246 IH_COMP_BZIP2, /* bzip2 Compression Used */
247 IH_COMP_LZMA, /* lzma Compression Used */
248 IH_COMP_LZO, /* lzo Compression Used */
249 IH_COMP_LZ4, /* lz4 Compression Used */
Robert Markod1c24842020-04-25 19:37:21 +0200250 IH_COMP_ZSTD, /* zstd Compression Used */
Simon Glass3c536ed2016-06-30 10:52:13 -0600251
252 IH_COMP_COUNT,
253};
wdenk5b1d7132002-11-03 00:07:02 +0000254
Eugeniu Rosca1403f392019-04-08 17:35:27 +0200255#define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
wdenk5b1d7132002-11-03 00:07:02 +0000256#define IH_MAGIC 0x27051956 /* Image Magic Number */
257#define IH_NMLEN 32 /* Image Name Length */
258
Fabio Estevam5fd7c5d2013-01-03 08:24:33 +0000259/* Reused from common.h */
260#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
261
wdenk5b1d7132002-11-03 00:07:02 +0000262/*
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100263 * Legacy format image header,
264 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000265 */
wdenk5b1d7132002-11-03 00:07:02 +0000266typedef struct image_header {
Bin Mengf0b8eb12019-10-27 05:19:40 -0700267 uint32_t ih_magic; /* Image Header Magic Number */
268 uint32_t ih_hcrc; /* Image Header CRC Checksum */
269 uint32_t ih_time; /* Image Creation Timestamp */
270 uint32_t ih_size; /* Image Data Size */
271 uint32_t ih_load; /* Data Load Address */
272 uint32_t ih_ep; /* Entry Point Address */
273 uint32_t ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000274 uint8_t ih_os; /* Operating System */
275 uint8_t ih_arch; /* CPU architecture */
276 uint8_t ih_type; /* Image Type */
277 uint8_t ih_comp; /* Compression Type */
278 uint8_t ih_name[IH_NMLEN]; /* Image Name */
279} image_header_t;
280
Kumar Galabd70bbe2008-08-15 08:24:41 -0500281typedef struct image_info {
282 ulong start, end; /* start/end of blob */
283 ulong image_start, image_len; /* start of image within blob, len of image */
284 ulong load; /* load addr for the image */
285 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass0129b522014-10-19 21:11:24 -0600286 uint8_t arch; /* CPU architecture */
Kumar Galabd70bbe2008-08-15 08:24:41 -0500287} image_info_t;
288
Marian Balakowicz20c43722008-01-08 18:11:44 +0100289/*
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100290 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
291 * routines.
292 */
293typedef struct bootm_headers {
294 /*
295 * Legacy os image header, if it is a multi component image
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100296 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100297 * data from second and third component accordingly.
298 */
Marian Balakowiczab00e022008-04-11 11:07:49 +0200299 image_header_t *legacy_hdr_os; /* image header pointer */
300 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100301 ulong legacy_hdr_valid;
302
Simon Glass0f781382021-09-25 19:43:35 -0600303 /*
304 * The fit_ members are only used with FIT, but it involves a lot of
305 * #ifdefs to avoid compiling that code. Since FIT is the standard
306 * format, even for SPL, this extra data size seems worth it.
307 */
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +0100308 const char *fit_uname_cfg; /* configuration node unit name */
309
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100310 void *fit_hdr_os; /* os FIT image header */
Marian Balakowicz6a2b2c22008-03-10 17:53:49 +0100311 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100312 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100313
314 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100315 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
316 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100317
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100318 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz61c1ad52008-03-12 10:32:59 +0100319 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
320 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass0129b522014-10-19 21:11:24 -0600321
322 void *fit_hdr_setup; /* x86 setup FIT image header */
323 const char *fit_uname_setup; /* x86 setup subimage node name */
324 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczaa6aae42008-03-12 10:35:52 +0100325
Kumar Gala18178bc2008-10-21 17:25:45 -0500326#ifndef USE_HOSTCC
Kumar Galabd70bbe2008-08-15 08:24:41 -0500327 image_info_t os; /* os image info */
Kumar Gala93467bc2008-08-15 08:24:36 -0500328 ulong ep; /* entry point of OS */
329
Kumar Galafffb1432008-08-15 08:24:37 -0500330 ulong rd_start, rd_end;/* ramdisk start/end */
331
Kumar Galaa5130ad2008-08-15 08:24:38 -0500332 char *ft_addr; /* flat dev tree address */
Kumar Galaa5130ad2008-08-15 08:24:38 -0500333 ulong ft_len; /* length of flat device tree */
334
Kumar Gala18178bc2008-10-21 17:25:45 -0500335 ulong initrd_start;
336 ulong initrd_end;
337 ulong cmdline_start;
338 ulong cmdline_end;
Masahiro Yamadaf7ed78b2020-06-26 15:13:33 +0900339 struct bd_info *kbd;
Kumar Gala18178bc2008-10-21 17:25:45 -0500340#endif
341
Simon Glass64b723f2017-08-03 12:22:12 -0600342 int verify; /* env_get("verify")[0] != 'n' */
Kumar Gala18178bc2008-10-21 17:25:45 -0500343
344#define BOOTM_STATE_START (0x00000001)
Simon Glass3081e2e2013-06-11 11:14:47 -0700345#define BOOTM_STATE_FINDOS (0x00000002)
346#define BOOTM_STATE_FINDOTHER (0x00000004)
347#define BOOTM_STATE_LOADOS (0x00000008)
348#define BOOTM_STATE_RAMDISK (0x00000010)
349#define BOOTM_STATE_FDT (0x00000020)
350#define BOOTM_STATE_OS_CMDLINE (0x00000040)
351#define BOOTM_STATE_OS_BD_T (0x00000080)
352#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glass00134882013-06-11 11:14:48 -0700353#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
354#define BOOTM_STATE_OS_GO (0x00000400)
Philippe Reynesae1f2ca2022-03-28 22:57:00 +0200355#define BOOTM_STATE_PRE_LOAD 0x00000800
Kumar Gala18178bc2008-10-21 17:25:45 -0500356 int state;
357
Patrick Delaunayd62063d2021-03-10 10:16:25 +0100358#if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
Kumar Galada6d11e2008-08-15 08:24:40 -0500359 struct lmb lmb; /* for memory mgmt */
360#endif
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100361} bootm_headers_t;
362
Simon Glass7ae16bb2022-08-28 12:32:53 -0600363#ifdef CONFIG_LMB
364#define images_lmb(_images) (&(_images)->lmb)
365#else
366#define images_lmb(_images) NULL
367#endif
368
Simon Schwarzaf775a02012-03-15 04:01:34 +0000369extern bootm_headers_t images;
370
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100371/*
Marian Balakowicz20c43722008-01-08 18:11:44 +0100372 * Some systems (for example LWMON) have very short watchdog periods;
373 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200374 * checksum calculations into reasonable chunks.
Marian Balakowicz20c43722008-01-08 18:11:44 +0100375 */
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200376#ifndef CHUNKSZ
Marian Balakowicz20c43722008-01-08 18:11:44 +0100377#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka222e2ca2008-04-25 13:54:02 +0200378#endif
379
380#ifndef CHUNKSZ_CRC32
381#define CHUNKSZ_CRC32 (64 * 1024)
382#endif
383
384#ifndef CHUNKSZ_MD5
385#define CHUNKSZ_MD5 (64 * 1024)
386#endif
387
388#ifndef CHUNKSZ_SHA1
389#define CHUNKSZ_SHA1 (64 * 1024)
390#endif
Marian Balakowicz20c43722008-01-08 18:11:44 +0100391
Mike Frysinger4ad8e9f2009-07-02 19:23:25 -0400392#define uimage_to_cpu(x) be32_to_cpu(x)
393#define cpu_to_uimage(x) cpu_to_be32(x)
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100394
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530395/*
396 * Translation table for entries of a specific type; used by
397 * get_table_entry_id() and get_table_entry_name().
398 */
399typedef struct table_entry {
400 int id;
401 char *sname; /* short (input) name to find table entry */
402 char *lname; /* long (output) name to print for messages */
403} table_entry_t;
404
405/*
Atish Patra04e8cd82020-03-05 16:24:22 -0800406 * Compression type and magic number mapping table.
407 */
408struct comp_magic_map {
409 int comp_id;
410 const char *name;
411 unsigned char magic[2];
412};
413
414/*
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530415 * get_table_entry_id() scans the translation table trying to find an
416 * entry that matches the given short name. If a matching entry is
417 * found, it's id is returned to the caller.
418 */
Mike Frysingercf2feb12010-10-20 07:17:39 -0400419int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530420 const char *table_name, const char *name);
421/*
422 * get_table_entry_name() scans the translation table trying to find
423 * an entry that matches the given id. If a matching entry is found,
424 * its long name is returned to the caller.
425 */
Mike Frysingercf2feb12010-10-20 07:17:39 -0400426char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskar4454c9e2009-09-07 14:59:08 +0530427
Stephen Warren6904b6e2011-10-18 11:11:49 +0000428const char *genimg_get_os_name(uint8_t os);
Simon Glass86c362d2016-02-22 22:55:50 -0700429
430/**
431 * genimg_get_os_short_name() - get the short name for an OS
432 *
433 * @param os OS (IH_OS_...)
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100434 * Return: OS short name, or "unknown" if unknown
Simon Glass86c362d2016-02-22 22:55:50 -0700435 */
436const char *genimg_get_os_short_name(uint8_t comp);
437
Stephen Warren6904b6e2011-10-18 11:11:49 +0000438const char *genimg_get_arch_name(uint8_t arch);
Simon Glass86c362d2016-02-22 22:55:50 -0700439
440/**
441 * genimg_get_arch_short_name() - get the short name for an architecture
442 *
443 * @param arch Architecture type (IH_ARCH_...)
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100444 * Return: architecture short name, or "unknown" if unknown
Simon Glass86c362d2016-02-22 22:55:50 -0700445 */
446const char *genimg_get_arch_short_name(uint8_t arch);
447
Stephen Warren6904b6e2011-10-18 11:11:49 +0000448const char *genimg_get_type_name(uint8_t type);
Simon Glass434a31b2015-06-23 15:38:25 -0600449
450/**
451 * genimg_get_type_short_name() - get the short name for an image type
452 *
453 * @param type Image type (IH_TYPE_...)
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100454 * Return: image short name, or "unknown" if unknown
Simon Glass434a31b2015-06-23 15:38:25 -0600455 */
456const char *genimg_get_type_short_name(uint8_t type);
457
Stephen Warren6904b6e2011-10-18 11:11:49 +0000458const char *genimg_get_comp_name(uint8_t comp);
Simon Glass86c362d2016-02-22 22:55:50 -0700459
460/**
461 * genimg_get_comp_short_name() - get the short name for a compression method
462 *
463 * @param comp compression method (IH_COMP_...)
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100464 * Return: compression method short name, or "unknown" if unknown
Simon Glass86c362d2016-02-22 22:55:50 -0700465 */
466const char *genimg_get_comp_short_name(uint8_t comp);
467
Simon Glass19864332016-06-30 10:52:16 -0600468/**
469 * genimg_get_cat_name() - Get the name of an item in a category
470 *
471 * @category: Category of item
472 * @id: Item ID
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100473 * Return: name of item, or "Unknown ..." if unknown
Simon Glass19864332016-06-30 10:52:16 -0600474 */
475const char *genimg_get_cat_name(enum ih_category category, uint id);
476
477/**
478 * genimg_get_cat_short_name() - Get the short name of an item in a category
479 *
480 * @category: Category of item
481 * @id: Item ID
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100482 * Return: short name of item, or "Unknown ..." if unknown
Simon Glass19864332016-06-30 10:52:16 -0600483 */
484const char *genimg_get_cat_short_name(enum ih_category category, uint id);
485
486/**
487 * genimg_get_cat_count() - Get the number of items in a category
488 *
489 * @category: Category to check
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100490 * Return: the number of items in the category (IH_xxx_COUNT)
Simon Glass19864332016-06-30 10:52:16 -0600491 */
492int genimg_get_cat_count(enum ih_category category);
493
494/**
495 * genimg_get_cat_desc() - Get the description of a category
496 *
Naoki Hayama9f1622f2020-10-07 11:22:24 +0900497 * @category: Category to check
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100498 * Return: the description of a category, e.g. "architecture". This
Simon Glass19864332016-06-30 10:52:16 -0600499 * effectively converts the enum to a string.
500 */
501const char *genimg_get_cat_desc(enum ih_category category);
502
Naoki Hayamad7e82912020-10-07 11:21:25 +0900503/**
504 * genimg_cat_has_id() - Check whether a category has an item
505 *
506 * @category: Category to check
507 * @id: Item ID
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100508 * Return: true or false as to whether a category has an item
Naoki Hayamad7e82912020-10-07 11:21:25 +0900509 */
510bool genimg_cat_has_id(enum ih_category category, uint id);
511
Stephen Warren6904b6e2011-10-18 11:11:49 +0000512int genimg_get_os_id(const char *name);
513int genimg_get_arch_id(const char *name);
514int genimg_get_type_id(const char *name);
515int genimg_get_comp_id(const char *name);
516void genimg_print_size(uint32_t size);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100517
Simon Glass2c6a1b02021-09-25 19:43:33 -0600518#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC)
Simon Glassaf0ec0d2013-05-07 06:11:51 +0000519#define IMAGE_ENABLE_TIMESTAMP 1
520#else
521#define IMAGE_ENABLE_TIMESTAMP 0
522#endif
523void genimg_print_time(time_t timestamp);
524
Simon Glass384d86d2013-05-16 13:53:21 +0000525/* What to do with a image load address ('load = <> 'in the FIT) */
526enum fit_load_op {
527 FIT_LOAD_IGNORED, /* Ignore load address */
528 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glass05a9ad72014-08-22 14:26:43 -0600529 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass384d86d2013-05-16 13:53:21 +0000530 FIT_LOAD_REQUIRED, /* Must be provided */
531};
532
Simon Glass0129b522014-10-19 21:11:24 -0600533int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
534 ulong *setup_len);
535
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100536/* Image format types, returned by _get_format() routine */
537#define IMAGE_FORMAT_INVALID 0x00
538#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
539#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior686d6672014-05-05 15:08:09 -0500540#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100541
Bryan Wuf5c377a2014-08-15 16:51:38 -0700542ulong genimg_get_kernel_addr_fit(char * const img_addr,
543 const char **fit_uname_config,
544 const char **fit_uname_kernel);
Bryan Wuaf7b0de2014-07-31 17:39:58 -0700545ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass49648062013-05-07 06:12:03 +0000546int genimg_get_format(const void *img_addr);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000547int genimg_has_config(bootm_headers_t *images);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100548
Simon Glassed38aef2020-05-10 11:40:03 -0600549int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
550 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
551int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
552 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite1b21c282015-05-21 09:52:48 -0400553
554/**
555 * boot_get_loadable - routine to load a list of binaries to memory
556 * @argc: Ignored Argument
557 * @argv: Ignored Argument
558 * @images: pointer to the bootm images structure
559 * @arch: expected architecture for the image
560 * @ld_start: Ignored Argument
561 * @ld_len: Ignored Argument
562 *
563 * boot_get_loadable() will take the given FIT configuration, and look
564 * for a field named "loadables". Loadables, is a list of elements in
565 * the FIT given as strings. exe:
Andre Przywara3234ecd2017-12-04 02:05:10 +0000566 * loadables = "linux_kernel", "fdt-2";
Karl Apsite1b21c282015-05-21 09:52:48 -0400567 * this function will attempt to parse each string, and load the
568 * corresponding element from the FIT into memory. Once placed,
569 * no aditional actions are taken.
570 *
571 * @return:
572 * 0, if only valid images or no images are found
573 * error code, if an error occurs during fit_image_load
574 */
Simon Glassed38aef2020-05-10 11:40:03 -0600575int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
576 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100577
Simon Glass0129b522014-10-19 21:11:24 -0600578int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
579 ulong *setup_start, ulong *setup_len);
580
Simon Glass384d86d2013-05-16 13:53:21 +0000581/**
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300582 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
583 *
584 * This deals with all aspects of loading an DTB from a FIT.
585 * The correct base image based on configuration will be selected, and
586 * then any overlays specified will be applied (as present in fit_uname_configp).
587 *
588 * @param images Boot images structure
589 * @param addr Address of FIT in memory
590 * @param fit_unamep On entry this is the requested image name
Andre Przywara3234ecd2017-12-04 02:05:10 +0000591 * (e.g. "kernel") or NULL to use the default. On exit
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300592 * points to the selected image name
593 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywara3234ecd2017-12-04 02:05:10 +0000594 * name (e.g. "conf-1") or NULL to use the default. On
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300595 * exit points to the selected configuration name.
596 * @param arch Expected architecture (IH_ARCH_...)
597 * @param datap Returns address of loaded image
598 * @param lenp Returns length of loaded image
599 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100600 * Return: node offset of base image, or -ve error code on error
Pantelis Antoniou6e51fb22017-09-04 23:12:16 +0300601 */
602int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
603 const char **fit_unamep, const char **fit_uname_configp,
604 int arch, ulong *datap, ulong *lenp);
605
606/**
Simon Glass384d86d2013-05-16 13:53:21 +0000607 * fit_image_load() - load an image from a FIT
608 *
609 * This deals with all aspects of loading an image from a FIT, including
610 * selecting the right image based on configuration, verifying it, printing
611 * out progress messages, checking the type/arch/os and optionally copying it
612 * to the right load address.
613 *
Simon Glassa0c0b632014-06-12 07:24:47 -0600614 * The property to look up is defined by image_type.
615 *
Simon Glass384d86d2013-05-16 13:53:21 +0000616 * @param images Boot images structure
Simon Glass384d86d2013-05-16 13:53:21 +0000617 * @param addr Address of FIT in memory
618 * @param fit_unamep On entry this is the requested image name
Andre Przywara3234ecd2017-12-04 02:05:10 +0000619 * (e.g. "kernel") or NULL to use the default. On exit
Simon Glass384d86d2013-05-16 13:53:21 +0000620 * points to the selected image name
Simon Glassad68fc32013-07-10 23:08:10 -0700621 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywara3234ecd2017-12-04 02:05:10 +0000622 * name (e.g. "conf-1") or NULL to use the default. On
Simon Glassad68fc32013-07-10 23:08:10 -0700623 * exit points to the selected configuration name.
Simon Glass384d86d2013-05-16 13:53:21 +0000624 * @param arch Expected architecture (IH_ARCH_...)
625 * @param image_type Required image type (IH_TYPE_...). If this is
626 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
627 * also.
628 * @param bootstage_id ID of starting bootstage to use for progress updates.
629 * This will be added to the BOOTSTAGE_SUB values when
630 * calling bootstage_mark()
631 * @param load_op Decribes what to do with the load address
632 * @param datap Returns address of loaded image
633 * @param lenp Returns length of loaded image
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100634 * Return: node offset of image, or -ve error code on error
Simon Glass384d86d2013-05-16 13:53:21 +0000635 */
Simon Glassa0c0b632014-06-12 07:24:47 -0600636int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassad68fc32013-07-10 23:08:10 -0700637 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass384d86d2013-05-16 13:53:21 +0000638 int arch, int image_type, int bootstage_id,
639 enum fit_load_op load_op, ulong *datap, ulong *lenp);
640
Simon Glass606f09b2019-12-28 10:45:04 -0700641/**
642 * image_source_script() - Execute a script
643 *
644 * Executes a U-Boot script at a particular address in memory. The script should
645 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
646 *
647 * @addr: Address of script
648 * @fit_uname: FIT subimage name
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100649 * Return: result code (enum command_ret_t)
Simon Glass606f09b2019-12-28 10:45:04 -0700650 */
651int image_source_script(ulong addr, const char *fit_uname);
652
Simon Glass384d86d2013-05-16 13:53:21 +0000653/**
654 * fit_get_node_from_config() - Look up an image a FIT by type
655 *
Andre Przywara3234ecd2017-12-04 02:05:10 +0000656 * This looks in the selected conf- node (images->fit_uname_cfg) for a
Simon Glass384d86d2013-05-16 13:53:21 +0000657 * particular image type (e.g. "kernel") and then finds the image that is
658 * referred to.
659 *
660 * For example, for something like:
661 *
662 * images {
Andre Przywara3234ecd2017-12-04 02:05:10 +0000663 * kernel {
Simon Glass384d86d2013-05-16 13:53:21 +0000664 * ...
665 * };
666 * };
667 * configurations {
Andre Przywara3234ecd2017-12-04 02:05:10 +0000668 * conf-1 {
669 * kernel = "kernel";
Simon Glass384d86d2013-05-16 13:53:21 +0000670 * };
671 * };
672 *
673 * the function will return the node offset of the kernel@1 node, assuming
Andre Przywara3234ecd2017-12-04 02:05:10 +0000674 * that conf-1 is the chosen configuration.
Simon Glass384d86d2013-05-16 13:53:21 +0000675 *
676 * @param images Boot images structure
677 * @param prop_name Property name to look up (FIT_..._PROP)
678 * @param addr Address of FIT in memory
679 */
680int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
681 ulong addr);
682
Simon Glassed38aef2020-05-10 11:40:03 -0600683int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
Simon Glassb1b79922013-05-16 13:53:23 +0000684 bootm_headers_t *images,
685 char **of_flat_tree, ulong *of_size);
Grant Likely20f54922011-03-28 09:59:01 +0000686void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000687int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Galaa5130ad2008-08-15 08:24:38 -0500688
Stephen Warren6904b6e2011-10-18 11:11:49 +0000689int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100690 ulong *initrd_start, ulong *initrd_end);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000691int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
Masahiro Yamadaf7ed78b2020-06-26 15:13:33 +0900692int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100693
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100694/*******************************************************************/
695/* Legacy format specific code (prefixed with image_) */
696/*******************************************************************/
Stephen Warren6904b6e2011-10-18 11:11:49 +0000697static inline uint32_t image_get_header_size(void)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100698{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000699 return (sizeof(image_header_t));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100700}
701
702#define image_get_hdr_l(f) \
Wolfgang Denk3b506772009-08-19 11:42:56 +0200703 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100704 { \
Stephen Warren6904b6e2011-10-18 11:11:49 +0000705 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100706 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000707image_get_hdr_l(magic) /* image_get_magic */
708image_get_hdr_l(hcrc) /* image_get_hcrc */
709image_get_hdr_l(time) /* image_get_time */
710image_get_hdr_l(size) /* image_get_size */
711image_get_hdr_l(load) /* image_get_load */
712image_get_hdr_l(ep) /* image_get_ep */
713image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100714
715#define image_get_hdr_b(f) \
Wolfgang Denk3b506772009-08-19 11:42:56 +0200716 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100717 { \
718 return hdr->ih_##f; \
719 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000720image_get_hdr_b(os) /* image_get_os */
721image_get_hdr_b(arch) /* image_get_arch */
722image_get_hdr_b(type) /* image_get_type */
723image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100724
Stephen Warren6904b6e2011-10-18 11:11:49 +0000725static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100726{
727 return (char *)hdr->ih_name;
728}
729
Stephen Warren6904b6e2011-10-18 11:11:49 +0000730static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100731{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000732 return image_get_size(hdr);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100733}
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100734
735/**
736 * image_get_data - get image payload start address
737 * @hdr: image header
738 *
739 * image_get_data() returns address of the image payload. For single
740 * component images it is image data start. For multi component
741 * images it points to the null terminated table of sub-images sizes.
742 *
743 * returns:
744 * image payload data start address
745 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000746static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100747{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000748 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100749}
750
Stephen Warren6904b6e2011-10-18 11:11:49 +0000751static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100752{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000753 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100754}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000755static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100756{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000757 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100758}
759
760#define image_set_hdr_l(f) \
761 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
762 { \
Stephen Warren6904b6e2011-10-18 11:11:49 +0000763 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100764 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000765image_set_hdr_l(magic) /* image_set_magic */
766image_set_hdr_l(hcrc) /* image_set_hcrc */
767image_set_hdr_l(time) /* image_set_time */
768image_set_hdr_l(size) /* image_set_size */
769image_set_hdr_l(load) /* image_set_load */
770image_set_hdr_l(ep) /* image_set_ep */
771image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100772
773#define image_set_hdr_b(f) \
774 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
775 { \
776 hdr->ih_##f = val; \
777 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000778image_set_hdr_b(os) /* image_set_os */
779image_set_hdr_b(arch) /* image_set_arch */
780image_set_hdr_b(type) /* image_set_type */
781image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100782
Stephen Warren6904b6e2011-10-18 11:11:49 +0000783static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100784{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000785 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100786}
787
Stephen Warren6904b6e2011-10-18 11:11:49 +0000788int image_check_hcrc(const image_header_t *hdr);
789int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100790#ifndef USE_HOSTCC
Simon Glassda1a1342017-08-03 12:22:15 -0600791ulong env_get_bootm_low(void);
792phys_size_t env_get_bootm_size(void);
793phys_size_t env_get_bootm_mapsize(void);
Marian Balakowiczf9a67bd2008-01-08 18:11:45 +0100794#endif
Simon Glassa51991d2014-06-12 07:24:53 -0600795void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100796
Stephen Warren6904b6e2011-10-18 11:11:49 +0000797static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100798{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000799 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100800}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000801static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100802{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000803 return (image_get_type(hdr) == type);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100804}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000805static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100806{
Simon Glass062e79f2021-03-15 18:11:12 +1300807 /* Let's assume that sandbox can load any architecture */
Simon Glass2c6a1b02021-09-25 19:43:33 -0600808 if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX))
Simon Glass062e79f2021-03-15 18:11:12 +1300809 return true;
Alison Wang42664e02017-06-06 15:32:40 +0800810 return (image_get_arch(hdr) == arch) ||
811 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100812}
Stephen Warren6904b6e2011-10-18 11:11:49 +0000813static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100814{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000815 return (image_get_os(hdr) == os);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100816}
817
Stephen Warren6904b6e2011-10-18 11:11:49 +0000818ulong image_multi_count(const image_header_t *hdr);
819void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100820 ulong *data, ulong *len);
821
Stephen Warren6904b6e2011-10-18 11:11:49 +0000822void image_print_contents(const void *hdr);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100823
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100824#ifndef USE_HOSTCC
Stephen Warren6904b6e2011-10-18 11:11:49 +0000825static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100826{
Mike Frysinger5da0bed2011-10-03 14:50:33 +0000827#ifndef IH_ARCH_DEFAULT
828# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100829#endif
Mike Frysinger5da0bed2011-10-03 14:50:33 +0000830 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100831}
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100832#endif /* USE_HOSTCC */
wdenk5b1d7132002-11-03 00:07:02 +0000833
Simon Glass9ca37422013-05-08 08:06:01 +0000834/**
Atish Patra04e8cd82020-03-05 16:24:22 -0800835 * image_decomp_type() - Find out compression type of an image
836 *
837 * @buf: Address in U-Boot memory where image is loaded.
838 * @len: Length of the compressed image.
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100839 * Return: compression type or IH_COMP_NONE if not compressed.
Atish Patra04e8cd82020-03-05 16:24:22 -0800840 *
841 * Note: Only following compression types are supported now.
842 * lzo, lzma, gzip, bzip2
843 */
844int image_decomp_type(const unsigned char *buf, ulong len);
845
846/**
Julius Werner47ef9862019-07-24 19:37:54 -0700847 * image_decomp() - decompress an image
848 *
849 * @comp: Compression algorithm that is used (IH_COMP_...)
850 * @load: Destination load address in U-Boot memory
851 * @image_start Image start address (where we are decompressing from)
852 * @type: OS type (IH_OS_...)
853 * @load_bug: Place to decompress to
854 * @image_buf: Address to decompress from
855 * @image_len: Number of bytes in @image_buf to decompress
856 * @unc_len: Available space for decompression
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100857 * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
Julius Werner47ef9862019-07-24 19:37:54 -0700858 */
859int image_decomp(int comp, ulong load, ulong image_start, int type,
860 void *load_buf, void *image_buf, ulong image_len,
861 uint unc_len, ulong *load_end);
862
863/**
Simon Glass9ca37422013-05-08 08:06:01 +0000864 * Set up properties in the FDT
865 *
866 * This sets up properties in the FDT that is to be passed to linux.
867 *
868 * @images: Images information
869 * @blob: FDT to update
870 * @of_size: Size of the FDT
871 * @lmb: Points to logical memory block structure
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100872 * Return: 0 if ok, <0 on failure
Simon Glass9ca37422013-05-08 08:06:01 +0000873 */
874int image_setup_libfdt(bootm_headers_t *images, void *blob,
875 int of_size, struct lmb *lmb);
876
877/**
878 * Set up the FDT to use for booting a kernel
879 *
880 * This performs ramdisk setup, sets up the FDT if required, and adds
881 * paramters to the FDT if libfdt is available.
882 *
883 * @param images Images information
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100884 * Return: 0 if ok, <0 on failure
Simon Glass9ca37422013-05-08 08:06:01 +0000885 */
886int image_setup_linux(bootm_headers_t *images);
887
Simon Glass5f1afdd2013-07-04 13:26:10 -0700888/**
889 * bootz_setup() - Extract stat and size of a Linux xImage
890 *
891 * @image: Address of image
892 * @start: Returns start address of image
893 * @end : Returns end address of image
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100894 * Return: 0 if OK, 1 if the image was not recognised
Simon Glass5f1afdd2013-07-04 13:26:10 -0700895 */
896int bootz_setup(ulong image, ulong *start, ulong *end);
897
Bin Chendac184b2018-01-27 16:59:09 +1100898/**
899 * Return the correct start address and size of a Linux aarch64 Image.
900 *
901 * @image: Address of image
902 * @start: Returns start address of image
903 * @size : Returns size image
Marek Vasut85ed2892018-06-13 06:13:32 +0200904 * @force_reloc: Ignore image->ep field, always place image to RAM start
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100905 * Return: 0 if OK, 1 if the image was not recognised
Bin Chendac184b2018-01-27 16:59:09 +1100906 */
Marek Vasut85ed2892018-06-13 06:13:32 +0200907int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
908 bool force_reloc);
Simon Glass5f1afdd2013-07-04 13:26:10 -0700909
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100910/*******************************************************************/
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100911/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100912/*******************************************************************/
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100913
914#define FIT_IMAGES_PATH "/images"
915#define FIT_CONFS_PATH "/configurations"
916
Simon Glassd7aabcc2020-03-18 11:44:06 -0600917/* hash/signature/key node */
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100918#define FIT_HASH_NODENAME "hash"
919#define FIT_ALGO_PROP "algo"
920#define FIT_VALUE_PROP "value"
Joe Hershberger8b7d32a2012-08-17 10:34:39 +0000921#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass58fe7e52013-06-13 15:10:00 -0700922#define FIT_SIG_NODENAME "signature"
Simon Glassd7aabcc2020-03-18 11:44:06 -0600923#define FIT_KEY_REQUIRED "required"
924#define FIT_KEY_HINT "key-name-hint"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100925
Philippe Reynes3148e422019-12-18 18:25:41 +0100926/* cipher node */
927#define FIT_CIPHER_NODENAME "cipher"
928#define FIT_ALGO_PROP "algo"
929
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100930/* image node */
931#define FIT_DATA_PROP "data"
Peng Fan8876c7e2017-12-05 13:20:59 +0800932#define FIT_DATA_POSITION_PROP "data-position"
tomas.melin@vaisala.com45ee7902017-01-13 13:20:14 +0200933#define FIT_DATA_OFFSET_PROP "data-offset"
934#define FIT_DATA_SIZE_PROP "data-size"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100935#define FIT_TIMESTAMP_PROP "timestamp"
936#define FIT_DESC_PROP "description"
937#define FIT_ARCH_PROP "arch"
938#define FIT_TYPE_PROP "type"
939#define FIT_OS_PROP "os"
940#define FIT_COMP_PROP "compression"
941#define FIT_ENTRY_PROP "entry"
942#define FIT_LOAD_PROP "load"
943
944/* configuration node */
945#define FIT_KERNEL_PROP "kernel"
946#define FIT_RAMDISK_PROP "ramdisk"
947#define FIT_FDT_PROP "fdt"
Karl Apsite8f0537d2015-05-21 09:52:47 -0400948#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100949#define FIT_DEFAULT_PROP "default"
Simon Glass0129b522014-10-19 21:11:24 -0600950#define FIT_SETUP_PROP "setup"
Michal Simek0a130b12016-05-17 13:58:44 +0200951#define FIT_FPGA_PROP "fpga"
Michal Simekb766e8f2018-03-26 16:31:26 +0200952#define FIT_FIRMWARE_PROP "firmware"
Marek Vasut93e95752018-05-13 00:22:54 +0200953#define FIT_STANDALONE_PROP "standalone"
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100954
Michael van der Westhuizene36c6c32014-05-30 20:59:00 +0200955#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100956
957/* cmdline argument format parsing */
Mike Frysinger711453d2012-04-22 06:59:06 +0000958int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowicz3413e222008-02-21 17:20:20 +0100959 ulong *addr, const char **conf_name);
Mike Frysinger711453d2012-04-22 06:59:06 +0000960int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowicz3413e222008-02-21 17:20:20 +0100961 ulong *addr, const char **image_name);
Marian Balakowiczdbdd16a2008-02-04 08:28:09 +0100962
Guilherme Maciel Ferreira3c46bcd2015-01-15 02:54:42 -0200963int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren6904b6e2011-10-18 11:11:49 +0000964void fit_print_contents(const void *fit);
965void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100966
967/**
968 * fit_get_end - get FIT image size
969 * @fit: pointer to the FIT format image header
970 *
971 * returns:
972 * size of the FIT image (blob) in memory
973 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000974static inline ulong fit_get_size(const void *fit)
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100975{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000976 return fdt_totalsize(fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100977}
978
979/**
980 * fit_get_end - get FIT image end
981 * @fit: pointer to the FIT format image header
982 *
983 * returns:
984 * end address of the FIT image (blob) in memory
985 */
Simon Glass5b539a02016-02-24 09:14:42 -0700986ulong fit_get_end(const void *fit);
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100987
988/**
989 * fit_get_name - get FIT node name
990 * @fit: pointer to the FIT format image header
991 *
992 * returns:
993 * NULL, on error
994 * pointer to node name, on success
995 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000996static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100997 int noffset, int *len)
998{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000999 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001000}
1001
Stephen Warren6904b6e2011-10-18 11:11:49 +00001002int fit_get_desc(const void *fit, int noffset, char **desc);
1003int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001004
Stephen Warren6904b6e2011-10-18 11:11:49 +00001005int fit_image_get_node(const void *fit, const char *image_uname);
1006int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1007int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1008int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1009int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1010int fit_image_get_load(const void *fit, int noffset, ulong *load);
1011int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1012int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001013 const void **data, size_t *size);
tomas.melin@vaisala.com45ee7902017-01-13 13:20:14 +02001014int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
Peng Fan8876c7e2017-12-05 13:20:59 +08001015int fit_image_get_data_position(const void *fit, int noffset,
1016 int *data_position);
tomas.melin@vaisala.com45ee7902017-01-13 13:20:14 +02001017int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
Philippe Reynes3d964702019-12-18 18:25:42 +01001018int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1019 size_t *data_size);
Kelvin Cheung186cc992018-05-19 18:21:37 +08001020int fit_image_get_data_and_size(const void *fit, int noffset,
1021 const void **data, size_t *size);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001022
Sean Anderson080d3a02022-08-16 11:16:03 -04001023/**
1024 * fit_get_data_node() - Get verified image data for an image
1025 * @fit: Pointer to the FIT format image header
1026 * @image_uname: The name of the image node
1027 * @data: A pointer which will be filled with the location of the image data
1028 * @size: A pointer which will be filled with the size of the image data
1029 *
1030 * This function looks up the location and size of an image specified by its
1031 * name. For example, if you had a FIT like::
1032 *
1033 * images {
1034 * my-firmware {
1035 * ...
1036 * };
1037 * };
1038 *
1039 * Then you could look up the data location and size of the my-firmware image
1040 * by calling this function with @image_uname set to "my-firmware". This
1041 * function also verifies the image data (if enabled) before returning. The
1042 * image description is printed out on success. @data and @size will not be
1043 * modified on faulure.
1044 *
1045 * Return:
1046 * * 0 on success
1047 * * -EINVAL if the image could not be verified
1048 * * -ENOENT if there was a problem getting the data/size
1049 * * Another negative error if there was a problem looking up the image node.
1050 */
1051int fit_get_data_node(const void *fit, const char *image_uname,
1052 const void **data, size_t *size);
1053
1054/**
1055 * fit_get_data_conf_prop() - Get verified image data for a property in /conf
1056 * @fit: Pointer to the FIT format image header
1057 * @prop_name: The name of the property in /conf referencing the image
1058 * @data: A pointer which will be filled with the location of the image data
1059 * @size: A pointer which will be filled with the size of the image data
1060 *
1061 * This function looks up the location and size of an image specified by a
1062 * property in /conf. For example, if you had a FIT like::
1063 *
1064 * images {
1065 * my-firmware {
1066 * ...
1067 * };
1068 * };
1069 *
1070 * configurations {
1071 * default = "conf-1";
1072 * conf-1 {
1073 * some-firmware = "my-firmware";
1074 * };
1075 * };
1076 *
1077 * Then you could look up the data location and size of the my-firmware image
1078 * by calling this function with @prop_name set to "some-firmware". This
1079 * function also verifies the image data (if enabled) before returning. The
1080 * image description is printed out on success. @data and @size will not be
1081 * modified on faulure.
1082 *
1083 * Return:
1084 * * 0 on success
1085 * * -EINVAL if the image could not be verified
1086 * * -ENOENT if there was a problem getting the data/size
1087 * * Another negative error if there was a problem looking up the configuration
1088 * or image node.
1089 */
1090int fit_get_data_conf_prop(const void *fit, const char *prop_name,
1091 const void **data, size_t *size);
1092
Jan Kiszka27beec22022-01-14 10:21:17 +01001093int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo);
Stephen Warren6904b6e2011-10-18 11:11:49 +00001094int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001095 int *value_len);
1096
Stephen Warren6904b6e2011-10-18 11:11:49 +00001097int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassee382652013-05-07 06:12:01 +00001098
Philippe Reynes3e3899c2022-03-28 22:57:02 +02001099/**
1100 * fit_pre_load_data() - add public key to fdt blob
1101 *
1102 * Adds public key to the node pre load.
1103 *
1104 * @keydir: Directory containing keys
1105 * @keydest: FDT blob to write public key
1106 * @fit: Pointer to the FIT format image header
1107 *
1108 * returns:
1109 * 0, on success
1110 * < 0, on failure
1111 */
1112int fit_pre_load_data(const char *keydir, void *keydest, void *fit);
1113
Philippe Reynes3148e422019-12-18 18:25:41 +01001114int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1115 const char *comment, int require_keys,
1116 const char *engine_id, const char *cmdname);
1117
Simon Glasse4607262021-11-12 12:28:13 -07001118#define NODE_MAX_NAME_LEN 80
1119
1120/**
1121 * struct image_summary - Provides information about signing info added
1122 *
1123 * @sig_offset: Offset of the node in the blob devicetree where the signature
1124 * was wriiten
1125 * @sig_path: Path to @sig_offset
1126 * @keydest_offset: Offset of the node in the keydest devicetree where the
1127 * public key was written (-1 if none)
1128 * @keydest_path: Path to @keydest_offset
1129 */
1130struct image_summary {
1131 int sig_offset;
1132 char sig_path[NODE_MAX_NAME_LEN];
1133 int keydest_offset;
1134 char keydest_path[NODE_MAX_NAME_LEN];
1135};
1136
Simon Glassee382652013-05-07 06:12:01 +00001137/**
Simon Glassfbabc0f2013-06-13 15:10:01 -07001138 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassee382652013-05-07 06:12:01 +00001139 *
Simon Glassfbabc0f2013-06-13 15:10:01 -07001140 * @keydir: Directory containing keys
Simon Glass6a0efc82021-11-12 12:28:06 -07001141 * @kwydest: FDT blob to write public key information to (NULL if none)
Simon Glassfbabc0f2013-06-13 15:10:01 -07001142 * @fit: Pointer to the FIT format image header
1143 * @comment: Comment to add to signature nodes
1144 * @require_keys: Mark all keys as 'required'
George McCollister23d14892017-01-06 13:14:17 -06001145 * @engine_id: Engine to use for signing
Alex Kiernan697fcdc2018-06-20 20:10:52 +00001146 * @cmdname: Command name used when reporting errors
Jan Kiszka4043f322022-01-14 10:21:19 +01001147 * @algo_name: Algorithm name, or NULL if to be read from FIT
Simon Glasse4607262021-11-12 12:28:13 -07001148 * @summary: Returns information about what data was written
Simon Glassfbabc0f2013-06-13 15:10:01 -07001149 *
1150 * Adds hash values for all component images in the FIT blob.
1151 * Hashes are calculated for all component images which have hash subnodes
1152 * with algorithm property set to one of the supported hash algorithms.
1153 *
1154 * Also add signatures if signature nodes are present.
1155 *
1156 * returns
1157 * 0, on success
1158 * libfdt error code, on failure
Simon Glassee382652013-05-07 06:12:01 +00001159 */
Alexandru Gagniuc8fcea122021-02-19 12:45:17 -06001160int fit_add_verification_data(const char *keydir, const char *keyfile,
1161 void *keydest, void *fit, const char *comment,
1162 int require_keys, const char *engine_id,
Simon Glasse4607262021-11-12 12:28:13 -07001163 const char *cmdname, const char *algo_name,
1164 struct image_summary *summary);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001165
Simon Glasse10e2ee2021-11-12 12:28:10 -07001166/**
1167 * fit_image_verify_with_data() - Verify an image with given data
1168 *
1169 * @fit: Pointer to the FIT format image header
1170 * @image_offset: Offset in @fit of image to verify
1171 * @key_blob: FDT containing public keys
1172 * @data: Image data to verify
1173 * @size: Size of image data
1174 */
Jun Nieadf5d1c2018-02-27 16:55:58 +08001175int fit_image_verify_with_data(const void *fit, int image_noffset,
Simon Glasse10e2ee2021-11-12 12:28:10 -07001176 const void *key_blob, const void *data,
1177 size_t size);
1178
Simon Glass7428ad12013-05-07 06:11:57 +00001179int fit_image_verify(const void *fit, int noffset);
Simon Glass384d86d2013-05-16 13:53:21 +00001180int fit_config_verify(const void *fit, int conf_noffset);
Simon Glass7428ad12013-05-07 06:11:57 +00001181int fit_all_image_verify(const void *fit);
Philippe Reynes3d964702019-12-18 18:25:42 +01001182int fit_config_decrypt(const void *fit, int conf_noffset);
Stephen Warren6904b6e2011-10-18 11:11:49 +00001183int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1184int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1185int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1186int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
Simon Glassd563c252021-02-15 17:08:09 -07001187
1188/**
1189 * fit_check_format() - Check that the FIT is valid
1190 *
1191 * This performs various checks on the FIT to make sure it is suitable for
1192 * use, looking for mandatory properties, nodes, etc.
1193 *
1194 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1195 * sure that there are no strange tags or broken nodes in the FIT.
1196 *
1197 * @fit: pointer to the FIT format image header
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001198 * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
Simon Glassd563c252021-02-15 17:08:09 -07001199 * failed (e.g. due to bad structure), -ENOMSG if the description is
Simon Glassb641de82021-02-24 08:50:32 -05001200 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
Simon Glassd563c252021-02-15 17:08:09 -07001201 * path is missing
1202 */
1203int fit_check_format(const void *fit, ulong size);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001204
Gabe Blackd572e162012-10-25 16:31:10 +00001205int fit_conf_find_compat(const void *fit, const void *fdt);
Simon Glass2f3c6c52020-03-18 11:43:55 -06001206
1207/**
1208 * fit_conf_get_node - get node offset for configuration of a given unit name
1209 * @fit: pointer to the FIT format image header
1210 * @conf_uname: configuration node unit name (NULL to use default)
1211 *
1212 * fit_conf_get_node() finds a configuration (within the '/configurations'
1213 * parent node) of a provided unit name. If configuration is found its node
1214 * offset is returned to the caller.
1215 *
1216 * When NULL is provided in second argument fit_conf_get_node() will search
1217 * for a default configuration node instead. Default configuration node unit
1218 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1219 * node.
1220 *
1221 * returns:
1222 * configuration node offset when found (>=0)
1223 * negative number on failure (FDT_ERR_* code)
1224 */
Stephen Warren6904b6e2011-10-18 11:11:49 +00001225int fit_conf_get_node(const void *fit, const char *conf_uname);
Simon Glass2f3c6c52020-03-18 11:43:55 -06001226
Tien Fong Cheeca99a8a2019-05-07 17:42:28 +08001227int fit_conf_get_prop_node_count(const void *fit, int noffset,
1228 const char *prop_name);
1229int fit_conf_get_prop_node_index(const void *fit, int noffset,
1230 const char *prop_name, int index);
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001231
Simon Glassdc0f52c2013-05-07 06:12:00 +00001232/**
1233 * fit_conf_get_prop_node() - Get node refered to by a configuration
1234 * @fit: FIT to check
1235 * @noffset: Offset of conf@xxx node to check
1236 * @prop_name: Property to read from the conf node
1237 *
Andre Przywara3234ecd2017-12-04 02:05:10 +00001238 * The conf- nodes contain references to other nodes, using properties
1239 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
Simon Glassdc0f52c2013-05-07 06:12:00 +00001240 * return the offset of the node referred to (e.g. offset of node
Andre Przywara3234ecd2017-12-04 02:05:10 +00001241 * "/images/kernel".
Simon Glassdc0f52c2013-05-07 06:12:00 +00001242 */
1243int fit_conf_get_prop_node(const void *fit, int noffset,
1244 const char *prop_name);
1245
Simon Glass36b916a2013-05-07 06:11:52 +00001246int fit_check_ramdisk(const void *fit, int os_noffset,
1247 uint8_t arch, int verify);
1248
Simon Glass10a1eca2013-05-07 06:11:54 +00001249int calculate_hash(const void *data, int data_len, const char *algo,
1250 uint8_t *value, int *value_len);
1251
Simon Glass384d86d2013-05-16 13:53:21 +00001252/*
Simon Glass58fe7e52013-06-13 15:10:00 -07001253 * At present we only support signing on the host, and verification on the
1254 * device
Simon Glass384d86d2013-05-16 13:53:21 +00001255 */
Alex Kiernanbb6abce2019-04-18 20:34:55 +00001256#if defined(USE_HOSTCC)
1257# if defined(CONFIG_FIT_SIGNATURE)
Simon Glass58fe7e52013-06-13 15:10:00 -07001258# define IMAGE_ENABLE_SIGN 1
AKASHI Takahiro2223c7d2020-02-21 15:12:55 +09001259# define FIT_IMAGE_ENABLE_VERIFY 1
Alex Kiernanbb6abce2019-04-18 20:34:55 +00001260# include <openssl/evp.h>
1261# else
Simon Glass58fe7e52013-06-13 15:10:00 -07001262# define IMAGE_ENABLE_SIGN 0
AKASHI Takahiro2223c7d2020-02-21 15:12:55 +09001263# define FIT_IMAGE_ENABLE_VERIFY 0
Simon Glass384d86d2013-05-16 13:53:21 +00001264# endif
1265#else
Simon Glass58fe7e52013-06-13 15:10:00 -07001266# define IMAGE_ENABLE_SIGN 0
AKASHI Takahiro2223c7d2020-02-21 15:12:55 +09001267# define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
Simon Glass384d86d2013-05-16 13:53:21 +00001268#endif
1269
1270#ifdef USE_HOSTCC
Heiko Schocherd7b42322014-03-03 12:19:30 +01001271void *image_get_host_blob(void);
1272void image_set_host_blob(void *host_blob);
1273# define gd_fdt_blob() image_get_host_blob()
Simon Glass384d86d2013-05-16 13:53:21 +00001274#else
1275# define gd_fdt_blob() (gd->fdt_blob)
1276#endif
1277
Alexandru Gagniuc8fcea122021-02-19 12:45:17 -06001278/*
1279 * Information passed to the signing routines
1280 *
1281 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1282 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1283 * neither are valid, some operations might fail with EINVAL.
1284 */
Simon Glass58fe7e52013-06-13 15:10:00 -07001285struct image_sign_info {
1286 const char *keydir; /* Directory conaining keys */
1287 const char *keyname; /* Name of key to use */
Alexandru Gagniuc8fcea122021-02-19 12:45:17 -06001288 const char *keyfile; /* Filename of private or public key */
Hannu Lounentoe2b1e1f2021-10-18 08:49:03 +03001289 const void *fit; /* Pointer to FIT blob */
Simon Glass58fe7e52013-06-13 15:10:00 -07001290 int node_offset; /* Offset of signature node */
Andrew Duda6616c822016-11-08 18:53:41 +00001291 const char *name; /* Algorithm name */
1292 struct checksum_algo *checksum; /* Checksum algorithm information */
Philippe Reynes12468352018-11-14 13:51:00 +01001293 struct padding_algo *padding; /* Padding algorithm information */
Andrew Duda6616c822016-11-08 18:53:41 +00001294 struct crypto_algo *crypto; /* Crypto algorithm information */
Simon Glass58fe7e52013-06-13 15:10:00 -07001295 const void *fdt_blob; /* FDT containing public keys */
1296 int required_keynode; /* Node offset of key to use: -1=any */
1297 const char *require_keys; /* Value for 'required' property */
George McCollister23d14892017-01-06 13:14:17 -06001298 const char *engine_id; /* Engine to use for signing */
AKASHI Takahiro3eae5fd2020-02-21 15:12:57 +09001299 /*
1300 * Note: the following two fields are always valid even w/o
1301 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1302 * the same on target and host. Otherwise, vboot test may fail.
1303 */
1304 const void *key; /* Pointer to public key in DER */
1305 int keylen; /* Length of public key */
Simon Glass58fe7e52013-06-13 15:10:00 -07001306};
Philippe Reynes3148e422019-12-18 18:25:41 +01001307
Simon Glass58fe7e52013-06-13 15:10:00 -07001308/* A part of an image, used for hashing */
1309struct image_region {
1310 const void *data;
1311 int size;
1312};
1313
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001314struct checksum_algo {
1315 const char *name;
1316 const int checksum_len;
Andrew Duda3db9ff02016-11-08 18:53:40 +00001317 const int der_len;
1318 const uint8_t *der_prefix;
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001319#if IMAGE_ENABLE_SIGN
Heiko Schocherd7b42322014-03-03 12:19:30 +01001320 const EVP_MD *(*calculate_sign)(void);
1321#endif
Ruchika Gupta2c8987f2015-01-23 16:01:59 +05301322 int (*calculate)(const char *name,
Simon Glass2c6a1b02021-09-25 19:43:33 -06001323 const struct image_region *region,
Ruchika Gupta2c8987f2015-01-23 16:01:59 +05301324 int region_count, uint8_t *checksum);
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001325};
1326
Andrew Duda06ca6d62016-11-08 18:53:41 +00001327struct crypto_algo {
Simon Glass58fe7e52013-06-13 15:10:00 -07001328 const char *name; /* Name of algorithm */
Andrew Duda06ca6d62016-11-08 18:53:41 +00001329 const int key_len;
Simon Glass58fe7e52013-06-13 15:10:00 -07001330
1331 /**
1332 * sign() - calculate and return signature for given input data
1333 *
1334 * @info: Specifies key and FIT information
1335 * @data: Pointer to the input data
1336 * @data_len: Data length
1337 * @sigp: Set to an allocated buffer holding the signature
1338 * @sig_len: Set to length of the calculated hash
1339 *
1340 * This computes input data signature according to selected algorithm.
1341 * Resulting signature value is placed in an allocated buffer, the
1342 * pointer is returned as *sigp. The length of the calculated
1343 * signature is returned via the sig_len pointer argument. The caller
1344 * should free *sigp.
1345 *
1346 * @return: 0, on success, -ve on error
1347 */
1348 int (*sign)(struct image_sign_info *info,
1349 const struct image_region region[],
1350 int region_count, uint8_t **sigp, uint *sig_len);
1351
1352 /**
1353 * add_verify_data() - Add verification information to FDT
1354 *
1355 * Add public key information to the FDT node, suitable for
1356 * verification at run-time. The information added depends on the
1357 * algorithm being used.
1358 *
1359 * @info: Specifies key and FIT information
1360 * @keydest: Destination FDT blob for public key data
Simon Glass94336dc2021-11-12 12:28:11 -07001361 * @return: node offset within the FDT blob where the data was written,
1362 * or -ve on error
Simon Glass58fe7e52013-06-13 15:10:00 -07001363 */
1364 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1365
1366 /**
1367 * verify() - Verify a signature against some data
1368 *
1369 * @info: Specifies key and FIT information
1370 * @data: Pointer to the input data
1371 * @data_len: Data length
1372 * @sig: Signature
1373 * @sig_len: Number of bytes in signature
1374 * @return 0 if verified, -ve on error
1375 */
1376 int (*verify)(struct image_sign_info *info,
1377 const struct image_region region[], int region_count,
1378 uint8_t *sig, uint sig_len);
Andrew Duda06ca6d62016-11-08 18:53:41 +00001379};
Heiko Schocheredaf9b12014-03-03 12:19:26 +01001380
Alexandru Gagniucb04e9182021-07-14 17:05:39 -05001381/* Declare a new U-Boot crypto algorithm handler */
1382#define U_BOOT_CRYPTO_ALGO(__name) \
1383ll_entry_declare(struct crypto_algo, __name, cryptos)
1384
Philippe Reynes12468352018-11-14 13:51:00 +01001385struct padding_algo {
1386 const char *name;
1387 int (*verify)(struct image_sign_info *info,
SESA6444251304b462022-03-09 01:27:15 -08001388 const uint8_t *pad, int pad_len,
Philippe Reynes12468352018-11-14 13:51:00 +01001389 const uint8_t *hash, int hash_len);
1390};
1391
Alexandru Gagniucf3b5e582021-08-18 17:49:02 -05001392/* Declare a new U-Boot padding algorithm handler */
1393#define U_BOOT_PADDING_ALGO(__name) \
1394ll_entry_declare(struct padding_algo, __name, paddings)
1395
Andrew Duda6616c822016-11-08 18:53:41 +00001396/**
1397 * image_get_checksum_algo() - Look up a checksum algorithm
1398 *
1399 * @param full_name Name of algorithm in the form "checksum,crypto"
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001400 * Return: pointer to algorithm information, or NULL if not found
Andrew Duda6616c822016-11-08 18:53:41 +00001401 */
1402struct checksum_algo *image_get_checksum_algo(const char *full_name);
Simon Glass58fe7e52013-06-13 15:10:00 -07001403
1404/**
Andrew Duda6616c822016-11-08 18:53:41 +00001405 * image_get_crypto_algo() - Look up a cryptosystem algorithm
Simon Glass58fe7e52013-06-13 15:10:00 -07001406 *
Andrew Duda6616c822016-11-08 18:53:41 +00001407 * @param full_name Name of algorithm in the form "checksum,crypto"
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001408 * Return: pointer to algorithm information, or NULL if not found
Simon Glass58fe7e52013-06-13 15:10:00 -07001409 */
Andrew Duda6616c822016-11-08 18:53:41 +00001410struct crypto_algo *image_get_crypto_algo(const char *full_name);
Simon Glass58fe7e52013-06-13 15:10:00 -07001411
Simon Glassfbabc0f2013-06-13 15:10:01 -07001412/**
Philippe Reynes12468352018-11-14 13:51:00 +01001413 * image_get_padding_algo() - Look up a padding algorithm
1414 *
1415 * @param name Name of padding algorithm
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001416 * Return: pointer to algorithm information, or NULL if not found
Philippe Reynes12468352018-11-14 13:51:00 +01001417 */
1418struct padding_algo *image_get_padding_algo(const char *name);
1419
1420/**
Philippe Reynesd28484e2022-03-28 22:56:59 +02001421 * image_pre_load() - Manage pre load header
1422 *
1423 * Manage the pre-load header before launching the image.
1424 * It checks the signature of the image. It also set the
1425 * variable image_load_offset to skip this header before
1426 * launching the image.
1427 *
1428 * @param addr Address of the image
1429 * @return: 0 on success, -ve on error
1430 */
1431int image_pre_load(ulong addr);
1432
1433/**
Simon Glassfbabc0f2013-06-13 15:10:01 -07001434 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1435 *
1436 * @fit: FIT to check
1437 * @image_noffset: Offset of image node to check
1438 * @data: Image data to check
1439 * @size: Size of image data
Simon Glasse10e2ee2021-11-12 12:28:10 -07001440 * @key_blob: FDT containing public keys
Simon Glassfbabc0f2013-06-13 15:10:01 -07001441 * @no_sigsp: Returns 1 if no signatures were required, and
1442 * therefore nothing was checked. The caller may wish
1443 * to fall back to other mechanisms, or refuse to
1444 * boot.
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001445 * Return: 0 if all verified ok, <0 on error
Simon Glassfbabc0f2013-06-13 15:10:01 -07001446 */
1447int fit_image_verify_required_sigs(const void *fit, int image_noffset,
Simon Glasse10e2ee2021-11-12 12:28:10 -07001448 const char *data, size_t size, const void *key_blob,
Simon Glassfbabc0f2013-06-13 15:10:01 -07001449 int *no_sigsp);
1450
1451/**
1452 * fit_image_check_sig() - Check a single image signature node
1453 *
1454 * @fit: FIT to check
1455 * @noffset: Offset of signature node to check
1456 * @data: Image data to check
1457 * @size: Size of image data
Simon Glasse10e2ee2021-11-12 12:28:10 -07001458 * @keyblob: Key blob to check (typically the control FDT)
1459 * @required_keynode: Offset in the keyblob of the required key node,
Simon Glassfbabc0f2013-06-13 15:10:01 -07001460 * if any. If this is given, then the image wil not
1461 * pass verification unless that key is used. If this is
1462 * -1 then any signature will do.
1463 * @err_msgp: In the event of an error, this will be pointed to a
1464 * help error string to display to the user.
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001465 * Return: 0 if all verified ok, <0 on error
Simon Glassfbabc0f2013-06-13 15:10:01 -07001466 */
1467int fit_image_check_sig(const void *fit, int noffset, const void *data,
Simon Glasse10e2ee2021-11-12 12:28:10 -07001468 size_t size, const void *key_blob, int required_keynode,
1469 char **err_msgp);
Simon Glassfbabc0f2013-06-13 15:10:01 -07001470
Philippe Reynes3d964702019-12-18 18:25:42 +01001471int fit_image_decrypt_data(const void *fit,
1472 int image_noffset, int cipher_noffset,
1473 const void *data, size_t size,
1474 void **data_unciphered, size_t *size_unciphered);
1475
Simon Glass56ab8d62013-06-13 15:10:09 -07001476/**
1477 * fit_region_make_list() - Make a list of regions to hash
1478 *
1479 * Given a list of FIT regions (offset, size) provided by libfdt, create
1480 * a list of regions (void *, size) for use by the signature creationg
1481 * and verification code.
1482 *
1483 * @fit: FIT image to process
1484 * @fdt_regions: Regions as returned by libfdt
1485 * @count: Number of regions returned by libfdt
1486 * @region: Place to put list of regions (NULL to allocate it)
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001487 * Return: pointer to list of regions, or NULL if out of memory
Simon Glass56ab8d62013-06-13 15:10:09 -07001488 */
1489struct image_region *fit_region_make_list(const void *fit,
1490 struct fdt_region *fdt_regions, int count,
1491 struct image_region *region);
Simon Glassfbabc0f2013-06-13 15:10:01 -07001492
Stephen Warren6904b6e2011-10-18 11:11:49 +00001493static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001494{
Heiko Schocherd7b42322014-03-03 12:19:30 +01001495#ifndef USE_HOSTCC
Thierry Reding7d731a92011-10-27 08:58:25 +00001496 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocherd7b42322014-03-03 12:19:30 +01001497#else
1498 return 0;
1499#endif
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001500}
Marian Balakowicze227fbb2008-02-29 21:24:06 +01001501
Philippe Reynes3148e422019-12-18 18:25:41 +01001502/*
1503 * At present we only support ciphering on the host, and unciphering on the
1504 * device
1505 */
1506#if defined(USE_HOSTCC)
1507# if defined(CONFIG_FIT_CIPHER)
1508# define IMAGE_ENABLE_ENCRYPT 1
1509# define IMAGE_ENABLE_DECRYPT 1
1510# include <openssl/evp.h>
1511# else
1512# define IMAGE_ENABLE_ENCRYPT 0
1513# define IMAGE_ENABLE_DECRYPT 0
1514# endif
1515#else
1516# define IMAGE_ENABLE_ENCRYPT 0
1517# define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1518#endif
1519
1520/* Information passed to the ciphering routines */
1521struct image_cipher_info {
1522 const char *keydir; /* Directory containing keys */
1523 const char *keyname; /* Name of key to use */
1524 const char *ivname; /* Name of IV to use */
1525 const void *fit; /* Pointer to FIT blob */
1526 int node_noffset; /* Offset of the cipher node */
1527 const char *name; /* Algorithm name */
1528 struct cipher_algo *cipher; /* Cipher algorithm information */
1529 const void *fdt_blob; /* FDT containing key and IV */
1530 const void *key; /* Value of the key */
1531 const void *iv; /* Value of the IV */
1532 size_t size_unciphered; /* Size of the unciphered data */
1533};
1534
1535struct cipher_algo {
1536 const char *name; /* Name of algorithm */
1537 int key_len; /* Length of the key */
1538 int iv_len; /* Length of the IV */
1539
1540#if IMAGE_ENABLE_ENCRYPT
1541 const EVP_CIPHER * (*calculate_type)(void);
1542#endif
1543
1544 int (*encrypt)(struct image_cipher_info *info,
1545 const unsigned char *data, int data_len,
1546 unsigned char **cipher, int *cipher_len);
1547
1548 int (*add_cipher_data)(struct image_cipher_info *info,
Philippe Reynes64d67c42020-09-17 15:01:46 +02001549 void *keydest, void *fit, int node_noffset);
Philippe Reynes3d964702019-12-18 18:25:42 +01001550
1551 int (*decrypt)(struct image_cipher_info *info,
1552 const void *cipher, size_t cipher_len,
1553 void **data, size_t *data_len);
Philippe Reynes3148e422019-12-18 18:25:41 +01001554};
1555
1556int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1557
1558struct cipher_algo *image_get_cipher_algo(const char *full_name);
1559
Sebastian Siewior686d6672014-05-05 15:08:09 -05001560struct andr_img_hdr;
1561int android_image_check_header(const struct andr_img_hdr *hdr);
1562int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1563 ulong *os_data, ulong *os_len);
1564int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1565 ulong *rd_data, ulong *rd_len);
Bin Chen909f1402018-01-27 16:59:08 +11001566int android_image_get_second(const struct andr_img_hdr *hdr,
1567 ulong *second_data, ulong *second_len);
Sam Protsenko2666a1a2020-01-24 17:53:41 +02001568bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
Sam Protsenko4fabf402020-01-24 17:53:40 +02001569bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1570 u32 *size);
Sebastian Siewior686d6672014-05-05 15:08:09 -05001571ulong android_image_get_end(const struct andr_img_hdr *hdr);
1572ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Eugeniu Rosca1403f392019-04-08 17:35:27 +02001573ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
Michael Trimarchi44af20b2016-06-10 19:54:37 +02001574void android_print_contents(const struct andr_img_hdr *hdr);
Sam Protsenko4fabf402020-01-24 17:53:40 +02001575bool android_image_print_dtb_contents(ulong hdr_addr);
Sebastian Siewior686d6672014-05-05 15:08:09 -05001576
Simon Glassf287dfd2016-02-22 22:55:55 -07001577/**
1578 * board_fit_config_name_match() - Check for a matching board name
1579 *
1580 * This is used when SPL loads a FIT containing multiple device tree files
1581 * and wants to work out which one to use. The description of each one is
1582 * passed to this function. The description comes from the 'description' field
1583 * in each (FDT) image node.
1584 *
1585 * @name: Device tree description
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001586 * Return: 0 if this device tree should be used, non-zero to try the next
Simon Glassf287dfd2016-02-22 22:55:55 -07001587 */
1588int board_fit_config_name_match(const char *name);
1589
Daniel Allredcf839bd2016-06-27 09:19:21 -05001590/**
1591 * board_fit_image_post_process() - Do any post-process on FIT binary data
1592 *
1593 * This is used to do any sort of image manipulation, verification, decryption
1594 * etc. in a platform or board specific way. Obviously, anything done here would
1595 * need to be comprehended in how the images were prepared before being injected
1596 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1597 * before being added to the FIT image).
1598 *
Lokesh Vutlab36dd3e2021-06-11 11:45:05 +03001599 * @fit: pointer to fit image
1600 * @node: offset of image node
Daniel Allredcf839bd2016-06-27 09:19:21 -05001601 * @image: pointer to the image start pointer
1602 * @size: pointer to the image size
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001603 * Return: no return value (failure should be handled internally)
Daniel Allredcf839bd2016-06-27 09:19:21 -05001604 */
Lokesh Vutlab36dd3e2021-06-11 11:45:05 +03001605void board_fit_image_post_process(const void *fit, int node, void **p_image,
1606 size_t *p_size);
Daniel Allredcf839bd2016-06-27 09:19:21 -05001607
Cooper Jr., Frankline6792402017-06-16 17:25:05 -05001608#define FDT_ERROR ((ulong)(-1))
1609
Cooper Jr., Franklin899aad22017-06-16 17:25:06 -05001610ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
Jean-Jacques Hiblot5e7c12e2017-09-15 12:57:27 +02001611
1612/**
1613 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1614 *
1615 * A FIT image contains one or more DTBs. This function parses the
1616 * configurations described in the FIT images and returns the node of
1617 * the first matching DTB. To check if a DTB matches a board, this function
1618 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1619 * the node described by the default configuration if it exists.
1620 *
1621 * @fdt: pointer to flat device tree
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001622 * Return: the node if found, -ve otherwise
Jean-Jacques Hiblot5e7c12e2017-09-15 12:57:27 +02001623 */
Cooper Jr., Franklin899aad22017-06-16 17:25:06 -05001624int fit_find_config_node(const void *fdt);
1625
Andrew F. Davis28b28f72016-11-29 16:33:20 -06001626/**
1627 * Mapping of image types to function handlers to be invoked on the associated
1628 * loaded images
1629 *
1630 * @type: Type of image, I.E. IH_TYPE_*
1631 * @handler: Function to call on loaded image
1632 */
1633struct fit_loadable_tbl {
1634 int type;
1635 /**
1636 * handler() - Process a loaded image
1637 *
1638 * @data: Pointer to start of loaded image data
1639 * @size: Size of loaded image data
1640 */
1641 void (*handler)(ulong data, size_t size);
1642};
1643
1644/*
1645 * Define a FIT loadable image type handler
1646 *
1647 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1648 * _handler is the handler function to call after this image type is loaded
1649 */
1650#define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1651 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1652 .type = _type, \
1653 .handler = _handler, \
1654 }
1655
AKASHI Takahiro768d58d2020-10-29 13:47:43 +09001656/**
1657 * fit_update - update storage with FIT image
1658 * @fit: Pointer to FIT image
1659 *
1660 * Update firmware on storage using FIT image as input.
1661 * The storage area to be update will be identified by the name
1662 * in FIT and matching it to "dfu_alt_info" variable.
1663 *
1664 * Return: 0 on success, non-zero otherwise
1665 */
1666int fit_update(const void *fit);
1667
Marian Balakowiczb4a12a92008-01-08 18:12:17 +01001668#endif /* __IMAGE_H__ */