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 ********************************************************************
37 #include <asm/byteorder.h>
39 /* Define this to avoid #ifdefs later on */
44 /* new uImage format support enabled on host */
46 #define CONFIG_OF_LIBFDT 1
47 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
49 #define IMAGE_ENABLE_IGNORE 0
50 #define IMAGE_INDENT_STRING ""
55 #include <asm/u-boot.h>
58 /* Take notice of the 'ignore' property for hashes */
59 #define IMAGE_ENABLE_IGNORE 1
60 #define IMAGE_INDENT_STRING " "
62 #endif /* USE_HOSTCC */
64 #if defined(CONFIG_FIT)
66 #include <fdt_support.h>
67 # ifdef CONFIG_SPL_BUILD
68 # ifdef CONFIG_SPL_CRC32_SUPPORT
69 # define IMAGE_ENABLE_CRC32 1
71 # ifdef CONFIG_SPL_MD5_SUPPORT
72 # define IMAGE_ENABLE_MD5 1
74 # ifdef CONFIG_SPL_SHA1_SUPPORT
75 # define IMAGE_ENABLE_SHA1 1
78 # define CONFIG_CRC32 /* FIT images need CRC32 support */
79 # define CONFIG_MD5 /* and MD5 */
80 # define CONFIG_SHA1 /* and SHA1 */
81 # define IMAGE_ENABLE_CRC32 1
82 # define IMAGE_ENABLE_MD5 1
83 # define IMAGE_ENABLE_SHA1 1
86 #ifndef IMAGE_ENABLE_CRC32
87 #define IMAGE_ENABLE_CRC32 0
90 #ifndef IMAGE_ENABLE_MD5
91 #define IMAGE_ENABLE_MD5 0
94 #ifndef IMAGE_ENABLE_SHA1
95 #define IMAGE_ENABLE_SHA1 0
98 #endif /* CONFIG_FIT */
100 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
101 # define IMAGE_ENABLE_RAMDISK_HIGH 1
103 # define IMAGE_ENABLE_RAMDISK_HIGH 0
106 #ifdef CONFIG_OF_LIBFDT
107 # define IMAGE_ENABLE_OF_LIBFDT 1
109 # define IMAGE_ENABLE_OF_LIBFDT 0
112 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
113 # define IMAGE_BOOT_GET_CMDLINE 1
115 # define IMAGE_BOOT_GET_CMDLINE 0
118 #ifdef CONFIG_OF_BOARD_SETUP
119 # define IMAAGE_OF_BOARD_SETUP 1
121 # define IMAAGE_OF_BOARD_SETUP 0
125 * Operating System Codes
127 #define IH_OS_INVALID 0 /* Invalid OS */
128 #define IH_OS_OPENBSD 1 /* OpenBSD */
129 #define IH_OS_NETBSD 2 /* NetBSD */
130 #define IH_OS_FREEBSD 3 /* FreeBSD */
131 #define IH_OS_4_4BSD 4 /* 4.4BSD */
132 #define IH_OS_LINUX 5 /* Linux */
133 #define IH_OS_SVR4 6 /* SVR4 */
134 #define IH_OS_ESIX 7 /* Esix */
135 #define IH_OS_SOLARIS 8 /* Solaris */
136 #define IH_OS_IRIX 9 /* Irix */
137 #define IH_OS_SCO 10 /* SCO */
138 #define IH_OS_DELL 11 /* Dell */
139 #define IH_OS_NCR 12 /* NCR */
140 #define IH_OS_LYNXOS 13 /* LynxOS */
141 #define IH_OS_VXWORKS 14 /* VxWorks */
142 #define IH_OS_PSOS 15 /* pSOS */
143 #define IH_OS_QNX 16 /* QNX */
144 #define IH_OS_U_BOOT 17 /* Firmware */
145 #define IH_OS_RTEMS 18 /* RTEMS */
146 #define IH_OS_ARTOS 19 /* ARTOS */
147 #define IH_OS_UNITY 20 /* Unity OS */
148 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
149 #define IH_OS_OSE 22 /* OSE */
150 #define IH_OS_PLAN9 23 /* Plan 9 */
153 * CPU Architecture Codes (supported by Linux)
155 #define IH_ARCH_INVALID 0 /* Invalid CPU */
156 #define IH_ARCH_ALPHA 1 /* Alpha */
157 #define IH_ARCH_ARM 2 /* ARM */
158 #define IH_ARCH_I386 3 /* Intel x86 */
159 #define IH_ARCH_IA64 4 /* IA64 */
160 #define IH_ARCH_MIPS 5 /* MIPS */
161 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
162 #define IH_ARCH_PPC 7 /* PowerPC */
163 #define IH_ARCH_S390 8 /* IBM S390 */
164 #define IH_ARCH_SH 9 /* SuperH */
165 #define IH_ARCH_SPARC 10 /* Sparc */
166 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
167 #define IH_ARCH_M68K 12 /* M68K */
168 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
169 #define IH_ARCH_NIOS2 15 /* Nios-II */
170 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
171 #define IH_ARCH_AVR32 17 /* AVR32 */
172 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
173 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
174 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
175 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
180 * "Standalone Programs" are directly runnable in the environment
181 * provided by U-Boot; it is expected that (if they behave
182 * well) you can continue to work in U-Boot after return from
183 * the Standalone Program.
184 * "OS Kernel Images" are usually images of some Embedded OS which
185 * will take over control completely. Usually these programs
186 * will install their own set of exception handlers, device
187 * drivers, set up the MMU, etc. - this means, that you cannot
188 * expect to re-enter U-Boot except by resetting the CPU.
189 * "RAMDisk Images" are more or less just data blocks, and their
190 * parameters (address, size) are passed to an OS kernel that is
192 * "Multi-File Images" contain several images, typically an OS
193 * (Linux) kernel image and one or more data images like
194 * RAMDisks. This construct is useful for instance when you want
195 * to boot over the network using BOOTP etc., where the boot
196 * server provides just a single image file, but you want to get
197 * for instance an OS kernel and a RAMDisk image.
199 * "Multi-File Images" start with a list of image sizes, each
200 * image size (in bytes) specified by an "uint32_t" in network
201 * byte order. This list is terminated by an "(uint32_t)0".
202 * Immediately after the terminating 0 follow the images, one by
203 * one, all aligned on "uint32_t" boundaries (size rounded up to
204 * a multiple of 4 bytes - except for the last file).
206 * "Firmware Images" are binary images containing firmware (like
207 * U-Boot or FPGA images) which usually will be programmed to
210 * "Script files" are command sequences that will be executed by
211 * U-Boot's command interpreter; this feature is especially
212 * useful when you configure U-Boot to use a real shell (hush)
213 * as command interpreter (=> Shell Scripts).
216 #define IH_TYPE_INVALID 0 /* Invalid Image */
217 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
218 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
219 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
220 #define IH_TYPE_MULTI 4 /* Multi-File Image */
221 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
222 #define IH_TYPE_SCRIPT 6 /* Script file */
223 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
224 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
225 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
226 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
227 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
228 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
229 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
230 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
231 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
236 #define IH_COMP_NONE 0 /* No Compression Used */
237 #define IH_COMP_GZIP 1 /* gzip Compression Used */
238 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
239 #define IH_COMP_LZMA 3 /* lzma Compression Used */
240 #define IH_COMP_LZO 4 /* lzo Compression Used */
242 #define IH_MAGIC 0x27051956 /* Image Magic Number */
243 #define IH_NMLEN 32 /* Image Name Length */
245 /* Reused from common.h */
246 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
249 * Legacy format image header,
250 * all data in network byte order (aka natural aka bigendian).
252 typedef struct image_header {
253 __be32 ih_magic; /* Image Header Magic Number */
254 __be32 ih_hcrc; /* Image Header CRC Checksum */
255 __be32 ih_time; /* Image Creation Timestamp */
256 __be32 ih_size; /* Image Data Size */
257 __be32 ih_load; /* Data Load Address */
258 __be32 ih_ep; /* Entry Point Address */
259 __be32 ih_dcrc; /* Image Data CRC Checksum */
260 uint8_t ih_os; /* Operating System */
261 uint8_t ih_arch; /* CPU architecture */
262 uint8_t ih_type; /* Image Type */
263 uint8_t ih_comp; /* Compression Type */
264 uint8_t ih_name[IH_NMLEN]; /* Image Name */
267 typedef struct image_info {
268 ulong start, end; /* start/end of blob */
269 ulong image_start, image_len; /* start of image within blob, len of image */
270 ulong load; /* load addr for the image */
271 uint8_t comp, type, os; /* compression, type of image, os type */
275 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
278 typedef struct bootm_headers {
280 * Legacy os image header, if it is a multi component image
281 * then boot_get_ramdisk() and get_fdt() will attempt to get
282 * data from second and third component accordingly.
284 image_header_t *legacy_hdr_os; /* image header pointer */
285 image_header_t legacy_hdr_os_copy; /* header copy */
286 ulong legacy_hdr_valid;
288 #if defined(CONFIG_FIT)
289 const char *fit_uname_cfg; /* configuration node unit name */
291 void *fit_hdr_os; /* os FIT image header */
292 const char *fit_uname_os; /* os subimage node unit name */
293 int fit_noffset_os; /* os subimage node offset */
295 void *fit_hdr_rd; /* init ramdisk FIT image header */
296 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
297 int fit_noffset_rd; /* init ramdisk subimage node offset */
299 void *fit_hdr_fdt; /* FDT blob FIT image header */
300 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
301 int fit_noffset_fdt;/* FDT blob subimage node offset */
305 image_info_t os; /* os image info */
306 ulong ep; /* entry point of OS */
308 ulong rd_start, rd_end;/* ramdisk start/end */
310 char *ft_addr; /* flat dev tree address */
311 ulong ft_len; /* length of flat device tree */
320 int verify; /* getenv("verify")[0] != 'n' */
322 #define BOOTM_STATE_START (0x00000001)
323 #define BOOTM_STATE_LOADOS (0x00000002)
324 #define BOOTM_STATE_RAMDISK (0x00000004)
325 #define BOOTM_STATE_FDT (0x00000008)
326 #define BOOTM_STATE_OS_CMDLINE (0x00000010)
327 #define BOOTM_STATE_OS_BD_T (0x00000020)
328 #define BOOTM_STATE_OS_PREP (0x00000040)
329 #define BOOTM_STATE_OS_GO (0x00000080)
333 struct lmb lmb; /* for memory mgmt */
337 extern bootm_headers_t images;
340 * Some systems (for example LWMON) have very short watchdog periods;
341 * we must make sure to split long operations like memmove() or
342 * checksum calculations into reasonable chunks.
345 #define CHUNKSZ (64 * 1024)
348 #ifndef CHUNKSZ_CRC32
349 #define CHUNKSZ_CRC32 (64 * 1024)
353 #define CHUNKSZ_MD5 (64 * 1024)
357 #define CHUNKSZ_SHA1 (64 * 1024)
360 #define uimage_to_cpu(x) be32_to_cpu(x)
361 #define cpu_to_uimage(x) cpu_to_be32(x)
364 * Translation table for entries of a specific type; used by
365 * get_table_entry_id() and get_table_entry_name().
367 typedef struct table_entry {
369 char *sname; /* short (input) name to find table entry */
370 char *lname; /* long (output) name to print for messages */
374 * get_table_entry_id() scans the translation table trying to find an
375 * entry that matches the given short name. If a matching entry is
376 * found, it's id is returned to the caller.
378 int get_table_entry_id(const table_entry_t *table,
379 const char *table_name, const char *name);
381 * get_table_entry_name() scans the translation table trying to find
382 * an entry that matches the given id. If a matching entry is found,
383 * its long name is returned to the caller.
385 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
387 const char *genimg_get_os_name(uint8_t os);
388 const char *genimg_get_arch_name(uint8_t arch);
389 const char *genimg_get_type_name(uint8_t type);
390 const char *genimg_get_comp_name(uint8_t comp);
391 int genimg_get_os_id(const char *name);
392 int genimg_get_arch_id(const char *name);
393 int genimg_get_type_id(const char *name);
394 int genimg_get_comp_id(const char *name);
395 void genimg_print_size(uint32_t size);
397 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
399 #define IMAGE_ENABLE_TIMESTAMP 1
401 #define IMAGE_ENABLE_TIMESTAMP 0
403 void genimg_print_time(time_t timestamp);
405 /* What to do with a image load address ('load = <> 'in the FIT) */
407 FIT_LOAD_IGNORED, /* Ignore load address */
408 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
409 FIT_LOAD_REQUIRED, /* Must be provided */
413 /* Image format types, returned by _get_format() routine */
414 #define IMAGE_FORMAT_INVALID 0x00
415 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
416 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
418 int genimg_get_format(const void *img_addr);
419 int genimg_has_config(bootm_headers_t *images);
420 ulong genimg_get_image(ulong img_addr);
422 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
423 uint8_t arch, ulong *rd_start, ulong *rd_end);
426 * fit_image_load() - load an image from a FIT
428 * This deals with all aspects of loading an image from a FIT, including
429 * selecting the right image based on configuration, verifying it, printing
430 * out progress messages, checking the type/arch/os and optionally copying it
431 * to the right load address.
433 * @param images Boot images structure
434 * @param prop_name Property name to look up (FIT_..._PROP)
435 * @param addr Address of FIT in memory
436 * @param fit_unamep On entry this is the requested image name
437 * (e.g. "kernel@1") or NULL to use the default. On exit
438 * points to the selected image name
439 * @param fit_uname_config Requested configuration name, or NULL for the
441 * @param arch Expected architecture (IH_ARCH_...)
442 * @param image_type Required image type (IH_TYPE_...). If this is
443 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
445 * @param bootstage_id ID of starting bootstage to use for progress updates.
446 * This will be added to the BOOTSTAGE_SUB values when
447 * calling bootstage_mark()
448 * @param load_op Decribes what to do with the load address
449 * @param datap Returns address of loaded image
450 * @param lenp Returns length of loaded image
452 int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
453 const char **fit_unamep, const char *fit_uname_config,
454 int arch, int image_type, int bootstage_id,
455 enum fit_load_op load_op, ulong *datap, ulong *lenp);
458 * fit_get_node_from_config() - Look up an image a FIT by type
460 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
461 * particular image type (e.g. "kernel") and then finds the image that is
464 * For example, for something like:
473 * kernel = "kernel@1";
477 * the function will return the node offset of the kernel@1 node, assuming
478 * that conf@1 is the chosen configuration.
480 * @param images Boot images structure
481 * @param prop_name Property name to look up (FIT_..._PROP)
482 * @param addr Address of FIT in memory
484 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
487 int boot_get_fdt(int flag, int argc, char * const argv[],
488 bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
489 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
490 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
492 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
493 ulong *initrd_start, ulong *initrd_end);
494 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
495 #ifdef CONFIG_SYS_BOOT_GET_KBD
496 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
497 #endif /* CONFIG_SYS_BOOT_GET_KBD */
498 #endif /* !USE_HOSTCC */
500 /*******************************************************************/
501 /* Legacy format specific code (prefixed with image_) */
502 /*******************************************************************/
503 static inline uint32_t image_get_header_size(void)
505 return (sizeof(image_header_t));
508 #define image_get_hdr_l(f) \
509 static inline uint32_t image_get_##f(const image_header_t *hdr) \
511 return uimage_to_cpu(hdr->ih_##f); \
513 image_get_hdr_l(magic) /* image_get_magic */
514 image_get_hdr_l(hcrc) /* image_get_hcrc */
515 image_get_hdr_l(time) /* image_get_time */
516 image_get_hdr_l(size) /* image_get_size */
517 image_get_hdr_l(load) /* image_get_load */
518 image_get_hdr_l(ep) /* image_get_ep */
519 image_get_hdr_l(dcrc) /* image_get_dcrc */
521 #define image_get_hdr_b(f) \
522 static inline uint8_t image_get_##f(const image_header_t *hdr) \
524 return hdr->ih_##f; \
526 image_get_hdr_b(os) /* image_get_os */
527 image_get_hdr_b(arch) /* image_get_arch */
528 image_get_hdr_b(type) /* image_get_type */
529 image_get_hdr_b(comp) /* image_get_comp */
531 static inline char *image_get_name(const image_header_t *hdr)
533 return (char *)hdr->ih_name;
536 static inline uint32_t image_get_data_size(const image_header_t *hdr)
538 return image_get_size(hdr);
542 * image_get_data - get image payload start address
545 * image_get_data() returns address of the image payload. For single
546 * component images it is image data start. For multi component
547 * images it points to the null terminated table of sub-images sizes.
550 * image payload data start address
552 static inline ulong image_get_data(const image_header_t *hdr)
554 return ((ulong)hdr + image_get_header_size());
557 static inline uint32_t image_get_image_size(const image_header_t *hdr)
559 return (image_get_size(hdr) + image_get_header_size());
561 static inline ulong image_get_image_end(const image_header_t *hdr)
563 return ((ulong)hdr + image_get_image_size(hdr));
566 #define image_set_hdr_l(f) \
567 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
569 hdr->ih_##f = cpu_to_uimage(val); \
571 image_set_hdr_l(magic) /* image_set_magic */
572 image_set_hdr_l(hcrc) /* image_set_hcrc */
573 image_set_hdr_l(time) /* image_set_time */
574 image_set_hdr_l(size) /* image_set_size */
575 image_set_hdr_l(load) /* image_set_load */
576 image_set_hdr_l(ep) /* image_set_ep */
577 image_set_hdr_l(dcrc) /* image_set_dcrc */
579 #define image_set_hdr_b(f) \
580 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
584 image_set_hdr_b(os) /* image_set_os */
585 image_set_hdr_b(arch) /* image_set_arch */
586 image_set_hdr_b(type) /* image_set_type */
587 image_set_hdr_b(comp) /* image_set_comp */
589 static inline void image_set_name(image_header_t *hdr, const char *name)
591 strncpy(image_get_name(hdr), name, IH_NMLEN);
594 int image_check_hcrc(const image_header_t *hdr);
595 int image_check_dcrc(const image_header_t *hdr);
597 ulong getenv_bootm_low(void);
598 phys_size_t getenv_bootm_size(void);
599 phys_size_t getenv_bootm_mapsize(void);
600 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
603 static inline int image_check_magic(const image_header_t *hdr)
605 return (image_get_magic(hdr) == IH_MAGIC);
607 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
609 return (image_get_type(hdr) == type);
611 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
613 return (image_get_arch(hdr) == arch);
615 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
617 return (image_get_os(hdr) == os);
620 ulong image_multi_count(const image_header_t *hdr);
621 void image_multi_getimg(const image_header_t *hdr, ulong idx,
622 ulong *data, ulong *len);
624 void image_print_contents(const void *hdr);
627 static inline int image_check_target_arch(const image_header_t *hdr)
629 #ifndef IH_ARCH_DEFAULT
630 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
632 return image_check_arch(hdr, IH_ARCH_DEFAULT);
634 #endif /* USE_HOSTCC */
637 * Set up properties in the FDT
639 * This sets up properties in the FDT that is to be passed to linux.
641 * @images: Images information
642 * @blob: FDT to update
643 * @of_size: Size of the FDT
644 * @lmb: Points to logical memory block structure
645 * @return 0 if ok, <0 on failure
647 int image_setup_libfdt(bootm_headers_t *images, void *blob,
648 int of_size, struct lmb *lmb);
651 * Set up the FDT to use for booting a kernel
653 * This performs ramdisk setup, sets up the FDT if required, and adds
654 * paramters to the FDT if libfdt is available.
656 * @param images Images information
657 * @return 0 if ok, <0 on failure
659 int image_setup_linux(bootm_headers_t *images);
661 /*******************************************************************/
662 /* New uImage format specific code (prefixed with fit_) */
663 /*******************************************************************/
664 #if defined(CONFIG_FIT)
666 #define FIT_IMAGES_PATH "/images"
667 #define FIT_CONFS_PATH "/configurations"
670 #define FIT_HASH_NODENAME "hash"
671 #define FIT_ALGO_PROP "algo"
672 #define FIT_VALUE_PROP "value"
673 #define FIT_IGNORE_PROP "uboot-ignore"
676 #define FIT_DATA_PROP "data"
677 #define FIT_TIMESTAMP_PROP "timestamp"
678 #define FIT_DESC_PROP "description"
679 #define FIT_ARCH_PROP "arch"
680 #define FIT_TYPE_PROP "type"
681 #define FIT_OS_PROP "os"
682 #define FIT_COMP_PROP "compression"
683 #define FIT_ENTRY_PROP "entry"
684 #define FIT_LOAD_PROP "load"
686 /* configuration node */
687 #define FIT_KERNEL_PROP "kernel"
688 #define FIT_RAMDISK_PROP "ramdisk"
689 #define FIT_FDT_PROP "fdt"
690 #define FIT_DEFAULT_PROP "default"
692 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
694 /* cmdline argument format parsing */
695 int fit_parse_conf(const char *spec, ulong addr_curr,
696 ulong *addr, const char **conf_name);
697 int fit_parse_subimage(const char *spec, ulong addr_curr,
698 ulong *addr, const char **image_name);
700 void fit_print_contents(const void *fit);
701 void fit_image_print(const void *fit, int noffset, const char *p);
704 * fit_get_end - get FIT image size
705 * @fit: pointer to the FIT format image header
708 * size of the FIT image (blob) in memory
710 static inline ulong fit_get_size(const void *fit)
712 return fdt_totalsize(fit);
716 * fit_get_end - get FIT image end
717 * @fit: pointer to the FIT format image header
720 * end address of the FIT image (blob) in memory
722 static inline ulong fit_get_end(const void *fit)
724 return (ulong)fit + fdt_totalsize(fit);
728 * fit_get_name - get FIT node name
729 * @fit: pointer to the FIT format image header
733 * pointer to node name, on success
735 static inline const char *fit_get_name(const void *fit_hdr,
736 int noffset, int *len)
738 return fdt_get_name(fit_hdr, noffset, len);
741 int fit_get_desc(const void *fit, int noffset, char **desc);
742 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
744 int fit_image_get_node(const void *fit, const char *image_uname);
745 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
746 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
747 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
748 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
749 int fit_image_get_load(const void *fit, int noffset, ulong *load);
750 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
751 int fit_image_get_data(const void *fit, int noffset,
752 const void **data, size_t *size);
754 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
755 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
758 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
761 * fit_add_verification_data() - Calculate and add hashes to FIT
763 * @fit: Fit image to process
764 * @return 0 if ok, <0 for error
766 int fit_add_verification_data(void *fit);
768 int fit_image_verify(const void *fit, int noffset);
769 int fit_config_verify(const void *fit, int conf_noffset);
770 int fit_all_image_verify(const void *fit);
771 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
772 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
773 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
774 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
775 int fit_check_format(const void *fit);
777 int fit_conf_find_compat(const void *fit, const void *fdt);
778 int fit_conf_get_node(const void *fit, const char *conf_uname);
779 int fit_conf_get_kernel_node(const void *fit, int noffset);
780 int fit_conf_get_ramdisk_node(const void *fit, int noffset);
781 int fit_conf_get_fdt_node(const void *fit, int noffset);
784 * fit_conf_get_prop_node() - Get node refered to by a configuration
786 * @noffset: Offset of conf@xxx node to check
787 * @prop_name: Property to read from the conf node
789 * The conf@ nodes contain references to other nodes, using properties
790 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
791 * return the offset of the node referred to (e.g. offset of node
792 * "/images/kernel@1".
794 int fit_conf_get_prop_node(const void *fit, int noffset,
795 const char *prop_name);
797 void fit_conf_print(const void *fit, int noffset, const char *p);
799 int fit_check_ramdisk(const void *fit, int os_noffset,
800 uint8_t arch, int verify);
802 int calculate_hash(const void *data, int data_len, const char *algo,
803 uint8_t *value, int *value_len);
806 * At present we only support verification on the device
808 #if defined(CONFIG_FIT_SIGNATURE)
810 # define IMAGE_ENABLE_VERIFY 0
812 # define IMAGE_ENABLE_VERIFY 1
815 # define IMAGE_ENABLE_VERIFY 0
819 # define gd_fdt_blob() NULL
821 # define gd_fdt_blob() (gd->fdt_blob)
824 #ifdef CONFIG_FIT_BEST_MATCH
825 #define IMAGE_ENABLE_BEST_MATCH 1
827 #define IMAGE_ENABLE_BEST_MATCH 0
830 static inline int fit_image_check_target_arch(const void *fdt, int node)
832 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
835 #ifdef CONFIG_FIT_VERBOSE
836 #define fit_unsupported(msg) printf("! %s:%d " \
837 "FIT images not supported for '%s'\n", \
838 __FILE__, __LINE__, (msg))
840 #define fit_unsupported_reset(msg) printf("! %s:%d " \
841 "FIT images not supported for '%s' " \
842 "- must reset board to recover!\n", \
843 __FILE__, __LINE__, (msg))
845 #define fit_unsupported(msg)
846 #define fit_unsupported_reset(msg)
847 #endif /* CONFIG_FIT_VERBOSE */
848 #endif /* CONFIG_FIT */
850 #endif /* __IMAGE_H__ */