1 /* 2 * (C) Copyright 2008 Semihalf 3 * 4 * (C) Copyright 2000-2005 5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 6 * 7 * See file CREDITS for list of people who contributed to this 8 * project. 9 * 10 * This program is free software; you can redistribute it and/or 11 * modify it under the terms of the GNU General Public License as 12 * published by the Free Software Foundation; either version 2 of 13 * the License, or (at your option) any later version. 14 * 15 * This program is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 23 * MA 02111-1307 USA 24 * 25 ******************************************************************** 26 * NOTE: This header file defines an interface to U-Boot. Including 27 * this (unmodified) header file in another file is considered normal 28 * use of U-Boot, and does *not* fall under the heading of "derived 29 * work". 30 ******************************************************************** 31 */ 32 33 #ifndef __IMAGE_H__ 34 #define __IMAGE_H__ 35 36 #include "compiler.h" 37 #include <asm/byteorder.h> 38 39 /* Define this to avoid #ifdefs later on */ 40 struct lmb; 41 42 #ifdef USE_HOSTCC 43 44 /* new uImage format support enabled on host */ 45 #define CONFIG_FIT 1 46 #define CONFIG_OF_LIBFDT 1 47 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 48 49 /* Support FIT image signing on host */ 50 #define CONFIG_FIT_SIGNATURE 51 52 #define IMAGE_ENABLE_IGNORE 0 53 #define IMAGE_INDENT_STRING "" 54 55 #else 56 57 #include <lmb.h> 58 #include <asm/u-boot.h> 59 #include <command.h> 60 61 /* Take notice of the 'ignore' property for hashes */ 62 #define IMAGE_ENABLE_IGNORE 1 63 #define IMAGE_INDENT_STRING " " 64 65 #endif /* USE_HOSTCC */ 66 67 #if defined(CONFIG_FIT) 68 #include <libfdt.h> 69 #include <fdt_support.h> 70 # ifdef CONFIG_SPL_BUILD 71 # ifdef CONFIG_SPL_CRC32_SUPPORT 72 # define IMAGE_ENABLE_CRC32 1 73 # endif 74 # ifdef CONFIG_SPL_MD5_SUPPORT 75 # define IMAGE_ENABLE_MD5 1 76 # endif 77 # ifdef CONFIG_SPL_SHA1_SUPPORT 78 # define IMAGE_ENABLE_SHA1 1 79 # endif 80 # else 81 # define CONFIG_CRC32 /* FIT images need CRC32 support */ 82 # define CONFIG_MD5 /* and MD5 */ 83 # define CONFIG_SHA1 /* and SHA1 */ 84 # define IMAGE_ENABLE_CRC32 1 85 # define IMAGE_ENABLE_MD5 1 86 # define IMAGE_ENABLE_SHA1 1 87 # endif 88 89 #ifndef IMAGE_ENABLE_CRC32 90 #define IMAGE_ENABLE_CRC32 0 91 #endif 92 93 #ifndef IMAGE_ENABLE_MD5 94 #define IMAGE_ENABLE_MD5 0 95 #endif 96 97 #ifndef IMAGE_ENABLE_SHA1 98 #define IMAGE_ENABLE_SHA1 0 99 #endif 100 101 #endif /* CONFIG_FIT */ 102 103 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH 104 # define IMAGE_ENABLE_RAMDISK_HIGH 1 105 #else 106 # define IMAGE_ENABLE_RAMDISK_HIGH 0 107 #endif 108 109 #ifdef CONFIG_OF_LIBFDT 110 # define IMAGE_ENABLE_OF_LIBFDT 1 111 #else 112 # define IMAGE_ENABLE_OF_LIBFDT 0 113 #endif 114 115 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE 116 # define IMAGE_BOOT_GET_CMDLINE 1 117 #else 118 # define IMAGE_BOOT_GET_CMDLINE 0 119 #endif 120 121 #ifdef CONFIG_OF_BOARD_SETUP 122 # define IMAAGE_OF_BOARD_SETUP 1 123 #else 124 # define IMAAGE_OF_BOARD_SETUP 0 125 #endif 126 127 /* 128 * Operating System Codes 129 */ 130 #define IH_OS_INVALID 0 /* Invalid OS */ 131 #define IH_OS_OPENBSD 1 /* OpenBSD */ 132 #define IH_OS_NETBSD 2 /* NetBSD */ 133 #define IH_OS_FREEBSD 3 /* FreeBSD */ 134 #define IH_OS_4_4BSD 4 /* 4.4BSD */ 135 #define IH_OS_LINUX 5 /* Linux */ 136 #define IH_OS_SVR4 6 /* SVR4 */ 137 #define IH_OS_ESIX 7 /* Esix */ 138 #define IH_OS_SOLARIS 8 /* Solaris */ 139 #define IH_OS_IRIX 9 /* Irix */ 140 #define IH_OS_SCO 10 /* SCO */ 141 #define IH_OS_DELL 11 /* Dell */ 142 #define IH_OS_NCR 12 /* NCR */ 143 #define IH_OS_LYNXOS 13 /* LynxOS */ 144 #define IH_OS_VXWORKS 14 /* VxWorks */ 145 #define IH_OS_PSOS 15 /* pSOS */ 146 #define IH_OS_QNX 16 /* QNX */ 147 #define IH_OS_U_BOOT 17 /* Firmware */ 148 #define IH_OS_RTEMS 18 /* RTEMS */ 149 #define IH_OS_ARTOS 19 /* ARTOS */ 150 #define IH_OS_UNITY 20 /* Unity OS */ 151 #define IH_OS_INTEGRITY 21 /* INTEGRITY */ 152 #define IH_OS_OSE 22 /* OSE */ 153 #define IH_OS_PLAN9 23 /* Plan 9 */ 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 180 /* 181 * Image Types 182 * 183 * "Standalone Programs" are directly runnable in the environment 184 * provided by U-Boot; it is expected that (if they behave 185 * well) you can continue to work in U-Boot after return from 186 * the Standalone Program. 187 * "OS Kernel Images" are usually images of some Embedded OS which 188 * will take over control completely. Usually these programs 189 * will install their own set of exception handlers, device 190 * drivers, set up the MMU, etc. - this means, that you cannot 191 * expect to re-enter U-Boot except by resetting the CPU. 192 * "RAMDisk Images" are more or less just data blocks, and their 193 * parameters (address, size) are passed to an OS kernel that is 194 * being started. 195 * "Multi-File Images" contain several images, typically an OS 196 * (Linux) kernel image and one or more data images like 197 * RAMDisks. This construct is useful for instance when you want 198 * to boot over the network using BOOTP etc., where the boot 199 * server provides just a single image file, but you want to get 200 * for instance an OS kernel and a RAMDisk image. 201 * 202 * "Multi-File Images" start with a list of image sizes, each 203 * image size (in bytes) specified by an "uint32_t" in network 204 * byte order. This list is terminated by an "(uint32_t)0". 205 * Immediately after the terminating 0 follow the images, one by 206 * one, all aligned on "uint32_t" boundaries (size rounded up to 207 * a multiple of 4 bytes - except for the last file). 208 * 209 * "Firmware Images" are binary images containing firmware (like 210 * U-Boot or FPGA images) which usually will be programmed to 211 * flash memory. 212 * 213 * "Script files" are command sequences that will be executed by 214 * U-Boot's command interpreter; this feature is especially 215 * useful when you configure U-Boot to use a real shell (hush) 216 * as command interpreter (=> Shell Scripts). 217 */ 218 219 #define IH_TYPE_INVALID 0 /* Invalid Image */ 220 #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 221 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 222 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 223 #define IH_TYPE_MULTI 4 /* Multi-File Image */ 224 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 225 #define IH_TYPE_SCRIPT 6 /* Script file */ 226 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ 227 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ 228 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */ 229 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */ 230 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */ 231 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */ 232 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */ 233 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */ 234 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot 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 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 422 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 423 424 int genimg_get_format(const void *img_addr); 425 int genimg_has_config(bootm_headers_t *images); 426 ulong genimg_get_image(ulong img_addr); 427 428 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, 429 uint8_t arch, ulong *rd_start, ulong *rd_end); 430 431 /** 432 * fit_image_load() - load an image from a FIT 433 * 434 * This deals with all aspects of loading an image from a FIT, including 435 * selecting the right image based on configuration, verifying it, printing 436 * out progress messages, checking the type/arch/os and optionally copying it 437 * to the right load address. 438 * 439 * @param images Boot images structure 440 * @param prop_name Property name to look up (FIT_..._PROP) 441 * @param addr Address of FIT in memory 442 * @param fit_unamep On entry this is the requested image name 443 * (e.g. "kernel@1") or NULL to use the default. On exit 444 * points to the selected image name 445 * @param fit_uname_config Requested configuration name, or NULL for the 446 * default 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, const char *prop_name, ulong addr, 459 const char **fit_unamep, const char *fit_uname_config, 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 /* New uImage format specific code (prefixed with fit_) */ 670 /*******************************************************************/ 671 #if defined(CONFIG_FIT) 672 673 #define FIT_IMAGES_PATH "/images" 674 #define FIT_CONFS_PATH "/configurations" 675 676 /* hash/signature node */ 677 #define FIT_HASH_NODENAME "hash" 678 #define FIT_ALGO_PROP "algo" 679 #define FIT_VALUE_PROP "value" 680 #define FIT_IGNORE_PROP "uboot-ignore" 681 #define FIT_SIG_NODENAME "signature" 682 683 /* image node */ 684 #define FIT_DATA_PROP "data" 685 #define FIT_TIMESTAMP_PROP "timestamp" 686 #define FIT_DESC_PROP "description" 687 #define FIT_ARCH_PROP "arch" 688 #define FIT_TYPE_PROP "type" 689 #define FIT_OS_PROP "os" 690 #define FIT_COMP_PROP "compression" 691 #define FIT_ENTRY_PROP "entry" 692 #define FIT_LOAD_PROP "load" 693 694 /* configuration node */ 695 #define FIT_KERNEL_PROP "kernel" 696 #define FIT_RAMDISK_PROP "ramdisk" 697 #define FIT_FDT_PROP "fdt" 698 #define FIT_DEFAULT_PROP "default" 699 700 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */ 701 702 /* cmdline argument format parsing */ 703 int fit_parse_conf(const char *spec, ulong addr_curr, 704 ulong *addr, const char **conf_name); 705 int fit_parse_subimage(const char *spec, ulong addr_curr, 706 ulong *addr, const char **image_name); 707 708 void fit_print_contents(const void *fit); 709 void fit_image_print(const void *fit, int noffset, const char *p); 710 711 /** 712 * fit_get_end - get FIT image size 713 * @fit: pointer to the FIT format image header 714 * 715 * returns: 716 * size of the FIT image (blob) in memory 717 */ 718 static inline ulong fit_get_size(const void *fit) 719 { 720 return fdt_totalsize(fit); 721 } 722 723 /** 724 * fit_get_end - get FIT image end 725 * @fit: pointer to the FIT format image header 726 * 727 * returns: 728 * end address of the FIT image (blob) in memory 729 */ 730 static inline ulong fit_get_end(const void *fit) 731 { 732 return (ulong)fit + fdt_totalsize(fit); 733 } 734 735 /** 736 * fit_get_name - get FIT node name 737 * @fit: pointer to the FIT format image header 738 * 739 * returns: 740 * NULL, on error 741 * pointer to node name, on success 742 */ 743 static inline const char *fit_get_name(const void *fit_hdr, 744 int noffset, int *len) 745 { 746 return fdt_get_name(fit_hdr, noffset, len); 747 } 748 749 int fit_get_desc(const void *fit, int noffset, char **desc); 750 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); 751 752 int fit_image_get_node(const void *fit, const char *image_uname); 753 int fit_image_get_os(const void *fit, int noffset, uint8_t *os); 754 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); 755 int fit_image_get_type(const void *fit, int noffset, uint8_t *type); 756 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); 757 int fit_image_get_load(const void *fit, int noffset, ulong *load); 758 int fit_image_get_entry(const void *fit, int noffset, ulong *entry); 759 int fit_image_get_data(const void *fit, int noffset, 760 const void **data, size_t *size); 761 762 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); 763 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, 764 int *value_len); 765 766 int fit_set_timestamp(void *fit, int noffset, time_t timestamp); 767 768 /** 769 * fit_add_verification_data() - add verification data to FIT image nodes 770 * 771 * @keydir: Directory containing keys 772 * @kwydest: FDT blob to write public key information to 773 * @fit: Pointer to the FIT format image header 774 * @comment: Comment to add to signature nodes 775 * @require_keys: Mark all keys as 'required' 776 * 777 * Adds hash values for all component images in the FIT blob. 778 * Hashes are calculated for all component images which have hash subnodes 779 * with algorithm property set to one of the supported hash algorithms. 780 * 781 * Also add signatures if signature nodes are present. 782 * 783 * returns 784 * 0, on success 785 * libfdt error code, on failure 786 */ 787 int fit_add_verification_data(const char *keydir, void *keydest, void *fit, 788 const char *comment, int require_keys); 789 790 int fit_image_verify(const void *fit, int noffset); 791 int fit_config_verify(const void *fit, int conf_noffset); 792 int fit_all_image_verify(const void *fit); 793 int fit_image_check_os(const void *fit, int noffset, uint8_t os); 794 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); 795 int fit_image_check_type(const void *fit, int noffset, uint8_t type); 796 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); 797 int fit_check_format(const void *fit); 798 799 int fit_conf_find_compat(const void *fit, const void *fdt); 800 int fit_conf_get_node(const void *fit, const char *conf_uname); 801 802 /** 803 * fit_conf_get_prop_node() - Get node refered to by a configuration 804 * @fit: FIT to check 805 * @noffset: Offset of conf@xxx node to check 806 * @prop_name: Property to read from the conf node 807 * 808 * The conf@ nodes contain references to other nodes, using properties 809 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"), 810 * return the offset of the node referred to (e.g. offset of node 811 * "/images/kernel@1". 812 */ 813 int fit_conf_get_prop_node(const void *fit, int noffset, 814 const char *prop_name); 815 816 void fit_conf_print(const void *fit, int noffset, const char *p); 817 818 int fit_check_ramdisk(const void *fit, int os_noffset, 819 uint8_t arch, int verify); 820 821 int calculate_hash(const void *data, int data_len, const char *algo, 822 uint8_t *value, int *value_len); 823 824 /* 825 * At present we only support signing on the host, and verification on the 826 * device 827 */ 828 #if defined(CONFIG_FIT_SIGNATURE) 829 # ifdef USE_HOSTCC 830 # define IMAGE_ENABLE_SIGN 1 831 # define IMAGE_ENABLE_VERIFY 0 832 #else 833 # define IMAGE_ENABLE_SIGN 0 834 # define IMAGE_ENABLE_VERIFY 1 835 # endif 836 #else 837 # define IMAGE_ENABLE_SIGN 0 838 # define IMAGE_ENABLE_VERIFY 0 839 #endif 840 841 #ifdef USE_HOSTCC 842 # define gd_fdt_blob() NULL 843 #else 844 # define gd_fdt_blob() (gd->fdt_blob) 845 #endif 846 847 #ifdef CONFIG_FIT_BEST_MATCH 848 #define IMAGE_ENABLE_BEST_MATCH 1 849 #else 850 #define IMAGE_ENABLE_BEST_MATCH 0 851 #endif 852 853 /* Information passed to the signing routines */ 854 struct image_sign_info { 855 const char *keydir; /* Directory conaining keys */ 856 const char *keyname; /* Name of key to use */ 857 void *fit; /* Pointer to FIT blob */ 858 int node_offset; /* Offset of signature node */ 859 struct image_sig_algo *algo; /* Algorithm information */ 860 const void *fdt_blob; /* FDT containing public keys */ 861 int required_keynode; /* Node offset of key to use: -1=any */ 862 const char *require_keys; /* Value for 'required' property */ 863 }; 864 865 /* A part of an image, used for hashing */ 866 struct image_region { 867 const void *data; 868 int size; 869 }; 870 871 struct image_sig_algo { 872 const char *name; /* Name of algorithm */ 873 874 /** 875 * sign() - calculate and return signature for given input data 876 * 877 * @info: Specifies key and FIT information 878 * @data: Pointer to the input data 879 * @data_len: Data length 880 * @sigp: Set to an allocated buffer holding the signature 881 * @sig_len: Set to length of the calculated hash 882 * 883 * This computes input data signature according to selected algorithm. 884 * Resulting signature value is placed in an allocated buffer, the 885 * pointer is returned as *sigp. The length of the calculated 886 * signature is returned via the sig_len pointer argument. The caller 887 * should free *sigp. 888 * 889 * @return: 0, on success, -ve on error 890 */ 891 int (*sign)(struct image_sign_info *info, 892 const struct image_region region[], 893 int region_count, uint8_t **sigp, uint *sig_len); 894 895 /** 896 * add_verify_data() - Add verification information to FDT 897 * 898 * Add public key information to the FDT node, suitable for 899 * verification at run-time. The information added depends on the 900 * algorithm being used. 901 * 902 * @info: Specifies key and FIT information 903 * @keydest: Destination FDT blob for public key data 904 * @return: 0, on success, -ve on error 905 */ 906 int (*add_verify_data)(struct image_sign_info *info, void *keydest); 907 908 /** 909 * verify() - Verify a signature against some data 910 * 911 * @info: Specifies key and FIT information 912 * @data: Pointer to the input data 913 * @data_len: Data length 914 * @sig: Signature 915 * @sig_len: Number of bytes in signature 916 * @return 0 if verified, -ve on error 917 */ 918 int (*verify)(struct image_sign_info *info, 919 const struct image_region region[], int region_count, 920 uint8_t *sig, uint sig_len); 921 }; 922 923 /** 924 * image_get_sig_algo() - Look up a signature algortihm 925 * 926 * @param name Name of algorithm 927 * @return pointer to algorithm information, or NULL if not found 928 */ 929 struct image_sig_algo *image_get_sig_algo(const char *name); 930 931 /** 932 * fit_image_verify_required_sigs() - Verify signatures marked as 'required' 933 * 934 * @fit: FIT to check 935 * @image_noffset: Offset of image node to check 936 * @data: Image data to check 937 * @size: Size of image data 938 * @sig_blob: FDT containing public keys 939 * @no_sigsp: Returns 1 if no signatures were required, and 940 * therefore nothing was checked. The caller may wish 941 * to fall back to other mechanisms, or refuse to 942 * boot. 943 * @return 0 if all verified ok, <0 on error 944 */ 945 int fit_image_verify_required_sigs(const void *fit, int image_noffset, 946 const char *data, size_t size, const void *sig_blob, 947 int *no_sigsp); 948 949 /** 950 * fit_image_check_sig() - Check a single image signature node 951 * 952 * @fit: FIT to check 953 * @noffset: Offset of signature node to check 954 * @data: Image data to check 955 * @size: Size of image data 956 * @required_keynode: Offset in the control FDT of the required key node, 957 * if any. If this is given, then the image wil not 958 * pass verification unless that key is used. If this is 959 * -1 then any signature will do. 960 * @err_msgp: In the event of an error, this will be pointed to a 961 * help error string to display to the user. 962 * @return 0 if all verified ok, <0 on error 963 */ 964 int fit_image_check_sig(const void *fit, int noffset, const void *data, 965 size_t size, int required_keynode, char **err_msgp); 966 967 /** 968 * fit_region_make_list() - Make a list of regions to hash 969 * 970 * Given a list of FIT regions (offset, size) provided by libfdt, create 971 * a list of regions (void *, size) for use by the signature creationg 972 * and verification code. 973 * 974 * @fit: FIT image to process 975 * @fdt_regions: Regions as returned by libfdt 976 * @count: Number of regions returned by libfdt 977 * @region: Place to put list of regions (NULL to allocate it) 978 * @return pointer to list of regions, or NULL if out of memory 979 */ 980 struct image_region *fit_region_make_list(const void *fit, 981 struct fdt_region *fdt_regions, int count, 982 struct image_region *region); 983 984 static inline int fit_image_check_target_arch(const void *fdt, int node) 985 { 986 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); 987 } 988 989 #ifdef CONFIG_FIT_VERBOSE 990 #define fit_unsupported(msg) printf("! %s:%d " \ 991 "FIT images not supported for '%s'\n", \ 992 __FILE__, __LINE__, (msg)) 993 994 #define fit_unsupported_reset(msg) printf("! %s:%d " \ 995 "FIT images not supported for '%s' " \ 996 "- must reset board to recover!\n", \ 997 __FILE__, __LINE__, (msg)) 998 #else 999 #define fit_unsupported(msg) 1000 #define fit_unsupported_reset(msg) 1001 #endif /* CONFIG_FIT_VERBOSE */ 1002 #endif /* CONFIG_FIT */ 1003 1004 #endif /* __IMAGE_H__ */ 1005