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