]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/image.h
Merge branch 'master' of git://git.denx.de/u-boot-uniphier
[people/ms/u-boot.git] / include / image.h
1 /*
2 * (C) Copyright 2008 Semihalf
3 *
4 * (C) Copyright 2000-2005
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 *
7 * SPDX-License-Identifier: GPL-2.0+
8 ********************************************************************
9 * NOTE: This header file defines an interface to U-Boot. Including
10 * this (unmodified) header file in another file is considered normal
11 * use of U-Boot, and does *not* fall under the heading of "derived
12 * work".
13 ********************************************************************
14 */
15
16 #ifndef __IMAGE_H__
17 #define __IMAGE_H__
18
19 #include "compiler.h"
20 #include <asm/byteorder.h>
21
22 /* Define this to avoid #ifdefs later on */
23 struct lmb;
24
25 #ifdef USE_HOSTCC
26 #include <sys/types.h>
27
28 /* new uImage format support enabled on host */
29 #define IMAGE_ENABLE_FIT 1
30 #define IMAGE_ENABLE_OF_LIBFDT 1
31 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
32
33 #define IMAGE_ENABLE_IGNORE 0
34 #define IMAGE_INDENT_STRING ""
35
36 #else
37
38 #include <lmb.h>
39 #include <asm/u-boot.h>
40 #include <command.h>
41
42 /* Take notice of the 'ignore' property for hashes */
43 #define IMAGE_ENABLE_IGNORE 1
44 #define IMAGE_INDENT_STRING " "
45
46 #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
47 #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
48
49 #endif /* USE_HOSTCC */
50
51 #if IMAGE_ENABLE_FIT
52 #include <hash.h>
53 #include <libfdt.h>
54 #include <fdt_support.h>
55 # ifdef CONFIG_SPL_BUILD
56 # ifdef CONFIG_SPL_CRC32_SUPPORT
57 # define IMAGE_ENABLE_CRC32 1
58 # endif
59 # ifdef CONFIG_SPL_MD5_SUPPORT
60 # define IMAGE_ENABLE_MD5 1
61 # endif
62 # ifdef CONFIG_SPL_SHA1_SUPPORT
63 # define IMAGE_ENABLE_SHA1 1
64 # endif
65 # ifdef CONFIG_SPL_SHA256_SUPPORT
66 # define IMAGE_ENABLE_SHA256 1
67 # endif
68 # else
69 # define CONFIG_CRC32 /* FIT images need CRC32 support */
70 # define CONFIG_MD5 /* and MD5 */
71 # define CONFIG_SHA1 /* and SHA1 */
72 # define CONFIG_SHA256 /* and SHA256 */
73 # define IMAGE_ENABLE_CRC32 1
74 # define IMAGE_ENABLE_MD5 1
75 # define IMAGE_ENABLE_SHA1 1
76 # define IMAGE_ENABLE_SHA256 1
77 # endif
78
79 #ifdef CONFIG_FIT_DISABLE_SHA256
80 #undef CONFIG_SHA256
81 #undef IMAGE_ENABLE_SHA256
82 #endif
83
84 #ifndef IMAGE_ENABLE_CRC32
85 #define IMAGE_ENABLE_CRC32 0
86 #endif
87
88 #ifndef IMAGE_ENABLE_MD5
89 #define IMAGE_ENABLE_MD5 0
90 #endif
91
92 #ifndef IMAGE_ENABLE_SHA1
93 #define IMAGE_ENABLE_SHA1 0
94 #endif
95
96 #ifndef IMAGE_ENABLE_SHA256
97 #define IMAGE_ENABLE_SHA256 0
98 #endif
99
100 #endif /* IMAGE_ENABLE_FIT */
101
102 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
103 # define IMAGE_ENABLE_RAMDISK_HIGH 1
104 #else
105 # define IMAGE_ENABLE_RAMDISK_HIGH 0
106 #endif
107
108 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
109 # define IMAGE_BOOT_GET_CMDLINE 1
110 #else
111 # define IMAGE_BOOT_GET_CMDLINE 0
112 #endif
113
114 #ifdef CONFIG_OF_BOARD_SETUP
115 # define IMAGE_OF_BOARD_SETUP 1
116 #else
117 # define IMAGE_OF_BOARD_SETUP 0
118 #endif
119
120 #ifdef CONFIG_OF_SYSTEM_SETUP
121 # define IMAGE_OF_SYSTEM_SETUP 1
122 #else
123 # define IMAGE_OF_SYSTEM_SETUP 0
124 #endif
125
126 enum ih_category {
127 IH_ARCH,
128 IH_COMP,
129 IH_OS,
130 IH_TYPE,
131
132 IH_COUNT,
133 };
134
135 /*
136 * Operating System Codes
137 *
138 * The following are exposed to uImage header.
139 * Do not change values for backward compatibility.
140 */
141 enum {
142 IH_OS_INVALID = 0, /* Invalid OS */
143 IH_OS_OPENBSD, /* OpenBSD */
144 IH_OS_NETBSD, /* NetBSD */
145 IH_OS_FREEBSD, /* FreeBSD */
146 IH_OS_4_4BSD, /* 4.4BSD */
147 IH_OS_LINUX, /* Linux */
148 IH_OS_SVR4, /* SVR4 */
149 IH_OS_ESIX, /* Esix */
150 IH_OS_SOLARIS, /* Solaris */
151 IH_OS_IRIX, /* Irix */
152 IH_OS_SCO, /* SCO */
153 IH_OS_DELL, /* Dell */
154 IH_OS_NCR, /* NCR */
155 IH_OS_LYNXOS, /* LynxOS */
156 IH_OS_VXWORKS, /* VxWorks */
157 IH_OS_PSOS, /* pSOS */
158 IH_OS_QNX, /* QNX */
159 IH_OS_U_BOOT, /* Firmware */
160 IH_OS_RTEMS, /* RTEMS */
161 IH_OS_ARTOS, /* ARTOS */
162 IH_OS_UNITY, /* Unity OS */
163 IH_OS_INTEGRITY, /* INTEGRITY */
164 IH_OS_OSE, /* OSE */
165 IH_OS_PLAN9, /* Plan 9 */
166 IH_OS_OPENRTOS, /* OpenRTOS */
167
168 IH_OS_COUNT,
169 };
170
171 /*
172 * CPU Architecture Codes (supported by Linux)
173 *
174 * The following are exposed to uImage header.
175 * Do not change values for backward compatibility.
176 */
177 enum {
178 IH_ARCH_INVALID = 0, /* Invalid CPU */
179 IH_ARCH_ALPHA, /* Alpha */
180 IH_ARCH_ARM, /* ARM */
181 IH_ARCH_I386, /* Intel x86 */
182 IH_ARCH_IA64, /* IA64 */
183 IH_ARCH_MIPS, /* MIPS */
184 IH_ARCH_MIPS64, /* MIPS 64 Bit */
185 IH_ARCH_PPC, /* PowerPC */
186 IH_ARCH_S390, /* IBM S390 */
187 IH_ARCH_SH, /* SuperH */
188 IH_ARCH_SPARC, /* Sparc */
189 IH_ARCH_SPARC64, /* Sparc 64 Bit */
190 IH_ARCH_M68K, /* M68K */
191 IH_ARCH_NIOS, /* Nios-32 */
192 IH_ARCH_MICROBLAZE, /* MicroBlaze */
193 IH_ARCH_NIOS2, /* Nios-II */
194 IH_ARCH_BLACKFIN, /* Blackfin */
195 IH_ARCH_AVR32, /* AVR32 */
196 IH_ARCH_ST200, /* STMicroelectronics ST200 */
197 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
198 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
199 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
200 IH_ARCH_ARM64, /* ARM64 */
201 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
202 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
203 IH_ARCH_XTENSA, /* Xtensa */
204
205 IH_ARCH_COUNT,
206 };
207
208 /*
209 * Image Types
210 *
211 * "Standalone Programs" are directly runnable in the environment
212 * provided by U-Boot; it is expected that (if they behave
213 * well) you can continue to work in U-Boot after return from
214 * the Standalone Program.
215 * "OS Kernel Images" are usually images of some Embedded OS which
216 * will take over control completely. Usually these programs
217 * will install their own set of exception handlers, device
218 * drivers, set up the MMU, etc. - this means, that you cannot
219 * expect to re-enter U-Boot except by resetting the CPU.
220 * "RAMDisk Images" are more or less just data blocks, and their
221 * parameters (address, size) are passed to an OS kernel that is
222 * being started.
223 * "Multi-File Images" contain several images, typically an OS
224 * (Linux) kernel image and one or more data images like
225 * RAMDisks. This construct is useful for instance when you want
226 * to boot over the network using BOOTP etc., where the boot
227 * server provides just a single image file, but you want to get
228 * for instance an OS kernel and a RAMDisk image.
229 *
230 * "Multi-File Images" start with a list of image sizes, each
231 * image size (in bytes) specified by an "uint32_t" in network
232 * byte order. This list is terminated by an "(uint32_t)0".
233 * Immediately after the terminating 0 follow the images, one by
234 * one, all aligned on "uint32_t" boundaries (size rounded up to
235 * a multiple of 4 bytes - except for the last file).
236 *
237 * "Firmware Images" are binary images containing firmware (like
238 * U-Boot or FPGA images) which usually will be programmed to
239 * flash memory.
240 *
241 * "Script files" are command sequences that will be executed by
242 * U-Boot's command interpreter; this feature is especially
243 * useful when you configure U-Boot to use a real shell (hush)
244 * as command interpreter (=> Shell Scripts).
245 *
246 * The following are exposed to uImage header.
247 * Do not change values for backward compatibility.
248 */
249
250 enum {
251 IH_TYPE_INVALID = 0, /* Invalid Image */
252 IH_TYPE_STANDALONE, /* Standalone Program */
253 IH_TYPE_KERNEL, /* OS Kernel Image */
254 IH_TYPE_RAMDISK, /* RAMDisk Image */
255 IH_TYPE_MULTI, /* Multi-File Image */
256 IH_TYPE_FIRMWARE, /* Firmware Image */
257 IH_TYPE_SCRIPT, /* Script file */
258 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
259 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
260 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
261 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
262 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
263 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
264 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
265 /* OS Kernel Image, can run from any load address */
266 IH_TYPE_KERNEL_NOLOAD,
267 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
268 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
269 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
270 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
271 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */
272 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
273 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
274 IH_TYPE_LOADABLE, /* A list of typeless images */
275 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
276 IH_TYPE_RKSD, /* Rockchip SD card */
277 IH_TYPE_RKSPI, /* Rockchip SPI image */
278 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
279 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
280 IH_TYPE_FPGA, /* FPGA Image */
281 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
282 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
283 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
284
285 IH_TYPE_COUNT, /* Number of image types */
286 };
287
288 /*
289 * Compression Types
290 *
291 * The following are exposed to uImage header.
292 * Do not change values for backward compatibility.
293 */
294 enum {
295 IH_COMP_NONE = 0, /* No Compression Used */
296 IH_COMP_GZIP, /* gzip Compression Used */
297 IH_COMP_BZIP2, /* bzip2 Compression Used */
298 IH_COMP_LZMA, /* lzma Compression Used */
299 IH_COMP_LZO, /* lzo Compression Used */
300 IH_COMP_LZ4, /* lz4 Compression Used */
301
302 IH_COMP_COUNT,
303 };
304
305 #define IH_MAGIC 0x27051956 /* Image Magic Number */
306 #define IH_NMLEN 32 /* Image Name Length */
307
308 /* Reused from common.h */
309 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
310
311 /*
312 * Legacy format image header,
313 * all data in network byte order (aka natural aka bigendian).
314 */
315 typedef struct image_header {
316 __be32 ih_magic; /* Image Header Magic Number */
317 __be32 ih_hcrc; /* Image Header CRC Checksum */
318 __be32 ih_time; /* Image Creation Timestamp */
319 __be32 ih_size; /* Image Data Size */
320 __be32 ih_load; /* Data Load Address */
321 __be32 ih_ep; /* Entry Point Address */
322 __be32 ih_dcrc; /* Image Data CRC Checksum */
323 uint8_t ih_os; /* Operating System */
324 uint8_t ih_arch; /* CPU architecture */
325 uint8_t ih_type; /* Image Type */
326 uint8_t ih_comp; /* Compression Type */
327 uint8_t ih_name[IH_NMLEN]; /* Image Name */
328 } image_header_t;
329
330 typedef struct image_info {
331 ulong start, end; /* start/end of blob */
332 ulong image_start, image_len; /* start of image within blob, len of image */
333 ulong load; /* load addr for the image */
334 uint8_t comp, type, os; /* compression, type of image, os type */
335 uint8_t arch; /* CPU architecture */
336 } image_info_t;
337
338 /*
339 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
340 * routines.
341 */
342 typedef struct bootm_headers {
343 /*
344 * Legacy os image header, if it is a multi component image
345 * then boot_get_ramdisk() and get_fdt() will attempt to get
346 * data from second and third component accordingly.
347 */
348 image_header_t *legacy_hdr_os; /* image header pointer */
349 image_header_t legacy_hdr_os_copy; /* header copy */
350 ulong legacy_hdr_valid;
351
352 #if IMAGE_ENABLE_FIT
353 const char *fit_uname_cfg; /* configuration node unit name */
354
355 void *fit_hdr_os; /* os FIT image header */
356 const char *fit_uname_os; /* os subimage node unit name */
357 int fit_noffset_os; /* os subimage node offset */
358
359 void *fit_hdr_rd; /* init ramdisk FIT image header */
360 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
361 int fit_noffset_rd; /* init ramdisk subimage node offset */
362
363 void *fit_hdr_fdt; /* FDT blob FIT image header */
364 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
365 int fit_noffset_fdt;/* FDT blob subimage node offset */
366
367 void *fit_hdr_setup; /* x86 setup FIT image header */
368 const char *fit_uname_setup; /* x86 setup subimage node name */
369 int fit_noffset_setup;/* x86 setup subimage node offset */
370 #endif
371
372 #ifndef USE_HOSTCC
373 image_info_t os; /* os image info */
374 ulong ep; /* entry point of OS */
375
376 ulong rd_start, rd_end;/* ramdisk start/end */
377
378 char *ft_addr; /* flat dev tree address */
379 ulong ft_len; /* length of flat device tree */
380
381 ulong initrd_start;
382 ulong initrd_end;
383 ulong cmdline_start;
384 ulong cmdline_end;
385 bd_t *kbd;
386 #endif
387
388 int verify; /* getenv("verify")[0] != 'n' */
389
390 #define BOOTM_STATE_START (0x00000001)
391 #define BOOTM_STATE_FINDOS (0x00000002)
392 #define BOOTM_STATE_FINDOTHER (0x00000004)
393 #define BOOTM_STATE_LOADOS (0x00000008)
394 #define BOOTM_STATE_RAMDISK (0x00000010)
395 #define BOOTM_STATE_FDT (0x00000020)
396 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
397 #define BOOTM_STATE_OS_BD_T (0x00000080)
398 #define BOOTM_STATE_OS_PREP (0x00000100)
399 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
400 #define BOOTM_STATE_OS_GO (0x00000400)
401 int state;
402
403 #ifdef CONFIG_LMB
404 struct lmb lmb; /* for memory mgmt */
405 #endif
406 } bootm_headers_t;
407
408 extern bootm_headers_t images;
409
410 /*
411 * Some systems (for example LWMON) have very short watchdog periods;
412 * we must make sure to split long operations like memmove() or
413 * checksum calculations into reasonable chunks.
414 */
415 #ifndef CHUNKSZ
416 #define CHUNKSZ (64 * 1024)
417 #endif
418
419 #ifndef CHUNKSZ_CRC32
420 #define CHUNKSZ_CRC32 (64 * 1024)
421 #endif
422
423 #ifndef CHUNKSZ_MD5
424 #define CHUNKSZ_MD5 (64 * 1024)
425 #endif
426
427 #ifndef CHUNKSZ_SHA1
428 #define CHUNKSZ_SHA1 (64 * 1024)
429 #endif
430
431 #define uimage_to_cpu(x) be32_to_cpu(x)
432 #define cpu_to_uimage(x) cpu_to_be32(x)
433
434 /*
435 * Translation table for entries of a specific type; used by
436 * get_table_entry_id() and get_table_entry_name().
437 */
438 typedef struct table_entry {
439 int id;
440 char *sname; /* short (input) name to find table entry */
441 char *lname; /* long (output) name to print for messages */
442 } table_entry_t;
443
444 /*
445 * get_table_entry_id() scans the translation table trying to find an
446 * entry that matches the given short name. If a matching entry is
447 * found, it's id is returned to the caller.
448 */
449 int get_table_entry_id(const table_entry_t *table,
450 const char *table_name, const char *name);
451 /*
452 * get_table_entry_name() scans the translation table trying to find
453 * an entry that matches the given id. If a matching entry is found,
454 * its long name is returned to the caller.
455 */
456 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
457
458 const char *genimg_get_os_name(uint8_t os);
459
460 /**
461 * genimg_get_os_short_name() - get the short name for an OS
462 *
463 * @param os OS (IH_OS_...)
464 * @return OS short name, or "unknown" if unknown
465 */
466 const char *genimg_get_os_short_name(uint8_t comp);
467
468 const char *genimg_get_arch_name(uint8_t arch);
469
470 /**
471 * genimg_get_arch_short_name() - get the short name for an architecture
472 *
473 * @param arch Architecture type (IH_ARCH_...)
474 * @return architecture short name, or "unknown" if unknown
475 */
476 const char *genimg_get_arch_short_name(uint8_t arch);
477
478 const char *genimg_get_type_name(uint8_t type);
479
480 /**
481 * genimg_get_type_short_name() - get the short name for an image type
482 *
483 * @param type Image type (IH_TYPE_...)
484 * @return image short name, or "unknown" if unknown
485 */
486 const char *genimg_get_type_short_name(uint8_t type);
487
488 const char *genimg_get_comp_name(uint8_t comp);
489
490 /**
491 * genimg_get_comp_short_name() - get the short name for a compression method
492 *
493 * @param comp compression method (IH_COMP_...)
494 * @return compression method short name, or "unknown" if unknown
495 */
496 const char *genimg_get_comp_short_name(uint8_t comp);
497
498 /**
499 * genimg_get_cat_name() - Get the name of an item in a category
500 *
501 * @category: Category of item
502 * @id: Item ID
503 * @return name of item, or "Unknown ..." if unknown
504 */
505 const char *genimg_get_cat_name(enum ih_category category, uint id);
506
507 /**
508 * genimg_get_cat_short_name() - Get the short name of an item in a category
509 *
510 * @category: Category of item
511 * @id: Item ID
512 * @return short name of item, or "Unknown ..." if unknown
513 */
514 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
515
516 /**
517 * genimg_get_cat_count() - Get the number of items in a category
518 *
519 * @category: Category to check
520 * @return the number of items in the category (IH_xxx_COUNT)
521 */
522 int genimg_get_cat_count(enum ih_category category);
523
524 /**
525 * genimg_get_cat_desc() - Get the description of a category
526 *
527 * @return the description of a category, e.g. "architecture". This
528 * effectively converts the enum to a string.
529 */
530 const char *genimg_get_cat_desc(enum ih_category category);
531
532 int genimg_get_os_id(const char *name);
533 int genimg_get_arch_id(const char *name);
534 int genimg_get_type_id(const char *name);
535 int genimg_get_comp_id(const char *name);
536 void genimg_print_size(uint32_t size);
537
538 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
539 defined(USE_HOSTCC)
540 #define IMAGE_ENABLE_TIMESTAMP 1
541 #else
542 #define IMAGE_ENABLE_TIMESTAMP 0
543 #endif
544 void genimg_print_time(time_t timestamp);
545
546 /* What to do with a image load address ('load = <> 'in the FIT) */
547 enum fit_load_op {
548 FIT_LOAD_IGNORED, /* Ignore load address */
549 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
550 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
551 FIT_LOAD_REQUIRED, /* Must be provided */
552 };
553
554 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
555 ulong *setup_len);
556
557 #ifndef USE_HOSTCC
558 /* Image format types, returned by _get_format() routine */
559 #define IMAGE_FORMAT_INVALID 0x00
560 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
561 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
562 #endif
563 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
564 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
565
566 ulong genimg_get_kernel_addr_fit(char * const img_addr,
567 const char **fit_uname_config,
568 const char **fit_uname_kernel);
569 ulong genimg_get_kernel_addr(char * const img_addr);
570 int genimg_get_format(const void *img_addr);
571 int genimg_has_config(bootm_headers_t *images);
572 ulong genimg_get_image(ulong img_addr);
573
574 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
575 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
576 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
577 uint8_t arch, ulong *rd_start, ulong *rd_end);
578
579 /**
580 * boot_get_loadable - routine to load a list of binaries to memory
581 * @argc: Ignored Argument
582 * @argv: Ignored Argument
583 * @images: pointer to the bootm images structure
584 * @arch: expected architecture for the image
585 * @ld_start: Ignored Argument
586 * @ld_len: Ignored Argument
587 *
588 * boot_get_loadable() will take the given FIT configuration, and look
589 * for a field named "loadables". Loadables, is a list of elements in
590 * the FIT given as strings. exe:
591 * loadables = "linux_kernel@1", "fdt@2";
592 * this function will attempt to parse each string, and load the
593 * corresponding element from the FIT into memory. Once placed,
594 * no aditional actions are taken.
595 *
596 * @return:
597 * 0, if only valid images or no images are found
598 * error code, if an error occurs during fit_image_load
599 */
600 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
601 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
602 #endif /* !USE_HOSTCC */
603
604 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
605 ulong *setup_start, ulong *setup_len);
606
607 /**
608 * fit_image_load() - load an image from a FIT
609 *
610 * This deals with all aspects of loading an image from a FIT, including
611 * selecting the right image based on configuration, verifying it, printing
612 * out progress messages, checking the type/arch/os and optionally copying it
613 * to the right load address.
614 *
615 * The property to look up is defined by image_type.
616 *
617 * @param images Boot images structure
618 * @param addr Address of FIT in memory
619 * @param fit_unamep On entry this is the requested image name
620 * (e.g. "kernel@1") or NULL to use the default. On exit
621 * points to the selected image name
622 * @param fit_uname_configp On entry this is the requested configuration
623 * name (e.g. "conf@1") or NULL to use the default. On
624 * exit points to the selected configuration name.
625 * @param arch Expected architecture (IH_ARCH_...)
626 * @param image_type Required image type (IH_TYPE_...). If this is
627 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
628 * also.
629 * @param bootstage_id ID of starting bootstage to use for progress updates.
630 * This will be added to the BOOTSTAGE_SUB values when
631 * calling bootstage_mark()
632 * @param load_op Decribes what to do with the load address
633 * @param datap Returns address of loaded image
634 * @param lenp Returns length of loaded image
635 * @return node offset of image, or -ve error code on error
636 */
637 int fit_image_load(bootm_headers_t *images, ulong addr,
638 const char **fit_unamep, const char **fit_uname_configp,
639 int arch, int image_type, int bootstage_id,
640 enum fit_load_op load_op, ulong *datap, ulong *lenp);
641
642 #ifndef USE_HOSTCC
643 /**
644 * fit_get_node_from_config() - Look up an image a FIT by type
645 *
646 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
647 * particular image type (e.g. "kernel") and then finds the image that is
648 * referred to.
649 *
650 * For example, for something like:
651 *
652 * images {
653 * kernel@1 {
654 * ...
655 * };
656 * };
657 * configurations {
658 * conf@1 {
659 * kernel = "kernel@1";
660 * };
661 * };
662 *
663 * the function will return the node offset of the kernel@1 node, assuming
664 * that conf@1 is the chosen configuration.
665 *
666 * @param images Boot images structure
667 * @param prop_name Property name to look up (FIT_..._PROP)
668 * @param addr Address of FIT in memory
669 */
670 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
671 ulong addr);
672
673 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
674 bootm_headers_t *images,
675 char **of_flat_tree, ulong *of_size);
676 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
677 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
678
679 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
680 ulong *initrd_start, ulong *initrd_end);
681 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
682 #ifdef CONFIG_SYS_BOOT_GET_KBD
683 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
684 #endif /* CONFIG_SYS_BOOT_GET_KBD */
685 #endif /* !USE_HOSTCC */
686
687 /*******************************************************************/
688 /* Legacy format specific code (prefixed with image_) */
689 /*******************************************************************/
690 static inline uint32_t image_get_header_size(void)
691 {
692 return (sizeof(image_header_t));
693 }
694
695 #define image_get_hdr_l(f) \
696 static inline uint32_t image_get_##f(const image_header_t *hdr) \
697 { \
698 return uimage_to_cpu(hdr->ih_##f); \
699 }
700 image_get_hdr_l(magic) /* image_get_magic */
701 image_get_hdr_l(hcrc) /* image_get_hcrc */
702 image_get_hdr_l(time) /* image_get_time */
703 image_get_hdr_l(size) /* image_get_size */
704 image_get_hdr_l(load) /* image_get_load */
705 image_get_hdr_l(ep) /* image_get_ep */
706 image_get_hdr_l(dcrc) /* image_get_dcrc */
707
708 #define image_get_hdr_b(f) \
709 static inline uint8_t image_get_##f(const image_header_t *hdr) \
710 { \
711 return hdr->ih_##f; \
712 }
713 image_get_hdr_b(os) /* image_get_os */
714 image_get_hdr_b(arch) /* image_get_arch */
715 image_get_hdr_b(type) /* image_get_type */
716 image_get_hdr_b(comp) /* image_get_comp */
717
718 static inline char *image_get_name(const image_header_t *hdr)
719 {
720 return (char *)hdr->ih_name;
721 }
722
723 static inline uint32_t image_get_data_size(const image_header_t *hdr)
724 {
725 return image_get_size(hdr);
726 }
727
728 /**
729 * image_get_data - get image payload start address
730 * @hdr: image header
731 *
732 * image_get_data() returns address of the image payload. For single
733 * component images it is image data start. For multi component
734 * images it points to the null terminated table of sub-images sizes.
735 *
736 * returns:
737 * image payload data start address
738 */
739 static inline ulong image_get_data(const image_header_t *hdr)
740 {
741 return ((ulong)hdr + image_get_header_size());
742 }
743
744 static inline uint32_t image_get_image_size(const image_header_t *hdr)
745 {
746 return (image_get_size(hdr) + image_get_header_size());
747 }
748 static inline ulong image_get_image_end(const image_header_t *hdr)
749 {
750 return ((ulong)hdr + image_get_image_size(hdr));
751 }
752
753 #define image_set_hdr_l(f) \
754 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
755 { \
756 hdr->ih_##f = cpu_to_uimage(val); \
757 }
758 image_set_hdr_l(magic) /* image_set_magic */
759 image_set_hdr_l(hcrc) /* image_set_hcrc */
760 image_set_hdr_l(time) /* image_set_time */
761 image_set_hdr_l(size) /* image_set_size */
762 image_set_hdr_l(load) /* image_set_load */
763 image_set_hdr_l(ep) /* image_set_ep */
764 image_set_hdr_l(dcrc) /* image_set_dcrc */
765
766 #define image_set_hdr_b(f) \
767 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
768 { \
769 hdr->ih_##f = val; \
770 }
771 image_set_hdr_b(os) /* image_set_os */
772 image_set_hdr_b(arch) /* image_set_arch */
773 image_set_hdr_b(type) /* image_set_type */
774 image_set_hdr_b(comp) /* image_set_comp */
775
776 static inline void image_set_name(image_header_t *hdr, const char *name)
777 {
778 strncpy(image_get_name(hdr), name, IH_NMLEN);
779 }
780
781 int image_check_hcrc(const image_header_t *hdr);
782 int image_check_dcrc(const image_header_t *hdr);
783 #ifndef USE_HOSTCC
784 ulong getenv_bootm_low(void);
785 phys_size_t getenv_bootm_size(void);
786 phys_size_t getenv_bootm_mapsize(void);
787 #endif
788 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
789
790 static inline int image_check_magic(const image_header_t *hdr)
791 {
792 return (image_get_magic(hdr) == IH_MAGIC);
793 }
794 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
795 {
796 return (image_get_type(hdr) == type);
797 }
798 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
799 {
800 return (image_get_arch(hdr) == arch);
801 }
802 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
803 {
804 return (image_get_os(hdr) == os);
805 }
806
807 ulong image_multi_count(const image_header_t *hdr);
808 void image_multi_getimg(const image_header_t *hdr, ulong idx,
809 ulong *data, ulong *len);
810
811 void image_print_contents(const void *hdr);
812
813 #ifndef USE_HOSTCC
814 static inline int image_check_target_arch(const image_header_t *hdr)
815 {
816 #ifndef IH_ARCH_DEFAULT
817 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
818 #endif
819 return image_check_arch(hdr, IH_ARCH_DEFAULT);
820 }
821 #endif /* USE_HOSTCC */
822
823 /**
824 * Set up properties in the FDT
825 *
826 * This sets up properties in the FDT that is to be passed to linux.
827 *
828 * @images: Images information
829 * @blob: FDT to update
830 * @of_size: Size of the FDT
831 * @lmb: Points to logical memory block structure
832 * @return 0 if ok, <0 on failure
833 */
834 int image_setup_libfdt(bootm_headers_t *images, void *blob,
835 int of_size, struct lmb *lmb);
836
837 /**
838 * Set up the FDT to use for booting a kernel
839 *
840 * This performs ramdisk setup, sets up the FDT if required, and adds
841 * paramters to the FDT if libfdt is available.
842 *
843 * @param images Images information
844 * @return 0 if ok, <0 on failure
845 */
846 int image_setup_linux(bootm_headers_t *images);
847
848 /**
849 * bootz_setup() - Extract stat and size of a Linux xImage
850 *
851 * @image: Address of image
852 * @start: Returns start address of image
853 * @end : Returns end address of image
854 * @return 0 if OK, 1 if the image was not recognised
855 */
856 int bootz_setup(ulong image, ulong *start, ulong *end);
857
858
859 /*******************************************************************/
860 /* New uImage format specific code (prefixed with fit_) */
861 /*******************************************************************/
862
863 #define FIT_IMAGES_PATH "/images"
864 #define FIT_CONFS_PATH "/configurations"
865
866 /* hash/signature node */
867 #define FIT_HASH_NODENAME "hash"
868 #define FIT_ALGO_PROP "algo"
869 #define FIT_VALUE_PROP "value"
870 #define FIT_IGNORE_PROP "uboot-ignore"
871 #define FIT_SIG_NODENAME "signature"
872
873 /* image node */
874 #define FIT_DATA_PROP "data"
875 #define FIT_DATA_OFFSET_PROP "data-offset"
876 #define FIT_DATA_SIZE_PROP "data-size"
877 #define FIT_TIMESTAMP_PROP "timestamp"
878 #define FIT_DESC_PROP "description"
879 #define FIT_ARCH_PROP "arch"
880 #define FIT_TYPE_PROP "type"
881 #define FIT_OS_PROP "os"
882 #define FIT_COMP_PROP "compression"
883 #define FIT_ENTRY_PROP "entry"
884 #define FIT_LOAD_PROP "load"
885
886 /* configuration node */
887 #define FIT_KERNEL_PROP "kernel"
888 #define FIT_RAMDISK_PROP "ramdisk"
889 #define FIT_FDT_PROP "fdt"
890 #define FIT_LOADABLE_PROP "loadables"
891 #define FIT_DEFAULT_PROP "default"
892 #define FIT_SETUP_PROP "setup"
893 #define FIT_FPGA_PROP "fpga"
894
895 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
896
897 #if IMAGE_ENABLE_FIT
898 /* cmdline argument format parsing */
899 int fit_parse_conf(const char *spec, ulong addr_curr,
900 ulong *addr, const char **conf_name);
901 int fit_parse_subimage(const char *spec, ulong addr_curr,
902 ulong *addr, const char **image_name);
903
904 int fit_get_subimage_count(const void *fit, int images_noffset);
905 void fit_print_contents(const void *fit);
906 void fit_image_print(const void *fit, int noffset, const char *p);
907
908 /**
909 * fit_get_end - get FIT image size
910 * @fit: pointer to the FIT format image header
911 *
912 * returns:
913 * size of the FIT image (blob) in memory
914 */
915 static inline ulong fit_get_size(const void *fit)
916 {
917 return fdt_totalsize(fit);
918 }
919
920 /**
921 * fit_get_end - get FIT image end
922 * @fit: pointer to the FIT format image header
923 *
924 * returns:
925 * end address of the FIT image (blob) in memory
926 */
927 ulong fit_get_end(const void *fit);
928
929 /**
930 * fit_get_name - get FIT node name
931 * @fit: pointer to the FIT format image header
932 *
933 * returns:
934 * NULL, on error
935 * pointer to node name, on success
936 */
937 static inline const char *fit_get_name(const void *fit_hdr,
938 int noffset, int *len)
939 {
940 return fdt_get_name(fit_hdr, noffset, len);
941 }
942
943 int fit_get_desc(const void *fit, int noffset, char **desc);
944 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
945
946 int fit_image_get_node(const void *fit, const char *image_uname);
947 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
948 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
949 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
950 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
951 int fit_image_get_load(const void *fit, int noffset, ulong *load);
952 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
953 int fit_image_get_data(const void *fit, int noffset,
954 const void **data, size_t *size);
955 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
956 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
957
958 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
959 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
960 int *value_len);
961
962 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
963
964 /**
965 * fit_add_verification_data() - add verification data to FIT image nodes
966 *
967 * @keydir: Directory containing keys
968 * @kwydest: FDT blob to write public key information to
969 * @fit: Pointer to the FIT format image header
970 * @comment: Comment to add to signature nodes
971 * @require_keys: Mark all keys as 'required'
972 * @engine_id: Engine to use for signing
973 *
974 * Adds hash values for all component images in the FIT blob.
975 * Hashes are calculated for all component images which have hash subnodes
976 * with algorithm property set to one of the supported hash algorithms.
977 *
978 * Also add signatures if signature nodes are present.
979 *
980 * returns
981 * 0, on success
982 * libfdt error code, on failure
983 */
984 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
985 const char *comment, int require_keys,
986 const char *engine_id);
987
988 int fit_image_verify(const void *fit, int noffset);
989 int fit_config_verify(const void *fit, int conf_noffset);
990 int fit_all_image_verify(const void *fit);
991 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
992 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
993 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
994 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
995 int fit_check_format(const void *fit);
996
997 int fit_conf_find_compat(const void *fit, const void *fdt);
998 int fit_conf_get_node(const void *fit, const char *conf_uname);
999
1000 /**
1001 * fit_conf_get_prop_node() - Get node refered to by a configuration
1002 * @fit: FIT to check
1003 * @noffset: Offset of conf@xxx node to check
1004 * @prop_name: Property to read from the conf node
1005 *
1006 * The conf@ nodes contain references to other nodes, using properties
1007 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
1008 * return the offset of the node referred to (e.g. offset of node
1009 * "/images/kernel@1".
1010 */
1011 int fit_conf_get_prop_node(const void *fit, int noffset,
1012 const char *prop_name);
1013
1014 void fit_conf_print(const void *fit, int noffset, const char *p);
1015
1016 int fit_check_ramdisk(const void *fit, int os_noffset,
1017 uint8_t arch, int verify);
1018
1019 int calculate_hash(const void *data, int data_len, const char *algo,
1020 uint8_t *value, int *value_len);
1021
1022 /*
1023 * At present we only support signing on the host, and verification on the
1024 * device
1025 */
1026 #if defined(CONFIG_FIT_SIGNATURE)
1027 # ifdef USE_HOSTCC
1028 # define IMAGE_ENABLE_SIGN 1
1029 # define IMAGE_ENABLE_VERIFY 1
1030 # include <openssl/evp.h>
1031 #else
1032 # define IMAGE_ENABLE_SIGN 0
1033 # define IMAGE_ENABLE_VERIFY 1
1034 # endif
1035 #else
1036 # define IMAGE_ENABLE_SIGN 0
1037 # define IMAGE_ENABLE_VERIFY 0
1038 #endif
1039
1040 #ifdef USE_HOSTCC
1041 void *image_get_host_blob(void);
1042 void image_set_host_blob(void *host_blob);
1043 # define gd_fdt_blob() image_get_host_blob()
1044 #else
1045 # define gd_fdt_blob() (gd->fdt_blob)
1046 #endif
1047
1048 #ifdef CONFIG_FIT_BEST_MATCH
1049 #define IMAGE_ENABLE_BEST_MATCH 1
1050 #else
1051 #define IMAGE_ENABLE_BEST_MATCH 0
1052 #endif
1053
1054 /* Information passed to the signing routines */
1055 struct image_sign_info {
1056 const char *keydir; /* Directory conaining keys */
1057 const char *keyname; /* Name of key to use */
1058 void *fit; /* Pointer to FIT blob */
1059 int node_offset; /* Offset of signature node */
1060 const char *name; /* Algorithm name */
1061 struct checksum_algo *checksum; /* Checksum algorithm information */
1062 struct crypto_algo *crypto; /* Crypto algorithm information */
1063 const void *fdt_blob; /* FDT containing public keys */
1064 int required_keynode; /* Node offset of key to use: -1=any */
1065 const char *require_keys; /* Value for 'required' property */
1066 const char *engine_id; /* Engine to use for signing */
1067 };
1068 #endif /* Allow struct image_region to always be defined for rsa.h */
1069
1070 /* A part of an image, used for hashing */
1071 struct image_region {
1072 const void *data;
1073 int size;
1074 };
1075
1076 #if IMAGE_ENABLE_FIT
1077
1078 #if IMAGE_ENABLE_VERIFY
1079 # include <u-boot/rsa-checksum.h>
1080 #endif
1081 struct checksum_algo {
1082 const char *name;
1083 const int checksum_len;
1084 const int der_len;
1085 const uint8_t *der_prefix;
1086 #if IMAGE_ENABLE_SIGN
1087 const EVP_MD *(*calculate_sign)(void);
1088 #endif
1089 int (*calculate)(const char *name,
1090 const struct image_region region[],
1091 int region_count, uint8_t *checksum);
1092 };
1093
1094 struct crypto_algo {
1095 const char *name; /* Name of algorithm */
1096 const int key_len;
1097
1098 /**
1099 * sign() - calculate and return signature for given input data
1100 *
1101 * @info: Specifies key and FIT information
1102 * @data: Pointer to the input data
1103 * @data_len: Data length
1104 * @sigp: Set to an allocated buffer holding the signature
1105 * @sig_len: Set to length of the calculated hash
1106 *
1107 * This computes input data signature according to selected algorithm.
1108 * Resulting signature value is placed in an allocated buffer, the
1109 * pointer is returned as *sigp. The length of the calculated
1110 * signature is returned via the sig_len pointer argument. The caller
1111 * should free *sigp.
1112 *
1113 * @return: 0, on success, -ve on error
1114 */
1115 int (*sign)(struct image_sign_info *info,
1116 const struct image_region region[],
1117 int region_count, uint8_t **sigp, uint *sig_len);
1118
1119 /**
1120 * add_verify_data() - Add verification information to FDT
1121 *
1122 * Add public key information to the FDT node, suitable for
1123 * verification at run-time. The information added depends on the
1124 * algorithm being used.
1125 *
1126 * @info: Specifies key and FIT information
1127 * @keydest: Destination FDT blob for public key data
1128 * @return: 0, on success, -ve on error
1129 */
1130 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1131
1132 /**
1133 * verify() - Verify a signature against some data
1134 *
1135 * @info: Specifies key and FIT information
1136 * @data: Pointer to the input data
1137 * @data_len: Data length
1138 * @sig: Signature
1139 * @sig_len: Number of bytes in signature
1140 * @return 0 if verified, -ve on error
1141 */
1142 int (*verify)(struct image_sign_info *info,
1143 const struct image_region region[], int region_count,
1144 uint8_t *sig, uint sig_len);
1145 };
1146
1147 /**
1148 * image_get_checksum_algo() - Look up a checksum algorithm
1149 *
1150 * @param full_name Name of algorithm in the form "checksum,crypto"
1151 * @return pointer to algorithm information, or NULL if not found
1152 */
1153 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1154
1155 /**
1156 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1157 *
1158 * @param full_name Name of algorithm in the form "checksum,crypto"
1159 * @return pointer to algorithm information, or NULL if not found
1160 */
1161 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1162
1163 /**
1164 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1165 *
1166 * @fit: FIT to check
1167 * @image_noffset: Offset of image node to check
1168 * @data: Image data to check
1169 * @size: Size of image data
1170 * @sig_blob: FDT containing public keys
1171 * @no_sigsp: Returns 1 if no signatures were required, and
1172 * therefore nothing was checked. The caller may wish
1173 * to fall back to other mechanisms, or refuse to
1174 * boot.
1175 * @return 0 if all verified ok, <0 on error
1176 */
1177 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1178 const char *data, size_t size, const void *sig_blob,
1179 int *no_sigsp);
1180
1181 /**
1182 * fit_image_check_sig() - Check a single image signature node
1183 *
1184 * @fit: FIT to check
1185 * @noffset: Offset of signature node to check
1186 * @data: Image data to check
1187 * @size: Size of image data
1188 * @required_keynode: Offset in the control FDT of the required key node,
1189 * if any. If this is given, then the image wil not
1190 * pass verification unless that key is used. If this is
1191 * -1 then any signature will do.
1192 * @err_msgp: In the event of an error, this will be pointed to a
1193 * help error string to display to the user.
1194 * @return 0 if all verified ok, <0 on error
1195 */
1196 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1197 size_t size, int required_keynode, char **err_msgp);
1198
1199 /**
1200 * fit_region_make_list() - Make a list of regions to hash
1201 *
1202 * Given a list of FIT regions (offset, size) provided by libfdt, create
1203 * a list of regions (void *, size) for use by the signature creationg
1204 * and verification code.
1205 *
1206 * @fit: FIT image to process
1207 * @fdt_regions: Regions as returned by libfdt
1208 * @count: Number of regions returned by libfdt
1209 * @region: Place to put list of regions (NULL to allocate it)
1210 * @return pointer to list of regions, or NULL if out of memory
1211 */
1212 struct image_region *fit_region_make_list(const void *fit,
1213 struct fdt_region *fdt_regions, int count,
1214 struct image_region *region);
1215
1216 static inline int fit_image_check_target_arch(const void *fdt, int node)
1217 {
1218 #ifndef USE_HOSTCC
1219 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1220 #else
1221 return 0;
1222 #endif
1223 }
1224
1225 #ifdef CONFIG_FIT_VERBOSE
1226 #define fit_unsupported(msg) printf("! %s:%d " \
1227 "FIT images not supported for '%s'\n", \
1228 __FILE__, __LINE__, (msg))
1229
1230 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1231 "FIT images not supported for '%s' " \
1232 "- must reset board to recover!\n", \
1233 __FILE__, __LINE__, (msg))
1234 #else
1235 #define fit_unsupported(msg)
1236 #define fit_unsupported_reset(msg)
1237 #endif /* CONFIG_FIT_VERBOSE */
1238 #endif /* CONFIG_FIT */
1239
1240 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1241 struct andr_img_hdr;
1242 int android_image_check_header(const struct andr_img_hdr *hdr);
1243 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1244 ulong *os_data, ulong *os_len);
1245 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1246 ulong *rd_data, ulong *rd_len);
1247 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1248 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1249 void android_print_contents(const struct andr_img_hdr *hdr);
1250
1251 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1252
1253 /**
1254 * board_fit_config_name_match() - Check for a matching board name
1255 *
1256 * This is used when SPL loads a FIT containing multiple device tree files
1257 * and wants to work out which one to use. The description of each one is
1258 * passed to this function. The description comes from the 'description' field
1259 * in each (FDT) image node.
1260 *
1261 * @name: Device tree description
1262 * @return 0 if this device tree should be used, non-zero to try the next
1263 */
1264 int board_fit_config_name_match(const char *name);
1265
1266 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1267 /**
1268 * board_fit_image_post_process() - Do any post-process on FIT binary data
1269 *
1270 * This is used to do any sort of image manipulation, verification, decryption
1271 * etc. in a platform or board specific way. Obviously, anything done here would
1272 * need to be comprehended in how the images were prepared before being injected
1273 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1274 * before being added to the FIT image).
1275 *
1276 * @image: pointer to the image start pointer
1277 * @size: pointer to the image size
1278 * @return no return value (failure should be handled internally)
1279 */
1280 void board_fit_image_post_process(void **p_image, size_t *p_size);
1281 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1282
1283 /**
1284 * Mapping of image types to function handlers to be invoked on the associated
1285 * loaded images
1286 *
1287 * @type: Type of image, I.E. IH_TYPE_*
1288 * @handler: Function to call on loaded image
1289 */
1290 struct fit_loadable_tbl {
1291 int type;
1292 /**
1293 * handler() - Process a loaded image
1294 *
1295 * @data: Pointer to start of loaded image data
1296 * @size: Size of loaded image data
1297 */
1298 void (*handler)(ulong data, size_t size);
1299 };
1300
1301 /*
1302 * Define a FIT loadable image type handler
1303 *
1304 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1305 * _handler is the handler function to call after this image type is loaded
1306 */
1307 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1308 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1309 .type = _type, \
1310 .handler = _handler, \
1311 }
1312
1313 #endif /* __IMAGE_H__ */