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