blob: 92efec0f04b7c518d2d277e664803005ba8cd861 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk5b1d7132002-11-03 00:07:02 +00002/*
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01003 * (C) Copyright 2008 Semihalf
4 *
Wolfgang Denkf08abe32005-11-25 16:38:03 +01005 * (C) Copyright 2000-2005
wdenk5b1d7132002-11-03 00:07:02 +00006 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
Wolfgang Denkf08abe32005-11-25 16:38:03 +01007 ********************************************************************
8 * NOTE: This header file defines an interface to U-Boot. Including
9 * this (unmodified) header file in another file is considered normal
10 * use of U-Boot, and does *not* fall under the heading of "derived
11 * work".
12 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000013 */
14
15#ifndef __IMAGE_H__
16#define __IMAGE_H__
17
Mike Frysinger37566092009-07-02 19:23:25 -040018#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000019#include <asm/byteorder.h>
Marek Vasut7f13b372018-06-13 06:13:32 +020020#include <stdbool.h>
Mike Frysinger37566092009-07-02 19:23:25 -040021
Simon Glass13d06982013-05-08 08:06:01 +000022/* Define this to avoid #ifdefs later on */
23struct lmb;
Masahiro Yamada641599a2018-03-21 18:03:35 +090024struct fdt_region;
Simon Glass13d06982013-05-08 08:06:01 +000025
Mike Frysinger37566092009-07-02 19:23:25 -040026#ifdef USE_HOSTCC
Jörg Krause26e355d2015-04-22 21:36:22 +020027#include <sys/types.h>
Simon Glassbf371b42021-09-25 19:43:20 -060028#include <linux/kconfig.h>
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010029
Simon Glass1fe7d932013-05-08 08:05:58 +000030#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000031
Wolfgang Denkdef08192008-10-21 11:23:56 +020032#else
33
34#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020035#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050036#include <command.h>
Alexandru Gagniuc09801642021-07-14 17:05:39 -050037#include <linker_lists.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020038
Simon Glass1fe7d932013-05-08 08:05:58 +000039#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000040
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010041#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010042
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020043#include <hash.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090044#include <linux/libfdt.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010045#include <fdt_support.h>
Simon Glass13c133b2021-09-25 19:43:33 -060046#include <u-boot/hash-checksum.h>
Simon Glass13d06982013-05-08 08:06:01 +000047
Simon Glass8e8ccfe2019-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 Reynes98220742022-03-28 22:56:59 +020051extern ulong image_load_offset; /* Default Load Address Offset */
Simon Glass8e8ccfe2019-12-28 10:45:03 -070052
Simon Glassc5819702021-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 Glass56d7ab72016-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 Yamadaff87b082016-07-21 15:16:00 +090067 *
68 * The following are exposed to uImage header.
Stefano Babic24431ad2018-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 Glass555f45d2016-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 Tomsich4914af12017-09-13 21:29:29 +020098 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
Bryan O'Donoghue45b55712018-03-13 16:50:35 +000099 IH_OS_TEE, /* Trusted Execution Environment */
Lukas Auer5e30e452019-08-21 21:14:44 +0200100 IH_OS_OPENSBI, /* RISC-V OpenSBI */
Cristian Ciocalteaa031b032019-12-24 18:05:38 +0200101 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
Simon Glass555f45d2016-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 Yamadaff87b082016-07-21 15:16:00 +0900108 *
109 * The following are exposed to uImage header.
Stefano Babic24431ad2018-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 Glass555f45d2016-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 Yamadaff87b082016-07-21 15:16:00 +0900127 IH_ARCH_NIOS, /* Nios-32 */
Simon Glass555f45d2016-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 Zankelde5e5ce2016-08-10 18:36:43 +0300139 IH_ARCH_XTENSA, /* Xtensa */
Rick Chen068feb92017-12-26 13:55:58 +0800140 IH_ARCH_RISCV, /* RISC-V */
Simon Glass555f45d2016-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
wdenke1599e82004-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)
wdenk27b207f2003-07-24 23:38:38 +0000181 * as command interpreter (=> Shell Scripts).
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900182 *
183 * The following are exposed to uImage header.
Stefano Babic24431ad2018-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 Glass555f45d2016-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 Vasut662abc42018-04-15 13:15:33 +0200209 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
Simon Glass555f45d2016-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 Graf6915dcf2018-04-13 14:18:52 +0200218 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
Simon Glass555f45d2016-06-30 10:52:13 -0600219 IH_TYPE_FPGA, /* FPGA Image */
Albert ARIBAUD \(3ADEV\)ed0c2c02016-09-26 09:08:06 +0200220 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
Andrew F. Davis7e719ee2016-11-29 16:33:21 -0600221 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
Sven Ebenfeldd21bd692016-11-06 16:37:56 +0100222 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
Andrew F. Davis6442c962017-07-31 10:58:20 -0500223 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
Patrick Delaunay81260e32018-03-12 10:46:04 +0100224 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
Marek Vasut662abc42018-04-15 13:15:33 +0200225 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
Ryder Lee3b975a12018-11-15 10:07:49 +0800226 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
Stefano Babic24431ad2018-12-17 11:02:00 +0100227 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
228 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
Patrick Delaunaye7fabe72019-08-02 15:07:19 +0200229 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
Andre Przywara6d295092018-12-20 01:15:18 +0000230 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
Samuel Hollande9e87ec2022-03-18 00:00:43 -0500231 IH_TYPE_SUNXI_TOC0, /* Allwinner TOC0 Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000232
Simon Glass555f45d2016-06-30 10:52:13 -0600233 IH_TYPE_COUNT, /* Number of image types */
234};
Simon Glass5b9d44d2015-06-23 15:38:25 -0600235
wdenk5b1d7132002-11-03 00:07:02 +0000236/*
237 * Compression Types
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900238 *
239 * The following are exposed to uImage header.
Stefano Babic24431ad2018-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 Glass555f45d2016-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 Marko26073f92020-04-25 19:37:21 +0200250 IH_COMP_ZSTD, /* zstd Compression Used */
Simon Glass555f45d2016-06-30 10:52:13 -0600251
252 IH_COMP_COUNT,
253};
wdenk5b1d7132002-11-03 00:07:02 +0000254
Eugeniu Rosca829ceb22019-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 Estevam1411fb32013-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 Balakowicz9a4daad2008-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 */
Simon Glassf3543e62022-09-06 20:26:52 -0600266struct legacy_img_hdr {
Bin Meng1af5e972019-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 */
Simon Glassf3543e62022-09-06 20:26:52 -0600279};
wdenk5b1d7132002-11-03 00:07:02 +0000280
Simon Glassda79b2f2022-09-06 20:26:51 -0600281struct image_info {
Kumar Gala396f6352008-08-15 08:24:41 -0500282 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 Glass90268b82014-10-19 21:11:24 -0600286 uint8_t arch; /* CPU architecture */
Simon Glassda79b2f2022-09-06 20:26:51 -0600287};
Kumar Gala396f6352008-08-15 08:24:41 -0500288
Marian Balakowicz559316f2008-01-08 18:11:44 +0100289/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100290 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
291 * routines.
292 */
Simon Glassd9d7c202022-09-06 20:26:50 -0600293struct bootm_headers {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100294 /*
295 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100296 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100297 * data from second and third component accordingly.
298 */
Simon Glassf3543e62022-09-06 20:26:52 -0600299 struct legacy_img_hdr *legacy_hdr_os; /* image header pointer */
300 struct legacy_img_hdr legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100301 ulong legacy_hdr_valid;
302
Simon Glass1df654a2021-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 Balakowiczf773bea2008-03-12 10:35:46 +0100308 const char *fit_uname_cfg; /* configuration node unit name */
309
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100310 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100311 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100312 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100313
314 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-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 Balakowiczd5934ad2008-02-04 08:28:09 +0100317
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100318 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-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 Glass90268b82014-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 Balakowicz1ec73762008-03-12 10:35:52 +0100325
Kumar Gala49c3a862008-10-21 17:25:45 -0500326#ifndef USE_HOSTCC
Simon Glassda79b2f2022-09-06 20:26:51 -0600327 struct image_info os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500328 ulong ep; /* entry point of OS */
329
Kumar Galac4f94192008-08-15 08:24:37 -0500330 ulong rd_start, rd_end;/* ramdisk start/end */
331
Kumar Gala06a09912008-08-15 08:24:38 -0500332 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500333 ulong ft_len; /* length of flat device tree */
334
Kumar Gala49c3a862008-10-21 17:25:45 -0500335 ulong initrd_start;
336 ulong initrd_end;
337 ulong cmdline_start;
338 ulong cmdline_end;
Masahiro Yamadab75d8dc2020-06-26 15:13:33 +0900339 struct bd_info *kbd;
Kumar Gala49c3a862008-10-21 17:25:45 -0500340#endif
341
Simon Glass00caae62017-08-03 12:22:12 -0600342 int verify; /* env_get("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500343
Simon Glassc56b2bb2022-09-06 20:26:49 -0600344#define BOOTM_STATE_START 0x00000001
345#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
353#define BOOTM_STATE_OS_FAKE_GO 0x00000200 /* 'Almost' run the OS */
354#define BOOTM_STATE_OS_GO 0x00000400
355#define BOOTM_STATE_PRE_LOAD 0x00000800
Kumar Gala49c3a862008-10-21 17:25:45 -0500356 int state;
357
Patrick Delaunay77b8cfe2021-03-10 10:16:25 +0100358#if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
Kumar Galae906cfa2008-08-15 08:24:40 -0500359 struct lmb lmb; /* for memory mgmt */
360#endif
Simon Glassd9d7c202022-09-06 20:26:50 -0600361};
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100362
Simon Glass9c2e9122022-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 Glassd9d7c202022-09-06 20:26:50 -0600369extern struct bootm_headers images;
Simon Schwarz1648a372012-03-15 04:01:34 +0000370
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100371/*
Marian Balakowicz559316f2008-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 Sieka75903782008-04-25 13:54:02 +0200374 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100375 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200376#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100377#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-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 Balakowicz559316f2008-01-08 18:11:44 +0100391
Mike Frysinger37566092009-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)
wdenk5b1d7132002-11-03 00:07:02 +0000394
Prafulla Wadaskarb029ddd2009-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 Patra155d6a32020-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 Wadaskarb029ddd2009-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 Frysinger7edb1862010-10-20 07:17:39 -0400419int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-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 Frysinger7edb1862010-10-20 07:17:39 -0400426char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530427
Stephen Warren712fbcf2011-10-18 11:11:49 +0000428const char *genimg_get_os_name(uint8_t os);
Simon Glasscef2e512016-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 Schuchardt185f8122022-01-19 18:05:50 +0100434 * Return: OS short name, or "unknown" if unknown
Simon Glasscef2e512016-02-22 22:55:50 -0700435 */
436const char *genimg_get_os_short_name(uint8_t comp);
437
Stephen Warren712fbcf2011-10-18 11:11:49 +0000438const char *genimg_get_arch_name(uint8_t arch);
Simon Glasscef2e512016-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 Schuchardt185f8122022-01-19 18:05:50 +0100444 * Return: architecture short name, or "unknown" if unknown
Simon Glasscef2e512016-02-22 22:55:50 -0700445 */
446const char *genimg_get_arch_short_name(uint8_t arch);
447
Stephen Warren712fbcf2011-10-18 11:11:49 +0000448const char *genimg_get_type_name(uint8_t type);
Simon Glass5b9d44d2015-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 Schuchardt185f8122022-01-19 18:05:50 +0100454 * Return: image short name, or "unknown" if unknown
Simon Glass5b9d44d2015-06-23 15:38:25 -0600455 */
456const char *genimg_get_type_short_name(uint8_t type);
457
Stephen Warren712fbcf2011-10-18 11:11:49 +0000458const char *genimg_get_comp_name(uint8_t comp);
Simon Glasscef2e512016-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 Schuchardt185f8122022-01-19 18:05:50 +0100464 * Return: compression method short name, or "unknown" if unknown
Simon Glasscef2e512016-02-22 22:55:50 -0700465 */
466const char *genimg_get_comp_short_name(uint8_t comp);
467
Simon Glass14262202016-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 Schuchardt185f8122022-01-19 18:05:50 +0100473 * Return: name of item, or "Unknown ..." if unknown
Simon Glass14262202016-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 Schuchardt185f8122022-01-19 18:05:50 +0100482 * Return: short name of item, or "Unknown ..." if unknown
Simon Glass14262202016-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 Schuchardt185f8122022-01-19 18:05:50 +0100490 * Return: the number of items in the category (IH_xxx_COUNT)
Simon Glass14262202016-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 Hayama898a0842020-10-07 11:22:24 +0900497 * @category: Category to check
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100498 * Return: the description of a category, e.g. "architecture". This
Simon Glass14262202016-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 Hayama02d41b02020-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 Schuchardt185f8122022-01-19 18:05:50 +0100508 * Return: true or false as to whether a category has an item
Naoki Hayama02d41b02020-10-07 11:21:25 +0900509 */
510bool genimg_cat_has_id(enum ih_category category, uint id);
511
Stephen Warren712fbcf2011-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 Balakowicz570abb02008-02-29 15:59:59 +0100517
Simon Glass13c133b2021-09-25 19:43:33 -0600518#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC)
Simon Glass859e92b2013-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 Glass782cfbb2013-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 Glassfe20a812014-08-22 14:26:43 -0600529 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000530 FIT_LOAD_REQUIRED, /* Must be provided */
531};
532
Simon Glassd9d7c202022-09-06 20:26:50 -0600533int boot_get_setup(struct bootm_headers *images, uint8_t arch, ulong *setup_start,
Simon Glass90268b82014-10-19 21:11:24 -0600534 ulong *setup_len);
535
Marian Balakowicz9a4daad2008-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 Siewior9ace3fc2014-05-05 15:08:09 -0500540#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100541
Bryan Wu6c454fe2014-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 Wu0f641402014-07-31 17:39:58 -0700545ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000546int genimg_get_format(const void *img_addr);
Simon Glassd9d7c202022-09-06 20:26:50 -0600547int genimg_has_config(struct bootm_headers *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100548
Simon Glassd9d7c202022-09-06 20:26:50 -0600549int boot_get_fpga(int argc, char *const argv[], struct bootm_headers *images,
Simon Glass09140112020-05-10 11:40:03 -0600550 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
Simon Glassd9d7c202022-09-06 20:26:50 -0600551int boot_get_ramdisk(int argc, char *const argv[], struct bootm_headers *images,
Simon Glass09140112020-05-10 11:40:03 -0600552 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite84a07db2015-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 Przywarab2267e82017-12-04 02:05:10 +0000566 * loadables = "linux_kernel", "fdt-2";
Karl Apsite84a07db2015-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 Glassd9d7c202022-09-06 20:26:50 -0600575int boot_get_loadable(int argc, char *const argv[], struct bootm_headers *images,
Simon Glass09140112020-05-10 11:40:03 -0600576 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100577
Simon Glassd9d7c202022-09-06 20:26:50 -0600578int boot_get_setup_fit(struct bootm_headers *images, uint8_t arch,
Simon Glass90268b82014-10-19 21:11:24 -0600579 ulong *setup_start, ulong *setup_len);
580
Simon Glass782cfbb2013-05-16 13:53:21 +0000581/**
Pantelis Antoniou169043d2017-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 Przywarab2267e82017-12-04 02:05:10 +0000591 * (e.g. "kernel") or NULL to use the default. On exit
Pantelis Antoniou169043d2017-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 Przywarab2267e82017-12-04 02:05:10 +0000594 * name (e.g. "conf-1") or NULL to use the default. On
Pantelis Antoniou169043d2017-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 Schuchardt185f8122022-01-19 18:05:50 +0100600 * Return: node offset of base image, or -ve error code on error
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300601 */
Simon Glassd9d7c202022-09-06 20:26:50 -0600602int boot_get_fdt_fit(struct bootm_headers *images, ulong addr,
603 const char **fit_unamep, const char **fit_uname_configp,
604 int arch, ulong *datap, ulong *lenp);
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300605
606/**
Simon Glass782cfbb2013-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 Glass126cc862014-06-12 07:24:47 -0600614 * The property to look up is defined by image_type.
615 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000616 * @param images Boot images structure
Simon Glass782cfbb2013-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 Przywarab2267e82017-12-04 02:05:10 +0000619 * (e.g. "kernel") or NULL to use the default. On exit
Simon Glass782cfbb2013-05-16 13:53:21 +0000620 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700621 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000622 * name (e.g. "conf-1") or NULL to use the default. On
Simon Glassf320a4d2013-07-10 23:08:10 -0700623 * exit points to the selected configuration name.
Simon Glass782cfbb2013-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 Schuchardt185f8122022-01-19 18:05:50 +0100634 * Return: node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000635 */
Simon Glassd9d7c202022-09-06 20:26:50 -0600636int fit_image_load(struct bootm_headers *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700637 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-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 Glass220a3a42019-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 Schuchardt185f8122022-01-19 18:05:50 +0100649 * Return: result code (enum command_ret_t)
Simon Glass220a3a42019-12-28 10:45:04 -0700650 */
651int image_source_script(ulong addr, const char *fit_uname);
652
Simon Glass782cfbb2013-05-16 13:53:21 +0000653/**
654 * fit_get_node_from_config() - Look up an image a FIT by type
655 *
Andre Przywarab2267e82017-12-04 02:05:10 +0000656 * This looks in the selected conf- node (images->fit_uname_cfg) for a
Simon Glass782cfbb2013-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 Przywarab2267e82017-12-04 02:05:10 +0000663 * kernel {
Simon Glass782cfbb2013-05-16 13:53:21 +0000664 * ...
665 * };
666 * };
667 * configurations {
Andre Przywarab2267e82017-12-04 02:05:10 +0000668 * conf-1 {
669 * kernel = "kernel";
Simon Glass782cfbb2013-05-16 13:53:21 +0000670 * };
671 * };
672 *
673 * the function will return the node offset of the kernel@1 node, assuming
Andre Przywarab2267e82017-12-04 02:05:10 +0000674 * that conf-1 is the chosen configuration.
Simon Glass782cfbb2013-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 */
Simon Glassd9d7c202022-09-06 20:26:50 -0600680int fit_get_node_from_config(struct bootm_headers *images,
681 const char *prop_name, ulong addr);
Simon Glass782cfbb2013-05-16 13:53:21 +0000682
Simon Glass09140112020-05-10 11:40:03 -0600683int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
Simon Glassd9d7c202022-09-06 20:26:50 -0600684 struct bootm_headers *images,
Simon Glass53f375f2013-05-16 13:53:23 +0000685 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000686void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000687int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500688
Stephen Warren712fbcf2011-10-18 11:11:49 +0000689int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100690 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000691int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
Masahiro Yamadab75d8dc2020-06-26 15:13:33 +0900692int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100693
694/*******************************************************************/
695/* Legacy format specific code (prefixed with image_) */
696/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000697static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100698{
Simon Glassf3543e62022-09-06 20:26:52 -0600699 return sizeof(struct legacy_img_hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100700}
701
702#define image_get_hdr_l(f) \
Simon Glassf3543e62022-09-06 20:26:52 -0600703 static inline uint32_t image_get_##f(const struct legacy_img_hdr *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100704 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000705 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100706 }
Stephen Warren712fbcf2011-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 Balakowiczb97a2a02008-01-08 18:14:09 +0100714
715#define image_get_hdr_b(f) \
Simon Glassf3543e62022-09-06 20:26:52 -0600716 static inline uint8_t image_get_##f(const struct legacy_img_hdr *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100717 { \
718 return hdr->ih_##f; \
719 }
Stephen Warren712fbcf2011-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 Balakowiczb97a2a02008-01-08 18:14:09 +0100724
Simon Glassf3543e62022-09-06 20:26:52 -0600725static inline char *image_get_name(const struct legacy_img_hdr *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100726{
727 return (char *)hdr->ih_name;
728}
729
Simon Glassf3543e62022-09-06 20:26:52 -0600730static inline uint32_t image_get_data_size(const struct legacy_img_hdr *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100731{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000732 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100733}
Marian Balakowiczf13e7b22008-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 */
Simon Glassf3543e62022-09-06 20:26:52 -0600746static inline ulong image_get_data(const struct legacy_img_hdr *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100747{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000748 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100749}
750
Simon Glassf3543e62022-09-06 20:26:52 -0600751static inline uint32_t image_get_image_size(const struct legacy_img_hdr *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100752{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000753 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100754}
Simon Glassf3543e62022-09-06 20:26:52 -0600755
756static inline ulong image_get_image_end(const struct legacy_img_hdr *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100757{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000758 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100759}
760
761#define image_set_hdr_l(f) \
Simon Glassf3543e62022-09-06 20:26:52 -0600762 static inline void image_set_##f(struct legacy_img_hdr *hdr, uint32_t val) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100763 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000764 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100765 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000766image_set_hdr_l(magic) /* image_set_magic */
767image_set_hdr_l(hcrc) /* image_set_hcrc */
768image_set_hdr_l(time) /* image_set_time */
769image_set_hdr_l(size) /* image_set_size */
770image_set_hdr_l(load) /* image_set_load */
771image_set_hdr_l(ep) /* image_set_ep */
772image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100773
774#define image_set_hdr_b(f) \
Simon Glassf3543e62022-09-06 20:26:52 -0600775 static inline void image_set_##f(struct legacy_img_hdr *hdr, uint8_t val) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100776 { \
777 hdr->ih_##f = val; \
778 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000779image_set_hdr_b(os) /* image_set_os */
780image_set_hdr_b(arch) /* image_set_arch */
781image_set_hdr_b(type) /* image_set_type */
782image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100783
Simon Glassf3543e62022-09-06 20:26:52 -0600784static inline void image_set_name(struct legacy_img_hdr *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100785{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000786 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100787}
788
Simon Glassf3543e62022-09-06 20:26:52 -0600789int image_check_hcrc(const struct legacy_img_hdr *hdr);
790int image_check_dcrc(const struct legacy_img_hdr *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100791#ifndef USE_HOSTCC
Simon Glass723806c2017-08-03 12:22:15 -0600792ulong env_get_bootm_low(void);
793phys_size_t env_get_bootm_size(void);
794phys_size_t env_get_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100795#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600796void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100797
Simon Glassf3543e62022-09-06 20:26:52 -0600798static inline int image_check_magic(const struct legacy_img_hdr *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100799{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000800 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100801}
Simon Glassf3543e62022-09-06 20:26:52 -0600802
803static inline int image_check_type(const struct legacy_img_hdr *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100804{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000805 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100806}
Simon Glassf3543e62022-09-06 20:26:52 -0600807
808static inline int image_check_arch(const struct legacy_img_hdr *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100809{
Simon Glasse2734d62021-03-15 18:11:12 +1300810 /* Let's assume that sandbox can load any architecture */
Simon Glass13c133b2021-09-25 19:43:33 -0600811 if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX))
Simon Glasse2734d62021-03-15 18:11:12 +1300812 return true;
Alison Wang4ac0a322017-06-06 15:32:40 +0800813 return (image_get_arch(hdr) == arch) ||
814 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100815}
Simon Glassf3543e62022-09-06 20:26:52 -0600816
817static inline int image_check_os(const struct legacy_img_hdr *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100818{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000819 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100820}
821
Simon Glassf3543e62022-09-06 20:26:52 -0600822ulong image_multi_count(const struct legacy_img_hdr *hdr);
823void image_multi_getimg(const struct legacy_img_hdr *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100824 ulong *data, ulong *len);
825
Stephen Warren712fbcf2011-10-18 11:11:49 +0000826void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100827
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100828#ifndef USE_HOSTCC
Simon Glassf3543e62022-09-06 20:26:52 -0600829static inline int image_check_target_arch(const struct legacy_img_hdr *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100830{
Mike Frysinger476af292011-10-03 14:50:33 +0000831#ifndef IH_ARCH_DEFAULT
832# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100833#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000834 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100835}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100836#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100837
Simon Glass13d06982013-05-08 08:06:01 +0000838/**
Atish Patra155d6a32020-03-05 16:24:22 -0800839 * image_decomp_type() - Find out compression type of an image
840 *
841 * @buf: Address in U-Boot memory where image is loaded.
842 * @len: Length of the compressed image.
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100843 * Return: compression type or IH_COMP_NONE if not compressed.
Atish Patra155d6a32020-03-05 16:24:22 -0800844 *
845 * Note: Only following compression types are supported now.
846 * lzo, lzma, gzip, bzip2
847 */
848int image_decomp_type(const unsigned char *buf, ulong len);
849
850/**
Julius Werner20908542019-07-24 19:37:54 -0700851 * image_decomp() - decompress an image
852 *
853 * @comp: Compression algorithm that is used (IH_COMP_...)
854 * @load: Destination load address in U-Boot memory
855 * @image_start Image start address (where we are decompressing from)
856 * @type: OS type (IH_OS_...)
857 * @load_bug: Place to decompress to
858 * @image_buf: Address to decompress from
859 * @image_len: Number of bytes in @image_buf to decompress
860 * @unc_len: Available space for decompression
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100861 * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
Julius Werner20908542019-07-24 19:37:54 -0700862 */
863int image_decomp(int comp, ulong load, ulong image_start, int type,
864 void *load_buf, void *image_buf, ulong image_len,
865 uint unc_len, ulong *load_end);
866
867/**
Simon Glass13d06982013-05-08 08:06:01 +0000868 * Set up properties in the FDT
869 *
870 * This sets up properties in the FDT that is to be passed to linux.
871 *
872 * @images: Images information
873 * @blob: FDT to update
874 * @of_size: Size of the FDT
875 * @lmb: Points to logical memory block structure
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100876 * Return: 0 if ok, <0 on failure
Simon Glass13d06982013-05-08 08:06:01 +0000877 */
Simon Glassd9d7c202022-09-06 20:26:50 -0600878int image_setup_libfdt(struct bootm_headers *images, void *blob,
Simon Glass13d06982013-05-08 08:06:01 +0000879 int of_size, struct lmb *lmb);
880
881/**
882 * Set up the FDT to use for booting a kernel
883 *
884 * This performs ramdisk setup, sets up the FDT if required, and adds
885 * paramters to the FDT if libfdt is available.
886 *
887 * @param images Images information
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100888 * Return: 0 if ok, <0 on failure
Simon Glass13d06982013-05-08 08:06:01 +0000889 */
Simon Glassd9d7c202022-09-06 20:26:50 -0600890int image_setup_linux(struct bootm_headers *images);
Simon Glass13d06982013-05-08 08:06:01 +0000891
Simon Glassa5266d62013-07-04 13:26:10 -0700892/**
893 * bootz_setup() - Extract stat and size of a Linux xImage
894 *
895 * @image: Address of image
896 * @start: Returns start address of image
897 * @end : Returns end address of image
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100898 * Return: 0 if OK, 1 if the image was not recognised
Simon Glassa5266d62013-07-04 13:26:10 -0700899 */
900int bootz_setup(ulong image, ulong *start, ulong *end);
901
Bin Chen6808ef92018-01-27 16:59:09 +1100902/**
903 * Return the correct start address and size of a Linux aarch64 Image.
904 *
905 * @image: Address of image
906 * @start: Returns start address of image
907 * @size : Returns size image
Marek Vasut7f13b372018-06-13 06:13:32 +0200908 * @force_reloc: Ignore image->ep field, always place image to RAM start
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100909 * Return: 0 if OK, 1 if the image was not recognised
Bin Chen6808ef92018-01-27 16:59:09 +1100910 */
Marek Vasut7f13b372018-06-13 06:13:32 +0200911int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
912 bool force_reloc);
Simon Glassa5266d62013-07-04 13:26:10 -0700913
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100914/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100915/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100916/*******************************************************************/
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100917
918#define FIT_IMAGES_PATH "/images"
919#define FIT_CONFS_PATH "/configurations"
920
Simon Glass72188f52020-03-18 11:44:06 -0600921/* hash/signature/key node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100922#define FIT_HASH_NODENAME "hash"
923#define FIT_ALGO_PROP "algo"
924#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000925#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700926#define FIT_SIG_NODENAME "signature"
Simon Glass72188f52020-03-18 11:44:06 -0600927#define FIT_KEY_REQUIRED "required"
928#define FIT_KEY_HINT "key-name-hint"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100929
Philippe Reynes7298e422019-12-18 18:25:41 +0100930/* cipher node */
931#define FIT_CIPHER_NODENAME "cipher"
932#define FIT_ALGO_PROP "algo"
933
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100934/* image node */
935#define FIT_DATA_PROP "data"
Peng Fana1be94b2017-12-05 13:20:59 +0800936#define FIT_DATA_POSITION_PROP "data-position"
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +0200937#define FIT_DATA_OFFSET_PROP "data-offset"
938#define FIT_DATA_SIZE_PROP "data-size"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100939#define FIT_TIMESTAMP_PROP "timestamp"
940#define FIT_DESC_PROP "description"
941#define FIT_ARCH_PROP "arch"
942#define FIT_TYPE_PROP "type"
943#define FIT_OS_PROP "os"
944#define FIT_COMP_PROP "compression"
945#define FIT_ENTRY_PROP "entry"
946#define FIT_LOAD_PROP "load"
947
948/* configuration node */
949#define FIT_KERNEL_PROP "kernel"
950#define FIT_RAMDISK_PROP "ramdisk"
951#define FIT_FDT_PROP "fdt"
Karl Apsiteecf8cd62015-05-21 09:52:47 -0400952#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100953#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -0600954#define FIT_SETUP_PROP "setup"
Michal Simeked0cea72016-05-17 13:58:44 +0200955#define FIT_FPGA_PROP "fpga"
Michal Simek1f8e4bf2018-03-26 16:31:26 +0200956#define FIT_FIRMWARE_PROP "firmware"
Marek Vasut0298d202018-05-13 00:22:54 +0200957#define FIT_STANDALONE_PROP "standalone"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100958
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200959#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100960
961/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000962int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100963 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000964int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100965 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100966
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200967int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000968void fit_print_contents(const void *fit);
969void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100970
971/**
972 * fit_get_end - get FIT image size
973 * @fit: pointer to the FIT format image header
974 *
975 * returns:
976 * size of the FIT image (blob) in memory
977 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000978static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100979{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000980 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100981}
982
983/**
984 * fit_get_end - get FIT image end
985 * @fit: pointer to the FIT format image header
986 *
987 * returns:
988 * end address of the FIT image (blob) in memory
989 */
Simon Glass7a80de42016-02-24 09:14:42 -0700990ulong fit_get_end(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100991
992/**
993 * fit_get_name - get FIT node name
994 * @fit: pointer to the FIT format image header
995 *
996 * returns:
997 * NULL, on error
998 * pointer to node name, on success
999 */
Stephen Warren712fbcf2011-10-18 11:11:49 +00001000static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001001 int noffset, int *len)
1002{
Stephen Warren712fbcf2011-10-18 11:11:49 +00001003 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001004}
1005
Stephen Warren712fbcf2011-10-18 11:11:49 +00001006int fit_get_desc(const void *fit, int noffset, char **desc);
1007int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001008
Stephen Warren712fbcf2011-10-18 11:11:49 +00001009int fit_image_get_node(const void *fit, const char *image_uname);
1010int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1011int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1012int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1013int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1014int fit_image_get_load(const void *fit, int noffset, ulong *load);
1015int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1016int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001017 const void **data, size_t *size);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001018int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
Peng Fana1be94b2017-12-05 13:20:59 +08001019int fit_image_get_data_position(const void *fit, int noffset,
1020 int *data_position);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001021int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
Philippe Reynes4df35782019-12-18 18:25:42 +01001022int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1023 size_t *data_size);
Kelvin Cheungc3c86382018-05-19 18:21:37 +08001024int fit_image_get_data_and_size(const void *fit, int noffset,
1025 const void **data, size_t *size);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001026
Sean Anderson37feaf22022-08-16 11:16:03 -04001027/**
1028 * fit_get_data_node() - Get verified image data for an image
1029 * @fit: Pointer to the FIT format image header
1030 * @image_uname: The name of the image node
1031 * @data: A pointer which will be filled with the location of the image data
1032 * @size: A pointer which will be filled with the size of the image data
1033 *
1034 * This function looks up the location and size of an image specified by its
1035 * name. For example, if you had a FIT like::
1036 *
1037 * images {
1038 * my-firmware {
1039 * ...
1040 * };
1041 * };
1042 *
1043 * Then you could look up the data location and size of the my-firmware image
1044 * by calling this function with @image_uname set to "my-firmware". This
1045 * function also verifies the image data (if enabled) before returning. The
1046 * image description is printed out on success. @data and @size will not be
1047 * modified on faulure.
1048 *
1049 * Return:
1050 * * 0 on success
1051 * * -EINVAL if the image could not be verified
1052 * * -ENOENT if there was a problem getting the data/size
1053 * * Another negative error if there was a problem looking up the image node.
1054 */
1055int fit_get_data_node(const void *fit, const char *image_uname,
1056 const void **data, size_t *size);
1057
1058/**
1059 * fit_get_data_conf_prop() - Get verified image data for a property in /conf
1060 * @fit: Pointer to the FIT format image header
1061 * @prop_name: The name of the property in /conf referencing the image
1062 * @data: A pointer which will be filled with the location of the image data
1063 * @size: A pointer which will be filled with the size of the image data
1064 *
1065 * This function looks up the location and size of an image specified by a
1066 * property in /conf. For example, if you had a FIT like::
1067 *
1068 * images {
1069 * my-firmware {
1070 * ...
1071 * };
1072 * };
1073 *
1074 * configurations {
1075 * default = "conf-1";
1076 * conf-1 {
1077 * some-firmware = "my-firmware";
1078 * };
1079 * };
1080 *
1081 * Then you could look up the data location and size of the my-firmware image
1082 * by calling this function with @prop_name set to "some-firmware". This
1083 * function also verifies the image data (if enabled) before returning. The
1084 * image description is printed out on success. @data and @size will not be
1085 * modified on faulure.
1086 *
1087 * Return:
1088 * * 0 on success
1089 * * -EINVAL if the image could not be verified
1090 * * -ENOENT if there was a problem getting the data/size
1091 * * Another negative error if there was a problem looking up the configuration
1092 * or image node.
1093 */
1094int fit_get_data_conf_prop(const void *fit, const char *prop_name,
1095 const void **data, size_t *size);
1096
Jan Kiszka4550ce92022-01-14 10:21:17 +01001097int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001098int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001099 int *value_len);
1100
Stephen Warren712fbcf2011-10-18 11:11:49 +00001101int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +00001102
Philippe Reynes6e052d12022-03-28 22:57:02 +02001103/**
1104 * fit_pre_load_data() - add public key to fdt blob
1105 *
1106 * Adds public key to the node pre load.
1107 *
1108 * @keydir: Directory containing keys
1109 * @keydest: FDT blob to write public key
1110 * @fit: Pointer to the FIT format image header
1111 *
1112 * returns:
1113 * 0, on success
1114 * < 0, on failure
1115 */
1116int fit_pre_load_data(const char *keydir, void *keydest, void *fit);
1117
Philippe Reynes7298e422019-12-18 18:25:41 +01001118int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1119 const char *comment, int require_keys,
1120 const char *engine_id, const char *cmdname);
1121
Simon Glass2d2384b2021-11-12 12:28:13 -07001122#define NODE_MAX_NAME_LEN 80
1123
1124/**
1125 * struct image_summary - Provides information about signing info added
1126 *
1127 * @sig_offset: Offset of the node in the blob devicetree where the signature
1128 * was wriiten
1129 * @sig_path: Path to @sig_offset
1130 * @keydest_offset: Offset of the node in the keydest devicetree where the
1131 * public key was written (-1 if none)
1132 * @keydest_path: Path to @keydest_offset
1133 */
1134struct image_summary {
1135 int sig_offset;
1136 char sig_path[NODE_MAX_NAME_LEN];
1137 int keydest_offset;
1138 char keydest_path[NODE_MAX_NAME_LEN];
1139};
1140
Simon Glassbbb467d2013-05-07 06:12:01 +00001141/**
Simon Glass56518e72013-06-13 15:10:01 -07001142 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +00001143 *
Simon Glass56518e72013-06-13 15:10:01 -07001144 * @keydir: Directory containing keys
Simon Glass70e6bcc2021-11-12 12:28:06 -07001145 * @kwydest: FDT blob to write public key information to (NULL if none)
Simon Glass56518e72013-06-13 15:10:01 -07001146 * @fit: Pointer to the FIT format image header
1147 * @comment: Comment to add to signature nodes
1148 * @require_keys: Mark all keys as 'required'
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001149 * @engine_id: Engine to use for signing
Alex Kiernan795f4522018-06-20 20:10:52 +00001150 * @cmdname: Command name used when reporting errors
Jan Kiszka5902a392022-01-14 10:21:19 +01001151 * @algo_name: Algorithm name, or NULL if to be read from FIT
Simon Glass2d2384b2021-11-12 12:28:13 -07001152 * @summary: Returns information about what data was written
Simon Glass56518e72013-06-13 15:10:01 -07001153 *
1154 * Adds hash values for all component images in the FIT blob.
1155 * Hashes are calculated for all component images which have hash subnodes
1156 * with algorithm property set to one of the supported hash algorithms.
1157 *
1158 * Also add signatures if signature nodes are present.
1159 *
1160 * returns
1161 * 0, on success
1162 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +00001163 */
Alexandru Gagniuc36bfcb62021-02-19 12:45:17 -06001164int fit_add_verification_data(const char *keydir, const char *keyfile,
1165 void *keydest, void *fit, const char *comment,
1166 int require_keys, const char *engine_id,
Simon Glass2d2384b2021-11-12 12:28:13 -07001167 const char *cmdname, const char *algo_name,
1168 struct image_summary *summary);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001169
Simon Glass99f844b2021-11-12 12:28:10 -07001170/**
1171 * fit_image_verify_with_data() - Verify an image with given data
1172 *
1173 * @fit: Pointer to the FIT format image header
1174 * @image_offset: Offset in @fit of image to verify
1175 * @key_blob: FDT containing public keys
1176 * @data: Image data to verify
1177 * @size: Size of image data
1178 */
Jun Nie5c643db2018-02-27 16:55:58 +08001179int fit_image_verify_with_data(const void *fit, int image_noffset,
Simon Glass99f844b2021-11-12 12:28:10 -07001180 const void *key_blob, const void *data,
1181 size_t size);
1182
Simon Glassb8da8362013-05-07 06:11:57 +00001183int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +00001184int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +00001185int fit_all_image_verify(const void *fit);
Philippe Reynes4df35782019-12-18 18:25:42 +01001186int fit_config_decrypt(const void *fit, int conf_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001187int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1188int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1189int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1190int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
Simon Glassc5819702021-02-15 17:08:09 -07001191
1192/**
1193 * fit_check_format() - Check that the FIT is valid
1194 *
1195 * This performs various checks on the FIT to make sure it is suitable for
1196 * use, looking for mandatory properties, nodes, etc.
1197 *
1198 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1199 * sure that there are no strange tags or broken nodes in the FIT.
1200 *
1201 * @fit: pointer to the FIT format image header
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001202 * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
Simon Glassc5819702021-02-15 17:08:09 -07001203 * failed (e.g. due to bad structure), -ENOMSG if the description is
Simon Glass29cbc4b2021-02-24 08:50:32 -05001204 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
Simon Glassc5819702021-02-15 17:08:09 -07001205 * path is missing
1206 */
1207int fit_check_format(const void *fit, ulong size);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001208
Simon Glass494e66d2022-10-20 18:23:00 -06001209/**
1210 * fit_conf_find_compat() - find most compatible configuration
1211 * @fit: pointer to the FIT format image header
1212 * @fdt: pointer to the device tree to compare against
1213 *
1214 * Attempts to find the configuration whose fdt is the most compatible with the
1215 * passed in device tree
1216 *
1217 * Example::
1218 *
1219 * / o image-tree
1220 * |-o images
1221 * | |-o fdt-1
1222 * | |-o fdt-2
1223 * |
1224 * |-o configurations
1225 * |-o config-1
1226 * | |-fdt = fdt-1
1227 * |
1228 * |-o config-2
1229 * |-fdt = fdt-2
1230 *
1231 * / o U-Boot fdt
1232 * |-compatible = "foo,bar", "bim,bam"
1233 *
1234 * / o kernel fdt1
1235 * |-compatible = "foo,bar",
1236 *
1237 * / o kernel fdt2
1238 * |-compatible = "bim,bam", "baz,biz"
1239 *
1240 * Configuration 1 would be picked because the first string in U-Boot's
1241 * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
1242 * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
1243 *
1244 * As an optimization, the compatible property from the FDT's root node can be
1245 * copied into the configuration node in the FIT image. This is required to
1246 * match configurations with compressed FDTs.
1247 *
1248 * Returns: offset to the configuration to use if one was found, -1 otherwise
1249 */
Gabe Blackd95f6ec2012-10-25 16:31:10 +00001250int fit_conf_find_compat(const void *fit, const void *fdt);
Simon Glass390b26d2020-03-18 11:43:55 -06001251
1252/**
1253 * fit_conf_get_node - get node offset for configuration of a given unit name
1254 * @fit: pointer to the FIT format image header
1255 * @conf_uname: configuration node unit name (NULL to use default)
1256 *
1257 * fit_conf_get_node() finds a configuration (within the '/configurations'
1258 * parent node) of a provided unit name. If configuration is found its node
1259 * offset is returned to the caller.
1260 *
1261 * When NULL is provided in second argument fit_conf_get_node() will search
1262 * for a default configuration node instead. Default configuration node unit
1263 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1264 * node.
1265 *
1266 * returns:
1267 * configuration node offset when found (>=0)
1268 * negative number on failure (FDT_ERR_* code)
1269 */
Stephen Warren712fbcf2011-10-18 11:11:49 +00001270int fit_conf_get_node(const void *fit, const char *conf_uname);
Simon Glass390b26d2020-03-18 11:43:55 -06001271
Tien Fong Chee0a42a132019-05-07 17:42:28 +08001272int fit_conf_get_prop_node_count(const void *fit, int noffset,
1273 const char *prop_name);
1274int fit_conf_get_prop_node_index(const void *fit, int noffset,
1275 const char *prop_name, int index);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001276
Simon Glass003efd72013-05-07 06:12:00 +00001277/**
1278 * fit_conf_get_prop_node() - Get node refered to by a configuration
1279 * @fit: FIT to check
1280 * @noffset: Offset of conf@xxx node to check
1281 * @prop_name: Property to read from the conf node
1282 *
Andre Przywarab2267e82017-12-04 02:05:10 +00001283 * The conf- nodes contain references to other nodes, using properties
1284 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
Simon Glass003efd72013-05-07 06:12:00 +00001285 * return the offset of the node referred to (e.g. offset of node
Andre Przywarab2267e82017-12-04 02:05:10 +00001286 * "/images/kernel".
Simon Glass003efd72013-05-07 06:12:00 +00001287 */
1288int fit_conf_get_prop_node(const void *fit, int noffset,
1289 const char *prop_name);
1290
Simon Glass61a439a2013-05-07 06:11:52 +00001291int fit_check_ramdisk(const void *fit, int os_noffset,
1292 uint8_t arch, int verify);
1293
Simon Glass604f23d2013-05-07 06:11:54 +00001294int calculate_hash(const void *data, int data_len, const char *algo,
1295 uint8_t *value, int *value_len);
1296
Simon Glass782cfbb2013-05-16 13:53:21 +00001297/*
Simon Glass3e569a62013-06-13 15:10:00 -07001298 * At present we only support signing on the host, and verification on the
1299 * device
Simon Glass782cfbb2013-05-16 13:53:21 +00001300 */
Alex Kiernan89665f22019-04-18 20:34:55 +00001301#if defined(USE_HOSTCC)
1302# if defined(CONFIG_FIT_SIGNATURE)
Simon Glass3e569a62013-06-13 15:10:00 -07001303# define IMAGE_ENABLE_SIGN 1
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001304# define FIT_IMAGE_ENABLE_VERIFY 1
Alex Kiernan89665f22019-04-18 20:34:55 +00001305# include <openssl/evp.h>
1306# else
Simon Glass3e569a62013-06-13 15:10:00 -07001307# define IMAGE_ENABLE_SIGN 0
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001308# define FIT_IMAGE_ENABLE_VERIFY 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001309# endif
1310#else
Simon Glass3e569a62013-06-13 15:10:00 -07001311# define IMAGE_ENABLE_SIGN 0
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001312# define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
Simon Glass782cfbb2013-05-16 13:53:21 +00001313#endif
1314
1315#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +01001316void *image_get_host_blob(void);
1317void image_set_host_blob(void *host_blob);
1318# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +00001319#else
1320# define gd_fdt_blob() (gd->fdt_blob)
1321#endif
1322
Alexandru Gagniuc36bfcb62021-02-19 12:45:17 -06001323/*
1324 * Information passed to the signing routines
1325 *
1326 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1327 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1328 * neither are valid, some operations might fail with EINVAL.
1329 */
Simon Glass3e569a62013-06-13 15:10:00 -07001330struct image_sign_info {
1331 const char *keydir; /* Directory conaining keys */
1332 const char *keyname; /* Name of key to use */
Alexandru Gagniuc36bfcb62021-02-19 12:45:17 -06001333 const char *keyfile; /* Filename of private or public key */
Hannu Lounento22896292021-10-18 08:49:03 +03001334 const void *fit; /* Pointer to FIT blob */
Simon Glass3e569a62013-06-13 15:10:00 -07001335 int node_offset; /* Offset of signature node */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001336 const char *name; /* Algorithm name */
1337 struct checksum_algo *checksum; /* Checksum algorithm information */
Philippe Reynes20031562018-11-14 13:51:00 +01001338 struct padding_algo *padding; /* Padding algorithm information */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001339 struct crypto_algo *crypto; /* Crypto algorithm information */
Simon Glass3e569a62013-06-13 15:10:00 -07001340 const void *fdt_blob; /* FDT containing public keys */
1341 int required_keynode; /* Node offset of key to use: -1=any */
1342 const char *require_keys; /* Value for 'required' property */
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001343 const char *engine_id; /* Engine to use for signing */
AKASHI Takahiroa8fc3df2020-02-21 15:12:57 +09001344 /*
1345 * Note: the following two fields are always valid even w/o
1346 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1347 * the same on target and host. Otherwise, vboot test may fail.
1348 */
1349 const void *key; /* Pointer to public key in DER */
1350 int keylen; /* Length of public key */
Simon Glass3e569a62013-06-13 15:10:00 -07001351};
Philippe Reynes7298e422019-12-18 18:25:41 +01001352
Simon Glass3e569a62013-06-13 15:10:00 -07001353/* A part of an image, used for hashing */
1354struct image_region {
1355 const void *data;
1356 int size;
1357};
1358
Heiko Schocher646257d2014-03-03 12:19:26 +01001359struct checksum_algo {
1360 const char *name;
1361 const int checksum_len;
Andrew Dudada29f292016-11-08 18:53:40 +00001362 const int der_len;
1363 const uint8_t *der_prefix;
Heiko Schocher646257d2014-03-03 12:19:26 +01001364#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +01001365 const EVP_MD *(*calculate_sign)(void);
1366#endif
Ruchika Guptab37b46f2015-01-23 16:01:59 +05301367 int (*calculate)(const char *name,
Simon Glass13c133b2021-09-25 19:43:33 -06001368 const struct image_region *region,
Ruchika Guptab37b46f2015-01-23 16:01:59 +05301369 int region_count, uint8_t *checksum);
Heiko Schocher646257d2014-03-03 12:19:26 +01001370};
1371
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001372struct crypto_algo {
Simon Glass3e569a62013-06-13 15:10:00 -07001373 const char *name; /* Name of algorithm */
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001374 const int key_len;
Simon Glass3e569a62013-06-13 15:10:00 -07001375
1376 /**
1377 * sign() - calculate and return signature for given input data
1378 *
1379 * @info: Specifies key and FIT information
1380 * @data: Pointer to the input data
1381 * @data_len: Data length
1382 * @sigp: Set to an allocated buffer holding the signature
1383 * @sig_len: Set to length of the calculated hash
1384 *
1385 * This computes input data signature according to selected algorithm.
1386 * Resulting signature value is placed in an allocated buffer, the
1387 * pointer is returned as *sigp. The length of the calculated
1388 * signature is returned via the sig_len pointer argument. The caller
1389 * should free *sigp.
1390 *
1391 * @return: 0, on success, -ve on error
1392 */
1393 int (*sign)(struct image_sign_info *info,
1394 const struct image_region region[],
1395 int region_count, uint8_t **sigp, uint *sig_len);
1396
1397 /**
1398 * add_verify_data() - Add verification information to FDT
1399 *
1400 * Add public key information to the FDT node, suitable for
1401 * verification at run-time. The information added depends on the
1402 * algorithm being used.
1403 *
1404 * @info: Specifies key and FIT information
1405 * @keydest: Destination FDT blob for public key data
Simon Glassc033dc82021-11-12 12:28:11 -07001406 * @return: node offset within the FDT blob where the data was written,
1407 * or -ve on error
Simon Glass3e569a62013-06-13 15:10:00 -07001408 */
1409 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1410
1411 /**
1412 * verify() - Verify a signature against some data
1413 *
1414 * @info: Specifies key and FIT information
1415 * @data: Pointer to the input data
1416 * @data_len: Data length
1417 * @sig: Signature
1418 * @sig_len: Number of bytes in signature
1419 * @return 0 if verified, -ve on error
1420 */
1421 int (*verify)(struct image_sign_info *info,
1422 const struct image_region region[], int region_count,
1423 uint8_t *sig, uint sig_len);
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001424};
Heiko Schocher646257d2014-03-03 12:19:26 +01001425
Alexandru Gagniuc09801642021-07-14 17:05:39 -05001426/* Declare a new U-Boot crypto algorithm handler */
1427#define U_BOOT_CRYPTO_ALGO(__name) \
1428ll_entry_declare(struct crypto_algo, __name, cryptos)
1429
Philippe Reynes20031562018-11-14 13:51:00 +01001430struct padding_algo {
1431 const char *name;
1432 int (*verify)(struct image_sign_info *info,
SESA644425c755aa82022-03-09 01:27:15 -08001433 const uint8_t *pad, int pad_len,
Philippe Reynes20031562018-11-14 13:51:00 +01001434 const uint8_t *hash, int hash_len);
1435};
1436
Alexandru Gagniucde41f0e2021-08-18 17:49:02 -05001437/* Declare a new U-Boot padding algorithm handler */
1438#define U_BOOT_PADDING_ALGO(__name) \
1439ll_entry_declare(struct padding_algo, __name, paddings)
1440
Simon Glass3e569a62013-06-13 15:10:00 -07001441/**
Andrew Duda83dd98e2016-11-08 18:53:41 +00001442 * image_get_checksum_algo() - Look up a checksum algorithm
Simon Glass3e569a62013-06-13 15:10:00 -07001443 *
Andrew Duda83dd98e2016-11-08 18:53:41 +00001444 * @param full_name Name of algorithm in the form "checksum,crypto"
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001445 * Return: pointer to algorithm information, or NULL if not found
Simon Glass3e569a62013-06-13 15:10:00 -07001446 */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001447struct checksum_algo *image_get_checksum_algo(const char *full_name);
1448
1449/**
1450 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1451 *
1452 * @param full_name Name of algorithm in the form "checksum,crypto"
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001453 * Return: pointer to algorithm information, or NULL if not found
Andrew Duda83dd98e2016-11-08 18:53:41 +00001454 */
1455struct crypto_algo *image_get_crypto_algo(const char *full_name);
Simon Glass3e569a62013-06-13 15:10:00 -07001456
Simon Glass56518e72013-06-13 15:10:01 -07001457/**
Philippe Reynes20031562018-11-14 13:51:00 +01001458 * image_get_padding_algo() - Look up a padding algorithm
1459 *
1460 * @param name Name of padding algorithm
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001461 * Return: pointer to algorithm information, or NULL if not found
Philippe Reynes20031562018-11-14 13:51:00 +01001462 */
1463struct padding_algo *image_get_padding_algo(const char *name);
1464
Steven Lawrance7c5eeb82022-09-14 20:57:27 +02001465#define IMAGE_PRE_LOAD_SIG_MAGIC 0x55425348
1466#define IMAGE_PRE_LOAD_SIG_OFFSET_MAGIC 0
1467#define IMAGE_PRE_LOAD_SIG_OFFSET_IMG_LEN 4
1468#define IMAGE_PRE_LOAD_SIG_OFFSET_SIG 8
1469
1470#define IMAGE_PRE_LOAD_PATH "/image/pre-load/sig"
1471#define IMAGE_PRE_LOAD_PROP_ALGO_NAME "algo-name"
1472#define IMAGE_PRE_LOAD_PROP_PADDING_NAME "padding-name"
1473#define IMAGE_PRE_LOAD_PROP_SIG_SIZE "signature-size"
1474#define IMAGE_PRE_LOAD_PROP_PUBLIC_KEY "public-key"
1475#define IMAGE_PRE_LOAD_PROP_MANDATORY "mandatory"
1476
1477/*
1478 * Information in the device-tree about the signature in the header
1479 */
1480struct image_sig_info {
1481 char *algo_name; /* Name of the algo (eg: sha256,rsa2048) */
1482 char *padding_name; /* Name of the padding */
1483 uint8_t *key; /* Public signature key */
1484 int key_len; /* Length of the public key */
1485 uint32_t sig_size; /* size of the signature (in the header) */
1486 int mandatory; /* Set if the signature is mandatory */
1487
1488 struct image_sign_info sig_info; /* Signature info */
1489};
1490
1491/*
1492 * Header of the signature header
1493 */
1494struct sig_header_s {
1495 uint32_t magic;
1496 uint32_t version;
1497 uint32_t header_size;
1498 uint32_t image_size;
1499 uint32_t offset_img_sig;
1500 uint32_t flags;
1501 uint32_t reserved0;
1502 uint32_t reserved1;
1503 uint8_t sha256_img_sig[SHA256_SUM_LEN];
1504};
1505
1506#define SIG_HEADER_LEN (sizeof(struct sig_header_s))
1507
Philippe Reynes20031562018-11-14 13:51:00 +01001508/**
Philippe Reynes98220742022-03-28 22:56:59 +02001509 * image_pre_load() - Manage pre load header
1510 *
1511 * Manage the pre-load header before launching the image.
1512 * It checks the signature of the image. It also set the
1513 * variable image_load_offset to skip this header before
1514 * launching the image.
1515 *
1516 * @param addr Address of the image
1517 * @return: 0 on success, -ve on error
1518 */
1519int image_pre_load(ulong addr);
1520
1521/**
Simon Glass56518e72013-06-13 15:10:01 -07001522 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1523 *
1524 * @fit: FIT to check
1525 * @image_noffset: Offset of image node to check
1526 * @data: Image data to check
1527 * @size: Size of image data
Simon Glass99f844b2021-11-12 12:28:10 -07001528 * @key_blob: FDT containing public keys
Simon Glass56518e72013-06-13 15:10:01 -07001529 * @no_sigsp: Returns 1 if no signatures were required, and
1530 * therefore nothing was checked. The caller may wish
1531 * to fall back to other mechanisms, or refuse to
1532 * boot.
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001533 * Return: 0 if all verified ok, <0 on error
Simon Glass56518e72013-06-13 15:10:01 -07001534 */
1535int fit_image_verify_required_sigs(const void *fit, int image_noffset,
Simon Glass99f844b2021-11-12 12:28:10 -07001536 const char *data, size_t size, const void *key_blob,
Simon Glass56518e72013-06-13 15:10:01 -07001537 int *no_sigsp);
1538
1539/**
1540 * fit_image_check_sig() - Check a single image signature node
1541 *
1542 * @fit: FIT to check
1543 * @noffset: Offset of signature node to check
1544 * @data: Image data to check
1545 * @size: Size of image data
Simon Glass99f844b2021-11-12 12:28:10 -07001546 * @keyblob: Key blob to check (typically the control FDT)
1547 * @required_keynode: Offset in the keyblob of the required key node,
Simon Glass56518e72013-06-13 15:10:01 -07001548 * if any. If this is given, then the image wil not
1549 * pass verification unless that key is used. If this is
1550 * -1 then any signature will do.
1551 * @err_msgp: In the event of an error, this will be pointed to a
1552 * help error string to display to the user.
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001553 * Return: 0 if all verified ok, <0 on error
Simon Glass56518e72013-06-13 15:10:01 -07001554 */
1555int fit_image_check_sig(const void *fit, int noffset, const void *data,
Simon Glass99f844b2021-11-12 12:28:10 -07001556 size_t size, const void *key_blob, int required_keynode,
1557 char **err_msgp);
Simon Glass56518e72013-06-13 15:10:01 -07001558
Philippe Reynes4df35782019-12-18 18:25:42 +01001559int fit_image_decrypt_data(const void *fit,
1560 int image_noffset, int cipher_noffset,
1561 const void *data, size_t size,
1562 void **data_unciphered, size_t *size_unciphered);
1563
Simon Glass4d098522013-06-13 15:10:09 -07001564/**
1565 * fit_region_make_list() - Make a list of regions to hash
1566 *
1567 * Given a list of FIT regions (offset, size) provided by libfdt, create
1568 * a list of regions (void *, size) for use by the signature creationg
1569 * and verification code.
1570 *
1571 * @fit: FIT image to process
1572 * @fdt_regions: Regions as returned by libfdt
1573 * @count: Number of regions returned by libfdt
1574 * @region: Place to put list of regions (NULL to allocate it)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001575 * Return: pointer to list of regions, or NULL if out of memory
Simon Glass4d098522013-06-13 15:10:09 -07001576 */
1577struct image_region *fit_region_make_list(const void *fit,
1578 struct fdt_region *fdt_regions, int count,
1579 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001580
Stephen Warren712fbcf2011-10-18 11:11:49 +00001581static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001582{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001583#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001584 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001585#else
1586 return 0;
1587#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001588}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001589
Philippe Reynes7298e422019-12-18 18:25:41 +01001590/*
1591 * At present we only support ciphering on the host, and unciphering on the
1592 * device
1593 */
1594#if defined(USE_HOSTCC)
1595# if defined(CONFIG_FIT_CIPHER)
1596# define IMAGE_ENABLE_ENCRYPT 1
1597# define IMAGE_ENABLE_DECRYPT 1
1598# include <openssl/evp.h>
1599# else
1600# define IMAGE_ENABLE_ENCRYPT 0
1601# define IMAGE_ENABLE_DECRYPT 0
1602# endif
1603#else
1604# define IMAGE_ENABLE_ENCRYPT 0
1605# define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1606#endif
1607
1608/* Information passed to the ciphering routines */
1609struct image_cipher_info {
1610 const char *keydir; /* Directory containing keys */
1611 const char *keyname; /* Name of key to use */
1612 const char *ivname; /* Name of IV to use */
1613 const void *fit; /* Pointer to FIT blob */
1614 int node_noffset; /* Offset of the cipher node */
1615 const char *name; /* Algorithm name */
1616 struct cipher_algo *cipher; /* Cipher algorithm information */
1617 const void *fdt_blob; /* FDT containing key and IV */
1618 const void *key; /* Value of the key */
1619 const void *iv; /* Value of the IV */
1620 size_t size_unciphered; /* Size of the unciphered data */
1621};
1622
1623struct cipher_algo {
1624 const char *name; /* Name of algorithm */
1625 int key_len; /* Length of the key */
1626 int iv_len; /* Length of the IV */
1627
1628#if IMAGE_ENABLE_ENCRYPT
1629 const EVP_CIPHER * (*calculate_type)(void);
1630#endif
1631
1632 int (*encrypt)(struct image_cipher_info *info,
1633 const unsigned char *data, int data_len,
1634 unsigned char **cipher, int *cipher_len);
1635
1636 int (*add_cipher_data)(struct image_cipher_info *info,
Philippe Reynesa6982a62020-09-17 15:01:46 +02001637 void *keydest, void *fit, int node_noffset);
Philippe Reynes4df35782019-12-18 18:25:42 +01001638
1639 int (*decrypt)(struct image_cipher_info *info,
1640 const void *cipher, size_t cipher_len,
1641 void **data, size_t *data_len);
Philippe Reynes7298e422019-12-18 18:25:41 +01001642};
1643
1644int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1645
1646struct cipher_algo *image_get_cipher_algo(const char *full_name);
1647
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001648struct andr_img_hdr;
1649int android_image_check_header(const struct andr_img_hdr *hdr);
1650int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1651 ulong *os_data, ulong *os_len);
1652int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1653 ulong *rd_data, ulong *rd_len);
Bin Chen10481612018-01-27 16:59:08 +11001654int android_image_get_second(const struct andr_img_hdr *hdr,
1655 ulong *second_data, ulong *second_len);
Sam Protsenko7f253152020-01-24 17:53:41 +02001656bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
Sam Protsenkoc3bfad82020-01-24 17:53:40 +02001657bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1658 u32 *size);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001659ulong android_image_get_end(const struct andr_img_hdr *hdr);
1660ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Eugeniu Rosca829ceb22019-04-08 17:35:27 +02001661ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
Michael Trimarchi4f1318b2016-06-10 19:54:37 +02001662void android_print_contents(const struct andr_img_hdr *hdr);
Sam Protsenkoc3bfad82020-01-24 17:53:40 +02001663bool android_image_print_dtb_contents(ulong hdr_addr);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001664
Simon Glass4b307f22016-02-22 22:55:55 -07001665/**
1666 * board_fit_config_name_match() - Check for a matching board name
1667 *
1668 * This is used when SPL loads a FIT containing multiple device tree files
1669 * and wants to work out which one to use. The description of each one is
1670 * passed to this function. The description comes from the 'description' field
1671 * in each (FDT) image node.
1672 *
1673 * @name: Device tree description
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001674 * Return: 0 if this device tree should be used, non-zero to try the next
Simon Glass4b307f22016-02-22 22:55:55 -07001675 */
1676int board_fit_config_name_match(const char *name);
1677
Daniel Allredda74d1f2016-06-27 09:19:21 -05001678/**
1679 * board_fit_image_post_process() - Do any post-process on FIT binary data
1680 *
1681 * This is used to do any sort of image manipulation, verification, decryption
1682 * etc. in a platform or board specific way. Obviously, anything done here would
1683 * need to be comprehended in how the images were prepared before being injected
1684 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1685 * before being added to the FIT image).
1686 *
Lokesh Vutla481d3942021-06-11 11:45:05 +03001687 * @fit: pointer to fit image
1688 * @node: offset of image node
Daniel Allredda74d1f2016-06-27 09:19:21 -05001689 * @image: pointer to the image start pointer
1690 * @size: pointer to the image size
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001691 * Return: no return value (failure should be handled internally)
Daniel Allredda74d1f2016-06-27 09:19:21 -05001692 */
Lokesh Vutla481d3942021-06-11 11:45:05 +03001693void board_fit_image_post_process(const void *fit, int node, void **p_image,
1694 size_t *p_size);
Daniel Allredda74d1f2016-06-27 09:19:21 -05001695
Cooper Jr., Franklin3863f842017-06-16 17:25:05 -05001696#define FDT_ERROR ((ulong)(-1))
1697
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001698ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
Jean-Jacques Hiblot02035d02017-09-15 12:57:27 +02001699
1700/**
1701 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1702 *
1703 * A FIT image contains one or more DTBs. This function parses the
1704 * configurations described in the FIT images and returns the node of
1705 * the first matching DTB. To check if a DTB matches a board, this function
1706 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1707 * the node described by the default configuration if it exists.
1708 *
1709 * @fdt: pointer to flat device tree
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001710 * Return: the node if found, -ve otherwise
Jean-Jacques Hiblot02035d02017-09-15 12:57:27 +02001711 */
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001712int fit_find_config_node(const void *fdt);
1713
Andrew F. Davisd7be5092016-11-29 16:33:20 -06001714/**
1715 * Mapping of image types to function handlers to be invoked on the associated
1716 * loaded images
1717 *
1718 * @type: Type of image, I.E. IH_TYPE_*
1719 * @handler: Function to call on loaded image
1720 */
1721struct fit_loadable_tbl {
1722 int type;
1723 /**
1724 * handler() - Process a loaded image
1725 *
1726 * @data: Pointer to start of loaded image data
1727 * @size: Size of loaded image data
1728 */
1729 void (*handler)(ulong data, size_t size);
1730};
1731
1732/*
1733 * Define a FIT loadable image type handler
1734 *
1735 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1736 * _handler is the handler function to call after this image type is loaded
1737 */
1738#define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1739 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1740 .type = _type, \
1741 .handler = _handler, \
1742 }
1743
AKASHI Takahiro3149e522020-10-29 13:47:43 +09001744/**
1745 * fit_update - update storage with FIT image
1746 * @fit: Pointer to FIT image
1747 *
1748 * Update firmware on storage using FIT image as input.
1749 * The storage area to be update will be identified by the name
1750 * in FIT and matching it to "dfu_alt_info" variable.
1751 *
1752 * Return: 0 on success, non-zero otherwise
1753 */
1754int fit_update(const void *fit);
1755
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001756#endif /* __IMAGE_H__ */