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 ********************************************************************
40 /* new uImage format support enabled on host */
42 #define CONFIG_OF_LIBFDT 1
43 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
48 #include <asm/u-boot.h>
51 #endif /* USE_HOSTCC */
53 #if defined(CONFIG_FIT)
56 #include <fdt_support.h>
57 #define CONFIG_MD5 /* FIT images need MD5 support */
58 #define CONFIG_SHA1 /* and SHA1 */
62 * Operating System Codes
64 #define IH_OS_INVALID 0 /* Invalid OS */
65 #define IH_OS_OPENBSD 1 /* OpenBSD */
66 #define IH_OS_NETBSD 2 /* NetBSD */
67 #define IH_OS_FREEBSD 3 /* FreeBSD */
68 #define IH_OS_4_4BSD 4 /* 4.4BSD */
69 #define IH_OS_LINUX 5 /* Linux */
70 #define IH_OS_SVR4 6 /* SVR4 */
71 #define IH_OS_ESIX 7 /* Esix */
72 #define IH_OS_SOLARIS 8 /* Solaris */
73 #define IH_OS_IRIX 9 /* Irix */
74 #define IH_OS_SCO 10 /* SCO */
75 #define IH_OS_DELL 11 /* Dell */
76 #define IH_OS_NCR 12 /* NCR */
77 #define IH_OS_LYNXOS 13 /* LynxOS */
78 #define IH_OS_VXWORKS 14 /* VxWorks */
79 #define IH_OS_PSOS 15 /* pSOS */
80 #define IH_OS_QNX 16 /* QNX */
81 #define IH_OS_U_BOOT 17 /* Firmware */
82 #define IH_OS_RTEMS 18 /* RTEMS */
83 #define IH_OS_ARTOS 19 /* ARTOS */
84 #define IH_OS_UNITY 20 /* Unity OS */
85 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
86 #define IH_OS_OSE 22 /* OSE */
89 * CPU Architecture Codes (supported by Linux)
91 #define IH_ARCH_INVALID 0 /* Invalid CPU */
92 #define IH_ARCH_ALPHA 1 /* Alpha */
93 #define IH_ARCH_ARM 2 /* ARM */
94 #define IH_ARCH_I386 3 /* Intel x86 */
95 #define IH_ARCH_IA64 4 /* IA64 */
96 #define IH_ARCH_MIPS 5 /* MIPS */
97 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
98 #define IH_ARCH_PPC 7 /* PowerPC */
99 #define IH_ARCH_S390 8 /* IBM S390 */
100 #define IH_ARCH_SH 9 /* SuperH */
101 #define IH_ARCH_SPARC 10 /* Sparc */
102 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
103 #define IH_ARCH_M68K 12 /* M68K */
104 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
105 #define IH_ARCH_NIOS2 15 /* Nios-II */
106 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
107 #define IH_ARCH_AVR32 17 /* AVR32 */
108 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
113 * "Standalone Programs" are directly runnable in the environment
114 * provided by U-Boot; it is expected that (if they behave
115 * well) you can continue to work in U-Boot after return from
116 * the Standalone Program.
117 * "OS Kernel Images" are usually images of some Embedded OS which
118 * will take over control completely. Usually these programs
119 * will install their own set of exception handlers, device
120 * drivers, set up the MMU, etc. - this means, that you cannot
121 * expect to re-enter U-Boot except by resetting the CPU.
122 * "RAMDisk Images" are more or less just data blocks, and their
123 * parameters (address, size) are passed to an OS kernel that is
125 * "Multi-File Images" contain several images, typically an OS
126 * (Linux) kernel image and one or more data images like
127 * RAMDisks. This construct is useful for instance when you want
128 * to boot over the network using BOOTP etc., where the boot
129 * server provides just a single image file, but you want to get
130 * for instance an OS kernel and a RAMDisk image.
132 * "Multi-File Images" start with a list of image sizes, each
133 * image size (in bytes) specified by an "uint32_t" in network
134 * byte order. This list is terminated by an "(uint32_t)0".
135 * Immediately after the terminating 0 follow the images, one by
136 * one, all aligned on "uint32_t" boundaries (size rounded up to
137 * a multiple of 4 bytes - except for the last file).
139 * "Firmware Images" are binary images containing firmware (like
140 * U-Boot or FPGA images) which usually will be programmed to
143 * "Script files" are command sequences that will be executed by
144 * U-Boot's command interpreter; this feature is especially
145 * useful when you configure U-Boot to use a real shell (hush)
146 * as command interpreter (=> Shell Scripts).
149 #define IH_TYPE_INVALID 0 /* Invalid Image */
150 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
151 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
152 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
153 #define IH_TYPE_MULTI 4 /* Multi-File Image */
154 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
155 #define IH_TYPE_SCRIPT 6 /* Script file */
156 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
157 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
158 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
159 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
160 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
161 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
166 #define IH_COMP_NONE 0 /* No Compression Used */
167 #define IH_COMP_GZIP 1 /* gzip Compression Used */
168 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
169 #define IH_COMP_LZMA 3 /* lzma Compression Used */
170 #define IH_COMP_LZO 4 /* lzo 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 void *fit_hdr_fdt; /* FDT blob FIT image header */
227 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
228 int fit_noffset_fdt;/* FDT blob subimage node offset */
232 image_info_t os; /* os image info */
233 ulong ep; /* entry point of OS */
235 ulong rd_start, rd_end;/* ramdisk start/end */
237 #ifdef CONFIG_OF_LIBFDT
238 char *ft_addr; /* flat dev tree address */
240 ulong ft_len; /* length of flat device tree */
249 int verify; /* getenv("verify")[0] != 'n' */
251 #define BOOTM_STATE_START (0x00000001)
252 #define BOOTM_STATE_LOADOS (0x00000002)
253 #define BOOTM_STATE_RAMDISK (0x00000004)
254 #define BOOTM_STATE_FDT (0x00000008)
255 #define BOOTM_STATE_OS_CMDLINE (0x00000010)
256 #define BOOTM_STATE_OS_BD_T (0x00000020)
257 #define BOOTM_STATE_OS_PREP (0x00000040)
258 #define BOOTM_STATE_OS_GO (0x00000080)
262 struct lmb lmb; /* for memory mgmt */
267 * Some systems (for example LWMON) have very short watchdog periods;
268 * we must make sure to split long operations like memmove() or
269 * checksum calculations into reasonable chunks.
272 #define CHUNKSZ (64 * 1024)
275 #ifndef CHUNKSZ_CRC32
276 #define CHUNKSZ_CRC32 (64 * 1024)
280 #define CHUNKSZ_MD5 (64 * 1024)
284 #define CHUNKSZ_SHA1 (64 * 1024)
287 #define uimage_to_cpu(x) be32_to_cpu(x)
288 #define cpu_to_uimage(x) cpu_to_be32(x)
291 * Translation table for entries of a specific type; used by
292 * get_table_entry_id() and get_table_entry_name().
294 typedef struct table_entry {
296 char *sname; /* short (input) name to find table entry */
297 char *lname; /* long (output) name to print for messages */
301 * get_table_entry_id() scans the translation table trying to find an
302 * entry that matches the given short name. If a matching entry is
303 * found, it's id is returned to the caller.
305 int get_table_entry_id(const table_entry_t *table,
306 const char *table_name, const char *name);
308 * get_table_entry_name() scans the translation table trying to find
309 * an entry that matches the given id. If a matching entry is found,
310 * its long name is returned to the caller.
312 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
314 const char *genimg_get_os_name (uint8_t os);
315 const char *genimg_get_arch_name (uint8_t arch);
316 const char *genimg_get_type_name (uint8_t type);
317 const char *genimg_get_comp_name (uint8_t comp);
318 int genimg_get_os_id (const char *name);
319 int genimg_get_arch_id (const char *name);
320 int genimg_get_type_id (const char *name);
321 int genimg_get_comp_id (const char *name);
322 void genimg_print_size (uint32_t size);
325 /* Image format types, returned by _get_format() routine */
326 #define IMAGE_FORMAT_INVALID 0x00
327 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
328 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
330 int genimg_get_format (void *img_addr);
331 int genimg_has_config (bootm_headers_t *images);
332 ulong genimg_get_image (ulong img_addr);
334 int boot_get_ramdisk (int argc, char * const argv[], bootm_headers_t *images,
335 uint8_t arch, ulong *rd_start, ulong *rd_end);
338 #ifdef CONFIG_OF_LIBFDT
339 int boot_get_fdt (int flag, int argc, char * const argv[], bootm_headers_t *images,
340 char **of_flat_tree, ulong *of_size);
341 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
342 int boot_relocate_fdt (struct lmb *lmb, char **of_flat_tree, ulong *of_size);
345 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
346 int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
347 ulong *initrd_start, ulong *initrd_end);
348 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
349 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
350 int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
351 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
352 #ifdef CONFIG_SYS_BOOT_GET_KBD
353 int boot_get_kbd (struct lmb *lmb, bd_t **kbd);
354 #endif /* CONFIG_SYS_BOOT_GET_KBD */
355 #endif /* !USE_HOSTCC */
357 /*******************************************************************/
358 /* Legacy format specific code (prefixed with image_) */
359 /*******************************************************************/
360 static inline uint32_t image_get_header_size (void)
362 return (sizeof (image_header_t));
365 #define image_get_hdr_l(f) \
366 static inline uint32_t image_get_##f(const image_header_t *hdr) \
368 return uimage_to_cpu (hdr->ih_##f); \
370 image_get_hdr_l (magic) /* image_get_magic */
371 image_get_hdr_l (hcrc) /* image_get_hcrc */
372 image_get_hdr_l (time) /* image_get_time */
373 image_get_hdr_l (size) /* image_get_size */
374 image_get_hdr_l (load) /* image_get_load */
375 image_get_hdr_l (ep) /* image_get_ep */
376 image_get_hdr_l (dcrc) /* image_get_dcrc */
378 #define image_get_hdr_b(f) \
379 static inline uint8_t image_get_##f(const image_header_t *hdr) \
381 return hdr->ih_##f; \
383 image_get_hdr_b (os) /* image_get_os */
384 image_get_hdr_b (arch) /* image_get_arch */
385 image_get_hdr_b (type) /* image_get_type */
386 image_get_hdr_b (comp) /* image_get_comp */
388 static inline char *image_get_name (const image_header_t *hdr)
390 return (char *)hdr->ih_name;
393 static inline uint32_t image_get_data_size (const image_header_t *hdr)
395 return image_get_size (hdr);
399 * image_get_data - get image payload start address
402 * image_get_data() returns address of the image payload. For single
403 * component images it is image data start. For multi component
404 * images it points to the null terminated table of sub-images sizes.
407 * image payload data start address
409 static inline ulong image_get_data (const image_header_t *hdr)
411 return ((ulong)hdr + image_get_header_size ());
414 static inline uint32_t image_get_image_size (const image_header_t *hdr)
416 return (image_get_size (hdr) + image_get_header_size ());
418 static inline ulong image_get_image_end (const image_header_t *hdr)
420 return ((ulong)hdr + image_get_image_size (hdr));
423 #define image_set_hdr_l(f) \
424 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
426 hdr->ih_##f = cpu_to_uimage (val); \
428 image_set_hdr_l (magic) /* image_set_magic */
429 image_set_hdr_l (hcrc) /* image_set_hcrc */
430 image_set_hdr_l (time) /* image_set_time */
431 image_set_hdr_l (size) /* image_set_size */
432 image_set_hdr_l (load) /* image_set_load */
433 image_set_hdr_l (ep) /* image_set_ep */
434 image_set_hdr_l (dcrc) /* image_set_dcrc */
436 #define image_set_hdr_b(f) \
437 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
441 image_set_hdr_b (os) /* image_set_os */
442 image_set_hdr_b (arch) /* image_set_arch */
443 image_set_hdr_b (type) /* image_set_type */
444 image_set_hdr_b (comp) /* image_set_comp */
446 static inline void image_set_name (image_header_t *hdr, const char *name)
448 strncpy (image_get_name (hdr), name, IH_NMLEN);
451 int image_check_hcrc (const image_header_t *hdr);
452 int image_check_dcrc (const image_header_t *hdr);
454 int getenv_yesno (char *var);
455 ulong getenv_bootm_low(void);
456 phys_size_t getenv_bootm_size(void);
457 phys_size_t getenv_bootm_mapsize(void);
458 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
461 static inline int image_check_magic (const image_header_t *hdr)
463 return (image_get_magic (hdr) == IH_MAGIC);
465 static inline int image_check_type (const image_header_t *hdr, uint8_t type)
467 return (image_get_type (hdr) == type);
469 static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
471 return (image_get_arch (hdr) == arch);
473 static inline int image_check_os (const image_header_t *hdr, uint8_t os)
475 return (image_get_os (hdr) == os);
478 ulong image_multi_count (const image_header_t *hdr);
479 void image_multi_getimg (const image_header_t *hdr, ulong idx,
480 ulong *data, ulong *len);
482 void image_print_contents (const void *hdr);
485 static inline int image_check_target_arch (const image_header_t *hdr)
487 #ifndef IH_ARCH_DEFAULT
488 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
490 return image_check_arch(hdr, IH_ARCH_DEFAULT);
492 #endif /* USE_HOSTCC */
494 /*******************************************************************/
495 /* New uImage format specific code (prefixed with fit_) */
496 /*******************************************************************/
497 #if defined(CONFIG_FIT)
499 #define FIT_IMAGES_PATH "/images"
500 #define FIT_CONFS_PATH "/configurations"
503 #define FIT_HASH_NODENAME "hash"
504 #define FIT_ALGO_PROP "algo"
505 #define FIT_VALUE_PROP "value"
508 #define FIT_DATA_PROP "data"
509 #define FIT_TIMESTAMP_PROP "timestamp"
510 #define FIT_DESC_PROP "description"
511 #define FIT_ARCH_PROP "arch"
512 #define FIT_TYPE_PROP "type"
513 #define FIT_OS_PROP "os"
514 #define FIT_COMP_PROP "compression"
515 #define FIT_ENTRY_PROP "entry"
516 #define FIT_LOAD_PROP "load"
518 /* configuration node */
519 #define FIT_KERNEL_PROP "kernel"
520 #define FIT_RAMDISK_PROP "ramdisk"
521 #define FIT_FDT_PROP "fdt"
522 #define FIT_DEFAULT_PROP "default"
524 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
526 /* cmdline argument format parsing */
527 inline int fit_parse_conf (const char *spec, ulong addr_curr,
528 ulong *addr, const char **conf_name);
529 inline int fit_parse_subimage (const char *spec, ulong addr_curr,
530 ulong *addr, const char **image_name);
532 void fit_print_contents (const void *fit);
533 void fit_image_print (const void *fit, int noffset, const char *p);
534 void fit_image_print_hash (const void *fit, int noffset, const char *p);
537 * fit_get_end - get FIT image size
538 * @fit: pointer to the FIT format image header
541 * size of the FIT image (blob) in memory
543 static inline ulong fit_get_size (const void *fit)
545 return fdt_totalsize (fit);
549 * fit_get_end - get FIT image end
550 * @fit: pointer to the FIT format image header
553 * end address of the FIT image (blob) in memory
555 static inline ulong fit_get_end (const void *fit)
557 return (ulong)fit + fdt_totalsize (fit);
561 * fit_get_name - get FIT node name
562 * @fit: pointer to the FIT format image header
566 * pointer to node name, on success
568 static inline const char *fit_get_name (const void *fit_hdr,
569 int noffset, int *len)
571 return fdt_get_name (fit_hdr, noffset, len);
574 int fit_get_desc (const void *fit, int noffset, char **desc);
575 int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
577 int fit_image_get_node (const void *fit, const char *image_uname);
578 int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
579 int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
580 int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
581 int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
582 int fit_image_get_load (const void *fit, int noffset, ulong *load);
583 int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
584 int fit_image_get_data (const void *fit, int noffset,
585 const void **data, size_t *size);
587 int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
588 int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
591 int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
592 int fit_set_hashes (void *fit);
593 int fit_image_set_hashes (void *fit, int image_noffset);
594 int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
597 int fit_image_check_hashes (const void *fit, int noffset);
598 int fit_all_image_check_hashes (const void *fit);
599 int fit_image_check_os (const void *fit, int noffset, uint8_t os);
600 int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
601 int fit_image_check_type (const void *fit, int noffset, uint8_t type);
602 int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
603 int fit_check_format (const void *fit);
605 int fit_conf_get_node (const void *fit, const char *conf_uname);
606 int fit_conf_get_kernel_node (const void *fit, int noffset);
607 int fit_conf_get_ramdisk_node (const void *fit, int noffset);
608 int fit_conf_get_fdt_node (const void *fit, int noffset);
610 void fit_conf_print (const void *fit, int noffset, const char *p);
613 static inline int fit_image_check_target_arch (const void *fdt, int node)
615 return !fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
617 #endif /* USE_HOSTCC */
619 #ifdef CONFIG_FIT_VERBOSE
620 #define fit_unsupported(msg) printf ("! %s:%d " \
621 "FIT images not supported for '%s'\n", \
622 __FILE__, __LINE__, (msg))
624 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
625 "FIT images not supported for '%s' " \
626 "- must reset board to recover!\n", \
627 __FILE__, __LINE__, (msg))
629 #define fit_unsupported(msg)
630 #define fit_unsupported_reset(msg)
631 #endif /* CONFIG_FIT_VERBOSE */
632 #endif /* CONFIG_FIT */
634 #endif /* __IMAGE_H__ */