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 on target
45 * To be moved to board configuration file */
47 #define CONFIG_OF_LIBFDT 1
48 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
52 /* new uImage format support enabled on host */
54 #define CONFIG_OF_LIBFDT 1
55 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
57 #endif /* USE_HOSTCC */
59 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
60 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
63 #if defined(CONFIG_FIT)
66 #include <fdt_support.h>
70 * Operating System Codes
72 #define IH_OS_INVALID 0 /* Invalid OS */
73 #define IH_OS_OPENBSD 1 /* OpenBSD */
74 #define IH_OS_NETBSD 2 /* NetBSD */
75 #define IH_OS_FREEBSD 3 /* FreeBSD */
76 #define IH_OS_4_4BSD 4 /* 4.4BSD */
77 #define IH_OS_LINUX 5 /* Linux */
78 #define IH_OS_SVR4 6 /* SVR4 */
79 #define IH_OS_ESIX 7 /* Esix */
80 #define IH_OS_SOLARIS 8 /* Solaris */
81 #define IH_OS_IRIX 9 /* Irix */
82 #define IH_OS_SCO 10 /* SCO */
83 #define IH_OS_DELL 11 /* Dell */
84 #define IH_OS_NCR 12 /* NCR */
85 #define IH_OS_LYNXOS 13 /* LynxOS */
86 #define IH_OS_VXWORKS 14 /* VxWorks */
87 #define IH_OS_PSOS 15 /* pSOS */
88 #define IH_OS_QNX 16 /* QNX */
89 #define IH_OS_U_BOOT 17 /* Firmware */
90 #define IH_OS_RTEMS 18 /* RTEMS */
91 #define IH_OS_ARTOS 19 /* ARTOS */
92 #define IH_OS_UNITY 20 /* Unity OS */
95 * CPU Architecture Codes (supported by Linux)
97 #define IH_ARCH_INVALID 0 /* Invalid CPU */
98 #define IH_ARCH_ALPHA 1 /* Alpha */
99 #define IH_ARCH_ARM 2 /* ARM */
100 #define IH_ARCH_I386 3 /* Intel x86 */
101 #define IH_ARCH_IA64 4 /* IA64 */
102 #define IH_ARCH_MIPS 5 /* MIPS */
103 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
104 #define IH_ARCH_PPC 7 /* PowerPC */
105 #define IH_ARCH_S390 8 /* IBM S390 */
106 #define IH_ARCH_SH 9 /* SuperH */
107 #define IH_ARCH_SPARC 10 /* Sparc */
108 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
109 #define IH_ARCH_M68K 12 /* M68K */
110 #define IH_ARCH_NIOS 13 /* Nios-32 */
111 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
112 #define IH_ARCH_NIOS2 15 /* Nios-II */
113 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
114 #define IH_ARCH_AVR32 17 /* AVR32 */
115 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
120 * "Standalone Programs" are directly runnable in the environment
121 * provided by U-Boot; it is expected that (if they behave
122 * well) you can continue to work in U-Boot after return from
123 * the Standalone Program.
124 * "OS Kernel Images" are usually images of some Embedded OS which
125 * will take over control completely. Usually these programs
126 * will install their own set of exception handlers, device
127 * drivers, set up the MMU, etc. - this means, that you cannot
128 * expect to re-enter U-Boot except by resetting the CPU.
129 * "RAMDisk Images" are more or less just data blocks, and their
130 * parameters (address, size) are passed to an OS kernel that is
132 * "Multi-File Images" contain several images, typically an OS
133 * (Linux) kernel image and one or more data images like
134 * RAMDisks. This construct is useful for instance when you want
135 * to boot over the network using BOOTP etc., where the boot
136 * server provides just a single image file, but you want to get
137 * for instance an OS kernel and a RAMDisk image.
139 * "Multi-File Images" start with a list of image sizes, each
140 * image size (in bytes) specified by an "uint32_t" in network
141 * byte order. This list is terminated by an "(uint32_t)0".
142 * Immediately after the terminating 0 follow the images, one by
143 * one, all aligned on "uint32_t" boundaries (size rounded up to
144 * a multiple of 4 bytes - except for the last file).
146 * "Firmware Images" are binary images containing firmware (like
147 * U-Boot or FPGA images) which usually will be programmed to
150 * "Script files" are command sequences that will be executed by
151 * U-Boot's command interpreter; this feature is especially
152 * useful when you configure U-Boot to use a real shell (hush)
153 * as command interpreter (=> Shell Scripts).
156 #define IH_TYPE_INVALID 0 /* Invalid Image */
157 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
158 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
159 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
160 #define IH_TYPE_MULTI 4 /* Multi-File Image */
161 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
162 #define IH_TYPE_SCRIPT 6 /* Script file */
163 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
164 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
169 #define IH_COMP_NONE 0 /* No Compression Used */
170 #define IH_COMP_GZIP 1 /* gzip Compression Used */
171 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
173 #define IH_MAGIC 0x27051956 /* Image Magic Number */
174 #define IH_NMLEN 32 /* Image Name Length */
177 * Legacy format image header,
178 * all data in network byte order (aka natural aka bigendian).
180 typedef struct image_header {
181 uint32_t ih_magic; /* Image Header Magic Number */
182 uint32_t ih_hcrc; /* Image Header CRC Checksum */
183 uint32_t ih_time; /* Image Creation Timestamp */
184 uint32_t ih_size; /* Image Data Size */
185 uint32_t ih_load; /* Data Load Address */
186 uint32_t ih_ep; /* Entry Point Address */
187 uint32_t ih_dcrc; /* Image Data CRC Checksum */
188 uint8_t ih_os; /* Operating System */
189 uint8_t ih_arch; /* CPU architecture */
190 uint8_t ih_type; /* Image Type */
191 uint8_t ih_comp; /* Compression Type */
192 uint8_t ih_name[IH_NMLEN]; /* Image Name */
196 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
199 typedef struct bootm_headers {
201 * Legacy os image header, if it is a multi component image
202 * then boot_get_ramdisk() and get_fdt() will attempt to get
203 * data from second and third component accordingly.
205 image_header_t *legacy_hdr_os;
206 ulong legacy_hdr_valid;
208 #if defined(CONFIG_FIT)
209 void *fit_hdr_os; /* os FIT image header */
210 const char *fit_uname_os; /* os subimage node unit name */
212 void *fit_hdr_rd; /* init ramdisk FIT image header */
213 const char *fit_uname_rd; /* init ramdisk node unit name */
215 #if defined(CONFIG_PPC)
216 void *fit_hdr_fdt; /* FDT blob FIT image header */
217 const char *fit_uname_fdt; /* FDT blob node unit name */
219 int verify; /* getenv("verify")[0] != 'n' */
220 int autostart; /* getenv("autostart")[0] != 'n' */
221 struct lmb *lmb; /* for memory mgmt */
226 * Some systems (for example LWMON) have very short watchdog periods;
227 * we must make sure to split long operations like memmove() or
228 * crc32() into reasonable chunks.
230 #define CHUNKSZ (64 * 1024)
232 #define uimage_to_cpu(x) ntohl(x)
233 #define cpu_to_uimage(x) htonl(x)
235 const char *genimg_get_os_name (uint8_t os);
236 const char *genimg_get_arch_name (uint8_t arch);
237 const char *genimg_get_type_name (uint8_t type);
238 const char *genimg_get_comp_name (uint8_t comp);
239 int genimg_get_os_id (const char *name);
240 int genimg_get_arch_id (const char *name);
241 int genimg_get_type_id (const char *name);
242 int genimg_get_comp_id (const char *name);
245 /* Image format types, returned by _get_format() routine */
246 #define IMAGE_FORMAT_INVALID 0x00
247 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
248 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
250 int genimg_get_format (void *img_addr);
251 ulong genimg_get_image (ulong img_addr);
253 int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
254 uint8_t arch, ulong *rd_start, ulong *rd_end);
256 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
257 int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
258 ulong *initrd_start, ulong *initrd_end);
260 int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
262 int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
263 #endif /* CONFIG_PPC || CONFIG_M68K */
264 #endif /* !USE_HOSTCC */
266 /*******************************************************************/
267 /* Legacy format specific code (prefixed with image_) */
268 /*******************************************************************/
269 static inline uint32_t image_get_header_size (void)
271 return (sizeof (image_header_t));
274 #define image_get_hdr_l(f) \
275 static inline uint32_t image_get_##f(image_header_t *hdr) \
277 return uimage_to_cpu (hdr->ih_##f); \
279 image_get_hdr_l (magic);
280 image_get_hdr_l (hcrc);
281 image_get_hdr_l (time);
282 image_get_hdr_l (size);
283 image_get_hdr_l (load);
284 image_get_hdr_l (ep);
285 image_get_hdr_l (dcrc);
287 #define image_get_hdr_b(f) \
288 static inline uint8_t image_get_##f(image_header_t *hdr) \
290 return hdr->ih_##f; \
292 image_get_hdr_b (os);
293 image_get_hdr_b (arch);
294 image_get_hdr_b (type);
295 image_get_hdr_b (comp);
297 static inline char *image_get_name (image_header_t *hdr)
299 return (char *)hdr->ih_name;
302 static inline uint32_t image_get_data_size (image_header_t *hdr)
304 return image_get_size (hdr);
308 * image_get_data - get image payload start address
311 * image_get_data() returns address of the image payload. For single
312 * component images it is image data start. For multi component
313 * images it points to the null terminated table of sub-images sizes.
316 * image payload data start address
318 static inline ulong image_get_data (image_header_t *hdr)
320 return ((ulong)hdr + image_get_header_size ());
323 static inline uint32_t image_get_image_size (image_header_t *hdr)
325 return (image_get_size (hdr) + image_get_header_size ());
327 static inline ulong image_get_image_end (image_header_t *hdr)
329 return ((ulong)hdr + image_get_image_size (hdr));
332 #define image_set_hdr_l(f) \
333 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
335 hdr->ih_##f = cpu_to_uimage (val); \
337 image_set_hdr_l (magic);
338 image_set_hdr_l (hcrc);
339 image_set_hdr_l (time);
340 image_set_hdr_l (size);
341 image_set_hdr_l (load);
342 image_set_hdr_l (ep);
343 image_set_hdr_l (dcrc);
345 #define image_set_hdr_b(f) \
346 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
350 image_set_hdr_b (os);
351 image_set_hdr_b (arch);
352 image_set_hdr_b (type);
353 image_set_hdr_b (comp);
355 static inline void image_set_name (image_header_t *hdr, const char *name)
357 strncpy (image_get_name (hdr), name, IH_NMLEN);
360 int image_check_hcrc (image_header_t *hdr);
361 int image_check_dcrc (image_header_t *hdr);
363 int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
364 int getenv_verify (void);
365 int getenv_autostart (void);
366 ulong getenv_bootm_low(void);
367 ulong getenv_bootm_size(void);
368 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
371 static inline int image_check_magic (image_header_t *hdr)
373 return (image_get_magic (hdr) == IH_MAGIC);
375 static inline int image_check_type (image_header_t *hdr, uint8_t type)
377 return (image_get_type (hdr) == type);
379 static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
381 return (image_get_arch (hdr) == arch);
383 static inline int image_check_os (image_header_t *hdr, uint8_t os)
385 return (image_get_os (hdr) == os);
388 ulong image_multi_count (image_header_t *hdr);
389 void image_multi_getimg (image_header_t *hdr, ulong idx,
390 ulong *data, ulong *len);
392 inline void image_print_contents (image_header_t *hdr);
393 inline void image_print_contents_noindent (image_header_t *hdr);
396 static inline int image_check_target_arch (image_header_t *hdr)
399 if (!image_check_arch (hdr, IH_ARCH_ARM))
400 #elif defined(__avr32__)
401 if (!image_check_arch (hdr, IH_ARCH_AVR32))
402 #elif defined(__bfin__)
403 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
404 #elif defined(__I386__)
405 if (!image_check_arch (hdr, IH_ARCH_I386))
406 #elif defined(__M68K__)
407 if (!image_check_arch (hdr, IH_ARCH_M68K))
408 #elif defined(__microblaze__)
409 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
410 #elif defined(__mips__)
411 if (!image_check_arch (hdr, IH_ARCH_MIPS))
412 #elif defined(__nios__)
413 if (!image_check_arch (hdr, IH_ARCH_NIOS))
414 #elif defined(__nios2__)
415 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
416 #elif defined(__PPC__)
417 if (!image_check_arch (hdr, IH_ARCH_PPC))
418 #elif defined(__sh__)
419 if (!image_check_arch (hdr, IH_ARCH_SH))
421 # error Unknown CPU type
427 #endif /* USE_HOSTCC */
429 /*******************************************************************/
430 /* New uImage format specific code (prefixed with fit_) */
431 /*******************************************************************/
432 #if defined(CONFIG_FIT)
434 #define FIT_IMAGES_PATH "/images"
435 #define FIT_CONFS_PATH "/configurations"
438 #define FIT_HASH_NODENAME "hash"
439 #define FIT_ALGO_PROP "algo"
440 #define FIT_VALUE_PROP "value"
443 #define FIT_DATA_PROP "data"
444 #define FIT_TIMESTAMP_PROP "timestamp"
445 #define FIT_DESC_PROP "description"
446 #define FIT_ARCH_PROP "arch"
447 #define FIT_TYPE_PROP "type"
448 #define FIT_OS_PROP "os"
449 #define FIT_COMP_PROP "compression"
450 #define FIT_ENTRY_PROP "entry"
451 #define FIT_LOAD_PROP "load"
453 /* configuration node */
454 #define FIT_KERNEL_PROP "kernel"
455 #define FIT_RAMDISK_PROP "ramdisk"
456 #define FIT_FDT_PROP "fdt"
457 #define FIT_DEFAULT_PROP "default"
459 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
461 /* cmdline argument format parsing */
462 inline int fit_parse_conf (const char *spec, ulong addr_curr,
463 ulong *addr, const char **conf_name);
464 inline int fit_parse_subimage (const char *spec, ulong addr_curr,
465 ulong *addr, const char **image_name);
467 inline void fit_print_contents (const void *fit);
468 inline void fit_print_contents_noindent (const void *fit);
469 void fit_image_print (const void *fit, int noffset, const char *p);
470 void fit_image_print_hash (const void *fit, int noffset, const char *p);
473 * fit_get_end - get FIT image size
474 * @fit: pointer to the FIT format image header
477 * size of the FIT image (blob) in memory
479 static inline ulong fit_get_size (const void *fit)
481 return fdt_totalsize (fit);
485 * fit_get_end - get FIT image end
486 * @fit: pointer to the FIT format image header
489 * end address of the FIT image (blob) in memory
491 static inline ulong fit_get_end (const void *fit)
493 return (ulong)fit + fdt_totalsize (fit);
497 * fit_get_name - get FIT node name
498 * @fit: pointer to the FIT format image header
502 * pointer to node name, on success
504 static inline const char *fit_get_name (const void *fit_hdr,
505 int noffset, int *len)
507 return fdt_get_name (fit_hdr, noffset, len);
510 int fit_get_desc (const void *fit, int noffset, char **desc);
511 int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
513 int fit_image_get_node (const void *fit, const char *image_uname);
514 int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
515 int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
516 int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
517 int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
518 int fit_image_get_load (const void *fit, int noffset, ulong *load);
519 int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
520 int fit_image_get_data (const void *fit, int noffset,
521 const void **data, size_t *size);
523 int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
524 int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
527 int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
528 int fit_set_hashes (void *fit);
529 int fit_image_set_hashes (void *fit, int image_noffset);
530 int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
533 int fit_image_check_hashes (const void *fit, int noffset);
534 int fit_image_check_os (const void *fit, int noffset, uint8_t os);
535 int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
536 int fit_image_check_type (const void *fit, int noffset, uint8_t type);
537 int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
538 int fit_check_format (const void *fit);
540 int fit_conf_get_node (const void *fit, const char *conf_uname);
541 int fit_conf_get_kernel_node (const void *fit, int noffset);
542 int fit_conf_get_ramdisk_node (const void *fit, int noffset);
543 int fit_conf_get_fdt_node (const void *fit, int noffset);
545 void fit_conf_print (const void *fit, int noffset, const char *p);
548 static inline int fit_image_check_target_arch (const void *fdt, int node)
551 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
552 #elif defined(__avr32__)
553 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
554 #elif defined(__bfin__)
555 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
556 #elif defined(__I386__)
557 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
558 #elif defined(__M68K__)
559 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
560 #elif defined(__microblaze__)
561 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
562 #elif defined(__mips__)
563 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
564 #elif defined(__nios__)
565 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
566 #elif defined(__nios2__)
567 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
568 #elif defined(__PPC__)
569 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
570 #elif defined(__sh__)
571 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
573 # error Unknown CPU type
579 #endif /* USE_HOSTCC */
581 #ifdef CONFIG_FIT_VERBOSE
582 #define fit_unsupported(msg) printf ("! %s:%d " \
583 "FIT images not supported for '%s'\n", \
584 __FILE__, __LINE__, (msg))
586 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
587 "FIT images not supported for '%s' " \
588 "- must reset board to recover!\n", \
589 __FILE__, __LINE__, (msg))
591 #define fit_unsupported(msg)
592 #define fit_unsupported_reset(msg)
593 #endif /* CONFIG_FIT_VERBOSE */
594 #endif /* CONFIG_FIT */
596 #endif /* __IMAGE_H__ */