blob: ae767f0c8315c3b6a99a511e25f8e85fe665f8c9 [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
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010026
27/* new uImage format support enabled on host */
28#define CONFIG_FIT 1
29#define CONFIG_OF_LIBFDT 1
30#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
31
Simon Glassab9efc62013-05-07 06:11:58 +000032#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000033#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000034
Wolfgang Denkdef08192008-10-21 11:23:56 +020035#else
36
37#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020038#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050039#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020040
Simon Glassab9efc62013-05-07 06:11:58 +000041/* Take notice of the 'ignore' property for hashes */
42#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000043#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000044
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010045#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010046
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010047#if defined(CONFIG_FIT)
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +020048#include <hash.h>
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010049#include <libfdt.h>
50#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000051# ifdef CONFIG_SPL_BUILD
52# ifdef CONFIG_SPL_CRC32_SUPPORT
53# define IMAGE_ENABLE_CRC32 1
54# endif
55# ifdef CONFIG_SPL_MD5_SUPPORT
56# define IMAGE_ENABLE_MD5 1
57# endif
58# ifdef CONFIG_SPL_SHA1_SUPPORT
59# define IMAGE_ENABLE_SHA1 1
60# endif
Heiko Schocher2842c1c2014-03-03 12:19:25 +010061# ifdef CONFIG_SPL_SHA256_SUPPORT
62# define IMAGE_ENABLE_SHA256 1
63# endif
Simon Glass87ebee32013-05-08 08:05:59 +000064# else
65# define CONFIG_CRC32 /* FIT images need CRC32 support */
66# define CONFIG_MD5 /* and MD5 */
67# define CONFIG_SHA1 /* and SHA1 */
Heiko Schocher2842c1c2014-03-03 12:19:25 +010068# define CONFIG_SHA256 /* and SHA256 */
Simon Glass87ebee32013-05-08 08:05:59 +000069# define IMAGE_ENABLE_CRC32 1
70# define IMAGE_ENABLE_MD5 1
71# define IMAGE_ENABLE_SHA1 1
Heiko Schocher2842c1c2014-03-03 12:19:25 +010072# define IMAGE_ENABLE_SHA256 1
Simon Glass87ebee32013-05-08 08:05:59 +000073# endif
74
75#ifndef IMAGE_ENABLE_CRC32
76#define IMAGE_ENABLE_CRC32 0
77#endif
78
79#ifndef IMAGE_ENABLE_MD5
80#define IMAGE_ENABLE_MD5 0
81#endif
82
83#ifndef IMAGE_ENABLE_SHA1
84#define IMAGE_ENABLE_SHA1 0
85#endif
86
Heiko Schocher2842c1c2014-03-03 12:19:25 +010087#ifndef IMAGE_ENABLE_SHA256
88#define IMAGE_ENABLE_SHA256 0
89#endif
90
Simon Glass13d06982013-05-08 08:06:01 +000091#endif /* CONFIG_FIT */
92
93#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
94# define IMAGE_ENABLE_RAMDISK_HIGH 1
95#else
96# define IMAGE_ENABLE_RAMDISK_HIGH 0
97#endif
98
99#ifdef CONFIG_OF_LIBFDT
100# define IMAGE_ENABLE_OF_LIBFDT 1
101#else
102# define IMAGE_ENABLE_OF_LIBFDT 0
103#endif
104
105#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
106# define IMAGE_BOOT_GET_CMDLINE 1
107#else
108# define IMAGE_BOOT_GET_CMDLINE 0
109#endif
110
111#ifdef CONFIG_OF_BOARD_SETUP
Masahiro Yamada95f70622014-01-29 16:29:16 +0900112# define IMAGE_OF_BOARD_SETUP 1
Simon Glass13d06982013-05-08 08:06:01 +0000113#else
Masahiro Yamada95f70622014-01-29 16:29:16 +0900114# define IMAGE_OF_BOARD_SETUP 0
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100115#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100116
wdenk5b1d7132002-11-03 00:07:02 +0000117/*
118 * Operating System Codes
119 */
120#define IH_OS_INVALID 0 /* Invalid OS */
121#define IH_OS_OPENBSD 1 /* OpenBSD */
122#define IH_OS_NETBSD 2 /* NetBSD */
123#define IH_OS_FREEBSD 3 /* FreeBSD */
124#define IH_OS_4_4BSD 4 /* 4.4BSD */
125#define IH_OS_LINUX 5 /* Linux */
126#define IH_OS_SVR4 6 /* SVR4 */
127#define IH_OS_ESIX 7 /* Esix */
128#define IH_OS_SOLARIS 8 /* Solaris */
129#define IH_OS_IRIX 9 /* Irix */
130#define IH_OS_SCO 10 /* SCO */
131#define IH_OS_DELL 11 /* Dell */
132#define IH_OS_NCR 12 /* NCR */
133#define IH_OS_LYNXOS 13 /* LynxOS */
134#define IH_OS_VXWORKS 14 /* VxWorks */
135#define IH_OS_PSOS 15 /* pSOS */
136#define IH_OS_QNX 16 /* QNX */
137#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000138#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000139#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000140#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500141#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200142#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000143#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000144
145/*
146 * CPU Architecture Codes (supported by Linux)
147 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100148#define IH_ARCH_INVALID 0 /* Invalid CPU */
149#define IH_ARCH_ALPHA 1 /* Alpha */
150#define IH_ARCH_ARM 2 /* ARM */
151#define IH_ARCH_I386 3 /* Intel x86 */
152#define IH_ARCH_IA64 4 /* IA64 */
153#define IH_ARCH_MIPS 5 /* MIPS */
154#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
155#define IH_ARCH_PPC 7 /* PowerPC */
156#define IH_ARCH_S390 8 /* IBM S390 */
157#define IH_ARCH_SH 9 /* SuperH */
158#define IH_ARCH_SPARC 10 /* Sparc */
159#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
160#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100161#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
162#define IH_ARCH_NIOS2 15 /* Nios-II */
163#define IH_ARCH_BLACKFIN 16 /* Blackfin */
164#define IH_ARCH_AVR32 17 /* AVR32 */
165#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000166#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000167#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000168#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
David Feng0ae76532013-12-14 11:47:35 +0800169#define IH_ARCH_ARM64 22 /* ARM64 */
Alexey Brodkinbc5d5422014-02-04 12:56:16 +0400170#define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
wdenk5b1d7132002-11-03 00:07:02 +0000171
172/*
173 * Image Types
174 *
175 * "Standalone Programs" are directly runnable in the environment
176 * provided by U-Boot; it is expected that (if they behave
177 * well) you can continue to work in U-Boot after return from
178 * the Standalone Program.
179 * "OS Kernel Images" are usually images of some Embedded OS which
180 * will take over control completely. Usually these programs
181 * will install their own set of exception handlers, device
182 * drivers, set up the MMU, etc. - this means, that you cannot
183 * expect to re-enter U-Boot except by resetting the CPU.
184 * "RAMDisk Images" are more or less just data blocks, and their
185 * parameters (address, size) are passed to an OS kernel that is
186 * being started.
187 * "Multi-File Images" contain several images, typically an OS
188 * (Linux) kernel image and one or more data images like
189 * RAMDisks. This construct is useful for instance when you want
190 * to boot over the network using BOOTP etc., where the boot
191 * server provides just a single image file, but you want to get
192 * for instance an OS kernel and a RAMDisk image.
193 *
194 * "Multi-File Images" start with a list of image sizes, each
195 * image size (in bytes) specified by an "uint32_t" in network
196 * byte order. This list is terminated by an "(uint32_t)0".
197 * Immediately after the terminating 0 follow the images, one by
198 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000199 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000200 *
201 * "Firmware Images" are binary images containing firmware (like
202 * U-Boot or FPGA images) which usually will be programmed to
203 * flash memory.
204 *
205 * "Script files" are command sequences that will be executed by
206 * U-Boot's command interpreter; this feature is especially
207 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000208 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000209 */
210
211#define IH_TYPE_INVALID 0 /* Invalid Image */
212#define IH_TYPE_STANDALONE 1 /* Standalone Program */
213#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
214#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
215#define IH_TYPE_MULTI 4 /* Multi-File Image */
216#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
217#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000218#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500219#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530220#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100221#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000222#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400223#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000224#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e82011-11-10 13:17:53 -0700225#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000226#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
Marek Vasutbce88372013-08-26 20:43:33 +0200227#define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
Karicheri, Muralidharanbf411ea2014-04-04 13:16:48 -0400228#define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
Andreas Bießmann7b1a4112014-05-19 14:23:39 +0200229#define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
wdenk5b1d7132002-11-03 00:07:02 +0000230
231/*
232 * Compression Types
233 */
234#define IH_COMP_NONE 0 /* No Compression Used */
235#define IH_COMP_GZIP 1 /* gzip Compression Used */
236#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200237#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100238#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000239
240#define IH_MAGIC 0x27051956 /* Image Magic Number */
241#define IH_NMLEN 32 /* Image Name Length */
242
Fabio Estevam1411fb32013-01-03 08:24:33 +0000243/* Reused from common.h */
244#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
245
wdenk5b1d7132002-11-03 00:07:02 +0000246/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100247 * Legacy format image header,
248 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000249 */
wdenk5b1d7132002-11-03 00:07:02 +0000250typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000251 __be32 ih_magic; /* Image Header Magic Number */
252 __be32 ih_hcrc; /* Image Header CRC Checksum */
253 __be32 ih_time; /* Image Creation Timestamp */
254 __be32 ih_size; /* Image Data Size */
255 __be32 ih_load; /* Data Load Address */
256 __be32 ih_ep; /* Entry Point Address */
257 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000258 uint8_t ih_os; /* Operating System */
259 uint8_t ih_arch; /* CPU architecture */
260 uint8_t ih_type; /* Image Type */
261 uint8_t ih_comp; /* Compression Type */
262 uint8_t ih_name[IH_NMLEN]; /* Image Name */
263} image_header_t;
264
Kumar Gala396f6352008-08-15 08:24:41 -0500265typedef struct image_info {
266 ulong start, end; /* start/end of blob */
267 ulong image_start, image_len; /* start of image within blob, len of image */
268 ulong load; /* load addr for the image */
269 uint8_t comp, type, os; /* compression, type of image, os type */
270} image_info_t;
271
Marian Balakowicz559316f2008-01-08 18:11:44 +0100272/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100273 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
274 * routines.
275 */
276typedef struct bootm_headers {
277 /*
278 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100279 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100280 * data from second and third component accordingly.
281 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200282 image_header_t *legacy_hdr_os; /* image header pointer */
283 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100284 ulong legacy_hdr_valid;
285
286#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100287 const char *fit_uname_cfg; /* configuration node unit name */
288
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100289 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100290 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100291 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100292
293 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100294 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
295 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100296
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100297 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100298 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
299 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100300#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100301
Kumar Gala49c3a862008-10-21 17:25:45 -0500302#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500303 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500304 ulong ep; /* entry point of OS */
305
Kumar Galac4f94192008-08-15 08:24:37 -0500306 ulong rd_start, rd_end;/* ramdisk start/end */
307
Kumar Gala06a09912008-08-15 08:24:38 -0500308 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500309 ulong ft_len; /* length of flat device tree */
310
Kumar Gala49c3a862008-10-21 17:25:45 -0500311 ulong initrd_start;
312 ulong initrd_end;
313 ulong cmdline_start;
314 ulong cmdline_end;
315 bd_t *kbd;
316#endif
317
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100318 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500319
320#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700321#define BOOTM_STATE_FINDOS (0x00000002)
322#define BOOTM_STATE_FINDOTHER (0x00000004)
323#define BOOTM_STATE_LOADOS (0x00000008)
324#define BOOTM_STATE_RAMDISK (0x00000010)
325#define BOOTM_STATE_FDT (0x00000020)
326#define BOOTM_STATE_OS_CMDLINE (0x00000040)
327#define BOOTM_STATE_OS_BD_T (0x00000080)
328#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700329#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
330#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500331 int state;
332
Mike Frysingera16028d2009-11-03 11:35:59 -0500333#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500334 struct lmb lmb; /* for memory mgmt */
335#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100336} bootm_headers_t;
337
Simon Schwarz1648a372012-03-15 04:01:34 +0000338extern bootm_headers_t images;
339
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100340/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100341 * Some systems (for example LWMON) have very short watchdog periods;
342 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200343 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100344 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200345#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100346#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200347#endif
348
349#ifndef CHUNKSZ_CRC32
350#define CHUNKSZ_CRC32 (64 * 1024)
351#endif
352
353#ifndef CHUNKSZ_MD5
354#define CHUNKSZ_MD5 (64 * 1024)
355#endif
356
357#ifndef CHUNKSZ_SHA1
358#define CHUNKSZ_SHA1 (64 * 1024)
359#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100360
Mike Frysinger37566092009-07-02 19:23:25 -0400361#define uimage_to_cpu(x) be32_to_cpu(x)
362#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000363
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530364/*
365 * Translation table for entries of a specific type; used by
366 * get_table_entry_id() and get_table_entry_name().
367 */
368typedef struct table_entry {
369 int id;
370 char *sname; /* short (input) name to find table entry */
371 char *lname; /* long (output) name to print for messages */
372} table_entry_t;
373
374/*
375 * get_table_entry_id() scans the translation table trying to find an
376 * entry that matches the given short name. If a matching entry is
377 * found, it's id is returned to the caller.
378 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400379int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530380 const char *table_name, const char *name);
381/*
382 * get_table_entry_name() scans the translation table trying to find
383 * an entry that matches the given id. If a matching entry is found,
384 * its long name is returned to the caller.
385 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400386char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530387
Stephen Warren712fbcf2011-10-18 11:11:49 +0000388const char *genimg_get_os_name(uint8_t os);
389const char *genimg_get_arch_name(uint8_t arch);
390const char *genimg_get_type_name(uint8_t type);
391const char *genimg_get_comp_name(uint8_t comp);
392int genimg_get_os_id(const char *name);
393int genimg_get_arch_id(const char *name);
394int genimg_get_type_id(const char *name);
395int genimg_get_comp_id(const char *name);
396void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100397
Simon Glass859e92b2013-05-07 06:11:51 +0000398#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
399 defined(USE_HOSTCC)
400#define IMAGE_ENABLE_TIMESTAMP 1
401#else
402#define IMAGE_ENABLE_TIMESTAMP 0
403#endif
404void genimg_print_time(time_t timestamp);
405
Simon Glass782cfbb2013-05-16 13:53:21 +0000406/* What to do with a image load address ('load = <> 'in the FIT) */
407enum fit_load_op {
408 FIT_LOAD_IGNORED, /* Ignore load address */
409 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
410 FIT_LOAD_REQUIRED, /* Must be provided */
411};
412
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100413#ifndef USE_HOSTCC
414/* Image format types, returned by _get_format() routine */
415#define IMAGE_FORMAT_INVALID 0x00
Heiko Schocher21d29f72014-05-28 11:33:33 +0200416#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100417#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
Heiko Schocher21d29f72014-05-28 11:33:33 +0200418#endif
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100419#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -0500420#define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100421
Simon Glass35e7b0f2013-05-07 06:12:03 +0000422int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000423int genimg_has_config(bootm_headers_t *images);
424ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100425
Stephen Warren712fbcf2011-10-18 11:11:49 +0000426int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100427 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100428
Simon Glass782cfbb2013-05-16 13:53:21 +0000429/**
430 * fit_image_load() - load an image from a FIT
431 *
432 * This deals with all aspects of loading an image from a FIT, including
433 * selecting the right image based on configuration, verifying it, printing
434 * out progress messages, checking the type/arch/os and optionally copying it
435 * to the right load address.
436 *
Simon Glass126cc862014-06-12 07:24:47 -0600437 * The property to look up is defined by image_type.
438 *
Simon Glass782cfbb2013-05-16 13:53:21 +0000439 * @param images Boot images structure
Simon Glass782cfbb2013-05-16 13:53:21 +0000440 * @param addr Address of FIT in memory
441 * @param fit_unamep On entry this is the requested image name
442 * (e.g. "kernel@1") or NULL to use the default. On exit
443 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700444 * @param fit_uname_configp On entry this is the requested configuration
445 * name (e.g. "conf@1") or NULL to use the default. On
446 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000447 * @param arch Expected architecture (IH_ARCH_...)
448 * @param image_type Required image type (IH_TYPE_...). If this is
449 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
450 * also.
451 * @param bootstage_id ID of starting bootstage to use for progress updates.
452 * This will be added to the BOOTSTAGE_SUB values when
453 * calling bootstage_mark()
454 * @param load_op Decribes what to do with the load address
455 * @param datap Returns address of loaded image
456 * @param lenp Returns length of loaded image
457 */
Simon Glass126cc862014-06-12 07:24:47 -0600458int fit_image_load(bootm_headers_t *images, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700459 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000460 int arch, int image_type, int bootstage_id,
461 enum fit_load_op load_op, ulong *datap, ulong *lenp);
462
463/**
464 * fit_get_node_from_config() - Look up an image a FIT by type
465 *
466 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
467 * particular image type (e.g. "kernel") and then finds the image that is
468 * referred to.
469 *
470 * For example, for something like:
471 *
472 * images {
473 * kernel@1 {
474 * ...
475 * };
476 * };
477 * configurations {
478 * conf@1 {
479 * kernel = "kernel@1";
480 * };
481 * };
482 *
483 * the function will return the node offset of the kernel@1 node, assuming
484 * that conf@1 is the chosen configuration.
485 *
486 * @param images Boot images structure
487 * @param prop_name Property name to look up (FIT_..._PROP)
488 * @param addr Address of FIT in memory
489 */
490int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
491 ulong addr);
492
Simon Glass53f375f2013-05-16 13:53:23 +0000493int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
494 bootm_headers_t *images,
495 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000496void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000497int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500498
Stephen Warren712fbcf2011-10-18 11:11:49 +0000499int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100500 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000501int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600502#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000503int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600504#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100505#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100506
507/*******************************************************************/
508/* Legacy format specific code (prefixed with image_) */
509/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000510static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100511{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000512 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100513}
514
515#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200516 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100517 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000518 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100519 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000520image_get_hdr_l(magic) /* image_get_magic */
521image_get_hdr_l(hcrc) /* image_get_hcrc */
522image_get_hdr_l(time) /* image_get_time */
523image_get_hdr_l(size) /* image_get_size */
524image_get_hdr_l(load) /* image_get_load */
525image_get_hdr_l(ep) /* image_get_ep */
526image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100527
528#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200529 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100530 { \
531 return hdr->ih_##f; \
532 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000533image_get_hdr_b(os) /* image_get_os */
534image_get_hdr_b(arch) /* image_get_arch */
535image_get_hdr_b(type) /* image_get_type */
536image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100537
Stephen Warren712fbcf2011-10-18 11:11:49 +0000538static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100539{
540 return (char *)hdr->ih_name;
541}
542
Stephen Warren712fbcf2011-10-18 11:11:49 +0000543static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100544{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000545 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100546}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100547
548/**
549 * image_get_data - get image payload start address
550 * @hdr: image header
551 *
552 * image_get_data() returns address of the image payload. For single
553 * component images it is image data start. For multi component
554 * images it points to the null terminated table of sub-images sizes.
555 *
556 * returns:
557 * image payload data start address
558 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000559static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100560{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000561 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100562}
563
Stephen Warren712fbcf2011-10-18 11:11:49 +0000564static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100565{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000566 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100567}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000568static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100569{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000570 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100571}
572
573#define image_set_hdr_l(f) \
574 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
575 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000576 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100577 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000578image_set_hdr_l(magic) /* image_set_magic */
579image_set_hdr_l(hcrc) /* image_set_hcrc */
580image_set_hdr_l(time) /* image_set_time */
581image_set_hdr_l(size) /* image_set_size */
582image_set_hdr_l(load) /* image_set_load */
583image_set_hdr_l(ep) /* image_set_ep */
584image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100585
586#define image_set_hdr_b(f) \
587 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
588 { \
589 hdr->ih_##f = val; \
590 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000591image_set_hdr_b(os) /* image_set_os */
592image_set_hdr_b(arch) /* image_set_arch */
593image_set_hdr_b(type) /* image_set_type */
594image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100595
Stephen Warren712fbcf2011-10-18 11:11:49 +0000596static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100597{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000598 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100599}
600
Stephen Warren712fbcf2011-10-18 11:11:49 +0000601int image_check_hcrc(const image_header_t *hdr);
602int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100603#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600604ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500605phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000606phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000607void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100608#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100609
Stephen Warren712fbcf2011-10-18 11:11:49 +0000610static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100611{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000612 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100613}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000614static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100615{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000616 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100617}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000618static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100619{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000620 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100621}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000622static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100623{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000624 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100625}
626
Stephen Warren712fbcf2011-10-18 11:11:49 +0000627ulong image_multi_count(const image_header_t *hdr);
628void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100629 ulong *data, ulong *len);
630
Stephen Warren712fbcf2011-10-18 11:11:49 +0000631void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100632
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100633#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000634static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100635{
Mike Frysinger476af292011-10-03 14:50:33 +0000636#ifndef IH_ARCH_DEFAULT
637# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100638#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000639 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100640}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100641#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100642
Simon Glass13d06982013-05-08 08:06:01 +0000643/**
644 * Set up properties in the FDT
645 *
646 * This sets up properties in the FDT that is to be passed to linux.
647 *
648 * @images: Images information
649 * @blob: FDT to update
650 * @of_size: Size of the FDT
651 * @lmb: Points to logical memory block structure
652 * @return 0 if ok, <0 on failure
653 */
654int image_setup_libfdt(bootm_headers_t *images, void *blob,
655 int of_size, struct lmb *lmb);
656
657/**
658 * Set up the FDT to use for booting a kernel
659 *
660 * This performs ramdisk setup, sets up the FDT if required, and adds
661 * paramters to the FDT if libfdt is available.
662 *
663 * @param images Images information
664 * @return 0 if ok, <0 on failure
665 */
666int image_setup_linux(bootm_headers_t *images);
667
Simon Glassa5266d62013-07-04 13:26:10 -0700668/**
669 * bootz_setup() - Extract stat and size of a Linux xImage
670 *
671 * @image: Address of image
672 * @start: Returns start address of image
673 * @end : Returns end address of image
674 * @return 0 if OK, 1 if the image was not recognised
675 */
676int bootz_setup(ulong image, ulong *start, ulong *end);
677
678
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100679/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100680/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100681/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100682#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100683
684#define FIT_IMAGES_PATH "/images"
685#define FIT_CONFS_PATH "/configurations"
686
Simon Glass3e569a62013-06-13 15:10:00 -0700687/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100688#define FIT_HASH_NODENAME "hash"
689#define FIT_ALGO_PROP "algo"
690#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000691#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700692#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100693
694/* image node */
695#define FIT_DATA_PROP "data"
696#define FIT_TIMESTAMP_PROP "timestamp"
697#define FIT_DESC_PROP "description"
698#define FIT_ARCH_PROP "arch"
699#define FIT_TYPE_PROP "type"
700#define FIT_OS_PROP "os"
701#define FIT_COMP_PROP "compression"
702#define FIT_ENTRY_PROP "entry"
703#define FIT_LOAD_PROP "load"
704
705/* configuration node */
706#define FIT_KERNEL_PROP "kernel"
707#define FIT_RAMDISK_PROP "ramdisk"
708#define FIT_FDT_PROP "fdt"
709#define FIT_DEFAULT_PROP "default"
710
Michael van der Westhuizen1de7bb42014-05-30 20:59:00 +0200711#define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100712
713/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000714int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100715 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000716int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100717 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100718
Stephen Warren712fbcf2011-10-18 11:11:49 +0000719void fit_print_contents(const void *fit);
720void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100721
722/**
723 * fit_get_end - get FIT image size
724 * @fit: pointer to the FIT format image header
725 *
726 * returns:
727 * size of the FIT image (blob) in memory
728 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000729static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100730{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000731 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100732}
733
734/**
735 * fit_get_end - get FIT image end
736 * @fit: pointer to the FIT format image header
737 *
738 * returns:
739 * end address of the FIT image (blob) in memory
740 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000741static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100742{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000743 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100744}
745
746/**
747 * fit_get_name - get FIT node name
748 * @fit: pointer to the FIT format image header
749 *
750 * returns:
751 * NULL, on error
752 * pointer to node name, on success
753 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000754static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100755 int noffset, int *len)
756{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000757 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100758}
759
Stephen Warren712fbcf2011-10-18 11:11:49 +0000760int fit_get_desc(const void *fit, int noffset, char **desc);
761int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100762
Stephen Warren712fbcf2011-10-18 11:11:49 +0000763int fit_image_get_node(const void *fit, const char *image_uname);
764int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
765int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
766int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
767int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
768int fit_image_get_load(const void *fit, int noffset, ulong *load);
769int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
770int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100771 const void **data, size_t *size);
772
Stephen Warren712fbcf2011-10-18 11:11:49 +0000773int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
774int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100775 int *value_len);
776
Stephen Warren712fbcf2011-10-18 11:11:49 +0000777int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000778
779/**
Simon Glass56518e72013-06-13 15:10:01 -0700780 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000781 *
Simon Glass56518e72013-06-13 15:10:01 -0700782 * @keydir: Directory containing keys
783 * @kwydest: FDT blob to write public key information to
784 * @fit: Pointer to the FIT format image header
785 * @comment: Comment to add to signature nodes
786 * @require_keys: Mark all keys as 'required'
787 *
788 * Adds hash values for all component images in the FIT blob.
789 * Hashes are calculated for all component images which have hash subnodes
790 * with algorithm property set to one of the supported hash algorithms.
791 *
792 * Also add signatures if signature nodes are present.
793 *
794 * returns
795 * 0, on success
796 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000797 */
Simon Glass56518e72013-06-13 15:10:01 -0700798int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
799 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100800
Simon Glassb8da8362013-05-07 06:11:57 +0000801int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000802int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000803int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000804int fit_image_check_os(const void *fit, int noffset, uint8_t os);
805int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
806int fit_image_check_type(const void *fit, int noffset, uint8_t type);
807int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
808int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100809
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000810int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000811int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100812
Simon Glass003efd72013-05-07 06:12:00 +0000813/**
814 * fit_conf_get_prop_node() - Get node refered to by a configuration
815 * @fit: FIT to check
816 * @noffset: Offset of conf@xxx node to check
817 * @prop_name: Property to read from the conf node
818 *
819 * The conf@ nodes contain references to other nodes, using properties
820 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
821 * return the offset of the node referred to (e.g. offset of node
822 * "/images/kernel@1".
823 */
824int fit_conf_get_prop_node(const void *fit, int noffset,
825 const char *prop_name);
826
Stephen Warren712fbcf2011-10-18 11:11:49 +0000827void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100828
Simon Glass61a439a2013-05-07 06:11:52 +0000829int fit_check_ramdisk(const void *fit, int os_noffset,
830 uint8_t arch, int verify);
831
Simon Glass604f23d2013-05-07 06:11:54 +0000832int calculate_hash(const void *data, int data_len, const char *algo,
833 uint8_t *value, int *value_len);
834
Simon Glass782cfbb2013-05-16 13:53:21 +0000835/*
Simon Glass3e569a62013-06-13 15:10:00 -0700836 * At present we only support signing on the host, and verification on the
837 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000838 */
839#if defined(CONFIG_FIT_SIGNATURE)
840# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700841# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +0100842# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +0100843# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +0000844#else
Simon Glass3e569a62013-06-13 15:10:00 -0700845# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000846# define IMAGE_ENABLE_VERIFY 1
847# endif
848#else
Simon Glass3e569a62013-06-13 15:10:00 -0700849# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000850# define IMAGE_ENABLE_VERIFY 0
851#endif
852
853#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +0100854void *image_get_host_blob(void);
855void image_set_host_blob(void *host_blob);
856# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +0000857#else
858# define gd_fdt_blob() (gd->fdt_blob)
859#endif
860
861#ifdef CONFIG_FIT_BEST_MATCH
862#define IMAGE_ENABLE_BEST_MATCH 1
863#else
864#define IMAGE_ENABLE_BEST_MATCH 0
865#endif
866
Simon Glass3e569a62013-06-13 15:10:00 -0700867/* Information passed to the signing routines */
868struct image_sign_info {
869 const char *keydir; /* Directory conaining keys */
870 const char *keyname; /* Name of key to use */
871 void *fit; /* Pointer to FIT blob */
872 int node_offset; /* Offset of signature node */
873 struct image_sig_algo *algo; /* Algorithm information */
874 const void *fdt_blob; /* FDT containing public keys */
875 int required_keynode; /* Node offset of key to use: -1=any */
876 const char *require_keys; /* Value for 'required' property */
877};
878
879/* A part of an image, used for hashing */
880struct image_region {
881 const void *data;
882 int size;
883};
884
Heiko Schocher646257d2014-03-03 12:19:26 +0100885#if IMAGE_ENABLE_VERIFY
886# include <rsa-checksum.h>
887#endif
888struct checksum_algo {
889 const char *name;
890 const int checksum_len;
Heiko Schocherdb1b5f32014-03-03 12:19:27 +0100891 const int pad_len;
Heiko Schocher646257d2014-03-03 12:19:26 +0100892#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +0100893 const EVP_MD *(*calculate_sign)(void);
894#endif
Heiko Schocher646257d2014-03-03 12:19:26 +0100895 void (*calculate)(const struct image_region region[],
896 int region_count, uint8_t *checksum);
897 const uint8_t *rsa_padding;
Heiko Schocher646257d2014-03-03 12:19:26 +0100898};
899
Simon Glass3e569a62013-06-13 15:10:00 -0700900struct image_sig_algo {
901 const char *name; /* Name of algorithm */
902
903 /**
904 * sign() - calculate and return signature for given input data
905 *
906 * @info: Specifies key and FIT information
907 * @data: Pointer to the input data
908 * @data_len: Data length
909 * @sigp: Set to an allocated buffer holding the signature
910 * @sig_len: Set to length of the calculated hash
911 *
912 * This computes input data signature according to selected algorithm.
913 * Resulting signature value is placed in an allocated buffer, the
914 * pointer is returned as *sigp. The length of the calculated
915 * signature is returned via the sig_len pointer argument. The caller
916 * should free *sigp.
917 *
918 * @return: 0, on success, -ve on error
919 */
920 int (*sign)(struct image_sign_info *info,
921 const struct image_region region[],
922 int region_count, uint8_t **sigp, uint *sig_len);
923
924 /**
925 * add_verify_data() - Add verification information to FDT
926 *
927 * Add public key information to the FDT node, suitable for
928 * verification at run-time. The information added depends on the
929 * algorithm being used.
930 *
931 * @info: Specifies key and FIT information
932 * @keydest: Destination FDT blob for public key data
933 * @return: 0, on success, -ve on error
934 */
935 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
936
937 /**
938 * verify() - Verify a signature against some data
939 *
940 * @info: Specifies key and FIT information
941 * @data: Pointer to the input data
942 * @data_len: Data length
943 * @sig: Signature
944 * @sig_len: Number of bytes in signature
945 * @return 0 if verified, -ve on error
946 */
947 int (*verify)(struct image_sign_info *info,
948 const struct image_region region[], int region_count,
949 uint8_t *sig, uint sig_len);
Heiko Schocher646257d2014-03-03 12:19:26 +0100950
951 /* pointer to checksum algorithm */
952 struct checksum_algo *checksum;
Simon Glass3e569a62013-06-13 15:10:00 -0700953};
954
955/**
956 * image_get_sig_algo() - Look up a signature algortihm
957 *
958 * @param name Name of algorithm
959 * @return pointer to algorithm information, or NULL if not found
960 */
961struct image_sig_algo *image_get_sig_algo(const char *name);
962
Simon Glass56518e72013-06-13 15:10:01 -0700963/**
964 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
965 *
966 * @fit: FIT to check
967 * @image_noffset: Offset of image node to check
968 * @data: Image data to check
969 * @size: Size of image data
970 * @sig_blob: FDT containing public keys
971 * @no_sigsp: Returns 1 if no signatures were required, and
972 * therefore nothing was checked. The caller may wish
973 * to fall back to other mechanisms, or refuse to
974 * boot.
975 * @return 0 if all verified ok, <0 on error
976 */
977int fit_image_verify_required_sigs(const void *fit, int image_noffset,
978 const char *data, size_t size, const void *sig_blob,
979 int *no_sigsp);
980
981/**
982 * fit_image_check_sig() - Check a single image signature node
983 *
984 * @fit: FIT to check
985 * @noffset: Offset of signature node to check
986 * @data: Image data to check
987 * @size: Size of image data
988 * @required_keynode: Offset in the control FDT of the required key node,
989 * if any. If this is given, then the image wil not
990 * pass verification unless that key is used. If this is
991 * -1 then any signature will do.
992 * @err_msgp: In the event of an error, this will be pointed to a
993 * help error string to display to the user.
994 * @return 0 if all verified ok, <0 on error
995 */
996int fit_image_check_sig(const void *fit, int noffset, const void *data,
997 size_t size, int required_keynode, char **err_msgp);
998
Simon Glass4d098522013-06-13 15:10:09 -0700999/**
1000 * fit_region_make_list() - Make a list of regions to hash
1001 *
1002 * Given a list of FIT regions (offset, size) provided by libfdt, create
1003 * a list of regions (void *, size) for use by the signature creationg
1004 * and verification code.
1005 *
1006 * @fit: FIT image to process
1007 * @fdt_regions: Regions as returned by libfdt
1008 * @count: Number of regions returned by libfdt
1009 * @region: Place to put list of regions (NULL to allocate it)
1010 * @return pointer to list of regions, or NULL if out of memory
1011 */
1012struct image_region *fit_region_make_list(const void *fit,
1013 struct fdt_region *fdt_regions, int count,
1014 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001015
Stephen Warren712fbcf2011-10-18 11:11:49 +00001016static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001017{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001018#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001019 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001020#else
1021 return 0;
1022#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001023}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001024
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001025#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001026#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001027 "FIT images not supported for '%s'\n", \
1028 __FILE__, __LINE__, (msg))
1029
Stephen Warren712fbcf2011-10-18 11:11:49 +00001030#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001031 "FIT images not supported for '%s' " \
1032 "- must reset board to recover!\n", \
1033 __FILE__, __LINE__, (msg))
1034#else
1035#define fit_unsupported(msg)
1036#define fit_unsupported_reset(msg)
1037#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001038#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001039
Sebastian Siewior9ace3fc2014-05-05 15:08:09 -05001040#if defined(CONFIG_ANDROID_BOOT_IMAGE)
1041struct andr_img_hdr;
1042int android_image_check_header(const struct andr_img_hdr *hdr);
1043int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1044 ulong *os_data, ulong *os_len);
1045int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1046 ulong *rd_data, ulong *rd_len);
1047ulong android_image_get_end(const struct andr_img_hdr *hdr);
1048ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1049
1050#endif /* CONFIG_ANDROID_BOOT_IMAGE */
1051
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001052#endif /* __IMAGE_H__ */