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