blob: df020ff135d210677cd530f10c52e524e6bfd377 [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
47
Wolfgang Denkdef08192008-10-21 11:23:56 +020048#else
49
50#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020051#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050052#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020053
Simon Glassab9efc62013-05-07 06:11:58 +000054/* Take notice of the 'ignore' property for hashes */
55#define IMAGE_ENABLE_IGNORE 1
56
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010057#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010058
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010059#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010060#include <libfdt.h>
61#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010062#define CONFIG_MD5 /* FIT images need MD5 support */
Mike Frysingerdac4d7e2010-01-17 21:08:00 -050063#define CONFIG_SHA1 /* and SHA1 */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010064#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010065
wdenk5b1d7132002-11-03 00:07:02 +000066/*
67 * Operating System Codes
68 */
69#define IH_OS_INVALID 0 /* Invalid OS */
70#define IH_OS_OPENBSD 1 /* OpenBSD */
71#define IH_OS_NETBSD 2 /* NetBSD */
72#define IH_OS_FREEBSD 3 /* FreeBSD */
73#define IH_OS_4_4BSD 4 /* 4.4BSD */
74#define IH_OS_LINUX 5 /* Linux */
75#define IH_OS_SVR4 6 /* SVR4 */
76#define IH_OS_ESIX 7 /* Esix */
77#define IH_OS_SOLARIS 8 /* Solaris */
78#define IH_OS_IRIX 9 /* Irix */
79#define IH_OS_SCO 10 /* SCO */
80#define IH_OS_DELL 11 /* Dell */
81#define IH_OS_NCR 12 /* NCR */
82#define IH_OS_LYNXOS 13 /* LynxOS */
83#define IH_OS_VXWORKS 14 /* VxWorks */
84#define IH_OS_PSOS 15 /* pSOS */
85#define IH_OS_QNX 16 /* QNX */
86#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +000087#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +000088#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +000089#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -050090#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +020091#define IH_OS_OSE 22 /* OSE */
Steven Stallion04d41402013-03-20 06:31:35 +000092#define IH_OS_PLAN9 23 /* Plan 9 */
wdenk5b1d7132002-11-03 00:07:02 +000093
94/*
95 * CPU Architecture Codes (supported by Linux)
96 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010097#define IH_ARCH_INVALID 0 /* Invalid CPU */
98#define IH_ARCH_ALPHA 1 /* Alpha */
99#define IH_ARCH_ARM 2 /* ARM */
100#define IH_ARCH_I386 3 /* Intel x86 */
101#define IH_ARCH_IA64 4 /* IA64 */
102#define IH_ARCH_MIPS 5 /* MIPS */
103#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
104#define IH_ARCH_PPC 7 /* PowerPC */
105#define IH_ARCH_S390 8 /* IBM S390 */
106#define IH_ARCH_SH 9 /* SuperH */
107#define IH_ARCH_SPARC 10 /* Sparc */
108#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
109#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100110#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
111#define IH_ARCH_NIOS2 15 /* Nios-II */
112#define IH_ARCH_BLACKFIN 16 /* Blackfin */
113#define IH_ARCH_AVR32 17 /* AVR32 */
114#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
Simon Glass65bf1d32011-10-07 13:53:34 +0000115#define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
Stefan Kristianssonf52138a2011-11-21 23:43:58 +0000116#define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
Stefan Kristiansson3ddcacc2011-11-26 19:04:50 +0000117#define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
wdenk5b1d7132002-11-03 00:07:02 +0000118
119/*
120 * Image Types
121 *
122 * "Standalone Programs" are directly runnable in the environment
123 * provided by U-Boot; it is expected that (if they behave
124 * well) you can continue to work in U-Boot after return from
125 * the Standalone Program.
126 * "OS Kernel Images" are usually images of some Embedded OS which
127 * will take over control completely. Usually these programs
128 * will install their own set of exception handlers, device
129 * drivers, set up the MMU, etc. - this means, that you cannot
130 * expect to re-enter U-Boot except by resetting the CPU.
131 * "RAMDisk Images" are more or less just data blocks, and their
132 * parameters (address, size) are passed to an OS kernel that is
133 * being started.
134 * "Multi-File Images" contain several images, typically an OS
135 * (Linux) kernel image and one or more data images like
136 * RAMDisks. This construct is useful for instance when you want
137 * to boot over the network using BOOTP etc., where the boot
138 * server provides just a single image file, but you want to get
139 * for instance an OS kernel and a RAMDisk image.
140 *
141 * "Multi-File Images" start with a list of image sizes, each
142 * image size (in bytes) specified by an "uint32_t" in network
143 * byte order. This list is terminated by an "(uint32_t)0".
144 * Immediately after the terminating 0 follow the images, one by
145 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000146 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000147 *
148 * "Firmware Images" are binary images containing firmware (like
149 * U-Boot or FPGA images) which usually will be programmed to
150 * flash memory.
151 *
152 * "Script files" are command sequences that will be executed by
153 * U-Boot's command interpreter; this feature is especially
154 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000155 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000156 */
157
158#define IH_TYPE_INVALID 0 /* Invalid Image */
159#define IH_TYPE_STANDALONE 1 /* Standalone Program */
160#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
161#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
162#define IH_TYPE_MULTI 4 /* Multi-File Image */
163#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
164#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000165#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500166#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530167#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100168#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000169#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400170#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
Stefano Babic4962e382011-10-17 00:07:43 +0000171#define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
Stephen Warrenb9b50e892011-11-10 13:17:53 -0700172#define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000173#define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000174
175/*
176 * Compression Types
177 */
178#define IH_COMP_NONE 0 /* No Compression Used */
179#define IH_COMP_GZIP 1 /* gzip Compression Used */
180#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200181#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100182#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000183
184#define IH_MAGIC 0x27051956 /* Image Magic Number */
185#define IH_NMLEN 32 /* Image Name Length */
186
Fabio Estevam1411fb32013-01-03 08:24:33 +0000187/* Reused from common.h */
188#define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
189
wdenk5b1d7132002-11-03 00:07:02 +0000190/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100191 * Legacy format image header,
192 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000193 */
wdenk5b1d7132002-11-03 00:07:02 +0000194typedef struct image_header {
Kim Phillips2f220502012-10-29 13:34:30 +0000195 __be32 ih_magic; /* Image Header Magic Number */
196 __be32 ih_hcrc; /* Image Header CRC Checksum */
197 __be32 ih_time; /* Image Creation Timestamp */
198 __be32 ih_size; /* Image Data Size */
199 __be32 ih_load; /* Data Load Address */
200 __be32 ih_ep; /* Entry Point Address */
201 __be32 ih_dcrc; /* Image Data CRC Checksum */
wdenk5b1d7132002-11-03 00:07:02 +0000202 uint8_t ih_os; /* Operating System */
203 uint8_t ih_arch; /* CPU architecture */
204 uint8_t ih_type; /* Image Type */
205 uint8_t ih_comp; /* Compression Type */
206 uint8_t ih_name[IH_NMLEN]; /* Image Name */
207} image_header_t;
208
Kumar Gala396f6352008-08-15 08:24:41 -0500209typedef struct image_info {
210 ulong start, end; /* start/end of blob */
211 ulong image_start, image_len; /* start of image within blob, len of image */
212 ulong load; /* load addr for the image */
213 uint8_t comp, type, os; /* compression, type of image, os type */
214} image_info_t;
215
Marian Balakowicz559316f2008-01-08 18:11:44 +0100216/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100217 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
218 * routines.
219 */
220typedef struct bootm_headers {
221 /*
222 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100223 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100224 * data from second and third component accordingly.
225 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200226 image_header_t *legacy_hdr_os; /* image header pointer */
227 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100228 ulong legacy_hdr_valid;
229
230#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100231 const char *fit_uname_cfg; /* configuration node unit name */
232
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100233 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100234 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100235 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100236
237 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100238 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
239 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100240
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100241 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100242 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
243 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100244#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100245
Kumar Gala49c3a862008-10-21 17:25:45 -0500246#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500247 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500248 ulong ep; /* entry point of OS */
249
Kumar Galac4f94192008-08-15 08:24:37 -0500250 ulong rd_start, rd_end;/* ramdisk start/end */
251
Kumar Gala06a09912008-08-15 08:24:38 -0500252#ifdef CONFIG_OF_LIBFDT
253 char *ft_addr; /* flat dev tree address */
254#endif
255 ulong ft_len; /* length of flat device tree */
256
Kumar Gala49c3a862008-10-21 17:25:45 -0500257 ulong initrd_start;
258 ulong initrd_end;
259 ulong cmdline_start;
260 ulong cmdline_end;
261 bd_t *kbd;
262#endif
263
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100264 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500265
266#define BOOTM_STATE_START (0x00000001)
267#define BOOTM_STATE_LOADOS (0x00000002)
268#define BOOTM_STATE_RAMDISK (0x00000004)
269#define BOOTM_STATE_FDT (0x00000008)
270#define BOOTM_STATE_OS_CMDLINE (0x00000010)
271#define BOOTM_STATE_OS_BD_T (0x00000020)
272#define BOOTM_STATE_OS_PREP (0x00000040)
273#define BOOTM_STATE_OS_GO (0x00000080)
274 int state;
275
Mike Frysingera16028d2009-11-03 11:35:59 -0500276#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500277 struct lmb lmb; /* for memory mgmt */
278#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100279} bootm_headers_t;
280
Simon Schwarz1648a372012-03-15 04:01:34 +0000281extern bootm_headers_t images;
282
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100283/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100284 * Some systems (for example LWMON) have very short watchdog periods;
285 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200286 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100287 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200288#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100289#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200290#endif
291
292#ifndef CHUNKSZ_CRC32
293#define CHUNKSZ_CRC32 (64 * 1024)
294#endif
295
296#ifndef CHUNKSZ_MD5
297#define CHUNKSZ_MD5 (64 * 1024)
298#endif
299
300#ifndef CHUNKSZ_SHA1
301#define CHUNKSZ_SHA1 (64 * 1024)
302#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100303
Mike Frysinger37566092009-07-02 19:23:25 -0400304#define uimage_to_cpu(x) be32_to_cpu(x)
305#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000306
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530307/*
308 * Translation table for entries of a specific type; used by
309 * get_table_entry_id() and get_table_entry_name().
310 */
311typedef struct table_entry {
312 int id;
313 char *sname; /* short (input) name to find table entry */
314 char *lname; /* long (output) name to print for messages */
315} table_entry_t;
316
317/*
318 * get_table_entry_id() scans the translation table trying to find an
319 * entry that matches the given short name. If a matching entry is
320 * found, it's id is returned to the caller.
321 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400322int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530323 const char *table_name, const char *name);
324/*
325 * get_table_entry_name() scans the translation table trying to find
326 * an entry that matches the given id. If a matching entry is found,
327 * its long name is returned to the caller.
328 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400329char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530330
Stephen Warren712fbcf2011-10-18 11:11:49 +0000331const char *genimg_get_os_name(uint8_t os);
332const char *genimg_get_arch_name(uint8_t arch);
333const char *genimg_get_type_name(uint8_t type);
334const char *genimg_get_comp_name(uint8_t comp);
335int genimg_get_os_id(const char *name);
336int genimg_get_arch_id(const char *name);
337int genimg_get_type_id(const char *name);
338int genimg_get_comp_id(const char *name);
339void genimg_print_size(uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100340
Simon Glass859e92b2013-05-07 06:11:51 +0000341#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
342 defined(USE_HOSTCC)
343#define IMAGE_ENABLE_TIMESTAMP 1
344#else
345#define IMAGE_ENABLE_TIMESTAMP 0
346#endif
347void genimg_print_time(time_t timestamp);
348
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100349#ifndef USE_HOSTCC
350/* Image format types, returned by _get_format() routine */
351#define IMAGE_FORMAT_INVALID 0x00
352#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
353#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
354
Simon Glass35e7b0f2013-05-07 06:12:03 +0000355int genimg_get_format(const void *img_addr);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000356int genimg_has_config(bootm_headers_t *images);
357ulong genimg_get_image(ulong img_addr);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100358
Stephen Warren712fbcf2011-10-18 11:11:49 +0000359int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100360 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100361
Kumar Gala06a09912008-08-15 08:24:38 -0500362
363#ifdef CONFIG_OF_LIBFDT
Stephen Warren712fbcf2011-10-18 11:11:49 +0000364int boot_get_fdt(int flag, int argc, char * const argv[],
365 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000366void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000367int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500368#endif
369
John Rigbyfca43cc2010-10-13 13:57:35 -0600370#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Stephen Warren712fbcf2011-10-18 11:11:49 +0000371int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100372 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600373#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
374#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000375int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600376#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
377#ifdef CONFIG_SYS_BOOT_GET_KBD
Stephen Warren712fbcf2011-10-18 11:11:49 +0000378int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600379#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100380#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100381
382/*******************************************************************/
383/* Legacy format specific code (prefixed with image_) */
384/*******************************************************************/
Stephen Warren712fbcf2011-10-18 11:11:49 +0000385static inline uint32_t image_get_header_size(void)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100386{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000387 return (sizeof(image_header_t));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100388}
389
390#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200391 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100392 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000393 return uimage_to_cpu(hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100394 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000395image_get_hdr_l(magic) /* image_get_magic */
396image_get_hdr_l(hcrc) /* image_get_hcrc */
397image_get_hdr_l(time) /* image_get_time */
398image_get_hdr_l(size) /* image_get_size */
399image_get_hdr_l(load) /* image_get_load */
400image_get_hdr_l(ep) /* image_get_ep */
401image_get_hdr_l(dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100402
403#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200404 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100405 { \
406 return hdr->ih_##f; \
407 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000408image_get_hdr_b(os) /* image_get_os */
409image_get_hdr_b(arch) /* image_get_arch */
410image_get_hdr_b(type) /* image_get_type */
411image_get_hdr_b(comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100412
Stephen Warren712fbcf2011-10-18 11:11:49 +0000413static inline char *image_get_name(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100414{
415 return (char *)hdr->ih_name;
416}
417
Stephen Warren712fbcf2011-10-18 11:11:49 +0000418static inline uint32_t image_get_data_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100419{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000420 return image_get_size(hdr);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100421}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100422
423/**
424 * image_get_data - get image payload start address
425 * @hdr: image header
426 *
427 * image_get_data() returns address of the image payload. For single
428 * component images it is image data start. For multi component
429 * images it points to the null terminated table of sub-images sizes.
430 *
431 * returns:
432 * image payload data start address
433 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000434static inline ulong image_get_data(const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100435{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000436 return ((ulong)hdr + image_get_header_size());
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100437}
438
Stephen Warren712fbcf2011-10-18 11:11:49 +0000439static inline uint32_t image_get_image_size(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100440{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000441 return (image_get_size(hdr) + image_get_header_size());
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100442}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000443static inline ulong image_get_image_end(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100444{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000445 return ((ulong)hdr + image_get_image_size(hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100446}
447
448#define image_set_hdr_l(f) \
449 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
450 { \
Stephen Warren712fbcf2011-10-18 11:11:49 +0000451 hdr->ih_##f = cpu_to_uimage(val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100452 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000453image_set_hdr_l(magic) /* image_set_magic */
454image_set_hdr_l(hcrc) /* image_set_hcrc */
455image_set_hdr_l(time) /* image_set_time */
456image_set_hdr_l(size) /* image_set_size */
457image_set_hdr_l(load) /* image_set_load */
458image_set_hdr_l(ep) /* image_set_ep */
459image_set_hdr_l(dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100460
461#define image_set_hdr_b(f) \
462 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
463 { \
464 hdr->ih_##f = val; \
465 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000466image_set_hdr_b(os) /* image_set_os */
467image_set_hdr_b(arch) /* image_set_arch */
468image_set_hdr_b(type) /* image_set_type */
469image_set_hdr_b(comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100470
Stephen Warren712fbcf2011-10-18 11:11:49 +0000471static inline void image_set_name(image_header_t *hdr, const char *name)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100472{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000473 strncpy(image_get_name(hdr), name, IH_NMLEN);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100474}
475
Stephen Warren712fbcf2011-10-18 11:11:49 +0000476int image_check_hcrc(const image_header_t *hdr);
477int image_check_dcrc(const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100478#ifndef USE_HOSTCC
Kumar Galad3f2fa02008-02-27 21:51:50 -0600479ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500480phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000481phys_size_t getenv_bootm_mapsize(void);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000482void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100483#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100484
Stephen Warren712fbcf2011-10-18 11:11:49 +0000485static inline int image_check_magic(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100486{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000487 return (image_get_magic(hdr) == IH_MAGIC);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100488}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000489static inline int image_check_type(const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100490{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000491 return (image_get_type(hdr) == type);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100492}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000493static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100494{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000495 return (image_get_arch(hdr) == arch);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100496}
Stephen Warren712fbcf2011-10-18 11:11:49 +0000497static inline int image_check_os(const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100498{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000499 return (image_get_os(hdr) == os);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100500}
501
Stephen Warren712fbcf2011-10-18 11:11:49 +0000502ulong image_multi_count(const image_header_t *hdr);
503void image_multi_getimg(const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100504 ulong *data, ulong *len);
505
Stephen Warren712fbcf2011-10-18 11:11:49 +0000506void image_print_contents(const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100507
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100508#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000509static inline int image_check_target_arch(const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100510{
Mike Frysinger476af292011-10-03 14:50:33 +0000511#ifndef IH_ARCH_DEFAULT
512# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100513#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000514 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100515}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100516#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100517
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100518/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100519/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100520/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100521#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100522
523#define FIT_IMAGES_PATH "/images"
524#define FIT_CONFS_PATH "/configurations"
525
526/* hash node */
527#define FIT_HASH_NODENAME "hash"
528#define FIT_ALGO_PROP "algo"
529#define FIT_VALUE_PROP "value"
Joe Hershberger8ac88f22012-08-17 10:34:39 +0000530#define FIT_IGNORE_PROP "uboot-ignore"
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100531
532/* image node */
533#define FIT_DATA_PROP "data"
534#define FIT_TIMESTAMP_PROP "timestamp"
535#define FIT_DESC_PROP "description"
536#define FIT_ARCH_PROP "arch"
537#define FIT_TYPE_PROP "type"
538#define FIT_OS_PROP "os"
539#define FIT_COMP_PROP "compression"
540#define FIT_ENTRY_PROP "entry"
541#define FIT_LOAD_PROP "load"
542
543/* configuration node */
544#define FIT_KERNEL_PROP "kernel"
545#define FIT_RAMDISK_PROP "ramdisk"
546#define FIT_FDT_PROP "fdt"
547#define FIT_DEFAULT_PROP "default"
548
549#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
550
551/* cmdline argument format parsing */
Mike Frysinger314f6342012-04-22 06:59:06 +0000552int fit_parse_conf(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100553 ulong *addr, const char **conf_name);
Mike Frysinger314f6342012-04-22 06:59:06 +0000554int fit_parse_subimage(const char *spec, ulong addr_curr,
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100555 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100556
Stephen Warren712fbcf2011-10-18 11:11:49 +0000557void fit_print_contents(const void *fit);
558void fit_image_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100559
560/**
561 * fit_get_end - get FIT image size
562 * @fit: pointer to the FIT format image header
563 *
564 * returns:
565 * size of the FIT image (blob) in memory
566 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000567static inline ulong fit_get_size(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100568{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000569 return fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100570}
571
572/**
573 * fit_get_end - get FIT image end
574 * @fit: pointer to the FIT format image header
575 *
576 * returns:
577 * end address of the FIT image (blob) in memory
578 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000579static inline ulong fit_get_end(const void *fit)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100580{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000581 return (ulong)fit + fdt_totalsize(fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100582}
583
584/**
585 * fit_get_name - get FIT node name
586 * @fit: pointer to the FIT format image header
587 *
588 * returns:
589 * NULL, on error
590 * pointer to node name, on success
591 */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000592static inline const char *fit_get_name(const void *fit_hdr,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100593 int noffset, int *len)
594{
Stephen Warren712fbcf2011-10-18 11:11:49 +0000595 return fdt_get_name(fit_hdr, noffset, len);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100596}
597
Stephen Warren712fbcf2011-10-18 11:11:49 +0000598int fit_get_desc(const void *fit, int noffset, char **desc);
599int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100600
Stephen Warren712fbcf2011-10-18 11:11:49 +0000601int fit_image_get_node(const void *fit, const char *image_uname);
602int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
603int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
604int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
605int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
606int fit_image_get_load(const void *fit, int noffset, ulong *load);
607int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
608int fit_image_get_data(const void *fit, int noffset,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100609 const void **data, size_t *size);
610
Stephen Warren712fbcf2011-10-18 11:11:49 +0000611int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
612int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100613 int *value_len);
614
Stephen Warren712fbcf2011-10-18 11:11:49 +0000615int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
Simon Glassbbb467d2013-05-07 06:12:01 +0000616
617/**
618 * fit_add_verification_data() - Calculate and add hashes to FIT
619 *
620 * @fit: Fit image to process
621 * @return 0 if ok, <0 for error
622 */
623int fit_add_verification_data(void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100624
Simon Glassb8da8362013-05-07 06:11:57 +0000625int fit_image_verify(const void *fit, int noffset);
626int fit_all_image_verify(const void *fit);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000627int fit_image_check_os(const void *fit, int noffset, uint8_t os);
628int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
629int fit_image_check_type(const void *fit, int noffset, uint8_t type);
630int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
631int fit_check_format(const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100632
Gabe Blackd95f6ec2012-10-25 16:31:10 +0000633int fit_conf_find_compat(const void *fit, const void *fdt);
Stephen Warren712fbcf2011-10-18 11:11:49 +0000634int fit_conf_get_node(const void *fit, const char *conf_uname);
635int fit_conf_get_kernel_node(const void *fit, int noffset);
636int fit_conf_get_ramdisk_node(const void *fit, int noffset);
637int fit_conf_get_fdt_node(const void *fit, int noffset);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100638
Simon Glass003efd72013-05-07 06:12:00 +0000639/**
640 * fit_conf_get_prop_node() - Get node refered to by a configuration
641 * @fit: FIT to check
642 * @noffset: Offset of conf@xxx node to check
643 * @prop_name: Property to read from the conf node
644 *
645 * The conf@ nodes contain references to other nodes, using properties
646 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
647 * return the offset of the node referred to (e.g. offset of node
648 * "/images/kernel@1".
649 */
650int fit_conf_get_prop_node(const void *fit, int noffset,
651 const char *prop_name);
652
Stephen Warren712fbcf2011-10-18 11:11:49 +0000653void fit_conf_print(const void *fit, int noffset, const char *p);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100654
Simon Glass61a439a2013-05-07 06:11:52 +0000655int fit_check_ramdisk(const void *fit, int os_noffset,
656 uint8_t arch, int verify);
657
Simon Glass604f23d2013-05-07 06:11:54 +0000658int calculate_hash(const void *data, int data_len, const char *algo,
659 uint8_t *value, int *value_len);
660
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100661#ifndef USE_HOSTCC
Stephen Warren712fbcf2011-10-18 11:11:49 +0000662static inline int fit_image_check_target_arch(const void *fdt, int node)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100663{
Thierry Reding75668322011-10-27 08:58:25 +0000664 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100665}
666#endif /* USE_HOSTCC */
667
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100668#ifdef CONFIG_FIT_VERBOSE
Stephen Warren712fbcf2011-10-18 11:11:49 +0000669#define fit_unsupported(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100670 "FIT images not supported for '%s'\n", \
671 __FILE__, __LINE__, (msg))
672
Stephen Warren712fbcf2011-10-18 11:11:49 +0000673#define fit_unsupported_reset(msg) printf("! %s:%d " \
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100674 "FIT images not supported for '%s' " \
675 "- must reset board to recover!\n", \
676 __FILE__, __LINE__, (msg))
677#else
678#define fit_unsupported(msg)
679#define fit_unsupported_reset(msg)
680#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100681#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100682
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100683#endif /* __IMAGE_H__ */