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>
41 #include <linux/string.h>
42 #include <asm/u-boot.h>
44 /* new uImage format support enabled by default */
46 #define CONFIG_OF_LIBFDT 1
48 /* enable fit_format_error(), fit_format_warning() */
49 #define CONFIG_FIT_VERBOSE 1
51 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
52 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
54 #endif /* USE_HOSTCC */
57 * Operating System Codes
59 #define IH_OS_INVALID 0 /* Invalid OS */
60 #define IH_OS_OPENBSD 1 /* OpenBSD */
61 #define IH_OS_NETBSD 2 /* NetBSD */
62 #define IH_OS_FREEBSD 3 /* FreeBSD */
63 #define IH_OS_4_4BSD 4 /* 4.4BSD */
64 #define IH_OS_LINUX 5 /* Linux */
65 #define IH_OS_SVR4 6 /* SVR4 */
66 #define IH_OS_ESIX 7 /* Esix */
67 #define IH_OS_SOLARIS 8 /* Solaris */
68 #define IH_OS_IRIX 9 /* Irix */
69 #define IH_OS_SCO 10 /* SCO */
70 #define IH_OS_DELL 11 /* Dell */
71 #define IH_OS_NCR 12 /* NCR */
72 #define IH_OS_LYNXOS 13 /* LynxOS */
73 #define IH_OS_VXWORKS 14 /* VxWorks */
74 #define IH_OS_PSOS 15 /* pSOS */
75 #define IH_OS_QNX 16 /* QNX */
76 #define IH_OS_U_BOOT 17 /* Firmware */
77 #define IH_OS_RTEMS 18 /* RTEMS */
78 #define IH_OS_ARTOS 19 /* ARTOS */
79 #define IH_OS_UNITY 20 /* Unity OS */
82 * CPU Architecture Codes (supported by Linux)
84 #define IH_ARCH_INVALID 0 /* Invalid CPU */
85 #define IH_ARCH_ALPHA 1 /* Alpha */
86 #define IH_ARCH_ARM 2 /* ARM */
87 #define IH_ARCH_I386 3 /* Intel x86 */
88 #define IH_ARCH_IA64 4 /* IA64 */
89 #define IH_ARCH_MIPS 5 /* MIPS */
90 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
91 #define IH_ARCH_PPC 7 /* PowerPC */
92 #define IH_ARCH_S390 8 /* IBM S390 */
93 #define IH_ARCH_SH 9 /* SuperH */
94 #define IH_ARCH_SPARC 10 /* Sparc */
95 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
96 #define IH_ARCH_M68K 12 /* M68K */
97 #define IH_ARCH_NIOS 13 /* Nios-32 */
98 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
99 #define IH_ARCH_NIOS2 15 /* Nios-II */
100 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
101 #define IH_ARCH_AVR32 17 /* AVR32 */
102 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
107 * "Standalone Programs" are directly runnable in the environment
108 * provided by U-Boot; it is expected that (if they behave
109 * well) you can continue to work in U-Boot after return from
110 * the Standalone Program.
111 * "OS Kernel Images" are usually images of some Embedded OS which
112 * will take over control completely. Usually these programs
113 * will install their own set of exception handlers, device
114 * drivers, set up the MMU, etc. - this means, that you cannot
115 * expect to re-enter U-Boot except by resetting the CPU.
116 * "RAMDisk Images" are more or less just data blocks, and their
117 * parameters (address, size) are passed to an OS kernel that is
119 * "Multi-File Images" contain several images, typically an OS
120 * (Linux) kernel image and one or more data images like
121 * RAMDisks. This construct is useful for instance when you want
122 * to boot over the network using BOOTP etc., where the boot
123 * server provides just a single image file, but you want to get
124 * for instance an OS kernel and a RAMDisk image.
126 * "Multi-File Images" start with a list of image sizes, each
127 * image size (in bytes) specified by an "uint32_t" in network
128 * byte order. This list is terminated by an "(uint32_t)0".
129 * Immediately after the terminating 0 follow the images, one by
130 * one, all aligned on "uint32_t" boundaries (size rounded up to
131 * a multiple of 4 bytes - except for the last file).
133 * "Firmware Images" are binary images containing firmware (like
134 * U-Boot or FPGA images) which usually will be programmed to
137 * "Script files" are command sequences that will be executed by
138 * U-Boot's command interpreter; this feature is especially
139 * useful when you configure U-Boot to use a real shell (hush)
140 * as command interpreter (=> Shell Scripts).
143 #define IH_TYPE_INVALID 0 /* Invalid Image */
144 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
145 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
146 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
147 #define IH_TYPE_MULTI 4 /* Multi-File Image */
148 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
149 #define IH_TYPE_SCRIPT 6 /* Script file */
150 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
151 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
156 #define IH_COMP_NONE 0 /* No Compression Used */
157 #define IH_COMP_GZIP 1 /* gzip Compression Used */
158 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
160 #define IH_MAGIC 0x27051956 /* Image Magic Number */
161 #define IH_NMLEN 32 /* Image Name Length */
164 * Legacy format image header,
165 * all data in network byte order (aka natural aka bigendian).
167 typedef struct image_header {
168 uint32_t ih_magic; /* Image Header Magic Number */
169 uint32_t ih_hcrc; /* Image Header CRC Checksum */
170 uint32_t ih_time; /* Image Creation Timestamp */
171 uint32_t ih_size; /* Image Data Size */
172 uint32_t ih_load; /* Data Load Address */
173 uint32_t ih_ep; /* Entry Point Address */
174 uint32_t ih_dcrc; /* Image Data CRC Checksum */
175 uint8_t ih_os; /* Operating System */
176 uint8_t ih_arch; /* CPU architecture */
177 uint8_t ih_type; /* Image Type */
178 uint8_t ih_comp; /* Compression Type */
179 uint8_t ih_name[IH_NMLEN]; /* Image Name */
183 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
186 typedef struct bootm_headers {
188 * Legacy os image header, if it is a multi component image
189 * then boot_get_ramdisk() and get_fdt() will attempt to get
190 * data from second and third component accordingly.
192 image_header_t *legacy_hdr_os;
193 ulong legacy_hdr_valid;
195 #if defined(CONFIG_FIT)
196 void *fit_hdr_os; /* os FIT image header */
197 char *fit_uname_os; /* os subimage node unit name */
199 void *fit_hdr_rd; /* init ramdisk FIT image header */
200 char *fit_uname_rd; /* init ramdisk node unit name */
202 #if defined(CONFIG_PPC)
203 void *fit_hdr_fdt; /* FDT blob FIT image header */
204 char *fit_uname_fdt; /* FDT blob node unit name */
206 int verify; /* getenv("verify")[0] != 'n' */
207 int autostart; /* getenv("autostart")[0] != 'n' */
208 struct lmb *lmb; /* for memory mgmt */
213 * Some systems (for example LWMON) have very short watchdog periods;
214 * we must make sure to split long operations like memmove() or
215 * crc32() into reasonable chunks.
217 #define CHUNKSZ (64 * 1024)
219 #define uimage_to_cpu(x) ntohl(x)
220 #define cpu_to_uimage(x) htonl(x)
223 /* Image format types, returned by _get_format() routine */
224 #define IMAGE_FORMAT_INVALID 0x00
225 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
226 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
228 int genimg_get_format (void *img_addr);
229 ulong genimg_get_image (ulong img_addr);
231 const char* genimg_get_os_name (uint8_t os);
232 const char* genimg_get_arch_name (uint8_t arch);
233 const char* genimg_get_type_name (uint8_t type);
234 const char* genimg_get_comp_name (uint8_t comp);
236 int boot_get_ramdisk (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[],
237 bootm_headers_t *images, uint8_t arch,
238 ulong *rd_start, ulong *rd_end);
240 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
241 int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
242 ulong *initrd_start, ulong *initrd_end);
244 int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
246 int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
247 #endif /* CONFIG_PPC || CONFIG_M68K */
248 #endif /* USE_HOSTCC */
250 /*******************************************************************/
251 /* Legacy format specific code (prefixed with image_) */
252 /*******************************************************************/
253 static inline uint32_t image_get_header_size (void)
255 return (sizeof (image_header_t));
258 #define image_get_hdr_l(f) \
259 static inline uint32_t image_get_##f(image_header_t *hdr) \
261 return uimage_to_cpu (hdr->ih_##f); \
263 image_get_hdr_l (magic);
264 image_get_hdr_l (hcrc);
265 image_get_hdr_l (time);
266 image_get_hdr_l (size);
267 image_get_hdr_l (load);
268 image_get_hdr_l (ep);
269 image_get_hdr_l (dcrc);
271 #define image_get_hdr_b(f) \
272 static inline uint8_t image_get_##f(image_header_t *hdr) \
274 return hdr->ih_##f; \
276 image_get_hdr_b (os);
277 image_get_hdr_b (arch);
278 image_get_hdr_b (type);
279 image_get_hdr_b (comp);
281 static inline char *image_get_name (image_header_t *hdr)
283 return (char *)hdr->ih_name;
286 static inline uint32_t image_get_data_size (image_header_t *hdr)
288 return image_get_size (hdr);
292 * image_get_data - get image payload start address
295 * image_get_data() returns address of the image payload. For single
296 * component images it is image data start. For multi component
297 * images it points to the null terminated table of sub-images sizes.
300 * image payload data start address
302 static inline ulong image_get_data (image_header_t *hdr)
304 return ((ulong)hdr + image_get_header_size ());
307 static inline uint32_t image_get_image_size (image_header_t *hdr)
309 return (image_get_size (hdr) + image_get_header_size ());
311 static inline ulong image_get_image_end (image_header_t *hdr)
313 return ((ulong)hdr + image_get_image_size (hdr));
316 #define image_set_hdr_l(f) \
317 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
319 hdr->ih_##f = cpu_to_uimage (val); \
321 image_set_hdr_l (magic);
322 image_set_hdr_l (hcrc);
323 image_set_hdr_l (time);
324 image_set_hdr_l (size);
325 image_set_hdr_l (load);
326 image_set_hdr_l (ep);
327 image_set_hdr_l (dcrc);
329 #define image_set_hdr_b(f) \
330 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
334 image_set_hdr_b (os);
335 image_set_hdr_b (arch);
336 image_set_hdr_b (type);
337 image_set_hdr_b (comp);
339 static inline void image_set_name (image_header_t *hdr, const char *name)
341 strncpy (image_get_name (hdr), name, IH_NMLEN);
344 int image_check_hcrc (image_header_t *hdr);
345 int image_check_dcrc (image_header_t *hdr);
347 int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
348 int getenv_verify (void);
349 int getenv_autostart (void);
350 ulong getenv_bootm_low(void);
351 ulong getenv_bootm_size(void);
352 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
355 static inline int image_check_magic (image_header_t *hdr)
357 return (image_get_magic (hdr) == IH_MAGIC);
359 static inline int image_check_type (image_header_t *hdr, uint8_t type)
361 return (image_get_type (hdr) == type);
363 static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
365 return (image_get_arch (hdr) == arch);
367 static inline int image_check_os (image_header_t *hdr, uint8_t os)
369 return (image_get_os (hdr) == os);
372 ulong image_multi_count (image_header_t *hdr);
373 void image_multi_getimg (image_header_t *hdr, ulong idx,
374 ulong *data, ulong *len);
377 static inline int image_check_target_arch (image_header_t *hdr)
380 if (!image_check_arch (hdr, IH_ARCH_ARM))
381 #elif defined(__avr32__)
382 if (!image_check_arch (hdr, IH_ARCH_AVR32))
383 #elif defined(__bfin__)
384 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
385 #elif defined(__I386__)
386 if (!image_check_arch (hdr, IH_ARCH_I386))
387 #elif defined(__M68K__)
388 if (!image_check_arch (hdr, IH_ARCH_M68K))
389 #elif defined(__microblaze__)
390 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
391 #elif defined(__mips__)
392 if (!image_check_arch (hdr, IH_ARCH_MIPS))
393 #elif defined(__nios__)
394 if (!image_check_arch (hdr, IH_ARCH_NIOS))
395 #elif defined(__nios2__)
396 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
397 #elif defined(__PPC__)
398 if (!image_check_arch (hdr, IH_ARCH_PPC))
399 #elif defined(__sh__)
400 if (!image_check_arch (hdr, IH_ARCH_SH))
402 # error Unknown CPU type
409 void image_print_contents (image_header_t *hdr);
411 /*******************************************************************/
412 /* New uImage format specific code (prefixed with fit_) */
413 /*******************************************************************/
414 #if defined(CONFIG_FIT)
415 inline int fit_parse_conf (const char *spec, ulong addr_curr,
416 ulong *addr, const char **conf_name);
417 inline int fit_parse_subimage (const char *spec, ulong addr_curr,
418 ulong *addr, const char **image_name);
420 #ifdef CONFIG_FIT_VERBOSE
421 #define fit_unsupported(msg) printf ("! %s:%d " \
422 "FIT images not supported for '%s'\n", \
423 __FILE__, __LINE__, (msg))
425 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
426 "FIT images not supported for '%s' " \
427 "- must reset board to recover!\n", \
428 __FILE__, __LINE__, (msg))
430 #define fit_unsupported(msg)
431 #define fit_unsupported_reset(msg)
432 #endif /* CONFIG_FIT_VERBOSE */
433 #endif /* CONFIG_FIT */
434 #endif /* USE_HOSTCC */
436 #endif /* __IMAGE_H__ */