blob: 734def31178438b758404f3daba40b63cd1b31dc [file] [log] [blame]
wdenk5b1d7132002-11-03 00:07:02 +00001/*
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01002 * (C) Copyright 2008 Semihalf
3 *
Wolfgang Denkf08abe32005-11-25 16:38:03 +01004 * (C) Copyright 2000-2005
wdenk5b1d7132002-11-03 00:07:02 +00005 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02007 * SPDX-License-Identifier: GPL-2.0+
Wolfgang Denkf08abe32005-11-25 16:38:03 +01008 ********************************************************************
9 * NOTE: This header file defines an interface to U-Boot. Including
10 * this (unmodified) header file in another file is considered normal
11 * use of U-Boot, and does *not* fall under the heading of "derived
12 * work".
13 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000014 */
15
16#ifndef __IMAGE_H__
17#define __IMAGE_H__
18
Mike Frysinger37566092009-07-02 19:23:25 -040019#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000020#include <asm/byteorder.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;
24
Mike Frysinger37566092009-07-02 19:23:25 -040025#ifdef USE_HOSTCC
Jörg Krause26e355d2015-04-22 21:36:22 +020026#include <sys/types.h>
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010027
28/* new uImage format support enabled on host */
Simon Glassaa34fbc2016-02-22 22:55:45 -070029#define IMAGE_ENABLE_FIT 1
30#define IMAGE_ENABLE_OF_LIBFDT 1
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010031#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
32
Simon Glassab9efc62013-05-07 06:11:58 +000033#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000034#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000035
Wolfgang Denkdef08192008-10-21 11:23:56 +020036#else
37
38#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020039#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050040#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020041
Simon Glassab9efc62013-05-07 06:11:58 +000042/* Take notice of the 'ignore' property for hashes */
43#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000044#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000045
Simon Glassaa34fbc2016-02-22 22:55:45 -070046#define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
47#define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
Simon Glass73223f02016-02-22 22:55:43 -070048
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010049#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010050
Simon Glass73223f02016-02-22 22:55:43 -070051#if IMAGE_ENABLE_FIT
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020052#include <hash.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010053#include <libfdt.h>
54#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000055# ifdef CONFIG_SPL_BUILD
Masahiro Yamada6f417512016-05-31 20:41:54 +090056# ifdef CONFIG_SPL_CRC32_SUPPORT
57# define IMAGE_ENABLE_CRC32 1
58# endif
59# ifdef CONFIG_SPL_MD5_SUPPORT
60# define IMAGE_ENABLE_MD5 1
61# endif
62# ifdef CONFIG_SPL_SHA1_SUPPORT
63# define IMAGE_ENABLE_SHA1 1
64# endif
65# ifdef CONFIG_SPL_SHA256_SUPPORT
66# define IMAGE_ENABLE_SHA256 1
67# endif
Simon Glass87ebee32013-05-08 08:05:59 +000068# else
69# define CONFIG_CRC32 /* FIT images need CRC32 support */
70# define CONFIG_MD5 /* and MD5 */
71# define CONFIG_SHA1 /* and SHA1 */
Heiko Schocher2842c1c2014-03-03 12:19:25 +010072# define CONFIG_SHA256 /* and SHA256 */
Simon Glass87ebee32013-05-08 08:05:59 +000073# define IMAGE_ENABLE_CRC32 1
74# define IMAGE_ENABLE_MD5 1
75# define IMAGE_ENABLE_SHA1 1
Heiko Schocher2842c1c2014-03-03 12:19:25 +010076# define IMAGE_ENABLE_SHA256 1
Simon Glass87ebee32013-05-08 08:05:59 +000077# endif
Masahiro Yamada6f417512016-05-31 20:41:54 +090078
79#ifdef CONFIG_FIT_DISABLE_SHA256
80#undef CONFIG_SHA256
81#undef IMAGE_ENABLE_SHA256
82#endif
83
84#ifndef IMAGE_ENABLE_CRC32
85#define IMAGE_ENABLE_CRC32 0
86#endif
87
88#ifndef IMAGE_ENABLE_MD5
89#define IMAGE_ENABLE_MD5 0
90#endif
91
92#ifndef IMAGE_ENABLE_SHA1
93#define IMAGE_ENABLE_SHA1 0
94#endif
95
96#ifndef IMAGE_ENABLE_SHA256
97#define IMAGE_ENABLE_SHA256 0
98#endif
99
Simon Glass73223f02016-02-22 22:55:43 -0700100#endif /* IMAGE_ENABLE_FIT */
Simon Glass13d06982013-05-08 08:06:01 +0000101
Masahiro Yamada6f417512016-05-31 20:41:54 +0900102#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
103# define IMAGE_ENABLE_RAMDISK_HIGH 1
104#else
105# define IMAGE_ENABLE_RAMDISK_HIGH 0
106#endif
107
108#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
109# define IMAGE_BOOT_GET_CMDLINE 1
110#else
111# define IMAGE_BOOT_GET_CMDLINE 0
112#endif
113
114#ifdef CONFIG_OF_BOARD_SETUP
115# define IMAGE_OF_BOARD_SETUP 1
116#else
117# define IMAGE_OF_BOARD_SETUP 0
118#endif
119
120#ifdef CONFIG_OF_SYSTEM_SETUP
121# define IMAGE_OF_SYSTEM_SETUP 1
122#else
123# define IMAGE_OF_SYSTEM_SETUP 0
124#endif
Simon Glassc654b512014-10-23 18:58:54 -0600125
Simon Glass56d7ab72016-06-30 10:52:14 -0600126enum ih_category {
127 IH_ARCH,
128 IH_COMP,
129 IH_OS,
130 IH_TYPE,
131
132 IH_COUNT,
133};
134
wdenk5b1d7132002-11-03 00:07:02 +0000135/*
136 * Operating System Codes
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900137 *
138 * The following are exposed to uImage header.
139 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000140 */
Simon Glass555f45d2016-06-30 10:52:13 -0600141enum {
142 IH_OS_INVALID = 0, /* Invalid OS */
143 IH_OS_OPENBSD, /* OpenBSD */
144 IH_OS_NETBSD, /* NetBSD */
145 IH_OS_FREEBSD, /* FreeBSD */
146 IH_OS_4_4BSD, /* 4.4BSD */
147 IH_OS_LINUX, /* Linux */
148 IH_OS_SVR4, /* SVR4 */
149 IH_OS_ESIX, /* Esix */
150 IH_OS_SOLARIS, /* Solaris */
151 IH_OS_IRIX, /* Irix */
152 IH_OS_SCO, /* SCO */
153 IH_OS_DELL, /* Dell */
154 IH_OS_NCR, /* NCR */
155 IH_OS_LYNXOS, /* LynxOS */
156 IH_OS_VXWORKS, /* VxWorks */
157 IH_OS_PSOS, /* pSOS */
158 IH_OS_QNX, /* QNX */
159 IH_OS_U_BOOT, /* Firmware */
160 IH_OS_RTEMS, /* RTEMS */
161 IH_OS_ARTOS, /* ARTOS */
162 IH_OS_UNITY, /* Unity OS */
163 IH_OS_INTEGRITY, /* INTEGRITY */
164 IH_OS_OSE, /* OSE */
165 IH_OS_PLAN9, /* Plan 9 */
166 IH_OS_OPENRTOS, /* OpenRTOS */
167
168 IH_OS_COUNT,
169};
wdenk5b1d7132002-11-03 00:07:02 +0000170
171/*
172 * CPU Architecture Codes (supported by Linux)
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900173 *
174 * The following are exposed to uImage header.
175 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000176 */
Simon Glass555f45d2016-06-30 10:52:13 -0600177enum {
178 IH_ARCH_INVALID = 0, /* Invalid CPU */
179 IH_ARCH_ALPHA, /* Alpha */
180 IH_ARCH_ARM, /* ARM */
181 IH_ARCH_I386, /* Intel x86 */
182 IH_ARCH_IA64, /* IA64 */
183 IH_ARCH_MIPS, /* MIPS */
184 IH_ARCH_MIPS64, /* MIPS 64 Bit */
185 IH_ARCH_PPC, /* PowerPC */
186 IH_ARCH_S390, /* IBM S390 */
187 IH_ARCH_SH, /* SuperH */
188 IH_ARCH_SPARC, /* Sparc */
189 IH_ARCH_SPARC64, /* Sparc 64 Bit */
190 IH_ARCH_M68K, /* M68K */
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900191 IH_ARCH_NIOS, /* Nios-32 */
Simon Glass555f45d2016-06-30 10:52:13 -0600192 IH_ARCH_MICROBLAZE, /* MicroBlaze */
193 IH_ARCH_NIOS2, /* Nios-II */
194 IH_ARCH_BLACKFIN, /* Blackfin */
195 IH_ARCH_AVR32, /* AVR32 */
196 IH_ARCH_ST200, /* STMicroelectronics ST200 */
197 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
198 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
199 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
200 IH_ARCH_ARM64, /* ARM64 */
201 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
202 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
203
204 IH_ARCH_COUNT,
205};
wdenk5b1d7132002-11-03 00:07:02 +0000206
207/*
208 * Image Types
209 *
210 * "Standalone Programs" are directly runnable in the environment
211 * provided by U-Boot; it is expected that (if they behave
212 * well) you can continue to work in U-Boot after return from
213 * the Standalone Program.
214 * "OS Kernel Images" are usually images of some Embedded OS which
215 * will take over control completely. Usually these programs
216 * will install their own set of exception handlers, device
217 * drivers, set up the MMU, etc. - this means, that you cannot
218 * expect to re-enter U-Boot except by resetting the CPU.
219 * "RAMDisk Images" are more or less just data blocks, and their
220 * parameters (address, size) are passed to an OS kernel that is
221 * being started.
222 * "Multi-File Images" contain several images, typically an OS
223 * (Linux) kernel image and one or more data images like
224 * RAMDisks. This construct is useful for instance when you want
225 * to boot over the network using BOOTP etc., where the boot
226 * server provides just a single image file, but you want to get
227 * for instance an OS kernel and a RAMDisk image.
228 *
229 * "Multi-File Images" start with a list of image sizes, each
230 * image size (in bytes) specified by an "uint32_t" in network
231 * byte order. This list is terminated by an "(uint32_t)0".
232 * Immediately after the terminating 0 follow the images, one by
233 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000234 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000235 *
236 * "Firmware Images" are binary images containing firmware (like
237 * U-Boot or FPGA images) which usually will be programmed to
238 * flash memory.
239 *
240 * "Script files" are command sequences that will be executed by
241 * U-Boot's command interpreter; this feature is especially
242 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000243 * as command interpreter (=> Shell Scripts).
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900244 *
245 * The following are exposed to uImage header.
246 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000247 */
248
Simon Glass555f45d2016-06-30 10:52:13 -0600249enum {
250 IH_TYPE_INVALID = 0, /* Invalid Image */
251 IH_TYPE_STANDALONE, /* Standalone Program */
252 IH_TYPE_KERNEL, /* OS Kernel Image */
253 IH_TYPE_RAMDISK, /* RAMDisk Image */
254 IH_TYPE_MULTI, /* Multi-File Image */
255 IH_TYPE_FIRMWARE, /* Firmware Image */
256 IH_TYPE_SCRIPT, /* Script file */
257 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
258 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
259 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
260 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
261 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
262 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
263 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
264 /* OS Kernel Image, can run from any load address */
265 IH_TYPE_KERNEL_NOLOAD,
266 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
267 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
268 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
269 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
270 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */
271 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
272 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
273 IH_TYPE_LOADABLE, /* A list of typeless images */
274 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
275 IH_TYPE_RKSD, /* Rockchip SD card */
276 IH_TYPE_RKSPI, /* Rockchip SPI image */
277 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
278 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
279 IH_TYPE_FPGA, /* FPGA Image */
wdenk5b1d7132002-11-03 00:07:02 +0000280
Simon Glass555f45d2016-06-30 10:52:13 -0600281 IH_TYPE_COUNT, /* Number of image types */
282};
Simon Glass5b9d44d2015-06-23 15:38:25 -0600283
wdenk5b1d7132002-11-03 00:07:02 +0000284/*
285 * Compression Types
Masahiro Yamadaff87b082016-07-21 15:16:00 +0900286 *
287 * The following are exposed to uImage header.
288 * Do not change values for backward compatibility.
wdenk5b1d7132002-11-03 00:07:02 +0000289 */
Simon Glass555f45d2016-06-30 10:52:13 -0600290enum {
291 IH_COMP_NONE = 0, /* No Compression Used */
292 IH_COMP_GZIP, /* gzip Compression Used */
293 IH_COMP_BZIP2, /* bzip2 Compression Used */
294 IH_COMP_LZMA, /* lzma Compression Used */
295 IH_COMP_LZO, /* lzo Compression Used */
296 IH_COMP_LZ4, /* lz4 Compression Used */
297
298 IH_COMP_COUNT,
299};
wdenk5b1d7132002-11-03 00:07:02 +0000300
301#define IH_MAGIC 0x27051956 /* Image Magic Number */
302#define IH_NMLEN 32 /* Image Name Length */
303
Fabio Estevam1411fb32013-01-03 08:24:33 +0000304/* Reused from common.h */
305#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
306
wdenk5b1d7132002-11-03 00:07:02 +0000307/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100308 * Legacy format image header,
309 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000310 */
wdenk5b1d7132002-11-03 00:07:02 +0000311typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000312 __be32 ih_magic; /* Image Header Magic Number */
313 __be32 ih_hcrc; /* Image Header CRC Checksum */
314 __be32 ih_time; /* Image Creation Timestamp */
315 __be32 ih_size; /* Image Data Size */
316 __be32 ih_load; /* Data Load Address */
317 __be32 ih_ep; /* Entry Point Address */
318 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000319 uint8_t ih_os; /* Operating System */
320 uint8_t ih_arch; /* CPU architecture */
321 uint8_t ih_type; /* Image Type */
322 uint8_t ih_comp; /* Compression Type */
323 uint8_t ih_name[IH_NMLEN]; /* Image Name */
324} image_header_t;
325
Kumar Gala396f6352008-08-15 08:24:41 -0500326typedef struct image_info {
327 ulong start, end; /* start/end of blob */
328 ulong image_start, image_len; /* start of image within blob, len of image */
329 ulong load; /* load addr for the image */
330 uint8_t comp, type, os; /* compression, type of image, os type */
Simon Glass90268b82014-10-19 21:11:24 -0600331 uint8_t arch; /* CPU architecture */
Kumar Gala396f6352008-08-15 08:24:41 -0500332} image_info_t;
333
Marian Balakowicz559316f2008-01-08 18:11:44 +0100334/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100335 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
336 * routines.
337 */
338typedef struct bootm_headers {
339 /*
340 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100341 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100342 * data from second and third component accordingly.
343 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200344 image_header_t *legacy_hdr_os; /* image header pointer */
345 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100346 ulong legacy_hdr_valid;
347
Simon Glass73223f02016-02-22 22:55:43 -0700348#if IMAGE_ENABLE_FIT
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100349 const char *fit_uname_cfg; /* configuration node unit name */
350
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100351 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100352 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100353 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100354
355 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100356 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
357 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100358
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100359 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100360 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
361 int fit_noffset_fdt;/* FDT blob subimage node offset */
Simon Glass90268b82014-10-19 21:11:24 -0600362
363 void *fit_hdr_setup; /* x86 setup FIT image header */
364 const char *fit_uname_setup; /* x86 setup subimage node name */
365 int fit_noffset_setup;/* x86 setup subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100366#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100367
Kumar Gala49c3a862008-10-21 17:25:45 -0500368#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500369 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500370 ulong ep; /* entry point of OS */
371
Kumar Galac4f94192008-08-15 08:24:37 -0500372 ulong rd_start, rd_end;/* ramdisk start/end */
373
Kumar Gala06a09912008-08-15 08:24:38 -0500374 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500375 ulong ft_len; /* length of flat device tree */
376
Kumar Gala49c3a862008-10-21 17:25:45 -0500377 ulong initrd_start;
378 ulong initrd_end;
379 ulong cmdline_start;
380 ulong cmdline_end;
381 bd_t *kbd;
382#endif
383
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100384 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500385
386#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700387#define BOOTM_STATE_FINDOS (0x00000002)
388#define BOOTM_STATE_FINDOTHER (0x00000004)
389#define BOOTM_STATE_LOADOS (0x00000008)
390#define BOOTM_STATE_RAMDISK (0x00000010)
391#define BOOTM_STATE_FDT (0x00000020)
392#define BOOTM_STATE_OS_CMDLINE (0x00000040)
393#define BOOTM_STATE_OS_BD_T (0x00000080)
394#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700395#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
396#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500397 int state;
398
Mike Frysingera16028d2009-11-03 11:35:59 -0500399#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500400 struct lmb lmb; /* for memory mgmt */
401#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100402} bootm_headers_t;
403
Simon Schwarz1648a372012-03-15 04:01:34 +0000404extern bootm_headers_t images;
405
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100406/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100407 * Some systems (for example LWMON) have very short watchdog periods;
408 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200409 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100410 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200411#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100412#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200413#endif
414
415#ifndef CHUNKSZ_CRC32
416#define CHUNKSZ_CRC32 (64 * 1024)
417#endif
418
419#ifndef CHUNKSZ_MD5
420#define CHUNKSZ_MD5 (64 * 1024)
421#endif
422
423#ifndef CHUNKSZ_SHA1
424#define CHUNKSZ_SHA1 (64 * 1024)
425#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100426
Mike Frysinger37566092009-07-02 19:23:25 -0400427#define uimage_to_cpu(x) be32_to_cpu(x)
428#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000429
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530430/*
431 * Translation table for entries of a specific type; used by
432 * get_table_entry_id() and get_table_entry_name().
433 */
434typedef struct table_entry {
435 int id;
436 char *sname; /* short (input) name to find table entry */
437 char *lname; /* long (output) name to print for messages */
438} table_entry_t;
439
440/*
441 * get_table_entry_id() scans the translation table trying to find an
442 * entry that matches the given short name. If a matching entry is
443 * found, it's id is returned to the caller.
444 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400445int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530446 const char *table_name, const char *name);
447/*
448 * get_table_entry_name() scans the translation table trying to find
449 * an entry that matches the given id. If a matching entry is found,
450 * its long name is returned to the caller.
451 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400452char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530453
Stephen Warren712fbcf2011-10-18 11:11:49 +0000454const char *genimg_get_os_name(uint8_t os);
Simon Glasscef2e512016-02-22 22:55:50 -0700455
456/**
457 * genimg_get_os_short_name() - get the short name for an OS
458 *
459 * @param os OS (IH_OS_...)
460 * @return OS short name, or "unknown" if unknown
461 */
462const char *genimg_get_os_short_name(uint8_t comp);
463
Stephen Warren712fbcf2011-10-18 11:11:49 +0000464const char *genimg_get_arch_name(uint8_t arch);
Simon Glasscef2e512016-02-22 22:55:50 -0700465
466/**
467 * genimg_get_arch_short_name() - get the short name for an architecture
468 *
469 * @param arch Architecture type (IH_ARCH_...)
470 * @return architecture short name, or "unknown" if unknown
471 */
472const char *genimg_get_arch_short_name(uint8_t arch);
473
Stephen Warren712fbcf2011-10-18 11:11:49 +0000474const char *genimg_get_type_name(uint8_t type);
Simon Glass5b9d44d2015-06-23 15:38:25 -0600475
476/**
477 * genimg_get_type_short_name() - get the short name for an image type
478 *
479 * @param type Image type (IH_TYPE_...)
480 * @return image short name, or "unknown" if unknown
481 */
482const char *genimg_get_type_short_name(uint8_t type);
483
Stephen Warren712fbcf2011-10-18 11:11:49 +0000484const char *genimg_get_comp_name(uint8_t comp);
Simon Glasscef2e512016-02-22 22:55:50 -0700485
486/**
487 * genimg_get_comp_short_name() - get the short name for a compression method
488 *
489 * @param comp compression method (IH_COMP_...)
490 * @return compression method short name, or "unknown" if unknown
491 */
492const char *genimg_get_comp_short_name(uint8_t comp);
493
Simon Glass14262202016-06-30 10:52:16 -0600494/**
495 * genimg_get_cat_name() - Get the name of an item in a category
496 *
497 * @category: Category of item
498 * @id: Item ID
499 * @return name of item, or "Unknown ..." if unknown
500 */
501const char *genimg_get_cat_name(enum ih_category category, uint id);
502
503/**
504 * genimg_get_cat_short_name() - Get the short name of an item in a category
505 *
506 * @category: Category of item
507 * @id: Item ID
508 * @return short name of item, or "Unknown ..." if unknown
509 */
510const char *genimg_get_cat_short_name(enum ih_category category, uint id);
511
512/**
513 * genimg_get_cat_count() - Get the number of items in a category
514 *
515 * @category: Category to check
516 * @return the number of items in the category (IH_xxx_COUNT)
517 */
518int genimg_get_cat_count(enum ih_category category);
519
520/**
521 * genimg_get_cat_desc() - Get the description of a category
522 *
523 * @return the description of a category, e.g. "architecture". This
524 * effectively converts the enum to a string.
525 */
526const char *genimg_get_cat_desc(enum ih_category category);
527
Stephen Warren712fbcf2011-10-18 11:11:49 +0000528int genimg_get_os_id(const char *name);
529int genimg_get_arch_id(const char *name);
530int genimg_get_type_id(const char *name);
531int genimg_get_comp_id(const char *name);
532void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100533
Simon Glass859e92b2013-05-07 06:11:51 +0000534#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
535 defined(USE_HOSTCC)
536#define IMAGE_ENABLE_TIMESTAMP 1
537#else
538#define IMAGE_ENABLE_TIMESTAMP 0
539#endif
540void genimg_print_time(time_t timestamp);
541
Simon Glass782cfbb2013-05-16 13:53:21 +0000542/* What to do with a image load address ('load = <> 'in the FIT) */
543enum fit_load_op {
544 FIT_LOAD_IGNORED, /* Ignore load address */
545 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
Simon Glassfe20a812014-08-22 14:26:43 -0600546 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
Simon Glass782cfbb2013-05-16 13:53:21 +0000547 FIT_LOAD_REQUIRED, /* Must be provided */
548};
549
Simon Glass90268b82014-10-19 21:11:24 -0600550int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
551 ulong *setup_len);
552
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100553#ifndef USE_HOSTCC
554/* Image format types, returned by _get_format() routine */
555#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher21d29f72014-05-28 11:33:33 +0200556#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100557#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200558#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100559#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500560#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100561
Bryan Wu6c454fe2014-08-15 16:51:38 -0700562ulong genimg_get_kernel_addr_fit(char * const img_addr,
563 const char **fit_uname_config,
564 const char **fit_uname_kernel);
Bryan Wu0f641402014-07-31 17:39:58 -0700565ulong genimg_get_kernel_addr(char * const img_addr);
Simon Glass35e7b0f2013-05-07 06:12:03 +0000566int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000567int genimg_has_config(bootm_headers_t *images);
568ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100569
Michal Simek62afc602016-05-17 14:03:50 +0200570int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
571 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000572int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100573 uint8_t arch, ulong *rd_start, ulong *rd_end);
Karl Apsite84a07db2015-05-21 09:52:48 -0400574
575/**
576 * boot_get_loadable - routine to load a list of binaries to memory
577 * @argc: Ignored Argument
578 * @argv: Ignored Argument
579 * @images: pointer to the bootm images structure
580 * @arch: expected architecture for the image
581 * @ld_start: Ignored Argument
582 * @ld_len: Ignored Argument
583 *
584 * boot_get_loadable() will take the given FIT configuration, and look
585 * for a field named "loadables". Loadables, is a list of elements in
586 * the FIT given as strings. exe:
587 * loadables = "linux_kernel@1", "fdt@2";
588 * this function will attempt to parse each string, and load the
589 * corresponding element from the FIT into memory. Once placed,
590 * no aditional actions are taken.
591 *
592 * @return:
593 * 0, if only valid images or no images are found
594 * error code, if an error occurs during fit_image_load
595 */
596int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
597 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
598#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100599
Simon Glass90268b82014-10-19 21:11:24 -0600600int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
601 ulong *setup_start, ulong *setup_len);
602
Simon Glass782cfbb2013-05-16 13:53:21 +0000603/**
604 * fit_image_load() - load an image from a FIT
605 *
606 * This deals with all aspects of loading an image from a FIT, including
607 * selecting the right image based on configuration, verifying it, printing
608 * out progress messages, checking the type/arch/os and optionally copying it
609 * to the right load address.
610 *
Simon Glass126cc862014-06-12 07:24:47 -0600611 * The property to look up is defined by image_type.
612 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000613 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000614 * @param addr Address of FIT in memory
615 * @param fit_unamep On entry this is the requested image name
616 * (e.g. "kernel@1") or NULL to use the default. On exit
617 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700618 * @param fit_uname_configp On entry this is the requested configuration
619 * name (e.g. "conf@1") or NULL to use the default. On
620 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000621 * @param arch Expected architecture (IH_ARCH_...)
622 * @param image_type Required image type (IH_TYPE_...). If this is
623 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
624 * also.
625 * @param bootstage_id ID of starting bootstage to use for progress updates.
626 * This will be added to the BOOTSTAGE_SUB values when
627 * calling bootstage_mark()
628 * @param load_op Decribes what to do with the load address
629 * @param datap Returns address of loaded image
630 * @param lenp Returns length of loaded image
Simon Glassce1400f2014-06-12 07:24:53 -0600631 * @return node offset of image, or -ve error code on error
Simon Glass782cfbb2013-05-16 13:53:21 +0000632 */
Simon Glass126cc862014-06-12 07:24:47 -0600633int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700634 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000635 int arch, int image_type, int bootstage_id,
636 enum fit_load_op load_op, ulong *datap, ulong *lenp);
637
Simon Glassce1400f2014-06-12 07:24:53 -0600638#ifndef USE_HOSTCC
Simon Glass782cfbb2013-05-16 13:53:21 +0000639/**
640 * fit_get_node_from_config() - Look up an image a FIT by type
641 *
642 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
643 * particular image type (e.g. "kernel") and then finds the image that is
644 * referred to.
645 *
646 * For example, for something like:
647 *
648 * images {
649 * kernel@1 {
650 * ...
651 * };
652 * };
653 * configurations {
654 * conf@1 {
655 * kernel = "kernel@1";
656 * };
657 * };
658 *
659 * the function will return the node offset of the kernel@1 node, assuming
660 * that conf@1 is the chosen configuration.
661 *
662 * @param images Boot images structure
663 * @param prop_name Property name to look up (FIT_..._PROP)
664 * @param addr Address of FIT in memory
665 */
666int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
667 ulong addr);
668
Simon Glass53f375f2013-05-16 13:53:23 +0000669int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
670 bootm_headers_t *images,
671 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000672void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000673int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500674
Stephen Warren712fbcf2011-10-18 11:11:49 +0000675int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100676 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000677int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600678#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000679int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600680#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100681#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100682
683/*******************************************************************/
684/* Legacy format specific code (prefixed with image_) */
685/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000686static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100687{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000688 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100689}
690
691#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200692 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100693 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000694 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100695 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000696image_get_hdr_l(magic) /* image_get_magic */
697image_get_hdr_l(hcrc) /* image_get_hcrc */
698image_get_hdr_l(time) /* image_get_time */
699image_get_hdr_l(size) /* image_get_size */
700image_get_hdr_l(load) /* image_get_load */
701image_get_hdr_l(ep) /* image_get_ep */
702image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100703
704#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200705 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100706 { \
707 return hdr->ih_##f; \
708 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000709image_get_hdr_b(os) /* image_get_os */
710image_get_hdr_b(arch) /* image_get_arch */
711image_get_hdr_b(type) /* image_get_type */
712image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100713
Stephen Warren712fbcf2011-10-18 11:11:49 +0000714static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100715{
716 return (char *)hdr->ih_name;
717}
718
Stephen Warren712fbcf2011-10-18 11:11:49 +0000719static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100720{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000721 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100722}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100723
724/**
725 * image_get_data - get image payload start address
726 * @hdr: image header
727 *
728 * image_get_data() returns address of the image payload. For single
729 * component images it is image data start. For multi component
730 * images it points to the null terminated table of sub-images sizes.
731 *
732 * returns:
733 * image payload data start address
734 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000735static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100736{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000737 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100738}
739
Stephen Warren712fbcf2011-10-18 11:11:49 +0000740static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100741{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000742 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100743}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000744static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100745{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000746 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100747}
748
749#define image_set_hdr_l(f) \
750 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
751 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000752 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100753 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000754image_set_hdr_l(magic) /* image_set_magic */
755image_set_hdr_l(hcrc) /* image_set_hcrc */
756image_set_hdr_l(time) /* image_set_time */
757image_set_hdr_l(size) /* image_set_size */
758image_set_hdr_l(load) /* image_set_load */
759image_set_hdr_l(ep) /* image_set_ep */
760image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100761
762#define image_set_hdr_b(f) \
763 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
764 { \
765 hdr->ih_##f = val; \
766 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000767image_set_hdr_b(os) /* image_set_os */
768image_set_hdr_b(arch) /* image_set_arch */
769image_set_hdr_b(type) /* image_set_type */
770image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100771
Stephen Warren712fbcf2011-10-18 11:11:49 +0000772static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100773{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000774 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100775}
776
Stephen Warren712fbcf2011-10-18 11:11:49 +0000777int image_check_hcrc(const image_header_t *hdr);
778int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100779#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600780ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500781phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000782phys_size_t getenv_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100783#endif
Simon Glassce1400f2014-06-12 07:24:53 -0600784void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100785
Stephen Warren712fbcf2011-10-18 11:11:49 +0000786static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100787{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000788 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100789}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000790static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100791{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000792 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100793}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000794static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100795{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000796 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100797}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000798static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100799{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000800 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100801}
802
Stephen Warren712fbcf2011-10-18 11:11:49 +0000803ulong image_multi_count(const image_header_t *hdr);
804void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100805 ulong *data, ulong *len);
806
Stephen Warren712fbcf2011-10-18 11:11:49 +0000807void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100808
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100809#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000810static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100811{
Mike Frysinger476af292011-10-03 14:50:33 +0000812#ifndef IH_ARCH_DEFAULT
813# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100814#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000815 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100816}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100817#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100818
Simon Glass13d06982013-05-08 08:06:01 +0000819/**
820 * Set up properties in the FDT
821 *
822 * This sets up properties in the FDT that is to be passed to linux.
823 *
824 * @images: Images information
825 * @blob: FDT to update
826 * @of_size: Size of the FDT
827 * @lmb: Points to logical memory block structure
828 * @return 0 if ok, <0 on failure
829 */
830int image_setup_libfdt(bootm_headers_t *images, void *blob,
831 int of_size, struct lmb *lmb);
832
833/**
834 * Set up the FDT to use for booting a kernel
835 *
836 * This performs ramdisk setup, sets up the FDT if required, and adds
837 * paramters to the FDT if libfdt is available.
838 *
839 * @param images Images information
840 * @return 0 if ok, <0 on failure
841 */
842int image_setup_linux(bootm_headers_t *images);
843
Simon Glassa5266d62013-07-04 13:26:10 -0700844/**
845 * bootz_setup() - Extract stat and size of a Linux xImage
846 *
847 * @image: Address of image
848 * @start: Returns start address of image
849 * @end : Returns end address of image
850 * @return 0 if OK, 1 if the image was not recognised
851 */
852int bootz_setup(ulong image, ulong *start, ulong *end);
853
854
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100855/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100856/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100857/*******************************************************************/
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100858
859#define FIT_IMAGES_PATH "/images"
860#define FIT_CONFS_PATH "/configurations"
861
Simon Glass3e569a62013-06-13 15:10:00 -0700862/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100863#define FIT_HASH_NODENAME "hash"
864#define FIT_ALGO_PROP "algo"
865#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000866#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700867#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100868
869/* image node */
870#define FIT_DATA_PROP "data"
871#define FIT_TIMESTAMP_PROP "timestamp"
872#define FIT_DESC_PROP "description"
873#define FIT_ARCH_PROP "arch"
874#define FIT_TYPE_PROP "type"
875#define FIT_OS_PROP "os"
876#define FIT_COMP_PROP "compression"
877#define FIT_ENTRY_PROP "entry"
878#define FIT_LOAD_PROP "load"
879
880/* configuration node */
881#define FIT_KERNEL_PROP "kernel"
882#define FIT_RAMDISK_PROP "ramdisk"
883#define FIT_FDT_PROP "fdt"
Karl Apsiteecf8cd62015-05-21 09:52:47 -0400884#define FIT_LOADABLE_PROP "loadables"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100885#define FIT_DEFAULT_PROP "default"
Simon Glass90268b82014-10-19 21:11:24 -0600886#define FIT_SETUP_PROP "setup"
Michal Simeked0cea72016-05-17 13:58:44 +0200887#define FIT_FPGA_PROP "fpga"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100888
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200889#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100890
Simon Glassf1dcee52016-02-22 22:55:56 -0700891#if IMAGE_ENABLE_FIT
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100892/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000893int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100894 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000895int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100896 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100897
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200898int fit_get_subimage_count(const void *fit, int images_noffset);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000899void fit_print_contents(const void *fit);
900void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100901
902/**
903 * fit_get_end - get FIT image size
904 * @fit: pointer to the FIT format image header
905 *
906 * returns:
907 * size of the FIT image (blob) in memory
908 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000909static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100910{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000911 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100912}
913
914/**
915 * fit_get_end - get FIT image end
916 * @fit: pointer to the FIT format image header
917 *
918 * returns:
919 * end address of the FIT image (blob) in memory
920 */
Simon Glass7a80de42016-02-24 09:14:42 -0700921ulong fit_get_end(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100922
923/**
924 * fit_get_name - get FIT node name
925 * @fit: pointer to the FIT format image header
926 *
927 * returns:
928 * NULL, on error
929 * pointer to node name, on success
930 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000931static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100932 int noffset, int *len)
933{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000934 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100935}
936
Stephen Warren712fbcf2011-10-18 11:11:49 +0000937int fit_get_desc(const void *fit, int noffset, char **desc);
938int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100939
Stephen Warren712fbcf2011-10-18 11:11:49 +0000940int fit_image_get_node(const void *fit, const char *image_uname);
941int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
942int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
943int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
944int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
945int fit_image_get_load(const void *fit, int noffset, ulong *load);
946int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
947int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100948 const void **data, size_t *size);
949
Stephen Warren712fbcf2011-10-18 11:11:49 +0000950int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
951int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100952 int *value_len);
953
Stephen Warren712fbcf2011-10-18 11:11:49 +0000954int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000955
956/**
Simon Glass56518e72013-06-13 15:10:01 -0700957 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000958 *
Simon Glass56518e72013-06-13 15:10:01 -0700959 * @keydir: Directory containing keys
960 * @kwydest: FDT blob to write public key information to
961 * @fit: Pointer to the FIT format image header
962 * @comment: Comment to add to signature nodes
963 * @require_keys: Mark all keys as 'required'
964 *
965 * Adds hash values for all component images in the FIT blob.
966 * Hashes are calculated for all component images which have hash subnodes
967 * with algorithm property set to one of the supported hash algorithms.
968 *
969 * Also add signatures if signature nodes are present.
970 *
971 * returns
972 * 0, on success
973 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000974 */
Simon Glass56518e72013-06-13 15:10:01 -0700975int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
976 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100977
Simon Glassb8da8362013-05-07 06:11:57 +0000978int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000979int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000980int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000981int fit_image_check_os(const void *fit, int noffset, uint8_t os);
982int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
983int fit_image_check_type(const void *fit, int noffset, uint8_t type);
984int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
985int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100986
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000987int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000988int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100989
Simon Glass003efd72013-05-07 06:12:00 +0000990/**
991 * fit_conf_get_prop_node() - Get node refered to by a configuration
992 * @fit: FIT to check
993 * @noffset: Offset of conf@xxx node to check
994 * @prop_name: Property to read from the conf node
995 *
996 * The conf@ nodes contain references to other nodes, using properties
997 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
998 * return the offset of the node referred to (e.g. offset of node
999 * "/images/kernel@1".
1000 */
1001int fit_conf_get_prop_node(const void *fit, int noffset,
1002 const char *prop_name);
1003
Stephen Warren712fbcf2011-10-18 11:11:49 +00001004void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001005
Simon Glass61a439a2013-05-07 06:11:52 +00001006int fit_check_ramdisk(const void *fit, int os_noffset,
1007 uint8_t arch, int verify);
1008
Simon Glass604f23d2013-05-07 06:11:54 +00001009int calculate_hash(const void *data, int data_len, const char *algo,
1010 uint8_t *value, int *value_len);
1011
Simon Glass782cfbb2013-05-16 13:53:21 +00001012/*
Simon Glass3e569a62013-06-13 15:10:00 -07001013 * At present we only support signing on the host, and verification on the
1014 * device
Simon Glass782cfbb2013-05-16 13:53:21 +00001015 */
1016#if defined(CONFIG_FIT_SIGNATURE)
1017# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -07001018# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +01001019# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +01001020# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +00001021#else
Simon Glass3e569a62013-06-13 15:10:00 -07001022# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001023# define IMAGE_ENABLE_VERIFY 1
1024# endif
1025#else
Simon Glass3e569a62013-06-13 15:10:00 -07001026# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +00001027# define IMAGE_ENABLE_VERIFY 0
1028#endif
1029
1030#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +01001031void *image_get_host_blob(void);
1032void image_set_host_blob(void *host_blob);
1033# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +00001034#else
1035# define gd_fdt_blob() (gd->fdt_blob)
1036#endif
1037
1038#ifdef CONFIG_FIT_BEST_MATCH
1039#define IMAGE_ENABLE_BEST_MATCH 1
1040#else
1041#define IMAGE_ENABLE_BEST_MATCH 0
1042#endif
1043
Simon Glass3e569a62013-06-13 15:10:00 -07001044/* Information passed to the signing routines */
1045struct image_sign_info {
1046 const char *keydir; /* Directory conaining keys */
1047 const char *keyname; /* Name of key to use */
1048 void *fit; /* Pointer to FIT blob */
1049 int node_offset; /* Offset of signature node */
1050 struct image_sig_algo *algo; /* Algorithm information */
1051 const void *fdt_blob; /* FDT containing public keys */
1052 int required_keynode; /* Node offset of key to use: -1=any */
1053 const char *require_keys; /* Value for 'required' property */
1054};
Simon Glass73223f02016-02-22 22:55:43 -07001055#endif /* Allow struct image_region to always be defined for rsa.h */
Simon Glass3e569a62013-06-13 15:10:00 -07001056
1057/* A part of an image, used for hashing */
1058struct image_region {
1059 const void *data;
1060 int size;
1061};
1062
Simon Glass73223f02016-02-22 22:55:43 -07001063#if IMAGE_ENABLE_FIT
1064
Heiko Schocher646257d2014-03-03 12:19:26 +01001065#if IMAGE_ENABLE_VERIFY
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +02001066# include <u-boot/rsa-checksum.h>
Heiko Schocher646257d2014-03-03 12:19:26 +01001067#endif
1068struct checksum_algo {
1069 const char *name;
1070 const int checksum_len;
Heiko Schocherdb1b5f32014-03-03 12:19:27 +01001071 const int pad_len;
Heiko Schocher646257d2014-03-03 12:19:26 +01001072#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +01001073 const EVP_MD *(*calculate_sign)(void);
1074#endif
Ruchika Guptab37b46f2015-01-23 16:01:59 +05301075 int (*calculate)(const char *name,
1076 const struct image_region region[],
1077 int region_count, uint8_t *checksum);
Heiko Schocher646257d2014-03-03 12:19:26 +01001078 const uint8_t *rsa_padding;
Heiko Schocher646257d2014-03-03 12:19:26 +01001079};
1080
Simon Glass3e569a62013-06-13 15:10:00 -07001081struct image_sig_algo {
1082 const char *name; /* Name of algorithm */
1083
1084 /**
1085 * sign() - calculate and return signature for given input data
1086 *
1087 * @info: Specifies key and FIT information
1088 * @data: Pointer to the input data
1089 * @data_len: Data length
1090 * @sigp: Set to an allocated buffer holding the signature
1091 * @sig_len: Set to length of the calculated hash
1092 *
1093 * This computes input data signature according to selected algorithm.
1094 * Resulting signature value is placed in an allocated buffer, the
1095 * pointer is returned as *sigp. The length of the calculated
1096 * signature is returned via the sig_len pointer argument. The caller
1097 * should free *sigp.
1098 *
1099 * @return: 0, on success, -ve on error
1100 */
1101 int (*sign)(struct image_sign_info *info,
1102 const struct image_region region[],
1103 int region_count, uint8_t **sigp, uint *sig_len);
1104
1105 /**
1106 * add_verify_data() - Add verification information to FDT
1107 *
1108 * Add public key information to the FDT node, suitable for
1109 * verification at run-time. The information added depends on the
1110 * algorithm being used.
1111 *
1112 * @info: Specifies key and FIT information
1113 * @keydest: Destination FDT blob for public key data
1114 * @return: 0, on success, -ve on error
1115 */
1116 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1117
1118 /**
1119 * verify() - Verify a signature against some data
1120 *
1121 * @info: Specifies key and FIT information
1122 * @data: Pointer to the input data
1123 * @data_len: Data length
1124 * @sig: Signature
1125 * @sig_len: Number of bytes in signature
1126 * @return 0 if verified, -ve on error
1127 */
1128 int (*verify)(struct image_sign_info *info,
1129 const struct image_region region[], int region_count,
1130 uint8_t *sig, uint sig_len);
Heiko Schocher646257d2014-03-03 12:19:26 +01001131
1132 /* pointer to checksum algorithm */
1133 struct checksum_algo *checksum;
Simon Glass3e569a62013-06-13 15:10:00 -07001134};
1135
1136/**
1137 * image_get_sig_algo() - Look up a signature algortihm
1138 *
1139 * @param name Name of algorithm
1140 * @return pointer to algorithm information, or NULL if not found
1141 */
1142struct image_sig_algo *image_get_sig_algo(const char *name);
1143
Simon Glass56518e72013-06-13 15:10:01 -07001144/**
1145 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1146 *
1147 * @fit: FIT to check
1148 * @image_noffset: Offset of image node to check
1149 * @data: Image data to check
1150 * @size: Size of image data
1151 * @sig_blob: FDT containing public keys
1152 * @no_sigsp: Returns 1 if no signatures were required, and
1153 * therefore nothing was checked. The caller may wish
1154 * to fall back to other mechanisms, or refuse to
1155 * boot.
1156 * @return 0 if all verified ok, <0 on error
1157 */
1158int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1159 const char *data, size_t size, const void *sig_blob,
1160 int *no_sigsp);
1161
1162/**
1163 * fit_image_check_sig() - Check a single image signature node
1164 *
1165 * @fit: FIT to check
1166 * @noffset: Offset of signature node to check
1167 * @data: Image data to check
1168 * @size: Size of image data
1169 * @required_keynode: Offset in the control FDT of the required key node,
1170 * if any. If this is given, then the image wil not
1171 * pass verification unless that key is used. If this is
1172 * -1 then any signature will do.
1173 * @err_msgp: In the event of an error, this will be pointed to a
1174 * help error string to display to the user.
1175 * @return 0 if all verified ok, <0 on error
1176 */
1177int fit_image_check_sig(const void *fit, int noffset, const void *data,
1178 size_t size, int required_keynode, char **err_msgp);
1179
Simon Glass4d098522013-06-13 15:10:09 -07001180/**
1181 * fit_region_make_list() - Make a list of regions to hash
1182 *
1183 * Given a list of FIT regions (offset, size) provided by libfdt, create
1184 * a list of regions (void *, size) for use by the signature creationg
1185 * and verification code.
1186 *
1187 * @fit: FIT image to process
1188 * @fdt_regions: Regions as returned by libfdt
1189 * @count: Number of regions returned by libfdt
1190 * @region: Place to put list of regions (NULL to allocate it)
1191 * @return pointer to list of regions, or NULL if out of memory
1192 */
1193struct image_region *fit_region_make_list(const void *fit,
1194 struct fdt_region *fdt_regions, int count,
1195 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001196
Stephen Warren712fbcf2011-10-18 11:11:49 +00001197static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001198{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001199#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001200 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001201#else
1202 return 0;
1203#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001204}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001205
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001206#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001207#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001208 "FIT images not supported for '%s'\n", \
1209 __FILE__, __LINE__, (msg))
1210
Stephen Warren712fbcf2011-10-18 11:11:49 +00001211#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001212 "FIT images not supported for '%s' " \
1213 "- must reset board to recover!\n", \
1214 __FILE__, __LINE__, (msg))
1215#else
1216#define fit_unsupported(msg)
1217#define fit_unsupported_reset(msg)
1218#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001219#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001220
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001221#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1222struct andr_img_hdr;
1223int android_image_check_header(const struct andr_img_hdr *hdr);
1224int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1225 ulong *os_data, ulong *os_len);
1226int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1227 ulong *rd_data, ulong *rd_len);
1228ulong android_image_get_end(const struct andr_img_hdr *hdr);
1229ulong android_image_get_kload(const struct andr_img_hdr *hdr);
Michael Trimarchi4f1318b2016-06-10 19:54:37 +02001230void android_print_contents(const struct andr_img_hdr *hdr);
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001231
1232#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1233
Simon Glass4b307f22016-02-22 22:55:55 -07001234/**
1235 * board_fit_config_name_match() - Check for a matching board name
1236 *
1237 * This is used when SPL loads a FIT containing multiple device tree files
1238 * and wants to work out which one to use. The description of each one is
1239 * passed to this function. The description comes from the 'description' field
1240 * in each (FDT) image node.
1241 *
1242 * @name: Device tree description
1243 * @return 0 if this device tree should be used, non-zero to try the next
1244 */
1245int board_fit_config_name_match(const char *name);
1246
Daniel Allredda74d1f2016-06-27 09:19:21 -05001247#ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1248/**
1249 * board_fit_image_post_process() - Do any post-process on FIT binary data
1250 *
1251 * This is used to do any sort of image manipulation, verification, decryption
1252 * etc. in a platform or board specific way. Obviously, anything done here would
1253 * need to be comprehended in how the images were prepared before being injected
1254 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1255 * before being added to the FIT image).
1256 *
1257 * @image: pointer to the image start pointer
1258 * @size: pointer to the image size
1259 * @return no return value (failure should be handled internally)
1260 */
1261void board_fit_image_post_process(void **p_image, size_t *p_size);
1262#endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1263
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001264#endif /* __IMAGE_H__ */