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