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