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