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