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