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 #define BOOTM_STATE_MEASURE (0x00001000) 424 int state; 425 426 #ifdef CONFIG_LMB 427 struct lmb lmb; /* for memory mgmt */ 428 #endif 429 } bootm_headers_t; 430 431 extern bootm_headers_t images; 432 433 /* 434 * Some systems (for example LWMON) have very short watchdog periods; 435 * we must make sure to split long operations like memmove() or 436 * checksum calculations into reasonable chunks. 437 */ 438 #ifndef CHUNKSZ 439 #define CHUNKSZ (64 * 1024) 440 #endif 441 442 #ifndef CHUNKSZ_CRC32 443 #define CHUNKSZ_CRC32 (64 * 1024) 444 #endif 445 446 #ifndef CHUNKSZ_MD5 447 #define CHUNKSZ_MD5 (64 * 1024) 448 #endif 449 450 #ifndef CHUNKSZ_SHA1 451 #define CHUNKSZ_SHA1 (64 * 1024) 452 #endif 453 454 #define uimage_to_cpu(x) be32_to_cpu(x) 455 #define cpu_to_uimage(x) cpu_to_be32(x) 456 457 /* 458 * Translation table for entries of a specific type; used by 459 * get_table_entry_id() and get_table_entry_name(). 460 */ 461 typedef struct table_entry { 462 int id; 463 char *sname; /* short (input) name to find table entry */ 464 char *lname; /* long (output) name to print for messages */ 465 } table_entry_t; 466 467 /* 468 * get_table_entry_id() scans the translation table trying to find an 469 * entry that matches the given short name. If a matching entry is 470 * found, it's id is returned to the caller. 471 */ 472 int get_table_entry_id(const table_entry_t *table, 473 const char *table_name, const char *name); 474 /* 475 * get_table_entry_name() scans the translation table trying to find 476 * an entry that matches the given id. If a matching entry is found, 477 * its long name is returned to the caller. 478 */ 479 char *get_table_entry_name(const table_entry_t *table, char *msg, int id); 480 481 const char *genimg_get_os_name(uint8_t os); 482 483 /** 484 * genimg_get_os_short_name() - get the short name for an OS 485 * 486 * @param os OS (IH_OS_...) 487 * @return OS short name, or "unknown" if unknown 488 */ 489 const char *genimg_get_os_short_name(uint8_t comp); 490 491 const char *genimg_get_arch_name(uint8_t arch); 492 493 /** 494 * genimg_get_arch_short_name() - get the short name for an architecture 495 * 496 * @param arch Architecture type (IH_ARCH_...) 497 * @return architecture short name, or "unknown" if unknown 498 */ 499 const char *genimg_get_arch_short_name(uint8_t arch); 500 501 const char *genimg_get_type_name(uint8_t type); 502 503 /** 504 * genimg_get_type_short_name() - get the short name for an image type 505 * 506 * @param type Image type (IH_TYPE_...) 507 * @return image short name, or "unknown" if unknown 508 */ 509 const char *genimg_get_type_short_name(uint8_t type); 510 511 const char *genimg_get_comp_name(uint8_t comp); 512 513 /** 514 * genimg_get_comp_short_name() - get the short name for a compression method 515 * 516 * @param comp compression method (IH_COMP_...) 517 * @return compression method short name, or "unknown" if unknown 518 */ 519 const char *genimg_get_comp_short_name(uint8_t comp); 520 521 /** 522 * genimg_get_cat_name() - Get the name of an item in a category 523 * 524 * @category: Category of item 525 * @id: Item ID 526 * @return name of item, or "Unknown ..." if unknown 527 */ 528 const char *genimg_get_cat_name(enum ih_category category, uint id); 529 530 /** 531 * genimg_get_cat_short_name() - Get the short name of an item in a category 532 * 533 * @category: Category of item 534 * @id: Item ID 535 * @return short name of item, or "Unknown ..." if unknown 536 */ 537 const char *genimg_get_cat_short_name(enum ih_category category, uint id); 538 539 /** 540 * genimg_get_cat_count() - Get the number of items in a category 541 * 542 * @category: Category to check 543 * @return the number of items in the category (IH_xxx_COUNT) 544 */ 545 int genimg_get_cat_count(enum ih_category category); 546 547 /** 548 * genimg_get_cat_desc() - Get the description of a category 549 * 550 * @return the description of a category, e.g. "architecture". This 551 * effectively converts the enum to a string. 552 */ 553 const char *genimg_get_cat_desc(enum ih_category category); 554 555 int genimg_get_os_id(const char *name); 556 int genimg_get_arch_id(const char *name); 557 int genimg_get_type_id(const char *name); 558 int genimg_get_comp_id(const char *name); 559 void genimg_print_size(uint32_t size); 560 561 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \ 562 defined(USE_HOSTCC) 563 #define IMAGE_ENABLE_TIMESTAMP 1 564 #else 565 #define IMAGE_ENABLE_TIMESTAMP 0 566 #endif 567 void genimg_print_time(time_t timestamp); 568 569 /* What to do with a image load address ('load = <> 'in the FIT) */ 570 enum fit_load_op { 571 FIT_LOAD_IGNORED, /* Ignore load address */ 572 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */ 573 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */ 574 FIT_LOAD_REQUIRED, /* Must be provided */ 575 }; 576 577 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start, 578 ulong *setup_len); 579 580 #ifndef USE_HOSTCC 581 /* Image format types, returned by _get_format() routine */ 582 #define IMAGE_FORMAT_INVALID 0x00 583 #if defined(CONFIG_IMAGE_FORMAT_LEGACY) 584 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 585 #endif 586 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 587 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */ 588 589 ulong genimg_get_kernel_addr_fit(char * const img_addr, 590 const char **fit_uname_config, 591 const char **fit_uname_kernel); 592 ulong genimg_get_kernel_addr(char * const img_addr); 593 int genimg_get_format(const void *img_addr); 594 int genimg_has_config(bootm_headers_t *images); 595 596 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images, 597 uint8_t arch, const ulong *ld_start, ulong * const ld_len); 598 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, 599 uint8_t arch, ulong *rd_start, ulong *rd_end); 600 601 /** 602 * boot_get_loadable - routine to load a list of binaries to memory 603 * @argc: Ignored Argument 604 * @argv: Ignored Argument 605 * @images: pointer to the bootm images structure 606 * @arch: expected architecture for the image 607 * @ld_start: Ignored Argument 608 * @ld_len: Ignored Argument 609 * 610 * boot_get_loadable() will take the given FIT configuration, and look 611 * for a field named "loadables". Loadables, is a list of elements in 612 * the FIT given as strings. exe: 613 * loadables = "linux_kernel", "fdt-2"; 614 * this function will attempt to parse each string, and load the 615 * corresponding element from the FIT into memory. Once placed, 616 * no aditional actions are taken. 617 * 618 * @return: 619 * 0, if only valid images or no images are found 620 * error code, if an error occurs during fit_image_load 621 */ 622 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images, 623 uint8_t arch, const ulong *ld_start, ulong * const ld_len); 624 #endif /* !USE_HOSTCC */ 625 626 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, 627 ulong *setup_start, ulong *setup_len); 628 629 /** 630 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays) 631 * 632 * This deals with all aspects of loading an DTB from a FIT. 633 * The correct base image based on configuration will be selected, and 634 * then any overlays specified will be applied (as present in fit_uname_configp). 635 * 636 * @param images Boot images structure 637 * @param addr Address of FIT in memory 638 * @param fit_unamep On entry this is the requested image name 639 * (e.g. "kernel") or NULL to use the default. On exit 640 * points to the selected image name 641 * @param fit_uname_configp On entry this is the requested configuration 642 * name (e.g. "conf-1") or NULL to use the default. On 643 * exit points to the selected configuration name. 644 * @param arch Expected architecture (IH_ARCH_...) 645 * @param datap Returns address of loaded image 646 * @param lenp Returns length of loaded image 647 * 648 * @return node offset of base image, or -ve error code on error 649 */ 650 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, 651 const char **fit_unamep, const char **fit_uname_configp, 652 int arch, ulong *datap, ulong *lenp); 653 654 /** 655 * fit_image_load() - load an image from a FIT 656 * 657 * This deals with all aspects of loading an image from a FIT, including 658 * selecting the right image based on configuration, verifying it, printing 659 * out progress messages, checking the type/arch/os and optionally copying it 660 * to the right load address. 661 * 662 * The property to look up is defined by image_type. 663 * 664 * @param images Boot images structure 665 * @param addr Address of FIT in memory 666 * @param fit_unamep On entry this is the requested image name 667 * (e.g. "kernel") or NULL to use the default. On exit 668 * points to the selected image name 669 * @param fit_uname_configp On entry this is the requested configuration 670 * name (e.g. "conf-1") or NULL to use the default. On 671 * exit points to the selected configuration name. 672 * @param arch Expected architecture (IH_ARCH_...) 673 * @param image_type Required image type (IH_TYPE_...). If this is 674 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD 675 * also. 676 * @param bootstage_id ID of starting bootstage to use for progress updates. 677 * This will be added to the BOOTSTAGE_SUB values when 678 * calling bootstage_mark() 679 * @param load_op Decribes what to do with the load address 680 * @param datap Returns address of loaded image 681 * @param lenp Returns length of loaded image 682 * @return node offset of image, or -ve error code on error 683 */ 684 int fit_image_load(bootm_headers_t *images, ulong addr, 685 const char **fit_unamep, const char **fit_uname_configp, 686 int arch, int image_type, int bootstage_id, 687 enum fit_load_op load_op, ulong *datap, ulong *lenp); 688 689 #ifndef USE_HOSTCC 690 /** 691 * fit_get_node_from_config() - Look up an image a FIT by type 692 * 693 * This looks in the selected conf- node (images->fit_uname_cfg) for a 694 * particular image type (e.g. "kernel") and then finds the image that is 695 * referred to. 696 * 697 * For example, for something like: 698 * 699 * images { 700 * kernel { 701 * ... 702 * }; 703 * }; 704 * configurations { 705 * conf-1 { 706 * kernel = "kernel"; 707 * }; 708 * }; 709 * 710 * the function will return the node offset of the kernel@1 node, assuming 711 * that conf-1 is the chosen configuration. 712 * 713 * @param images Boot images structure 714 * @param prop_name Property name to look up (FIT_..._PROP) 715 * @param addr Address of FIT in memory 716 */ 717 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, 718 ulong addr); 719 720 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch, 721 bootm_headers_t *images, 722 char **of_flat_tree, ulong *of_size); 723 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob); 724 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size); 725 726 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len, 727 ulong *initrd_start, ulong *initrd_end); 728 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); 729 #ifdef CONFIG_SYS_BOOT_GET_KBD 730 int boot_get_kbd(struct lmb *lmb, bd_t **kbd); 731 #endif /* CONFIG_SYS_BOOT_GET_KBD */ 732 #endif /* !USE_HOSTCC */ 733 734 /*******************************************************************/ 735 /* Legacy format specific code (prefixed with image_) */ 736 /*******************************************************************/ 737 static inline uint32_t image_get_header_size(void) 738 { 739 return (sizeof(image_header_t)); 740 } 741 742 #define image_get_hdr_l(f) \ 743 static inline uint32_t image_get_##f(const image_header_t *hdr) \ 744 { \ 745 return uimage_to_cpu(hdr->ih_##f); \ 746 } 747 image_get_hdr_l(magic) /* image_get_magic */ 748 image_get_hdr_l(hcrc) /* image_get_hcrc */ 749 image_get_hdr_l(time) /* image_get_time */ 750 image_get_hdr_l(size) /* image_get_size */ 751 image_get_hdr_l(load) /* image_get_load */ 752 image_get_hdr_l(ep) /* image_get_ep */ 753 image_get_hdr_l(dcrc) /* image_get_dcrc */ 754 755 #define image_get_hdr_b(f) \ 756 static inline uint8_t image_get_##f(const image_header_t *hdr) \ 757 { \ 758 return hdr->ih_##f; \ 759 } 760 image_get_hdr_b(os) /* image_get_os */ 761 image_get_hdr_b(arch) /* image_get_arch */ 762 image_get_hdr_b(type) /* image_get_type */ 763 image_get_hdr_b(comp) /* image_get_comp */ 764 765 static inline char *image_get_name(const image_header_t *hdr) 766 { 767 return (char *)hdr->ih_name; 768 } 769 770 static inline uint32_t image_get_data_size(const image_header_t *hdr) 771 { 772 return image_get_size(hdr); 773 } 774 775 /** 776 * image_get_data - get image payload start address 777 * @hdr: image header 778 * 779 * image_get_data() returns address of the image payload. For single 780 * component images it is image data start. For multi component 781 * images it points to the null terminated table of sub-images sizes. 782 * 783 * returns: 784 * image payload data start address 785 */ 786 static inline ulong image_get_data(const image_header_t *hdr) 787 { 788 return ((ulong)hdr + image_get_header_size()); 789 } 790 791 static inline uint32_t image_get_image_size(const image_header_t *hdr) 792 { 793 return (image_get_size(hdr) + image_get_header_size()); 794 } 795 static inline ulong image_get_image_end(const image_header_t *hdr) 796 { 797 return ((ulong)hdr + image_get_image_size(hdr)); 798 } 799 800 #define image_set_hdr_l(f) \ 801 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 802 { \ 803 hdr->ih_##f = cpu_to_uimage(val); \ 804 } 805 image_set_hdr_l(magic) /* image_set_magic */ 806 image_set_hdr_l(hcrc) /* image_set_hcrc */ 807 image_set_hdr_l(time) /* image_set_time */ 808 image_set_hdr_l(size) /* image_set_size */ 809 image_set_hdr_l(load) /* image_set_load */ 810 image_set_hdr_l(ep) /* image_set_ep */ 811 image_set_hdr_l(dcrc) /* image_set_dcrc */ 812 813 #define image_set_hdr_b(f) \ 814 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 815 { \ 816 hdr->ih_##f = val; \ 817 } 818 image_set_hdr_b(os) /* image_set_os */ 819 image_set_hdr_b(arch) /* image_set_arch */ 820 image_set_hdr_b(type) /* image_set_type */ 821 image_set_hdr_b(comp) /* image_set_comp */ 822 823 static inline void image_set_name(image_header_t *hdr, const char *name) 824 { 825 /* 826 * This is equivalent to: strncpy(image_get_name(hdr), name, IH_NMLEN); 827 * 828 * Use the tortured code below to avoid a warning with gcc 12. We do not 829 * want to include a nul terminator if the name is of length IH_NMLEN 830 */ 831 memcpy(image_get_name(hdr), name, strnlen(name, IH_NMLEN)); 832 } 833 834 int image_check_hcrc(const image_header_t *hdr); 835 int image_check_dcrc(const image_header_t *hdr); 836 #ifndef USE_HOSTCC 837 ulong env_get_bootm_low(void); 838 phys_size_t env_get_bootm_size(void); 839 phys_size_t env_get_bootm_mapsize(void); 840 #endif 841 void memmove_wd(void *to, void *from, size_t len, ulong chunksz); 842 843 static inline int image_check_magic(const image_header_t *hdr) 844 { 845 return (image_get_magic(hdr) == IH_MAGIC); 846 } 847 static inline int image_check_type(const image_header_t *hdr, uint8_t type) 848 { 849 return (image_get_type(hdr) == type); 850 } 851 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch) 852 { 853 return (image_get_arch(hdr) == arch) || 854 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64); 855 } 856 static inline int image_check_os(const image_header_t *hdr, uint8_t os) 857 { 858 return (image_get_os(hdr) == os); 859 } 860 861 ulong image_multi_count(const image_header_t *hdr); 862 void image_multi_getimg(const image_header_t *hdr, ulong idx, 863 ulong *data, ulong *len); 864 865 void image_print_contents(const void *hdr); 866 867 #ifndef USE_HOSTCC 868 static inline int image_check_target_arch(const image_header_t *hdr) 869 { 870 #ifndef IH_ARCH_DEFAULT 871 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h" 872 #endif 873 return image_check_arch(hdr, IH_ARCH_DEFAULT); 874 } 875 #endif /* USE_HOSTCC */ 876 877 /** 878 * Set up properties in the FDT 879 * 880 * This sets up properties in the FDT that is to be passed to linux. 881 * 882 * @images: Images information 883 * @blob: FDT to update 884 * @of_size: Size of the FDT 885 * @lmb: Points to logical memory block structure 886 * @return 0 if ok, <0 on failure 887 */ 888 int image_setup_libfdt(bootm_headers_t *images, void *blob, 889 int of_size, struct lmb *lmb); 890 891 /** 892 * Set up the FDT to use for booting a kernel 893 * 894 * This performs ramdisk setup, sets up the FDT if required, and adds 895 * paramters to the FDT if libfdt is available. 896 * 897 * @param images Images information 898 * @return 0 if ok, <0 on failure 899 */ 900 int image_setup_linux(bootm_headers_t *images); 901 902 /** 903 * bootz_setup() - Extract stat and size of a Linux xImage 904 * 905 * @image: Address of image 906 * @start: Returns start address of image 907 * @end : Returns end address of image 908 * @return 0 if OK, 1 if the image was not recognised 909 */ 910 int bootz_setup(ulong image, ulong *start, ulong *end); 911 912 /** 913 * Return the correct start address and size of a Linux aarch64 Image. 914 * 915 * @image: Address of image 916 * @start: Returns start address of image 917 * @size : Returns size image 918 * @force_reloc: Ignore image->ep field, always place image to RAM start 919 * @return 0 if OK, 1 if the image was not recognised 920 */ 921 int booti_setup(ulong image, ulong *relocated_addr, ulong *size, 922 bool force_reloc); 923 924 /*******************************************************************/ 925 /* New uImage format specific code (prefixed with fit_) */ 926 /*******************************************************************/ 927 928 #define FIT_IMAGES_PATH "/images" 929 #define FIT_CONFS_PATH "/configurations" 930 931 /* hash/signature node */ 932 #define FIT_HASH_NODENAME "hash" 933 #define FIT_ALGO_PROP "algo" 934 #define FIT_VALUE_PROP "value" 935 #define FIT_IGNORE_PROP "uboot-ignore" 936 #define FIT_SIG_NODENAME "signature" 937 938 /* image node */ 939 #define FIT_DATA_PROP "data" 940 #define FIT_DATA_POSITION_PROP "data-position" 941 #define FIT_DATA_OFFSET_PROP "data-offset" 942 #define FIT_DATA_SIZE_PROP "data-size" 943 #define FIT_TIMESTAMP_PROP "timestamp" 944 #define FIT_DESC_PROP "description" 945 #define FIT_ARCH_PROP "arch" 946 #define FIT_TYPE_PROP "type" 947 #define FIT_OS_PROP "os" 948 #define FIT_COMP_PROP "compression" 949 #define FIT_ENTRY_PROP "entry" 950 #define FIT_LOAD_PROP "load" 951 952 /* configuration node */ 953 #define FIT_KERNEL_PROP "kernel" 954 #define FIT_RAMDISK_PROP "ramdisk" 955 #define FIT_FDT_PROP "fdt" 956 #define FIT_LOADABLE_PROP "loadables" 957 #define FIT_DEFAULT_PROP "default" 958 #define FIT_SETUP_PROP "setup" 959 #define FIT_FPGA_PROP "fpga" 960 #define FIT_FIRMWARE_PROP "firmware" 961 #define FIT_STANDALONE_PROP "standalone" 962 963 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE 964 965 #if IMAGE_ENABLE_FIT 966 /* cmdline argument format parsing */ 967 int fit_parse_conf(const char *spec, ulong addr_curr, 968 ulong *addr, const char **conf_name); 969 int fit_parse_subimage(const char *spec, ulong addr_curr, 970 ulong *addr, const char **image_name); 971 972 int fit_get_subimage_count(const void *fit, int images_noffset); 973 void fit_print_contents(const void *fit); 974 void fit_image_print(const void *fit, int noffset, const char *p); 975 976 /** 977 * fit_get_end - get FIT image size 978 * @fit: pointer to the FIT format image header 979 * 980 * returns: 981 * size of the FIT image (blob) in memory 982 */ 983 static inline ulong fit_get_size(const void *fit) 984 { 985 return fdt_totalsize(fit); 986 } 987 988 /** 989 * fit_get_end - get FIT image end 990 * @fit: pointer to the FIT format image header 991 * 992 * returns: 993 * end address of the FIT image (blob) in memory 994 */ 995 ulong fit_get_end(const void *fit); 996 997 /** 998 * fit_get_name - get FIT node name 999 * @fit: pointer to the FIT format image header 1000 * 1001 * returns: 1002 * NULL, on error 1003 * pointer to node name, on success 1004 */ 1005 static inline const char *fit_get_name(const void *fit_hdr, 1006 int noffset, int *len) 1007 { 1008 return fdt_get_name(fit_hdr, noffset, len); 1009 } 1010 1011 int fit_get_desc(const void *fit, int noffset, char **desc); 1012 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); 1013 1014 int fit_image_get_node(const void *fit, const char *image_uname); 1015 int fit_image_get_os(const void *fit, int noffset, uint8_t *os); 1016 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); 1017 int fit_image_get_type(const void *fit, int noffset, uint8_t *type); 1018 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); 1019 int fit_image_get_load(const void *fit, int noffset, ulong *load); 1020 int fit_image_get_entry(const void *fit, int noffset, ulong *entry); 1021 int fit_image_get_data(const void *fit, int noffset, 1022 const void **data, size_t *size); 1023 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset); 1024 int fit_image_get_data_position(const void *fit, int noffset, 1025 int *data_position); 1026 int fit_image_get_data_size(const void *fit, int noffset, int *data_size); 1027 int fit_image_get_data_and_size(const void *fit, int noffset, 1028 const void **data, size_t *size); 1029 1030 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); 1031 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, 1032 int *value_len); 1033 1034 int fit_set_timestamp(void *fit, int noffset, time_t timestamp); 1035 1036 /** 1037 * fit_add_verification_data() - add verification data to FIT image nodes 1038 * 1039 * @keydir: Directory containing keys 1040 * @kwydest: FDT blob to write public key information to 1041 * @fit: Pointer to the FIT format image header 1042 * @comment: Comment to add to signature nodes 1043 * @require_keys: Mark all keys as 'required' 1044 * @engine_id: Engine to use for signing 1045 * @cmdname: Command name used when reporting errors 1046 * 1047 * Adds hash values for all component images in the FIT blob. 1048 * Hashes are calculated for all component images which have hash subnodes 1049 * with algorithm property set to one of the supported hash algorithms. 1050 * 1051 * Also add signatures if signature nodes are present. 1052 * 1053 * returns 1054 * 0, on success 1055 * libfdt error code, on failure 1056 */ 1057 int fit_add_verification_data(const char *keydir, void *keydest, void *fit, 1058 const char *comment, int require_keys, 1059 const char *engine_id, const char *cmdname); 1060 1061 int fit_image_verify_with_data(const void *fit, int image_noffset, 1062 const void *data, size_t size); 1063 int fit_image_verify(const void *fit, int noffset); 1064 int fit_config_verify(const void *fit, int conf_noffset); 1065 int fit_all_image_verify(const void *fit); 1066 int fit_image_check_os(const void *fit, int noffset, uint8_t os); 1067 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); 1068 int fit_image_check_type(const void *fit, int noffset, uint8_t type); 1069 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); 1070 int fit_check_format(const void *fit); 1071 1072 int fit_conf_find_compat(const void *fit, const void *fdt); 1073 int fit_conf_get_node(const void *fit, const char *conf_uname); 1074 1075 /** 1076 * fit_conf_get_prop_node() - Get node refered to by a configuration 1077 * @fit: FIT to check 1078 * @noffset: Offset of conf@xxx node to check 1079 * @prop_name: Property to read from the conf node 1080 * 1081 * The conf- nodes contain references to other nodes, using properties 1082 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"), 1083 * return the offset of the node referred to (e.g. offset of node 1084 * "/images/kernel". 1085 */ 1086 int fit_conf_get_prop_node(const void *fit, int noffset, 1087 const char *prop_name); 1088 1089 int fit_check_ramdisk(const void *fit, int os_noffset, 1090 uint8_t arch, int verify); 1091 1092 int calculate_hash(const void *data, int data_len, const char *algo, 1093 uint8_t *value, int *value_len); 1094 1095 /* 1096 * At present we only support signing on the host, and verification on the 1097 * device 1098 */ 1099 #if defined(CONFIG_FIT_SIGNATURE) 1100 # ifdef USE_HOSTCC 1101 # define IMAGE_ENABLE_SIGN 1 1102 # define IMAGE_ENABLE_VERIFY 1 1103 # include <openssl/evp.h> 1104 #else 1105 # define IMAGE_ENABLE_SIGN 0 1106 # define IMAGE_ENABLE_VERIFY 1 1107 # endif 1108 #else 1109 # define IMAGE_ENABLE_SIGN 0 1110 # define IMAGE_ENABLE_VERIFY 0 1111 #endif 1112 1113 #ifdef USE_HOSTCC 1114 void *image_get_host_blob(void); 1115 void image_set_host_blob(void *host_blob); 1116 # define gd_fdt_blob() image_get_host_blob() 1117 #else 1118 # define gd_fdt_blob() (gd->fdt_blob) 1119 #endif 1120 1121 #ifdef CONFIG_FIT_BEST_MATCH 1122 #define IMAGE_ENABLE_BEST_MATCH 1 1123 #else 1124 #define IMAGE_ENABLE_BEST_MATCH 0 1125 #endif 1126 1127 /* Information passed to the signing routines */ 1128 struct image_sign_info { 1129 const char *keydir; /* Directory conaining keys */ 1130 const char *keyname; /* Name of key to use */ 1131 void *fit; /* Pointer to FIT blob */ 1132 int node_offset; /* Offset of signature node */ 1133 const char *name; /* Algorithm name */ 1134 struct checksum_algo *checksum; /* Checksum algorithm information */ 1135 struct padding_algo *padding; /* Padding algorithm information */ 1136 struct crypto_algo *crypto; /* Crypto algorithm information */ 1137 const void *fdt_blob; /* FDT containing public keys */ 1138 int required_keynode; /* Node offset of key to use: -1=any */ 1139 const char *require_keys; /* Value for 'required' property */ 1140 const char *engine_id; /* Engine to use for signing */ 1141 }; 1142 #endif /* Allow struct image_region to always be defined for rsa.h */ 1143 1144 /* A part of an image, used for hashing */ 1145 struct image_region { 1146 const void *data; 1147 int size; 1148 }; 1149 1150 #if IMAGE_ENABLE_FIT 1151 1152 #if IMAGE_ENABLE_VERIFY 1153 # include <u-boot/rsa-checksum.h> 1154 #endif 1155 struct checksum_algo { 1156 const char *name; 1157 const int checksum_len; 1158 const int der_len; 1159 const uint8_t *der_prefix; 1160 #if IMAGE_ENABLE_SIGN 1161 const EVP_MD *(*calculate_sign)(void); 1162 #endif 1163 int (*calculate)(const char *name, 1164 const struct image_region region[], 1165 int region_count, uint8_t *checksum); 1166 }; 1167 1168 struct crypto_algo { 1169 const char *name; /* Name of algorithm */ 1170 const int key_len; 1171 1172 /** 1173 * sign() - calculate and return signature for given input data 1174 * 1175 * @info: Specifies key and FIT information 1176 * @data: Pointer to the input data 1177 * @data_len: Data length 1178 * @sigp: Set to an allocated buffer holding the signature 1179 * @sig_len: Set to length of the calculated hash 1180 * 1181 * This computes input data signature according to selected algorithm. 1182 * Resulting signature value is placed in an allocated buffer, the 1183 * pointer is returned as *sigp. The length of the calculated 1184 * signature is returned via the sig_len pointer argument. The caller 1185 * should free *sigp. 1186 * 1187 * @return: 0, on success, -ve on error 1188 */ 1189 int (*sign)(struct image_sign_info *info, 1190 const struct image_region region[], 1191 int region_count, uint8_t **sigp, uint *sig_len); 1192 1193 /** 1194 * add_verify_data() - Add verification information to FDT 1195 * 1196 * Add public key information to the FDT node, suitable for 1197 * verification at run-time. The information added depends on the 1198 * algorithm being used. 1199 * 1200 * @info: Specifies key and FIT information 1201 * @keydest: Destination FDT blob for public key data 1202 * @return: 0, on success, -ve on error 1203 */ 1204 int (*add_verify_data)(struct image_sign_info *info, void *keydest); 1205 1206 /** 1207 * verify() - Verify a signature against some data 1208 * 1209 * @info: Specifies key and FIT information 1210 * @data: Pointer to the input data 1211 * @data_len: Data length 1212 * @sig: Signature 1213 * @sig_len: Number of bytes in signature 1214 * @return 0 if verified, -ve on error 1215 */ 1216 int (*verify)(struct image_sign_info *info, 1217 const struct image_region region[], int region_count, 1218 uint8_t *sig, uint sig_len); 1219 }; 1220 1221 struct padding_algo { 1222 const char *name; 1223 int (*verify)(struct image_sign_info *info, 1224 uint8_t *pad, int pad_len, 1225 const uint8_t *hash, int hash_len); 1226 }; 1227 1228 /** 1229 * image_get_checksum_algo() - Look up a checksum algorithm 1230 * 1231 * @param full_name Name of algorithm in the form "checksum,crypto" 1232 * @return pointer to algorithm information, or NULL if not found 1233 */ 1234 struct checksum_algo *image_get_checksum_algo(const char *full_name); 1235 1236 /** 1237 * image_get_crypto_algo() - Look up a cryptosystem algorithm 1238 * 1239 * @param full_name Name of algorithm in the form "checksum,crypto" 1240 * @return pointer to algorithm information, or NULL if not found 1241 */ 1242 struct crypto_algo *image_get_crypto_algo(const char *full_name); 1243 1244 /** 1245 * image_get_padding_algo() - Look up a padding algorithm 1246 * 1247 * @param name Name of padding algorithm 1248 * @return pointer to algorithm information, or NULL if not found 1249 */ 1250 struct padding_algo *image_get_padding_algo(const char *name); 1251 1252 /** 1253 * fit_image_verify_required_sigs() - Verify signatures marked as 'required' 1254 * 1255 * @fit: FIT to check 1256 * @image_noffset: Offset of image node to check 1257 * @data: Image data to check 1258 * @size: Size of image data 1259 * @sig_blob: FDT containing public keys 1260 * @no_sigsp: Returns 1 if no signatures were required, and 1261 * therefore nothing was checked. The caller may wish 1262 * to fall back to other mechanisms, or refuse to 1263 * boot. 1264 * @return 0 if all verified ok, <0 on error 1265 */ 1266 int fit_image_verify_required_sigs(const void *fit, int image_noffset, 1267 const char *data, size_t size, const void *sig_blob, 1268 int *no_sigsp); 1269 1270 /** 1271 * fit_image_check_sig() - Check a single image signature node 1272 * 1273 * @fit: FIT to check 1274 * @noffset: Offset of signature node to check 1275 * @data: Image data to check 1276 * @size: Size of image data 1277 * @required_keynode: Offset in the control FDT of the required key node, 1278 * if any. If this is given, then the image wil not 1279 * pass verification unless that key is used. If this is 1280 * -1 then any signature will do. 1281 * @err_msgp: In the event of an error, this will be pointed to a 1282 * help error string to display to the user. 1283 * @return 0 if all verified ok, <0 on error 1284 */ 1285 int fit_image_check_sig(const void *fit, int noffset, const void *data, 1286 size_t size, int required_keynode, char **err_msgp); 1287 1288 /** 1289 * fit_region_make_list() - Make a list of regions to hash 1290 * 1291 * Given a list of FIT regions (offset, size) provided by libfdt, create 1292 * a list of regions (void *, size) for use by the signature creationg 1293 * and verification code. 1294 * 1295 * @fit: FIT image to process 1296 * @fdt_regions: Regions as returned by libfdt 1297 * @count: Number of regions returned by libfdt 1298 * @region: Place to put list of regions (NULL to allocate it) 1299 * @return pointer to list of regions, or NULL if out of memory 1300 */ 1301 struct image_region *fit_region_make_list(const void *fit, 1302 struct fdt_region *fdt_regions, int count, 1303 struct image_region *region); 1304 1305 static inline int fit_image_check_target_arch(const void *fdt, int node) 1306 { 1307 #ifndef USE_HOSTCC 1308 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); 1309 #else 1310 return 0; 1311 #endif 1312 } 1313 1314 #ifdef CONFIG_FIT_VERBOSE 1315 #define fit_unsupported(msg) printf("! %s:%d " \ 1316 "FIT images not supported for '%s'\n", \ 1317 __FILE__, __LINE__, (msg)) 1318 1319 #define fit_unsupported_reset(msg) printf("! %s:%d " \ 1320 "FIT images not supported for '%s' " \ 1321 "- must reset board to recover!\n", \ 1322 __FILE__, __LINE__, (msg)) 1323 #else 1324 #define fit_unsupported(msg) 1325 #define fit_unsupported_reset(msg) 1326 #endif /* CONFIG_FIT_VERBOSE */ 1327 #endif /* CONFIG_FIT */ 1328 1329 #if defined(CONFIG_ANDROID_BOOT_IMAGE) 1330 struct andr_img_hdr; 1331 int android_image_check_header(const struct andr_img_hdr *hdr); 1332 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify, 1333 ulong *os_data, ulong *os_len); 1334 int android_image_get_ramdisk(const struct andr_img_hdr *hdr, 1335 ulong *rd_data, ulong *rd_len); 1336 int android_image_get_second(const struct andr_img_hdr *hdr, 1337 ulong *second_data, ulong *second_len); 1338 ulong android_image_get_end(const struct andr_img_hdr *hdr); 1339 ulong android_image_get_kload(const struct andr_img_hdr *hdr); 1340 void android_print_contents(const struct andr_img_hdr *hdr); 1341 1342 #endif /* CONFIG_ANDROID_BOOT_IMAGE */ 1343 1344 /** 1345 * board_fit_config_name_match() - Check for a matching board name 1346 * 1347 * This is used when SPL loads a FIT containing multiple device tree files 1348 * and wants to work out which one to use. The description of each one is 1349 * passed to this function. The description comes from the 'description' field 1350 * in each (FDT) image node. 1351 * 1352 * @name: Device tree description 1353 * @return 0 if this device tree should be used, non-zero to try the next 1354 */ 1355 int board_fit_config_name_match(const char *name); 1356 1357 #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \ 1358 defined(CONFIG_FIT_IMAGE_POST_PROCESS) 1359 /** 1360 * board_fit_image_post_process() - Do any post-process on FIT binary data 1361 * 1362 * This is used to do any sort of image manipulation, verification, decryption 1363 * etc. in a platform or board specific way. Obviously, anything done here would 1364 * need to be comprehended in how the images were prepared before being injected 1365 * into the FIT creation (i.e. the binary blobs would have been pre-processed 1366 * before being added to the FIT image). 1367 * @fit: pointer to fit image 1368 * @node: offset of image node 1369 * @image: pointer to the image start pointer 1370 * @size: pointer to the image size 1371 * @return no return value (failure should be handled internally) 1372 */ 1373 void board_fit_image_post_process(const void *fit, int node, void **p_image, size_t *p_size); 1374 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */ 1375 1376 #define FDT_ERROR ((ulong)(-1)) 1377 1378 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop); 1379 1380 /** 1381 * fit_find_config_node() - Find the node for the best DTB in a FIT image 1382 * 1383 * A FIT image contains one or more DTBs. This function parses the 1384 * configurations described in the FIT images and returns the node of 1385 * the first matching DTB. To check if a DTB matches a board, this function 1386 * calls board_fit_config_name_match(). If no matching DTB is found, it returns 1387 * the node described by the default configuration if it exists. 1388 * 1389 * @fdt: pointer to flat device tree 1390 * @return the node if found, -ve otherwise 1391 */ 1392 int fit_find_config_node(const void *fdt); 1393 1394 /** 1395 * Mapping of image types to function handlers to be invoked on the associated 1396 * loaded images 1397 * 1398 * @type: Type of image, I.E. IH_TYPE_* 1399 * @handler: Function to call on loaded image 1400 */ 1401 struct fit_loadable_tbl { 1402 int type; 1403 /** 1404 * handler() - Process a loaded image 1405 * 1406 * @data: Pointer to start of loaded image data 1407 * @size: Size of loaded image data 1408 */ 1409 void (*handler)(ulong data, size_t size); 1410 }; 1411 1412 /* 1413 * Define a FIT loadable image type handler 1414 * 1415 * _type is a valid uimage_type ID as defined in the "Image Type" enum above 1416 * _handler is the handler function to call after this image type is loaded 1417 */ 1418 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \ 1419 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \ 1420 .type = _type, \ 1421 .handler = _handler, \ 1422 } 1423 1424 #endif /* __IMAGE_H__ */ 1425