blob: ee6eb8d24645a7ba8112a7ba15303b10b823a51f [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)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010048#include <libfdt.h>
49#include <fdt_support.h>
Simon Glass87ebee32013-05-08 08:05:59 +000050# ifdef CONFIG_SPL_BUILD
51# ifdef CONFIG_SPL_CRC32_SUPPORT
52# define IMAGE_ENABLE_CRC32 1
53# endif
54# ifdef CONFIG_SPL_MD5_SUPPORT
55# define IMAGE_ENABLE_MD5 1
56# endif
57# ifdef CONFIG_SPL_SHA1_SUPPORT
58# define IMAGE_ENABLE_SHA1 1
59# endif
60# else
61# define CONFIG_CRC32 /* FIT images need CRC32 support */
62# define CONFIG_MD5 /* and MD5 */
63# define CONFIG_SHA1 /* and SHA1 */
64# define IMAGE_ENABLE_CRC32 1
65# define IMAGE_ENABLE_MD5 1
66# define IMAGE_ENABLE_SHA1 1
67# endif
68
69#ifndef IMAGE_ENABLE_CRC32
70#define IMAGE_ENABLE_CRC32 0
71#endif
72
73#ifndef IMAGE_ENABLE_MD5
74#define IMAGE_ENABLE_MD5 0
75#endif
76
77#ifndef IMAGE_ENABLE_SHA1
78#define IMAGE_ENABLE_SHA1 0
79#endif
80
Simon Glass13d06982013-05-08 08:06:01 +000081#endif /* CONFIG_FIT */
82
83#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
84# define IMAGE_ENABLE_RAMDISK_HIGH 1
85#else
86# define IMAGE_ENABLE_RAMDISK_HIGH 0
87#endif
88
89#ifdef CONFIG_OF_LIBFDT
90# define IMAGE_ENABLE_OF_LIBFDT 1
91#else
92# define IMAGE_ENABLE_OF_LIBFDT 0
93#endif
94
95#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
96# define IMAGE_BOOT_GET_CMDLINE 1
97#else
98# define IMAGE_BOOT_GET_CMDLINE 0
99#endif
100
101#ifdef CONFIG_OF_BOARD_SETUP
102# define IMAAGE_OF_BOARD_SETUP 1
103#else
104# define IMAAGE_OF_BOARD_SETUP 0
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100105#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100106
wdenk5b1d7132002-11-03 00:07:02 +0000107/*
108 * Operating System Codes
109 */
110#define IH_OS_INVALID 0 /* Invalid OS */
111#define IH_OS_OPENBSD 1 /* OpenBSD */
112#define IH_OS_NETBSD 2 /* NetBSD */
113#define IH_OS_FREEBSD 3 /* FreeBSD */
114#define IH_OS_4_4BSD 4 /* 4.4BSD */
115#define IH_OS_LINUX 5 /* Linux */
116#define IH_OS_SVR4 6 /* SVR4 */
117#define IH_OS_ESIX 7 /* Esix */
118#define IH_OS_SOLARIS 8 /* Solaris */
119#define IH_OS_IRIX 9 /* Irix */
120#define IH_OS_SCO 10 /* SCO */
121#define IH_OS_DELL 11 /* Dell */
122#define IH_OS_NCR 12 /* NCR */
123#define IH_OS_LYNXOS 13 /* LynxOS */
124#define IH_OS_VXWORKS 14 /* VxWorks */
125#define IH_OS_PSOS 15 /* pSOS */
126#define IH_OS_QNX 16 /* QNX */
127#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000128#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000129#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000130#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500131#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200132#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000133#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000134
135/*
136 * CPU Architecture Codes (supported by Linux)
137 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100138#define IH_ARCH_INVALID 0 /* Invalid CPU */
139#define IH_ARCH_ALPHA 1 /* Alpha */
140#define IH_ARCH_ARM 2 /* ARM */
141#define IH_ARCH_I386 3 /* Intel x86 */
142#define IH_ARCH_IA64 4 /* IA64 */
143#define IH_ARCH_MIPS 5 /* MIPS */
144#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
145#define IH_ARCH_PPC 7 /* PowerPC */
146#define IH_ARCH_S390 8 /* IBM S390 */
147#define IH_ARCH_SH 9 /* SuperH */
148#define IH_ARCH_SPARC 10 /* Sparc */
149#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
150#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100151#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
152#define IH_ARCH_NIOS2 15 /* Nios-II */
153#define IH_ARCH_BLACKFIN 16 /* Blackfin */
154#define IH_ARCH_AVR32 17 /* AVR32 */
155#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000156#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000157#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000158#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
wdenk5b1d7132002-11-03 00:07:02 +0000159
160/*
161 * Image Types
162 *
163 * "Standalone Programs" are directly runnable in the environment
164 * provided by U-Boot; it is expected that (if they behave
165 * well) you can continue to work in U-Boot after return from
166 * the Standalone Program.
167 * "OS Kernel Images" are usually images of some Embedded OS which
168 * will take over control completely. Usually these programs
169 * will install their own set of exception handlers, device
170 * drivers, set up the MMU, etc. - this means, that you cannot
171 * expect to re-enter U-Boot except by resetting the CPU.
172 * "RAMDisk Images" are more or less just data blocks, and their
173 * parameters (address, size) are passed to an OS kernel that is
174 * being started.
175 * "Multi-File Images" contain several images, typically an OS
176 * (Linux) kernel image and one or more data images like
177 * RAMDisks. This construct is useful for instance when you want
178 * to boot over the network using BOOTP etc., where the boot
179 * server provides just a single image file, but you want to get
180 * for instance an OS kernel and a RAMDisk image.
181 *
182 * "Multi-File Images" start with a list of image sizes, each
183 * image size (in bytes) specified by an "uint32_t" in network
184 * byte order. This list is terminated by an "(uint32_t)0".
185 * Immediately after the terminating 0 follow the images, one by
186 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000187 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000188 *
189 * "Firmware Images" are binary images containing firmware (like
190 * U-Boot or FPGA images) which usually will be programmed to
191 * flash memory.
192 *
193 * "Script files" are command sequences that will be executed by
194 * U-Boot's command interpreter; this feature is especially
195 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000196 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000197 */
198
199#define IH_TYPE_INVALID 0 /* Invalid Image */
200#define IH_TYPE_STANDALONE 1 /* Standalone Program */
201#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
202#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
203#define IH_TYPE_MULTI 4 /* Multi-File Image */
204#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
205#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000206#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500207#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530208#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100209#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000210#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400211#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000212#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e892011-11-10 13:17:53 -0700213#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000214#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
Marek Vasutbce88372013-08-26 20:43:33 +0200215#define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000216
217/*
218 * Compression Types
219 */
220#define IH_COMP_NONE 0 /* No Compression Used */
221#define IH_COMP_GZIP 1 /* gzip Compression Used */
222#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200223#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100224#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000225
226#define IH_MAGIC 0x27051956 /* Image Magic Number */
227#define IH_NMLEN 32 /* Image Name Length */
228
Fabio Estevam1411fb32013-01-03 08:24:33 +0000229/* Reused from common.h */
230#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
231
wdenk5b1d7132002-11-03 00:07:02 +0000232/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100233 * Legacy format image header,
234 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000235 */
wdenk5b1d7132002-11-03 00:07:02 +0000236typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000237 __be32 ih_magic; /* Image Header Magic Number */
238 __be32 ih_hcrc; /* Image Header CRC Checksum */
239 __be32 ih_time; /* Image Creation Timestamp */
240 __be32 ih_size; /* Image Data Size */
241 __be32 ih_load; /* Data Load Address */
242 __be32 ih_ep; /* Entry Point Address */
243 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000244 uint8_t ih_os; /* Operating System */
245 uint8_t ih_arch; /* CPU architecture */
246 uint8_t ih_type; /* Image Type */
247 uint8_t ih_comp; /* Compression Type */
248 uint8_t ih_name[IH_NMLEN]; /* Image Name */
249} image_header_t;
250
Kumar Gala396f6352008-08-15 08:24:41 -0500251typedef struct image_info {
252 ulong start, end; /* start/end of blob */
253 ulong image_start, image_len; /* start of image within blob, len of image */
254 ulong load; /* load addr for the image */
255 uint8_t comp, type, os; /* compression, type of image, os type */
256} image_info_t;
257
Marian Balakowicz559316f2008-01-08 18:11:44 +0100258/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100259 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
260 * routines.
261 */
262typedef struct bootm_headers {
263 /*
264 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100265 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100266 * data from second and third component accordingly.
267 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200268 image_header_t *legacy_hdr_os; /* image header pointer */
269 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100270 ulong legacy_hdr_valid;
271
272#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100273 const char *fit_uname_cfg; /* configuration node unit name */
274
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100275 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100276 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100277 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100278
279 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100280 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
281 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100282
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100283 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100284 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
285 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100286#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100287
Kumar Gala49c3a862008-10-21 17:25:45 -0500288#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500289 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500290 ulong ep; /* entry point of OS */
291
Kumar Galac4f94192008-08-15 08:24:37 -0500292 ulong rd_start, rd_end;/* ramdisk start/end */
293
Kumar Gala06a09912008-08-15 08:24:38 -0500294 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500295 ulong ft_len; /* length of flat device tree */
296
Kumar Gala49c3a862008-10-21 17:25:45 -0500297 ulong initrd_start;
298 ulong initrd_end;
299 ulong cmdline_start;
300 ulong cmdline_end;
301 bd_t *kbd;
302#endif
303
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100304 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500305
306#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700307#define BOOTM_STATE_FINDOS (0x00000002)
308#define BOOTM_STATE_FINDOTHER (0x00000004)
309#define BOOTM_STATE_LOADOS (0x00000008)
310#define BOOTM_STATE_RAMDISK (0x00000010)
311#define BOOTM_STATE_FDT (0x00000020)
312#define BOOTM_STATE_OS_CMDLINE (0x00000040)
313#define BOOTM_STATE_OS_BD_T (0x00000080)
314#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700315#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
316#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500317 int state;
318
Mike Frysingera16028d2009-11-03 11:35:59 -0500319#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500320 struct lmb lmb; /* for memory mgmt */
321#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100322} bootm_headers_t;
323
Simon Schwarz1648a372012-03-15 04:01:34 +0000324extern bootm_headers_t images;
325
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100326/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100327 * Some systems (for example LWMON) have very short watchdog periods;
328 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200329 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100330 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200331#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100332#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200333#endif
334
335#ifndef CHUNKSZ_CRC32
336#define CHUNKSZ_CRC32 (64 * 1024)
337#endif
338
339#ifndef CHUNKSZ_MD5
340#define CHUNKSZ_MD5 (64 * 1024)
341#endif
342
343#ifndef CHUNKSZ_SHA1
344#define CHUNKSZ_SHA1 (64 * 1024)
345#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100346
Mike Frysinger37566092009-07-02 19:23:25 -0400347#define uimage_to_cpu(x) be32_to_cpu(x)
348#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000349
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530350/*
351 * Translation table for entries of a specific type; used by
352 * get_table_entry_id() and get_table_entry_name().
353 */
354typedef struct table_entry {
355 int id;
356 char *sname; /* short (input) name to find table entry */
357 char *lname; /* long (output) name to print for messages */
358} table_entry_t;
359
360/*
361 * get_table_entry_id() scans the translation table trying to find an
362 * entry that matches the given short name. If a matching entry is
363 * found, it's id is returned to the caller.
364 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400365int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530366 const char *table_name, const char *name);
367/*
368 * get_table_entry_name() scans the translation table trying to find
369 * an entry that matches the given id. If a matching entry is found,
370 * its long name is returned to the caller.
371 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400372char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530373
Stephen Warren712fbcf2011-10-18 11:11:49 +0000374const char *genimg_get_os_name(uint8_t os);
375const char *genimg_get_arch_name(uint8_t arch);
376const char *genimg_get_type_name(uint8_t type);
377const char *genimg_get_comp_name(uint8_t comp);
378int genimg_get_os_id(const char *name);
379int genimg_get_arch_id(const char *name);
380int genimg_get_type_id(const char *name);
381int genimg_get_comp_id(const char *name);
382void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100383
Simon Glass859e92b2013-05-07 06:11:51 +0000384#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
385 defined(USE_HOSTCC)
386#define IMAGE_ENABLE_TIMESTAMP 1
387#else
388#define IMAGE_ENABLE_TIMESTAMP 0
389#endif
390void genimg_print_time(time_t timestamp);
391
Simon Glass782cfbb2013-05-16 13:53:21 +0000392/* What to do with a image load address ('load = <> 'in the FIT) */
393enum fit_load_op {
394 FIT_LOAD_IGNORED, /* Ignore load address */
395 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
396 FIT_LOAD_REQUIRED, /* Must be provided */
397};
398
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100399#ifndef USE_HOSTCC
400/* Image format types, returned by _get_format() routine */
401#define IMAGE_FORMAT_INVALID 0x00
402#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
403#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
404
Simon Glass35e7b0f2013-05-07 06:12:03 +0000405int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000406int genimg_has_config(bootm_headers_t *images);
407ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100408
Stephen Warren712fbcf2011-10-18 11:11:49 +0000409int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100410 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100411
Simon Glass782cfbb2013-05-16 13:53:21 +0000412/**
413 * fit_image_load() - load an image from a FIT
414 *
415 * This deals with all aspects of loading an image from a FIT, including
416 * selecting the right image based on configuration, verifying it, printing
417 * out progress messages, checking the type/arch/os and optionally copying it
418 * to the right load address.
419 *
420 * @param images Boot images structure
421 * @param prop_name Property name to look up (FIT_..._PROP)
422 * @param addr Address of FIT in memory
423 * @param fit_unamep On entry this is the requested image name
424 * (e.g. "kernel@1") or NULL to use the default. On exit
425 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700426 * @param fit_uname_configp On entry this is the requested configuration
427 * name (e.g. "conf@1") or NULL to use the default. On
428 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000429 * @param arch Expected architecture (IH_ARCH_...)
430 * @param image_type Required image type (IH_TYPE_...). If this is
431 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
432 * also.
433 * @param bootstage_id ID of starting bootstage to use for progress updates.
434 * This will be added to the BOOTSTAGE_SUB values when
435 * calling bootstage_mark()
436 * @param load_op Decribes what to do with the load address
437 * @param datap Returns address of loaded image
438 * @param lenp Returns length of loaded image
439 */
440int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700441 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000442 int arch, int image_type, int bootstage_id,
443 enum fit_load_op load_op, ulong *datap, ulong *lenp);
444
445/**
446 * fit_get_node_from_config() - Look up an image a FIT by type
447 *
448 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
449 * particular image type (e.g. "kernel") and then finds the image that is
450 * referred to.
451 *
452 * For example, for something like:
453 *
454 * images {
455 * kernel@1 {
456 * ...
457 * };
458 * };
459 * configurations {
460 * conf@1 {
461 * kernel = "kernel@1";
462 * };
463 * };
464 *
465 * the function will return the node offset of the kernel@1 node, assuming
466 * that conf@1 is the chosen configuration.
467 *
468 * @param images Boot images structure
469 * @param prop_name Property name to look up (FIT_..._PROP)
470 * @param addr Address of FIT in memory
471 */
472int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
473 ulong addr);
474
Simon Glass53f375f2013-05-16 13:53:23 +0000475int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
476 bootm_headers_t *images,
477 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000478void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000479int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500480
Stephen Warren712fbcf2011-10-18 11:11:49 +0000481int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100482 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000483int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600484#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000485int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600486#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100487#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100488
489/*******************************************************************/
490/* Legacy format specific code (prefixed with image_) */
491/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000492static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100493{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000494 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100495}
496
497#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200498 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100499 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000500 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100501 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000502image_get_hdr_l(magic) /* image_get_magic */
503image_get_hdr_l(hcrc) /* image_get_hcrc */
504image_get_hdr_l(time) /* image_get_time */
505image_get_hdr_l(size) /* image_get_size */
506image_get_hdr_l(load) /* image_get_load */
507image_get_hdr_l(ep) /* image_get_ep */
508image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100509
510#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200511 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100512 { \
513 return hdr->ih_##f; \
514 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000515image_get_hdr_b(os) /* image_get_os */
516image_get_hdr_b(arch) /* image_get_arch */
517image_get_hdr_b(type) /* image_get_type */
518image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100519
Stephen Warren712fbcf2011-10-18 11:11:49 +0000520static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100521{
522 return (char *)hdr->ih_name;
523}
524
Stephen Warren712fbcf2011-10-18 11:11:49 +0000525static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100526{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000527 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100528}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100529
530/**
531 * image_get_data - get image payload start address
532 * @hdr: image header
533 *
534 * image_get_data() returns address of the image payload. For single
535 * component images it is image data start. For multi component
536 * images it points to the null terminated table of sub-images sizes.
537 *
538 * returns:
539 * image payload data start address
540 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000541static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100542{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000543 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100544}
545
Stephen Warren712fbcf2011-10-18 11:11:49 +0000546static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100547{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000548 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100549}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000550static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100551{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000552 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100553}
554
555#define image_set_hdr_l(f) \
556 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
557 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000558 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100559 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000560image_set_hdr_l(magic) /* image_set_magic */
561image_set_hdr_l(hcrc) /* image_set_hcrc */
562image_set_hdr_l(time) /* image_set_time */
563image_set_hdr_l(size) /* image_set_size */
564image_set_hdr_l(load) /* image_set_load */
565image_set_hdr_l(ep) /* image_set_ep */
566image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100567
568#define image_set_hdr_b(f) \
569 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
570 { \
571 hdr->ih_##f = val; \
572 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000573image_set_hdr_b(os) /* image_set_os */
574image_set_hdr_b(arch) /* image_set_arch */
575image_set_hdr_b(type) /* image_set_type */
576image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100577
Stephen Warren712fbcf2011-10-18 11:11:49 +0000578static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100579{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000580 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100581}
582
Stephen Warren712fbcf2011-10-18 11:11:49 +0000583int image_check_hcrc(const image_header_t *hdr);
584int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100585#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600586ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500587phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000588phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000589void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100590#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100591
Stephen Warren712fbcf2011-10-18 11:11:49 +0000592static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100593{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000594 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100595}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000596static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100597{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000598 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100599}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000600static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100601{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000602 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100603}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000604static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100605{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000606 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100607}
608
Stephen Warren712fbcf2011-10-18 11:11:49 +0000609ulong image_multi_count(const image_header_t *hdr);
610void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100611 ulong *data, ulong *len);
612
Stephen Warren712fbcf2011-10-18 11:11:49 +0000613void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100614
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100615#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000616static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100617{
Mike Frysinger476af292011-10-03 14:50:33 +0000618#ifndef IH_ARCH_DEFAULT
619# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100620#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000621 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100622}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100623#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100624
Simon Glass13d06982013-05-08 08:06:01 +0000625/**
626 * Set up properties in the FDT
627 *
628 * This sets up properties in the FDT that is to be passed to linux.
629 *
630 * @images: Images information
631 * @blob: FDT to update
632 * @of_size: Size of the FDT
633 * @lmb: Points to logical memory block structure
634 * @return 0 if ok, <0 on failure
635 */
636int image_setup_libfdt(bootm_headers_t *images, void *blob,
637 int of_size, struct lmb *lmb);
638
639/**
640 * Set up the FDT to use for booting a kernel
641 *
642 * This performs ramdisk setup, sets up the FDT if required, and adds
643 * paramters to the FDT if libfdt is available.
644 *
645 * @param images Images information
646 * @return 0 if ok, <0 on failure
647 */
648int image_setup_linux(bootm_headers_t *images);
649
Simon Glassa5266d62013-07-04 13:26:10 -0700650/**
651 * bootz_setup() - Extract stat and size of a Linux xImage
652 *
653 * @image: Address of image
654 * @start: Returns start address of image
655 * @end : Returns end address of image
656 * @return 0 if OK, 1 if the image was not recognised
657 */
658int bootz_setup(ulong image, ulong *start, ulong *end);
659
660
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100661/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100662/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100663/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100664#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100665
666#define FIT_IMAGES_PATH "/images"
667#define FIT_CONFS_PATH "/configurations"
668
Simon Glass3e569a62013-06-13 15:10:00 -0700669/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100670#define FIT_HASH_NODENAME "hash"
671#define FIT_ALGO_PROP "algo"
672#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000673#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700674#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100675
676/* image node */
677#define FIT_DATA_PROP "data"
678#define FIT_TIMESTAMP_PROP "timestamp"
679#define FIT_DESC_PROP "description"
680#define FIT_ARCH_PROP "arch"
681#define FIT_TYPE_PROP "type"
682#define FIT_OS_PROP "os"
683#define FIT_COMP_PROP "compression"
684#define FIT_ENTRY_PROP "entry"
685#define FIT_LOAD_PROP "load"
686
687/* configuration node */
688#define FIT_KERNEL_PROP "kernel"
689#define FIT_RAMDISK_PROP "ramdisk"
690#define FIT_FDT_PROP "fdt"
691#define FIT_DEFAULT_PROP "default"
692
693#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
694
695/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000696int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100697 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000698int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100699 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100700
Stephen Warren712fbcf2011-10-18 11:11:49 +0000701void fit_print_contents(const void *fit);
702void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100703
704/**
705 * fit_get_end - get FIT image size
706 * @fit: pointer to the FIT format image header
707 *
708 * returns:
709 * size of the FIT image (blob) in memory
710 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000711static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100712{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000713 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100714}
715
716/**
717 * fit_get_end - get FIT image end
718 * @fit: pointer to the FIT format image header
719 *
720 * returns:
721 * end address of the FIT image (blob) in memory
722 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000723static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100724{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000725 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100726}
727
728/**
729 * fit_get_name - get FIT node name
730 * @fit: pointer to the FIT format image header
731 *
732 * returns:
733 * NULL, on error
734 * pointer to node name, on success
735 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000736static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100737 int noffset, int *len)
738{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000739 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100740}
741
Stephen Warren712fbcf2011-10-18 11:11:49 +0000742int fit_get_desc(const void *fit, int noffset, char **desc);
743int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100744
Stephen Warren712fbcf2011-10-18 11:11:49 +0000745int fit_image_get_node(const void *fit, const char *image_uname);
746int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
747int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
748int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
749int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
750int fit_image_get_load(const void *fit, int noffset, ulong *load);
751int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
752int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100753 const void **data, size_t *size);
754
Stephen Warren712fbcf2011-10-18 11:11:49 +0000755int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
756int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100757 int *value_len);
758
Stephen Warren712fbcf2011-10-18 11:11:49 +0000759int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000760
761/**
Simon Glass56518e72013-06-13 15:10:01 -0700762 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000763 *
Simon Glass56518e72013-06-13 15:10:01 -0700764 * @keydir: Directory containing keys
765 * @kwydest: FDT blob to write public key information to
766 * @fit: Pointer to the FIT format image header
767 * @comment: Comment to add to signature nodes
768 * @require_keys: Mark all keys as 'required'
769 *
770 * Adds hash values for all component images in the FIT blob.
771 * Hashes are calculated for all component images which have hash subnodes
772 * with algorithm property set to one of the supported hash algorithms.
773 *
774 * Also add signatures if signature nodes are present.
775 *
776 * returns
777 * 0, on success
778 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000779 */
Simon Glass56518e72013-06-13 15:10:01 -0700780int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
781 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100782
Simon Glassb8da8362013-05-07 06:11:57 +0000783int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000784int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000785int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000786int fit_image_check_os(const void *fit, int noffset, uint8_t os);
787int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
788int fit_image_check_type(const void *fit, int noffset, uint8_t type);
789int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
790int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100791
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000792int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000793int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100794
Simon Glass003efd72013-05-07 06:12:00 +0000795/**
796 * fit_conf_get_prop_node() - Get node refered to by a configuration
797 * @fit: FIT to check
798 * @noffset: Offset of conf@xxx node to check
799 * @prop_name: Property to read from the conf node
800 *
801 * The conf@ nodes contain references to other nodes, using properties
802 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
803 * return the offset of the node referred to (e.g. offset of node
804 * "/images/kernel@1".
805 */
806int fit_conf_get_prop_node(const void *fit, int noffset,
807 const char *prop_name);
808
Stephen Warren712fbcf2011-10-18 11:11:49 +0000809void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100810
Simon Glass61a439a2013-05-07 06:11:52 +0000811int fit_check_ramdisk(const void *fit, int os_noffset,
812 uint8_t arch, int verify);
813
Simon Glass604f23d2013-05-07 06:11:54 +0000814int calculate_hash(const void *data, int data_len, const char *algo,
815 uint8_t *value, int *value_len);
816
Simon Glass782cfbb2013-05-16 13:53:21 +0000817/*
Simon Glass3e569a62013-06-13 15:10:00 -0700818 * At present we only support signing on the host, and verification on the
819 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000820 */
821#if defined(CONFIG_FIT_SIGNATURE)
822# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700823# define IMAGE_ENABLE_SIGN 1
Simon Glass782cfbb2013-05-16 13:53:21 +0000824# define IMAGE_ENABLE_VERIFY 0
825#else
Simon Glass3e569a62013-06-13 15:10:00 -0700826# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000827# define IMAGE_ENABLE_VERIFY 1
828# endif
829#else
Simon Glass3e569a62013-06-13 15:10:00 -0700830# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000831# define IMAGE_ENABLE_VERIFY 0
832#endif
833
834#ifdef USE_HOSTCC
835# define gd_fdt_blob() NULL
836#else
837# define gd_fdt_blob() (gd->fdt_blob)
838#endif
839
840#ifdef CONFIG_FIT_BEST_MATCH
841#define IMAGE_ENABLE_BEST_MATCH 1
842#else
843#define IMAGE_ENABLE_BEST_MATCH 0
844#endif
845
Simon Glass3e569a62013-06-13 15:10:00 -0700846/* Information passed to the signing routines */
847struct image_sign_info {
848 const char *keydir; /* Directory conaining keys */
849 const char *keyname; /* Name of key to use */
850 void *fit; /* Pointer to FIT blob */
851 int node_offset; /* Offset of signature node */
852 struct image_sig_algo *algo; /* Algorithm information */
853 const void *fdt_blob; /* FDT containing public keys */
854 int required_keynode; /* Node offset of key to use: -1=any */
855 const char *require_keys; /* Value for 'required' property */
856};
857
858/* A part of an image, used for hashing */
859struct image_region {
860 const void *data;
861 int size;
862};
863
864struct image_sig_algo {
865 const char *name; /* Name of algorithm */
866
867 /**
868 * sign() - calculate and return signature for given input data
869 *
870 * @info: Specifies key and FIT information
871 * @data: Pointer to the input data
872 * @data_len: Data length
873 * @sigp: Set to an allocated buffer holding the signature
874 * @sig_len: Set to length of the calculated hash
875 *
876 * This computes input data signature according to selected algorithm.
877 * Resulting signature value is placed in an allocated buffer, the
878 * pointer is returned as *sigp. The length of the calculated
879 * signature is returned via the sig_len pointer argument. The caller
880 * should free *sigp.
881 *
882 * @return: 0, on success, -ve on error
883 */
884 int (*sign)(struct image_sign_info *info,
885 const struct image_region region[],
886 int region_count, uint8_t **sigp, uint *sig_len);
887
888 /**
889 * add_verify_data() - Add verification information to FDT
890 *
891 * Add public key information to the FDT node, suitable for
892 * verification at run-time. The information added depends on the
893 * algorithm being used.
894 *
895 * @info: Specifies key and FIT information
896 * @keydest: Destination FDT blob for public key data
897 * @return: 0, on success, -ve on error
898 */
899 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
900
901 /**
902 * verify() - Verify a signature against some data
903 *
904 * @info: Specifies key and FIT information
905 * @data: Pointer to the input data
906 * @data_len: Data length
907 * @sig: Signature
908 * @sig_len: Number of bytes in signature
909 * @return 0 if verified, -ve on error
910 */
911 int (*verify)(struct image_sign_info *info,
912 const struct image_region region[], int region_count,
913 uint8_t *sig, uint sig_len);
914};
915
916/**
917 * image_get_sig_algo() - Look up a signature algortihm
918 *
919 * @param name Name of algorithm
920 * @return pointer to algorithm information, or NULL if not found
921 */
922struct image_sig_algo *image_get_sig_algo(const char *name);
923
Simon Glass56518e72013-06-13 15:10:01 -0700924/**
925 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
926 *
927 * @fit: FIT to check
928 * @image_noffset: Offset of image node to check
929 * @data: Image data to check
930 * @size: Size of image data
931 * @sig_blob: FDT containing public keys
932 * @no_sigsp: Returns 1 if no signatures were required, and
933 * therefore nothing was checked. The caller may wish
934 * to fall back to other mechanisms, or refuse to
935 * boot.
936 * @return 0 if all verified ok, <0 on error
937 */
938int fit_image_verify_required_sigs(const void *fit, int image_noffset,
939 const char *data, size_t size, const void *sig_blob,
940 int *no_sigsp);
941
942/**
943 * fit_image_check_sig() - Check a single image signature node
944 *
945 * @fit: FIT to check
946 * @noffset: Offset of signature node to check
947 * @data: Image data to check
948 * @size: Size of image data
949 * @required_keynode: Offset in the control FDT of the required key node,
950 * if any. If this is given, then the image wil not
951 * pass verification unless that key is used. If this is
952 * -1 then any signature will do.
953 * @err_msgp: In the event of an error, this will be pointed to a
954 * help error string to display to the user.
955 * @return 0 if all verified ok, <0 on error
956 */
957int fit_image_check_sig(const void *fit, int noffset, const void *data,
958 size_t size, int required_keynode, char **err_msgp);
959
Simon Glass4d098522013-06-13 15:10:09 -0700960/**
961 * fit_region_make_list() - Make a list of regions to hash
962 *
963 * Given a list of FIT regions (offset, size) provided by libfdt, create
964 * a list of regions (void *, size) for use by the signature creationg
965 * and verification code.
966 *
967 * @fit: FIT image to process
968 * @fdt_regions: Regions as returned by libfdt
969 * @count: Number of regions returned by libfdt
970 * @region: Place to put list of regions (NULL to allocate it)
971 * @return pointer to list of regions, or NULL if out of memory
972 */
973struct image_region *fit_region_make_list(const void *fit,
974 struct fdt_region *fdt_regions, int count,
975 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -0700976
Stephen Warren712fbcf2011-10-18 11:11:49 +0000977static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100978{
Thierry Reding75668322011-10-27 08:58:25 +0000979 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100980}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100981
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100982#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000983#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100984 "FIT images not supported for '%s'\n", \
985 __FILE__, __LINE__, (msg))
986
Stephen Warren712fbcf2011-10-18 11:11:49 +0000987#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100988 "FIT images not supported for '%s' " \
989 "- must reset board to recover!\n", \
990 __FILE__, __LINE__, (msg))
991#else
992#define fit_unsupported(msg)
993#define fit_unsupported_reset(msg)
994#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100995#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100996
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100997#endif /* __IMAGE_H__ */