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