blob: cca1cc533c586e21c2a82f22d316092e084abafd [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"
37
38#ifdef USE_HOSTCC
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010039
40/* new uImage format support enabled on host */
41#define CONFIG_FIT 1
42#define CONFIG_OF_LIBFDT 1
43#define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
44
Wolfgang Denkdef08192008-10-21 11:23:56 +020045#else
46
47#include <lmb.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020048#include <asm/u-boot.h>
Mike Frysinger5daa1c12010-01-21 04:03:20 -050049#include <command.h>
Wolfgang Denkdef08192008-10-21 11:23:56 +020050
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010051#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010052
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010053#if defined(CONFIG_FIT)
54#include <fdt.h>
55#include <libfdt.h>
56#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010057#define CONFIG_MD5 /* FIT images need MD5 support */
Mike Frysingerdac4d7e2010-01-17 21:08:00 -050058#define CONFIG_SHA1 /* and SHA1 */
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010059#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010060
wdenk5b1d7132002-11-03 00:07:02 +000061/*
62 * Operating System Codes
63 */
64#define IH_OS_INVALID 0 /* Invalid OS */
65#define IH_OS_OPENBSD 1 /* OpenBSD */
66#define IH_OS_NETBSD 2 /* NetBSD */
67#define IH_OS_FREEBSD 3 /* FreeBSD */
68#define IH_OS_4_4BSD 4 /* 4.4BSD */
69#define IH_OS_LINUX 5 /* Linux */
70#define IH_OS_SVR4 6 /* SVR4 */
71#define IH_OS_ESIX 7 /* Esix */
72#define IH_OS_SOLARIS 8 /* Solaris */
73#define IH_OS_IRIX 9 /* Irix */
74#define IH_OS_SCO 10 /* SCO */
75#define IH_OS_DELL 11 /* Dell */
76#define IH_OS_NCR 12 /* NCR */
77#define IH_OS_LYNXOS 13 /* LynxOS */
78#define IH_OS_VXWORKS 14 /* VxWorks */
79#define IH_OS_PSOS 15 /* pSOS */
80#define IH_OS_QNX 16 /* QNX */
81#define IH_OS_U_BOOT 17 /* Firmware */
wdenkd791b1d2003-04-20 14:04:18 +000082#define IH_OS_RTEMS 18 /* RTEMS */
wdenk7f70e852003-05-20 14:25:27 +000083#define IH_OS_ARTOS 19 /* ARTOS */
wdenk27b207f2003-07-24 23:38:38 +000084#define IH_OS_UNITY 20 /* Unity OS */
Peter Tyserf5ed9e32008-09-08 14:56:49 -050085#define IH_OS_INTEGRITY 21 /* INTEGRITY */
Torkel Lundgren3df61952010-09-28 11:05:36 +020086#define IH_OS_OSE 22 /* OSE */
wdenk5b1d7132002-11-03 00:07:02 +000087
88/*
89 * CPU Architecture Codes (supported by Linux)
90 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010091#define IH_ARCH_INVALID 0 /* Invalid CPU */
92#define IH_ARCH_ALPHA 1 /* Alpha */
93#define IH_ARCH_ARM 2 /* ARM */
94#define IH_ARCH_I386 3 /* Intel x86 */
95#define IH_ARCH_IA64 4 /* IA64 */
96#define IH_ARCH_MIPS 5 /* MIPS */
97#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
98#define IH_ARCH_PPC 7 /* PowerPC */
99#define IH_ARCH_S390 8 /* IBM S390 */
100#define IH_ARCH_SH 9 /* SuperH */
101#define IH_ARCH_SPARC 10 /* Sparc */
102#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
103#define IH_ARCH_M68K 12 /* M68K */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100104#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
105#define IH_ARCH_NIOS2 15 /* Nios-II */
106#define IH_ARCH_BLACKFIN 16 /* Blackfin */
107#define IH_ARCH_AVR32 17 /* AVR32 */
108#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
wdenk5b1d7132002-11-03 00:07:02 +0000109
110/*
111 * Image Types
112 *
113 * "Standalone Programs" are directly runnable in the environment
114 * provided by U-Boot; it is expected that (if they behave
115 * well) you can continue to work in U-Boot after return from
116 * the Standalone Program.
117 * "OS Kernel Images" are usually images of some Embedded OS which
118 * will take over control completely. Usually these programs
119 * will install their own set of exception handlers, device
120 * drivers, set up the MMU, etc. - this means, that you cannot
121 * expect to re-enter U-Boot except by resetting the CPU.
122 * "RAMDisk Images" are more or less just data blocks, and their
123 * parameters (address, size) are passed to an OS kernel that is
124 * being started.
125 * "Multi-File Images" contain several images, typically an OS
126 * (Linux) kernel image and one or more data images like
127 * RAMDisks. This construct is useful for instance when you want
128 * to boot over the network using BOOTP etc., where the boot
129 * server provides just a single image file, but you want to get
130 * for instance an OS kernel and a RAMDisk image.
131 *
132 * "Multi-File Images" start with a list of image sizes, each
133 * image size (in bytes) specified by an "uint32_t" in network
134 * byte order. This list is terminated by an "(uint32_t)0".
135 * Immediately after the terminating 0 follow the images, one by
136 * one, all aligned on "uint32_t" boundaries (size rounded up to
wdenke1599e82004-10-10 23:27:33 +0000137 * a multiple of 4 bytes - except for the last file).
wdenk5b1d7132002-11-03 00:07:02 +0000138 *
139 * "Firmware Images" are binary images containing firmware (like
140 * U-Boot or FPGA images) which usually will be programmed to
141 * flash memory.
142 *
143 * "Script files" are command sequences that will be executed by
144 * U-Boot's command interpreter; this feature is especially
145 * useful when you configure U-Boot to use a real shell (hush)
wdenk27b207f2003-07-24 23:38:38 +0000146 * as command interpreter (=> Shell Scripts).
wdenk5b1d7132002-11-03 00:07:02 +0000147 */
148
149#define IH_TYPE_INVALID 0 /* Invalid Image */
150#define IH_TYPE_STANDALONE 1 /* Standalone Program */
151#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
152#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
153#define IH_TYPE_MULTI 4 /* Multi-File Image */
154#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
155#define IH_TYPE_SCRIPT 6 /* Script file */
wdenkfbe4b5c2003-10-06 21:55:32 +0000156#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
Matthew McClintock25c751e2006-08-16 10:54:09 -0500157#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530158#define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
Stefano Babic8edcde52010-01-20 18:19:10 +0100159#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000160#define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
John Rigby3decb142011-07-21 09:10:30 -0400161#define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
wdenk5b1d7132002-11-03 00:07:02 +0000162
163/*
164 * Compression Types
165 */
166#define IH_COMP_NONE 0 /* No Compression Used */
167#define IH_COMP_GZIP 1 /* gzip Compression Used */
168#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200169#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100170#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000171
172#define IH_MAGIC 0x27051956 /* Image Magic Number */
173#define IH_NMLEN 32 /* Image Name Length */
174
wdenk5b1d7132002-11-03 00:07:02 +0000175/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100176 * Legacy format image header,
177 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000178 */
wdenk5b1d7132002-11-03 00:07:02 +0000179typedef struct image_header {
180 uint32_t ih_magic; /* Image Header Magic Number */
181 uint32_t ih_hcrc; /* Image Header CRC Checksum */
182 uint32_t ih_time; /* Image Creation Timestamp */
183 uint32_t ih_size; /* Image Data Size */
184 uint32_t ih_load; /* Data Load Address */
185 uint32_t ih_ep; /* Entry Point Address */
186 uint32_t ih_dcrc; /* Image Data CRC Checksum */
187 uint8_t ih_os; /* Operating System */
188 uint8_t ih_arch; /* CPU architecture */
189 uint8_t ih_type; /* Image Type */
190 uint8_t ih_comp; /* Compression Type */
191 uint8_t ih_name[IH_NMLEN]; /* Image Name */
192} image_header_t;
193
Kumar Gala396f6352008-08-15 08:24:41 -0500194typedef struct image_info {
195 ulong start, end; /* start/end of blob */
196 ulong image_start, image_len; /* start of image within blob, len of image */
197 ulong load; /* load addr for the image */
198 uint8_t comp, type, os; /* compression, type of image, os type */
199} image_info_t;
200
Marian Balakowicz559316f2008-01-08 18:11:44 +0100201/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100202 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
203 * routines.
204 */
205typedef struct bootm_headers {
206 /*
207 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100208 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100209 * data from second and third component accordingly.
210 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200211 image_header_t *legacy_hdr_os; /* image header pointer */
212 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100213 ulong legacy_hdr_valid;
214
215#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100216 const char *fit_uname_cfg; /* configuration node unit name */
217
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100218 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100219 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100220 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100221
222 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100223 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
224 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100225
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100226 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100227 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
228 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100229#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100230
Kumar Gala49c3a862008-10-21 17:25:45 -0500231#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500232 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500233 ulong ep; /* entry point of OS */
234
Kumar Galac4f94192008-08-15 08:24:37 -0500235 ulong rd_start, rd_end;/* ramdisk start/end */
236
Kumar Gala06a09912008-08-15 08:24:38 -0500237#ifdef CONFIG_OF_LIBFDT
238 char *ft_addr; /* flat dev tree address */
239#endif
240 ulong ft_len; /* length of flat device tree */
241
Kumar Gala49c3a862008-10-21 17:25:45 -0500242 ulong initrd_start;
243 ulong initrd_end;
244 ulong cmdline_start;
245 ulong cmdline_end;
246 bd_t *kbd;
247#endif
248
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100249 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500250
251#define BOOTM_STATE_START (0x00000001)
252#define BOOTM_STATE_LOADOS (0x00000002)
253#define BOOTM_STATE_RAMDISK (0x00000004)
254#define BOOTM_STATE_FDT (0x00000008)
255#define BOOTM_STATE_OS_CMDLINE (0x00000010)
256#define BOOTM_STATE_OS_BD_T (0x00000020)
257#define BOOTM_STATE_OS_PREP (0x00000040)
258#define BOOTM_STATE_OS_GO (0x00000080)
259 int state;
260
Mike Frysingera16028d2009-11-03 11:35:59 -0500261#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500262 struct lmb lmb; /* for memory mgmt */
263#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100264} bootm_headers_t;
265
266/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100267 * Some systems (for example LWMON) have very short watchdog periods;
268 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200269 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100270 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200271#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100272#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200273#endif
274
275#ifndef CHUNKSZ_CRC32
276#define CHUNKSZ_CRC32 (64 * 1024)
277#endif
278
279#ifndef CHUNKSZ_MD5
280#define CHUNKSZ_MD5 (64 * 1024)
281#endif
282
283#ifndef CHUNKSZ_SHA1
284#define CHUNKSZ_SHA1 (64 * 1024)
285#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100286
Mike Frysinger37566092009-07-02 19:23:25 -0400287#define uimage_to_cpu(x) be32_to_cpu(x)
288#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000289
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530290/*
291 * Translation table for entries of a specific type; used by
292 * get_table_entry_id() and get_table_entry_name().
293 */
294typedef struct table_entry {
295 int id;
296 char *sname; /* short (input) name to find table entry */
297 char *lname; /* long (output) name to print for messages */
298} table_entry_t;
299
300/*
301 * get_table_entry_id() scans the translation table trying to find an
302 * entry that matches the given short name. If a matching entry is
303 * found, it's id is returned to the caller.
304 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400305int get_table_entry_id(const table_entry_t *table,
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530306 const char *table_name, const char *name);
307/*
308 * get_table_entry_name() scans the translation table trying to find
309 * an entry that matches the given id. If a matching entry is found,
310 * its long name is returned to the caller.
311 */
Mike Frysinger7edb1862010-10-20 07:17:39 -0400312char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530313
Marian Balakowicz570abb02008-02-29 15:59:59 +0100314const char *genimg_get_os_name (uint8_t os);
315const char *genimg_get_arch_name (uint8_t arch);
316const char *genimg_get_type_name (uint8_t type);
317const char *genimg_get_comp_name (uint8_t comp);
318int genimg_get_os_id (const char *name);
319int genimg_get_arch_id (const char *name);
320int genimg_get_type_id (const char *name);
321int genimg_get_comp_id (const char *name);
Prafulla Wadaskarf666dea2009-09-07 14:59:07 +0530322void genimg_print_size (uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100323
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100324#ifndef USE_HOSTCC
325/* Image format types, returned by _get_format() routine */
326#define IMAGE_FORMAT_INVALID 0x00
327#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
328#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
329
330int genimg_get_format (void *img_addr);
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100331int genimg_has_config (bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100332ulong genimg_get_image (ulong img_addr);
333
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200334int boot_get_ramdisk (int argc, char * const argv[], bootm_headers_t *images,
Marian Balakowiczd985c842008-03-12 10:14:38 +0100335 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100336
Kumar Gala06a09912008-08-15 08:24:38 -0500337
338#ifdef CONFIG_OF_LIBFDT
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200339int boot_get_fdt (int flag, int argc, char * const argv[], bootm_headers_t *images,
Kumar Gala06a09912008-08-15 08:24:38 -0500340 char **of_flat_tree, ulong *of_size);
Grant Likely55b0a392011-03-28 09:59:01 +0000341void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
Grant Likely590d3ca2011-03-28 09:58:34 +0000342int boot_relocate_fdt (struct lmb *lmb, char **of_flat_tree, ulong *of_size);
Kumar Gala06a09912008-08-15 08:24:38 -0500343#endif
344
John Rigbyfca43cc2010-10-13 13:57:35 -0600345#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100346int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
347 ulong *initrd_start, ulong *initrd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600348#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
349#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
Grant Likely590d3ca2011-03-28 09:58:34 +0000350int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
John Rigbyfca43cc2010-10-13 13:57:35 -0600351#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
352#ifdef CONFIG_SYS_BOOT_GET_KBD
Grant Likely590d3ca2011-03-28 09:58:34 +0000353int boot_get_kbd (struct lmb *lmb, bd_t **kbd);
John Rigbyfca43cc2010-10-13 13:57:35 -0600354#endif /* CONFIG_SYS_BOOT_GET_KBD */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100355#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100356
357/*******************************************************************/
358/* Legacy format specific code (prefixed with image_) */
359/*******************************************************************/
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100360static inline uint32_t image_get_header_size (void)
361{
362 return (sizeof (image_header_t));
363}
364
365#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200366 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100367 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100368 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100369 }
Wolfgang Denk178e26d2010-06-26 23:46:40 +0200370image_get_hdr_l (magic) /* image_get_magic */
371image_get_hdr_l (hcrc) /* image_get_hcrc */
372image_get_hdr_l (time) /* image_get_time */
373image_get_hdr_l (size) /* image_get_size */
374image_get_hdr_l (load) /* image_get_load */
375image_get_hdr_l (ep) /* image_get_ep */
376image_get_hdr_l (dcrc) /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100377
378#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200379 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100380 { \
381 return hdr->ih_##f; \
382 }
Wolfgang Denk178e26d2010-06-26 23:46:40 +0200383image_get_hdr_b (os) /* image_get_os */
384image_get_hdr_b (arch) /* image_get_arch */
385image_get_hdr_b (type) /* image_get_type */
386image_get_hdr_b (comp) /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100387
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200388static inline char *image_get_name (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100389{
390 return (char *)hdr->ih_name;
391}
392
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200393static inline uint32_t image_get_data_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100394{
395 return image_get_size (hdr);
396}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100397
398/**
399 * image_get_data - get image payload start address
400 * @hdr: image header
401 *
402 * image_get_data() returns address of the image payload. For single
403 * component images it is image data start. For multi component
404 * images it points to the null terminated table of sub-images sizes.
405 *
406 * returns:
407 * image payload data start address
408 */
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200409static inline ulong image_get_data (const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100410{
411 return ((ulong)hdr + image_get_header_size ());
412}
413
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200414static inline uint32_t image_get_image_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100415{
416 return (image_get_size (hdr) + image_get_header_size ());
417}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200418static inline ulong image_get_image_end (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100419{
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100420 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100421}
422
423#define image_set_hdr_l(f) \
424 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
425 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100426 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100427 }
Wolfgang Denk178e26d2010-06-26 23:46:40 +0200428image_set_hdr_l (magic) /* image_set_magic */
429image_set_hdr_l (hcrc) /* image_set_hcrc */
430image_set_hdr_l (time) /* image_set_time */
431image_set_hdr_l (size) /* image_set_size */
432image_set_hdr_l (load) /* image_set_load */
433image_set_hdr_l (ep) /* image_set_ep */
434image_set_hdr_l (dcrc) /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100435
436#define image_set_hdr_b(f) \
437 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
438 { \
439 hdr->ih_##f = val; \
440 }
Wolfgang Denk178e26d2010-06-26 23:46:40 +0200441image_set_hdr_b (os) /* image_set_os */
442image_set_hdr_b (arch) /* image_set_arch */
443image_set_hdr_b (type) /* image_set_type */
444image_set_hdr_b (comp) /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100445
446static inline void image_set_name (image_header_t *hdr, const char *name)
447{
448 strncpy (image_get_name (hdr), name, IH_NMLEN);
449}
450
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200451int image_check_hcrc (const image_header_t *hdr);
452int image_check_dcrc (const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100453#ifndef USE_HOSTCC
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200454int getenv_yesno (char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600455ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500456phys_size_t getenv_bootm_size(void);
Grant Likelyc3624e62011-03-28 09:58:43 +0000457phys_size_t getenv_bootm_mapsize(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100458void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
459#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100460
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200461static inline int image_check_magic (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100462{
463 return (image_get_magic (hdr) == IH_MAGIC);
464}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200465static inline int image_check_type (const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100466{
467 return (image_get_type (hdr) == type);
468}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200469static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100470{
471 return (image_get_arch (hdr) == arch);
472}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200473static inline int image_check_os (const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100474{
475 return (image_get_os (hdr) == os);
476}
477
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200478ulong image_multi_count (const image_header_t *hdr);
479void image_multi_getimg (const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100480 ulong *data, ulong *len);
481
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200482void image_print_contents (const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100483
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100484#ifndef USE_HOSTCC
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200485static inline int image_check_target_arch (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100486{
Mike Frysinger476af292011-10-03 14:50:33 +0000487#ifndef IH_ARCH_DEFAULT
488# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100489#endif
Mike Frysinger476af292011-10-03 14:50:33 +0000490 return image_check_arch(hdr, IH_ARCH_DEFAULT);
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100491}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100492#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100493
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100494/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100495/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100496/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100497#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100498
499#define FIT_IMAGES_PATH "/images"
500#define FIT_CONFS_PATH "/configurations"
501
502/* hash node */
503#define FIT_HASH_NODENAME "hash"
504#define FIT_ALGO_PROP "algo"
505#define FIT_VALUE_PROP "value"
506
507/* image node */
508#define FIT_DATA_PROP "data"
509#define FIT_TIMESTAMP_PROP "timestamp"
510#define FIT_DESC_PROP "description"
511#define FIT_ARCH_PROP "arch"
512#define FIT_TYPE_PROP "type"
513#define FIT_OS_PROP "os"
514#define FIT_COMP_PROP "compression"
515#define FIT_ENTRY_PROP "entry"
516#define FIT_LOAD_PROP "load"
517
518/* configuration node */
519#define FIT_KERNEL_PROP "kernel"
520#define FIT_RAMDISK_PROP "ramdisk"
521#define FIT_FDT_PROP "fdt"
522#define FIT_DEFAULT_PROP "default"
523
524#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
525
526/* cmdline argument format parsing */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100527inline int fit_parse_conf (const char *spec, ulong addr_curr,
528 ulong *addr, const char **conf_name);
529inline int fit_parse_subimage (const char *spec, ulong addr_curr,
530 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100531
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200532void fit_print_contents (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100533void fit_image_print (const void *fit, int noffset, const char *p);
534void fit_image_print_hash (const void *fit, int noffset, const char *p);
535
536/**
537 * fit_get_end - get FIT image size
538 * @fit: pointer to the FIT format image header
539 *
540 * returns:
541 * size of the FIT image (blob) in memory
542 */
543static inline ulong fit_get_size (const void *fit)
544{
545 return fdt_totalsize (fit);
546}
547
548/**
549 * fit_get_end - get FIT image end
550 * @fit: pointer to the FIT format image header
551 *
552 * returns:
553 * end address of the FIT image (blob) in memory
554 */
555static inline ulong fit_get_end (const void *fit)
556{
557 return (ulong)fit + fdt_totalsize (fit);
558}
559
560/**
561 * fit_get_name - get FIT node name
562 * @fit: pointer to the FIT format image header
563 *
564 * returns:
565 * NULL, on error
566 * pointer to node name, on success
567 */
568static inline const char *fit_get_name (const void *fit_hdr,
569 int noffset, int *len)
570{
571 return fdt_get_name (fit_hdr, noffset, len);
572}
573
574int fit_get_desc (const void *fit, int noffset, char **desc);
575int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
576
577int fit_image_get_node (const void *fit, const char *image_uname);
578int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
579int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
580int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
581int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
582int fit_image_get_load (const void *fit, int noffset, ulong *load);
583int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
584int fit_image_get_data (const void *fit, int noffset,
585 const void **data, size_t *size);
586
587int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
588int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
589 int *value_len);
590
591int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
592int fit_set_hashes (void *fit);
593int fit_image_set_hashes (void *fit, int image_noffset);
594int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
595 int value_len);
596
597int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka919f5502008-09-09 12:58:15 +0200598int fit_all_image_check_hashes (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100599int fit_image_check_os (const void *fit, int noffset, uint8_t os);
600int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
601int fit_image_check_type (const void *fit, int noffset, uint8_t type);
602int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
603int fit_check_format (const void *fit);
604
605int fit_conf_get_node (const void *fit, const char *conf_uname);
606int fit_conf_get_kernel_node (const void *fit, int noffset);
607int fit_conf_get_ramdisk_node (const void *fit, int noffset);
608int fit_conf_get_fdt_node (const void *fit, int noffset);
609
610void fit_conf_print (const void *fit, int noffset, const char *p);
611
612#ifndef USE_HOSTCC
613static inline int fit_image_check_target_arch (const void *fdt, int node)
614{
Mike Frysinger476af292011-10-03 14:50:33 +0000615 return !fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100616}
617#endif /* USE_HOSTCC */
618
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100619#ifdef CONFIG_FIT_VERBOSE
620#define fit_unsupported(msg) printf ("! %s:%d " \
621 "FIT images not supported for '%s'\n", \
622 __FILE__, __LINE__, (msg))
623
624#define fit_unsupported_reset(msg) printf ("! %s:%d " \
625 "FIT images not supported for '%s' " \
626 "- must reset board to recover!\n", \
627 __FILE__, __LINE__, (msg))
628#else
629#define fit_unsupported(msg)
630#define fit_unsupported_reset(msg)
631#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100632#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100633
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100634#endif /* __IMAGE_H__ */