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