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