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