blob: 2508d7d2430f100a91741f862655d227c91e169b [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
Heiko Schocher2842c1c2014-03-03 12:19:25 +010060# ifdef CONFIG_SPL_SHA256_SUPPORT
61# define IMAGE_ENABLE_SHA256 1
62# endif
Simon Glass87ebee32013-05-08 08:05:59 +000063# else
64# define CONFIG_CRC32 /* FIT images need CRC32 support */
65# define CONFIG_MD5 /* and MD5 */
66# define CONFIG_SHA1 /* and SHA1 */
Heiko Schocher2842c1c2014-03-03 12:19:25 +010067# define CONFIG_SHA256 /* and SHA256 */
Simon Glass87ebee32013-05-08 08:05:59 +000068# define IMAGE_ENABLE_CRC32 1
69# define IMAGE_ENABLE_MD5 1
70# define IMAGE_ENABLE_SHA1 1
Heiko Schocher2842c1c2014-03-03 12:19:25 +010071# define IMAGE_ENABLE_SHA256 1
Simon Glass87ebee32013-05-08 08:05:59 +000072# endif
73
74#ifndef IMAGE_ENABLE_CRC32
75#define IMAGE_ENABLE_CRC32 0
76#endif
77
78#ifndef IMAGE_ENABLE_MD5
79#define IMAGE_ENABLE_MD5 0
80#endif
81
82#ifndef IMAGE_ENABLE_SHA1
83#define IMAGE_ENABLE_SHA1 0
84#endif
85
Heiko Schocher2842c1c2014-03-03 12:19:25 +010086#ifndef IMAGE_ENABLE_SHA256
87#define IMAGE_ENABLE_SHA256 0
88#endif
89
Simon Glass13d06982013-05-08 08:06:01 +000090#endif /* CONFIG_FIT */
91
92#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
93# define IMAGE_ENABLE_RAMDISK_HIGH 1
94#else
95# define IMAGE_ENABLE_RAMDISK_HIGH 0
96#endif
97
98#ifdef CONFIG_OF_LIBFDT
99# define IMAGE_ENABLE_OF_LIBFDT 1
100#else
101# define IMAGE_ENABLE_OF_LIBFDT 0
102#endif
103
104#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
105# define IMAGE_BOOT_GET_CMDLINE 1
106#else
107# define IMAGE_BOOT_GET_CMDLINE 0
108#endif
109
110#ifdef CONFIG_OF_BOARD_SETUP
Masahiro Yamada95f70622014-01-29 16:29:16 +0900111# define IMAGE_OF_BOARD_SETUP 1
Simon Glass13d06982013-05-08 08:06:01 +0000112#else
Masahiro Yamada95f70622014-01-29 16:29:16 +0900113# define IMAGE_OF_BOARD_SETUP 0
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100114#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100115
wdenk5b1d7132002-11-03 00:07:02 +0000116/*
117 * Operating System Codes
118 */
119#define IH_OS_INVALID 0 /* Invalid OS */
120#define IH_OS_OPENBSD 1 /* OpenBSD */
121#define IH_OS_NETBSD 2 /* NetBSD */
122#define IH_OS_FREEBSD 3 /* FreeBSD */
123#define IH_OS_4_4BSD 4 /* 4.4BSD */
124#define IH_OS_LINUX 5 /* Linux */
125#define IH_OS_SVR4 6 /* SVR4 */
126#define IH_OS_ESIX 7 /* Esix */
127#define IH_OS_SOLARIS 8 /* Solaris */
128#define IH_OS_IRIX 9 /* Irix */
129#define IH_OS_SCO 10 /* SCO */
130#define IH_OS_DELL 11 /* Dell */
131#define IH_OS_NCR 12 /* NCR */
132#define IH_OS_LYNXOS 13 /* LynxOS */
133#define IH_OS_VXWORKS 14 /* VxWorks */
134#define IH_OS_PSOS 15 /* pSOS */
135#define IH_OS_QNX 16 /* QNX */
136#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +0000137#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +0000138#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +0000139#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -0500140#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +0200141#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +0000142#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +0000143
144/*
145 * CPU Architecture Codes (supported by Linux)
146 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100147#define IH_ARCH_INVALID 0 /* Invalid CPU */
148#define IH_ARCH_ALPHA 1 /* Alpha */
149#define IH_ARCH_ARM 2 /* ARM */
150#define IH_ARCH_I386 3 /* Intel x86 */
151#define IH_ARCH_IA64 4 /* IA64 */
152#define IH_ARCH_MIPS 5 /* MIPS */
153#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
154#define IH_ARCH_PPC 7 /* PowerPC */
155#define IH_ARCH_S390 8 /* IBM S390 */
156#define IH_ARCH_SH 9 /* SuperH */
157#define IH_ARCH_SPARC 10 /* Sparc */
158#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
159#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100160#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
161#define IH_ARCH_NIOS2 15 /* Nios-II */
162#define IH_ARCH_BLACKFIN 16 /* Blackfin */
163#define IH_ARCH_AVR32 17 /* AVR32 */
164#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000165#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000166#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000167#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
David Feng0ae76532013-12-14 11:47:35 +0800168#define IH_ARCH_ARM64 22 /* ARM64 */
Alexey Brodkinbc5d5422014-02-04 12:56:16 +0400169#define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
wdenk5b1d7132002-11-03 00:07:02 +0000170
171/*
172 * Image Types
173 *
174 * "Standalone Programs" are directly runnable in the environment
175 * provided by U-Boot; it is expected that (if they behave
176 * well) you can continue to work in U-Boot after return from
177 * the Standalone Program.
178 * "OS Kernel Images" are usually images of some Embedded OS which
179 * will take over control completely. Usually these programs
180 * will install their own set of exception handlers, device
181 * drivers, set up the MMU, etc. - this means, that you cannot
182 * expect to re-enter U-Boot except by resetting the CPU.
183 * "RAMDisk Images" are more or less just data blocks, and their
184 * parameters (address, size) are passed to an OS kernel that is
185 * being started.
186 * "Multi-File Images" contain several images, typically an OS
187 * (Linux) kernel image and one or more data images like
188 * RAMDisks. This construct is useful for instance when you want
189 * to boot over the network using BOOTP etc., where the boot
190 * server provides just a single image file, but you want to get
191 * for instance an OS kernel and a RAMDisk image.
192 *
193 * "Multi-File Images" start with a list of image sizes, each
194 * image size (in bytes) specified by an "uint32_t" in network
195 * byte order. This list is terminated by an "(uint32_t)0".
196 * Immediately after the terminating 0 follow the images, one by
197 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000198 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000199 *
200 * "Firmware Images" are binary images containing firmware (like
201 * U-Boot or FPGA images) which usually will be programmed to
202 * flash memory.
203 *
204 * "Script files" are command sequences that will be executed by
205 * U-Boot's command interpreter; this feature is especially
206 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000207 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000208 */
209
210#define IH_TYPE_INVALID 0 /* Invalid Image */
211#define IH_TYPE_STANDALONE 1 /* Standalone Program */
212#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
213#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
214#define IH_TYPE_MULTI 4 /* Multi-File Image */
215#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
216#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000217#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500218#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530219#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100220#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000221#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400222#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000223#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e892011-11-10 13:17:53 -0700224#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000225#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
Marek Vasutbce88372013-08-26 20:43:33 +0200226#define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000227
228/*
229 * Compression Types
230 */
231#define IH_COMP_NONE 0 /* No Compression Used */
232#define IH_COMP_GZIP 1 /* gzip Compression Used */
233#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200234#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100235#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000236
237#define IH_MAGIC 0x27051956 /* Image Magic Number */
238#define IH_NMLEN 32 /* Image Name Length */
239
Fabio Estevam1411fb32013-01-03 08:24:33 +0000240/* Reused from common.h */
241#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
242
wdenk5b1d7132002-11-03 00:07:02 +0000243/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100244 * Legacy format image header,
245 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000246 */
wdenk5b1d7132002-11-03 00:07:02 +0000247typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000248 __be32 ih_magic; /* Image Header Magic Number */
249 __be32 ih_hcrc; /* Image Header CRC Checksum */
250 __be32 ih_time; /* Image Creation Timestamp */
251 __be32 ih_size; /* Image Data Size */
252 __be32 ih_load; /* Data Load Address */
253 __be32 ih_ep; /* Entry Point Address */
254 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000255 uint8_t ih_os; /* Operating System */
256 uint8_t ih_arch; /* CPU architecture */
257 uint8_t ih_type; /* Image Type */
258 uint8_t ih_comp; /* Compression Type */
259 uint8_t ih_name[IH_NMLEN]; /* Image Name */
260} image_header_t;
261
Kumar Gala396f6352008-08-15 08:24:41 -0500262typedef struct image_info {
263 ulong start, end; /* start/end of blob */
264 ulong image_start, image_len; /* start of image within blob, len of image */
265 ulong load; /* load addr for the image */
266 uint8_t comp, type, os; /* compression, type of image, os type */
267} image_info_t;
268
Marian Balakowicz559316f2008-01-08 18:11:44 +0100269/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100270 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
271 * routines.
272 */
273typedef struct bootm_headers {
274 /*
275 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100276 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100277 * data from second and third component accordingly.
278 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200279 image_header_t *legacy_hdr_os; /* image header pointer */
280 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100281 ulong legacy_hdr_valid;
282
283#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100284 const char *fit_uname_cfg; /* configuration node unit name */
285
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100286 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100287 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100288 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100289
290 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100291 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
292 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100293
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100294 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100295 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
296 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100297#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100298
Kumar Gala49c3a862008-10-21 17:25:45 -0500299#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500300 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500301 ulong ep; /* entry point of OS */
302
Kumar Galac4f94192008-08-15 08:24:37 -0500303 ulong rd_start, rd_end;/* ramdisk start/end */
304
Kumar Gala06a09912008-08-15 08:24:38 -0500305 char *ft_addr; /* flat dev tree address */
Kumar Gala06a09912008-08-15 08:24:38 -0500306 ulong ft_len; /* length of flat device tree */
307
Kumar Gala49c3a862008-10-21 17:25:45 -0500308 ulong initrd_start;
309 ulong initrd_end;
310 ulong cmdline_start;
311 ulong cmdline_end;
312 bd_t *kbd;
313#endif
314
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100315 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500316
317#define BOOTM_STATE_START (0x00000001)
Simon Glass35fc84f2013-06-11 11:14:47 -0700318#define BOOTM_STATE_FINDOS (0x00000002)
319#define BOOTM_STATE_FINDOTHER (0x00000004)
320#define BOOTM_STATE_LOADOS (0x00000008)
321#define BOOTM_STATE_RAMDISK (0x00000010)
322#define BOOTM_STATE_FDT (0x00000020)
323#define BOOTM_STATE_OS_CMDLINE (0x00000040)
324#define BOOTM_STATE_OS_BD_T (0x00000080)
325#define BOOTM_STATE_OS_PREP (0x00000100)
Simon Glassd0ae31e2013-06-11 11:14:48 -0700326#define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
327#define BOOTM_STATE_OS_GO (0x00000400)
Kumar Gala49c3a862008-10-21 17:25:45 -0500328 int state;
329
Mike Frysingera16028d2009-11-03 11:35:59 -0500330#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500331 struct lmb lmb; /* for memory mgmt */
332#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100333} bootm_headers_t;
334
Simon Schwarz1648a372012-03-15 04:01:34 +0000335extern bootm_headers_t images;
336
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100337/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100338 * Some systems (for example LWMON) have very short watchdog periods;
339 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200340 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100341 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200342#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100343#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200344#endif
345
346#ifndef CHUNKSZ_CRC32
347#define CHUNKSZ_CRC32 (64 * 1024)
348#endif
349
350#ifndef CHUNKSZ_MD5
351#define CHUNKSZ_MD5 (64 * 1024)
352#endif
353
354#ifndef CHUNKSZ_SHA1
355#define CHUNKSZ_SHA1 (64 * 1024)
356#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100357
Mike Frysinger37566092009-07-02 19:23:25 -0400358#define uimage_to_cpu(x) be32_to_cpu(x)
359#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000360
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530361/*
362 * Translation table for entries of a specific type; used by
363 * get_table_entry_id() and get_table_entry_name().
364 */
365typedef struct table_entry {
366 int id;
367 char *sname; /* short (input) name to find table entry */
368 char *lname; /* long (output) name to print for messages */
369} table_entry_t;
370
371/*
372 * get_table_entry_id() scans the translation table trying to find an
373 * entry that matches the given short name. If a matching entry is
374 * found, it's id is returned to the caller.
375 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400376int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530377 const char *table_name, const char *name);
378/*
379 * get_table_entry_name() scans the translation table trying to find
380 * an entry that matches the given id. If a matching entry is found,
381 * its long name is returned to the caller.
382 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400383char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530384
Stephen Warren712fbcf2011-10-18 11:11:49 +0000385const char *genimg_get_os_name(uint8_t os);
386const char *genimg_get_arch_name(uint8_t arch);
387const char *genimg_get_type_name(uint8_t type);
388const char *genimg_get_comp_name(uint8_t comp);
389int genimg_get_os_id(const char *name);
390int genimg_get_arch_id(const char *name);
391int genimg_get_type_id(const char *name);
392int genimg_get_comp_id(const char *name);
393void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100394
Simon Glass859e92b2013-05-07 06:11:51 +0000395#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
396 defined(USE_HOSTCC)
397#define IMAGE_ENABLE_TIMESTAMP 1
398#else
399#define IMAGE_ENABLE_TIMESTAMP 0
400#endif
401void genimg_print_time(time_t timestamp);
402
Simon Glass782cfbb2013-05-16 13:53:21 +0000403/* What to do with a image load address ('load = <> 'in the FIT) */
404enum fit_load_op {
405 FIT_LOAD_IGNORED, /* Ignore load address */
406 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
407 FIT_LOAD_REQUIRED, /* Must be provided */
408};
409
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100410#ifndef USE_HOSTCC
411/* Image format types, returned by _get_format() routine */
412#define IMAGE_FORMAT_INVALID 0x00
413#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
414#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
415
Simon Glass35e7b0f2013-05-07 06:12:03 +0000416int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000417int genimg_has_config(bootm_headers_t *images);
418ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100419
Stephen Warren712fbcf2011-10-18 11:11:49 +0000420int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100421 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100422
Simon Glass782cfbb2013-05-16 13:53:21 +0000423/**
424 * fit_image_load() - load an image from a FIT
425 *
426 * This deals with all aspects of loading an image from a FIT, including
427 * selecting the right image based on configuration, verifying it, printing
428 * out progress messages, checking the type/arch/os and optionally copying it
429 * to the right load address.
430 *
431 * @param images Boot images structure
432 * @param prop_name Property name to look up (FIT_..._PROP)
433 * @param addr Address of FIT in memory
434 * @param fit_unamep On entry this is the requested image name
435 * (e.g. "kernel@1") or NULL to use the default. On exit
436 * points to the selected image name
Simon Glassf320a4d2013-07-10 23:08:10 -0700437 * @param fit_uname_configp On entry this is the requested configuration
438 * name (e.g. "conf@1") or NULL to use the default. On
439 * exit points to the selected configuration name.
Simon Glass782cfbb2013-05-16 13:53:21 +0000440 * @param arch Expected architecture (IH_ARCH_...)
441 * @param image_type Required image type (IH_TYPE_...). If this is
442 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
443 * also.
444 * @param bootstage_id ID of starting bootstage to use for progress updates.
445 * This will be added to the BOOTSTAGE_SUB values when
446 * calling bootstage_mark()
447 * @param load_op Decribes what to do with the load address
448 * @param datap Returns address of loaded image
449 * @param lenp Returns length of loaded image
450 */
451int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
Simon Glassf320a4d2013-07-10 23:08:10 -0700452 const char **fit_unamep, const char **fit_uname_configp,
Simon Glass782cfbb2013-05-16 13:53:21 +0000453 int arch, int image_type, int bootstage_id,
454 enum fit_load_op load_op, ulong *datap, ulong *lenp);
455
456/**
457 * fit_get_node_from_config() - Look up an image a FIT by type
458 *
459 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
460 * particular image type (e.g. "kernel") and then finds the image that is
461 * referred to.
462 *
463 * For example, for something like:
464 *
465 * images {
466 * kernel@1 {
467 * ...
468 * };
469 * };
470 * configurations {
471 * conf@1 {
472 * kernel = "kernel@1";
473 * };
474 * };
475 *
476 * the function will return the node offset of the kernel@1 node, assuming
477 * that conf@1 is the chosen configuration.
478 *
479 * @param images Boot images structure
480 * @param prop_name Property name to look up (FIT_..._PROP)
481 * @param addr Address of FIT in memory
482 */
483int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
484 ulong addr);
485
Simon Glass53f375f2013-05-16 13:53:23 +0000486int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
487 bootm_headers_t *images,
488 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000489void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000490int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500491
Stephen Warren712fbcf2011-10-18 11:11:49 +0000492int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100493 ulong *initrd_start, ulong *initrd_end);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000494int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600495#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000496int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600497#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100498#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100499
500/*******************************************************************/
501/* Legacy format specific code (prefixed with image_) */
502/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000503static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100504{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000505 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100506}
507
508#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200509 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100510 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000511 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100512 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000513image_get_hdr_l(magic) /* image_get_magic */
514image_get_hdr_l(hcrc) /* image_get_hcrc */
515image_get_hdr_l(time) /* image_get_time */
516image_get_hdr_l(size) /* image_get_size */
517image_get_hdr_l(load) /* image_get_load */
518image_get_hdr_l(ep) /* image_get_ep */
519image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100520
521#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200522 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100523 { \
524 return hdr->ih_##f; \
525 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000526image_get_hdr_b(os) /* image_get_os */
527image_get_hdr_b(arch) /* image_get_arch */
528image_get_hdr_b(type) /* image_get_type */
529image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100530
Stephen Warren712fbcf2011-10-18 11:11:49 +0000531static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100532{
533 return (char *)hdr->ih_name;
534}
535
Stephen Warren712fbcf2011-10-18 11:11:49 +0000536static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100537{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000538 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100539}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100540
541/**
542 * image_get_data - get image payload start address
543 * @hdr: image header
544 *
545 * image_get_data() returns address of the image payload. For single
546 * component images it is image data start. For multi component
547 * images it points to the null terminated table of sub-images sizes.
548 *
549 * returns:
550 * image payload data start address
551 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000552static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100553{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000554 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100555}
556
Stephen Warren712fbcf2011-10-18 11:11:49 +0000557static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100558{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000559 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100560}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000561static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100562{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000563 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100564}
565
566#define image_set_hdr_l(f) \
567 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
568 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000569 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100570 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000571image_set_hdr_l(magic) /* image_set_magic */
572image_set_hdr_l(hcrc) /* image_set_hcrc */
573image_set_hdr_l(time) /* image_set_time */
574image_set_hdr_l(size) /* image_set_size */
575image_set_hdr_l(load) /* image_set_load */
576image_set_hdr_l(ep) /* image_set_ep */
577image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100578
579#define image_set_hdr_b(f) \
580 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
581 { \
582 hdr->ih_##f = val; \
583 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000584image_set_hdr_b(os) /* image_set_os */
585image_set_hdr_b(arch) /* image_set_arch */
586image_set_hdr_b(type) /* image_set_type */
587image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100588
Stephen Warren712fbcf2011-10-18 11:11:49 +0000589static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100590{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000591 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100592}
593
Stephen Warren712fbcf2011-10-18 11:11:49 +0000594int image_check_hcrc(const image_header_t *hdr);
595int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100596#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600597ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500598phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000599phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000600void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100601#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100602
Stephen Warren712fbcf2011-10-18 11:11:49 +0000603static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100604{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000605 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100606}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000607static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100608{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000609 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100610}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000611static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100612{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000613 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100614}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000615static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100616{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000617 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100618}
619
Stephen Warren712fbcf2011-10-18 11:11:49 +0000620ulong image_multi_count(const image_header_t *hdr);
621void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100622 ulong *data, ulong *len);
623
Stephen Warren712fbcf2011-10-18 11:11:49 +0000624void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100625
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100626#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000627static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100628{
Mike Frysinger476af292011-10-03 14:50:33 +0000629#ifndef IH_ARCH_DEFAULT
630# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100631#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000632 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100633}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100634#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100635
Simon Glass13d06982013-05-08 08:06:01 +0000636/**
637 * Set up properties in the FDT
638 *
639 * This sets up properties in the FDT that is to be passed to linux.
640 *
641 * @images: Images information
642 * @blob: FDT to update
643 * @of_size: Size of the FDT
644 * @lmb: Points to logical memory block structure
645 * @return 0 if ok, <0 on failure
646 */
647int image_setup_libfdt(bootm_headers_t *images, void *blob,
648 int of_size, struct lmb *lmb);
649
650/**
651 * Set up the FDT to use for booting a kernel
652 *
653 * This performs ramdisk setup, sets up the FDT if required, and adds
654 * paramters to the FDT if libfdt is available.
655 *
656 * @param images Images information
657 * @return 0 if ok, <0 on failure
658 */
659int image_setup_linux(bootm_headers_t *images);
660
Simon Glassa5266d62013-07-04 13:26:10 -0700661/**
662 * bootz_setup() - Extract stat and size of a Linux xImage
663 *
664 * @image: Address of image
665 * @start: Returns start address of image
666 * @end : Returns end address of image
667 * @return 0 if OK, 1 if the image was not recognised
668 */
669int bootz_setup(ulong image, ulong *start, ulong *end);
670
671
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100672/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100673/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100674/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100675#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100676
677#define FIT_IMAGES_PATH "/images"
678#define FIT_CONFS_PATH "/configurations"
679
Simon Glass3e569a62013-06-13 15:10:00 -0700680/* hash/signature node */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100681#define FIT_HASH_NODENAME "hash"
682#define FIT_ALGO_PROP "algo"
683#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000684#define FIT_IGNORE_PROP "uboot-ignore"
Simon Glass3e569a62013-06-13 15:10:00 -0700685#define FIT_SIG_NODENAME "signature"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100686
687/* image node */
688#define FIT_DATA_PROP "data"
689#define FIT_TIMESTAMP_PROP "timestamp"
690#define FIT_DESC_PROP "description"
691#define FIT_ARCH_PROP "arch"
692#define FIT_TYPE_PROP "type"
693#define FIT_OS_PROP "os"
694#define FIT_COMP_PROP "compression"
695#define FIT_ENTRY_PROP "entry"
696#define FIT_LOAD_PROP "load"
697
698/* configuration node */
699#define FIT_KERNEL_PROP "kernel"
700#define FIT_RAMDISK_PROP "ramdisk"
701#define FIT_FDT_PROP "fdt"
702#define FIT_DEFAULT_PROP "default"
703
704#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
705
706/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000707int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100708 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000709int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100710 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100711
Stephen Warren712fbcf2011-10-18 11:11:49 +0000712void fit_print_contents(const void *fit);
713void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100714
715/**
716 * fit_get_end - get FIT image size
717 * @fit: pointer to the FIT format image header
718 *
719 * returns:
720 * size of the FIT image (blob) in memory
721 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000722static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100723{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000724 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100725}
726
727/**
728 * fit_get_end - get FIT image end
729 * @fit: pointer to the FIT format image header
730 *
731 * returns:
732 * end address of the FIT image (blob) in memory
733 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000734static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100735{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000736 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100737}
738
739/**
740 * fit_get_name - get FIT node name
741 * @fit: pointer to the FIT format image header
742 *
743 * returns:
744 * NULL, on error
745 * pointer to node name, on success
746 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000747static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100748 int noffset, int *len)
749{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000750 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100751}
752
Stephen Warren712fbcf2011-10-18 11:11:49 +0000753int fit_get_desc(const void *fit, int noffset, char **desc);
754int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100755
Stephen Warren712fbcf2011-10-18 11:11:49 +0000756int fit_image_get_node(const void *fit, const char *image_uname);
757int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
758int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
759int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
760int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
761int fit_image_get_load(const void *fit, int noffset, ulong *load);
762int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
763int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100764 const void **data, size_t *size);
765
Stephen Warren712fbcf2011-10-18 11:11:49 +0000766int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
767int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100768 int *value_len);
769
Stephen Warren712fbcf2011-10-18 11:11:49 +0000770int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000771
772/**
Simon Glass56518e72013-06-13 15:10:01 -0700773 * fit_add_verification_data() - add verification data to FIT image nodes
Simon Glassbbb467d2013-05-07 06:12:01 +0000774 *
Simon Glass56518e72013-06-13 15:10:01 -0700775 * @keydir: Directory containing keys
776 * @kwydest: FDT blob to write public key information to
777 * @fit: Pointer to the FIT format image header
778 * @comment: Comment to add to signature nodes
779 * @require_keys: Mark all keys as 'required'
780 *
781 * Adds hash values for all component images in the FIT blob.
782 * Hashes are calculated for all component images which have hash subnodes
783 * with algorithm property set to one of the supported hash algorithms.
784 *
785 * Also add signatures if signature nodes are present.
786 *
787 * returns
788 * 0, on success
789 * libfdt error code, on failure
Simon Glassbbb467d2013-05-07 06:12:01 +0000790 */
Simon Glass56518e72013-06-13 15:10:01 -0700791int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
792 const char *comment, int require_keys);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100793
Simon Glassb8da8362013-05-07 06:11:57 +0000794int fit_image_verify(const void *fit, int noffset);
Simon Glass782cfbb2013-05-16 13:53:21 +0000795int fit_config_verify(const void *fit, int conf_noffset);
Simon Glassb8da8362013-05-07 06:11:57 +0000796int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000797int fit_image_check_os(const void *fit, int noffset, uint8_t os);
798int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
799int fit_image_check_type(const void *fit, int noffset, uint8_t type);
800int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
801int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100802
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000803int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000804int fit_conf_get_node(const void *fit, const char *conf_uname);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100805
Simon Glass003efd72013-05-07 06:12:00 +0000806/**
807 * fit_conf_get_prop_node() - Get node refered to by a configuration
808 * @fit: FIT to check
809 * @noffset: Offset of conf@xxx node to check
810 * @prop_name: Property to read from the conf node
811 *
812 * The conf@ nodes contain references to other nodes, using properties
813 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
814 * return the offset of the node referred to (e.g. offset of node
815 * "/images/kernel@1".
816 */
817int fit_conf_get_prop_node(const void *fit, int noffset,
818 const char *prop_name);
819
Stephen Warren712fbcf2011-10-18 11:11:49 +0000820void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100821
Simon Glass61a439a2013-05-07 06:11:52 +0000822int fit_check_ramdisk(const void *fit, int os_noffset,
823 uint8_t arch, int verify);
824
Simon Glass604f23d2013-05-07 06:11:54 +0000825int calculate_hash(const void *data, int data_len, const char *algo,
826 uint8_t *value, int *value_len);
827
Simon Glass782cfbb2013-05-16 13:53:21 +0000828/*
Simon Glass3e569a62013-06-13 15:10:00 -0700829 * At present we only support signing on the host, and verification on the
830 * device
Simon Glass782cfbb2013-05-16 13:53:21 +0000831 */
832#if defined(CONFIG_FIT_SIGNATURE)
833# ifdef USE_HOSTCC
Simon Glass3e569a62013-06-13 15:10:00 -0700834# define IMAGE_ENABLE_SIGN 1
Heiko Schocher29a23f92014-03-03 12:19:30 +0100835# define IMAGE_ENABLE_VERIFY 1
Heiko Schocher646257d2014-03-03 12:19:26 +0100836# include <openssl/evp.h>
Simon Glass782cfbb2013-05-16 13:53:21 +0000837#else
Simon Glass3e569a62013-06-13 15:10:00 -0700838# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000839# define IMAGE_ENABLE_VERIFY 1
840# endif
841#else
Simon Glass3e569a62013-06-13 15:10:00 -0700842# define IMAGE_ENABLE_SIGN 0
Simon Glass782cfbb2013-05-16 13:53:21 +0000843# define IMAGE_ENABLE_VERIFY 0
844#endif
845
846#ifdef USE_HOSTCC
Heiko Schocher29a23f92014-03-03 12:19:30 +0100847void *image_get_host_blob(void);
848void image_set_host_blob(void *host_blob);
849# define gd_fdt_blob() image_get_host_blob()
Simon Glass782cfbb2013-05-16 13:53:21 +0000850#else
851# define gd_fdt_blob() (gd->fdt_blob)
852#endif
853
854#ifdef CONFIG_FIT_BEST_MATCH
855#define IMAGE_ENABLE_BEST_MATCH 1
856#else
857#define IMAGE_ENABLE_BEST_MATCH 0
858#endif
859
Simon Glass3e569a62013-06-13 15:10:00 -0700860/* Information passed to the signing routines */
861struct image_sign_info {
862 const char *keydir; /* Directory conaining keys */
863 const char *keyname; /* Name of key to use */
864 void *fit; /* Pointer to FIT blob */
865 int node_offset; /* Offset of signature node */
866 struct image_sig_algo *algo; /* Algorithm information */
867 const void *fdt_blob; /* FDT containing public keys */
868 int required_keynode; /* Node offset of key to use: -1=any */
869 const char *require_keys; /* Value for 'required' property */
870};
871
872/* A part of an image, used for hashing */
873struct image_region {
874 const void *data;
875 int size;
876};
877
Heiko Schocher646257d2014-03-03 12:19:26 +0100878#if IMAGE_ENABLE_VERIFY
879# include <rsa-checksum.h>
880#endif
881struct checksum_algo {
882 const char *name;
883 const int checksum_len;
Heiko Schocherdb1b5f32014-03-03 12:19:27 +0100884 const int pad_len;
Heiko Schocher646257d2014-03-03 12:19:26 +0100885#if IMAGE_ENABLE_SIGN
Heiko Schocher29a23f92014-03-03 12:19:30 +0100886 const EVP_MD *(*calculate_sign)(void);
887#endif
Heiko Schocher646257d2014-03-03 12:19:26 +0100888 void (*calculate)(const struct image_region region[],
889 int region_count, uint8_t *checksum);
890 const uint8_t *rsa_padding;
Heiko Schocher646257d2014-03-03 12:19:26 +0100891};
892
Simon Glass3e569a62013-06-13 15:10:00 -0700893struct image_sig_algo {
894 const char *name; /* Name of algorithm */
895
896 /**
897 * sign() - calculate and return signature for given input data
898 *
899 * @info: Specifies key and FIT information
900 * @data: Pointer to the input data
901 * @data_len: Data length
902 * @sigp: Set to an allocated buffer holding the signature
903 * @sig_len: Set to length of the calculated hash
904 *
905 * This computes input data signature according to selected algorithm.
906 * Resulting signature value is placed in an allocated buffer, the
907 * pointer is returned as *sigp. The length of the calculated
908 * signature is returned via the sig_len pointer argument. The caller
909 * should free *sigp.
910 *
911 * @return: 0, on success, -ve on error
912 */
913 int (*sign)(struct image_sign_info *info,
914 const struct image_region region[],
915 int region_count, uint8_t **sigp, uint *sig_len);
916
917 /**
918 * add_verify_data() - Add verification information to FDT
919 *
920 * Add public key information to the FDT node, suitable for
921 * verification at run-time. The information added depends on the
922 * algorithm being used.
923 *
924 * @info: Specifies key and FIT information
925 * @keydest: Destination FDT blob for public key data
926 * @return: 0, on success, -ve on error
927 */
928 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
929
930 /**
931 * verify() - Verify a signature against some data
932 *
933 * @info: Specifies key and FIT information
934 * @data: Pointer to the input data
935 * @data_len: Data length
936 * @sig: Signature
937 * @sig_len: Number of bytes in signature
938 * @return 0 if verified, -ve on error
939 */
940 int (*verify)(struct image_sign_info *info,
941 const struct image_region region[], int region_count,
942 uint8_t *sig, uint sig_len);
Heiko Schocher646257d2014-03-03 12:19:26 +0100943
944 /* pointer to checksum algorithm */
945 struct checksum_algo *checksum;
Simon Glass3e569a62013-06-13 15:10:00 -0700946};
947
948/**
949 * image_get_sig_algo() - Look up a signature algortihm
950 *
951 * @param name Name of algorithm
952 * @return pointer to algorithm information, or NULL if not found
953 */
954struct image_sig_algo *image_get_sig_algo(const char *name);
955
Simon Glass56518e72013-06-13 15:10:01 -0700956/**
957 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
958 *
959 * @fit: FIT to check
960 * @image_noffset: Offset of image node to check
961 * @data: Image data to check
962 * @size: Size of image data
963 * @sig_blob: FDT containing public keys
964 * @no_sigsp: Returns 1 if no signatures were required, and
965 * therefore nothing was checked. The caller may wish
966 * to fall back to other mechanisms, or refuse to
967 * boot.
968 * @return 0 if all verified ok, <0 on error
969 */
970int fit_image_verify_required_sigs(const void *fit, int image_noffset,
971 const char *data, size_t size, const void *sig_blob,
972 int *no_sigsp);
973
974/**
975 * fit_image_check_sig() - Check a single image signature node
976 *
977 * @fit: FIT to check
978 * @noffset: Offset of signature node to check
979 * @data: Image data to check
980 * @size: Size of image data
981 * @required_keynode: Offset in the control FDT of the required key node,
982 * if any. If this is given, then the image wil not
983 * pass verification unless that key is used. If this is
984 * -1 then any signature will do.
985 * @err_msgp: In the event of an error, this will be pointed to a
986 * help error string to display to the user.
987 * @return 0 if all verified ok, <0 on error
988 */
989int fit_image_check_sig(const void *fit, int noffset, const void *data,
990 size_t size, int required_keynode, char **err_msgp);
991
Simon Glass4d098522013-06-13 15:10:09 -0700992/**
993 * fit_region_make_list() - Make a list of regions to hash
994 *
995 * Given a list of FIT regions (offset, size) provided by libfdt, create
996 * a list of regions (void *, size) for use by the signature creationg
997 * and verification code.
998 *
999 * @fit: FIT image to process
1000 * @fdt_regions: Regions as returned by libfdt
1001 * @count: Number of regions returned by libfdt
1002 * @region: Place to put list of regions (NULL to allocate it)
1003 * @return pointer to list of regions, or NULL if out of memory
1004 */
1005struct image_region *fit_region_make_list(const void *fit,
1006 struct fdt_region *fdt_regions, int count,
1007 struct image_region *region);
Simon Glass56518e72013-06-13 15:10:01 -07001008
Stephen Warren712fbcf2011-10-18 11:11:49 +00001009static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001010{
Heiko Schocher29a23f92014-03-03 12:19:30 +01001011#ifndef USE_HOSTCC
Thierry Reding75668322011-10-27 08:58:25 +00001012 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Heiko Schocher29a23f92014-03-03 12:19:30 +01001013#else
1014 return 0;
1015#endif
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001016}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +01001017
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001018#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +00001019#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001020 "FIT images not supported for '%s'\n", \
1021 __FILE__, __LINE__, (msg))
1022
Stephen Warren712fbcf2011-10-18 11:11:49 +00001023#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001024 "FIT images not supported for '%s' " \
1025 "- must reset board to recover!\n", \
1026 __FILE__, __LINE__, (msg))
1027#else
1028#define fit_unsupported(msg)
1029#define fit_unsupported_reset(msg)
1030#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +01001031#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +01001032
Marian Balakowiczf13e7b22008-01-08 18:12:17 +01001033#endif /* __IMAGE_H__ */