blob: d2e78fe298376aa17b442d7891ac990ab3c35cb4 [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>
Wolfgang Denkdef08192008-10-21 11:23:56 +020049
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010050#endif /* USE_HOSTCC */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010051
Wolfgang Denkdef08192008-10-21 11:23:56 +020052#include <command.h>
53
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010054#if defined(CONFIG_FIT)
55#include <fdt.h>
56#include <libfdt.h>
57#include <fdt_support.h>
Bartlomiej Sieka766529f2008-03-14 16:22:34 +010058#define CONFIG_MD5 /* FIT images need MD5 support */
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 */
wdenk5b1d7132002-11-03 00:07:02 +000086
87/*
88 * CPU Architecture Codes (supported by Linux)
89 */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010090#define IH_ARCH_INVALID 0 /* Invalid CPU */
91#define IH_ARCH_ALPHA 1 /* Alpha */
92#define IH_ARCH_ARM 2 /* ARM */
93#define IH_ARCH_I386 3 /* Intel x86 */
94#define IH_ARCH_IA64 4 /* IA64 */
95#define IH_ARCH_MIPS 5 /* MIPS */
96#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
97#define IH_ARCH_PPC 7 /* PowerPC */
98#define IH_ARCH_S390 8 /* IBM S390 */
99#define IH_ARCH_SH 9 /* SuperH */
100#define IH_ARCH_SPARC 10 /* Sparc */
101#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
102#define IH_ARCH_M68K 12 /* M68K */
103#define IH_ARCH_NIOS 13 /* Nios-32 */
104#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 */
wdenk5b1d7132002-11-03 00:07:02 +0000159
160/*
161 * Compression Types
162 */
163#define IH_COMP_NONE 0 /* No Compression Used */
164#define IH_COMP_GZIP 1 /* gzip Compression Used */
165#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200166#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100167#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000168
169#define IH_MAGIC 0x27051956 /* Image Magic Number */
170#define IH_NMLEN 32 /* Image Name Length */
171
wdenk5b1d7132002-11-03 00:07:02 +0000172/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100173 * Legacy format image header,
174 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000175 */
wdenk5b1d7132002-11-03 00:07:02 +0000176typedef struct image_header {
177 uint32_t ih_magic; /* Image Header Magic Number */
178 uint32_t ih_hcrc; /* Image Header CRC Checksum */
179 uint32_t ih_time; /* Image Creation Timestamp */
180 uint32_t ih_size; /* Image Data Size */
181 uint32_t ih_load; /* Data Load Address */
182 uint32_t ih_ep; /* Entry Point Address */
183 uint32_t ih_dcrc; /* Image Data CRC Checksum */
184 uint8_t ih_os; /* Operating System */
185 uint8_t ih_arch; /* CPU architecture */
186 uint8_t ih_type; /* Image Type */
187 uint8_t ih_comp; /* Compression Type */
188 uint8_t ih_name[IH_NMLEN]; /* Image Name */
189} image_header_t;
190
Kumar Gala396f6352008-08-15 08:24:41 -0500191typedef struct image_info {
192 ulong start, end; /* start/end of blob */
193 ulong image_start, image_len; /* start of image within blob, len of image */
194 ulong load; /* load addr for the image */
195 uint8_t comp, type, os; /* compression, type of image, os type */
196} image_info_t;
197
Marian Balakowicz559316f2008-01-08 18:11:44 +0100198/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100199 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
200 * routines.
201 */
202typedef struct bootm_headers {
203 /*
204 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100205 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100206 * data from second and third component accordingly.
207 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200208 image_header_t *legacy_hdr_os; /* image header pointer */
209 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100210 ulong legacy_hdr_valid;
211
212#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100213 const char *fit_uname_cfg; /* configuration node unit name */
214
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100215 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100216 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100217 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100218
219 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100220 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
221 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100222
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100223 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100224 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
225 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100226#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100227
Kumar Gala49c3a862008-10-21 17:25:45 -0500228#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500229 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500230 ulong ep; /* entry point of OS */
231
Kumar Galac4f94192008-08-15 08:24:37 -0500232 ulong rd_start, rd_end;/* ramdisk start/end */
233
Kumar Gala06a09912008-08-15 08:24:38 -0500234#ifdef CONFIG_OF_LIBFDT
235 char *ft_addr; /* flat dev tree address */
236#endif
237 ulong ft_len; /* length of flat device tree */
238
Kumar Gala49c3a862008-10-21 17:25:45 -0500239 ulong initrd_start;
240 ulong initrd_end;
241 ulong cmdline_start;
242 ulong cmdline_end;
243 bd_t *kbd;
244#endif
245
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100246 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500247
248#define BOOTM_STATE_START (0x00000001)
249#define BOOTM_STATE_LOADOS (0x00000002)
250#define BOOTM_STATE_RAMDISK (0x00000004)
251#define BOOTM_STATE_FDT (0x00000008)
252#define BOOTM_STATE_OS_CMDLINE (0x00000010)
253#define BOOTM_STATE_OS_BD_T (0x00000020)
254#define BOOTM_STATE_OS_PREP (0x00000040)
255#define BOOTM_STATE_OS_GO (0x00000080)
256 int state;
257
Kumar Galae906cfa2008-08-15 08:24:40 -0500258#ifndef USE_HOSTCC
259 struct lmb lmb; /* for memory mgmt */
260#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100261} bootm_headers_t;
262
263/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100264 * Some systems (for example LWMON) have very short watchdog periods;
265 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200266 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100267 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200268#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100269#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200270#endif
271
272#ifndef CHUNKSZ_CRC32
273#define CHUNKSZ_CRC32 (64 * 1024)
274#endif
275
276#ifndef CHUNKSZ_MD5
277#define CHUNKSZ_MD5 (64 * 1024)
278#endif
279
280#ifndef CHUNKSZ_SHA1
281#define CHUNKSZ_SHA1 (64 * 1024)
282#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100283
Mike Frysinger37566092009-07-02 19:23:25 -0400284#define uimage_to_cpu(x) be32_to_cpu(x)
285#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000286
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530287/*
288 * Translation table for entries of a specific type; used by
289 * get_table_entry_id() and get_table_entry_name().
290 */
291typedef struct table_entry {
292 int id;
293 char *sname; /* short (input) name to find table entry */
294 char *lname; /* long (output) name to print for messages */
295} table_entry_t;
296
297/*
298 * get_table_entry_id() scans the translation table trying to find an
299 * entry that matches the given short name. If a matching entry is
300 * found, it's id is returned to the caller.
301 */
302int get_table_entry_id (table_entry_t *table,
303 const char *table_name, const char *name);
304/*
305 * get_table_entry_name() scans the translation table trying to find
306 * an entry that matches the given id. If a matching entry is found,
307 * its long name is returned to the caller.
308 */
309char *get_table_entry_name (table_entry_t *table, char *msg, int id);
310
Marian Balakowicz570abb02008-02-29 15:59:59 +0100311const char *genimg_get_os_name (uint8_t os);
312const char *genimg_get_arch_name (uint8_t arch);
313const char *genimg_get_type_name (uint8_t type);
314const char *genimg_get_comp_name (uint8_t comp);
315int genimg_get_os_id (const char *name);
316int genimg_get_arch_id (const char *name);
317int genimg_get_type_id (const char *name);
318int genimg_get_comp_id (const char *name);
Prafulla Wadaskarf666dea2009-09-07 14:59:07 +0530319void genimg_print_size (uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100320
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100321#ifndef USE_HOSTCC
322/* Image format types, returned by _get_format() routine */
323#define IMAGE_FORMAT_INVALID 0x00
324#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
325#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
326
327int genimg_get_format (void *img_addr);
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100328int genimg_has_config (bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100329ulong genimg_get_image (ulong img_addr);
330
Marian Balakowiczd985c842008-03-12 10:14:38 +0100331int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
332 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100333
Kumar Gala06a09912008-08-15 08:24:38 -0500334
335#ifdef CONFIG_OF_LIBFDT
336int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
337 char **of_flat_tree, ulong *of_size);
338int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
339 char **of_flat_tree, ulong *of_size);
340#endif
341
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100342#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
343int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
344 ulong *initrd_start, ulong *initrd_end);
345
346int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
347 ulong bootmap_base);
348int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
349#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100350#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100351
352/*******************************************************************/
353/* Legacy format specific code (prefixed with image_) */
354/*******************************************************************/
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100355static inline uint32_t image_get_header_size (void)
356{
357 return (sizeof (image_header_t));
358}
359
360#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200361 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100362 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100363 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100364 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200365image_get_hdr_l (magic); /* image_get_magic */
366image_get_hdr_l (hcrc); /* image_get_hcrc */
367image_get_hdr_l (time); /* image_get_time */
368image_get_hdr_l (size); /* image_get_size */
369image_get_hdr_l (load); /* image_get_load */
370image_get_hdr_l (ep); /* image_get_ep */
371image_get_hdr_l (dcrc); /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100372
373#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200374 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100375 { \
376 return hdr->ih_##f; \
377 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200378image_get_hdr_b (os); /* image_get_os */
379image_get_hdr_b (arch); /* image_get_arch */
380image_get_hdr_b (type); /* image_get_type */
381image_get_hdr_b (comp); /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100382
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200383static inline char *image_get_name (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100384{
385 return (char *)hdr->ih_name;
386}
387
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200388static inline uint32_t image_get_data_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100389{
390 return image_get_size (hdr);
391}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100392
393/**
394 * image_get_data - get image payload start address
395 * @hdr: image header
396 *
397 * image_get_data() returns address of the image payload. For single
398 * component images it is image data start. For multi component
399 * images it points to the null terminated table of sub-images sizes.
400 *
401 * returns:
402 * image payload data start address
403 */
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200404static inline ulong image_get_data (const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100405{
406 return ((ulong)hdr + image_get_header_size ());
407}
408
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200409static inline uint32_t image_get_image_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100410{
411 return (image_get_size (hdr) + image_get_header_size ());
412}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200413static inline ulong image_get_image_end (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100414{
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100415 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100416}
417
418#define image_set_hdr_l(f) \
419 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
420 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100421 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100422 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200423image_set_hdr_l (magic); /* image_set_magic */
424image_set_hdr_l (hcrc); /* image_set_hcrc */
425image_set_hdr_l (time); /* image_set_time */
426image_set_hdr_l (size); /* image_set_size */
427image_set_hdr_l (load); /* image_set_load */
428image_set_hdr_l (ep); /* image_set_ep */
429image_set_hdr_l (dcrc); /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100430
431#define image_set_hdr_b(f) \
432 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
433 { \
434 hdr->ih_##f = val; \
435 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200436image_set_hdr_b (os); /* image_set_os */
437image_set_hdr_b (arch); /* image_set_arch */
438image_set_hdr_b (type); /* image_set_type */
439image_set_hdr_b (comp); /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100440
441static inline void image_set_name (image_header_t *hdr, const char *name)
442{
443 strncpy (image_get_name (hdr), name, IH_NMLEN);
444}
445
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200446int image_check_hcrc (const image_header_t *hdr);
447int image_check_dcrc (const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100448#ifndef USE_HOSTCC
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200449int getenv_yesno (char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600450ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500451phys_size_t getenv_bootm_size(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100452void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
453#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100454
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200455static inline int image_check_magic (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100456{
457 return (image_get_magic (hdr) == IH_MAGIC);
458}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200459static inline int image_check_type (const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100460{
461 return (image_get_type (hdr) == type);
462}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200463static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100464{
465 return (image_get_arch (hdr) == arch);
466}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200467static inline int image_check_os (const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100468{
469 return (image_get_os (hdr) == os);
470}
471
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200472ulong image_multi_count (const image_header_t *hdr);
473void image_multi_getimg (const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100474 ulong *data, ulong *len);
475
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200476void image_print_contents (const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100477
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100478#ifndef USE_HOSTCC
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200479static inline int image_check_target_arch (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100480{
481#if defined(__ARM__)
482 if (!image_check_arch (hdr, IH_ARCH_ARM))
483#elif defined(__avr32__)
484 if (!image_check_arch (hdr, IH_ARCH_AVR32))
485#elif defined(__bfin__)
486 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
487#elif defined(__I386__)
488 if (!image_check_arch (hdr, IH_ARCH_I386))
489#elif defined(__M68K__)
490 if (!image_check_arch (hdr, IH_ARCH_M68K))
491#elif defined(__microblaze__)
492 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
493#elif defined(__mips__)
494 if (!image_check_arch (hdr, IH_ARCH_MIPS))
495#elif defined(__nios__)
496 if (!image_check_arch (hdr, IH_ARCH_NIOS))
497#elif defined(__nios2__)
498 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
499#elif defined(__PPC__)
500 if (!image_check_arch (hdr, IH_ARCH_PPC))
501#elif defined(__sh__)
502 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100503#elif defined(__sparc__)
504 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100505#else
506# error Unknown CPU type
507#endif
508 return 0;
509
510 return 1;
511}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100512#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100513
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100514/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100515/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100516/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100517#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100518
519#define FIT_IMAGES_PATH "/images"
520#define FIT_CONFS_PATH "/configurations"
521
522/* hash node */
523#define FIT_HASH_NODENAME "hash"
524#define FIT_ALGO_PROP "algo"
525#define FIT_VALUE_PROP "value"
526
527/* image node */
528#define FIT_DATA_PROP "data"
529#define FIT_TIMESTAMP_PROP "timestamp"
530#define FIT_DESC_PROP "description"
531#define FIT_ARCH_PROP "arch"
532#define FIT_TYPE_PROP "type"
533#define FIT_OS_PROP "os"
534#define FIT_COMP_PROP "compression"
535#define FIT_ENTRY_PROP "entry"
536#define FIT_LOAD_PROP "load"
537
538/* configuration node */
539#define FIT_KERNEL_PROP "kernel"
540#define FIT_RAMDISK_PROP "ramdisk"
541#define FIT_FDT_PROP "fdt"
542#define FIT_DEFAULT_PROP "default"
543
544#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
545
546/* cmdline argument format parsing */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100547inline int fit_parse_conf (const char *spec, ulong addr_curr,
548 ulong *addr, const char **conf_name);
549inline int fit_parse_subimage (const char *spec, ulong addr_curr,
550 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100551
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200552void fit_print_contents (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100553void fit_image_print (const void *fit, int noffset, const char *p);
554void fit_image_print_hash (const void *fit, int noffset, const char *p);
555
556/**
557 * fit_get_end - get FIT image size
558 * @fit: pointer to the FIT format image header
559 *
560 * returns:
561 * size of the FIT image (blob) in memory
562 */
563static inline ulong fit_get_size (const void *fit)
564{
565 return fdt_totalsize (fit);
566}
567
568/**
569 * fit_get_end - get FIT image end
570 * @fit: pointer to the FIT format image header
571 *
572 * returns:
573 * end address of the FIT image (blob) in memory
574 */
575static inline ulong fit_get_end (const void *fit)
576{
577 return (ulong)fit + fdt_totalsize (fit);
578}
579
580/**
581 * fit_get_name - get FIT node name
582 * @fit: pointer to the FIT format image header
583 *
584 * returns:
585 * NULL, on error
586 * pointer to node name, on success
587 */
588static inline const char *fit_get_name (const void *fit_hdr,
589 int noffset, int *len)
590{
591 return fdt_get_name (fit_hdr, noffset, len);
592}
593
594int fit_get_desc (const void *fit, int noffset, char **desc);
595int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
596
597int fit_image_get_node (const void *fit, const char *image_uname);
598int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
599int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
600int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
601int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
602int fit_image_get_load (const void *fit, int noffset, ulong *load);
603int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
604int fit_image_get_data (const void *fit, int noffset,
605 const void **data, size_t *size);
606
607int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
608int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
609 int *value_len);
610
611int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
612int fit_set_hashes (void *fit);
613int fit_image_set_hashes (void *fit, int image_noffset);
614int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
615 int value_len);
616
617int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka919f5502008-09-09 12:58:15 +0200618int fit_all_image_check_hashes (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100619int fit_image_check_os (const void *fit, int noffset, uint8_t os);
620int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
621int fit_image_check_type (const void *fit, int noffset, uint8_t type);
622int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
623int fit_check_format (const void *fit);
624
625int fit_conf_get_node (const void *fit, const char *conf_uname);
626int fit_conf_get_kernel_node (const void *fit, int noffset);
627int fit_conf_get_ramdisk_node (const void *fit, int noffset);
628int fit_conf_get_fdt_node (const void *fit, int noffset);
629
630void fit_conf_print (const void *fit, int noffset, const char *p);
631
632#ifndef USE_HOSTCC
633static inline int fit_image_check_target_arch (const void *fdt, int node)
634{
635#if defined(__ARM__)
636 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
637#elif defined(__avr32__)
638 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
639#elif defined(__bfin__)
640 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
641#elif defined(__I386__)
642 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
643#elif defined(__M68K__)
644 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
645#elif defined(__microblaze__)
646 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
647#elif defined(__mips__)
648 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
649#elif defined(__nios__)
650 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
651#elif defined(__nios2__)
652 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
653#elif defined(__PPC__)
654 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
655#elif defined(__sh__)
656 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100657#elif defined(__sparc__)
658 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100659#else
660# error Unknown CPU type
661#endif
662 return 0;
663
664 return 1;
665}
666#endif /* USE_HOSTCC */
667
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100668#ifdef CONFIG_FIT_VERBOSE
669#define fit_unsupported(msg) printf ("! %s:%d " \
670 "FIT images not supported for '%s'\n", \
671 __FILE__, __LINE__, (msg))
672
673#define fit_unsupported_reset(msg) printf ("! %s:%d " \
674 "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__ */