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>
43 #endif /* USE_HOSTCC */
45 /* new uImage format support enabled by default */
47 #define CONFIG_OF_LIBFDT 1
49 /* enable fit_format_error(), fit_format_warning() */
50 #define CONFIG_FIT_VERBOSE 1
52 #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
53 #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
56 #if defined(CONFIG_FIT)
59 #include <fdt_support.h>
63 * Operating System Codes
65 #define IH_OS_INVALID 0 /* Invalid OS */
66 #define IH_OS_OPENBSD 1 /* OpenBSD */
67 #define IH_OS_NETBSD 2 /* NetBSD */
68 #define IH_OS_FREEBSD 3 /* FreeBSD */
69 #define IH_OS_4_4BSD 4 /* 4.4BSD */
70 #define IH_OS_LINUX 5 /* Linux */
71 #define IH_OS_SVR4 6 /* SVR4 */
72 #define IH_OS_ESIX 7 /* Esix */
73 #define IH_OS_SOLARIS 8 /* Solaris */
74 #define IH_OS_IRIX 9 /* Irix */
75 #define IH_OS_SCO 10 /* SCO */
76 #define IH_OS_DELL 11 /* Dell */
77 #define IH_OS_NCR 12 /* NCR */
78 #define IH_OS_LYNXOS 13 /* LynxOS */
79 #define IH_OS_VXWORKS 14 /* VxWorks */
80 #define IH_OS_PSOS 15 /* pSOS */
81 #define IH_OS_QNX 16 /* QNX */
82 #define IH_OS_U_BOOT 17 /* Firmware */
83 #define IH_OS_RTEMS 18 /* RTEMS */
84 #define IH_OS_ARTOS 19 /* ARTOS */
85 #define IH_OS_UNITY 20 /* Unity OS */
88 * CPU Architecture Codes (supported by Linux)
90 #define IH_ARCH_INVALID 0 /* Invalid CPU */
91 #define IH_ARCH_ALPHA 1 /* Alpha */
92 #define IH_ARCH_ARM 2 /* ARM */
93 #define IH_ARCH_I386 3 /* Intel x86 */
94 #define IH_ARCH_IA64 4 /* IA64 */
95 #define IH_ARCH_MIPS 5 /* MIPS */
96 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
97 #define IH_ARCH_PPC 7 /* PowerPC */
98 #define IH_ARCH_S390 8 /* IBM S390 */
99 #define IH_ARCH_SH 9 /* SuperH */
100 #define IH_ARCH_SPARC 10 /* Sparc */
101 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
102 #define IH_ARCH_M68K 12 /* M68K */
103 #define IH_ARCH_NIOS 13 /* Nios-32 */
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 */
162 #define IH_COMP_NONE 0 /* No Compression Used */
163 #define IH_COMP_GZIP 1 /* gzip Compression Used */
164 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
166 #define IH_MAGIC 0x27051956 /* Image Magic Number */
167 #define IH_NMLEN 32 /* Image Name Length */
170 * Legacy format image header,
171 * all data in network byte order (aka natural aka bigendian).
173 typedef struct image_header {
174 uint32_t ih_magic; /* Image Header Magic Number */
175 uint32_t ih_hcrc; /* Image Header CRC Checksum */
176 uint32_t ih_time; /* Image Creation Timestamp */
177 uint32_t ih_size; /* Image Data Size */
178 uint32_t ih_load; /* Data Load Address */
179 uint32_t ih_ep; /* Entry Point Address */
180 uint32_t ih_dcrc; /* Image Data CRC Checksum */
181 uint8_t ih_os; /* Operating System */
182 uint8_t ih_arch; /* CPU architecture */
183 uint8_t ih_type; /* Image Type */
184 uint8_t ih_comp; /* Compression Type */
185 uint8_t ih_name[IH_NMLEN]; /* Image Name */
189 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
192 typedef struct bootm_headers {
194 * Legacy os image header, if it is a multi component image
195 * then boot_get_ramdisk() and get_fdt() will attempt to get
196 * data from second and third component accordingly.
198 image_header_t *legacy_hdr_os;
199 ulong legacy_hdr_valid;
201 #if defined(CONFIG_FIT)
202 void *fit_hdr_os; /* os FIT image header */
203 char *fit_uname_os; /* os subimage node unit name */
205 void *fit_hdr_rd; /* init ramdisk FIT image header */
206 char *fit_uname_rd; /* init ramdisk node unit name */
208 #if defined(CONFIG_PPC)
209 void *fit_hdr_fdt; /* FDT blob FIT image header */
210 char *fit_uname_fdt; /* FDT blob node unit name */
212 int verify; /* getenv("verify")[0] != 'n' */
213 int autostart; /* getenv("autostart")[0] != 'n' */
214 struct lmb *lmb; /* for memory mgmt */
219 * Some systems (for example LWMON) have very short watchdog periods;
220 * we must make sure to split long operations like memmove() or
221 * crc32() into reasonable chunks.
223 #define CHUNKSZ (64 * 1024)
225 #define uimage_to_cpu(x) ntohl(x)
226 #define cpu_to_uimage(x) htonl(x)
228 const char *genimg_get_os_name (uint8_t os);
229 const char *genimg_get_arch_name (uint8_t arch);
230 const char *genimg_get_type_name (uint8_t type);
231 const char *genimg_get_comp_name (uint8_t comp);
232 int genimg_get_os_id (const char *name);
233 int genimg_get_arch_id (const char *name);
234 int genimg_get_type_id (const char *name);
235 int genimg_get_comp_id (const char *name);
238 /* Image format types, returned by _get_format() routine */
239 #define IMAGE_FORMAT_INVALID 0x00
240 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
241 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
243 int genimg_get_format (void *img_addr);
244 ulong genimg_get_image (ulong img_addr);
246 int boot_get_ramdisk (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[],
247 bootm_headers_t *images, uint8_t arch,
248 ulong *rd_start, ulong *rd_end);
250 #if defined(CONFIG_PPC) || defined(CONFIG_M68K)
251 int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
252 ulong *initrd_start, ulong *initrd_end);
254 int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
256 int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
257 #endif /* CONFIG_PPC || CONFIG_M68K */
258 #endif /* !USE_HOSTCC */
260 /*******************************************************************/
261 /* Legacy format specific code (prefixed with image_) */
262 /*******************************************************************/
263 static inline uint32_t image_get_header_size (void)
265 return (sizeof (image_header_t));
268 #define image_get_hdr_l(f) \
269 static inline uint32_t image_get_##f(image_header_t *hdr) \
271 return uimage_to_cpu (hdr->ih_##f); \
273 image_get_hdr_l (magic);
274 image_get_hdr_l (hcrc);
275 image_get_hdr_l (time);
276 image_get_hdr_l (size);
277 image_get_hdr_l (load);
278 image_get_hdr_l (ep);
279 image_get_hdr_l (dcrc);
281 #define image_get_hdr_b(f) \
282 static inline uint8_t image_get_##f(image_header_t *hdr) \
284 return hdr->ih_##f; \
286 image_get_hdr_b (os);
287 image_get_hdr_b (arch);
288 image_get_hdr_b (type);
289 image_get_hdr_b (comp);
291 static inline char *image_get_name (image_header_t *hdr)
293 return (char *)hdr->ih_name;
296 static inline uint32_t image_get_data_size (image_header_t *hdr)
298 return image_get_size (hdr);
302 * image_get_data - get image payload start address
305 * image_get_data() returns address of the image payload. For single
306 * component images it is image data start. For multi component
307 * images it points to the null terminated table of sub-images sizes.
310 * image payload data start address
312 static inline ulong image_get_data (image_header_t *hdr)
314 return ((ulong)hdr + image_get_header_size ());
317 static inline uint32_t image_get_image_size (image_header_t *hdr)
319 return (image_get_size (hdr) + image_get_header_size ());
321 static inline ulong image_get_image_end (image_header_t *hdr)
323 return ((ulong)hdr + image_get_image_size (hdr));
326 #define image_set_hdr_l(f) \
327 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
329 hdr->ih_##f = cpu_to_uimage (val); \
331 image_set_hdr_l (magic);
332 image_set_hdr_l (hcrc);
333 image_set_hdr_l (time);
334 image_set_hdr_l (size);
335 image_set_hdr_l (load);
336 image_set_hdr_l (ep);
337 image_set_hdr_l (dcrc);
339 #define image_set_hdr_b(f) \
340 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
344 image_set_hdr_b (os);
345 image_set_hdr_b (arch);
346 image_set_hdr_b (type);
347 image_set_hdr_b (comp);
349 static inline void image_set_name (image_header_t *hdr, const char *name)
351 strncpy (image_get_name (hdr), name, IH_NMLEN);
354 int image_check_hcrc (image_header_t *hdr);
355 int image_check_dcrc (image_header_t *hdr);
357 int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
358 int getenv_verify (void);
359 int getenv_autostart (void);
360 ulong getenv_bootm_low(void);
361 ulong getenv_bootm_size(void);
362 void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
365 static inline int image_check_magic (image_header_t *hdr)
367 return (image_get_magic (hdr) == IH_MAGIC);
369 static inline int image_check_type (image_header_t *hdr, uint8_t type)
371 return (image_get_type (hdr) == type);
373 static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
375 return (image_get_arch (hdr) == arch);
377 static inline int image_check_os (image_header_t *hdr, uint8_t os)
379 return (image_get_os (hdr) == os);
382 ulong image_multi_count (image_header_t *hdr);
383 void image_multi_getimg (image_header_t *hdr, ulong idx,
384 ulong *data, ulong *len);
386 inline void image_print_contents (image_header_t *hdr);
387 inline void image_print_contents_noindent (image_header_t *hdr);
390 static inline int image_check_target_arch (image_header_t *hdr)
393 if (!image_check_arch (hdr, IH_ARCH_ARM))
394 #elif defined(__avr32__)
395 if (!image_check_arch (hdr, IH_ARCH_AVR32))
396 #elif defined(__bfin__)
397 if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
398 #elif defined(__I386__)
399 if (!image_check_arch (hdr, IH_ARCH_I386))
400 #elif defined(__M68K__)
401 if (!image_check_arch (hdr, IH_ARCH_M68K))
402 #elif defined(__microblaze__)
403 if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
404 #elif defined(__mips__)
405 if (!image_check_arch (hdr, IH_ARCH_MIPS))
406 #elif defined(__nios__)
407 if (!image_check_arch (hdr, IH_ARCH_NIOS))
408 #elif defined(__nios2__)
409 if (!image_check_arch (hdr, IH_ARCH_NIOS2))
410 #elif defined(__PPC__)
411 if (!image_check_arch (hdr, IH_ARCH_PPC))
412 #elif defined(__sh__)
413 if (!image_check_arch (hdr, IH_ARCH_SH))
415 # error Unknown CPU type
421 #endif /* USE_HOSTCC */
423 /*******************************************************************/
424 /* New uImage format specific code (prefixed with fit_) */
425 /*******************************************************************/
426 #if defined(CONFIG_FIT)
428 #define FIT_IMAGES_PATH "/images"
429 #define FIT_CONFS_PATH "/configurations"
432 #define FIT_HASH_NODENAME "hash"
433 #define FIT_ALGO_PROP "algo"
434 #define FIT_VALUE_PROP "value"
437 #define FIT_DATA_PROP "data"
438 #define FIT_TIMESTAMP_PROP "timestamp"
439 #define FIT_DESC_PROP "description"
440 #define FIT_ARCH_PROP "arch"
441 #define FIT_TYPE_PROP "type"
442 #define FIT_OS_PROP "os"
443 #define FIT_COMP_PROP "compression"
444 #define FIT_ENTRY_PROP "entry"
445 #define FIT_LOAD_PROP "load"
447 /* configuration node */
448 #define FIT_KERNEL_PROP "kernel"
449 #define FIT_RAMDISK_PROP "ramdisk"
450 #define FIT_FDT_PROP "fdt"
451 #define FIT_DEFAULT_PROP "default"
453 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
455 /* cmdline argument format parsing */
456 inline int fit_parse_conf (const char *spec, ulong addr_curr,
457 ulong *addr, const char **conf_name);
458 inline int fit_parse_subimage (const char *spec, ulong addr_curr,
459 ulong *addr, const char **image_name);
461 inline void fit_print_contents (const void *fit);
462 inline void fit_print_contents_noindent (const void *fit);
463 void fit_image_print (const void *fit, int noffset, const char *p);
464 void fit_image_print_hash (const void *fit, int noffset, const char *p);
467 * fit_get_end - get FIT image size
468 * @fit: pointer to the FIT format image header
471 * size of the FIT image (blob) in memory
473 static inline ulong fit_get_size (const void *fit)
475 return fdt_totalsize (fit);
479 * fit_get_end - get FIT image end
480 * @fit: pointer to the FIT format image header
483 * end address of the FIT image (blob) in memory
485 static inline ulong fit_get_end (const void *fit)
487 return (ulong)fit + fdt_totalsize (fit);
491 * fit_get_name - get FIT node name
492 * @fit: pointer to the FIT format image header
496 * pointer to node name, on success
498 static inline const char *fit_get_name (const void *fit_hdr,
499 int noffset, int *len)
501 return fdt_get_name (fit_hdr, noffset, len);
504 int fit_get_desc (const void *fit, int noffset, char **desc);
505 int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
507 int fit_image_get_node (const void *fit, const char *image_uname);
508 int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
509 int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
510 int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
511 int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
512 int fit_image_get_load (const void *fit, int noffset, ulong *load);
513 int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
514 int fit_image_get_data (const void *fit, int noffset,
515 const void **data, size_t *size);
517 int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
518 int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
521 int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
522 int fit_set_hashes (void *fit);
523 int fit_image_set_hashes (void *fit, int image_noffset);
524 int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
527 int fit_image_check_hashes (const void *fit, int noffset);
528 int fit_image_check_os (const void *fit, int noffset, uint8_t os);
529 int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
530 int fit_image_check_type (const void *fit, int noffset, uint8_t type);
531 int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
532 int fit_check_format (const void *fit);
534 int fit_conf_get_node (const void *fit, const char *conf_uname);
535 int fit_conf_get_kernel_node (const void *fit, int noffset);
536 int fit_conf_get_ramdisk_node (const void *fit, int noffset);
537 int fit_conf_get_fdt_node (const void *fit, int noffset);
539 void fit_conf_print (const void *fit, int noffset, const char *p);
542 static inline int fit_image_check_target_arch (const void *fdt, int node)
545 if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM))
546 #elif defined(__avr32__)
547 if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32))
548 #elif defined(__bfin__)
549 if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN))
550 #elif defined(__I386__)
551 if (!fit_image_check_arch (fdt, node, IH_ARCH_I386))
552 #elif defined(__M68K__)
553 if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K))
554 #elif defined(__microblaze__)
555 if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE))
556 #elif defined(__mips__)
557 if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS))
558 #elif defined(__nios__)
559 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS))
560 #elif defined(__nios2__)
561 if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2))
562 #elif defined(__PPC__)
563 if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC))
564 #elif defined(__sh__)
565 if (!fit_image_check_arch (fdt, node, IH_ARCH_SH))
567 # error Unknown CPU type
573 #endif /* USE_HOSTCC */
575 #ifdef CONFIG_FIT_VERBOSE
576 #define fit_unsupported(msg) printf ("! %s:%d " \
577 "FIT images not supported for '%s'\n", \
578 __FILE__, __LINE__, (msg))
580 #define fit_unsupported_reset(msg) printf ("! %s:%d " \
581 "FIT images not supported for '%s' " \
582 "- must reset board to recover!\n", \
583 __FILE__, __LINE__, (msg))
585 #define fit_unsupported(msg)
586 #define fit_unsupported_reset(msg)
587 #endif /* CONFIG_FIT_VERBOSE */
588 #endif /* CONFIG_FIT */
590 #endif /* __IMAGE_H__ */