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