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