]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/image.h
rsa: Verify RSA padding programatically
[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
283 IH_TYPE_COUNT, /* Number of image types */
284 };
285
286 /*
287 * Compression Types
288 *
289 * The following are exposed to uImage header.
290 * Do not change values for backward compatibility.
291 */
292 enum {
293 IH_COMP_NONE = 0, /* No Compression Used */
294 IH_COMP_GZIP, /* gzip Compression Used */
295 IH_COMP_BZIP2, /* bzip2 Compression Used */
296 IH_COMP_LZMA, /* lzma Compression Used */
297 IH_COMP_LZO, /* lzo Compression Used */
298 IH_COMP_LZ4, /* lz4 Compression Used */
299
300 IH_COMP_COUNT,
301 };
302
303 #define IH_MAGIC 0x27051956 /* Image Magic Number */
304 #define IH_NMLEN 32 /* Image Name Length */
305
306 /* Reused from common.h */
307 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
308
309 /*
310 * Legacy format image header,
311 * all data in network byte order (aka natural aka bigendian).
312 */
313 typedef struct image_header {
314 __be32 ih_magic; /* Image Header Magic Number */
315 __be32 ih_hcrc; /* Image Header CRC Checksum */
316 __be32 ih_time; /* Image Creation Timestamp */
317 __be32 ih_size; /* Image Data Size */
318 __be32 ih_load; /* Data Load Address */
319 __be32 ih_ep; /* Entry Point Address */
320 __be32 ih_dcrc; /* Image Data CRC Checksum */
321 uint8_t ih_os; /* Operating System */
322 uint8_t ih_arch; /* CPU architecture */
323 uint8_t ih_type; /* Image Type */
324 uint8_t ih_comp; /* Compression Type */
325 uint8_t ih_name[IH_NMLEN]; /* Image Name */
326 } image_header_t;
327
328 typedef struct image_info {
329 ulong start, end; /* start/end of blob */
330 ulong image_start, image_len; /* start of image within blob, len of image */
331 ulong load; /* load addr for the image */
332 uint8_t comp, type, os; /* compression, type of image, os type */
333 uint8_t arch; /* CPU architecture */
334 } image_info_t;
335
336 /*
337 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
338 * routines.
339 */
340 typedef struct bootm_headers {
341 /*
342 * Legacy os image header, if it is a multi component image
343 * then boot_get_ramdisk() and get_fdt() will attempt to get
344 * data from second and third component accordingly.
345 */
346 image_header_t *legacy_hdr_os; /* image header pointer */
347 image_header_t legacy_hdr_os_copy; /* header copy */
348 ulong legacy_hdr_valid;
349
350 #if IMAGE_ENABLE_FIT
351 const char *fit_uname_cfg; /* configuration node unit name */
352
353 void *fit_hdr_os; /* os FIT image header */
354 const char *fit_uname_os; /* os subimage node unit name */
355 int fit_noffset_os; /* os subimage node offset */
356
357 void *fit_hdr_rd; /* init ramdisk FIT image header */
358 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
359 int fit_noffset_rd; /* init ramdisk subimage node offset */
360
361 void *fit_hdr_fdt; /* FDT blob FIT image header */
362 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
363 int fit_noffset_fdt;/* FDT blob subimage node offset */
364
365 void *fit_hdr_setup; /* x86 setup FIT image header */
366 const char *fit_uname_setup; /* x86 setup subimage node name */
367 int fit_noffset_setup;/* x86 setup subimage node offset */
368 #endif
369
370 #ifndef USE_HOSTCC
371 image_info_t os; /* os image info */
372 ulong ep; /* entry point of OS */
373
374 ulong rd_start, rd_end;/* ramdisk start/end */
375
376 char *ft_addr; /* flat dev tree address */
377 ulong ft_len; /* length of flat device tree */
378
379 ulong initrd_start;
380 ulong initrd_end;
381 ulong cmdline_start;
382 ulong cmdline_end;
383 bd_t *kbd;
384 #endif
385
386 int verify; /* getenv("verify")[0] != 'n' */
387
388 #define BOOTM_STATE_START (0x00000001)
389 #define BOOTM_STATE_FINDOS (0x00000002)
390 #define BOOTM_STATE_FINDOTHER (0x00000004)
391 #define BOOTM_STATE_LOADOS (0x00000008)
392 #define BOOTM_STATE_RAMDISK (0x00000010)
393 #define BOOTM_STATE_FDT (0x00000020)
394 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
395 #define BOOTM_STATE_OS_BD_T (0x00000080)
396 #define BOOTM_STATE_OS_PREP (0x00000100)
397 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
398 #define BOOTM_STATE_OS_GO (0x00000400)
399 int state;
400
401 #ifdef CONFIG_LMB
402 struct lmb lmb; /* for memory mgmt */
403 #endif
404 } bootm_headers_t;
405
406 extern bootm_headers_t images;
407
408 /*
409 * Some systems (for example LWMON) have very short watchdog periods;
410 * we must make sure to split long operations like memmove() or
411 * checksum calculations into reasonable chunks.
412 */
413 #ifndef CHUNKSZ
414 #define CHUNKSZ (64 * 1024)
415 #endif
416
417 #ifndef CHUNKSZ_CRC32
418 #define CHUNKSZ_CRC32 (64 * 1024)
419 #endif
420
421 #ifndef CHUNKSZ_MD5
422 #define CHUNKSZ_MD5 (64 * 1024)
423 #endif
424
425 #ifndef CHUNKSZ_SHA1
426 #define CHUNKSZ_SHA1 (64 * 1024)
427 #endif
428
429 #define uimage_to_cpu(x) be32_to_cpu(x)
430 #define cpu_to_uimage(x) cpu_to_be32(x)
431
432 /*
433 * Translation table for entries of a specific type; used by
434 * get_table_entry_id() and get_table_entry_name().
435 */
436 typedef struct table_entry {
437 int id;
438 char *sname; /* short (input) name to find table entry */
439 char *lname; /* long (output) name to print for messages */
440 } table_entry_t;
441
442 /*
443 * get_table_entry_id() scans the translation table trying to find an
444 * entry that matches the given short name. If a matching entry is
445 * found, it's id is returned to the caller.
446 */
447 int get_table_entry_id(const table_entry_t *table,
448 const char *table_name, const char *name);
449 /*
450 * get_table_entry_name() scans the translation table trying to find
451 * an entry that matches the given id. If a matching entry is found,
452 * its long name is returned to the caller.
453 */
454 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
455
456 const char *genimg_get_os_name(uint8_t os);
457
458 /**
459 * genimg_get_os_short_name() - get the short name for an OS
460 *
461 * @param os OS (IH_OS_...)
462 * @return OS short name, or "unknown" if unknown
463 */
464 const char *genimg_get_os_short_name(uint8_t comp);
465
466 const char *genimg_get_arch_name(uint8_t arch);
467
468 /**
469 * genimg_get_arch_short_name() - get the short name for an architecture
470 *
471 * @param arch Architecture type (IH_ARCH_...)
472 * @return architecture short name, or "unknown" if unknown
473 */
474 const char *genimg_get_arch_short_name(uint8_t arch);
475
476 const char *genimg_get_type_name(uint8_t type);
477
478 /**
479 * genimg_get_type_short_name() - get the short name for an image type
480 *
481 * @param type Image type (IH_TYPE_...)
482 * @return image short name, or "unknown" if unknown
483 */
484 const char *genimg_get_type_short_name(uint8_t type);
485
486 const char *genimg_get_comp_name(uint8_t comp);
487
488 /**
489 * genimg_get_comp_short_name() - get the short name for a compression method
490 *
491 * @param comp compression method (IH_COMP_...)
492 * @return compression method short name, or "unknown" if unknown
493 */
494 const char *genimg_get_comp_short_name(uint8_t comp);
495
496 /**
497 * genimg_get_cat_name() - Get the name of an item in a category
498 *
499 * @category: Category of item
500 * @id: Item ID
501 * @return name of item, or "Unknown ..." if unknown
502 */
503 const char *genimg_get_cat_name(enum ih_category category, uint id);
504
505 /**
506 * genimg_get_cat_short_name() - Get the short name of an item in a category
507 *
508 * @category: Category of item
509 * @id: Item ID
510 * @return short name of item, or "Unknown ..." if unknown
511 */
512 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
513
514 /**
515 * genimg_get_cat_count() - Get the number of items in a category
516 *
517 * @category: Category to check
518 * @return the number of items in the category (IH_xxx_COUNT)
519 */
520 int genimg_get_cat_count(enum ih_category category);
521
522 /**
523 * genimg_get_cat_desc() - Get the description of a category
524 *
525 * @return the description of a category, e.g. "architecture". This
526 * effectively converts the enum to a string.
527 */
528 const char *genimg_get_cat_desc(enum ih_category category);
529
530 int genimg_get_os_id(const char *name);
531 int genimg_get_arch_id(const char *name);
532 int genimg_get_type_id(const char *name);
533 int genimg_get_comp_id(const char *name);
534 void genimg_print_size(uint32_t size);
535
536 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
537 defined(USE_HOSTCC)
538 #define IMAGE_ENABLE_TIMESTAMP 1
539 #else
540 #define IMAGE_ENABLE_TIMESTAMP 0
541 #endif
542 void genimg_print_time(time_t timestamp);
543
544 /* What to do with a image load address ('load = <> 'in the FIT) */
545 enum fit_load_op {
546 FIT_LOAD_IGNORED, /* Ignore load address */
547 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
548 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
549 FIT_LOAD_REQUIRED, /* Must be provided */
550 };
551
552 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
553 ulong *setup_len);
554
555 #ifndef USE_HOSTCC
556 /* Image format types, returned by _get_format() routine */
557 #define IMAGE_FORMAT_INVALID 0x00
558 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
559 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
560 #endif
561 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
562 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
563
564 ulong genimg_get_kernel_addr_fit(char * const img_addr,
565 const char **fit_uname_config,
566 const char **fit_uname_kernel);
567 ulong genimg_get_kernel_addr(char * const img_addr);
568 int genimg_get_format(const void *img_addr);
569 int genimg_has_config(bootm_headers_t *images);
570 ulong genimg_get_image(ulong img_addr);
571
572 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
573 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
574 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
575 uint8_t arch, ulong *rd_start, ulong *rd_end);
576
577 /**
578 * boot_get_loadable - routine to load a list of binaries to memory
579 * @argc: Ignored Argument
580 * @argv: Ignored Argument
581 * @images: pointer to the bootm images structure
582 * @arch: expected architecture for the image
583 * @ld_start: Ignored Argument
584 * @ld_len: Ignored Argument
585 *
586 * boot_get_loadable() will take the given FIT configuration, and look
587 * for a field named "loadables". Loadables, is a list of elements in
588 * the FIT given as strings. exe:
589 * loadables = "linux_kernel@1", "fdt@2";
590 * this function will attempt to parse each string, and load the
591 * corresponding element from the FIT into memory. Once placed,
592 * no aditional actions are taken.
593 *
594 * @return:
595 * 0, if only valid images or no images are found
596 * error code, if an error occurs during fit_image_load
597 */
598 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
599 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
600 #endif /* !USE_HOSTCC */
601
602 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
603 ulong *setup_start, ulong *setup_len);
604
605 /**
606 * fit_image_load() - load an image from a FIT
607 *
608 * This deals with all aspects of loading an image from a FIT, including
609 * selecting the right image based on configuration, verifying it, printing
610 * out progress messages, checking the type/arch/os and optionally copying it
611 * to the right load address.
612 *
613 * The property to look up is defined by image_type.
614 *
615 * @param images Boot images structure
616 * @param addr Address of FIT in memory
617 * @param fit_unamep On entry this is the requested image name
618 * (e.g. "kernel@1") or NULL to use the default. On exit
619 * points to the selected image name
620 * @param fit_uname_configp On entry this is the requested configuration
621 * name (e.g. "conf@1") or NULL to use the default. On
622 * exit points to the selected configuration name.
623 * @param arch Expected architecture (IH_ARCH_...)
624 * @param image_type Required image type (IH_TYPE_...). If this is
625 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
626 * also.
627 * @param bootstage_id ID of starting bootstage to use for progress updates.
628 * This will be added to the BOOTSTAGE_SUB values when
629 * calling bootstage_mark()
630 * @param load_op Decribes what to do with the load address
631 * @param datap Returns address of loaded image
632 * @param lenp Returns length of loaded image
633 * @return node offset of image, or -ve error code on error
634 */
635 int fit_image_load(bootm_headers_t *images, ulong addr,
636 const char **fit_unamep, const char **fit_uname_configp,
637 int arch, int image_type, int bootstage_id,
638 enum fit_load_op load_op, ulong *datap, ulong *lenp);
639
640 #ifndef USE_HOSTCC
641 /**
642 * fit_get_node_from_config() - Look up an image a FIT by type
643 *
644 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
645 * particular image type (e.g. "kernel") and then finds the image that is
646 * referred to.
647 *
648 * For example, for something like:
649 *
650 * images {
651 * kernel@1 {
652 * ...
653 * };
654 * };
655 * configurations {
656 * conf@1 {
657 * kernel = "kernel@1";
658 * };
659 * };
660 *
661 * the function will return the node offset of the kernel@1 node, assuming
662 * that conf@1 is the chosen configuration.
663 *
664 * @param images Boot images structure
665 * @param prop_name Property name to look up (FIT_..._PROP)
666 * @param addr Address of FIT in memory
667 */
668 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
669 ulong addr);
670
671 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
672 bootm_headers_t *images,
673 char **of_flat_tree, ulong *of_size);
674 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
675 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
676
677 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
678 ulong *initrd_start, ulong *initrd_end);
679 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
680 #ifdef CONFIG_SYS_BOOT_GET_KBD
681 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
682 #endif /* CONFIG_SYS_BOOT_GET_KBD */
683 #endif /* !USE_HOSTCC */
684
685 /*******************************************************************/
686 /* Legacy format specific code (prefixed with image_) */
687 /*******************************************************************/
688 static inline uint32_t image_get_header_size(void)
689 {
690 return (sizeof(image_header_t));
691 }
692
693 #define image_get_hdr_l(f) \
694 static inline uint32_t image_get_##f(const image_header_t *hdr) \
695 { \
696 return uimage_to_cpu(hdr->ih_##f); \
697 }
698 image_get_hdr_l(magic) /* image_get_magic */
699 image_get_hdr_l(hcrc) /* image_get_hcrc */
700 image_get_hdr_l(time) /* image_get_time */
701 image_get_hdr_l(size) /* image_get_size */
702 image_get_hdr_l(load) /* image_get_load */
703 image_get_hdr_l(ep) /* image_get_ep */
704 image_get_hdr_l(dcrc) /* image_get_dcrc */
705
706 #define image_get_hdr_b(f) \
707 static inline uint8_t image_get_##f(const image_header_t *hdr) \
708 { \
709 return hdr->ih_##f; \
710 }
711 image_get_hdr_b(os) /* image_get_os */
712 image_get_hdr_b(arch) /* image_get_arch */
713 image_get_hdr_b(type) /* image_get_type */
714 image_get_hdr_b(comp) /* image_get_comp */
715
716 static inline char *image_get_name(const image_header_t *hdr)
717 {
718 return (char *)hdr->ih_name;
719 }
720
721 static inline uint32_t image_get_data_size(const image_header_t *hdr)
722 {
723 return image_get_size(hdr);
724 }
725
726 /**
727 * image_get_data - get image payload start address
728 * @hdr: image header
729 *
730 * image_get_data() returns address of the image payload. For single
731 * component images it is image data start. For multi component
732 * images it points to the null terminated table of sub-images sizes.
733 *
734 * returns:
735 * image payload data start address
736 */
737 static inline ulong image_get_data(const image_header_t *hdr)
738 {
739 return ((ulong)hdr + image_get_header_size());
740 }
741
742 static inline uint32_t image_get_image_size(const image_header_t *hdr)
743 {
744 return (image_get_size(hdr) + image_get_header_size());
745 }
746 static inline ulong image_get_image_end(const image_header_t *hdr)
747 {
748 return ((ulong)hdr + image_get_image_size(hdr));
749 }
750
751 #define image_set_hdr_l(f) \
752 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
753 { \
754 hdr->ih_##f = cpu_to_uimage(val); \
755 }
756 image_set_hdr_l(magic) /* image_set_magic */
757 image_set_hdr_l(hcrc) /* image_set_hcrc */
758 image_set_hdr_l(time) /* image_set_time */
759 image_set_hdr_l(size) /* image_set_size */
760 image_set_hdr_l(load) /* image_set_load */
761 image_set_hdr_l(ep) /* image_set_ep */
762 image_set_hdr_l(dcrc) /* image_set_dcrc */
763
764 #define image_set_hdr_b(f) \
765 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
766 { \
767 hdr->ih_##f = val; \
768 }
769 image_set_hdr_b(os) /* image_set_os */
770 image_set_hdr_b(arch) /* image_set_arch */
771 image_set_hdr_b(type) /* image_set_type */
772 image_set_hdr_b(comp) /* image_set_comp */
773
774 static inline void image_set_name(image_header_t *hdr, const char *name)
775 {
776 strncpy(image_get_name(hdr), name, IH_NMLEN);
777 }
778
779 int image_check_hcrc(const image_header_t *hdr);
780 int image_check_dcrc(const image_header_t *hdr);
781 #ifndef USE_HOSTCC
782 ulong getenv_bootm_low(void);
783 phys_size_t getenv_bootm_size(void);
784 phys_size_t getenv_bootm_mapsize(void);
785 #endif
786 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
787
788 static inline int image_check_magic(const image_header_t *hdr)
789 {
790 return (image_get_magic(hdr) == IH_MAGIC);
791 }
792 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
793 {
794 return (image_get_type(hdr) == type);
795 }
796 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
797 {
798 return (image_get_arch(hdr) == arch);
799 }
800 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
801 {
802 return (image_get_os(hdr) == os);
803 }
804
805 ulong image_multi_count(const image_header_t *hdr);
806 void image_multi_getimg(const image_header_t *hdr, ulong idx,
807 ulong *data, ulong *len);
808
809 void image_print_contents(const void *hdr);
810
811 #ifndef USE_HOSTCC
812 static inline int image_check_target_arch(const image_header_t *hdr)
813 {
814 #ifndef IH_ARCH_DEFAULT
815 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
816 #endif
817 return image_check_arch(hdr, IH_ARCH_DEFAULT);
818 }
819 #endif /* USE_HOSTCC */
820
821 /**
822 * Set up properties in the FDT
823 *
824 * This sets up properties in the FDT that is to be passed to linux.
825 *
826 * @images: Images information
827 * @blob: FDT to update
828 * @of_size: Size of the FDT
829 * @lmb: Points to logical memory block structure
830 * @return 0 if ok, <0 on failure
831 */
832 int image_setup_libfdt(bootm_headers_t *images, void *blob,
833 int of_size, struct lmb *lmb);
834
835 /**
836 * Set up the FDT to use for booting a kernel
837 *
838 * This performs ramdisk setup, sets up the FDT if required, and adds
839 * paramters to the FDT if libfdt is available.
840 *
841 * @param images Images information
842 * @return 0 if ok, <0 on failure
843 */
844 int image_setup_linux(bootm_headers_t *images);
845
846 /**
847 * bootz_setup() - Extract stat and size of a Linux xImage
848 *
849 * @image: Address of image
850 * @start: Returns start address of image
851 * @end : Returns end address of image
852 * @return 0 if OK, 1 if the image was not recognised
853 */
854 int bootz_setup(ulong image, ulong *start, ulong *end);
855
856
857 /*******************************************************************/
858 /* New uImage format specific code (prefixed with fit_) */
859 /*******************************************************************/
860
861 #define FIT_IMAGES_PATH "/images"
862 #define FIT_CONFS_PATH "/configurations"
863
864 /* hash/signature node */
865 #define FIT_HASH_NODENAME "hash"
866 #define FIT_ALGO_PROP "algo"
867 #define FIT_VALUE_PROP "value"
868 #define FIT_IGNORE_PROP "uboot-ignore"
869 #define FIT_SIG_NODENAME "signature"
870
871 /* image node */
872 #define FIT_DATA_PROP "data"
873 #define FIT_TIMESTAMP_PROP "timestamp"
874 #define FIT_DESC_PROP "description"
875 #define FIT_ARCH_PROP "arch"
876 #define FIT_TYPE_PROP "type"
877 #define FIT_OS_PROP "os"
878 #define FIT_COMP_PROP "compression"
879 #define FIT_ENTRY_PROP "entry"
880 #define FIT_LOAD_PROP "load"
881
882 /* configuration node */
883 #define FIT_KERNEL_PROP "kernel"
884 #define FIT_RAMDISK_PROP "ramdisk"
885 #define FIT_FDT_PROP "fdt"
886 #define FIT_LOADABLE_PROP "loadables"
887 #define FIT_DEFAULT_PROP "default"
888 #define FIT_SETUP_PROP "setup"
889 #define FIT_FPGA_PROP "fpga"
890
891 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
892
893 #if IMAGE_ENABLE_FIT
894 /* cmdline argument format parsing */
895 int fit_parse_conf(const char *spec, ulong addr_curr,
896 ulong *addr, const char **conf_name);
897 int fit_parse_subimage(const char *spec, ulong addr_curr,
898 ulong *addr, const char **image_name);
899
900 int fit_get_subimage_count(const void *fit, int images_noffset);
901 void fit_print_contents(const void *fit);
902 void fit_image_print(const void *fit, int noffset, const char *p);
903
904 /**
905 * fit_get_end - get FIT image size
906 * @fit: pointer to the FIT format image header
907 *
908 * returns:
909 * size of the FIT image (blob) in memory
910 */
911 static inline ulong fit_get_size(const void *fit)
912 {
913 return fdt_totalsize(fit);
914 }
915
916 /**
917 * fit_get_end - get FIT image end
918 * @fit: pointer to the FIT format image header
919 *
920 * returns:
921 * end address of the FIT image (blob) in memory
922 */
923 ulong fit_get_end(const void *fit);
924
925 /**
926 * fit_get_name - get FIT node name
927 * @fit: pointer to the FIT format image header
928 *
929 * returns:
930 * NULL, on error
931 * pointer to node name, on success
932 */
933 static inline const char *fit_get_name(const void *fit_hdr,
934 int noffset, int *len)
935 {
936 return fdt_get_name(fit_hdr, noffset, len);
937 }
938
939 int fit_get_desc(const void *fit, int noffset, char **desc);
940 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
941
942 int fit_image_get_node(const void *fit, const char *image_uname);
943 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
944 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
945 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
946 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
947 int fit_image_get_load(const void *fit, int noffset, ulong *load);
948 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
949 int fit_image_get_data(const void *fit, int noffset,
950 const void **data, size_t *size);
951
952 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
953 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
954 int *value_len);
955
956 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
957
958 /**
959 * fit_add_verification_data() - add verification data to FIT image nodes
960 *
961 * @keydir: Directory containing keys
962 * @kwydest: FDT blob to write public key information to
963 * @fit: Pointer to the FIT format image header
964 * @comment: Comment to add to signature nodes
965 * @require_keys: Mark all keys as 'required'
966 *
967 * Adds hash values for all component images in the FIT blob.
968 * Hashes are calculated for all component images which have hash subnodes
969 * with algorithm property set to one of the supported hash algorithms.
970 *
971 * Also add signatures if signature nodes are present.
972 *
973 * returns
974 * 0, on success
975 * libfdt error code, on failure
976 */
977 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
978 const char *comment, int require_keys);
979
980 int fit_image_verify(const void *fit, int noffset);
981 int fit_config_verify(const void *fit, int conf_noffset);
982 int fit_all_image_verify(const void *fit);
983 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
984 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
985 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
986 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
987 int fit_check_format(const void *fit);
988
989 int fit_conf_find_compat(const void *fit, const void *fdt);
990 int fit_conf_get_node(const void *fit, const char *conf_uname);
991
992 /**
993 * fit_conf_get_prop_node() - Get node refered to by a configuration
994 * @fit: FIT to check
995 * @noffset: Offset of conf@xxx node to check
996 * @prop_name: Property to read from the conf node
997 *
998 * The conf@ nodes contain references to other nodes, using properties
999 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
1000 * return the offset of the node referred to (e.g. offset of node
1001 * "/images/kernel@1".
1002 */
1003 int fit_conf_get_prop_node(const void *fit, int noffset,
1004 const char *prop_name);
1005
1006 void fit_conf_print(const void *fit, int noffset, const char *p);
1007
1008 int fit_check_ramdisk(const void *fit, int os_noffset,
1009 uint8_t arch, int verify);
1010
1011 int calculate_hash(const void *data, int data_len, const char *algo,
1012 uint8_t *value, int *value_len);
1013
1014 /*
1015 * At present we only support signing on the host, and verification on the
1016 * device
1017 */
1018 #if defined(CONFIG_FIT_SIGNATURE)
1019 # ifdef USE_HOSTCC
1020 # define IMAGE_ENABLE_SIGN 1
1021 # define IMAGE_ENABLE_VERIFY 1
1022 # include <openssl/evp.h>
1023 #else
1024 # define IMAGE_ENABLE_SIGN 0
1025 # define IMAGE_ENABLE_VERIFY 1
1026 # endif
1027 #else
1028 # define IMAGE_ENABLE_SIGN 0
1029 # define IMAGE_ENABLE_VERIFY 0
1030 #endif
1031
1032 #ifdef USE_HOSTCC
1033 void *image_get_host_blob(void);
1034 void image_set_host_blob(void *host_blob);
1035 # define gd_fdt_blob() image_get_host_blob()
1036 #else
1037 # define gd_fdt_blob() (gd->fdt_blob)
1038 #endif
1039
1040 #ifdef CONFIG_FIT_BEST_MATCH
1041 #define IMAGE_ENABLE_BEST_MATCH 1
1042 #else
1043 #define IMAGE_ENABLE_BEST_MATCH 0
1044 #endif
1045
1046 /* Information passed to the signing routines */
1047 struct image_sign_info {
1048 const char *keydir; /* Directory conaining keys */
1049 const char *keyname; /* Name of key to use */
1050 void *fit; /* Pointer to FIT blob */
1051 int node_offset; /* Offset of signature node */
1052 struct image_sig_algo *algo; /* Algorithm information */
1053 const void *fdt_blob; /* FDT containing public keys */
1054 int required_keynode; /* Node offset of key to use: -1=any */
1055 const char *require_keys; /* Value for 'required' property */
1056 };
1057 #endif /* Allow struct image_region to always be defined for rsa.h */
1058
1059 /* A part of an image, used for hashing */
1060 struct image_region {
1061 const void *data;
1062 int size;
1063 };
1064
1065 #if IMAGE_ENABLE_FIT
1066
1067 #if IMAGE_ENABLE_VERIFY
1068 # include <u-boot/rsa-checksum.h>
1069 #endif
1070 struct checksum_algo {
1071 const char *name;
1072 const int checksum_len;
1073 const int der_len;
1074 const uint8_t *der_prefix;
1075 const int key_len;
1076 #if IMAGE_ENABLE_SIGN
1077 const EVP_MD *(*calculate_sign)(void);
1078 #endif
1079 int (*calculate)(const char *name,
1080 const struct image_region region[],
1081 int region_count, uint8_t *checksum);
1082 };
1083
1084 struct image_sig_algo {
1085 const char *name; /* Name of algorithm */
1086
1087 /**
1088 * sign() - calculate and return signature for given input data
1089 *
1090 * @info: Specifies key and FIT information
1091 * @data: Pointer to the input data
1092 * @data_len: Data length
1093 * @sigp: Set to an allocated buffer holding the signature
1094 * @sig_len: Set to length of the calculated hash
1095 *
1096 * This computes input data signature according to selected algorithm.
1097 * Resulting signature value is placed in an allocated buffer, the
1098 * pointer is returned as *sigp. The length of the calculated
1099 * signature is returned via the sig_len pointer argument. The caller
1100 * should free *sigp.
1101 *
1102 * @return: 0, on success, -ve on error
1103 */
1104 int (*sign)(struct image_sign_info *info,
1105 const struct image_region region[],
1106 int region_count, uint8_t **sigp, uint *sig_len);
1107
1108 /**
1109 * add_verify_data() - Add verification information to FDT
1110 *
1111 * Add public key information to the FDT node, suitable for
1112 * verification at run-time. The information added depends on the
1113 * algorithm being used.
1114 *
1115 * @info: Specifies key and FIT information
1116 * @keydest: Destination FDT blob for public key data
1117 * @return: 0, on success, -ve on error
1118 */
1119 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1120
1121 /**
1122 * verify() - Verify a signature against some data
1123 *
1124 * @info: Specifies key and FIT information
1125 * @data: Pointer to the input data
1126 * @data_len: Data length
1127 * @sig: Signature
1128 * @sig_len: Number of bytes in signature
1129 * @return 0 if verified, -ve on error
1130 */
1131 int (*verify)(struct image_sign_info *info,
1132 const struct image_region region[], int region_count,
1133 uint8_t *sig, uint sig_len);
1134
1135 /* pointer to checksum algorithm */
1136 struct checksum_algo *checksum;
1137 };
1138
1139 /**
1140 * image_get_sig_algo() - Look up a signature algortihm
1141 *
1142 * @param name Name of algorithm
1143 * @return pointer to algorithm information, or NULL if not found
1144 */
1145 struct image_sig_algo *image_get_sig_algo(const char *name);
1146
1147 /**
1148 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1149 *
1150 * @fit: FIT to check
1151 * @image_noffset: Offset of image node to check
1152 * @data: Image data to check
1153 * @size: Size of image data
1154 * @sig_blob: FDT containing public keys
1155 * @no_sigsp: Returns 1 if no signatures were required, and
1156 * therefore nothing was checked. The caller may wish
1157 * to fall back to other mechanisms, or refuse to
1158 * boot.
1159 * @return 0 if all verified ok, <0 on error
1160 */
1161 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1162 const char *data, size_t size, const void *sig_blob,
1163 int *no_sigsp);
1164
1165 /**
1166 * fit_image_check_sig() - Check a single image signature node
1167 *
1168 * @fit: FIT to check
1169 * @noffset: Offset of signature node to check
1170 * @data: Image data to check
1171 * @size: Size of image data
1172 * @required_keynode: Offset in the control FDT of the required key node,
1173 * if any. If this is given, then the image wil not
1174 * pass verification unless that key is used. If this is
1175 * -1 then any signature will do.
1176 * @err_msgp: In the event of an error, this will be pointed to a
1177 * help error string to display to the user.
1178 * @return 0 if all verified ok, <0 on error
1179 */
1180 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1181 size_t size, int required_keynode, char **err_msgp);
1182
1183 /**
1184 * fit_region_make_list() - Make a list of regions to hash
1185 *
1186 * Given a list of FIT regions (offset, size) provided by libfdt, create
1187 * a list of regions (void *, size) for use by the signature creationg
1188 * and verification code.
1189 *
1190 * @fit: FIT image to process
1191 * @fdt_regions: Regions as returned by libfdt
1192 * @count: Number of regions returned by libfdt
1193 * @region: Place to put list of regions (NULL to allocate it)
1194 * @return pointer to list of regions, or NULL if out of memory
1195 */
1196 struct image_region *fit_region_make_list(const void *fit,
1197 struct fdt_region *fdt_regions, int count,
1198 struct image_region *region);
1199
1200 static inline int fit_image_check_target_arch(const void *fdt, int node)
1201 {
1202 #ifndef USE_HOSTCC
1203 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1204 #else
1205 return 0;
1206 #endif
1207 }
1208
1209 #ifdef CONFIG_FIT_VERBOSE
1210 #define fit_unsupported(msg) printf("! %s:%d " \
1211 "FIT images not supported for '%s'\n", \
1212 __FILE__, __LINE__, (msg))
1213
1214 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1215 "FIT images not supported for '%s' " \
1216 "- must reset board to recover!\n", \
1217 __FILE__, __LINE__, (msg))
1218 #else
1219 #define fit_unsupported(msg)
1220 #define fit_unsupported_reset(msg)
1221 #endif /* CONFIG_FIT_VERBOSE */
1222 #endif /* CONFIG_FIT */
1223
1224 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1225 struct andr_img_hdr;
1226 int android_image_check_header(const struct andr_img_hdr *hdr);
1227 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1228 ulong *os_data, ulong *os_len);
1229 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1230 ulong *rd_data, ulong *rd_len);
1231 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1232 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1233 void android_print_contents(const struct andr_img_hdr *hdr);
1234
1235 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1236
1237 /**
1238 * board_fit_config_name_match() - Check for a matching board name
1239 *
1240 * This is used when SPL loads a FIT containing multiple device tree files
1241 * and wants to work out which one to use. The description of each one is
1242 * passed to this function. The description comes from the 'description' field
1243 * in each (FDT) image node.
1244 *
1245 * @name: Device tree description
1246 * @return 0 if this device tree should be used, non-zero to try the next
1247 */
1248 int board_fit_config_name_match(const char *name);
1249
1250 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1251 /**
1252 * board_fit_image_post_process() - Do any post-process on FIT binary data
1253 *
1254 * This is used to do any sort of image manipulation, verification, decryption
1255 * etc. in a platform or board specific way. Obviously, anything done here would
1256 * need to be comprehended in how the images were prepared before being injected
1257 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1258 * before being added to the FIT image).
1259 *
1260 * @image: pointer to the image start pointer
1261 * @size: pointer to the image size
1262 * @return no return value (failure should be handled internally)
1263 */
1264 void board_fit_image_post_process(void **p_image, size_t *p_size);
1265 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1266
1267 #endif /* __IMAGE_H__ */