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