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>
46 /* new uImage format support enabled on host */
48 #define CONFIG_OF_LIBFDT 1
49 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
51 #endif /* USE_HOSTCC */
53 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
54 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
57 #if defined(CONFIG_FIT)
60 #include <fdt_support.h>
61 #define CONFIG_MD5 /* FIT images need MD5 support */
65 * Operating System Codes
67 #define IH_OS_INVALID 0 /* Invalid OS */
68 #define IH_OS_OPENBSD 1 /* OpenBSD */
69 #define IH_OS_NETBSD 2 /* NetBSD */
70 #define IH_OS_FREEBSD 3 /* FreeBSD */
71 #define IH_OS_4_4BSD 4 /* 4.4BSD */
72 #define IH_OS_LINUX 5 /* Linux */
73 #define IH_OS_SVR4 6 /* SVR4 */
74 #define IH_OS_ESIX 7 /* Esix */
75 #define IH_OS_SOLARIS 8 /* Solaris */
76 #define IH_OS_IRIX 9 /* Irix */
77 #define IH_OS_SCO 10 /* SCO */
78 #define IH_OS_DELL 11 /* Dell */
79 #define IH_OS_NCR 12 /* NCR */
80 #define IH_OS_LYNXOS 13 /* LynxOS */
81 #define IH_OS_VXWORKS 14 /* VxWorks */
82 #define IH_OS_PSOS 15 /* pSOS */
83 #define IH_OS_QNX 16 /* QNX */
84 #define IH_OS_U_BOOT 17 /* Firmware */
85 #define IH_OS_RTEMS 18 /* RTEMS */
86 #define IH_OS_ARTOS 19 /* ARTOS */
87 #define IH_OS_UNITY 20 /* Unity OS */
90 * CPU Architecture Codes (supported by Linux)
92 #define IH_ARCH_INVALID 0 /* Invalid CPU */
93 #define IH_ARCH_ALPHA 1 /* Alpha */
94 #define IH_ARCH_ARM 2 /* ARM */
95 #define IH_ARCH_I386 3 /* Intel x86 */
96 #define IH_ARCH_IA64 4 /* IA64 */
97 #define IH_ARCH_MIPS 5 /* MIPS */
98 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
99 #define IH_ARCH_PPC 7 /* PowerPC */
100 #define IH_ARCH_S390 8 /* IBM S390 */
101 #define IH_ARCH_SH 9 /* SuperH */
102 #define IH_ARCH_SPARC 10 /* Sparc */
103 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
104 #define IH_ARCH_M68K 12 /* M68K */
105 #define IH_ARCH_NIOS 13 /* Nios-32 */
106 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
107 #define IH_ARCH_NIOS2 15 /* Nios-II */
108 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
109 #define IH_ARCH_AVR32 17 /* AVR32 */
110 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
115 * "Standalone Programs" are directly runnable in the environment
116 * provided by U-Boot; it is expected that (if they behave
117 * well) you can continue to work in U-Boot after return from
118 * the Standalone Program.
119 * "OS Kernel Images" are usually images of some Embedded OS which
120 * will take over control completely. Usually these programs
121 * will install their own set of exception handlers, device
122 * drivers, set up the MMU, etc. - this means, that you cannot
123 * expect to re-enter U-Boot except by resetting the CPU.
124 * "RAMDisk Images" are more or less just data blocks, and their
125 * parameters (address, size) are passed to an OS kernel that is
127 * "Multi-File Images" contain several images, typically an OS
128 * (Linux) kernel image and one or more data images like
129 * RAMDisks. This construct is useful for instance when you want
130 * to boot over the network using BOOTP etc., where the boot
131 * server provides just a single image file, but you want to get
132 * for instance an OS kernel and a RAMDisk image.
134 * "Multi-File Images" start with a list of image sizes, each
135 * image size (in bytes) specified by an "uint32_t" in network
136 * byte order. This list is terminated by an "(uint32_t)0".
137 * Immediately after the terminating 0 follow the images, one by
138 * one, all aligned on "uint32_t" boundaries (size rounded up to
139 * a multiple of 4 bytes - except for the last file).
141 * "Firmware Images" are binary images containing firmware (like
142 * U-Boot or FPGA images) which usually will be programmed to
145 * "Script files" are command sequences that will be executed by
146 * U-Boot's command interpreter; this feature is especially
147 * useful when you configure U-Boot to use a real shell (hush)
148 * as command interpreter (=> Shell Scripts).
151 #define IH_TYPE_INVALID 0 /* Invalid Image */
152 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
153 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
154 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
155 #define IH_TYPE_MULTI 4 /* Multi-File Image */
156 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
157 #define IH_TYPE_SCRIPT 6 /* Script file */
158 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
159 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
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 */
168 #define IH_MAGIC 0x27051956 /* Image Magic Number */
169 #define IH_NMLEN 32 /* Image Name Length */
172 * Legacy format image header,
173 * all data in network byte order (aka natural aka bigendian).
175 typedef struct image_header
{
176 uint32_t ih_magic
; /* Image Header Magic Number */
177 uint32_t ih_hcrc
; /* Image Header CRC Checksum */
178 uint32_t ih_time
; /* Image Creation Timestamp */
179 uint32_t ih_size
; /* Image Data Size */
180 uint32_t ih_load
; /* Data Load Address */
181 uint32_t ih_ep
; /* Entry Point Address */
182 uint32_t ih_dcrc
; /* Image Data CRC Checksum */
183 uint8_t ih_os
; /* Operating System */
184 uint8_t ih_arch
; /* CPU architecture */
185 uint8_t ih_type
; /* Image Type */
186 uint8_t ih_comp
; /* Compression Type */
187 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
191 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
194 typedef struct bootm_headers
{
196 * Legacy os image header, if it is a multi component image
197 * then boot_get_ramdisk() and get_fdt() will attempt to get
198 * data from second and third component accordingly.
200 image_header_t
*legacy_hdr_os
; /* image header pointer */
201 image_header_t legacy_hdr_os_copy
; /* header copy */
202 ulong legacy_hdr_valid
;
204 #if defined(CONFIG_FIT)
205 const char *fit_uname_cfg
; /* configuration node unit name */
207 void *fit_hdr_os
; /* os FIT image header */
208 const char *fit_uname_os
; /* os subimage node unit name */
209 int fit_noffset_os
; /* os subimage node offset */
211 void *fit_hdr_rd
; /* init ramdisk FIT image header */
212 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
213 int fit_noffset_rd
; /* init ramdisk subimage node offset */
215 #if defined(CONFIG_PPC)
216 void *fit_hdr_fdt
; /* FDT blob FIT image header */
217 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
218 int fit_noffset_fdt
;/* FDT blob subimage node offset */
222 int verify
; /* getenv("verify")[0] != 'n' */
223 struct lmb
*lmb
; /* for memory mgmt */
227 * Some systems (for example LWMON) have very short watchdog periods;
228 * we must make sure to split long operations like memmove() or
229 * checksum calculations into reasonable chunks.
232 #define CHUNKSZ (64 * 1024)
235 #ifndef CHUNKSZ_CRC32
236 #define CHUNKSZ_CRC32 (64 * 1024)
240 #define CHUNKSZ_MD5 (64 * 1024)
244 #define CHUNKSZ_SHA1 (64 * 1024)
247 #define uimage_to_cpu(x) ntohl(x)
248 #define cpu_to_uimage(x) htonl(x)
250 const char *genimg_get_os_name (uint8_t os
);
251 const char *genimg_get_arch_name (uint8_t arch
);
252 const char *genimg_get_type_name (uint8_t type
);
253 const char *genimg_get_comp_name (uint8_t comp
);
254 int genimg_get_os_id (const char *name
);
255 int genimg_get_arch_id (const char *name
);
256 int genimg_get_type_id (const char *name
);
257 int genimg_get_comp_id (const char *name
);
260 /* Image format types, returned by _get_format() routine */
261 #define IMAGE_FORMAT_INVALID 0x00
262 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
263 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
265 int genimg_get_format (void *img_addr
);
266 int genimg_has_config (bootm_headers_t
*images
);
267 ulong
genimg_get_image (ulong img_addr
);
269 int boot_get_ramdisk (int argc
, char *argv
[], bootm_headers_t
*images
,
270 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
272 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
273 int boot_ramdisk_high (struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
274 ulong
*initrd_start
, ulong
*initrd_end
);
276 int boot_get_cmdline (struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
,
278 int boot_get_kbd (struct lmb
*lmb
, bd_t
**kbd
, ulong bootmap_base
);
279 #endif /* CONFIG_PPC || CONFIG_M68K */
280 #endif /* !USE_HOSTCC */
282 /*******************************************************************/
283 /* Legacy format specific code (prefixed with image_) */
284 /*******************************************************************/
285 static inline uint32_t image_get_header_size (void)
287 return (sizeof (image_header_t
));
290 #define image_get_hdr_l(f) \
291 static inline uint32_t image_get_##f(image_header_t *hdr) \
293 return uimage_to_cpu (hdr->ih_##f); \
295 image_get_hdr_l (magic
);
296 image_get_hdr_l (hcrc
);
297 image_get_hdr_l (time
);
298 image_get_hdr_l (size
);
299 image_get_hdr_l (load
);
300 image_get_hdr_l (ep
);
301 image_get_hdr_l (dcrc
);
303 #define image_get_hdr_b(f) \
304 static inline uint8_t image_get_##f(image_header_t *hdr) \
306 return hdr->ih_##f; \
308 image_get_hdr_b (os
);
309 image_get_hdr_b (arch
);
310 image_get_hdr_b (type
);
311 image_get_hdr_b (comp
);
313 static inline char *image_get_name (image_header_t
*hdr
)
315 return (char *)hdr
->ih_name
;
318 static inline uint32_t image_get_data_size (image_header_t
*hdr
)
320 return image_get_size (hdr
);
324 * image_get_data - get image payload start address
327 * image_get_data() returns address of the image payload. For single
328 * component images it is image data start. For multi component
329 * images it points to the null terminated table of sub-images sizes.
332 * image payload data start address
334 static inline ulong
image_get_data (image_header_t
*hdr
)
336 return ((ulong
)hdr
+ image_get_header_size ());
339 static inline uint32_t image_get_image_size (image_header_t
*hdr
)
341 return (image_get_size (hdr
) + image_get_header_size ());
343 static inline ulong
image_get_image_end (image_header_t
*hdr
)
345 return ((ulong
)hdr
+ image_get_image_size (hdr
));
348 #define image_set_hdr_l(f) \
349 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
351 hdr->ih_##f = cpu_to_uimage (val); \
353 image_set_hdr_l (magic
);
354 image_set_hdr_l (hcrc
);
355 image_set_hdr_l (time
);
356 image_set_hdr_l (size
);
357 image_set_hdr_l (load
);
358 image_set_hdr_l (ep
);
359 image_set_hdr_l (dcrc
);
361 #define image_set_hdr_b(f) \
362 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
366 image_set_hdr_b (os
);
367 image_set_hdr_b (arch
);
368 image_set_hdr_b (type
);
369 image_set_hdr_b (comp
);
371 static inline void image_set_name (image_header_t
*hdr
, const char *name
)
373 strncpy (image_get_name (hdr
), name
, IH_NMLEN
);
376 int image_check_hcrc (image_header_t
*hdr
);
377 int image_check_dcrc (image_header_t
*hdr
);
379 int getenv_yesno (char *var
);
380 ulong
getenv_bootm_low(void);
381 phys_size_t
getenv_bootm_size(void);
382 void memmove_wd (void *to
, void *from
, size_t len
, ulong chunksz
);
385 static inline int image_check_magic (image_header_t
*hdr
)
387 return (image_get_magic (hdr
) == IH_MAGIC
);
389 static inline int image_check_type (image_header_t
*hdr
, uint8_t type
)
391 return (image_get_type (hdr
) == type
);
393 static inline int image_check_arch (image_header_t
*hdr
, uint8_t arch
)
395 return (image_get_arch (hdr
) == arch
);
397 static inline int image_check_os (image_header_t
*hdr
, uint8_t os
)
399 return (image_get_os (hdr
) == os
);
402 ulong
image_multi_count (image_header_t
*hdr
);
403 void image_multi_getimg (image_header_t
*hdr
, ulong idx
,
404 ulong
*data
, ulong
*len
);
406 void image_print_contents (image_header_t
*hdr
);
409 static inline int image_check_target_arch (image_header_t
*hdr
)
412 if (!image_check_arch (hdr
, IH_ARCH_ARM
))
413 #elif defined(__avr32__)
414 if (!image_check_arch (hdr
, IH_ARCH_AVR32
))
415 #elif defined(__bfin__)
416 if (!image_check_arch (hdr
, IH_ARCH_BLACKFIN
))
417 #elif defined(__I386__)
418 if (!image_check_arch (hdr
, IH_ARCH_I386
))
419 #elif defined(__M68K__)
420 if (!image_check_arch (hdr
, IH_ARCH_M68K
))
421 #elif defined(__microblaze__)
422 if (!image_check_arch (hdr
, IH_ARCH_MICROBLAZE
))
423 #elif defined(__mips__)
424 if (!image_check_arch (hdr
, IH_ARCH_MIPS
))
425 #elif defined(__nios__)
426 if (!image_check_arch (hdr
, IH_ARCH_NIOS
))
427 #elif defined(__nios2__)
428 if (!image_check_arch (hdr
, IH_ARCH_NIOS2
))
429 #elif defined(__PPC__)
430 if (!image_check_arch (hdr
, IH_ARCH_PPC
))
431 #elif defined(__sh__)
432 if (!image_check_arch (hdr
, IH_ARCH_SH
))
433 #elif defined(__sparc__)
434 if (!image_check_arch (hdr
, IH_ARCH_SPARC
))
436 # error Unknown CPU type
442 #endif /* USE_HOSTCC */
444 /*******************************************************************/
445 /* New uImage format specific code (prefixed with fit_) */
446 /*******************************************************************/
447 #if defined(CONFIG_FIT)
449 #define FIT_IMAGES_PATH "/images"
450 #define FIT_CONFS_PATH "/configurations"
453 #define FIT_HASH_NODENAME "hash"
454 #define FIT_ALGO_PROP "algo"
455 #define FIT_VALUE_PROP "value"
458 #define FIT_DATA_PROP "data"
459 #define FIT_TIMESTAMP_PROP "timestamp"
460 #define FIT_DESC_PROP "description"
461 #define FIT_ARCH_PROP "arch"
462 #define FIT_TYPE_PROP "type"
463 #define FIT_OS_PROP "os"
464 #define FIT_COMP_PROP "compression"
465 #define FIT_ENTRY_PROP "entry"
466 #define FIT_LOAD_PROP "load"
468 /* configuration node */
469 #define FIT_KERNEL_PROP "kernel"
470 #define FIT_RAMDISK_PROP "ramdisk"
471 #define FIT_FDT_PROP "fdt"
472 #define FIT_DEFAULT_PROP "default"
474 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
476 /* cmdline argument format parsing */
477 inline int fit_parse_conf (const char *spec
, ulong addr_curr
,
478 ulong
*addr
, const char **conf_name
);
479 inline int fit_parse_subimage (const char *spec
, ulong addr_curr
,
480 ulong
*addr
, const char **image_name
);
482 void fit_print_contents (const void *fit
);
483 void fit_image_print (const void *fit
, int noffset
, const char *p
);
484 void fit_image_print_hash (const void *fit
, int noffset
, const char *p
);
487 * fit_get_end - get FIT image size
488 * @fit: pointer to the FIT format image header
491 * size of the FIT image (blob) in memory
493 static inline ulong
fit_get_size (const void *fit
)
495 return fdt_totalsize (fit
);
499 * fit_get_end - get FIT image end
500 * @fit: pointer to the FIT format image header
503 * end address of the FIT image (blob) in memory
505 static inline ulong
fit_get_end (const void *fit
)
507 return (ulong
)fit
+ fdt_totalsize (fit
);
511 * fit_get_name - get FIT node name
512 * @fit: pointer to the FIT format image header
516 * pointer to node name, on success
518 static inline const char *fit_get_name (const void *fit_hdr
,
519 int noffset
, int *len
)
521 return fdt_get_name (fit_hdr
, noffset
, len
);
524 int fit_get_desc (const void *fit
, int noffset
, char **desc
);
525 int fit_get_timestamp (const void *fit
, int noffset
, time_t *timestamp
);
527 int fit_image_get_node (const void *fit
, const char *image_uname
);
528 int fit_image_get_os (const void *fit
, int noffset
, uint8_t *os
);
529 int fit_image_get_arch (const void *fit
, int noffset
, uint8_t *arch
);
530 int fit_image_get_type (const void *fit
, int noffset
, uint8_t *type
);
531 int fit_image_get_comp (const void *fit
, int noffset
, uint8_t *comp
);
532 int fit_image_get_load (const void *fit
, int noffset
, ulong
*load
);
533 int fit_image_get_entry (const void *fit
, int noffset
, ulong
*entry
);
534 int fit_image_get_data (const void *fit
, int noffset
,
535 const void **data
, size_t *size
);
537 int fit_image_hash_get_algo (const void *fit
, int noffset
, char **algo
);
538 int fit_image_hash_get_value (const void *fit
, int noffset
, uint8_t **value
,
541 int fit_set_timestamp (void *fit
, int noffset
, time_t timestamp
);
542 int fit_set_hashes (void *fit
);
543 int fit_image_set_hashes (void *fit
, int image_noffset
);
544 int fit_image_hash_set_value (void *fit
, int noffset
, uint8_t *value
,
547 int fit_image_check_hashes (const void *fit
, int noffset
);
548 int fit_image_check_os (const void *fit
, int noffset
, uint8_t os
);
549 int fit_image_check_arch (const void *fit
, int noffset
, uint8_t arch
);
550 int fit_image_check_type (const void *fit
, int noffset
, uint8_t type
);
551 int fit_image_check_comp (const void *fit
, int noffset
, uint8_t comp
);
552 int fit_check_format (const void *fit
);
554 int fit_conf_get_node (const void *fit
, const char *conf_uname
);
555 int fit_conf_get_kernel_node (const void *fit
, int noffset
);
556 int fit_conf_get_ramdisk_node (const void *fit
, int noffset
);
557 int fit_conf_get_fdt_node (const void *fit
, int noffset
);
559 void fit_conf_print (const void *fit
, int noffset
, const char *p
);
562 static inline int fit_image_check_target_arch (const void *fdt
, int node
)
565 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_ARM
))
566 #elif defined(__avr32__)
567 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_AVR32
))
568 #elif defined(__bfin__)
569 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_BLACKFIN
))
570 #elif defined(__I386__)
571 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_I386
))
572 #elif defined(__M68K__)
573 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_M68K
))
574 #elif defined(__microblaze__)
575 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_MICROBLAZE
))
576 #elif defined(__mips__)
577 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_MIPS
))
578 #elif defined(__nios__)
579 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_NIOS
))
580 #elif defined(__nios2__)
581 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_NIOS2
))
582 #elif defined(__PPC__)
583 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_PPC
))
584 #elif defined(__sh__)
585 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_SH
))
586 #elif defined(__sparc__)
587 if (!fit_image_check_arch (fdt
, node
, IH_ARCH_SPARC
))
589 # error Unknown CPU type
595 #endif /* USE_HOSTCC */
597 #ifdef CONFIG_FIT_VERBOSE
598 #define fit_unsupported(msg) printf ("! %s:%d " \
599 "FIT images not supported for '%s'\n", \
600 __FILE__, __LINE__, (msg))
602 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
603 "FIT images not supported for '%s' " \
604 "- must reset board to recover!\n", \
605 __FILE__, __LINE__, (msg))
607 #define fit_unsupported(msg)
608 #define fit_unsupported_reset(msg)
609 #endif /* CONFIG_FIT_VERBOSE */
610 #endif /* CONFIG_FIT */
612 #endif /* __IMAGE_H__ */