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 */
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 */
172 #define IH_COMP_LZMA 3 /* lzma Compression Used */
173 #define IH_COMP_LZO 4 /* lzo Compression Used */
175 #define IH_MAGIC 0x27051956 /* Image Magic Number */
176 #define IH_NMLEN 32 /* Image Name Length */
179 * Legacy format image header,
180 * all data in network byte order (aka natural aka bigendian).
182 typedef struct image_header {
183 uint32_t ih_magic; /* Image Header Magic Number */
184 uint32_t ih_hcrc; /* Image Header CRC Checksum */
185 uint32_t ih_time; /* Image Creation Timestamp */
186 uint32_t ih_size; /* Image Data Size */
187 uint32_t ih_load; /* Data Load Address */
188 uint32_t ih_ep; /* Entry Point Address */
189 uint32_t ih_dcrc; /* Image Data CRC Checksum */
190 uint8_t ih_os; /* Operating System */
191 uint8_t ih_arch; /* CPU architecture */
192 uint8_t ih_type; /* Image Type */
193 uint8_t ih_comp; /* Compression Type */
194 uint8_t ih_name[IH_NMLEN]; /* Image Name */
197 typedef struct image_info {
198 ulong start, end; /* start/end of blob */
199 ulong image_start, image_len; /* start of image within blob, len of image */
200 ulong load; /* load addr for the image */
201 uint8_t comp, type, os; /* compression, type of image, os type */
205 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
208 typedef struct bootm_headers {
210 * Legacy os image header, if it is a multi component image
211 * then boot_get_ramdisk() and get_fdt() will attempt to get
212 * data from second and third component accordingly.
214 image_header_t *legacy_hdr_os; /* image header pointer */
215 image_header_t legacy_hdr_os_copy; /* header copy */
216 ulong legacy_hdr_valid;
218 #if defined(CONFIG_FIT)
219 const char *fit_uname_cfg; /* configuration node unit name */
221 void *fit_hdr_os; /* os FIT image header */
222 const char *fit_uname_os; /* os subimage node unit name */
223 int fit_noffset_os; /* os subimage node offset */
225 void *fit_hdr_rd; /* init ramdisk FIT image header */
226 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
227 int fit_noffset_rd; /* init ramdisk subimage node offset */
229 void *fit_hdr_fdt; /* FDT blob FIT image header */
230 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
231 int fit_noffset_fdt;/* FDT blob subimage node offset */
235 image_info_t os; /* os image info */
236 ulong ep; /* entry point of OS */
238 ulong rd_start, rd_end;/* ramdisk start/end */
240 #ifdef CONFIG_OF_LIBFDT
241 char *ft_addr; /* flat dev tree address */
243 ulong ft_len; /* length of flat device tree */
252 int verify; /* getenv("verify")[0] != 'n' */
254 #define BOOTM_STATE_START (0x00000001)
255 #define BOOTM_STATE_LOADOS (0x00000002)
256 #define BOOTM_STATE_RAMDISK (0x00000004)
257 #define BOOTM_STATE_FDT (0x00000008)
258 #define BOOTM_STATE_OS_CMDLINE (0x00000010)
259 #define BOOTM_STATE_OS_BD_T (0x00000020)
260 #define BOOTM_STATE_OS_PREP (0x00000040)
261 #define BOOTM_STATE_OS_GO (0x00000080)
265 struct lmb lmb; /* for memory mgmt */
270 * Some systems (for example LWMON) have very short watchdog periods;
271 * we must make sure to split long operations like memmove() or
272 * checksum calculations into reasonable chunks.
275 #define CHUNKSZ (64 * 1024)
278 #ifndef CHUNKSZ_CRC32
279 #define CHUNKSZ_CRC32 (64 * 1024)
283 #define CHUNKSZ_MD5 (64 * 1024)
287 #define CHUNKSZ_SHA1 (64 * 1024)
290 #define uimage_to_cpu(x) be32_to_cpu(x)
291 #define cpu_to_uimage(x) cpu_to_be32(x)
294 * Translation table for entries of a specific type; used by
295 * get_table_entry_id() and get_table_entry_name().
297 typedef struct table_entry {
299 char *sname; /* short (input) name to find table entry */
300 char *lname; /* long (output) name to print for messages */
304 * get_table_entry_id() scans the translation table trying to find an
305 * entry that matches the given short name. If a matching entry is
306 * found, it's id is returned to the caller.
308 int get_table_entry_id(const table_entry_t *table,
309 const char *table_name, const char *name);
311 * get_table_entry_name() scans the translation table trying to find
312 * an entry that matches the given id. If a matching entry is found,
313 * its long name is returned to the caller.
315 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
317 const char *genimg_get_os_name(uint8_t os);
318 const char *genimg_get_arch_name(uint8_t arch);
319 const char *genimg_get_type_name(uint8_t type);
320 const char *genimg_get_comp_name(uint8_t comp);
321 int genimg_get_os_id(const char *name);
322 int genimg_get_arch_id(const char *name);
323 int genimg_get_type_id(const char *name);
324 int genimg_get_comp_id(const char *name);
325 void genimg_print_size(uint32_t size);
328 /* Image format types, returned by _get_format() routine */
329 #define IMAGE_FORMAT_INVALID 0x00
330 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
331 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
333 int genimg_get_format(void *img_addr);
334 int genimg_has_config(bootm_headers_t *images);
335 ulong genimg_get_image(ulong img_addr);
337 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
338 uint8_t arch, ulong *rd_start, ulong *rd_end);
341 #ifdef CONFIG_OF_LIBFDT
342 int boot_get_fdt(int flag, int argc, char * const argv[],
343 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
344 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
345 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
348 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
349 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
350 ulong *initrd_start, ulong *initrd_end);
351 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
352 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
353 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
354 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
355 #ifdef CONFIG_SYS_BOOT_GET_KBD
356 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
357 #endif /* CONFIG_SYS_BOOT_GET_KBD */
358 #endif /* !USE_HOSTCC */
360 /*******************************************************************/
361 /* Legacy format specific code (prefixed with image_) */
362 /*******************************************************************/
363 static inline uint32_t image_get_header_size(void)
365 return (sizeof(image_header_t));
368 #define image_get_hdr_l(f) \
369 static inline uint32_t image_get_##f(const image_header_t *hdr) \
371 return uimage_to_cpu(hdr->ih_##f); \
373 image_get_hdr_l(magic) /* image_get_magic */
374 image_get_hdr_l(hcrc) /* image_get_hcrc */
375 image_get_hdr_l(time) /* image_get_time */
376 image_get_hdr_l(size) /* image_get_size */
377 image_get_hdr_l(load) /* image_get_load */
378 image_get_hdr_l(ep) /* image_get_ep */
379 image_get_hdr_l(dcrc) /* image_get_dcrc */
381 #define image_get_hdr_b(f) \
382 static inline uint8_t image_get_##f(const image_header_t *hdr) \
384 return hdr->ih_##f; \
386 image_get_hdr_b(os) /* image_get_os */
387 image_get_hdr_b(arch) /* image_get_arch */
388 image_get_hdr_b(type) /* image_get_type */
389 image_get_hdr_b(comp) /* image_get_comp */
391 static inline char *image_get_name(const image_header_t *hdr)
393 return (char *)hdr->ih_name;
396 static inline uint32_t image_get_data_size(const image_header_t *hdr)
398 return image_get_size(hdr);
402 * image_get_data - get image payload start address
405 * image_get_data() returns address of the image payload. For single
406 * component images it is image data start. For multi component
407 * images it points to the null terminated table of sub-images sizes.
410 * image payload data start address
412 static inline ulong image_get_data(const image_header_t *hdr)
414 return ((ulong)hdr + image_get_header_size());
417 static inline uint32_t image_get_image_size(const image_header_t *hdr)
419 return (image_get_size(hdr) + image_get_header_size());
421 static inline ulong image_get_image_end(const image_header_t *hdr)
423 return ((ulong)hdr + image_get_image_size(hdr));
426 #define image_set_hdr_l(f) \
427 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
429 hdr->ih_##f = cpu_to_uimage(val); \
431 image_set_hdr_l(magic) /* image_set_magic */
432 image_set_hdr_l(hcrc) /* image_set_hcrc */
433 image_set_hdr_l(time) /* image_set_time */
434 image_set_hdr_l(size) /* image_set_size */
435 image_set_hdr_l(load) /* image_set_load */
436 image_set_hdr_l(ep) /* image_set_ep */
437 image_set_hdr_l(dcrc) /* image_set_dcrc */
439 #define image_set_hdr_b(f) \
440 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
444 image_set_hdr_b(os) /* image_set_os */
445 image_set_hdr_b(arch) /* image_set_arch */
446 image_set_hdr_b(type) /* image_set_type */
447 image_set_hdr_b(comp) /* image_set_comp */
449 static inline void image_set_name(image_header_t *hdr, const char *name)
451 strncpy(image_get_name(hdr), name, IH_NMLEN);
454 int image_check_hcrc(const image_header_t *hdr);
455 int image_check_dcrc(const image_header_t *hdr);
457 int getenv_yesno(char *var);
458 ulong getenv_bootm_low(void);
459 phys_size_t getenv_bootm_size(void);
460 phys_size_t getenv_bootm_mapsize(void);
461 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
464 static inline int image_check_magic(const image_header_t *hdr)
466 return (image_get_magic(hdr) == IH_MAGIC);
468 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
470 return (image_get_type(hdr) == type);
472 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
474 return (image_get_arch(hdr) == arch);
476 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
478 return (image_get_os(hdr) == os);
481 ulong image_multi_count(const image_header_t *hdr);
482 void image_multi_getimg(const image_header_t *hdr, ulong idx,
483 ulong *data, ulong *len);
485 void image_print_contents(const void *hdr);
488 static inline int image_check_target_arch(const image_header_t *hdr)
490 #ifndef IH_ARCH_DEFAULT
491 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
493 return image_check_arch(hdr, IH_ARCH_DEFAULT);
495 #endif /* USE_HOSTCC */
497 /*******************************************************************/
498 /* New uImage format specific code (prefixed with fit_) */
499 /*******************************************************************/
500 #if defined(CONFIG_FIT)
502 #define FIT_IMAGES_PATH "/images"
503 #define FIT_CONFS_PATH "/configurations"
506 #define FIT_HASH_NODENAME "hash"
507 #define FIT_ALGO_PROP "algo"
508 #define FIT_VALUE_PROP "value"
511 #define FIT_DATA_PROP "data"
512 #define FIT_TIMESTAMP_PROP "timestamp"
513 #define FIT_DESC_PROP "description"
514 #define FIT_ARCH_PROP "arch"
515 #define FIT_TYPE_PROP "type"
516 #define FIT_OS_PROP "os"
517 #define FIT_COMP_PROP "compression"
518 #define FIT_ENTRY_PROP "entry"
519 #define FIT_LOAD_PROP "load"
521 /* configuration node */
522 #define FIT_KERNEL_PROP "kernel"
523 #define FIT_RAMDISK_PROP "ramdisk"
524 #define FIT_FDT_PROP "fdt"
525 #define FIT_DEFAULT_PROP "default"
527 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
529 /* cmdline argument format parsing */
530 inline int fit_parse_conf(const char *spec, ulong addr_curr,
531 ulong *addr, const char **conf_name);
532 inline int fit_parse_subimage(const char *spec, ulong addr_curr,
533 ulong *addr, const char **image_name);
535 void fit_print_contents(const void *fit);
536 void fit_image_print(const void *fit, int noffset, const char *p);
537 void fit_image_print_hash(const void *fit, int noffset, const char *p);
540 * fit_get_end - get FIT image size
541 * @fit: pointer to the FIT format image header
544 * size of the FIT image (blob) in memory
546 static inline ulong fit_get_size(const void *fit)
548 return fdt_totalsize(fit);
552 * fit_get_end - get FIT image end
553 * @fit: pointer to the FIT format image header
556 * end address of the FIT image (blob) in memory
558 static inline ulong fit_get_end(const void *fit)
560 return (ulong)fit + fdt_totalsize(fit);
564 * fit_get_name - get FIT node name
565 * @fit: pointer to the FIT format image header
569 * pointer to node name, on success
571 static inline const char *fit_get_name(const void *fit_hdr,
572 int noffset, int *len)
574 return fdt_get_name(fit_hdr, noffset, len);
577 int fit_get_desc(const void *fit, int noffset, char **desc);
578 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
580 int fit_image_get_node(const void *fit, const char *image_uname);
581 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
582 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
583 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
584 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
585 int fit_image_get_load(const void *fit, int noffset, ulong *load);
586 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
587 int fit_image_get_data(const void *fit, int noffset,
588 const void **data, size_t *size);
590 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
591 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
594 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
595 int fit_set_hashes(void *fit);
596 int fit_image_set_hashes(void *fit, int image_noffset);
597 int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value,
600 int fit_image_check_hashes(const void *fit, int noffset);
601 int fit_all_image_check_hashes(const void *fit);
602 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
603 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
604 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
605 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
606 int fit_check_format(const void *fit);
608 int fit_conf_get_node(const void *fit, const char *conf_uname);
609 int fit_conf_get_kernel_node(const void *fit, int noffset);
610 int fit_conf_get_ramdisk_node(const void *fit, int noffset);
611 int fit_conf_get_fdt_node(const void *fit, int noffset);
613 void fit_conf_print(const void *fit, int noffset, const char *p);
616 static inline int fit_image_check_target_arch(const void *fdt, int node)
618 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
620 #endif /* USE_HOSTCC */
622 #ifdef CONFIG_FIT_VERBOSE
623 #define fit_unsupported(msg) printf("! %s:%d " \
624 "FIT images not supported for '%s'\n", \
625 __FILE__, __LINE__, (msg))
627 #define fit_unsupported_reset(msg) printf("! %s:%d " \
628 "FIT images not supported for '%s' " \
629 "- must reset board to recover!\n", \
630 __FILE__, __LINE__, (msg))
632 #define fit_unsupported(msg)
633 #define fit_unsupported_reset(msg)
634 #endif /* CONFIG_FIT_VERBOSE */
635 #endif /* CONFIG_FIT */
637 #endif /* __IMAGE_H__ */