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