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