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