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