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