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>
44 /* new uImage format support enabled on target
45 * To be moved to board configuration file */
47 #define CONFIG_OF_LIBFDT 1
48 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
52 /* new uImage format support enabled on host */
54 #define CONFIG_OF_LIBFDT 1
55 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
57 #endif /* USE_HOSTCC */
59 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
60 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
63 #if defined(CONFIG_FIT)
66 #include <fdt_support.h>
67 #define CONFIG_MD5 /* FIT images need MD5 support */
71 * Operating System Codes
73 #define IH_OS_INVALID 0 /* Invalid OS */
74 #define IH_OS_OPENBSD 1 /* OpenBSD */
75 #define IH_OS_NETBSD 2 /* NetBSD */
76 #define IH_OS_FREEBSD 3 /* FreeBSD */
77 #define IH_OS_4_4BSD 4 /* 4.4BSD */
78 #define IH_OS_LINUX 5 /* Linux */
79 #define IH_OS_SVR4 6 /* SVR4 */
80 #define IH_OS_ESIX 7 /* Esix */
81 #define IH_OS_SOLARIS 8 /* Solaris */
82 #define IH_OS_IRIX 9 /* Irix */
83 #define IH_OS_SCO 10 /* SCO */
84 #define IH_OS_DELL 11 /* Dell */
85 #define IH_OS_NCR 12 /* NCR */
86 #define IH_OS_LYNXOS 13 /* LynxOS */
87 #define IH_OS_VXWORKS 14 /* VxWorks */
88 #define IH_OS_PSOS 15 /* pSOS */
89 #define IH_OS_QNX 16 /* QNX */
90 #define IH_OS_U_BOOT 17 /* Firmware */
91 #define IH_OS_RTEMS 18 /* RTEMS */
92 #define IH_OS_ARTOS 19 /* ARTOS */
93 #define IH_OS_UNITY 20 /* Unity OS */
96 * CPU Architecture Codes (supported by Linux)
98 #define IH_ARCH_INVALID 0 /* Invalid CPU */
99 #define IH_ARCH_ALPHA 1 /* Alpha */
100 #define IH_ARCH_ARM 2 /* ARM */
101 #define IH_ARCH_I386 3 /* Intel x86 */
102 #define IH_ARCH_IA64 4 /* IA64 */
103 #define IH_ARCH_MIPS 5 /* MIPS */
104 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
105 #define IH_ARCH_PPC 7 /* PowerPC */
106 #define IH_ARCH_S390 8 /* IBM S390 */
107 #define IH_ARCH_SH 9 /* SuperH */
108 #define IH_ARCH_SPARC 10 /* Sparc */
109 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
110 #define IH_ARCH_M68K 12 /* M68K */
111 #define IH_ARCH_NIOS 13 /* Nios-32 */
112 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
113 #define IH_ARCH_NIOS2 15 /* Nios-II */
114 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
115 #define IH_ARCH_AVR32 17 /* AVR32 */
116 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
121 * "Standalone Programs" are directly runnable in the environment
122 * provided by U-Boot; it is expected that (if they behave
123 * well) you can continue to work in U-Boot after return from
124 * the Standalone Program.
125 * "OS Kernel Images" are usually images of some Embedded OS which
126 * will take over control completely. Usually these programs
127 * will install their own set of exception handlers, device
128 * drivers, set up the MMU, etc. - this means, that you cannot
129 * expect to re-enter U-Boot except by resetting the CPU.
130 * "RAMDisk Images" are more or less just data blocks, and their
131 * parameters (address, size) are passed to an OS kernel that is
133 * "Multi-File Images" contain several images, typically an OS
134 * (Linux) kernel image and one or more data images like
135 * RAMDisks. This construct is useful for instance when you want
136 * to boot over the network using BOOTP etc., where the boot
137 * server provides just a single image file, but you want to get
138 * for instance an OS kernel and a RAMDisk image.
140 * "Multi-File Images" start with a list of image sizes, each
141 * image size (in bytes) specified by an "uint32_t" in network
142 * byte order. This list is terminated by an "(uint32_t)0".
143 * Immediately after the terminating 0 follow the images, one by
144 * one, all aligned on "uint32_t" boundaries (size rounded up to
145 * a multiple of 4 bytes - except for the last file).
147 * "Firmware Images" are binary images containing firmware (like
148 * U-Boot or FPGA images) which usually will be programmed to
151 * "Script files" are command sequences that will be executed by
152 * U-Boot's command interpreter; this feature is especially
153 * useful when you configure U-Boot to use a real shell (hush)
154 * as command interpreter (=> Shell Scripts).
157 #define IH_TYPE_INVALID 0 /* Invalid Image */
158 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
159 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
160 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
161 #define IH_TYPE_MULTI 4 /* Multi-File Image */
162 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
163 #define IH_TYPE_SCRIPT 6 /* Script file */
164 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
165 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
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 */
174 #define IH_MAGIC 0x27051956 /* Image Magic Number */
175 #define IH_NMLEN 32 /* Image Name Length */
178 * Legacy format image header,
179 * all data in network byte order (aka natural aka bigendian).
181 typedef struct image_header {
182 uint32_t ih_magic; /* Image Header Magic Number */
183 uint32_t ih_hcrc; /* Image Header CRC Checksum */
184 uint32_t ih_time; /* Image Creation Timestamp */
185 uint32_t ih_size; /* Image Data Size */
186 uint32_t ih_load; /* Data Load Address */
187 uint32_t ih_ep; /* Entry Point Address */
188 uint32_t ih_dcrc; /* Image Data CRC Checksum */
189 uint8_t ih_os; /* Operating System */
190 uint8_t ih_arch; /* CPU architecture */
191 uint8_t ih_type; /* Image Type */
192 uint8_t ih_comp; /* Compression Type */
193 uint8_t ih_name[IH_NMLEN]; /* Image Name */
197 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
200 typedef struct bootm_headers {
202 * Legacy os image header, if it is a multi component image
203 * then boot_get_ramdisk() and get_fdt() will attempt to get
204 * data from second and third component accordingly.
206 image_header_t *legacy_hdr_os;
207 ulong legacy_hdr_valid;
209 #if defined(CONFIG_FIT)
210 const char *fit_uname_cfg; /* configuration node unit name */
212 void *fit_hdr_os; /* os FIT image header */
213 const char *fit_uname_os; /* os subimage node unit name */
214 int fit_noffset_os; /* os subimage node offset */
216 void *fit_hdr_rd; /* init ramdisk FIT image header */
217 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
218 int fit_noffset_rd; /* init ramdisk subimage node offset */
220 #if defined(CONFIG_PPC)
221 void *fit_hdr_fdt; /* FDT blob FIT image header */
222 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
223 int fit_noffset_fdt;/* FDT blob subimage node offset */
227 int verify; /* getenv("verify")[0] != 'n' */
228 int autostart; /* getenv("autostart")[0] != 'n' */
229 struct lmb *lmb; /* for memory mgmt */
233 * Some systems (for example LWMON) have very short watchdog periods;
234 * we must make sure to split long operations like memmove() or
235 * crc32() into reasonable chunks.
237 #define CHUNKSZ (64 * 1024)
239 #define uimage_to_cpu(x) ntohl(x)
240 #define cpu_to_uimage(x) htonl(x)
242 const char *genimg_get_os_name (uint8_t os);
243 const char *genimg_get_arch_name (uint8_t arch);
244 const char *genimg_get_type_name (uint8_t type);
245 const char *genimg_get_comp_name (uint8_t comp);
246 int genimg_get_os_id (const char *name);
247 int genimg_get_arch_id (const char *name);
248 int genimg_get_type_id (const char *name);
249 int genimg_get_comp_id (const char *name);
252 /* Image format types, returned by _get_format() routine */
253 #define IMAGE_FORMAT_INVALID 0x00
254 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
255 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
257 int genimg_get_format (void *img_addr);
258 int genimg_has_config (bootm_headers_t *images);
259 ulong genimg_get_image (ulong img_addr);
261 int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images,
262 uint8_t arch, ulong *rd_start, ulong *rd_end);
264 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
265 int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
266 ulong *initrd_start, ulong *initrd_end);
268 int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
270 int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
271 #endif /* CONFIG_PPC || CONFIG_M68K */
272 #endif /* !USE_HOSTCC */
274 /*******************************************************************/
275 /* Legacy format specific code (prefixed with image_) */
276 /*******************************************************************/
277 static inline uint32_t image_get_header_size (void)
279 return (sizeof (image_header_t));
282 #define image_get_hdr_l(f) \
283 static inline uint32_t image_get_##f(image_header_t *hdr) \
285 return uimage_to_cpu (hdr->ih_##f); \
287 image_get_hdr_l (magic);
288 image_get_hdr_l (hcrc);
289 image_get_hdr_l (time);
290 image_get_hdr_l (size);
291 image_get_hdr_l (load);
292 image_get_hdr_l (ep);
293 image_get_hdr_l (dcrc);
295 #define image_get_hdr_b(f) \
296 static inline uint8_t image_get_##f(image_header_t *hdr) \
298 return hdr->ih_##f; \
300 image_get_hdr_b (os);
301 image_get_hdr_b (arch);
302 image_get_hdr_b (type);
303 image_get_hdr_b (comp);
305 static inline char *image_get_name (image_header_t *hdr)
307 return (char *)hdr->ih_name;
310 static inline uint32_t image_get_data_size (image_header_t *hdr)
312 return image_get_size (hdr);
316 * image_get_data - get image payload start address
319 * image_get_data() returns address of the image payload. For single
320 * component images it is image data start. For multi component
321 * images it points to the null terminated table of sub-images sizes.
324 * image payload data start address
326 static inline ulong image_get_data (image_header_t *hdr)
328 return ((ulong)hdr + image_get_header_size ());
331 static inline uint32_t image_get_image_size (image_header_t *hdr)
333 return (image_get_size (hdr) + image_get_header_size ());
335 static inline ulong image_get_image_end (image_header_t *hdr)
337 return ((ulong)hdr + image_get_image_size (hdr));
340 #define image_set_hdr_l(f) \
341 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
343 hdr->ih_##f = cpu_to_uimage (val); \
345 image_set_hdr_l (magic);
346 image_set_hdr_l (hcrc);
347 image_set_hdr_l (time);
348 image_set_hdr_l (size);
349 image_set_hdr_l (load);
350 image_set_hdr_l (ep);
351 image_set_hdr_l (dcrc);
353 #define image_set_hdr_b(f) \
354 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
358 image_set_hdr_b (os);
359 image_set_hdr_b (arch);
360 image_set_hdr_b (type);
361 image_set_hdr_b (comp);
363 static inline void image_set_name (image_header_t *hdr, const char *name)
365 strncpy (image_get_name (hdr), name, IH_NMLEN);
368 int image_check_hcrc (image_header_t *hdr);
369 int image_check_dcrc (image_header_t *hdr);
371 int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
372 int getenv_verify (void);
373 int getenv_autostart (void);
374 ulong getenv_bootm_low(void);
375 ulong getenv_bootm_size(void);
376 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
379 static inline int image_check_magic (image_header_t *hdr)
381 return (image_get_magic (hdr) == IH_MAGIC);
383 static inline int image_check_type (image_header_t *hdr, uint8_t type)
385 return (image_get_type (hdr) == type);
387 static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
389 return (image_get_arch (hdr) == arch);
391 static inline int image_check_os (image_header_t *hdr, uint8_t os)
393 return (image_get_os (hdr) == os);
396 ulong image_multi_count (image_header_t *hdr);
397 void image_multi_getimg (image_header_t *hdr, ulong idx,
398 ulong *data, ulong *len);
400 inline void image_print_contents (image_header_t *hdr);
401 inline void image_print_contents_noindent (image_header_t *hdr);
404 static inline int image_check_target_arch (image_header_t *hdr)
407 if (!image_check_arch (hdr, IH_ARCH_ARM))
408 #elif defined(__avr32__)
409 if (!image_check_arch (hdr, IH_ARCH_AVR32))
410 #elif defined(__bfin__)
411 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
412 #elif defined(__I386__)
413 if (!image_check_arch (hdr, IH_ARCH_I386))
414 #elif defined(__M68K__)
415 if (!image_check_arch (hdr, IH_ARCH_M68K))
416 #elif defined(__microblaze__)
417 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
418 #elif defined(__mips__)
419 if (!image_check_arch (hdr, IH_ARCH_MIPS))
420 #elif defined(__nios__)
421 if (!image_check_arch (hdr, IH_ARCH_NIOS))
422 #elif defined(__nios2__)
423 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
424 #elif defined(__PPC__)
425 if (!image_check_arch (hdr, IH_ARCH_PPC))
426 #elif defined(__sh__)
427 if (!image_check_arch (hdr, IH_ARCH_SH))
429 # error Unknown CPU type
435 #endif /* USE_HOSTCC */
437 /*******************************************************************/
438 /* New uImage format specific code (prefixed with fit_) */
439 /*******************************************************************/
440 #if defined(CONFIG_FIT)
442 #define FIT_IMAGES_PATH "/images"
443 #define FIT_CONFS_PATH "/configurations"
446 #define FIT_HASH_NODENAME "hash"
447 #define FIT_ALGO_PROP "algo"
448 #define FIT_VALUE_PROP "value"
451 #define FIT_DATA_PROP "data"
452 #define FIT_TIMESTAMP_PROP "timestamp"
453 #define FIT_DESC_PROP "description"
454 #define FIT_ARCH_PROP "arch"
455 #define FIT_TYPE_PROP "type"
456 #define FIT_OS_PROP "os"
457 #define FIT_COMP_PROP "compression"
458 #define FIT_ENTRY_PROP "entry"
459 #define FIT_LOAD_PROP "load"
461 /* configuration node */
462 #define FIT_KERNEL_PROP "kernel"
463 #define FIT_RAMDISK_PROP "ramdisk"
464 #define FIT_FDT_PROP "fdt"
465 #define FIT_DEFAULT_PROP "default"
467 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
469 /* cmdline argument format parsing */
470 inline int fit_parse_conf (const char *spec, ulong addr_curr,
471 ulong *addr, const char **conf_name);
472 inline int fit_parse_subimage (const char *spec, ulong addr_curr,
473 ulong *addr, const char **image_name);
475 inline void fit_print_contents (const void *fit);
476 inline void fit_print_contents_noindent (const void *fit);
477 void fit_image_print (const void *fit, int noffset, const char *p);
478 void fit_image_print_hash (const void *fit, int noffset, const char *p);
481 * fit_get_end - get FIT image size
482 * @fit: pointer to the FIT format image header
485 * size of the FIT image (blob) in memory
487 static inline ulong fit_get_size (const void *fit)
489 return fdt_totalsize (fit);
493 * fit_get_end - get FIT image end
494 * @fit: pointer to the FIT format image header
497 * end address of the FIT image (blob) in memory
499 static inline ulong fit_get_end (const void *fit)
501 return (ulong)fit + fdt_totalsize (fit);
505 * fit_get_name - get FIT node name
506 * @fit: pointer to the FIT format image header
510 * pointer to node name, on success
512 static inline const char *fit_get_name (const void *fit_hdr,
513 int noffset, int *len)
515 return fdt_get_name (fit_hdr, noffset, len);
518 int fit_get_desc (const void *fit, int noffset, char **desc);
519 int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
521 int fit_image_get_node (const void *fit, const char *image_uname);
522 int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
523 int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
524 int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
525 int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
526 int fit_image_get_load (const void *fit, int noffset, ulong *load);
527 int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
528 int fit_image_get_data (const void *fit, int noffset,
529 const void **data, size_t *size);
531 int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
532 int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
535 int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
536 int fit_set_hashes (void *fit);
537 int fit_image_set_hashes (void *fit, int image_noffset);
538 int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
541 int fit_image_check_hashes (const void *fit, int noffset);
542 int fit_image_check_os (const void *fit, int noffset, uint8_t os);
543 int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
544 int fit_image_check_type (const void *fit, int noffset, uint8_t type);
545 int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
546 int fit_check_format (const void *fit);
548 int fit_conf_get_node (const void *fit, const char *conf_uname);
549 int fit_conf_get_kernel_node (const void *fit, int noffset);
550 int fit_conf_get_ramdisk_node (const void *fit, int noffset);
551 int fit_conf_get_fdt_node (const void *fit, int noffset);
553 void fit_conf_print (const void *fit, int noffset, const char *p);
556 static inline int fit_image_check_target_arch (const void *fdt, int node)
559 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
560 #elif defined(__avr32__)
561 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
562 #elif defined(__bfin__)
563 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
564 #elif defined(__I386__)
565 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
566 #elif defined(__M68K__)
567 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
568 #elif defined(__microblaze__)
569 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
570 #elif defined(__mips__)
571 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
572 #elif defined(__nios__)
573 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
574 #elif defined(__nios2__)
575 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
576 #elif defined(__PPC__)
577 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
578 #elif defined(__sh__)
579 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
581 # error Unknown CPU type
587 #endif /* USE_HOSTCC */
589 #ifdef CONFIG_FIT_VERBOSE
590 #define fit_unsupported(msg) printf ("! %s:%d " \
591 "FIT images not supported for '%s'\n", \
592 __FILE__, __LINE__, (msg))
594 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
595 "FIT images not supported for '%s' " \
596 "- must reset board to recover!\n", \
597 __FILE__, __LINE__, (msg))
599 #define fit_unsupported(msg)
600 #define fit_unsupported_reset(msg)
601 #endif /* CONFIG_FIT_VERBOSE */
602 #endif /* CONFIG_FIT */
604 #endif /* __IMAGE_H__ */