2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2005
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * See file CREDITS for list of people who contributed to this
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.
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.
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,
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
30 ********************************************************************
36 #include <asm/byteorder.h>
40 #include <linux/string.h>
41 #include <asm/u-boot.h>
43 /* new uImage format support enabled by default */
45 #define CONFIG_OF_LIBFDT 1
47 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
48 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
50 #endif /* USE_HOSTCC */
53 * Operating System Codes
55 #define IH_OS_INVALID 0 /* Invalid OS */
56 #define IH_OS_OPENBSD 1 /* OpenBSD */
57 #define IH_OS_NETBSD 2 /* NetBSD */
58 #define IH_OS_FREEBSD 3 /* FreeBSD */
59 #define IH_OS_4_4BSD 4 /* 4.4BSD */
60 #define IH_OS_LINUX 5 /* Linux */
61 #define IH_OS_SVR4 6 /* SVR4 */
62 #define IH_OS_ESIX 7 /* Esix */
63 #define IH_OS_SOLARIS 8 /* Solaris */
64 #define IH_OS_IRIX 9 /* Irix */
65 #define IH_OS_SCO 10 /* SCO */
66 #define IH_OS_DELL 11 /* Dell */
67 #define IH_OS_NCR 12 /* NCR */
68 #define IH_OS_LYNXOS 13 /* LynxOS */
69 #define IH_OS_VXWORKS 14 /* VxWorks */
70 #define IH_OS_PSOS 15 /* pSOS */
71 #define IH_OS_QNX 16 /* QNX */
72 #define IH_OS_U_BOOT 17 /* Firmware */
73 #define IH_OS_RTEMS 18 /* RTEMS */
74 #define IH_OS_ARTOS 19 /* ARTOS */
75 #define IH_OS_UNITY 20 /* Unity OS */
78 * CPU Architecture Codes (supported by Linux)
80 #define IH_ARCH_INVALID 0 /* Invalid CPU */
81 #define IH_ARCH_ALPHA 1 /* Alpha */
82 #define IH_ARCH_ARM 2 /* ARM */
83 #define IH_ARCH_I386 3 /* Intel x86 */
84 #define IH_ARCH_IA64 4 /* IA64 */
85 #define IH_ARCH_MIPS 5 /* MIPS */
86 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
87 #define IH_ARCH_PPC 7 /* PowerPC */
88 #define IH_ARCH_S390 8 /* IBM S390 */
89 #define IH_ARCH_SH 9 /* SuperH */
90 #define IH_ARCH_SPARC 10 /* Sparc */
91 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
92 #define IH_ARCH_M68K 12 /* M68K */
93 #define IH_ARCH_NIOS 13 /* Nios-32 */
94 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
95 #define IH_ARCH_NIOS2 15 /* Nios-II */
96 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
97 #define IH_ARCH_AVR32 17 /* AVR32 */
98 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
103 * "Standalone Programs" are directly runnable in the environment
104 * provided by U-Boot; it is expected that (if they behave
105 * well) you can continue to work in U-Boot after return from
106 * the Standalone Program.
107 * "OS Kernel Images" are usually images of some Embedded OS which
108 * will take over control completely. Usually these programs
109 * will install their own set of exception handlers, device
110 * drivers, set up the MMU, etc. - this means, that you cannot
111 * expect to re-enter U-Boot except by resetting the CPU.
112 * "RAMDisk Images" are more or less just data blocks, and their
113 * parameters (address, size) are passed to an OS kernel that is
115 * "Multi-File Images" contain several images, typically an OS
116 * (Linux) kernel image and one or more data images like
117 * RAMDisks. This construct is useful for instance when you want
118 * to boot over the network using BOOTP etc., where the boot
119 * server provides just a single image file, but you want to get
120 * for instance an OS kernel and a RAMDisk image.
122 * "Multi-File Images" start with a list of image sizes, each
123 * image size (in bytes) specified by an "uint32_t" in network
124 * byte order. This list is terminated by an "(uint32_t)0".
125 * Immediately after the terminating 0 follow the images, one by
126 * one, all aligned on "uint32_t" boundaries (size rounded up to
127 * a multiple of 4 bytes - except for the last file).
129 * "Firmware Images" are binary images containing firmware (like
130 * U-Boot or FPGA images) which usually will be programmed to
133 * "Script files" are command sequences that will be executed by
134 * U-Boot's command interpreter; this feature is especially
135 * useful when you configure U-Boot to use a real shell (hush)
136 * as command interpreter (=> Shell Scripts).
139 #define IH_TYPE_INVALID 0 /* Invalid Image */
140 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
141 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
142 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
143 #define IH_TYPE_MULTI 4 /* Multi-File Image */
144 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
145 #define IH_TYPE_SCRIPT 6 /* Script file */
146 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
147 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
152 #define IH_COMP_NONE 0 /* No Compression Used */
153 #define IH_COMP_GZIP 1 /* gzip Compression Used */
154 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
156 #define IH_MAGIC 0x27051956 /* Image Magic Number */
157 #define IH_NMLEN 32 /* Image Name Length */
160 * all data in network byte order (aka natural aka bigendian)
163 typedef struct image_header {
164 uint32_t ih_magic; /* Image Header Magic Number */
165 uint32_t ih_hcrc; /* Image Header CRC Checksum */
166 uint32_t ih_time; /* Image Creation Timestamp */
167 uint32_t ih_size; /* Image Data Size */
168 uint32_t ih_load; /* Data Load Address */
169 uint32_t ih_ep; /* Entry Point Address */
170 uint32_t ih_dcrc; /* Image Data CRC Checksum */
171 uint8_t ih_os; /* Operating System */
172 uint8_t ih_arch; /* CPU architecture */
173 uint8_t ih_type; /* Image Type */
174 uint8_t ih_comp; /* Compression Type */
175 uint8_t ih_name[IH_NMLEN]; /* Image Name */
179 * Some systems (for example LWMON) have very short watchdog periods;
180 * we must make sure to split long operations like memmove() or
181 * crc32() into reasonable chunks.
183 #define CHUNKSZ (64 * 1024)
185 #define image_to_cpu(x) ntohl(x)
186 #define cpu_to_image(x) htonl(x)
188 static inline uint32_t image_get_header_size (void)
190 return (sizeof (image_header_t));
193 #define image_get_hdr_l(f) \
194 static inline uint32_t image_get_##f(image_header_t *hdr) \
196 return image_to_cpu (hdr->ih_##f); \
198 image_get_hdr_l (magic);
199 image_get_hdr_l (hcrc);
200 image_get_hdr_l (time);
201 image_get_hdr_l (size);
202 image_get_hdr_l (load);
203 image_get_hdr_l (ep);
204 image_get_hdr_l (dcrc);
206 #define image_get_hdr_b(f) \
207 static inline uint8_t image_get_##f(image_header_t *hdr) \
209 return hdr->ih_##f; \
211 image_get_hdr_b (os);
212 image_get_hdr_b (arch);
213 image_get_hdr_b (type);
214 image_get_hdr_b (comp);
216 static inline char *image_get_name (image_header_t *hdr)
218 return (char *)hdr->ih_name;
221 static inline uint32_t image_get_data_size (image_header_t *hdr)
223 return image_get_size (hdr);
227 * image_get_data - get image payload start address
230 * image_get_data() returns address of the image payload. For single
231 * component images it is image data start. For multi component
232 * images it points to the null terminated table of sub-images sizes.
235 * image payload data start address
237 static inline ulong image_get_data (image_header_t *hdr)
239 return ((ulong)hdr + image_get_header_size ());
242 static inline uint32_t image_get_image_size (image_header_t *hdr)
244 return (image_get_size (hdr) + image_get_header_size ());
246 static inline ulong image_get_image_end (image_header_t *hdr)
248 return ((ulong)hdr + image_get_image_size (hdr));
251 #define image_set_hdr_l(f) \
252 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
254 hdr->ih_##f = cpu_to_image (val); \
256 image_set_hdr_l (magic);
257 image_set_hdr_l (hcrc);
258 image_set_hdr_l (time);
259 image_set_hdr_l (size);
260 image_set_hdr_l (load);
261 image_set_hdr_l (ep);
262 image_set_hdr_l (dcrc);
264 #define image_set_hdr_b(f) \
265 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
269 image_set_hdr_b (os);
270 image_set_hdr_b (arch);
271 image_set_hdr_b (type);
272 image_set_hdr_b (comp);
274 static inline void image_set_name (image_header_t *hdr, const char *name)
276 strncpy (image_get_name (hdr), name, IH_NMLEN);
279 int image_check_hcrc (image_header_t *hdr);
280 int image_check_dcrc (image_header_t *hdr);
282 int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
283 int getenv_verify (void);
284 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
287 static inline int image_check_magic (image_header_t *hdr)
289 return (image_get_magic (hdr) == IH_MAGIC);
291 static inline int image_check_type (image_header_t *hdr, uint8_t type)
293 return (image_get_type (hdr) == type);
295 static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
297 return (image_get_arch (hdr) == arch);
299 static inline int image_check_os (image_header_t *hdr, uint8_t os)
301 return (image_get_os (hdr) == os);
304 ulong image_multi_count (image_header_t *hdr);
305 void image_multi_getimg (image_header_t *hdr, ulong idx,
306 ulong *data, ulong *len);
309 static inline int image_check_target_arch (image_header_t *hdr)
312 if (!image_check_arch (hdr, IH_ARCH_ARM))
313 #elif defined(__avr32__)
314 if (!image_check_arch (hdr, IH_ARCH_AVR32))
315 #elif defined(__bfin__)
316 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
317 #elif defined(__I386__)
318 if (!image_check_arch (hdr, IH_ARCH_I386))
319 #elif defined(__M68K__)
320 if (!image_check_arch (hdr, IH_ARCH_M68K))
321 #elif defined(__microblaze__)
322 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
323 #elif defined(__mips__)
324 if (!image_check_arch (hdr, IH_ARCH_MIPS))
325 #elif defined(__nios__)
326 if (!image_check_arch (hdr, IH_ARCH_NIOS))
327 #elif defined(__nios2__)
328 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
329 #elif defined(__PPC__)
330 if (!image_check_arch (hdr, IH_ARCH_PPC))
331 #elif defined(__sh__)
332 if (!image_check_arch (hdr, IH_ARCH_SH))
334 # error Unknown CPU type
341 const char* image_get_os_name (uint8_t os);
342 const char* image_get_arch_name (uint8_t arch);
343 const char* image_get_type_name (uint8_t type);
344 const char* image_get_comp_name (uint8_t comp);
346 #define IMAGE_FORMAT_INVALID 0x00
347 #define IMAGE_FORMAT_LEGACY 0x01
348 #define IMAGE_FORMAT_FIT 0x02
349 int gen_image_get_format (void *img_addr);
350 ulong gen_get_image (ulong img_addr);
352 image_header_t* image_get_ramdisk (cmd_tbl_t *cmdtp, int flag,
353 int argc, char *argv[],
354 ulong rd_addr, uint8_t arch, int verify);
356 void get_ramdisk (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[],
357 image_header_t *hdr, int verify, uint8_t arch,
358 ulong *rd_start, ulong *rd_end);
360 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
361 ulong ramdisk_high (ulong alloc_current, ulong rd_data, ulong rd_len,
362 bd_t *kbd, ulong sp_limit, ulong sp,
363 ulong *initrd_start, ulong *initrd_end);
365 ulong get_boot_sp_limit (ulong sp);
366 ulong get_boot_cmdline (ulong alloc_current, ulong *cmd_start, ulong *cmd_end);
367 ulong get_boot_kbd (ulong alloc_current, bd_t **kbd);
368 #endif /* CONFIG_PPC || CONFIG_M68K */
370 #endif /* USE_HOSTCC */
372 #endif /* __IMAGE_H__ */