blob: cc38eae39a4c280adf17eca9c9907515e3390900 [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
223#if defined(CONFIG_PPC)
224 void *fit_hdr_fdt; /* FDT blob FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100225 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
226 int fit_noffset_fdt;/* FDT blob subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100227#endif
Marian Balakowicz1ec73762008-03-12 10:35:52 +0100228#endif
229
Kumar Gala49c3a862008-10-21 17:25:45 -0500230#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500231 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500232 ulong ep; /* entry point of OS */
233
Kumar Galac4f94192008-08-15 08:24:37 -0500234 ulong rd_start, rd_end;/* ramdisk start/end */
235
Kumar Gala06a09912008-08-15 08:24:38 -0500236#ifdef CONFIG_OF_LIBFDT
237 char *ft_addr; /* flat dev tree address */
238#endif
239 ulong ft_len; /* length of flat device tree */
240
Kumar Gala49c3a862008-10-21 17:25:45 -0500241 ulong initrd_start;
242 ulong initrd_end;
243 ulong cmdline_start;
244 ulong cmdline_end;
245 bd_t *kbd;
246#endif
247
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100248 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500249
250#define BOOTM_STATE_START (0x00000001)
251#define BOOTM_STATE_LOADOS (0x00000002)
252#define BOOTM_STATE_RAMDISK (0x00000004)
253#define BOOTM_STATE_FDT (0x00000008)
254#define BOOTM_STATE_OS_CMDLINE (0x00000010)
255#define BOOTM_STATE_OS_BD_T (0x00000020)
256#define BOOTM_STATE_OS_PREP (0x00000040)
257#define BOOTM_STATE_OS_GO (0x00000080)
258 int state;
259
Kumar Galae906cfa2008-08-15 08:24:40 -0500260#ifndef USE_HOSTCC
261 struct lmb lmb; /* for memory mgmt */
262#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100263} bootm_headers_t;
264
265/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100266 * Some systems (for example LWMON) have very short watchdog periods;
267 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200268 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100269 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200270#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100271#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200272#endif
273
274#ifndef CHUNKSZ_CRC32
275#define CHUNKSZ_CRC32 (64 * 1024)
276#endif
277
278#ifndef CHUNKSZ_MD5
279#define CHUNKSZ_MD5 (64 * 1024)
280#endif
281
282#ifndef CHUNKSZ_SHA1
283#define CHUNKSZ_SHA1 (64 * 1024)
284#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100285
Mike Frysinger37566092009-07-02 19:23:25 -0400286#define uimage_to_cpu(x) be32_to_cpu(x)
287#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000288
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530289/*
290 * Translation table for entries of a specific type; used by
291 * get_table_entry_id() and get_table_entry_name().
292 */
293typedef struct table_entry {
294 int id;
295 char *sname; /* short (input) name to find table entry */
296 char *lname; /* long (output) name to print for messages */
297} table_entry_t;
298
299/*
300 * get_table_entry_id() scans the translation table trying to find an
301 * entry that matches the given short name. If a matching entry is
302 * found, it's id is returned to the caller.
303 */
304int get_table_entry_id (table_entry_t *table,
305 const char *table_name, const char *name);
306/*
307 * get_table_entry_name() scans the translation table trying to find
308 * an entry that matches the given id. If a matching entry is found,
309 * its long name is returned to the caller.
310 */
311char *get_table_entry_name (table_entry_t *table, char *msg, int id);
312
Marian Balakowicz570abb02008-02-29 15:59:59 +0100313const char *genimg_get_os_name (uint8_t os);
314const char *genimg_get_arch_name (uint8_t arch);
315const char *genimg_get_type_name (uint8_t type);
316const char *genimg_get_comp_name (uint8_t comp);
317int genimg_get_os_id (const char *name);
318int genimg_get_arch_id (const char *name);
319int genimg_get_type_id (const char *name);
320int genimg_get_comp_id (const char *name);
Prafulla Wadaskarf666dea2009-09-07 14:59:07 +0530321void genimg_print_size (uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100322
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100323#ifndef USE_HOSTCC
324/* Image format types, returned by _get_format() routine */
325#define IMAGE_FORMAT_INVALID 0x00
326#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
327#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
328
329int genimg_get_format (void *img_addr);
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100330int genimg_has_config (bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100331ulong genimg_get_image (ulong img_addr);
332
Marian Balakowiczd985c842008-03-12 10:14:38 +0100333int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
334 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100335
Kumar Gala06a09912008-08-15 08:24:38 -0500336
337#ifdef CONFIG_OF_LIBFDT
338int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
339 char **of_flat_tree, ulong *of_size);
340int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
341 char **of_flat_tree, ulong *of_size);
342#endif
343
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100344#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
345int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
346 ulong *initrd_start, ulong *initrd_end);
347
348int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
349 ulong bootmap_base);
350int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
351#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100352#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100353
354/*******************************************************************/
355/* Legacy format specific code (prefixed with image_) */
356/*******************************************************************/
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100357static inline uint32_t image_get_header_size (void)
358{
359 return (sizeof (image_header_t));
360}
361
362#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200363 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100364 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100365 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100366 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200367image_get_hdr_l (magic); /* image_get_magic */
368image_get_hdr_l (hcrc); /* image_get_hcrc */
369image_get_hdr_l (time); /* image_get_time */
370image_get_hdr_l (size); /* image_get_size */
371image_get_hdr_l (load); /* image_get_load */
372image_get_hdr_l (ep); /* image_get_ep */
373image_get_hdr_l (dcrc); /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100374
375#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200376 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100377 { \
378 return hdr->ih_##f; \
379 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200380image_get_hdr_b (os); /* image_get_os */
381image_get_hdr_b (arch); /* image_get_arch */
382image_get_hdr_b (type); /* image_get_type */
383image_get_hdr_b (comp); /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100384
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200385static inline char *image_get_name (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100386{
387 return (char *)hdr->ih_name;
388}
389
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200390static inline uint32_t image_get_data_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100391{
392 return image_get_size (hdr);
393}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100394
395/**
396 * image_get_data - get image payload start address
397 * @hdr: image header
398 *
399 * image_get_data() returns address of the image payload. For single
400 * component images it is image data start. For multi component
401 * images it points to the null terminated table of sub-images sizes.
402 *
403 * returns:
404 * image payload data start address
405 */
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200406static inline ulong image_get_data (const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100407{
408 return ((ulong)hdr + image_get_header_size ());
409}
410
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200411static inline uint32_t image_get_image_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100412{
413 return (image_get_size (hdr) + image_get_header_size ());
414}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200415static inline ulong image_get_image_end (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100416{
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100417 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100418}
419
420#define image_set_hdr_l(f) \
421 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
422 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100423 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100424 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200425image_set_hdr_l (magic); /* image_set_magic */
426image_set_hdr_l (hcrc); /* image_set_hcrc */
427image_set_hdr_l (time); /* image_set_time */
428image_set_hdr_l (size); /* image_set_size */
429image_set_hdr_l (load); /* image_set_load */
430image_set_hdr_l (ep); /* image_set_ep */
431image_set_hdr_l (dcrc); /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100432
433#define image_set_hdr_b(f) \
434 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
435 { \
436 hdr->ih_##f = val; \
437 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200438image_set_hdr_b (os); /* image_set_os */
439image_set_hdr_b (arch); /* image_set_arch */
440image_set_hdr_b (type); /* image_set_type */
441image_set_hdr_b (comp); /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100442
443static inline void image_set_name (image_header_t *hdr, const char *name)
444{
445 strncpy (image_get_name (hdr), name, IH_NMLEN);
446}
447
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200448int image_check_hcrc (const image_header_t *hdr);
449int image_check_dcrc (const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100450#ifndef USE_HOSTCC
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200451int getenv_yesno (char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600452ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500453phys_size_t getenv_bootm_size(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100454void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
455#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100456
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200457static inline int image_check_magic (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100458{
459 return (image_get_magic (hdr) == IH_MAGIC);
460}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200461static inline int image_check_type (const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100462{
463 return (image_get_type (hdr) == type);
464}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200465static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100466{
467 return (image_get_arch (hdr) == arch);
468}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200469static inline int image_check_os (const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100470{
471 return (image_get_os (hdr) == os);
472}
473
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200474ulong image_multi_count (const image_header_t *hdr);
475void image_multi_getimg (const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100476 ulong *data, ulong *len);
477
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200478void image_print_contents (const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100479
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100480#ifndef USE_HOSTCC
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200481static inline int image_check_target_arch (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100482{
483#if defined(__ARM__)
484 if (!image_check_arch (hdr, IH_ARCH_ARM))
485#elif defined(__avr32__)
486 if (!image_check_arch (hdr, IH_ARCH_AVR32))
487#elif defined(__bfin__)
488 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
489#elif defined(__I386__)
490 if (!image_check_arch (hdr, IH_ARCH_I386))
491#elif defined(__M68K__)
492 if (!image_check_arch (hdr, IH_ARCH_M68K))
493#elif defined(__microblaze__)
494 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
495#elif defined(__mips__)
496 if (!image_check_arch (hdr, IH_ARCH_MIPS))
497#elif defined(__nios__)
498 if (!image_check_arch (hdr, IH_ARCH_NIOS))
499#elif defined(__nios2__)
500 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
501#elif defined(__PPC__)
502 if (!image_check_arch (hdr, IH_ARCH_PPC))
503#elif defined(__sh__)
504 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100505#elif defined(__sparc__)
506 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100507#else
508# error Unknown CPU type
509#endif
510 return 0;
511
512 return 1;
513}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100514#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100515
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100516/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100517/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100518/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100519#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100520
521#define FIT_IMAGES_PATH "/images"
522#define FIT_CONFS_PATH "/configurations"
523
524/* hash node */
525#define FIT_HASH_NODENAME "hash"
526#define FIT_ALGO_PROP "algo"
527#define FIT_VALUE_PROP "value"
528
529/* image node */
530#define FIT_DATA_PROP "data"
531#define FIT_TIMESTAMP_PROP "timestamp"
532#define FIT_DESC_PROP "description"
533#define FIT_ARCH_PROP "arch"
534#define FIT_TYPE_PROP "type"
535#define FIT_OS_PROP "os"
536#define FIT_COMP_PROP "compression"
537#define FIT_ENTRY_PROP "entry"
538#define FIT_LOAD_PROP "load"
539
540/* configuration node */
541#define FIT_KERNEL_PROP "kernel"
542#define FIT_RAMDISK_PROP "ramdisk"
543#define FIT_FDT_PROP "fdt"
544#define FIT_DEFAULT_PROP "default"
545
546#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
547
548/* cmdline argument format parsing */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100549inline int fit_parse_conf (const char *spec, ulong addr_curr,
550 ulong *addr, const char **conf_name);
551inline int fit_parse_subimage (const char *spec, ulong addr_curr,
552 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100553
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200554void fit_print_contents (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100555void fit_image_print (const void *fit, int noffset, const char *p);
556void fit_image_print_hash (const void *fit, int noffset, const char *p);
557
558/**
559 * fit_get_end - get FIT image size
560 * @fit: pointer to the FIT format image header
561 *
562 * returns:
563 * size of the FIT image (blob) in memory
564 */
565static inline ulong fit_get_size (const void *fit)
566{
567 return fdt_totalsize (fit);
568}
569
570/**
571 * fit_get_end - get FIT image end
572 * @fit: pointer to the FIT format image header
573 *
574 * returns:
575 * end address of the FIT image (blob) in memory
576 */
577static inline ulong fit_get_end (const void *fit)
578{
579 return (ulong)fit + fdt_totalsize (fit);
580}
581
582/**
583 * fit_get_name - get FIT node name
584 * @fit: pointer to the FIT format image header
585 *
586 * returns:
587 * NULL, on error
588 * pointer to node name, on success
589 */
590static inline const char *fit_get_name (const void *fit_hdr,
591 int noffset, int *len)
592{
593 return fdt_get_name (fit_hdr, noffset, len);
594}
595
596int fit_get_desc (const void *fit, int noffset, char **desc);
597int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
598
599int fit_image_get_node (const void *fit, const char *image_uname);
600int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
601int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
602int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
603int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
604int fit_image_get_load (const void *fit, int noffset, ulong *load);
605int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
606int fit_image_get_data (const void *fit, int noffset,
607 const void **data, size_t *size);
608
609int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
610int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
611 int *value_len);
612
613int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
614int fit_set_hashes (void *fit);
615int fit_image_set_hashes (void *fit, int image_noffset);
616int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
617 int value_len);
618
619int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka919f5502008-09-09 12:58:15 +0200620int fit_all_image_check_hashes (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100621int fit_image_check_os (const void *fit, int noffset, uint8_t os);
622int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
623int fit_image_check_type (const void *fit, int noffset, uint8_t type);
624int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
625int fit_check_format (const void *fit);
626
627int fit_conf_get_node (const void *fit, const char *conf_uname);
628int fit_conf_get_kernel_node (const void *fit, int noffset);
629int fit_conf_get_ramdisk_node (const void *fit, int noffset);
630int fit_conf_get_fdt_node (const void *fit, int noffset);
631
632void fit_conf_print (const void *fit, int noffset, const char *p);
633
634#ifndef USE_HOSTCC
635static inline int fit_image_check_target_arch (const void *fdt, int node)
636{
637#if defined(__ARM__)
638 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
639#elif defined(__avr32__)
640 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
641#elif defined(__bfin__)
642 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
643#elif defined(__I386__)
644 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
645#elif defined(__M68K__)
646 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
647#elif defined(__microblaze__)
648 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
649#elif defined(__mips__)
650 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
651#elif defined(__nios__)
652 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
653#elif defined(__nios2__)
654 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
655#elif defined(__PPC__)
656 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
657#elif defined(__sh__)
658 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100659#elif defined(__sparc__)
660 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100661#else
662# error Unknown CPU type
663#endif
664 return 0;
665
666 return 1;
667}
668#endif /* USE_HOSTCC */
669
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100670#ifdef CONFIG_FIT_VERBOSE
671#define fit_unsupported(msg) printf ("! %s:%d " \
672 "FIT images not supported for '%s'\n", \
673 __FILE__, __LINE__, (msg))
674
675#define fit_unsupported_reset(msg) printf ("! %s:%d " \
676 "FIT images not supported for '%s' " \
677 "- must reset board to recover!\n", \
678 __FILE__, __LINE__, (msg))
679#else
680#define fit_unsupported(msg)
681#define fit_unsupported_reset(msg)
682#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100683#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100684
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100685#endif /* __IMAGE_H__ */