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 */
109 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
110 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
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 */
160 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
161 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
162 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
163 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
164 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
165 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
170 #define IH_COMP_NONE 0 /* No Compression Used */
171 #define IH_COMP_GZIP 1 /* gzip Compression Used */
172 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
173 #define IH_COMP_LZMA 3 /* lzma Compression Used */
174 #define IH_COMP_LZO 4 /* lzo Compression Used */
176 #define IH_MAGIC 0x27051956 /* Image Magic Number */
177 #define IH_NMLEN 32 /* Image Name Length */
180 * Legacy format image header,
181 * all data in network byte order (aka natural aka bigendian).
183 typedef struct image_header {
184 uint32_t ih_magic; /* Image Header Magic Number */
185 uint32_t ih_hcrc; /* Image Header CRC Checksum */
186 uint32_t ih_time; /* Image Creation Timestamp */
187 uint32_t ih_size; /* Image Data Size */
188 uint32_t ih_load; /* Data Load Address */
189 uint32_t ih_ep; /* Entry Point Address */
190 uint32_t ih_dcrc; /* Image Data CRC Checksum */
191 uint8_t ih_os; /* Operating System */
192 uint8_t ih_arch; /* CPU architecture */
193 uint8_t ih_type; /* Image Type */
194 uint8_t ih_comp; /* Compression Type */
195 uint8_t ih_name[IH_NMLEN]; /* Image Name */
198 typedef struct image_info {
199 ulong start, end; /* start/end of blob */
200 ulong image_start, image_len; /* start of image within blob, len of image */
201 ulong load; /* load addr for the image */
202 uint8_t comp, type, os; /* compression, type of image, os type */
206 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
209 typedef struct bootm_headers {
211 * Legacy os image header, if it is a multi component image
212 * then boot_get_ramdisk() and get_fdt() will attempt to get
213 * data from second and third component accordingly.
215 image_header_t *legacy_hdr_os; /* image header pointer */
216 image_header_t legacy_hdr_os_copy; /* header copy */
217 ulong legacy_hdr_valid;
219 #if defined(CONFIG_FIT)
220 const char *fit_uname_cfg; /* configuration node unit name */
222 void *fit_hdr_os; /* os FIT image header */
223 const char *fit_uname_os; /* os subimage node unit name */
224 int fit_noffset_os; /* os subimage node offset */
226 void *fit_hdr_rd; /* init ramdisk FIT image header */
227 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
228 int fit_noffset_rd; /* init ramdisk subimage node offset */
230 void *fit_hdr_fdt; /* FDT blob FIT image header */
231 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
232 int fit_noffset_fdt;/* FDT blob subimage node offset */
236 image_info_t os; /* os image info */
237 ulong ep; /* entry point of OS */
239 ulong rd_start, rd_end;/* ramdisk start/end */
241 #ifdef CONFIG_OF_LIBFDT
242 char *ft_addr; /* flat dev tree address */
244 ulong ft_len; /* length of flat device tree */
253 int verify; /* getenv("verify")[0] != 'n' */
255 #define BOOTM_STATE_START (0x00000001)
256 #define BOOTM_STATE_LOADOS (0x00000002)
257 #define BOOTM_STATE_RAMDISK (0x00000004)
258 #define BOOTM_STATE_FDT (0x00000008)
259 #define BOOTM_STATE_OS_CMDLINE (0x00000010)
260 #define BOOTM_STATE_OS_BD_T (0x00000020)
261 #define BOOTM_STATE_OS_PREP (0x00000040)
262 #define BOOTM_STATE_OS_GO (0x00000080)
266 struct lmb lmb; /* for memory mgmt */
271 * Some systems (for example LWMON) have very short watchdog periods;
272 * we must make sure to split long operations like memmove() or
273 * checksum calculations into reasonable chunks.
276 #define CHUNKSZ (64 * 1024)
279 #ifndef CHUNKSZ_CRC32
280 #define CHUNKSZ_CRC32 (64 * 1024)
284 #define CHUNKSZ_MD5 (64 * 1024)
288 #define CHUNKSZ_SHA1 (64 * 1024)
291 #define uimage_to_cpu(x) be32_to_cpu(x)
292 #define cpu_to_uimage(x) cpu_to_be32(x)
295 * Translation table for entries of a specific type; used by
296 * get_table_entry_id() and get_table_entry_name().
298 typedef struct table_entry {
300 char *sname; /* short (input) name to find table entry */
301 char *lname; /* long (output) name to print for messages */
305 * get_table_entry_id() scans the translation table trying to find an
306 * entry that matches the given short name. If a matching entry is
307 * found, it's id is returned to the caller.
309 int get_table_entry_id(const table_entry_t *table,
310 const char *table_name, const char *name);
312 * get_table_entry_name() scans the translation table trying to find
313 * an entry that matches the given id. If a matching entry is found,
314 * its long name is returned to the caller.
316 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
318 const char *genimg_get_os_name(uint8_t os);
319 const char *genimg_get_arch_name(uint8_t arch);
320 const char *genimg_get_type_name(uint8_t type);
321 const char *genimg_get_comp_name(uint8_t comp);
322 int genimg_get_os_id(const char *name);
323 int genimg_get_arch_id(const char *name);
324 int genimg_get_type_id(const char *name);
325 int genimg_get_comp_id(const char *name);
326 void genimg_print_size(uint32_t size);
329 /* Image format types, returned by _get_format() routine */
330 #define IMAGE_FORMAT_INVALID 0x00
331 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
332 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
334 int genimg_get_format(void *img_addr);
335 int genimg_has_config(bootm_headers_t *images);
336 ulong genimg_get_image(ulong img_addr);
338 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
339 uint8_t arch, ulong *rd_start, ulong *rd_end);
342 #ifdef CONFIG_OF_LIBFDT
343 int boot_get_fdt(int flag, int argc, char * const argv[],
344 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
345 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
346 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
349 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
350 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
351 ulong *initrd_start, ulong *initrd_end);
352 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
353 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
354 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
355 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
356 #ifdef CONFIG_SYS_BOOT_GET_KBD
357 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
358 #endif /* CONFIG_SYS_BOOT_GET_KBD */
359 #endif /* !USE_HOSTCC */
361 /*******************************************************************/
362 /* Legacy format specific code (prefixed with image_) */
363 /*******************************************************************/
364 static inline uint32_t image_get_header_size(void)
366 return (sizeof(image_header_t));
369 #define image_get_hdr_l(f) \
370 static inline uint32_t image_get_##f(const image_header_t *hdr) \
372 return uimage_to_cpu(hdr->ih_##f); \
374 image_get_hdr_l(magic) /* image_get_magic */
375 image_get_hdr_l(hcrc) /* image_get_hcrc */
376 image_get_hdr_l(time) /* image_get_time */
377 image_get_hdr_l(size) /* image_get_size */
378 image_get_hdr_l(load) /* image_get_load */
379 image_get_hdr_l(ep) /* image_get_ep */
380 image_get_hdr_l(dcrc) /* image_get_dcrc */
382 #define image_get_hdr_b(f) \
383 static inline uint8_t image_get_##f(const image_header_t *hdr) \
385 return hdr->ih_##f; \
387 image_get_hdr_b(os) /* image_get_os */
388 image_get_hdr_b(arch) /* image_get_arch */
389 image_get_hdr_b(type) /* image_get_type */
390 image_get_hdr_b(comp) /* image_get_comp */
392 static inline char *image_get_name(const image_header_t *hdr)
394 return (char *)hdr->ih_name;
397 static inline uint32_t image_get_data_size(const image_header_t *hdr)
399 return image_get_size(hdr);
403 * image_get_data - get image payload start address
406 * image_get_data() returns address of the image payload. For single
407 * component images it is image data start. For multi component
408 * images it points to the null terminated table of sub-images sizes.
411 * image payload data start address
413 static inline ulong image_get_data(const image_header_t *hdr)
415 return ((ulong)hdr + image_get_header_size());
418 static inline uint32_t image_get_image_size(const image_header_t *hdr)
420 return (image_get_size(hdr) + image_get_header_size());
422 static inline ulong image_get_image_end(const image_header_t *hdr)
424 return ((ulong)hdr + image_get_image_size(hdr));
427 #define image_set_hdr_l(f) \
428 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
430 hdr->ih_##f = cpu_to_uimage(val); \
432 image_set_hdr_l(magic) /* image_set_magic */
433 image_set_hdr_l(hcrc) /* image_set_hcrc */
434 image_set_hdr_l(time) /* image_set_time */
435 image_set_hdr_l(size) /* image_set_size */
436 image_set_hdr_l(load) /* image_set_load */
437 image_set_hdr_l(ep) /* image_set_ep */
438 image_set_hdr_l(dcrc) /* image_set_dcrc */
440 #define image_set_hdr_b(f) \
441 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
445 image_set_hdr_b(os) /* image_set_os */
446 image_set_hdr_b(arch) /* image_set_arch */
447 image_set_hdr_b(type) /* image_set_type */
448 image_set_hdr_b(comp) /* image_set_comp */
450 static inline void image_set_name(image_header_t *hdr, const char *name)
452 strncpy(image_get_name(hdr), name, IH_NMLEN);
455 int image_check_hcrc(const image_header_t *hdr);
456 int image_check_dcrc(const image_header_t *hdr);
458 int getenv_yesno(char *var);
459 ulong getenv_bootm_low(void);
460 phys_size_t getenv_bootm_size(void);
461 phys_size_t getenv_bootm_mapsize(void);
462 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
465 static inline int image_check_magic(const image_header_t *hdr)
467 return (image_get_magic(hdr) == IH_MAGIC);
469 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
471 return (image_get_type(hdr) == type);
473 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
475 return (image_get_arch(hdr) == arch);
477 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
479 return (image_get_os(hdr) == os);
482 ulong image_multi_count(const image_header_t *hdr);
483 void image_multi_getimg(const image_header_t *hdr, ulong idx,
484 ulong *data, ulong *len);
486 void image_print_contents(const void *hdr);
489 static inline int image_check_target_arch(const image_header_t *hdr)
491 #ifndef IH_ARCH_DEFAULT
492 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
494 return image_check_arch(hdr, IH_ARCH_DEFAULT);
496 #endif /* USE_HOSTCC */
498 /*******************************************************************/
499 /* New uImage format specific code (prefixed with fit_) */
500 /*******************************************************************/
501 #if defined(CONFIG_FIT)
503 #define FIT_IMAGES_PATH "/images"
504 #define FIT_CONFS_PATH "/configurations"
507 #define FIT_HASH_NODENAME "hash"
508 #define FIT_ALGO_PROP "algo"
509 #define FIT_VALUE_PROP "value"
512 #define FIT_DATA_PROP "data"
513 #define FIT_TIMESTAMP_PROP "timestamp"
514 #define FIT_DESC_PROP "description"
515 #define FIT_ARCH_PROP "arch"
516 #define FIT_TYPE_PROP "type"
517 #define FIT_OS_PROP "os"
518 #define FIT_COMP_PROP "compression"
519 #define FIT_ENTRY_PROP "entry"
520 #define FIT_LOAD_PROP "load"
522 /* configuration node */
523 #define FIT_KERNEL_PROP "kernel"
524 #define FIT_RAMDISK_PROP "ramdisk"
525 #define FIT_FDT_PROP "fdt"
526 #define FIT_DEFAULT_PROP "default"
528 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
530 /* cmdline argument format parsing */
531 inline int fit_parse_conf(const char *spec, ulong addr_curr,
532 ulong *addr, const char **conf_name);
533 inline int fit_parse_subimage(const char *spec, ulong addr_curr,
534 ulong *addr, const char **image_name);
536 void fit_print_contents(const void *fit);
537 void fit_image_print(const void *fit, int noffset, const char *p);
538 void fit_image_print_hash(const void *fit, int noffset, const char *p);
541 * fit_get_end - get FIT image size
542 * @fit: pointer to the FIT format image header
545 * size of the FIT image (blob) in memory
547 static inline ulong fit_get_size(const void *fit)
549 return fdt_totalsize(fit);
553 * fit_get_end - get FIT image end
554 * @fit: pointer to the FIT format image header
557 * end address of the FIT image (blob) in memory
559 static inline ulong fit_get_end(const void *fit)
561 return (ulong)fit + fdt_totalsize(fit);
565 * fit_get_name - get FIT node name
566 * @fit: pointer to the FIT format image header
570 * pointer to node name, on success
572 static inline const char *fit_get_name(const void *fit_hdr,
573 int noffset, int *len)
575 return fdt_get_name(fit_hdr, noffset, len);
578 int fit_get_desc(const void *fit, int noffset, char **desc);
579 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
581 int fit_image_get_node(const void *fit, const char *image_uname);
582 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
583 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
584 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
585 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
586 int fit_image_get_load(const void *fit, int noffset, ulong *load);
587 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
588 int fit_image_get_data(const void *fit, int noffset,
589 const void **data, size_t *size);
591 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
592 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
595 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
596 int fit_set_hashes(void *fit);
597 int fit_image_set_hashes(void *fit, int image_noffset);
598 int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value,
601 int fit_image_check_hashes(const void *fit, int noffset);
602 int fit_all_image_check_hashes(const void *fit);
603 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
604 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
605 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
606 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
607 int fit_check_format(const void *fit);
609 int fit_conf_get_node(const void *fit, const char *conf_uname);
610 int fit_conf_get_kernel_node(const void *fit, int noffset);
611 int fit_conf_get_ramdisk_node(const void *fit, int noffset);
612 int fit_conf_get_fdt_node(const void *fit, int noffset);
614 void fit_conf_print(const void *fit, int noffset, const char *p);
617 static inline int fit_image_check_target_arch(const void *fdt, int node)
619 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
621 #endif /* USE_HOSTCC */
623 #ifdef CONFIG_FIT_VERBOSE
624 #define fit_unsupported(msg) printf("! %s:%d " \
625 "FIT images not supported for '%s'\n", \
626 __FILE__, __LINE__, (msg))
628 #define fit_unsupported_reset(msg) printf("! %s:%d " \
629 "FIT images not supported for '%s' " \
630 "- must reset board to recover!\n", \
631 __FILE__, __LINE__, (msg))
633 #define fit_unsupported(msg)
634 #define fit_unsupported_reset(msg)
635 #endif /* CONFIG_FIT_VERBOSE */
636 #endif /* CONFIG_FIT */
638 #endif /* __IMAGE_H__ */