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