blob: 27c977e534780d0a2cfaf5bf24a17ae6993fa4a6 [file] [log] [blame]
wdenk5b1d7132002-11-03 00:07:02 +00001/*
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01002 * (C) Copyright 2008 Semihalf
3 *
Wolfgang Denkf08abe32005-11-25 16:38:03 +01004 * (C) Copyright 2000-2005
wdenk5b1d7132002-11-03 00:07:02 +00005 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 *
7 * See file CREDITS for list of people who contributed to this
8 * project.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23 * MA 02111-1307 USA
Wolfgang Denkf08abe32005-11-25 16:38:03 +010024 *
25 ********************************************************************
26 * NOTE: This header file defines an interface to U-Boot. Including
27 * this (unmodified) header file in another file is considered normal
28 * use of U-Boot, and does *not* fall under the heading of "derived
29 * work".
30 ********************************************************************
wdenk5b1d7132002-11-03 00:07:02 +000031 */
32
33#ifndef __IMAGE_H__
34#define __IMAGE_H__
35
Mike Frysinger37566092009-07-02 19:23:25 -040036#include "compiler.h"
Kim Phillips2f220502012-10-29 13:34:30 +000037#include <asm/byteorder.h>
Mike Frysinger37566092009-07-02 19:23:25 -040038
39#ifdef USE_HOSTCC
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010040
41/* new uImage format support enabled on host */
42#define CONFIG_FIT 1
43#define CONFIG_OF_LIBFDT 1
44#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
45
Simon Glassab9efc62013-05-07 06:11:58 +000046#define IMAGE_ENABLE_IGNORE 0
Simon Glass1fe7d932013-05-08 08:05:58 +000047#define IMAGE_INDENT_STRING ""
Simon Glassab9efc62013-05-07 06:11:58 +000048
Wolfgang Denkdef08192008-10-21 11:23:56 +020049#else
50
51#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020052#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050053#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020054
Simon Glassab9efc62013-05-07 06:11:58 +000055/* Take notice of the 'ignore' property for hashes */
56#define IMAGE_ENABLE_IGNORE 1
Simon Glass1fe7d932013-05-08 08:05:58 +000057#define IMAGE_INDENT_STRING " "
Simon Glassab9efc62013-05-07 06:11:58 +000058
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010059#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010060
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010061#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010062#include <libfdt.h>
63#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010064#define CONFIG_MD5 /* FIT images need MD5 support */
Mike Frysingerdac4d7e2010-01-17 21:08:00 -050065#define CONFIG_SHA1 /* and SHA1 */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010066#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010067
wdenk5b1d7132002-11-03 00:07:02 +000068/*
69 * Operating System Codes
70 */
71#define IH_OS_INVALID 0 /* Invalid OS */
72#define IH_OS_OPENBSD 1 /* OpenBSD */
73#define IH_OS_NETBSD 2 /* NetBSD */
74#define IH_OS_FREEBSD 3 /* FreeBSD */
75#define IH_OS_4_4BSD 4 /* 4.4BSD */
76#define IH_OS_LINUX 5 /* Linux */
77#define IH_OS_SVR4 6 /* SVR4 */
78#define IH_OS_ESIX 7 /* Esix */
79#define IH_OS_SOLARIS 8 /* Solaris */
80#define IH_OS_IRIX 9 /* Irix */
81#define IH_OS_SCO 10 /* SCO */
82#define IH_OS_DELL 11 /* Dell */
83#define IH_OS_NCR 12 /* NCR */
84#define IH_OS_LYNXOS 13 /* LynxOS */
85#define IH_OS_VXWORKS 14 /* VxWorks */
86#define IH_OS_PSOS 15 /* pSOS */
87#define IH_OS_QNX 16 /* QNX */
88#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +000089#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +000090#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +000091#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -050092#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +020093#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +000094#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +000095
96/*
97 * CPU Architecture Codes (supported by Linux)
98 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010099#define IH_ARCH_INVALID 0 /* Invalid CPU */
100#define IH_ARCH_ALPHA 1 /* Alpha */
101#define IH_ARCH_ARM 2 /* ARM */
102#define IH_ARCH_I386 3 /* Intel x86 */
103#define IH_ARCH_IA64 4 /* IA64 */
104#define IH_ARCH_MIPS 5 /* MIPS */
105#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
106#define IH_ARCH_PPC 7 /* PowerPC */
107#define IH_ARCH_S390 8 /* IBM S390 */
108#define IH_ARCH_SH 9 /* SuperH */
109#define IH_ARCH_SPARC 10 /* Sparc */
110#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
111#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100112#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
113#define IH_ARCH_NIOS2 15 /* Nios-II */
114#define IH_ARCH_BLACKFIN 16 /* Blackfin */
115#define IH_ARCH_AVR32 17 /* AVR32 */
116#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000117#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000118#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000119#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
wdenk5b1d7132002-11-03 00:07:02 +0000120
121/*
122 * Image Types
123 *
124 * "Standalone Programs" are directly runnable in the environment
125 * provided by U-Boot; it is expected that (if they behave
126 * well) you can continue to work in U-Boot after return from
127 * the Standalone Program.
128 * "OS Kernel Images" are usually images of some Embedded OS which
129 * will take over control completely. Usually these programs
130 * will install their own set of exception handlers, device
131 * drivers, set up the MMU, etc. - this means, that you cannot
132 * expect to re-enter U-Boot except by resetting the CPU.
133 * "RAMDisk Images" are more or less just data blocks, and their
134 * parameters (address, size) are passed to an OS kernel that is
135 * being started.
136 * "Multi-File Images" contain several images, typically an OS
137 * (Linux) kernel image and one or more data images like
138 * RAMDisks. This construct is useful for instance when you want
139 * to boot over the network using BOOTP etc., where the boot
140 * server provides just a single image file, but you want to get
141 * for instance an OS kernel and a RAMDisk image.
142 *
143 * "Multi-File Images" start with a list of image sizes, each
144 * image size (in bytes) specified by an "uint32_t" in network
145 * byte order. This list is terminated by an "(uint32_t)0".
146 * Immediately after the terminating 0 follow the images, one by
147 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000148 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000149 *
150 * "Firmware Images" are binary images containing firmware (like
151 * U-Boot or FPGA images) which usually will be programmed to
152 * flash memory.
153 *
154 * "Script files" are command sequences that will be executed by
155 * U-Boot's command interpreter; this feature is especially
156 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000157 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000158 */
159
160#define IH_TYPE_INVALID 0 /* Invalid Image */
161#define IH_TYPE_STANDALONE 1 /* Standalone Program */
162#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
163#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
164#define IH_TYPE_MULTI 4 /* Multi-File Image */
165#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
166#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000167#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500168#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530169#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100170#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000171#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400172#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000173#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e82011-11-10 13:17:53 -0700174#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000175#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000176
177/*
178 * Compression Types
179 */
180#define IH_COMP_NONE 0 /* No Compression Used */
181#define IH_COMP_GZIP 1 /* gzip Compression Used */
182#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200183#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100184#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000185
186#define IH_MAGIC 0x27051956 /* Image Magic Number */
187#define IH_NMLEN 32 /* Image Name Length */
188
Fabio Estevam1411fb32013-01-03 08:24:33 +0000189/* Reused from common.h */
190#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
191
wdenk5b1d7132002-11-03 00:07:02 +0000192/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100193 * Legacy format image header,
194 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000195 */
wdenk5b1d7132002-11-03 00:07:02 +0000196typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000197 __be32 ih_magic; /* Image Header Magic Number */
198 __be32 ih_hcrc; /* Image Header CRC Checksum */
199 __be32 ih_time; /* Image Creation Timestamp */
200 __be32 ih_size; /* Image Data Size */
201 __be32 ih_load; /* Data Load Address */
202 __be32 ih_ep; /* Entry Point Address */
203 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000204 uint8_t ih_os; /* Operating System */
205 uint8_t ih_arch; /* CPU architecture */
206 uint8_t ih_type; /* Image Type */
207 uint8_t ih_comp; /* Compression Type */
208 uint8_t ih_name[IH_NMLEN]; /* Image Name */
209} image_header_t;
210
Kumar Gala396f6352008-08-15 08:24:41 -0500211typedef struct image_info {
212 ulong start, end; /* start/end of blob */
213 ulong image_start, image_len; /* start of image within blob, len of image */
214 ulong load; /* load addr for the image */
215 uint8_t comp, type, os; /* compression, type of image, os type */
216} image_info_t;
217
Marian Balakowicz559316f2008-01-08 18:11:44 +0100218/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100219 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
220 * routines.
221 */
222typedef struct bootm_headers {
223 /*
224 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100225 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100226 * data from second and third component accordingly.
227 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200228 image_header_t *legacy_hdr_os; /* image header pointer */
229 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100230 ulong legacy_hdr_valid;
231
232#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100233 const char *fit_uname_cfg; /* configuration node unit name */
234
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100235 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100236 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100237 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100238
239 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100240 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
241 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100242
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100243 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100244 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
245 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100246#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100247
Kumar Gala49c3a862008-10-21 17:25:45 -0500248#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500249 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500250 ulong ep; /* entry point of OS */
251
Kumar Galac4f94192008-08-15 08:24:37 -0500252 ulong rd_start, rd_end;/* ramdisk start/end */
253
Kumar Gala06a09912008-08-15 08:24:38 -0500254#ifdef CONFIG_OF_LIBFDT
255 char *ft_addr; /* flat dev tree address */
256#endif
257 ulong ft_len; /* length of flat device tree */
258
Kumar Gala49c3a862008-10-21 17:25:45 -0500259 ulong initrd_start;
260 ulong initrd_end;
261 ulong cmdline_start;
262 ulong cmdline_end;
263 bd_t *kbd;
264#endif
265
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100266 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500267
268#define BOOTM_STATE_START (0x00000001)
269#define BOOTM_STATE_LOADOS (0x00000002)
270#define BOOTM_STATE_RAMDISK (0x00000004)
271#define BOOTM_STATE_FDT (0x00000008)
272#define BOOTM_STATE_OS_CMDLINE (0x00000010)
273#define BOOTM_STATE_OS_BD_T (0x00000020)
274#define BOOTM_STATE_OS_PREP (0x00000040)
275#define BOOTM_STATE_OS_GO (0x00000080)
276 int state;
277
Mike Frysingera16028d2009-11-03 11:35:59 -0500278#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500279 struct lmb lmb; /* for memory mgmt */
280#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100281} bootm_headers_t;
282
Simon Schwarz1648a372012-03-15 04:01:34 +0000283extern bootm_headers_t images;
284
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100285/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100286 * Some systems (for example LWMON) have very short watchdog periods;
287 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200288 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100289 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200290#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100291#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200292#endif
293
294#ifndef CHUNKSZ_CRC32
295#define CHUNKSZ_CRC32 (64 * 1024)
296#endif
297
298#ifndef CHUNKSZ_MD5
299#define CHUNKSZ_MD5 (64 * 1024)
300#endif
301
302#ifndef CHUNKSZ_SHA1
303#define CHUNKSZ_SHA1 (64 * 1024)
304#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100305
Mike Frysinger37566092009-07-02 19:23:25 -0400306#define uimage_to_cpu(x) be32_to_cpu(x)
307#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000308
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530309/*
310 * Translation table for entries of a specific type; used by
311 * get_table_entry_id() and get_table_entry_name().
312 */
313typedef struct table_entry {
314 int id;
315 char *sname; /* short (input) name to find table entry */
316 char *lname; /* long (output) name to print for messages */
317} table_entry_t;
318
319/*
320 * get_table_entry_id() scans the translation table trying to find an
321 * entry that matches the given short name. If a matching entry is
322 * found, it's id is returned to the caller.
323 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400324int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530325 const char *table_name, const char *name);
326/*
327 * get_table_entry_name() scans the translation table trying to find
328 * an entry that matches the given id. If a matching entry is found,
329 * its long name is returned to the caller.
330 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400331char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530332
Stephen Warren712fbcf2011-10-18 11:11:49 +0000333const char *genimg_get_os_name(uint8_t os);
334const char *genimg_get_arch_name(uint8_t arch);
335const char *genimg_get_type_name(uint8_t type);
336const char *genimg_get_comp_name(uint8_t comp);
337int genimg_get_os_id(const char *name);
338int genimg_get_arch_id(const char *name);
339int genimg_get_type_id(const char *name);
340int genimg_get_comp_id(const char *name);
341void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100342
Simon Glass859e92b2013-05-07 06:11:51 +0000343#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
344 defined(USE_HOSTCC)
345#define IMAGE_ENABLE_TIMESTAMP 1
346#else
347#define IMAGE_ENABLE_TIMESTAMP 0
348#endif
349void genimg_print_time(time_t timestamp);
350
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100351#ifndef USE_HOSTCC
352/* Image format types, returned by _get_format() routine */
353#define IMAGE_FORMAT_INVALID 0x00
354#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
355#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
356
Simon Glass35e7b0f2013-05-07 06:12:03 +0000357int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000358int genimg_has_config(bootm_headers_t *images);
359ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100360
Stephen Warren712fbcf2011-10-18 11:11:49 +0000361int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100362 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100363
Kumar Gala06a09912008-08-15 08:24:38 -0500364
365#ifdef CONFIG_OF_LIBFDT
Stephen Warren712fbcf2011-10-18 11:11:49 +0000366int boot_get_fdt(int flag, int argc, char * const argv[],
367 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000368void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000369int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500370#endif
371
John Rigbyfca43cc2010-10-13 13:57:35 -0600372#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Stephen Warren712fbcf2011-10-18 11:11:49 +0000373int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100374 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600375#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
376#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000377int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600378#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
379#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000380int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600381#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100382#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100383
384/*******************************************************************/
385/* Legacy format specific code (prefixed with image_) */
386/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000387static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100388{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000389 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100390}
391
392#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200393 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100394 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000395 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100396 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000397image_get_hdr_l(magic) /* image_get_magic */
398image_get_hdr_l(hcrc) /* image_get_hcrc */
399image_get_hdr_l(time) /* image_get_time */
400image_get_hdr_l(size) /* image_get_size */
401image_get_hdr_l(load) /* image_get_load */
402image_get_hdr_l(ep) /* image_get_ep */
403image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100404
405#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200406 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100407 { \
408 return hdr->ih_##f; \
409 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000410image_get_hdr_b(os) /* image_get_os */
411image_get_hdr_b(arch) /* image_get_arch */
412image_get_hdr_b(type) /* image_get_type */
413image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100414
Stephen Warren712fbcf2011-10-18 11:11:49 +0000415static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100416{
417 return (char *)hdr->ih_name;
418}
419
Stephen Warren712fbcf2011-10-18 11:11:49 +0000420static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100421{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000422 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100423}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100424
425/**
426 * image_get_data - get image payload start address
427 * @hdr: image header
428 *
429 * image_get_data() returns address of the image payload. For single
430 * component images it is image data start. For multi component
431 * images it points to the null terminated table of sub-images sizes.
432 *
433 * returns:
434 * image payload data start address
435 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000436static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100437{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000438 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100439}
440
Stephen Warren712fbcf2011-10-18 11:11:49 +0000441static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100442{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000443 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100444}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000445static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100446{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000447 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100448}
449
450#define image_set_hdr_l(f) \
451 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
452 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000453 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100454 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000455image_set_hdr_l(magic) /* image_set_magic */
456image_set_hdr_l(hcrc) /* image_set_hcrc */
457image_set_hdr_l(time) /* image_set_time */
458image_set_hdr_l(size) /* image_set_size */
459image_set_hdr_l(load) /* image_set_load */
460image_set_hdr_l(ep) /* image_set_ep */
461image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100462
463#define image_set_hdr_b(f) \
464 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
465 { \
466 hdr->ih_##f = val; \
467 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000468image_set_hdr_b(os) /* image_set_os */
469image_set_hdr_b(arch) /* image_set_arch */
470image_set_hdr_b(type) /* image_set_type */
471image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100472
Stephen Warren712fbcf2011-10-18 11:11:49 +0000473static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100474{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000475 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100476}
477
Stephen Warren712fbcf2011-10-18 11:11:49 +0000478int image_check_hcrc(const image_header_t *hdr);
479int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100480#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600481ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500482phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000483phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000484void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100485#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100486
Stephen Warren712fbcf2011-10-18 11:11:49 +0000487static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100488{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000489 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100490}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000491static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100492{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000493 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100494}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000495static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100496{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000497 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100498}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000499static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100500{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000501 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100502}
503
Stephen Warren712fbcf2011-10-18 11:11:49 +0000504ulong image_multi_count(const image_header_t *hdr);
505void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100506 ulong *data, ulong *len);
507
Stephen Warren712fbcf2011-10-18 11:11:49 +0000508void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100509
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100510#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000511static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100512{
Mike Frysinger476af292011-10-03 14:50:33 +0000513#ifndef IH_ARCH_DEFAULT
514# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100515#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000516 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100517}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100518#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100519
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100520/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100521/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100522/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100523#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100524
525#define FIT_IMAGES_PATH "/images"
526#define FIT_CONFS_PATH "/configurations"
527
528/* hash node */
529#define FIT_HASH_NODENAME "hash"
530#define FIT_ALGO_PROP "algo"
531#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000532#define FIT_IGNORE_PROP "uboot-ignore"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100533
534/* image node */
535#define FIT_DATA_PROP "data"
536#define FIT_TIMESTAMP_PROP "timestamp"
537#define FIT_DESC_PROP "description"
538#define FIT_ARCH_PROP "arch"
539#define FIT_TYPE_PROP "type"
540#define FIT_OS_PROP "os"
541#define FIT_COMP_PROP "compression"
542#define FIT_ENTRY_PROP "entry"
543#define FIT_LOAD_PROP "load"
544
545/* configuration node */
546#define FIT_KERNEL_PROP "kernel"
547#define FIT_RAMDISK_PROP "ramdisk"
548#define FIT_FDT_PROP "fdt"
549#define FIT_DEFAULT_PROP "default"
550
551#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
552
553/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000554int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100555 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000556int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100557 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100558
Stephen Warren712fbcf2011-10-18 11:11:49 +0000559void fit_print_contents(const void *fit);
560void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100561
562/**
563 * fit_get_end - get FIT image size
564 * @fit: pointer to the FIT format image header
565 *
566 * returns:
567 * size of the FIT image (blob) in memory
568 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000569static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100570{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000571 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100572}
573
574/**
575 * fit_get_end - get FIT image end
576 * @fit: pointer to the FIT format image header
577 *
578 * returns:
579 * end address of the FIT image (blob) in memory
580 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000581static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100582{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000583 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100584}
585
586/**
587 * fit_get_name - get FIT node name
588 * @fit: pointer to the FIT format image header
589 *
590 * returns:
591 * NULL, on error
592 * pointer to node name, on success
593 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000594static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100595 int noffset, int *len)
596{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000597 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100598}
599
Stephen Warren712fbcf2011-10-18 11:11:49 +0000600int fit_get_desc(const void *fit, int noffset, char **desc);
601int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100602
Stephen Warren712fbcf2011-10-18 11:11:49 +0000603int fit_image_get_node(const void *fit, const char *image_uname);
604int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
605int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
606int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
607int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
608int fit_image_get_load(const void *fit, int noffset, ulong *load);
609int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
610int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100611 const void **data, size_t *size);
612
Stephen Warren712fbcf2011-10-18 11:11:49 +0000613int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
614int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100615 int *value_len);
616
Stephen Warren712fbcf2011-10-18 11:11:49 +0000617int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000618
619/**
620 * fit_add_verification_data() - Calculate and add hashes to FIT
621 *
622 * @fit: Fit image to process
623 * @return 0 if ok, <0 for error
624 */
625int fit_add_verification_data(void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100626
Simon Glassb8da8362013-05-07 06:11:57 +0000627int fit_image_verify(const void *fit, int noffset);
628int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000629int fit_image_check_os(const void *fit, int noffset, uint8_t os);
630int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
631int fit_image_check_type(const void *fit, int noffset, uint8_t type);
632int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
633int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100634
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000635int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000636int fit_conf_get_node(const void *fit, const char *conf_uname);
637int fit_conf_get_kernel_node(const void *fit, int noffset);
638int fit_conf_get_ramdisk_node(const void *fit, int noffset);
639int fit_conf_get_fdt_node(const void *fit, int noffset);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100640
Simon Glass003efd72013-05-07 06:12:00 +0000641/**
642 * fit_conf_get_prop_node() - Get node refered to by a configuration
643 * @fit: FIT to check
644 * @noffset: Offset of conf@xxx node to check
645 * @prop_name: Property to read from the conf node
646 *
647 * The conf@ nodes contain references to other nodes, using properties
648 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
649 * return the offset of the node referred to (e.g. offset of node
650 * "/images/kernel@1".
651 */
652int fit_conf_get_prop_node(const void *fit, int noffset,
653 const char *prop_name);
654
Stephen Warren712fbcf2011-10-18 11:11:49 +0000655void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100656
Simon Glass61a439a2013-05-07 06:11:52 +0000657int fit_check_ramdisk(const void *fit, int os_noffset,
658 uint8_t arch, int verify);
659
Simon Glass604f23d2013-05-07 06:11:54 +0000660int calculate_hash(const void *data, int data_len, const char *algo,
661 uint8_t *value, int *value_len);
662
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100663#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000664static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100665{
Thierry Reding75668322011-10-27 08:58:25 +0000666 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100667}
668#endif /* USE_HOSTCC */
669
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100670#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000671#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100672 "FIT images not supported for '%s'\n", \
673 __FILE__, __LINE__, (msg))
674
Stephen Warren712fbcf2011-10-18 11:11:49 +0000675#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100676 "FIT images not supported for '%s' " \
677 "- must reset board to recover!\n", \
678 __FILE__, __LINE__, (msg))
679#else
680#define fit_unsupported(msg)
681#define fit_unsupported_reset(msg)
682#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100683#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100684
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100685#endif /* __IMAGE_H__ */