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 ********************************************************************
39 /* new uImage format support enabled on host */
41 #define CONFIG_OF_LIBFDT 1
42 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
47 #include <linux/string.h>
48 #include <asm/u-boot.h>
49 #include <asm/byteorder.h>
51 #endif /* USE_HOSTCC */
53 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
54 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
59 #if defined(CONFIG_FIT)
62 #include <fdt_support.h>
63 #define CONFIG_MD5 /* FIT images need MD5 support */
67 * Operating System Codes
69 #define IH_OS_INVALID 0 /* Invalid OS */
70 #define IH_OS_OPENBSD 1 /* OpenBSD */
71 #define IH_OS_NETBSD 2 /* NetBSD */
72 #define IH_OS_FREEBSD 3 /* FreeBSD */
73 #define IH_OS_4_4BSD 4 /* 4.4BSD */
74 #define IH_OS_LINUX 5 /* Linux */
75 #define IH_OS_SVR4 6 /* SVR4 */
76 #define IH_OS_ESIX 7 /* Esix */
77 #define IH_OS_SOLARIS 8 /* Solaris */
78 #define IH_OS_IRIX 9 /* Irix */
79 #define IH_OS_SCO 10 /* SCO */
80 #define IH_OS_DELL 11 /* Dell */
81 #define IH_OS_NCR 12 /* NCR */
82 #define IH_OS_LYNXOS 13 /* LynxOS */
83 #define IH_OS_VXWORKS 14 /* VxWorks */
84 #define IH_OS_PSOS 15 /* pSOS */
85 #define IH_OS_QNX 16 /* QNX */
86 #define IH_OS_U_BOOT 17 /* Firmware */
87 #define IH_OS_RTEMS 18 /* RTEMS */
88 #define IH_OS_ARTOS 19 /* ARTOS */
89 #define IH_OS_UNITY 20 /* Unity OS */
90 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
93 * CPU Architecture Codes (supported by Linux)
95 #define IH_ARCH_INVALID 0 /* Invalid CPU */
96 #define IH_ARCH_ALPHA 1 /* Alpha */
97 #define IH_ARCH_ARM 2 /* ARM */
98 #define IH_ARCH_I386 3 /* Intel x86 */
99 #define IH_ARCH_IA64 4 /* IA64 */
100 #define IH_ARCH_MIPS 5 /* MIPS */
101 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
102 #define IH_ARCH_PPC 7 /* PowerPC */
103 #define IH_ARCH_S390 8 /* IBM S390 */
104 #define IH_ARCH_SH 9 /* SuperH */
105 #define IH_ARCH_SPARC 10 /* Sparc */
106 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
107 #define IH_ARCH_M68K 12 /* M68K */
108 #define IH_ARCH_NIOS 13 /* Nios-32 */
109 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
110 #define IH_ARCH_NIOS2 15 /* Nios-II */
111 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
112 #define IH_ARCH_AVR32 17 /* AVR32 */
113 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
118 * "Standalone Programs" are directly runnable in the environment
119 * provided by U-Boot; it is expected that (if they behave
120 * well) you can continue to work in U-Boot after return from
121 * the Standalone Program.
122 * "OS Kernel Images" are usually images of some Embedded OS which
123 * will take over control completely. Usually these programs
124 * will install their own set of exception handlers, device
125 * drivers, set up the MMU, etc. - this means, that you cannot
126 * expect to re-enter U-Boot except by resetting the CPU.
127 * "RAMDisk Images" are more or less just data blocks, and their
128 * parameters (address, size) are passed to an OS kernel that is
130 * "Multi-File Images" contain several images, typically an OS
131 * (Linux) kernel image and one or more data images like
132 * RAMDisks. This construct is useful for instance when you want
133 * to boot over the network using BOOTP etc., where the boot
134 * server provides just a single image file, but you want to get
135 * for instance an OS kernel and a RAMDisk image.
137 * "Multi-File Images" start with a list of image sizes, each
138 * image size (in bytes) specified by an "uint32_t" in network
139 * byte order. This list is terminated by an "(uint32_t)0".
140 * Immediately after the terminating 0 follow the images, one by
141 * one, all aligned on "uint32_t" boundaries (size rounded up to
142 * a multiple of 4 bytes - except for the last file).
144 * "Firmware Images" are binary images containing firmware (like
145 * U-Boot or FPGA images) which usually will be programmed to
148 * "Script files" are command sequences that will be executed by
149 * U-Boot's command interpreter; this feature is especially
150 * useful when you configure U-Boot to use a real shell (hush)
151 * as command interpreter (=> Shell Scripts).
154 #define IH_TYPE_INVALID 0 /* Invalid Image */
155 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
156 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
157 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
158 #define IH_TYPE_MULTI 4 /* Multi-File Image */
159 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
160 #define IH_TYPE_SCRIPT 6 /* Script file */
161 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
162 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
167 #define IH_COMP_NONE 0 /* No Compression Used */
168 #define IH_COMP_GZIP 1 /* gzip Compression Used */
169 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
170 #define IH_COMP_LZMA 3 /* lzma Compression Used */
172 #define IH_MAGIC 0x27051956 /* Image Magic Number */
173 #define IH_NMLEN 32 /* Image Name Length */
176 * Legacy format image header,
177 * all data in network byte order (aka natural aka bigendian).
179 typedef struct image_header {
180 uint32_t ih_magic; /* Image Header Magic Number */
181 uint32_t ih_hcrc; /* Image Header CRC Checksum */
182 uint32_t ih_time; /* Image Creation Timestamp */
183 uint32_t ih_size; /* Image Data Size */
184 uint32_t ih_load; /* Data Load Address */
185 uint32_t ih_ep; /* Entry Point Address */
186 uint32_t ih_dcrc; /* Image Data CRC Checksum */
187 uint8_t ih_os; /* Operating System */
188 uint8_t ih_arch; /* CPU architecture */
189 uint8_t ih_type; /* Image Type */
190 uint8_t ih_comp; /* Compression Type */
191 uint8_t ih_name[IH_NMLEN]; /* Image Name */
194 typedef struct image_info {
195 ulong start, end; /* start/end of blob */
196 ulong image_start, image_len; /* start of image within blob, len of image */
197 ulong load; /* load addr for the image */
198 uint8_t comp, type, os; /* compression, type of image, os type */
202 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
205 typedef struct bootm_headers {
207 * Legacy os image header, if it is a multi component image
208 * then boot_get_ramdisk() and get_fdt() will attempt to get
209 * data from second and third component accordingly.
211 image_header_t *legacy_hdr_os; /* image header pointer */
212 image_header_t legacy_hdr_os_copy; /* header copy */
213 ulong legacy_hdr_valid;
215 #if defined(CONFIG_FIT)
216 const char *fit_uname_cfg; /* configuration node unit name */
218 void *fit_hdr_os; /* os FIT image header */
219 const char *fit_uname_os; /* os subimage node unit name */
220 int fit_noffset_os; /* os subimage node offset */
222 void *fit_hdr_rd; /* init ramdisk FIT image header */
223 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
224 int fit_noffset_rd; /* init ramdisk subimage node offset */
226 #if defined(CONFIG_PPC)
227 void *fit_hdr_fdt; /* FDT blob FIT image header */
228 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
229 int fit_noffset_fdt;/* FDT blob subimage node offset */
233 image_info_t os; /* os image info */
234 ulong ep; /* entry point of OS */
236 ulong rd_start, rd_end;/* ramdisk start/end */
238 #ifdef CONFIG_OF_LIBFDT
239 char *ft_addr; /* flat dev tree address */
241 ulong ft_len; /* length of flat device tree */
243 int verify; /* getenv("verify")[0] != 'n' */
244 int valid; /* set to 1 if we've set values in the header */
246 struct lmb lmb; /* for memory mgmt */
251 * Some systems (for example LWMON) have very short watchdog periods;
252 * we must make sure to split long operations like memmove() or
253 * checksum calculations into reasonable chunks.
256 #define CHUNKSZ (64 * 1024)
259 #ifndef CHUNKSZ_CRC32
260 #define CHUNKSZ_CRC32 (64 * 1024)
264 #define CHUNKSZ_MD5 (64 * 1024)
268 #define CHUNKSZ_SHA1 (64 * 1024)
271 #define uimage_to_cpu(x) ntohl(x)
272 #define cpu_to_uimage(x) htonl(x)
274 const char *genimg_get_os_name (uint8_t os);
275 const char *genimg_get_arch_name (uint8_t arch);
276 const char *genimg_get_type_name (uint8_t type);
277 const char *genimg_get_comp_name (uint8_t comp);
278 int genimg_get_os_id (const char *name);
279 int genimg_get_arch_id (const char *name);
280 int genimg_get_type_id (const char *name);
281 int genimg_get_comp_id (const char *name);
284 /* Image format types, returned by _get_format() routine */
285 #define IMAGE_FORMAT_INVALID 0x00
286 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
287 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
289 int genimg_get_format (void *img_addr);
290 int genimg_has_config (bootm_headers_t *images);
291 ulong genimg_get_image (ulong img_addr);
293 int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
294 uint8_t arch, ulong *rd_start, ulong *rd_end);
297 #ifdef CONFIG_OF_LIBFDT
298 int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images,
299 char **of_flat_tree, ulong *of_size);
300 int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base,
301 char **of_flat_tree, ulong *of_size);
304 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
305 int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
306 ulong *initrd_start, ulong *initrd_end);
308 int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
310 int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
311 #endif /* CONFIG_PPC || CONFIG_M68K */
312 #endif /* !USE_HOSTCC */
314 /*******************************************************************/
315 /* Legacy format specific code (prefixed with image_) */
316 /*******************************************************************/
317 static inline uint32_t image_get_header_size (void)
319 return (sizeof (image_header_t));
322 #define image_get_hdr_l(f) \
323 static inline uint32_t image_get_##f(image_header_t *hdr) \
325 return uimage_to_cpu (hdr->ih_##f); \
327 image_get_hdr_l (magic);
328 image_get_hdr_l (hcrc);
329 image_get_hdr_l (time);
330 image_get_hdr_l (size);
331 image_get_hdr_l (load);
332 image_get_hdr_l (ep);
333 image_get_hdr_l (dcrc);
335 #define image_get_hdr_b(f) \
336 static inline uint8_t image_get_##f(image_header_t *hdr) \
338 return hdr->ih_##f; \
340 image_get_hdr_b (os);
341 image_get_hdr_b (arch);
342 image_get_hdr_b (type);
343 image_get_hdr_b (comp);
345 static inline char *image_get_name (image_header_t *hdr)
347 return (char *)hdr->ih_name;
350 static inline uint32_t image_get_data_size (image_header_t *hdr)
352 return image_get_size (hdr);
356 * image_get_data - get image payload start address
359 * image_get_data() returns address of the image payload. For single
360 * component images it is image data start. For multi component
361 * images it points to the null terminated table of sub-images sizes.
364 * image payload data start address
366 static inline ulong image_get_data (image_header_t *hdr)
368 return ((ulong)hdr + image_get_header_size ());
371 static inline uint32_t image_get_image_size (image_header_t *hdr)
373 return (image_get_size (hdr) + image_get_header_size ());
375 static inline ulong image_get_image_end (image_header_t *hdr)
377 return ((ulong)hdr + image_get_image_size (hdr));
380 #define image_set_hdr_l(f) \
381 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
383 hdr->ih_##f = cpu_to_uimage (val); \
385 image_set_hdr_l (magic);
386 image_set_hdr_l (hcrc);
387 image_set_hdr_l (time);
388 image_set_hdr_l (size);
389 image_set_hdr_l (load);
390 image_set_hdr_l (ep);
391 image_set_hdr_l (dcrc);
393 #define image_set_hdr_b(f) \
394 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
398 image_set_hdr_b (os);
399 image_set_hdr_b (arch);
400 image_set_hdr_b (type);
401 image_set_hdr_b (comp);
403 static inline void image_set_name (image_header_t *hdr, const char *name)
405 strncpy (image_get_name (hdr), name, IH_NMLEN);
408 int image_check_hcrc (image_header_t *hdr);
409 int image_check_dcrc (image_header_t *hdr);
411 int getenv_yesno (char *var);
412 ulong getenv_bootm_low(void);
413 phys_size_t getenv_bootm_size(void);
414 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
417 static inline int image_check_magic (image_header_t *hdr)
419 return (image_get_magic (hdr) == IH_MAGIC);
421 static inline int image_check_type (image_header_t *hdr, uint8_t type)
423 return (image_get_type (hdr) == type);
425 static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
427 return (image_get_arch (hdr) == arch);
429 static inline int image_check_os (image_header_t *hdr, uint8_t os)
431 return (image_get_os (hdr) == os);
434 ulong image_multi_count (image_header_t *hdr);
435 void image_multi_getimg (image_header_t *hdr, ulong idx,
436 ulong *data, ulong *len);
438 void image_print_contents (image_header_t *hdr);
441 static inline int image_check_target_arch (image_header_t *hdr)
444 if (!image_check_arch (hdr, IH_ARCH_ARM))
445 #elif defined(__avr32__)
446 if (!image_check_arch (hdr, IH_ARCH_AVR32))
447 #elif defined(__bfin__)
448 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
449 #elif defined(__I386__)
450 if (!image_check_arch (hdr, IH_ARCH_I386))
451 #elif defined(__M68K__)
452 if (!image_check_arch (hdr, IH_ARCH_M68K))
453 #elif defined(__microblaze__)
454 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
455 #elif defined(__mips__)
456 if (!image_check_arch (hdr, IH_ARCH_MIPS))
457 #elif defined(__nios__)
458 if (!image_check_arch (hdr, IH_ARCH_NIOS))
459 #elif defined(__nios2__)
460 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
461 #elif defined(__PPC__)
462 if (!image_check_arch (hdr, IH_ARCH_PPC))
463 #elif defined(__sh__)
464 if (!image_check_arch (hdr, IH_ARCH_SH))
465 #elif defined(__sparc__)
466 if (!image_check_arch (hdr, IH_ARCH_SPARC))
468 # error Unknown CPU type
474 #endif /* USE_HOSTCC */
476 /*******************************************************************/
477 /* New uImage format specific code (prefixed with fit_) */
478 /*******************************************************************/
479 #if defined(CONFIG_FIT)
481 #define FIT_IMAGES_PATH "/images"
482 #define FIT_CONFS_PATH "/configurations"
485 #define FIT_HASH_NODENAME "hash"
486 #define FIT_ALGO_PROP "algo"
487 #define FIT_VALUE_PROP "value"
490 #define FIT_DATA_PROP "data"
491 #define FIT_TIMESTAMP_PROP "timestamp"
492 #define FIT_DESC_PROP "description"
493 #define FIT_ARCH_PROP "arch"
494 #define FIT_TYPE_PROP "type"
495 #define FIT_OS_PROP "os"
496 #define FIT_COMP_PROP "compression"
497 #define FIT_ENTRY_PROP "entry"
498 #define FIT_LOAD_PROP "load"
500 /* configuration node */
501 #define FIT_KERNEL_PROP "kernel"
502 #define FIT_RAMDISK_PROP "ramdisk"
503 #define FIT_FDT_PROP "fdt"
504 #define FIT_DEFAULT_PROP "default"
506 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
508 /* cmdline argument format parsing */
509 inline int fit_parse_conf (const char *spec, ulong addr_curr,
510 ulong *addr, const char **conf_name);
511 inline int fit_parse_subimage (const char *spec, ulong addr_curr,
512 ulong *addr, const char **image_name);
514 void fit_print_contents (const void *fit);
515 void fit_image_print (const void *fit, int noffset, const char *p);
516 void fit_image_print_hash (const void *fit, int noffset, const char *p);
519 * fit_get_end - get FIT image size
520 * @fit: pointer to the FIT format image header
523 * size of the FIT image (blob) in memory
525 static inline ulong fit_get_size (const void *fit)
527 return fdt_totalsize (fit);
531 * fit_get_end - get FIT image end
532 * @fit: pointer to the FIT format image header
535 * end address of the FIT image (blob) in memory
537 static inline ulong fit_get_end (const void *fit)
539 return (ulong)fit + fdt_totalsize (fit);
543 * fit_get_name - get FIT node name
544 * @fit: pointer to the FIT format image header
548 * pointer to node name, on success
550 static inline const char *fit_get_name (const void *fit_hdr,
551 int noffset, int *len)
553 return fdt_get_name (fit_hdr, noffset, len);
556 int fit_get_desc (const void *fit, int noffset, char **desc);
557 int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
559 int fit_image_get_node (const void *fit, const char *image_uname);
560 int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
561 int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
562 int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
563 int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
564 int fit_image_get_load (const void *fit, int noffset, ulong *load);
565 int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
566 int fit_image_get_data (const void *fit, int noffset,
567 const void **data, size_t *size);
569 int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
570 int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
573 int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
574 int fit_set_hashes (void *fit);
575 int fit_image_set_hashes (void *fit, int image_noffset);
576 int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
579 int fit_image_check_hashes (const void *fit, int noffset);
580 int fit_all_image_check_hashes (const void *fit);
581 int fit_image_check_os (const void *fit, int noffset, uint8_t os);
582 int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
583 int fit_image_check_type (const void *fit, int noffset, uint8_t type);
584 int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
585 int fit_check_format (const void *fit);
587 int fit_conf_get_node (const void *fit, const char *conf_uname);
588 int fit_conf_get_kernel_node (const void *fit, int noffset);
589 int fit_conf_get_ramdisk_node (const void *fit, int noffset);
590 int fit_conf_get_fdt_node (const void *fit, int noffset);
592 void fit_conf_print (const void *fit, int noffset, const char *p);
595 static inline int fit_image_check_target_arch (const void *fdt, int node)
598 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
599 #elif defined(__avr32__)
600 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
601 #elif defined(__bfin__)
602 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
603 #elif defined(__I386__)
604 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
605 #elif defined(__M68K__)
606 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
607 #elif defined(__microblaze__)
608 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
609 #elif defined(__mips__)
610 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
611 #elif defined(__nios__)
612 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
613 #elif defined(__nios2__)
614 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
615 #elif defined(__PPC__)
616 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
617 #elif defined(__sh__)
618 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
619 #elif defined(__sparc__)
620 if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC))
622 # error Unknown CPU type
628 #endif /* USE_HOSTCC */
630 #ifdef CONFIG_FIT_VERBOSE
631 #define fit_unsupported(msg) printf ("! %s:%d " \
632 "FIT images not supported for '%s'\n", \
633 __FILE__, __LINE__, (msg))
635 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
636 "FIT images not supported for '%s' " \
637 "- must reset board to recover!\n", \
638 __FILE__, __LINE__, (msg))
640 #define fit_unsupported(msg)
641 #define fit_unsupported_reset(msg)
642 #endif /* CONFIG_FIT_VERBOSE */
643 #endif /* CONFIG_FIT */
645 #endif /* __IMAGE_H__ */