blob: 00bc03bebece37313263ea5a13afa1d47c868bdd [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk5b1d7132002-11-03 00:07:02 +00002/*
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01003 * (C) Copyright 2008 Semihalf
4 *
Wolfgang Denkf08abe32005-11-25 16:38:03 +01005 * (C) Copyright 2000-2005
wdenk5b1d7132002-11-03 00:07:02 +00006 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
Wolfgang Denkf08abe32005-11-25 16:38:03 +01007 ********************************************************************
8 * NOTE: This header file defines an interface to U-Boot. Including
9 * this (unmodified) header file in another file is considered normal
10 * use of U-Boot, and does *not* fall under the heading of "derived
11 * work".
12 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000013 */
14
15#ifndef __IMAGE_H__
16#define __IMAGE_H__
17
Mike Frysinger37566092009-07-02 19:23:25 -040018#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000019#include <asm/byteorder.h>
Marek Vasut7f13b372018-06-13 06:13:32 +020020#include <stdbool.h>
Mike Frysinger37566092009-07-02 19:23:25 -040021
Simon Glass13d06982013-05-08 08:06:01 +000022/* Define this to avoid #ifdefs later on */
23struct lmb;
Masahiro Yamada641599a2018-03-21 18:03:35 +090024struct fdt_region;
Simon Glass13d06982013-05-08 08:06:01 +000025
Mike Frysinger37566092009-07-02 19:23:25 -040026#ifdef USE_HOSTCC
Jörg Krause26e355d2015-04-22 21:36:22 +020027#include <sys/types.h>
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010028
29/* new uImage format support enabled on host */
Simon Glassaa34fbc2016-02-22 22:55:45 -070030#define IMAGE_ENABLE_FIT 1
31#define IMAGE_ENABLE_OF_LIBFDT 1
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010032#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
Philippe Reynes061daa02018-11-14 13:51:01 +010033#define CONFIG_FIT_ENABLE_RSASSA_PSS_SUPPORT 1
Tom Rini0db7f682017-05-15 12:17:48 -040034#define CONFIG_FIT_ENABLE_SHA256_SUPPORT
Reuben Dowled16b38f2020-04-16 17:36:52 +120035#define CONFIG_FIT_ENABLE_SHA384_SUPPORT
36#define CONFIG_FIT_ENABLE_SHA512_SUPPORT
Tom Rini089df182017-05-15 12:17:49 -040037#define CONFIG_SHA1
38#define CONFIG_SHA256
Reuben Dowled16b38f2020-04-16 17:36:52 +120039#define CONFIG_SHA384
40#define CONFIG_SHA512
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010041
Simon Glassab9efc62013-05-07 06:11:58 +000042#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000043#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000044
Wolfgang Denkdef08192008-10-21 11:23:56 +020045#else
46
47#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020048#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050049#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020050
Simon Glassab9efc62013-05-07 06:11:58 +000051/* Take notice of the 'ignore' property for hashes */
52#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000053#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000054
Simon Glassaa34fbc2016-02-22 22:55:45 -070055#define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
56#define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
Simon Glass73223f02016-02-22 22:55:43 -070057
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010058#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010059
Simon Glass73223f02016-02-22 22:55:43 -070060#if IMAGE_ENABLE_FIT
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020061#include <hash.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090062#include <linux/libfdt.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010063#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000064# ifdef CONFIG_SPL_BUILD
Masahiro Yamada6f417512016-05-31 20:41:54 +090065# ifdef CONFIG_SPL_CRC32_SUPPORT
66# define IMAGE_ENABLE_CRC32 1
67# endif
68# ifdef CONFIG_SPL_MD5_SUPPORT
69# define IMAGE_ENABLE_MD5 1
70# endif
71# ifdef CONFIG_SPL_SHA1_SUPPORT
72# define IMAGE_ENABLE_SHA1 1
73# endif
Simon Glass87ebee32013-05-08 08:05:59 +000074# else
Simon Glass87ebee32013-05-08 08:05:59 +000075# define IMAGE_ENABLE_CRC32 1
76# define IMAGE_ENABLE_MD5 1
77# define IMAGE_ENABLE_SHA1 1
78# endif
Masahiro Yamada6f417512016-05-31 20:41:54 +090079
Masahiro Yamada6f417512016-05-31 20:41:54 +090080#ifndef IMAGE_ENABLE_CRC32
81#define IMAGE_ENABLE_CRC32 0
82#endif
83
84#ifndef IMAGE_ENABLE_MD5
85#define IMAGE_ENABLE_MD5 0
86#endif
87
88#ifndef IMAGE_ENABLE_SHA1
89#define IMAGE_ENABLE_SHA1 0
90#endif
91
Tom Rini0db7f682017-05-15 12:17:48 -040092#if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
93 defined(CONFIG_SPL_SHA256_SUPPORT)
Tom Rini0db7f682017-05-15 12:17:48 -040094#define IMAGE_ENABLE_SHA256 1
95#else
Masahiro Yamada6f417512016-05-31 20:41:54 +090096#define IMAGE_ENABLE_SHA256 0
97#endif
98
Reuben Dowled16b38f2020-04-16 17:36:52 +120099#if defined(CONFIG_FIT_ENABLE_SHA384_SUPPORT) || \
100 defined(CONFIG_SPL_SHA384_SUPPORT)
101#define IMAGE_ENABLE_SHA384 1
102#else
103#define IMAGE_ENABLE_SHA384 0
104#endif
105
106#if defined(CONFIG_FIT_ENABLE_SHA512_SUPPORT) || \
107 defined(CONFIG_SPL_SHA512_SUPPORT)
108#define IMAGE_ENABLE_SHA512 1
109#else
110#define IMAGE_ENABLE_SHA512 0
111#endif
112
Simon Glass73223f02016-02-22 22:55:43 -0700113#endif /* IMAGE_ENABLE_FIT */
Simon Glass13d06982013-05-08 08:06:01 +0000114
Masahiro Yamada6f417512016-05-31 20:41:54 +0900115#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
116# define IMAGE_BOOT_GET_CMDLINE 1
117#else
118# define IMAGE_BOOT_GET_CMDLINE 0
119#endif
120
121#ifdef CONFIG_OF_BOARD_SETUP
122# define IMAGE_OF_BOARD_SETUP 1
123#else
124# define IMAGE_OF_BOARD_SETUP 0
125#endif
126
127#ifdef CONFIG_OF_SYSTEM_SETUP
128# define IMAGE_OF_SYSTEM_SETUP 1
129#else
130# define IMAGE_OF_SYSTEM_SETUP 0
131#endif
Simon Glassc654b512014-10-23 18:58:54 -0600132
Simon Glass8e8ccfe2019-12-28 10:45:03 -0700133extern ulong image_load_addr; /* Default Load Address */
134extern ulong image_save_addr; /* Default Save Address */
135extern ulong image_save_size; /* Default Save Size */
136
Simon Glass56d7ab72016-06-30 10:52:14 -0600137enum ih_category {
138 IH_ARCH,
139 IH_COMP,
140 IH_OS,
141 IH_TYPE,
142
143 IH_COUNT,
144};
145
wdenk5b1d7132002-11-03 00:07:02 +0000146/*
147 * Operating System Codes
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900148 *
149 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100150 * New IDs *MUST* be appended at the end of the list and *NEVER*
151 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000152 */
Simon Glass555f45d2016-06-30 10:52:13 -0600153enum {
154 IH_OS_INVALID = 0, /* Invalid OS */
155 IH_OS_OPENBSD, /* OpenBSD */
156 IH_OS_NETBSD, /* NetBSD */
157 IH_OS_FREEBSD, /* FreeBSD */
158 IH_OS_4_4BSD, /* 4.4BSD */
159 IH_OS_LINUX, /* Linux */
160 IH_OS_SVR4, /* SVR4 */
161 IH_OS_ESIX, /* Esix */
162 IH_OS_SOLARIS, /* Solaris */
163 IH_OS_IRIX, /* Irix */
164 IH_OS_SCO, /* SCO */
165 IH_OS_DELL, /* Dell */
166 IH_OS_NCR, /* NCR */
167 IH_OS_LYNXOS, /* LynxOS */
168 IH_OS_VXWORKS, /* VxWorks */
169 IH_OS_PSOS, /* pSOS */
170 IH_OS_QNX, /* QNX */
171 IH_OS_U_BOOT, /* Firmware */
172 IH_OS_RTEMS, /* RTEMS */
173 IH_OS_ARTOS, /* ARTOS */
174 IH_OS_UNITY, /* Unity OS */
175 IH_OS_INTEGRITY, /* INTEGRITY */
176 IH_OS_OSE, /* OSE */
177 IH_OS_PLAN9, /* Plan 9 */
178 IH_OS_OPENRTOS, /* OpenRTOS */
Philipp Tomsich4914af12017-09-13 21:29:29 +0200179 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
Bryan O'Donoghue45b55712018-03-13 16:50:35 +0000180 IH_OS_TEE, /* Trusted Execution Environment */
Lukas Auer5e30e452019-08-21 21:14:44 +0200181 IH_OS_OPENSBI, /* RISC-V OpenSBI */
Cristian Ciocalteaa031b032019-12-24 18:05:38 +0200182 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
Simon Glass555f45d2016-06-30 10:52:13 -0600183
184 IH_OS_COUNT,
185};
wdenk5b1d7132002-11-03 00:07:02 +0000186
187/*
188 * CPU Architecture Codes (supported by Linux)
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900189 *
190 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100191 * New IDs *MUST* be appended at the end of the list and *NEVER*
192 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000193 */
Simon Glass555f45d2016-06-30 10:52:13 -0600194enum {
195 IH_ARCH_INVALID = 0, /* Invalid CPU */
196 IH_ARCH_ALPHA, /* Alpha */
197 IH_ARCH_ARM, /* ARM */
198 IH_ARCH_I386, /* Intel x86 */
199 IH_ARCH_IA64, /* IA64 */
200 IH_ARCH_MIPS, /* MIPS */
201 IH_ARCH_MIPS64, /* MIPS 64 Bit */
202 IH_ARCH_PPC, /* PowerPC */
203 IH_ARCH_S390, /* IBM S390 */
204 IH_ARCH_SH, /* SuperH */
205 IH_ARCH_SPARC, /* Sparc */
206 IH_ARCH_SPARC64, /* Sparc 64 Bit */
207 IH_ARCH_M68K, /* M68K */
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900208 IH_ARCH_NIOS, /* Nios-32 */
Simon Glass555f45d2016-06-30 10:52:13 -0600209 IH_ARCH_MICROBLAZE, /* MicroBlaze */
210 IH_ARCH_NIOS2, /* Nios-II */
211 IH_ARCH_BLACKFIN, /* Blackfin */
212 IH_ARCH_AVR32, /* AVR32 */
213 IH_ARCH_ST200, /* STMicroelectronics ST200 */
214 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
215 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
216 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
217 IH_ARCH_ARM64, /* ARM64 */
218 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
219 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
Chris Zankelde5e5ce2016-08-10 18:36:43 +0300220 IH_ARCH_XTENSA, /* Xtensa */
Rick Chen068feb92017-12-26 13:55:58 +0800221 IH_ARCH_RISCV, /* RISC-V */
Simon Glass555f45d2016-06-30 10:52:13 -0600222
223 IH_ARCH_COUNT,
224};
wdenk5b1d7132002-11-03 00:07:02 +0000225
226/*
227 * Image Types
228 *
229 * "Standalone Programs" are directly runnable in the environment
230 * provided by U-Boot; it is expected that (if they behave
231 * well) you can continue to work in U-Boot after return from
232 * the Standalone Program.
233 * "OS Kernel Images" are usually images of some Embedded OS which
234 * will take over control completely. Usually these programs
235 * will install their own set of exception handlers, device
236 * drivers, set up the MMU, etc. - this means, that you cannot
237 * expect to re-enter U-Boot except by resetting the CPU.
238 * "RAMDisk Images" are more or less just data blocks, and their
239 * parameters (address, size) are passed to an OS kernel that is
240 * being started.
241 * "Multi-File Images" contain several images, typically an OS
242 * (Linux) kernel image and one or more data images like
243 * RAMDisks. This construct is useful for instance when you want
244 * to boot over the network using BOOTP etc., where the boot
245 * server provides just a single image file, but you want to get
246 * for instance an OS kernel and a RAMDisk image.
247 *
248 * "Multi-File Images" start with a list of image sizes, each
249 * image size (in bytes) specified by an "uint32_t" in network
250 * byte order. This list is terminated by an "(uint32_t)0".
251 * Immediately after the terminating 0 follow the images, one by
252 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000253 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000254 *
255 * "Firmware Images" are binary images containing firmware (like
256 * U-Boot or FPGA images) which usually will be programmed to
257 * flash memory.
258 *
259 * "Script files" are command sequences that will be executed by
260 * U-Boot's command interpreter; this feature is especially
261 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000262 * as command interpreter (=> Shell Scripts).
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900263 *
264 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100265 * New IDs *MUST* be appended at the end of the list and *NEVER*
266 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000267 */
268
Simon Glass555f45d2016-06-30 10:52:13 -0600269enum {
270 IH_TYPE_INVALID = 0, /* Invalid Image */
271 IH_TYPE_STANDALONE, /* Standalone Program */
272 IH_TYPE_KERNEL, /* OS Kernel Image */
273 IH_TYPE_RAMDISK, /* RAMDisk Image */
274 IH_TYPE_MULTI, /* Multi-File Image */
275 IH_TYPE_FIRMWARE, /* Firmware Image */
276 IH_TYPE_SCRIPT, /* Script file */
277 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
278 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
279 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
280 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
281 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
282 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
283 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
284 /* OS Kernel Image, can run from any load address */
285 IH_TYPE_KERNEL_NOLOAD,
286 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
287 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
288 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
289 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
Marek Vasut662abc42018-04-15 13:15:33 +0200290 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
Simon Glass555f45d2016-06-30 10:52:13 -0600291 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
292 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
293 IH_TYPE_LOADABLE, /* A list of typeless images */
294 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
295 IH_TYPE_RKSD, /* Rockchip SD card */
296 IH_TYPE_RKSPI, /* Rockchip SPI image */
297 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
298 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
Alexander Graf6915dcf2018-04-13 14:18:52 +0200299 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
Simon Glass555f45d2016-06-30 10:52:13 -0600300 IH_TYPE_FPGA, /* FPGA Image */
Albert ARIBAUD \(3ADEV\)ed0c2c02016-09-26 09:08:06 +0200301 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
Andrew F. Davis7e719ee2016-11-29 16:33:21 -0600302 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
Sven Ebenfeldd21bd692016-11-06 16:37:56 +0100303 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
Andrew F. Davis6442c962017-07-31 10:58:20 -0500304 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
Patrick Delaunay81260e32018-03-12 10:46:04 +0100305 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
Marek Vasut662abc42018-04-15 13:15:33 +0200306 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
Ryder Lee3b975a12018-11-15 10:07:49 +0800307 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
Stefano Babic24431ad2018-12-17 11:02:00 +0100308 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
309 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
Patrick Delaunaye7fabe72019-08-02 15:07:19 +0200310 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
wdenk5b1d7132002-11-03 00:07:02 +0000311
Simon Glass555f45d2016-06-30 10:52:13 -0600312 IH_TYPE_COUNT, /* Number of image types */
313};
Simon Glass5b9d44d2015-06-23 15:38:25 -0600314
wdenk5b1d7132002-11-03 00:07:02 +0000315/*
316 * Compression Types
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900317 *
318 * The following are exposed to uImage header.
Stefano Babic24431ad2018-12-17 11:02:00 +0100319 * New IDs *MUST* be appended at the end of the list and *NEVER*
320 * inserted for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000321 */
Simon Glass555f45d2016-06-30 10:52:13 -0600322enum {
323 IH_COMP_NONE = 0, /* No Compression Used */
324 IH_COMP_GZIP, /* gzip Compression Used */
325 IH_COMP_BZIP2, /* bzip2 Compression Used */
326 IH_COMP_LZMA, /* lzma Compression Used */
327 IH_COMP_LZO, /* lzo Compression Used */
328 IH_COMP_LZ4, /* lz4 Compression Used */
Robert Marko26073f92020-04-25 19:37:21 +0200329 IH_COMP_ZSTD, /* zstd Compression Used */
Simon Glass555f45d2016-06-30 10:52:13 -0600330
331 IH_COMP_COUNT,
332};
wdenk5b1d7132002-11-03 00:07:02 +0000333
Eugeniu Rosca829ceb22019-04-08 17:35:27 +0200334#define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
wdenk5b1d7132002-11-03 00:07:02 +0000335#define IH_MAGIC 0x27051956 /* Image Magic Number */
336#define IH_NMLEN 32 /* Image Name Length */
337
Fabio Estevam1411fb32013-01-03 08:24:33 +0000338/* Reused from common.h */
339#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
340
wdenk5b1d7132002-11-03 00:07:02 +0000341/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100342 * Legacy format image header,
343 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000344 */
wdenk5b1d7132002-11-03 00:07:02 +0000345typedef struct image_header {
Bin Meng1af5e972019-10-27 05:19:40 -0700346 uint32_t ih_magic; /* Image Header Magic Number */
347 uint32_t ih_hcrc; /* Image Header CRC Checksum */
348 uint32_t ih_time; /* Image Creation Timestamp */
349 uint32_t ih_size; /* Image Data Size */
350 uint32_t ih_load; /* Data Load Address */
351 uint32_t ih_ep; /* Entry Point Address */
352 uint32_t ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000353 uint8_t ih_os; /* Operating System */
354 uint8_t ih_arch; /* CPU architecture */
355 uint8_t ih_type; /* Image Type */
356 uint8_t ih_comp; /* Compression Type */
357 uint8_t ih_name[IH_NMLEN]; /* Image Name */
358} image_header_t;
359
Kumar Gala396f6352008-08-15 08:24:41 -0500360typedef struct image_info {
361 ulong start, end; /* start/end of blob */
362 ulong image_start, image_len; /* start of image within blob, len of image */
363 ulong load; /* load addr for the image */
364 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass90268b82014-10-19 21:11:24 -0600365 uint8_t arch; /* CPU architecture */
Kumar Gala396f6352008-08-15 08:24:41 -0500366} image_info_t;
367
Marian Balakowicz559316f2008-01-08 18:11:44 +0100368/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100369 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
370 * routines.
371 */
372typedef struct bootm_headers {
373 /*
374 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100375 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100376 * data from second and third component accordingly.
377 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200378 image_header_t *legacy_hdr_os; /* image header pointer */
379 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100380 ulong legacy_hdr_valid;
381
Simon Glass73223f02016-02-22 22:55:43 -0700382#if IMAGE_ENABLE_FIT
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100383 const char *fit_uname_cfg; /* configuration node unit name */
384
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100385 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100386 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100387 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100388
389 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100390 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
391 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100392
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100393 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100394 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
395 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass90268b82014-10-19 21:11:24 -0600396
397 void *fit_hdr_setup; /* x86 setup FIT image header */
398 const char *fit_uname_setup; /* x86 setup subimage node name */
399 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100400#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100401
Kumar Gala49c3a862008-10-21 17:25:45 -0500402#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500403 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500404 ulong ep; /* entry point of OS */
405
Kumar Galac4f94192008-08-15 08:24:37 -0500406 ulong rd_start, rd_end;/* ramdisk start/end */
407
Kumar Gala06a09912008-08-15 08:24:38 -0500408 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500409 ulong ft_len; /* length of flat device tree */
410
Kumar Gala49c3a862008-10-21 17:25:45 -0500411 ulong initrd_start;
412 ulong initrd_end;
413 ulong cmdline_start;
414 ulong cmdline_end;
Masahiro Yamadab75d8dc2020-06-26 15:13:33 +0900415 struct bd_info *kbd;
Kumar Gala49c3a862008-10-21 17:25:45 -0500416#endif
417
Simon Glass00caae62017-08-03 12:22:12 -0600418 int verify; /* env_get("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500419
420#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700421#define BOOTM_STATE_FINDOS (0x00000002)
422#define BOOTM_STATE_FINDOTHER (0x00000004)
423#define BOOTM_STATE_LOADOS (0x00000008)
424#define BOOTM_STATE_RAMDISK (0x00000010)
425#define BOOTM_STATE_FDT (0x00000020)
426#define BOOTM_STATE_OS_CMDLINE (0x00000040)
427#define BOOTM_STATE_OS_BD_T (0x00000080)
428#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700429#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
430#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500431 int state;
432
Mike Frysingera16028d2009-11-03 11:35:59 -0500433#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500434 struct lmb lmb; /* for memory mgmt */
435#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100436} bootm_headers_t;
437
Simon Schwarz1648a372012-03-15 04:01:34 +0000438extern bootm_headers_t images;
439
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100440/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100441 * Some systems (for example LWMON) have very short watchdog periods;
442 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200443 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100444 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200445#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100446#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200447#endif
448
449#ifndef CHUNKSZ_CRC32
450#define CHUNKSZ_CRC32 (64 * 1024)
451#endif
452
453#ifndef CHUNKSZ_MD5
454#define CHUNKSZ_MD5 (64 * 1024)
455#endif
456
457#ifndef CHUNKSZ_SHA1
458#define CHUNKSZ_SHA1 (64 * 1024)
459#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100460
Mike Frysinger37566092009-07-02 19:23:25 -0400461#define uimage_to_cpu(x) be32_to_cpu(x)
462#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000463
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530464/*
465 * Translation table for entries of a specific type; used by
466 * get_table_entry_id() and get_table_entry_name().
467 */
468typedef struct table_entry {
469 int id;
470 char *sname; /* short (input) name to find table entry */
471 char *lname; /* long (output) name to print for messages */
472} table_entry_t;
473
474/*
Atish Patra155d6a32020-03-05 16:24:22 -0800475 * Compression type and magic number mapping table.
476 */
477struct comp_magic_map {
478 int comp_id;
479 const char *name;
480 unsigned char magic[2];
481};
482
483/*
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530484 * get_table_entry_id() scans the translation table trying to find an
485 * entry that matches the given short name. If a matching entry is
486 * found, it's id is returned to the caller.
487 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400488int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530489 const char *table_name, const char *name);
490/*
491 * get_table_entry_name() scans the translation table trying to find
492 * an entry that matches the given id. If a matching entry is found,
493 * its long name is returned to the caller.
494 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400495char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530496
Stephen Warren712fbcf2011-10-18 11:11:49 +0000497const char *genimg_get_os_name(uint8_t os);
Simon Glasscef2e512016-02-22 22:55:50 -0700498
499/**
500 * genimg_get_os_short_name() - get the short name for an OS
501 *
502 * @param os OS (IH_OS_...)
503 * @return OS short name, or "unknown" if unknown
504 */
505const char *genimg_get_os_short_name(uint8_t comp);
506
Stephen Warren712fbcf2011-10-18 11:11:49 +0000507const char *genimg_get_arch_name(uint8_t arch);
Simon Glasscef2e512016-02-22 22:55:50 -0700508
509/**
510 * genimg_get_arch_short_name() - get the short name for an architecture
511 *
512 * @param arch Architecture type (IH_ARCH_...)
513 * @return architecture short name, or "unknown" if unknown
514 */
515const char *genimg_get_arch_short_name(uint8_t arch);
516
Stephen Warren712fbcf2011-10-18 11:11:49 +0000517const char *genimg_get_type_name(uint8_t type);
Simon Glass5b9d44d2015-06-23 15:38:25 -0600518
519/**
520 * genimg_get_type_short_name() - get the short name for an image type
521 *
522 * @param type Image type (IH_TYPE_...)
523 * @return image short name, or "unknown" if unknown
524 */
525const char *genimg_get_type_short_name(uint8_t type);
526
Stephen Warren712fbcf2011-10-18 11:11:49 +0000527const char *genimg_get_comp_name(uint8_t comp);
Simon Glasscef2e512016-02-22 22:55:50 -0700528
529/**
530 * genimg_get_comp_short_name() - get the short name for a compression method
531 *
532 * @param comp compression method (IH_COMP_...)
533 * @return compression method short name, or "unknown" if unknown
534 */
535const char *genimg_get_comp_short_name(uint8_t comp);
536
Simon Glass14262202016-06-30 10:52:16 -0600537/**
538 * genimg_get_cat_name() - Get the name of an item in a category
539 *
540 * @category: Category of item
541 * @id: Item ID
542 * @return name of item, or "Unknown ..." if unknown
543 */
544const char *genimg_get_cat_name(enum ih_category category, uint id);
545
546/**
547 * genimg_get_cat_short_name() - Get the short name of an item in a category
548 *
549 * @category: Category of item
550 * @id: Item ID
551 * @return short name of item, or "Unknown ..." if unknown
552 */
553const char *genimg_get_cat_short_name(enum ih_category category, uint id);
554
555/**
556 * genimg_get_cat_count() - Get the number of items in a category
557 *
558 * @category: Category to check
559 * @return the number of items in the category (IH_xxx_COUNT)
560 */
561int genimg_get_cat_count(enum ih_category category);
562
563/**
564 * genimg_get_cat_desc() - Get the description of a category
565 *
Naoki Hayama898a0842020-10-07 11:22:24 +0900566 * @category: Category to check
Simon Glass14262202016-06-30 10:52:16 -0600567 * @return the description of a category, e.g. "architecture". This
568 * effectively converts the enum to a string.
569 */
570const char *genimg_get_cat_desc(enum ih_category category);
571
Naoki Hayama02d41b02020-10-07 11:21:25 +0900572/**
573 * genimg_cat_has_id() - Check whether a category has an item
574 *
575 * @category: Category to check
576 * @id: Item ID
577 * @return true or false as to whether a category has an item
578 */
579bool genimg_cat_has_id(enum ih_category category, uint id);
580
Stephen Warren712fbcf2011-10-18 11:11:49 +0000581int genimg_get_os_id(const char *name);
582int genimg_get_arch_id(const char *name);
583int genimg_get_type_id(const char *name);
584int genimg_get_comp_id(const char *name);
585void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100586
Simon Glass859e92b2013-05-07 06:11:51 +0000587#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
588 defined(USE_HOSTCC)
589#define IMAGE_ENABLE_TIMESTAMP 1
590#else
591#define IMAGE_ENABLE_TIMESTAMP 0
592#endif
593void genimg_print_time(time_t timestamp);
594
Simon Glass782cfbb2013-05-16 13:53:21 +0000595/* What to do with a image load address ('load = <> 'in the FIT) */
596enum fit_load_op {
597 FIT_LOAD_IGNORED, /* Ignore load address */
598 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600599 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000600 FIT_LOAD_REQUIRED, /* Must be provided */
601};
602
Simon Glass90268b82014-10-19 21:11:24 -0600603int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
604 ulong *setup_len);
605
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100606#ifndef USE_HOSTCC
607/* Image format types, returned by _get_format() routine */
608#define IMAGE_FORMAT_INVALID 0x00
Tom Rinic76c93a2019-05-23 07:14:07 -0400609#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100610#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200611#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100612#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500613#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100614
Bryan Wu6c454fe2014-08-15 16:51:38 -0700615ulong genimg_get_kernel_addr_fit(char * const img_addr,
616 const char **fit_uname_config,
617 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700618ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000619int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000620int genimg_has_config(bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100621
Simon Glass09140112020-05-10 11:40:03 -0600622int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
623 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
624int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
625 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite84a07db2015-05-21 09:52:48 -0400626
627/**
628 * boot_get_loadable - routine to load a list of binaries to memory
629 * @argc: Ignored Argument
630 * @argv: Ignored Argument
631 * @images: pointer to the bootm images structure
632 * @arch: expected architecture for the image
633 * @ld_start: Ignored Argument
634 * @ld_len: Ignored Argument
635 *
636 * boot_get_loadable() will take the given FIT configuration, and look
637 * for a field named "loadables". Loadables, is a list of elements in
638 * the FIT given as strings. exe:
Andre Przywarab2267e82017-12-04 02:05:10 +0000639 * loadables = "linux_kernel", "fdt-2";
Karl Apsite84a07db2015-05-21 09:52:48 -0400640 * this function will attempt to parse each string, and load the
641 * corresponding element from the FIT into memory. Once placed,
642 * no aditional actions are taken.
643 *
644 * @return:
645 * 0, if only valid images or no images are found
646 * error code, if an error occurs during fit_image_load
647 */
Simon Glass09140112020-05-10 11:40:03 -0600648int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
649 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
Karl Apsite84a07db2015-05-21 09:52:48 -0400650#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100651
Simon Glass90268b82014-10-19 21:11:24 -0600652int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
653 ulong *setup_start, ulong *setup_len);
654
Simon Glass782cfbb2013-05-16 13:53:21 +0000655/**
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300656 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
657 *
658 * This deals with all aspects of loading an DTB from a FIT.
659 * The correct base image based on configuration will be selected, and
660 * then any overlays specified will be applied (as present in fit_uname_configp).
661 *
662 * @param images Boot images structure
663 * @param addr Address of FIT in memory
664 * @param fit_unamep On entry this is the requested image name
Andre Przywarab2267e82017-12-04 02:05:10 +0000665 * (e.g. "kernel") or NULL to use the default. On exit
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300666 * points to the selected image name
667 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000668 * name (e.g. "conf-1") or NULL to use the default. On
Pantelis Antoniou169043d2017-09-04 23:12:16 +0300669 * exit points to the selected configuration name.
670 * @param arch Expected architecture (IH_ARCH_...)
671 * @param datap Returns address of loaded image
672 * @param lenp Returns length of loaded image
673 *
674 * @return node offset of base image, or -ve error code on error
675 */
676int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
677 const char **fit_unamep, const char **fit_uname_configp,
678 int arch, ulong *datap, ulong *lenp);
679
680/**
Simon Glass782cfbb2013-05-16 13:53:21 +0000681 * fit_image_load() - load an image from a FIT
682 *
683 * This deals with all aspects of loading an image from a FIT, including
684 * selecting the right image based on configuration, verifying it, printing
685 * out progress messages, checking the type/arch/os and optionally copying it
686 * to the right load address.
687 *
Simon Glass126cc862014-06-12 07:24:47 -0600688 * The property to look up is defined by image_type.
689 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000690 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000691 * @param addr Address of FIT in memory
692 * @param fit_unamep On entry this is the requested image name
Andre Przywarab2267e82017-12-04 02:05:10 +0000693 * (e.g. "kernel") or NULL to use the default. On exit
Simon Glass782cfbb2013-05-16 13:53:21 +0000694 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700695 * @param fit_uname_configp On entry this is the requested configuration
Andre Przywarab2267e82017-12-04 02:05:10 +0000696 * name (e.g. "conf-1") or NULL to use the default. On
Simon Glassf320a4d2013-07-10 23:08:10 -0700697 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000698 * @param arch Expected architecture (IH_ARCH_...)
699 * @param image_type Required image type (IH_TYPE_...). If this is
700 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
701 * also.
702 * @param bootstage_id ID of starting bootstage to use for progress updates.
703 * This will be added to the BOOTSTAGE_SUB values when
704 * calling bootstage_mark()
705 * @param load_op Decribes what to do with the load address
706 * @param datap Returns address of loaded image
707 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600708 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000709 */
Simon Glass126cc862014-06-12 07:24:47 -0600710int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700711 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000712 int arch, int image_type, int bootstage_id,
713 enum fit_load_op load_op, ulong *datap, ulong *lenp);
714
Simon Glass220a3a42019-12-28 10:45:04 -0700715/**
716 * image_source_script() - Execute a script
717 *
718 * Executes a U-Boot script at a particular address in memory. The script should
719 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
720 *
721 * @addr: Address of script
722 * @fit_uname: FIT subimage name
723 * @return result code (enum command_ret_t)
724 */
725int image_source_script(ulong addr, const char *fit_uname);
726
Simon Glassce1400f2014-06-12 07:24:53 -0600727#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000728/**
729 * fit_get_node_from_config() - Look up an image a FIT by type
730 *
Andre Przywarab2267e82017-12-04 02:05:10 +0000731 * This looks in the selected conf- node (images->fit_uname_cfg) for a
Simon Glass782cfbb2013-05-16 13:53:21 +0000732 * particular image type (e.g. "kernel") and then finds the image that is
733 * referred to.
734 *
735 * For example, for something like:
736 *
737 * images {
Andre Przywarab2267e82017-12-04 02:05:10 +0000738 * kernel {
Simon Glass782cfbb2013-05-16 13:53:21 +0000739 * ...
740 * };
741 * };
742 * configurations {
Andre Przywarab2267e82017-12-04 02:05:10 +0000743 * conf-1 {
744 * kernel = "kernel";
Simon Glass782cfbb2013-05-16 13:53:21 +0000745 * };
746 * };
747 *
748 * the function will return the node offset of the kernel@1 node, assuming
Andre Przywarab2267e82017-12-04 02:05:10 +0000749 * that conf-1 is the chosen configuration.
Simon Glass782cfbb2013-05-16 13:53:21 +0000750 *
751 * @param images Boot images structure
752 * @param prop_name Property name to look up (FIT_..._PROP)
753 * @param addr Address of FIT in memory
754 */
755int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
756 ulong addr);
757
Simon Glass09140112020-05-10 11:40:03 -0600758int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
Simon Glass53f375f2013-05-16 13:53:23 +0000759 bootm_headers_t *images,
760 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000761void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000762int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500763
Stephen Warren712fbcf2011-10-18 11:11:49 +0000764int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100765 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000766int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600767#ifdef CONFIG_SYS_BOOT_GET_KBD
Masahiro Yamadab75d8dc2020-06-26 15:13:33 +0900768int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600769#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100770#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100771
772/*******************************************************************/
773/* Legacy format specific code (prefixed with image_) */
774/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000775static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100776{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000777 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100778}
779
780#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200781 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100782 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000783 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100784 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000785image_get_hdr_l(magic) /* image_get_magic */
786image_get_hdr_l(hcrc) /* image_get_hcrc */
787image_get_hdr_l(time) /* image_get_time */
788image_get_hdr_l(size) /* image_get_size */
789image_get_hdr_l(load) /* image_get_load */
790image_get_hdr_l(ep) /* image_get_ep */
791image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100792
793#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200794 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100795 { \
796 return hdr->ih_##f; \
797 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000798image_get_hdr_b(os) /* image_get_os */
799image_get_hdr_b(arch) /* image_get_arch */
800image_get_hdr_b(type) /* image_get_type */
801image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100802
Stephen Warren712fbcf2011-10-18 11:11:49 +0000803static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100804{
805 return (char *)hdr->ih_name;
806}
807
Stephen Warren712fbcf2011-10-18 11:11:49 +0000808static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100809{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000810 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100811}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100812
813/**
814 * image_get_data - get image payload start address
815 * @hdr: image header
816 *
817 * image_get_data() returns address of the image payload. For single
818 * component images it is image data start. For multi component
819 * images it points to the null terminated table of sub-images sizes.
820 *
821 * returns:
822 * image payload data start address
823 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000824static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100825{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000826 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100827}
828
Stephen Warren712fbcf2011-10-18 11:11:49 +0000829static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100830{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000831 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100832}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000833static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100834{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000835 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100836}
837
838#define image_set_hdr_l(f) \
839 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
840 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000841 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100842 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000843image_set_hdr_l(magic) /* image_set_magic */
844image_set_hdr_l(hcrc) /* image_set_hcrc */
845image_set_hdr_l(time) /* image_set_time */
846image_set_hdr_l(size) /* image_set_size */
847image_set_hdr_l(load) /* image_set_load */
848image_set_hdr_l(ep) /* image_set_ep */
849image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100850
851#define image_set_hdr_b(f) \
852 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
853 { \
854 hdr->ih_##f = val; \
855 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000856image_set_hdr_b(os) /* image_set_os */
857image_set_hdr_b(arch) /* image_set_arch */
858image_set_hdr_b(type) /* image_set_type */
859image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100860
Stephen Warren712fbcf2011-10-18 11:11:49 +0000861static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100862{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000863 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100864}
865
Stephen Warren712fbcf2011-10-18 11:11:49 +0000866int image_check_hcrc(const image_header_t *hdr);
867int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100868#ifndef USE_HOSTCC
Simon Glass723806c2017-08-03 12:22:15 -0600869ulong env_get_bootm_low(void);
870phys_size_t env_get_bootm_size(void);
871phys_size_t env_get_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100872#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600873void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100874
Stephen Warren712fbcf2011-10-18 11:11:49 +0000875static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100876{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000877 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100878}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000879static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100880{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000881 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100882}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000883static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100884{
Alison Wang4ac0a322017-06-06 15:32:40 +0800885 return (image_get_arch(hdr) == arch) ||
886 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100887}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000888static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100889{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000890 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100891}
892
Stephen Warren712fbcf2011-10-18 11:11:49 +0000893ulong image_multi_count(const image_header_t *hdr);
894void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100895 ulong *data, ulong *len);
896
Stephen Warren712fbcf2011-10-18 11:11:49 +0000897void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100898
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100899#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000900static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100901{
Mike Frysinger476af292011-10-03 14:50:33 +0000902#ifndef IH_ARCH_DEFAULT
903# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100904#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000905 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100906}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100907#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100908
Simon Glass13d06982013-05-08 08:06:01 +0000909/**
Atish Patra155d6a32020-03-05 16:24:22 -0800910 * image_decomp_type() - Find out compression type of an image
911 *
912 * @buf: Address in U-Boot memory where image is loaded.
913 * @len: Length of the compressed image.
914 * @return compression type or IH_COMP_NONE if not compressed.
915 *
916 * Note: Only following compression types are supported now.
917 * lzo, lzma, gzip, bzip2
918 */
919int image_decomp_type(const unsigned char *buf, ulong len);
920
921/**
Julius Werner20908542019-07-24 19:37:54 -0700922 * image_decomp() - decompress an image
923 *
924 * @comp: Compression algorithm that is used (IH_COMP_...)
925 * @load: Destination load address in U-Boot memory
926 * @image_start Image start address (where we are decompressing from)
927 * @type: OS type (IH_OS_...)
928 * @load_bug: Place to decompress to
929 * @image_buf: Address to decompress from
930 * @image_len: Number of bytes in @image_buf to decompress
931 * @unc_len: Available space for decompression
932 * @return 0 if OK, -ve on error (BOOTM_ERR_...)
933 */
934int image_decomp(int comp, ulong load, ulong image_start, int type,
935 void *load_buf, void *image_buf, ulong image_len,
936 uint unc_len, ulong *load_end);
937
938/**
Simon Glass13d06982013-05-08 08:06:01 +0000939 * Set up properties in the FDT
940 *
941 * This sets up properties in the FDT that is to be passed to linux.
942 *
943 * @images: Images information
944 * @blob: FDT to update
945 * @of_size: Size of the FDT
946 * @lmb: Points to logical memory block structure
947 * @return 0 if ok, <0 on failure
948 */
949int image_setup_libfdt(bootm_headers_t *images, void *blob,
950 int of_size, struct lmb *lmb);
951
952/**
953 * Set up the FDT to use for booting a kernel
954 *
955 * This performs ramdisk setup, sets up the FDT if required, and adds
956 * paramters to the FDT if libfdt is available.
957 *
958 * @param images Images information
959 * @return 0 if ok, <0 on failure
960 */
961int image_setup_linux(bootm_headers_t *images);
962
Simon Glassa5266d62013-07-04 13:26:10 -0700963/**
964 * bootz_setup() - Extract stat and size of a Linux xImage
965 *
966 * @image: Address of image
967 * @start: Returns start address of image
968 * @end : Returns end address of image
969 * @return 0 if OK, 1 if the image was not recognised
970 */
971int bootz_setup(ulong image, ulong *start, ulong *end);
972
Bin Chen6808ef92018-01-27 16:59:09 +1100973/**
974 * Return the correct start address and size of a Linux aarch64 Image.
975 *
976 * @image: Address of image
977 * @start: Returns start address of image
978 * @size : Returns size image
Marek Vasut7f13b372018-06-13 06:13:32 +0200979 * @force_reloc: Ignore image->ep field, always place image to RAM start
Bin Chen6808ef92018-01-27 16:59:09 +1100980 * @return 0 if OK, 1 if the image was not recognised
981 */
Marek Vasut7f13b372018-06-13 06:13:32 +0200982int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
983 bool force_reloc);
Simon Glassa5266d62013-07-04 13:26:10 -0700984
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100985/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100986/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100987/*******************************************************************/
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100988
989#define FIT_IMAGES_PATH "/images"
990#define FIT_CONFS_PATH "/configurations"
991
Simon Glass72188f52020-03-18 11:44:06 -0600992/* hash/signature/key node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100993#define FIT_HASH_NODENAME "hash"
994#define FIT_ALGO_PROP "algo"
995#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000996#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700997#define FIT_SIG_NODENAME "signature"
Simon Glass72188f52020-03-18 11:44:06 -0600998#define FIT_KEY_REQUIRED "required"
999#define FIT_KEY_HINT "key-name-hint"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001000
Philippe Reynes7298e422019-12-18 18:25:41 +01001001/* cipher node */
1002#define FIT_CIPHER_NODENAME "cipher"
1003#define FIT_ALGO_PROP "algo"
1004
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001005/* image node */
1006#define FIT_DATA_PROP "data"
Peng Fana1be94b2017-12-05 13:20:59 +08001007#define FIT_DATA_POSITION_PROP "data-position"
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001008#define FIT_DATA_OFFSET_PROP "data-offset"
1009#define FIT_DATA_SIZE_PROP "data-size"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001010#define FIT_TIMESTAMP_PROP "timestamp"
1011#define FIT_DESC_PROP "description"
1012#define FIT_ARCH_PROP "arch"
1013#define FIT_TYPE_PROP "type"
1014#define FIT_OS_PROP "os"
1015#define FIT_COMP_PROP "compression"
1016#define FIT_ENTRY_PROP "entry"
1017#define FIT_LOAD_PROP "load"
1018
1019/* configuration node */
1020#define FIT_KERNEL_PROP "kernel"
1021#define FIT_RAMDISK_PROP "ramdisk"
1022#define FIT_FDT_PROP "fdt"
Karl Apsiteecf8cd62015-05-21 09:52:47 -04001023#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001024#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -06001025#define FIT_SETUP_PROP "setup"
Michal Simeked0cea72016-05-17 13:58:44 +02001026#define FIT_FPGA_PROP "fpga"
Michal Simek1f8e4bf2018-03-26 16:31:26 +02001027#define FIT_FIRMWARE_PROP "firmware"
Marek Vasut0298d202018-05-13 00:22:54 +02001028#define FIT_STANDALONE_PROP "standalone"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001029
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +02001030#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001031
Simon Glassf1dcee52016-02-22 22:55:56 -07001032#if IMAGE_ENABLE_FIT
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001033/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +00001034int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001035 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +00001036int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001037 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001038
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -02001039int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001040void fit_print_contents(const void *fit);
1041void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001042
1043/**
1044 * fit_get_end - get FIT image size
1045 * @fit: pointer to the FIT format image header
1046 *
1047 * returns:
1048 * size of the FIT image (blob) in memory
1049 */
Stephen Warren712fbcf2011-10-18 11:11:49 +00001050static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001051{
Stephen Warren712fbcf2011-10-18 11:11:49 +00001052 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001053}
1054
1055/**
1056 * fit_get_end - get FIT image end
1057 * @fit: pointer to the FIT format image header
1058 *
1059 * returns:
1060 * end address of the FIT image (blob) in memory
1061 */
Simon Glass7a80de42016-02-24 09:14:42 -07001062ulong fit_get_end(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001063
1064/**
1065 * fit_get_name - get FIT node name
1066 * @fit: pointer to the FIT format image header
1067 *
1068 * returns:
1069 * NULL, on error
1070 * pointer to node name, on success
1071 */
Stephen Warren712fbcf2011-10-18 11:11:49 +00001072static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001073 int noffset, int *len)
1074{
Stephen Warren712fbcf2011-10-18 11:11:49 +00001075 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001076}
1077
Stephen Warren712fbcf2011-10-18 11:11:49 +00001078int fit_get_desc(const void *fit, int noffset, char **desc);
1079int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001080
Stephen Warren712fbcf2011-10-18 11:11:49 +00001081int fit_image_get_node(const void *fit, const char *image_uname);
1082int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1083int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1084int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1085int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1086int fit_image_get_load(const void *fit, int noffset, ulong *load);
1087int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1088int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001089 const void **data, size_t *size);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001090int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
Peng Fana1be94b2017-12-05 13:20:59 +08001091int fit_image_get_data_position(const void *fit, int noffset,
1092 int *data_position);
tomas.melin@vaisala.comdb1b79b2017-01-13 13:20:14 +02001093int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
Philippe Reynes4df35782019-12-18 18:25:42 +01001094int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1095 size_t *data_size);
Kelvin Cheungc3c86382018-05-19 18:21:37 +08001096int fit_image_get_data_and_size(const void *fit, int noffset,
1097 const void **data, size_t *size);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001098
Stephen Warren712fbcf2011-10-18 11:11:49 +00001099int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1100int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001101 int *value_len);
1102
Stephen Warren712fbcf2011-10-18 11:11:49 +00001103int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +00001104
Philippe Reynes7298e422019-12-18 18:25:41 +01001105int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1106 const char *comment, int require_keys,
1107 const char *engine_id, const char *cmdname);
1108
Simon Glassbbb467d2013-05-07 06:12:01 +00001109/**
Simon Glass56518e72013-06-13 15:10:01 -07001110 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +00001111 *
Simon Glass56518e72013-06-13 15:10:01 -07001112 * @keydir: Directory containing keys
1113 * @kwydest: FDT blob to write public key information to
1114 * @fit: Pointer to the FIT format image header
1115 * @comment: Comment to add to signature nodes
1116 * @require_keys: Mark all keys as 'required'
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001117 * @engine_id: Engine to use for signing
Alex Kiernan795f4522018-06-20 20:10:52 +00001118 * @cmdname: Command name used when reporting errors
Simon Glass56518e72013-06-13 15:10:01 -07001119 *
1120 * Adds hash values for all component images in the FIT blob.
1121 * Hashes are calculated for all component images which have hash subnodes
1122 * with algorithm property set to one of the supported hash algorithms.
1123 *
1124 * Also add signatures if signature nodes are present.
1125 *
1126 * returns
1127 * 0, on success
1128 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +00001129 */
Simon Glass56518e72013-06-13 15:10:01 -07001130int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001131 const char *comment, int require_keys,
Alex Kiernan795f4522018-06-20 20:10:52 +00001132 const char *engine_id, const char *cmdname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001133
Jun Nie5c643db2018-02-27 16:55:58 +08001134int fit_image_verify_with_data(const void *fit, int image_noffset,
1135 const void *data, size_t size);
Simon Glassb8da8362013-05-07 06:11:57 +00001136int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +00001137int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +00001138int fit_all_image_verify(const void *fit);
Philippe Reynes4df35782019-12-18 18:25:42 +01001139int fit_config_decrypt(const void *fit, int conf_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +00001140int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1141int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1142int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1143int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1144int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001145
Gabe Blackd95f6ec2012-10-25 16:31:10 +00001146int fit_conf_find_compat(const void *fit, const void *fdt);
Simon Glass390b26d2020-03-18 11:43:55 -06001147
1148/**
1149 * fit_conf_get_node - get node offset for configuration of a given unit name
1150 * @fit: pointer to the FIT format image header
1151 * @conf_uname: configuration node unit name (NULL to use default)
1152 *
1153 * fit_conf_get_node() finds a configuration (within the '/configurations'
1154 * parent node) of a provided unit name. If configuration is found its node
1155 * offset is returned to the caller.
1156 *
1157 * When NULL is provided in second argument fit_conf_get_node() will search
1158 * for a default configuration node instead. Default configuration node unit
1159 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1160 * node.
1161 *
1162 * returns:
1163 * configuration node offset when found (>=0)
1164 * negative number on failure (FDT_ERR_* code)
1165 */
Stephen Warren712fbcf2011-10-18 11:11:49 +00001166int fit_conf_get_node(const void *fit, const char *conf_uname);
Simon Glass390b26d2020-03-18 11:43:55 -06001167
Tien Fong Chee0a42a132019-05-07 17:42:28 +08001168int fit_conf_get_prop_node_count(const void *fit, int noffset,
1169 const char *prop_name);
1170int fit_conf_get_prop_node_index(const void *fit, int noffset,
1171 const char *prop_name, int index);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001172
Simon Glass003efd72013-05-07 06:12:00 +00001173/**
1174 * fit_conf_get_prop_node() - Get node refered to by a configuration
1175 * @fit: FIT to check
1176 * @noffset: Offset of conf@xxx node to check
1177 * @prop_name: Property to read from the conf node
1178 *
Andre Przywarab2267e82017-12-04 02:05:10 +00001179 * The conf- nodes contain references to other nodes, using properties
1180 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
Simon Glass003efd72013-05-07 06:12:00 +00001181 * return the offset of the node referred to (e.g. offset of node
Andre Przywarab2267e82017-12-04 02:05:10 +00001182 * "/images/kernel".
Simon Glass003efd72013-05-07 06:12:00 +00001183 */
1184int fit_conf_get_prop_node(const void *fit, int noffset,
1185 const char *prop_name);
1186
Simon Glass61a439a2013-05-07 06:11:52 +00001187int fit_check_ramdisk(const void *fit, int os_noffset,
1188 uint8_t arch, int verify);
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001189#endif /* IMAGE_ENABLE_FIT */
Simon Glass61a439a2013-05-07 06:11:52 +00001190
Simon Glass604f23d2013-05-07 06:11:54 +00001191int calculate_hash(const void *data, int data_len, const char *algo,
1192 uint8_t *value, int *value_len);
1193
Simon Glass782cfbb2013-05-16 13:53:21 +00001194/*
Simon Glass3e569a62013-06-13 15:10:00 -07001195 * At present we only support signing on the host, and verification on the
1196 * device
Simon Glass782cfbb2013-05-16 13:53:21 +00001197 */
Alex Kiernan89665f22019-04-18 20:34:55 +00001198#if defined(USE_HOSTCC)
1199# if defined(CONFIG_FIT_SIGNATURE)
Simon Glass3e569a62013-06-13 15:10:00 -07001200# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +01001201# define IMAGE_ENABLE_VERIFY 1
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001202# define FIT_IMAGE_ENABLE_VERIFY 1
Alex Kiernan89665f22019-04-18 20:34:55 +00001203# include <openssl/evp.h>
1204# else
Simon Glass3e569a62013-06-13 15:10:00 -07001205# define IMAGE_ENABLE_SIGN 0
Alex Kiernan89665f22019-04-18 20:34:55 +00001206# define IMAGE_ENABLE_VERIFY 0
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001207# define FIT_IMAGE_ENABLE_VERIFY 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001208# endif
1209#else
Simon Glass3e569a62013-06-13 15:10:00 -07001210# define IMAGE_ENABLE_SIGN 0
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001211# define IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(RSA_VERIFY)
1212# define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
Simon Glass782cfbb2013-05-16 13:53:21 +00001213#endif
1214
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001215#if IMAGE_ENABLE_FIT
Simon Glass782cfbb2013-05-16 13:53:21 +00001216#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +01001217void *image_get_host_blob(void);
1218void image_set_host_blob(void *host_blob);
1219# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +00001220#else
1221# define gd_fdt_blob() (gd->fdt_blob)
1222#endif
1223
1224#ifdef CONFIG_FIT_BEST_MATCH
1225#define IMAGE_ENABLE_BEST_MATCH 1
1226#else
1227#define IMAGE_ENABLE_BEST_MATCH 0
1228#endif
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001229#endif /* IMAGE_ENABLE_FIT */
Simon Glass782cfbb2013-05-16 13:53:21 +00001230
Simon Glass3e569a62013-06-13 15:10:00 -07001231/* Information passed to the signing routines */
1232struct image_sign_info {
1233 const char *keydir; /* Directory conaining keys */
1234 const char *keyname; /* Name of key to use */
1235 void *fit; /* Pointer to FIT blob */
1236 int node_offset; /* Offset of signature node */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001237 const char *name; /* Algorithm name */
1238 struct checksum_algo *checksum; /* Checksum algorithm information */
Philippe Reynes20031562018-11-14 13:51:00 +01001239 struct padding_algo *padding; /* Padding algorithm information */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001240 struct crypto_algo *crypto; /* Crypto algorithm information */
Simon Glass3e569a62013-06-13 15:10:00 -07001241 const void *fdt_blob; /* FDT containing public keys */
1242 int required_keynode; /* Node offset of key to use: -1=any */
1243 const char *require_keys; /* Value for 'required' property */
George McCollisterf1ca1fd2017-01-06 13:14:17 -06001244 const char *engine_id; /* Engine to use for signing */
AKASHI Takahiroa8fc3df2020-02-21 15:12:57 +09001245 /*
1246 * Note: the following two fields are always valid even w/o
1247 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1248 * the same on target and host. Otherwise, vboot test may fail.
1249 */
1250 const void *key; /* Pointer to public key in DER */
1251 int keylen; /* Length of public key */
Simon Glass3e569a62013-06-13 15:10:00 -07001252};
Philippe Reynes7298e422019-12-18 18:25:41 +01001253
Simon Glass3e569a62013-06-13 15:10:00 -07001254/* A part of an image, used for hashing */
1255struct image_region {
1256 const void *data;
1257 int size;
1258};
1259
Heiko Schocher646257d2014-03-03 12:19:26 +01001260#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +02001261# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +01001262#endif
1263struct checksum_algo {
1264 const char *name;
1265 const int checksum_len;
Andrew Dudada29f292016-11-08 18:53:40 +00001266 const int der_len;
1267 const uint8_t *der_prefix;
Heiko Schocher646257d2014-03-03 12:19:26 +01001268#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +01001269 const EVP_MD *(*calculate_sign)(void);
1270#endif
Ruchika Guptab37b46f2015-01-23 16:01:59 +05301271 int (*calculate)(const char *name,
1272 const struct image_region region[],
1273 int region_count, uint8_t *checksum);
Heiko Schocher646257d2014-03-03 12:19:26 +01001274};
1275
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001276struct crypto_algo {
Simon Glass3e569a62013-06-13 15:10:00 -07001277 const char *name; /* Name of algorithm */
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001278 const int key_len;
Simon Glass3e569a62013-06-13 15:10:00 -07001279
1280 /**
1281 * sign() - calculate and return signature for given input data
1282 *
1283 * @info: Specifies key and FIT information
1284 * @data: Pointer to the input data
1285 * @data_len: Data length
1286 * @sigp: Set to an allocated buffer holding the signature
1287 * @sig_len: Set to length of the calculated hash
1288 *
1289 * This computes input data signature according to selected algorithm.
1290 * Resulting signature value is placed in an allocated buffer, the
1291 * pointer is returned as *sigp. The length of the calculated
1292 * signature is returned via the sig_len pointer argument. The caller
1293 * should free *sigp.
1294 *
1295 * @return: 0, on success, -ve on error
1296 */
1297 int (*sign)(struct image_sign_info *info,
1298 const struct image_region region[],
1299 int region_count, uint8_t **sigp, uint *sig_len);
1300
1301 /**
1302 * add_verify_data() - Add verification information to FDT
1303 *
1304 * Add public key information to the FDT node, suitable for
1305 * verification at run-time. The information added depends on the
1306 * algorithm being used.
1307 *
1308 * @info: Specifies key and FIT information
1309 * @keydest: Destination FDT blob for public key data
1310 * @return: 0, on success, -ve on error
1311 */
1312 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1313
1314 /**
1315 * verify() - Verify a signature against some data
1316 *
1317 * @info: Specifies key and FIT information
1318 * @data: Pointer to the input data
1319 * @data_len: Data length
1320 * @sig: Signature
1321 * @sig_len: Number of bytes in signature
1322 * @return 0 if verified, -ve on error
1323 */
1324 int (*verify)(struct image_sign_info *info,
1325 const struct image_region region[], int region_count,
1326 uint8_t *sig, uint sig_len);
Andrew Duda0c1d74f2016-11-08 18:53:41 +00001327};
Heiko Schocher646257d2014-03-03 12:19:26 +01001328
Philippe Reynes20031562018-11-14 13:51:00 +01001329struct padding_algo {
1330 const char *name;
1331 int (*verify)(struct image_sign_info *info,
1332 uint8_t *pad, int pad_len,
1333 const uint8_t *hash, int hash_len);
1334};
1335
Simon Glass3e569a62013-06-13 15:10:00 -07001336/**
Andrew Duda83dd98e2016-11-08 18:53:41 +00001337 * image_get_checksum_algo() - Look up a checksum algorithm
Simon Glass3e569a62013-06-13 15:10:00 -07001338 *
Andrew Duda83dd98e2016-11-08 18:53:41 +00001339 * @param full_name Name of algorithm in the form "checksum,crypto"
Simon Glass3e569a62013-06-13 15:10:00 -07001340 * @return pointer to algorithm information, or NULL if not found
1341 */
Andrew Duda83dd98e2016-11-08 18:53:41 +00001342struct checksum_algo *image_get_checksum_algo(const char *full_name);
1343
1344/**
1345 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1346 *
1347 * @param full_name Name of algorithm in the form "checksum,crypto"
1348 * @return pointer to algorithm information, or NULL if not found
1349 */
1350struct crypto_algo *image_get_crypto_algo(const char *full_name);
Simon Glass3e569a62013-06-13 15:10:00 -07001351
Simon Glass56518e72013-06-13 15:10:01 -07001352/**
Philippe Reynes20031562018-11-14 13:51:00 +01001353 * image_get_padding_algo() - Look up a padding algorithm
1354 *
1355 * @param name Name of padding algorithm
1356 * @return pointer to algorithm information, or NULL if not found
1357 */
1358struct padding_algo *image_get_padding_algo(const char *name);
1359
AKASHI Takahirob983cc22020-02-21 15:12:55 +09001360#if IMAGE_ENABLE_FIT
1361
Philippe Reynes20031562018-11-14 13:51:00 +01001362/**
Simon Glass56518e72013-06-13 15:10:01 -07001363 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1364 *
1365 * @fit: FIT to check
1366 * @image_noffset: Offset of image node to check
1367 * @data: Image data to check
1368 * @size: Size of image data
1369 * @sig_blob: FDT containing public keys
1370 * @no_sigsp: Returns 1 if no signatures were required, and
1371 * therefore nothing was checked. The caller may wish
1372 * to fall back to other mechanisms, or refuse to
1373 * boot.
1374 * @return 0 if all verified ok, <0 on error
1375 */
1376int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1377 const char *data, size_t size, const void *sig_blob,
1378 int *no_sigsp);
1379
1380/**
1381 * fit_image_check_sig() - Check a single image signature node
1382 *
1383 * @fit: FIT to check
1384 * @noffset: Offset of signature node to check
1385 * @data: Image data to check
1386 * @size: Size of image data
1387 * @required_keynode: Offset in the control FDT of the required key node,
1388 * if any. If this is given, then the image wil not
1389 * pass verification unless that key is used. If this is
1390 * -1 then any signature will do.
1391 * @err_msgp: In the event of an error, this will be pointed to a
1392 * help error string to display to the user.
1393 * @return 0 if all verified ok, <0 on error
1394 */
1395int fit_image_check_sig(const void *fit, int noffset, const void *data,
1396 size_t size, int required_keynode, char **err_msgp);
1397
Philippe Reynes4df35782019-12-18 18:25:42 +01001398int fit_image_decrypt_data(const void *fit,
1399 int image_noffset, int cipher_noffset,
1400 const void *data, size_t size,
1401 void **data_unciphered, size_t *size_unciphered);
1402
Simon Glass4d098522013-06-13 15:10:09 -07001403/**
1404 * fit_region_make_list() - Make a list of regions to hash
1405 *
1406 * Given a list of FIT regions (offset, size) provided by libfdt, create
1407 * a list of regions (void *, size) for use by the signature creationg
1408 * and verification code.
1409 *
1410 * @fit: FIT image to process
1411 * @fdt_regions: Regions as returned by libfdt
1412 * @count: Number of regions returned by libfdt
1413 * @region: Place to put list of regions (NULL to allocate it)
1414 * @return pointer to list of regions, or NULL if out of memory
1415 */
1416struct image_region *fit_region_make_list(const void *fit,
1417 struct fdt_region *fdt_regions, int count,
1418 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001419
Stephen Warren712fbcf2011-10-18 11:11:49 +00001420static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001421{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001422#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001423 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001424#else
1425 return 0;
1426#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001427}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001428
Philippe Reynes7298e422019-12-18 18:25:41 +01001429/*
1430 * At present we only support ciphering on the host, and unciphering on the
1431 * device
1432 */
1433#if defined(USE_HOSTCC)
1434# if defined(CONFIG_FIT_CIPHER)
1435# define IMAGE_ENABLE_ENCRYPT 1
1436# define IMAGE_ENABLE_DECRYPT 1
1437# include <openssl/evp.h>
1438# else
1439# define IMAGE_ENABLE_ENCRYPT 0
1440# define IMAGE_ENABLE_DECRYPT 0
1441# endif
1442#else
1443# define IMAGE_ENABLE_ENCRYPT 0
1444# define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1445#endif
1446
1447/* Information passed to the ciphering routines */
1448struct image_cipher_info {
1449 const char *keydir; /* Directory containing keys */
1450 const char *keyname; /* Name of key to use */
1451 const char *ivname; /* Name of IV to use */
1452 const void *fit; /* Pointer to FIT blob */
1453 int node_noffset; /* Offset of the cipher node */
1454 const char *name; /* Algorithm name */
1455 struct cipher_algo *cipher; /* Cipher algorithm information */
1456 const void *fdt_blob; /* FDT containing key and IV */
1457 const void *key; /* Value of the key */
1458 const void *iv; /* Value of the IV */
1459 size_t size_unciphered; /* Size of the unciphered data */
1460};
1461
1462struct cipher_algo {
1463 const char *name; /* Name of algorithm */
1464 int key_len; /* Length of the key */
1465 int iv_len; /* Length of the IV */
1466
1467#if IMAGE_ENABLE_ENCRYPT
1468 const EVP_CIPHER * (*calculate_type)(void);
1469#endif
1470
1471 int (*encrypt)(struct image_cipher_info *info,
1472 const unsigned char *data, int data_len,
1473 unsigned char **cipher, int *cipher_len);
1474
1475 int (*add_cipher_data)(struct image_cipher_info *info,
Philippe Reynesa6982a62020-09-17 15:01:46 +02001476 void *keydest, void *fit, int node_noffset);
Philippe Reynes4df35782019-12-18 18:25:42 +01001477
1478 int (*decrypt)(struct image_cipher_info *info,
1479 const void *cipher, size_t cipher_len,
1480 void **data, size_t *data_len);
Philippe Reynes7298e422019-12-18 18:25:41 +01001481};
1482
1483int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1484
1485struct cipher_algo *image_get_cipher_algo(const char *full_name);
1486
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001487#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001488#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001489 "FIT images not supported for '%s'\n", \
1490 __FILE__, __LINE__, (msg))
1491
Stephen Warren712fbcf2011-10-18 11:11:49 +00001492#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001493 "FIT images not supported for '%s' " \
1494 "- must reset board to recover!\n", \
1495 __FILE__, __LINE__, (msg))
1496#else
1497#define fit_unsupported(msg)
1498#define fit_unsupported_reset(msg)
1499#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001500#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001501
Eugeniu Roscad08b16e2020-03-08 01:11:18 +01001502#if !defined(USE_HOSTCC)
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001503#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1504struct andr_img_hdr;
1505int android_image_check_header(const struct andr_img_hdr *hdr);
1506int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1507 ulong *os_data, ulong *os_len);
1508int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1509 ulong *rd_data, ulong *rd_len);
Bin Chen10481612018-01-27 16:59:08 +11001510int android_image_get_second(const struct andr_img_hdr *hdr,
1511 ulong *second_data, ulong *second_len);
Sam Protsenko7f253152020-01-24 17:53:41 +02001512bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
Sam Protsenkoc3bfad82020-01-24 17:53:40 +02001513bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1514 u32 *size);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001515ulong android_image_get_end(const struct andr_img_hdr *hdr);
1516ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Eugeniu Rosca829ceb22019-04-08 17:35:27 +02001517ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
Michael Trimarchi4f1318b2016-06-10 19:54:37 +02001518void android_print_contents(const struct andr_img_hdr *hdr);
Sam Protsenkoc3bfad82020-01-24 17:53:40 +02001519#if !defined(CONFIG_SPL_BUILD)
1520bool android_image_print_dtb_contents(ulong hdr_addr);
1521#endif
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001522
1523#endif /* CONFIG_ANDROID_BOOT_IMAGE */
Eugeniu Roscad08b16e2020-03-08 01:11:18 +01001524#endif /* !USE_HOSTCC */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001525
Simon Glass4b307f22016-02-22 22:55:55 -07001526/**
1527 * board_fit_config_name_match() - Check for a matching board name
1528 *
1529 * This is used when SPL loads a FIT containing multiple device tree files
1530 * and wants to work out which one to use. The description of each one is
1531 * passed to this function. The description comes from the 'description' field
1532 * in each (FDT) image node.
1533 *
1534 * @name: Device tree description
1535 * @return 0 if this device tree should be used, non-zero to try the next
1536 */
1537int board_fit_config_name_match(const char *name);
1538
Madan Srinivasa5c7e412017-04-07 10:00:02 -05001539#if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1540 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
Daniel Allredda74d1f2016-06-27 09:19:21 -05001541/**
1542 * board_fit_image_post_process() - Do any post-process on FIT binary data
1543 *
1544 * This is used to do any sort of image manipulation, verification, decryption
1545 * etc. in a platform or board specific way. Obviously, anything done here would
1546 * need to be comprehended in how the images were prepared before being injected
1547 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1548 * before being added to the FIT image).
1549 *
1550 * @image: pointer to the image start pointer
1551 * @size: pointer to the image size
1552 * @return no return value (failure should be handled internally)
1553 */
1554void board_fit_image_post_process(void **p_image, size_t *p_size);
1555#endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1556
Cooper Jr., Franklin3863f842017-06-16 17:25:05 -05001557#define FDT_ERROR ((ulong)(-1))
1558
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001559ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
Jean-Jacques Hiblot02035d02017-09-15 12:57:27 +02001560
1561/**
1562 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1563 *
1564 * A FIT image contains one or more DTBs. This function parses the
1565 * configurations described in the FIT images and returns the node of
1566 * the first matching DTB. To check if a DTB matches a board, this function
1567 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1568 * the node described by the default configuration if it exists.
1569 *
1570 * @fdt: pointer to flat device tree
1571 * @return the node if found, -ve otherwise
1572 */
Cooper Jr., Franklin92926bc2017-06-16 17:25:06 -05001573int fit_find_config_node(const void *fdt);
1574
Andrew F. Davisd7be5092016-11-29 16:33:20 -06001575/**
1576 * Mapping of image types to function handlers to be invoked on the associated
1577 * loaded images
1578 *
1579 * @type: Type of image, I.E. IH_TYPE_*
1580 * @handler: Function to call on loaded image
1581 */
1582struct fit_loadable_tbl {
1583 int type;
1584 /**
1585 * handler() - Process a loaded image
1586 *
1587 * @data: Pointer to start of loaded image data
1588 * @size: Size of loaded image data
1589 */
1590 void (*handler)(ulong data, size_t size);
1591};
1592
1593/*
1594 * Define a FIT loadable image type handler
1595 *
1596 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1597 * _handler is the handler function to call after this image type is loaded
1598 */
1599#define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1600 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1601 .type = _type, \
1602 .handler = _handler, \
1603 }
1604
AKASHI Takahiro3149e522020-10-29 13:47:43 +09001605/**
1606 * fit_update - update storage with FIT image
1607 * @fit: Pointer to FIT image
1608 *
1609 * Update firmware on storage using FIT image as input.
1610 * The storage area to be update will be identified by the name
1611 * in FIT and matching it to "dfu_alt_info" variable.
1612 *
1613 * Return: 0 on success, non-zero otherwise
1614 */
1615int fit_update(const void *fit);
1616
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001617#endif /* __IMAGE_H__ */