blob: 541cac97fe1e13f18cb7e6f7cc2be9feb8ee2e84 [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 */
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 */
Stefano Babic8edcde52010-01-20 18:19:10 +0100159#define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
wdenk5b1d7132002-11-03 00:07:02 +0000160
161/*
162 * Compression Types
163 */
164#define IH_COMP_NONE 0 /* No Compression Used */
165#define IH_COMP_GZIP 1 /* gzip Compression Used */
166#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +0200167#define IH_COMP_LZMA 3 /* lzma Compression Used */
Peter Korsgaard20dde482009-11-19 11:37:51 +0100168#define IH_COMP_LZO 4 /* lzo Compression Used */
wdenk5b1d7132002-11-03 00:07:02 +0000169
170#define IH_MAGIC 0x27051956 /* Image Magic Number */
171#define IH_NMLEN 32 /* Image Name Length */
172
wdenk5b1d7132002-11-03 00:07:02 +0000173/*
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100174 * Legacy format image header,
175 * all data in network byte order (aka natural aka bigendian).
wdenk5b1d7132002-11-03 00:07:02 +0000176 */
wdenk5b1d7132002-11-03 00:07:02 +0000177typedef struct image_header {
178 uint32_t ih_magic; /* Image Header Magic Number */
179 uint32_t ih_hcrc; /* Image Header CRC Checksum */
180 uint32_t ih_time; /* Image Creation Timestamp */
181 uint32_t ih_size; /* Image Data Size */
182 uint32_t ih_load; /* Data Load Address */
183 uint32_t ih_ep; /* Entry Point Address */
184 uint32_t ih_dcrc; /* Image Data CRC Checksum */
185 uint8_t ih_os; /* Operating System */
186 uint8_t ih_arch; /* CPU architecture */
187 uint8_t ih_type; /* Image Type */
188 uint8_t ih_comp; /* Compression Type */
189 uint8_t ih_name[IH_NMLEN]; /* Image Name */
190} image_header_t;
191
Kumar Gala396f6352008-08-15 08:24:41 -0500192typedef struct image_info {
193 ulong start, end; /* start/end of blob */
194 ulong image_start, image_len; /* start of image within blob, len of image */
195 ulong load; /* load addr for the image */
196 uint8_t comp, type, os; /* compression, type of image, os type */
197} image_info_t;
198
Marian Balakowicz559316f2008-01-08 18:11:44 +0100199/*
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100200 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
201 * routines.
202 */
203typedef struct bootm_headers {
204 /*
205 * Legacy os image header, if it is a multi component image
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100206 * then boot_get_ramdisk() and get_fdt() will attempt to get
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100207 * data from second and third component accordingly.
208 */
Marian Balakowiczcb1c4892008-04-11 11:07:49 +0200209 image_header_t *legacy_hdr_os; /* image header pointer */
210 image_header_t legacy_hdr_os_copy; /* header copy */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100211 ulong legacy_hdr_valid;
212
213#if defined(CONFIG_FIT)
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100214 const char *fit_uname_cfg; /* configuration node unit name */
215
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100216 void *fit_hdr_os; /* os FIT image header */
Marian Balakowiczeb6175e2008-03-10 17:53:49 +0100217 const char *fit_uname_os; /* os subimage node unit name */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100218 int fit_noffset_os; /* os subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100219
220 void *fit_hdr_rd; /* init ramdisk FIT image header */
Marian Balakowicz3dfe1102008-03-12 10:32:59 +0100221 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
222 int fit_noffset_rd; /* init ramdisk subimage node offset */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100223
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100224 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
Kumar Gala49c3a862008-10-21 17:25:45 -0500229#ifndef USE_HOSTCC
Kumar Gala396f6352008-08-15 08:24:41 -0500230 image_info_t os; /* os image info */
Kumar Galac160a952008-08-15 08:24:36 -0500231 ulong ep; /* entry point of OS */
232
Kumar Galac4f94192008-08-15 08:24:37 -0500233 ulong rd_start, rd_end;/* ramdisk start/end */
234
Kumar Gala06a09912008-08-15 08:24:38 -0500235#ifdef CONFIG_OF_LIBFDT
236 char *ft_addr; /* flat dev tree address */
237#endif
238 ulong ft_len; /* length of flat device tree */
239
Kumar Gala49c3a862008-10-21 17:25:45 -0500240 ulong initrd_start;
241 ulong initrd_end;
242 ulong cmdline_start;
243 ulong cmdline_end;
244 bd_t *kbd;
245#endif
246
Marian Balakowicz8a5ea3e2008-02-27 11:01:04 +0100247 int verify; /* getenv("verify")[0] != 'n' */
Kumar Gala49c3a862008-10-21 17:25:45 -0500248
249#define BOOTM_STATE_START (0x00000001)
250#define BOOTM_STATE_LOADOS (0x00000002)
251#define BOOTM_STATE_RAMDISK (0x00000004)
252#define BOOTM_STATE_FDT (0x00000008)
253#define BOOTM_STATE_OS_CMDLINE (0x00000010)
254#define BOOTM_STATE_OS_BD_T (0x00000020)
255#define BOOTM_STATE_OS_PREP (0x00000040)
256#define BOOTM_STATE_OS_GO (0x00000080)
257 int state;
258
Mike Frysingera16028d2009-11-03 11:35:59 -0500259#ifdef CONFIG_LMB
Kumar Galae906cfa2008-08-15 08:24:40 -0500260 struct lmb lmb; /* for memory mgmt */
261#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100262} bootm_headers_t;
263
264/*
Marian Balakowicz559316f2008-01-08 18:11:44 +0100265 * Some systems (for example LWMON) have very short watchdog periods;
266 * we must make sure to split long operations like memmove() or
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200267 * checksum calculations into reasonable chunks.
Marian Balakowicz559316f2008-01-08 18:11:44 +0100268 */
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200269#ifndef CHUNKSZ
Marian Balakowicz559316f2008-01-08 18:11:44 +0100270#define CHUNKSZ (64 * 1024)
Bartlomiej Sieka75903782008-04-25 13:54:02 +0200271#endif
272
273#ifndef CHUNKSZ_CRC32
274#define CHUNKSZ_CRC32 (64 * 1024)
275#endif
276
277#ifndef CHUNKSZ_MD5
278#define CHUNKSZ_MD5 (64 * 1024)
279#endif
280
281#ifndef CHUNKSZ_SHA1
282#define CHUNKSZ_SHA1 (64 * 1024)
283#endif
Marian Balakowicz559316f2008-01-08 18:11:44 +0100284
Mike Frysinger37566092009-07-02 19:23:25 -0400285#define uimage_to_cpu(x) be32_to_cpu(x)
286#define cpu_to_uimage(x) cpu_to_be32(x)
wdenk5b1d7132002-11-03 00:07:02 +0000287
Prafulla Wadaskarb029ddd2009-09-07 14:59:08 +0530288/*
289 * Translation table for entries of a specific type; used by
290 * get_table_entry_id() and get_table_entry_name().
291 */
292typedef struct table_entry {
293 int id;
294 char *sname; /* short (input) name to find table entry */
295 char *lname; /* long (output) name to print for messages */
296} table_entry_t;
297
298/*
299 * get_table_entry_id() scans the translation table trying to find an
300 * entry that matches the given short name. If a matching entry is
301 * found, it's id is returned to the caller.
302 */
303int get_table_entry_id (table_entry_t *table,
304 const char *table_name, const char *name);
305/*
306 * get_table_entry_name() scans the translation table trying to find
307 * an entry that matches the given id. If a matching entry is found,
308 * its long name is returned to the caller.
309 */
310char *get_table_entry_name (table_entry_t *table, char *msg, int id);
311
Marian Balakowicz570abb02008-02-29 15:59:59 +0100312const char *genimg_get_os_name (uint8_t os);
313const char *genimg_get_arch_name (uint8_t arch);
314const char *genimg_get_type_name (uint8_t type);
315const char *genimg_get_comp_name (uint8_t comp);
316int genimg_get_os_id (const char *name);
317int genimg_get_arch_id (const char *name);
318int genimg_get_type_id (const char *name);
319int genimg_get_comp_id (const char *name);
Prafulla Wadaskarf666dea2009-09-07 14:59:07 +0530320void genimg_print_size (uint32_t size);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100321
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100322#ifndef USE_HOSTCC
323/* Image format types, returned by _get_format() routine */
324#define IMAGE_FORMAT_INVALID 0x00
325#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
326#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
327
328int genimg_get_format (void *img_addr);
Marian Balakowiczf773bea2008-03-12 10:35:46 +0100329int genimg_has_config (bootm_headers_t *images);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100330ulong genimg_get_image (ulong img_addr);
331
Marian Balakowiczd985c842008-03-12 10:14:38 +0100332int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
333 uint8_t arch, ulong *rd_start, ulong *rd_end);
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100334
Kumar Gala06a09912008-08-15 08:24:38 -0500335
336#ifdef CONFIG_OF_LIBFDT
337int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
338 char **of_flat_tree, ulong *of_size);
339int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
340 char **of_flat_tree, ulong *of_size);
341#endif
342
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100343#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
344int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
345 ulong *initrd_start, ulong *initrd_end);
346
347int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
348 ulong bootmap_base);
349int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
350#endif /* CONFIG_PPC || CONFIG_M68K */
Marian Balakowicz570abb02008-02-29 15:59:59 +0100351#endif /* !USE_HOSTCC */
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100352
353/*******************************************************************/
354/* Legacy format specific code (prefixed with image_) */
355/*******************************************************************/
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100356static inline uint32_t image_get_header_size (void)
357{
358 return (sizeof (image_header_t));
359}
360
361#define image_get_hdr_l(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200362 static inline uint32_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100363 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100364 return uimage_to_cpu (hdr->ih_##f); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100365 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200366image_get_hdr_l (magic); /* image_get_magic */
367image_get_hdr_l (hcrc); /* image_get_hcrc */
368image_get_hdr_l (time); /* image_get_time */
369image_get_hdr_l (size); /* image_get_size */
370image_get_hdr_l (load); /* image_get_load */
371image_get_hdr_l (ep); /* image_get_ep */
372image_get_hdr_l (dcrc); /* image_get_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100373
374#define image_get_hdr_b(f) \
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200375 static inline uint8_t image_get_##f(const image_header_t *hdr) \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100376 { \
377 return hdr->ih_##f; \
378 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200379image_get_hdr_b (os); /* image_get_os */
380image_get_hdr_b (arch); /* image_get_arch */
381image_get_hdr_b (type); /* image_get_type */
382image_get_hdr_b (comp); /* image_get_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100383
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200384static inline char *image_get_name (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100385{
386 return (char *)hdr->ih_name;
387}
388
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200389static inline uint32_t image_get_data_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100390{
391 return image_get_size (hdr);
392}
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100393
394/**
395 * image_get_data - get image payload start address
396 * @hdr: image header
397 *
398 * image_get_data() returns address of the image payload. For single
399 * component images it is image data start. For multi component
400 * images it points to the null terminated table of sub-images sizes.
401 *
402 * returns:
403 * image payload data start address
404 */
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200405static inline ulong image_get_data (const image_header_t *hdr)
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100406{
407 return ((ulong)hdr + image_get_header_size ());
408}
409
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200410static inline uint32_t image_get_image_size (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100411{
412 return (image_get_size (hdr) + image_get_header_size ());
413}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200414static inline ulong image_get_image_end (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100415{
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100416 return ((ulong)hdr + image_get_image_size (hdr));
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100417}
418
419#define image_set_hdr_l(f) \
420 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
421 { \
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100422 hdr->ih_##f = cpu_to_uimage (val); \
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100423 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200424image_set_hdr_l (magic); /* image_set_magic */
425image_set_hdr_l (hcrc); /* image_set_hcrc */
426image_set_hdr_l (time); /* image_set_time */
427image_set_hdr_l (size); /* image_set_size */
428image_set_hdr_l (load); /* image_set_load */
429image_set_hdr_l (ep); /* image_set_ep */
430image_set_hdr_l (dcrc); /* image_set_dcrc */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100431
432#define image_set_hdr_b(f) \
433 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
434 { \
435 hdr->ih_##f = val; \
436 }
Petri Lehtinenf05fa922009-01-29 10:35:40 +0200437image_set_hdr_b (os); /* image_set_os */
438image_set_hdr_b (arch); /* image_set_arch */
439image_set_hdr_b (type); /* image_set_type */
440image_set_hdr_b (comp); /* image_set_comp */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100441
442static inline void image_set_name (image_header_t *hdr, const char *name)
443{
444 strncpy (image_get_name (hdr), name, IH_NMLEN);
445}
446
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200447int image_check_hcrc (const image_header_t *hdr);
448int image_check_dcrc (const image_header_t *hdr);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100449#ifndef USE_HOSTCC
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200450int getenv_yesno (char *var);
Kumar Galad3f2fa02008-02-27 21:51:50 -0600451ulong getenv_bootm_low(void);
Becky Bruce391fd932008-06-09 20:37:18 -0500452phys_size_t getenv_bootm_size(void);
Marian Balakowiczaf13cdb2008-01-08 18:11:45 +0100453void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
454#endif
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100455
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200456static inline int image_check_magic (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100457{
458 return (image_get_magic (hdr) == IH_MAGIC);
459}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200460static inline int image_check_type (const image_header_t *hdr, uint8_t type)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100461{
462 return (image_get_type (hdr) == type);
463}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200464static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100465{
466 return (image_get_arch (hdr) == arch);
467}
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200468static inline int image_check_os (const image_header_t *hdr, uint8_t os)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100469{
470 return (image_get_os (hdr) == os);
471}
472
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200473ulong image_multi_count (const image_header_t *hdr);
474void image_multi_getimg (const image_header_t *hdr, ulong idx,
Marian Balakowicz42b73e82008-01-31 13:20:07 +0100475 ulong *data, ulong *len);
476
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200477void image_print_contents (const void *hdr);
Marian Balakowicz570abb02008-02-29 15:59:59 +0100478
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100479#ifndef USE_HOSTCC
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200480static inline int image_check_target_arch (const image_header_t *hdr)
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100481{
482#if defined(__ARM__)
483 if (!image_check_arch (hdr, IH_ARCH_ARM))
484#elif defined(__avr32__)
485 if (!image_check_arch (hdr, IH_ARCH_AVR32))
486#elif defined(__bfin__)
487 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
488#elif defined(__I386__)
489 if (!image_check_arch (hdr, IH_ARCH_I386))
490#elif defined(__M68K__)
491 if (!image_check_arch (hdr, IH_ARCH_M68K))
492#elif defined(__microblaze__)
493 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
494#elif defined(__mips__)
495 if (!image_check_arch (hdr, IH_ARCH_MIPS))
496#elif defined(__nios__)
497 if (!image_check_arch (hdr, IH_ARCH_NIOS))
498#elif defined(__nios2__)
499 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
500#elif defined(__PPC__)
501 if (!image_check_arch (hdr, IH_ARCH_PPC))
502#elif defined(__sh__)
503 if (!image_check_arch (hdr, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100504#elif defined(__sparc__)
505 if (!image_check_arch (hdr, IH_ARCH_SPARC))
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100506#else
507# error Unknown CPU type
508#endif
509 return 0;
510
511 return 1;
512}
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100513#endif /* USE_HOSTCC */
Marian Balakowiczb97a2a02008-01-08 18:14:09 +0100514
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100515/*******************************************************************/
Marian Balakowicz9a4daad2008-02-29 14:58:34 +0100516/* New uImage format specific code (prefixed with fit_) */
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100517/*******************************************************************/
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100518#if defined(CONFIG_FIT)
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100519
520#define FIT_IMAGES_PATH "/images"
521#define FIT_CONFS_PATH "/configurations"
522
523/* hash node */
524#define FIT_HASH_NODENAME "hash"
525#define FIT_ALGO_PROP "algo"
526#define FIT_VALUE_PROP "value"
527
528/* image node */
529#define FIT_DATA_PROP "data"
530#define FIT_TIMESTAMP_PROP "timestamp"
531#define FIT_DESC_PROP "description"
532#define FIT_ARCH_PROP "arch"
533#define FIT_TYPE_PROP "type"
534#define FIT_OS_PROP "os"
535#define FIT_COMP_PROP "compression"
536#define FIT_ENTRY_PROP "entry"
537#define FIT_LOAD_PROP "load"
538
539/* configuration node */
540#define FIT_KERNEL_PROP "kernel"
541#define FIT_RAMDISK_PROP "ramdisk"
542#define FIT_FDT_PROP "fdt"
543#define FIT_DEFAULT_PROP "default"
544
545#define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
546
547/* cmdline argument format parsing */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100548inline int fit_parse_conf (const char *spec, ulong addr_curr,
549 ulong *addr, const char **conf_name);
550inline int fit_parse_subimage (const char *spec, ulong addr_curr,
551 ulong *addr, const char **image_name);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100552
Bartlomiej Siekaedbed242008-04-18 12:39:23 +0200553void fit_print_contents (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100554void fit_image_print (const void *fit, int noffset, const char *p);
555void fit_image_print_hash (const void *fit, int noffset, const char *p);
556
557/**
558 * fit_get_end - get FIT image size
559 * @fit: pointer to the FIT format image header
560 *
561 * returns:
562 * size of the FIT image (blob) in memory
563 */
564static inline ulong fit_get_size (const void *fit)
565{
566 return fdt_totalsize (fit);
567}
568
569/**
570 * fit_get_end - get FIT image end
571 * @fit: pointer to the FIT format image header
572 *
573 * returns:
574 * end address of the FIT image (blob) in memory
575 */
576static inline ulong fit_get_end (const void *fit)
577{
578 return (ulong)fit + fdt_totalsize (fit);
579}
580
581/**
582 * fit_get_name - get FIT node name
583 * @fit: pointer to the FIT format image header
584 *
585 * returns:
586 * NULL, on error
587 * pointer to node name, on success
588 */
589static inline const char *fit_get_name (const void *fit_hdr,
590 int noffset, int *len)
591{
592 return fdt_get_name (fit_hdr, noffset, len);
593}
594
595int fit_get_desc (const void *fit, int noffset, char **desc);
596int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
597
598int fit_image_get_node (const void *fit, const char *image_uname);
599int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
600int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
601int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
602int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
603int fit_image_get_load (const void *fit, int noffset, ulong *load);
604int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
605int fit_image_get_data (const void *fit, int noffset,
606 const void **data, size_t *size);
607
608int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
609int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
610 int *value_len);
611
612int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
613int fit_set_hashes (void *fit);
614int fit_image_set_hashes (void *fit, int image_noffset);
615int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
616 int value_len);
617
618int fit_image_check_hashes (const void *fit, int noffset);
Bartlomiej Sieka919f5502008-09-09 12:58:15 +0200619int fit_all_image_check_hashes (const void *fit);
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100620int fit_image_check_os (const void *fit, int noffset, uint8_t os);
621int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
622int fit_image_check_type (const void *fit, int noffset, uint8_t type);
623int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
624int fit_check_format (const void *fit);
625
626int fit_conf_get_node (const void *fit, const char *conf_uname);
627int fit_conf_get_kernel_node (const void *fit, int noffset);
628int fit_conf_get_ramdisk_node (const void *fit, int noffset);
629int fit_conf_get_fdt_node (const void *fit, int noffset);
630
631void fit_conf_print (const void *fit, int noffset, const char *p);
632
633#ifndef USE_HOSTCC
634static inline int fit_image_check_target_arch (const void *fdt, int node)
635{
636#if defined(__ARM__)
637 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
638#elif defined(__avr32__)
639 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
640#elif defined(__bfin__)
641 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
642#elif defined(__I386__)
643 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
644#elif defined(__M68K__)
645 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
646#elif defined(__microblaze__)
647 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
648#elif defined(__mips__)
649 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
650#elif defined(__nios__)
651 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
652#elif defined(__nios2__)
653 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
654#elif defined(__PPC__)
655 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
656#elif defined(__sh__)
657 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
Daniel Hellstrombf3d8b32008-03-28 08:29:26 +0100658#elif defined(__sparc__)
659 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
Marian Balakowicz5dfb5212008-02-29 21:24:06 +0100660#else
661# error Unknown CPU type
662#endif
663 return 0;
664
665 return 1;
666}
667#endif /* USE_HOSTCC */
668
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100669#ifdef CONFIG_FIT_VERBOSE
670#define fit_unsupported(msg) printf ("! %s:%d " \
671 "FIT images not supported for '%s'\n", \
672 __FILE__, __LINE__, (msg))
673
674#define fit_unsupported_reset(msg) printf ("! %s:%d " \
675 "FIT images not supported for '%s' " \
676 "- must reset board to recover!\n", \
677 __FILE__, __LINE__, (msg))
678#else
679#define fit_unsupported(msg)
680#define fit_unsupported_reset(msg)
681#endif /* CONFIG_FIT_VERBOSE */
Marian Balakowiczf50433d2008-02-21 17:20:20 +0100682#endif /* CONFIG_FIT */
Marian Balakowicz5ad03eb2008-01-31 13:55:39 +0100683
Marian Balakowiczf13e7b22008-01-08 18:12:17 +0100684#endif /* __IMAGE_H__ */