blob: da7b9a04f1e3414af183e2e4265dcba8dfb02712 [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 *
7 * See file CREDITS for list of people who contributed to this
8 * project.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23 * MA 02111-1307 USA
Wolfgang Denkf08abe32005-11-25 16:38:03 +010024 *
25 ********************************************************************
26 * NOTE: This header file defines an interface to U-Boot. Including
27 * this (unmodified) header file in another file is considered normal
28 * use of U-Boot, and does *not* fall under the heading of "derived
29 * work".
30 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000031 */
32
33#ifndef __IMAGE_H__
34#define __IMAGE_H__
35
Mike Frysinger37566092009-07-02 19:23:25 -040036#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000037#include <asm/byteorder.h>
Mike Frysinger37566092009-07-02 19:23:25 -040038
Simon Glass13d06982013-05-08 08:06:01 +000039/* Define this to avoid #ifdefs later on */
40struct lmb;
41
Mike Frysinger37566092009-07-02 19:23:25 -040042#ifdef USE_HOSTCC
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010043
44/* new uImage format support enabled on host */
45#define CONFIG_FIT 1
46#define CONFIG_OF_LIBFDT 1
47#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
48
Simon Glass3e569a62013-06-13 15:10:00 -070049/* Support FIT image signing on host */
50#define CONFIG_FIT_SIGNATURE
51
Simon Glassab9efc62013-05-07 06:11:58 +000052#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000053#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000054
Wolfgang Denkdef08192008-10-21 11:23:56 +020055#else
56
57#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020058#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050059#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020060
Simon Glassab9efc62013-05-07 06:11:58 +000061/* Take notice of the 'ignore' property for hashes */
62#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000063#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000064
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010065#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010066
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010067#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010068#include <libfdt.h>
69#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000070# ifdef CONFIG_SPL_BUILD
71# ifdef CONFIG_SPL_CRC32_SUPPORT
72# define IMAGE_ENABLE_CRC32 1
73# endif
74# ifdef CONFIG_SPL_MD5_SUPPORT
75# define IMAGE_ENABLE_MD5 1
76# endif
77# ifdef CONFIG_SPL_SHA1_SUPPORT
78# define IMAGE_ENABLE_SHA1 1
79# endif
80# else
81# define CONFIG_CRC32 /* FIT images need CRC32 support */
82# define CONFIG_MD5 /* and MD5 */
83# define CONFIG_SHA1 /* and SHA1 */
84# define IMAGE_ENABLE_CRC32 1
85# define IMAGE_ENABLE_MD5 1
86# define IMAGE_ENABLE_SHA1 1
87# endif
88
89#ifndef IMAGE_ENABLE_CRC32
90#define IMAGE_ENABLE_CRC32 0
91#endif
92
93#ifndef IMAGE_ENABLE_MD5
94#define IMAGE_ENABLE_MD5 0
95#endif
96
97#ifndef IMAGE_ENABLE_SHA1
98#define IMAGE_ENABLE_SHA1 0
99#endif
100
Simon Glass13d06982013-05-08 08:06:01 +0000101#endif /* CONFIG_FIT */
102
103#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
104# define IMAGE_ENABLE_RAMDISK_HIGH 1
105#else
106# define IMAGE_ENABLE_RAMDISK_HIGH 0
107#endif
108
109#ifdef CONFIG_OF_LIBFDT
110# define IMAGE_ENABLE_OF_LIBFDT 1
111#else
112# define IMAGE_ENABLE_OF_LIBFDT 0
113#endif
114
115#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
116# define IMAGE_BOOT_GET_CMDLINE 1
117#else
118# define IMAGE_BOOT_GET_CMDLINE 0
119#endif
120
121#ifdef CONFIG_OF_BOARD_SETUP
122# define IMAAGE_OF_BOARD_SETUP 1
123#else
124# define IMAAGE_OF_BOARD_SETUP 0
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100125#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100126
wdenk5b1d7132002-11-03 00:07:02 +0000127/*
128 * Operating System Codes
129 */
130#define IH_OS_INVALID 0 /* Invalid OS */
131#define IH_OS_OPENBSD 1 /* OpenBSD */
132#define IH_OS_NETBSD 2 /* NetBSD */
133#define IH_OS_FREEBSD 3 /* FreeBSD */
134#define IH_OS_4_4BSD 4 /* 4.4BSD */
135#define IH_OS_LINUX 5 /* Linux */
136#define IH_OS_SVR4 6 /* SVR4 */
137#define IH_OS_ESIX 7 /* Esix */
138#define IH_OS_SOLARIS 8 /* Solaris */
139#define IH_OS_IRIX 9 /* Irix */
140#define IH_OS_SCO 10 /* SCO */
141#define IH_OS_DELL 11 /* Dell */
142#define IH_OS_NCR 12 /* NCR */
143#define IH_OS_LYNXOS 13 /* LynxOS */
144#define IH_OS_VXWORKS 14 /* VxWorks */
145#define IH_OS_PSOS 15 /* pSOS */
146#define IH_OS_QNX 16 /* QNX */
147#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000148#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000149#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000150#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500151#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200152#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000153#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000154
155/*
156 * CPU Architecture Codes (supported by Linux)
157 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100158#define IH_ARCH_INVALID 0 /* Invalid CPU */
159#define IH_ARCH_ALPHA 1 /* Alpha */
160#define IH_ARCH_ARM 2 /* ARM */
161#define IH_ARCH_I386 3 /* Intel x86 */
162#define IH_ARCH_IA64 4 /* IA64 */
163#define IH_ARCH_MIPS 5 /* MIPS */
164#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
165#define IH_ARCH_PPC 7 /* PowerPC */
166#define IH_ARCH_S390 8 /* IBM S390 */
167#define IH_ARCH_SH 9 /* SuperH */
168#define IH_ARCH_SPARC 10 /* Sparc */
169#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
170#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100171#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
172#define IH_ARCH_NIOS2 15 /* Nios-II */
173#define IH_ARCH_BLACKFIN 16 /* Blackfin */
174#define IH_ARCH_AVR32 17 /* AVR32 */
175#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000176#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000177#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000178#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
wdenk5b1d7132002-11-03 00:07:02 +0000179
180/*
181 * Image Types
182 *
183 * "Standalone Programs" are directly runnable in the environment
184 * provided by U-Boot; it is expected that (if they behave
185 * well) you can continue to work in U-Boot after return from
186 * the Standalone Program.
187 * "OS Kernel Images" are usually images of some Embedded OS which
188 * will take over control completely. Usually these programs
189 * will install their own set of exception handlers, device
190 * drivers, set up the MMU, etc. - this means, that you cannot
191 * expect to re-enter U-Boot except by resetting the CPU.
192 * "RAMDisk Images" are more or less just data blocks, and their
193 * parameters (address, size) are passed to an OS kernel that is
194 * being started.
195 * "Multi-File Images" contain several images, typically an OS
196 * (Linux) kernel image and one or more data images like
197 * RAMDisks. This construct is useful for instance when you want
198 * to boot over the network using BOOTP etc., where the boot
199 * server provides just a single image file, but you want to get
200 * for instance an OS kernel and a RAMDisk image.
201 *
202 * "Multi-File Images" start with a list of image sizes, each
203 * image size (in bytes) specified by an "uint32_t" in network
204 * byte order. This list is terminated by an "(uint32_t)0".
205 * Immediately after the terminating 0 follow the images, one by
206 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000207 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000208 *
209 * "Firmware Images" are binary images containing firmware (like
210 * U-Boot or FPGA images) which usually will be programmed to
211 * flash memory.
212 *
213 * "Script files" are command sequences that will be executed by
214 * U-Boot's command interpreter; this feature is especially
215 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000216 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000217 */
218
219#define IH_TYPE_INVALID 0 /* Invalid Image */
220#define IH_TYPE_STANDALONE 1 /* Standalone Program */
221#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
222#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
223#define IH_TYPE_MULTI 4 /* Multi-File Image */
224#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
225#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000226#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500227#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530228#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100229#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000230#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400231#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000232#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e82011-11-10 13:17:53 -0700233#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000234#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000235
236/*
237 * Compression Types
238 */
239#define IH_COMP_NONE 0 /* No Compression Used */
240#define IH_COMP_GZIP 1 /* gzip Compression Used */
241#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200242#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100243#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000244
245#define IH_MAGIC 0x27051956 /* Image Magic Number */
246#define IH_NMLEN 32 /* Image Name Length */
247
Fabio Estevam1411fb32013-01-03 08:24:33 +0000248/* Reused from common.h */
249#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
250
wdenk5b1d7132002-11-03 00:07:02 +0000251/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100252 * Legacy format image header,
253 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000254 */
wdenk5b1d7132002-11-03 00:07:02 +0000255typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000256 __be32 ih_magic; /* Image Header Magic Number */
257 __be32 ih_hcrc; /* Image Header CRC Checksum */
258 __be32 ih_time; /* Image Creation Timestamp */
259 __be32 ih_size; /* Image Data Size */
260 __be32 ih_load; /* Data Load Address */
261 __be32 ih_ep; /* Entry Point Address */
262 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000263 uint8_t ih_os; /* Operating System */
264 uint8_t ih_arch; /* CPU architecture */
265 uint8_t ih_type; /* Image Type */
266 uint8_t ih_comp; /* Compression Type */
267 uint8_t ih_name[IH_NMLEN]; /* Image Name */
268} image_header_t;
269
Kumar Gala396f6352008-08-15 08:24:41 -0500270typedef struct image_info {
271 ulong start, end; /* start/end of blob */
272 ulong image_start, image_len; /* start of image within blob, len of image */
273 ulong load; /* load addr for the image */
274 uint8_t comp, type, os; /* compression, type of image, os type */
275} image_info_t;
276
Marian Balakowicz559316f2008-01-08 18:11:44 +0100277/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100278 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
279 * routines.
280 */
281typedef struct bootm_headers {
282 /*
283 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100284 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100285 * data from second and third component accordingly.
286 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200287 image_header_t *legacy_hdr_os; /* image header pointer */
288 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100289 ulong legacy_hdr_valid;
290
291#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100292 const char *fit_uname_cfg; /* configuration node unit name */
293
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100294 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100295 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100296 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100297
298 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100299 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
300 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100301
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100302 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100303 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
304 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100305#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100306
Kumar Gala49c3a862008-10-21 17:25:45 -0500307#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500308 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500309 ulong ep; /* entry point of OS */
310
Kumar Galac4f94192008-08-15 08:24:37 -0500311 ulong rd_start, rd_end;/* ramdisk start/end */
312
Kumar Gala06a09912008-08-15 08:24:38 -0500313 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500314 ulong ft_len; /* length of flat device tree */
315
Kumar Gala49c3a862008-10-21 17:25:45 -0500316 ulong initrd_start;
317 ulong initrd_end;
318 ulong cmdline_start;
319 ulong cmdline_end;
320 bd_t *kbd;
321#endif
322
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100323 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500324
325#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700326#define BOOTM_STATE_FINDOS (0x00000002)
327#define BOOTM_STATE_FINDOTHER (0x00000004)
328#define BOOTM_STATE_LOADOS (0x00000008)
329#define BOOTM_STATE_RAMDISK (0x00000010)
330#define BOOTM_STATE_FDT (0x00000020)
331#define BOOTM_STATE_OS_CMDLINE (0x00000040)
332#define BOOTM_STATE_OS_BD_T (0x00000080)
333#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700334#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
335#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500336 int state;
337
Mike Frysingera16028d2009-11-03 11:35:59 -0500338#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500339 struct lmb lmb; /* for memory mgmt */
340#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100341} bootm_headers_t;
342
Simon Schwarz1648a372012-03-15 04:01:34 +0000343extern bootm_headers_t images;
344
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100345/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100346 * Some systems (for example LWMON) have very short watchdog periods;
347 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200348 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100349 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200350#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100351#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200352#endif
353
354#ifndef CHUNKSZ_CRC32
355#define CHUNKSZ_CRC32 (64 * 1024)
356#endif
357
358#ifndef CHUNKSZ_MD5
359#define CHUNKSZ_MD5 (64 * 1024)
360#endif
361
362#ifndef CHUNKSZ_SHA1
363#define CHUNKSZ_SHA1 (64 * 1024)
364#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100365
Mike Frysinger37566092009-07-02 19:23:25 -0400366#define uimage_to_cpu(x) be32_to_cpu(x)
367#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000368
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530369/*
370 * Translation table for entries of a specific type; used by
371 * get_table_entry_id() and get_table_entry_name().
372 */
373typedef struct table_entry {
374 int id;
375 char *sname; /* short (input) name to find table entry */
376 char *lname; /* long (output) name to print for messages */
377} table_entry_t;
378
379/*
380 * get_table_entry_id() scans the translation table trying to find an
381 * entry that matches the given short name. If a matching entry is
382 * found, it's id is returned to the caller.
383 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400384int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530385 const char *table_name, const char *name);
386/*
387 * get_table_entry_name() scans the translation table trying to find
388 * an entry that matches the given id. If a matching entry is found,
389 * its long name is returned to the caller.
390 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400391char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530392
Stephen Warren712fbcf2011-10-18 11:11:49 +0000393const char *genimg_get_os_name(uint8_t os);
394const char *genimg_get_arch_name(uint8_t arch);
395const char *genimg_get_type_name(uint8_t type);
396const char *genimg_get_comp_name(uint8_t comp);
397int genimg_get_os_id(const char *name);
398int genimg_get_arch_id(const char *name);
399int genimg_get_type_id(const char *name);
400int genimg_get_comp_id(const char *name);
401void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100402
Simon Glass859e92b2013-05-07 06:11:51 +0000403#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
404 defined(USE_HOSTCC)
405#define IMAGE_ENABLE_TIMESTAMP 1
406#else
407#define IMAGE_ENABLE_TIMESTAMP 0
408#endif
409void genimg_print_time(time_t timestamp);
410
Simon Glass782cfbb2013-05-16 13:53:21 +0000411/* What to do with a image load address ('load = <> 'in the FIT) */
412enum fit_load_op {
413 FIT_LOAD_IGNORED, /* Ignore load address */
414 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
415 FIT_LOAD_REQUIRED, /* Must be provided */
416};
417
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100418#ifndef USE_HOSTCC
419/* Image format types, returned by _get_format() routine */
420#define IMAGE_FORMAT_INVALID 0x00
421#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
422#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
423
Simon Glass35e7b0f2013-05-07 06:12:03 +0000424int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000425int genimg_has_config(bootm_headers_t *images);
426ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100427
Stephen Warren712fbcf2011-10-18 11:11:49 +0000428int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100429 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100430
Simon Glass782cfbb2013-05-16 13:53:21 +0000431/**
432 * fit_image_load() - load an image from a FIT
433 *
434 * This deals with all aspects of loading an image from a FIT, including
435 * selecting the right image based on configuration, verifying it, printing
436 * out progress messages, checking the type/arch/os and optionally copying it
437 * to the right load address.
438 *
439 * @param images Boot images structure
440 * @param prop_name Property name to look up (FIT_..._PROP)
441 * @param addr Address of FIT in memory
442 * @param fit_unamep On entry this is the requested image name
443 * (e.g. "kernel@1") or NULL to use the default. On exit
444 * points to the selected image name
445 * @param fit_uname_config Requested configuration name, or NULL for the
446 * default
447 * @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 */
458int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
459 const char **fit_unamep, const char *fit_uname_config,
460 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
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100668/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100669/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100670/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100671#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100672
673#define FIT_IMAGES_PATH "/images"
674#define FIT_CONFS_PATH "/configurations"
675
Simon Glass3e569a62013-06-13 15:10:00 -0700676/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100677#define FIT_HASH_NODENAME "hash"
678#define FIT_ALGO_PROP "algo"
679#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000680#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700681#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100682
683/* image node */
684#define FIT_DATA_PROP "data"
685#define FIT_TIMESTAMP_PROP "timestamp"
686#define FIT_DESC_PROP "description"
687#define FIT_ARCH_PROP "arch"
688#define FIT_TYPE_PROP "type"
689#define FIT_OS_PROP "os"
690#define FIT_COMP_PROP "compression"
691#define FIT_ENTRY_PROP "entry"
692#define FIT_LOAD_PROP "load"
693
694/* configuration node */
695#define FIT_KERNEL_PROP "kernel"
696#define FIT_RAMDISK_PROP "ramdisk"
697#define FIT_FDT_PROP "fdt"
698#define FIT_DEFAULT_PROP "default"
699
700#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
701
702/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000703int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100704 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000705int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100706 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100707
Stephen Warren712fbcf2011-10-18 11:11:49 +0000708void fit_print_contents(const void *fit);
709void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100710
711/**
712 * fit_get_end - get FIT image size
713 * @fit: pointer to the FIT format image header
714 *
715 * returns:
716 * size of the FIT image (blob) in memory
717 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000718static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100719{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000720 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100721}
722
723/**
724 * fit_get_end - get FIT image end
725 * @fit: pointer to the FIT format image header
726 *
727 * returns:
728 * end address of the FIT image (blob) in memory
729 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000730static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100731{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000732 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100733}
734
735/**
736 * fit_get_name - get FIT node name
737 * @fit: pointer to the FIT format image header
738 *
739 * returns:
740 * NULL, on error
741 * pointer to node name, on success
742 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000743static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100744 int noffset, int *len)
745{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000746 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100747}
748
Stephen Warren712fbcf2011-10-18 11:11:49 +0000749int fit_get_desc(const void *fit, int noffset, char **desc);
750int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100751
Stephen Warren712fbcf2011-10-18 11:11:49 +0000752int fit_image_get_node(const void *fit, const char *image_uname);
753int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
754int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
755int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
756int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
757int fit_image_get_load(const void *fit, int noffset, ulong *load);
758int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
759int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100760 const void **data, size_t *size);
761
Stephen Warren712fbcf2011-10-18 11:11:49 +0000762int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
763int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100764 int *value_len);
765
Stephen Warren712fbcf2011-10-18 11:11:49 +0000766int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000767
768/**
Simon Glass56518e72013-06-13 15:10:01 -0700769 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000770 *
Simon Glass56518e72013-06-13 15:10:01 -0700771 * @keydir: Directory containing keys
772 * @kwydest: FDT blob to write public key information to
773 * @fit: Pointer to the FIT format image header
774 * @comment: Comment to add to signature nodes
775 * @require_keys: Mark all keys as 'required'
776 *
777 * Adds hash values for all component images in the FIT blob.
778 * Hashes are calculated for all component images which have hash subnodes
779 * with algorithm property set to one of the supported hash algorithms.
780 *
781 * Also add signatures if signature nodes are present.
782 *
783 * returns
784 * 0, on success
785 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000786 */
Simon Glass56518e72013-06-13 15:10:01 -0700787int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
788 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100789
Simon Glassb8da8362013-05-07 06:11:57 +0000790int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000791int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000792int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000793int fit_image_check_os(const void *fit, int noffset, uint8_t os);
794int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
795int fit_image_check_type(const void *fit, int noffset, uint8_t type);
796int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
797int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100798
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000799int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000800int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100801
Simon Glass003efd72013-05-07 06:12:00 +0000802/**
803 * fit_conf_get_prop_node() - Get node refered to by a configuration
804 * @fit: FIT to check
805 * @noffset: Offset of conf@xxx node to check
806 * @prop_name: Property to read from the conf node
807 *
808 * The conf@ nodes contain references to other nodes, using properties
809 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
810 * return the offset of the node referred to (e.g. offset of node
811 * "/images/kernel@1".
812 */
813int fit_conf_get_prop_node(const void *fit, int noffset,
814 const char *prop_name);
815
Stephen Warren712fbcf2011-10-18 11:11:49 +0000816void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100817
Simon Glass61a439a2013-05-07 06:11:52 +0000818int fit_check_ramdisk(const void *fit, int os_noffset,
819 uint8_t arch, int verify);
820
Simon Glass604f23d2013-05-07 06:11:54 +0000821int calculate_hash(const void *data, int data_len, const char *algo,
822 uint8_t *value, int *value_len);
823
Simon Glass782cfbb2013-05-16 13:53:21 +0000824/*
Simon Glass3e569a62013-06-13 15:10:00 -0700825 * At present we only support signing on the host, and verification on the
826 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000827 */
828#if defined(CONFIG_FIT_SIGNATURE)
829# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700830# define IMAGE_ENABLE_SIGN 1
Simon Glass782cfbb2013-05-16 13:53:21 +0000831# define IMAGE_ENABLE_VERIFY 0
832#else
Simon Glass3e569a62013-06-13 15:10:00 -0700833# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000834# define IMAGE_ENABLE_VERIFY 1
835# endif
836#else
Simon Glass3e569a62013-06-13 15:10:00 -0700837# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000838# define IMAGE_ENABLE_VERIFY 0
839#endif
840
841#ifdef USE_HOSTCC
842# define gd_fdt_blob() NULL
843#else
844# define gd_fdt_blob() (gd->fdt_blob)
845#endif
846
847#ifdef CONFIG_FIT_BEST_MATCH
848#define IMAGE_ENABLE_BEST_MATCH 1
849#else
850#define IMAGE_ENABLE_BEST_MATCH 0
851#endif
852
Simon Glass3e569a62013-06-13 15:10:00 -0700853/* Information passed to the signing routines */
854struct image_sign_info {
855 const char *keydir; /* Directory conaining keys */
856 const char *keyname; /* Name of key to use */
857 void *fit; /* Pointer to FIT blob */
858 int node_offset; /* Offset of signature node */
859 struct image_sig_algo *algo; /* Algorithm information */
860 const void *fdt_blob; /* FDT containing public keys */
861 int required_keynode; /* Node offset of key to use: -1=any */
862 const char *require_keys; /* Value for 'required' property */
863};
864
865/* A part of an image, used for hashing */
866struct image_region {
867 const void *data;
868 int size;
869};
870
871struct image_sig_algo {
872 const char *name; /* Name of algorithm */
873
874 /**
875 * sign() - calculate and return signature for given input data
876 *
877 * @info: Specifies key and FIT information
878 * @data: Pointer to the input data
879 * @data_len: Data length
880 * @sigp: Set to an allocated buffer holding the signature
881 * @sig_len: Set to length of the calculated hash
882 *
883 * This computes input data signature according to selected algorithm.
884 * Resulting signature value is placed in an allocated buffer, the
885 * pointer is returned as *sigp. The length of the calculated
886 * signature is returned via the sig_len pointer argument. The caller
887 * should free *sigp.
888 *
889 * @return: 0, on success, -ve on error
890 */
891 int (*sign)(struct image_sign_info *info,
892 const struct image_region region[],
893 int region_count, uint8_t **sigp, uint *sig_len);
894
895 /**
896 * add_verify_data() - Add verification information to FDT
897 *
898 * Add public key information to the FDT node, suitable for
899 * verification at run-time. The information added depends on the
900 * algorithm being used.
901 *
902 * @info: Specifies key and FIT information
903 * @keydest: Destination FDT blob for public key data
904 * @return: 0, on success, -ve on error
905 */
906 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
907
908 /**
909 * verify() - Verify a signature against some data
910 *
911 * @info: Specifies key and FIT information
912 * @data: Pointer to the input data
913 * @data_len: Data length
914 * @sig: Signature
915 * @sig_len: Number of bytes in signature
916 * @return 0 if verified, -ve on error
917 */
918 int (*verify)(struct image_sign_info *info,
919 const struct image_region region[], int region_count,
920 uint8_t *sig, uint sig_len);
921};
922
923/**
924 * image_get_sig_algo() - Look up a signature algortihm
925 *
926 * @param name Name of algorithm
927 * @return pointer to algorithm information, or NULL if not found
928 */
929struct image_sig_algo *image_get_sig_algo(const char *name);
930
Simon Glass56518e72013-06-13 15:10:01 -0700931/**
932 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
933 *
934 * @fit: FIT to check
935 * @image_noffset: Offset of image node to check
936 * @data: Image data to check
937 * @size: Size of image data
938 * @sig_blob: FDT containing public keys
939 * @no_sigsp: Returns 1 if no signatures were required, and
940 * therefore nothing was checked. The caller may wish
941 * to fall back to other mechanisms, or refuse to
942 * boot.
943 * @return 0 if all verified ok, <0 on error
944 */
945int fit_image_verify_required_sigs(const void *fit, int image_noffset,
946 const char *data, size_t size, const void *sig_blob,
947 int *no_sigsp);
948
949/**
950 * fit_image_check_sig() - Check a single image signature node
951 *
952 * @fit: FIT to check
953 * @noffset: Offset of signature node to check
954 * @data: Image data to check
955 * @size: Size of image data
956 * @required_keynode: Offset in the control FDT of the required key node,
957 * if any. If this is given, then the image wil not
958 * pass verification unless that key is used. If this is
959 * -1 then any signature will do.
960 * @err_msgp: In the event of an error, this will be pointed to a
961 * help error string to display to the user.
962 * @return 0 if all verified ok, <0 on error
963 */
964int fit_image_check_sig(const void *fit, int noffset, const void *data,
965 size_t size, int required_keynode, char **err_msgp);
966
967
Stephen Warren712fbcf2011-10-18 11:11:49 +0000968static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100969{
Thierry Reding75668322011-10-27 08:58:25 +0000970 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100971}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100972
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100973#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000974#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100975 "FIT images not supported for '%s'\n", \
976 __FILE__, __LINE__, (msg))
977
Stephen Warren712fbcf2011-10-18 11:11:49 +0000978#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100979 "FIT images not supported for '%s' " \
980 "- must reset board to recover!\n", \
981 __FILE__, __LINE__, (msg))
982#else
983#define fit_unsupported(msg)
984#define fit_unsupported_reset(msg)
985#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100986#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100987
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100988#endif /* __IMAGE_H__ */