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