15b1d7137Swdenk /* 2b97a2a0aSMarian Balakowicz * (C) Copyright 2008 Semihalf 3b97a2a0aSMarian Balakowicz * 4f08abe31SWolfgang Denk * (C) Copyright 2000-2005 55b1d7137Swdenk * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 65b1d7137Swdenk * 75b1d7137Swdenk * See file CREDITS for list of people who contributed to this 85b1d7137Swdenk * project. 95b1d7137Swdenk * 105b1d7137Swdenk * This program is free software; you can redistribute it and/or 115b1d7137Swdenk * modify it under the terms of the GNU General Public License as 125b1d7137Swdenk * published by the Free Software Foundation; either version 2 of 135b1d7137Swdenk * the License, or (at your option) any later version. 145b1d7137Swdenk * 155b1d7137Swdenk * This program is distributed in the hope that it will be useful, 165b1d7137Swdenk * but WITHOUT ANY WARRANTY; without even the implied warranty of 175b1d7137Swdenk * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 185b1d7137Swdenk * GNU General Public License for more details. 195b1d7137Swdenk * 205b1d7137Swdenk * You should have received a copy of the GNU General Public License 215b1d7137Swdenk * along with this program; if not, write to the Free Software 225b1d7137Swdenk * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 235b1d7137Swdenk * MA 02111-1307 USA 24f08abe31SWolfgang Denk * 25f08abe31SWolfgang Denk ******************************************************************** 26f08abe31SWolfgang Denk * NOTE: This header file defines an interface to U-Boot. Including 27f08abe31SWolfgang Denk * this (unmodified) header file in another file is considered normal 28f08abe31SWolfgang Denk * use of U-Boot, and does *not* fall under the heading of "derived 29f08abe31SWolfgang Denk * work". 30f08abe31SWolfgang Denk ******************************************************************** 315b1d7137Swdenk */ 325b1d7137Swdenk 335b1d7137Swdenk #ifndef __IMAGE_H__ 345b1d7137Swdenk #define __IMAGE_H__ 355b1d7137Swdenk 36b97a2a0aSMarian Balakowicz #include <asm/byteorder.h> 375ad03eb3SMarian Balakowicz #include <command.h> 3875d3e8fbSMarian Balakowicz 39b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC 404ed6552fSKumar Gala #include <lmb.h> 41b97a2a0aSMarian Balakowicz #include <linux/string.h> 42ceaed2b1SMarian Balakowicz #include <asm/u-boot.h> 4375d3e8fbSMarian Balakowicz 449d25438fSBartlomiej Sieka #else 459d25438fSBartlomiej Sieka 469d25438fSBartlomiej Sieka /* new uImage format support enabled on host */ 479d25438fSBartlomiej Sieka #define CONFIG_FIT 1 489d25438fSBartlomiej Sieka #define CONFIG_OF_LIBFDT 1 499d25438fSBartlomiej Sieka #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 509d25438fSBartlomiej Sieka 519d25438fSBartlomiej Sieka #endif /* USE_HOSTCC */ 52d5934ad7SMarian Balakowicz 5375d3e8fbSMarian Balakowicz #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT) 5475d3e8fbSMarian Balakowicz #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!" 55b97a2a0aSMarian Balakowicz #endif 565dfb5213SMarian Balakowicz 575dfb5213SMarian Balakowicz #if defined(CONFIG_FIT) 585dfb5213SMarian Balakowicz #include <fdt.h> 595dfb5213SMarian Balakowicz #include <libfdt.h> 605dfb5213SMarian Balakowicz #include <fdt_support.h> 61766529fcSBartlomiej Sieka #define CONFIG_MD5 /* FIT images need MD5 support */ 625dfb5213SMarian Balakowicz #endif 63b97a2a0aSMarian Balakowicz 645b1d7137Swdenk /* 655b1d7137Swdenk * Operating System Codes 665b1d7137Swdenk */ 675b1d7137Swdenk #define IH_OS_INVALID 0 /* Invalid OS */ 685b1d7137Swdenk #define IH_OS_OPENBSD 1 /* OpenBSD */ 695b1d7137Swdenk #define IH_OS_NETBSD 2 /* NetBSD */ 705b1d7137Swdenk #define IH_OS_FREEBSD 3 /* FreeBSD */ 715b1d7137Swdenk #define IH_OS_4_4BSD 4 /* 4.4BSD */ 725b1d7137Swdenk #define IH_OS_LINUX 5 /* Linux */ 735b1d7137Swdenk #define IH_OS_SVR4 6 /* SVR4 */ 745b1d7137Swdenk #define IH_OS_ESIX 7 /* Esix */ 755b1d7137Swdenk #define IH_OS_SOLARIS 8 /* Solaris */ 765b1d7137Swdenk #define IH_OS_IRIX 9 /* Irix */ 775b1d7137Swdenk #define IH_OS_SCO 10 /* SCO */ 785b1d7137Swdenk #define IH_OS_DELL 11 /* Dell */ 795b1d7137Swdenk #define IH_OS_NCR 12 /* NCR */ 805b1d7137Swdenk #define IH_OS_LYNXOS 13 /* LynxOS */ 815b1d7137Swdenk #define IH_OS_VXWORKS 14 /* VxWorks */ 825b1d7137Swdenk #define IH_OS_PSOS 15 /* pSOS */ 835b1d7137Swdenk #define IH_OS_QNX 16 /* QNX */ 845b1d7137Swdenk #define IH_OS_U_BOOT 17 /* Firmware */ 85d791b1dcSwdenk #define IH_OS_RTEMS 18 /* RTEMS */ 867f70e853Swdenk #define IH_OS_ARTOS 19 /* ARTOS */ 8727b207fdSwdenk #define IH_OS_UNITY 20 /* Unity OS */ 88*f5ed9e39SPeter Tyser #define IH_OS_INTEGRITY 21 /* INTEGRITY */ 895b1d7137Swdenk 905b1d7137Swdenk /* 915b1d7137Swdenk * CPU Architecture Codes (supported by Linux) 925b1d7137Swdenk */ 93b97a2a0aSMarian Balakowicz #define IH_ARCH_INVALID 0 /* Invalid CPU */ 94b97a2a0aSMarian Balakowicz #define IH_ARCH_ALPHA 1 /* Alpha */ 95b97a2a0aSMarian Balakowicz #define IH_ARCH_ARM 2 /* ARM */ 96b97a2a0aSMarian Balakowicz #define IH_ARCH_I386 3 /* Intel x86 */ 97b97a2a0aSMarian Balakowicz #define IH_ARCH_IA64 4 /* IA64 */ 98b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS 5 /* MIPS */ 99b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */ 100b97a2a0aSMarian Balakowicz #define IH_ARCH_PPC 7 /* PowerPC */ 101b97a2a0aSMarian Balakowicz #define IH_ARCH_S390 8 /* IBM S390 */ 102b97a2a0aSMarian Balakowicz #define IH_ARCH_SH 9 /* SuperH */ 103b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC 10 /* Sparc */ 104b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */ 105b97a2a0aSMarian Balakowicz #define IH_ARCH_M68K 12 /* M68K */ 106b97a2a0aSMarian Balakowicz #define IH_ARCH_NIOS 13 /* Nios-32 */ 107b97a2a0aSMarian Balakowicz #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */ 108b97a2a0aSMarian Balakowicz #define IH_ARCH_NIOS2 15 /* Nios-II */ 109b97a2a0aSMarian Balakowicz #define IH_ARCH_BLACKFIN 16 /* Blackfin */ 110b97a2a0aSMarian Balakowicz #define IH_ARCH_AVR32 17 /* AVR32 */ 111b97a2a0aSMarian Balakowicz #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */ 1125b1d7137Swdenk 1135b1d7137Swdenk /* 1145b1d7137Swdenk * Image Types 1155b1d7137Swdenk * 1165b1d7137Swdenk * "Standalone Programs" are directly runnable in the environment 1175b1d7137Swdenk * provided by U-Boot; it is expected that (if they behave 1185b1d7137Swdenk * well) you can continue to work in U-Boot after return from 1195b1d7137Swdenk * the Standalone Program. 1205b1d7137Swdenk * "OS Kernel Images" are usually images of some Embedded OS which 1215b1d7137Swdenk * will take over control completely. Usually these programs 1225b1d7137Swdenk * will install their own set of exception handlers, device 1235b1d7137Swdenk * drivers, set up the MMU, etc. - this means, that you cannot 1245b1d7137Swdenk * expect to re-enter U-Boot except by resetting the CPU. 1255b1d7137Swdenk * "RAMDisk Images" are more or less just data blocks, and their 1265b1d7137Swdenk * parameters (address, size) are passed to an OS kernel that is 1275b1d7137Swdenk * being started. 1285b1d7137Swdenk * "Multi-File Images" contain several images, typically an OS 1295b1d7137Swdenk * (Linux) kernel image and one or more data images like 1305b1d7137Swdenk * RAMDisks. This construct is useful for instance when you want 1315b1d7137Swdenk * to boot over the network using BOOTP etc., where the boot 1325b1d7137Swdenk * server provides just a single image file, but you want to get 1335b1d7137Swdenk * for instance an OS kernel and a RAMDisk image. 1345b1d7137Swdenk * 1355b1d7137Swdenk * "Multi-File Images" start with a list of image sizes, each 1365b1d7137Swdenk * image size (in bytes) specified by an "uint32_t" in network 1375b1d7137Swdenk * byte order. This list is terminated by an "(uint32_t)0". 1385b1d7137Swdenk * Immediately after the terminating 0 follow the images, one by 1395b1d7137Swdenk * one, all aligned on "uint32_t" boundaries (size rounded up to 140e1599e83Swdenk * a multiple of 4 bytes - except for the last file). 1415b1d7137Swdenk * 1425b1d7137Swdenk * "Firmware Images" are binary images containing firmware (like 1435b1d7137Swdenk * U-Boot or FPGA images) which usually will be programmed to 1445b1d7137Swdenk * flash memory. 1455b1d7137Swdenk * 1465b1d7137Swdenk * "Script files" are command sequences that will be executed by 1475b1d7137Swdenk * U-Boot's command interpreter; this feature is especially 1485b1d7137Swdenk * useful when you configure U-Boot to use a real shell (hush) 14927b207fdSwdenk * as command interpreter (=> Shell Scripts). 1505b1d7137Swdenk */ 1515b1d7137Swdenk 1525b1d7137Swdenk #define IH_TYPE_INVALID 0 /* Invalid Image */ 1535b1d7137Swdenk #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 1545b1d7137Swdenk #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 1555b1d7137Swdenk #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 1565b1d7137Swdenk #define IH_TYPE_MULTI 4 /* Multi-File Image */ 1575b1d7137Swdenk #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 1585b1d7137Swdenk #define IH_TYPE_SCRIPT 6 /* Script file */ 159fbe4b5cbSwdenk #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ 16025c751e9SMatthew McClintock #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ 1615b1d7137Swdenk 1625b1d7137Swdenk /* 1635b1d7137Swdenk * Compression Types 1645b1d7137Swdenk */ 1655b1d7137Swdenk #define IH_COMP_NONE 0 /* No Compression Used */ 1665b1d7137Swdenk #define IH_COMP_GZIP 1 /* gzip Compression Used */ 1675b1d7137Swdenk #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ 1685b1d7137Swdenk 1695b1d7137Swdenk #define IH_MAGIC 0x27051956 /* Image Magic Number */ 1705b1d7137Swdenk #define IH_NMLEN 32 /* Image Name Length */ 1715b1d7137Swdenk 1725b1d7137Swdenk /* 1739a4daad0SMarian Balakowicz * Legacy format image header, 1749a4daad0SMarian Balakowicz * all data in network byte order (aka natural aka bigendian). 1755b1d7137Swdenk */ 1765b1d7137Swdenk typedef struct image_header { 1775b1d7137Swdenk uint32_t ih_magic; /* Image Header Magic Number */ 1785b1d7137Swdenk uint32_t ih_hcrc; /* Image Header CRC Checksum */ 1795b1d7137Swdenk uint32_t ih_time; /* Image Creation Timestamp */ 1805b1d7137Swdenk uint32_t ih_size; /* Image Data Size */ 1815b1d7137Swdenk uint32_t ih_load; /* Data Load Address */ 1825b1d7137Swdenk uint32_t ih_ep; /* Entry Point Address */ 1835b1d7137Swdenk uint32_t ih_dcrc; /* Image Data CRC Checksum */ 1845b1d7137Swdenk uint8_t ih_os; /* Operating System */ 1855b1d7137Swdenk uint8_t ih_arch; /* CPU architecture */ 1865b1d7137Swdenk uint8_t ih_type; /* Image Type */ 1875b1d7137Swdenk uint8_t ih_comp; /* Compression Type */ 1885b1d7137Swdenk uint8_t ih_name[IH_NMLEN]; /* Image Name */ 1895b1d7137Swdenk } image_header_t; 1905b1d7137Swdenk 191396f635bSKumar Gala typedef struct image_info { 192396f635bSKumar Gala ulong start, end; /* start/end of blob */ 193396f635bSKumar Gala ulong image_start, image_len; /* start of image within blob, len of image */ 194396f635bSKumar Gala ulong load; /* load addr for the image */ 195396f635bSKumar Gala uint8_t comp, type, os; /* compression, type of image, os type */ 196396f635bSKumar Gala } image_info_t; 197396f635bSKumar Gala 198559316faSMarian Balakowicz /* 199d5934ad7SMarian Balakowicz * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() 200d5934ad7SMarian Balakowicz * routines. 201d5934ad7SMarian Balakowicz */ 202d5934ad7SMarian Balakowicz typedef struct bootm_headers { 203d5934ad7SMarian Balakowicz /* 204d5934ad7SMarian Balakowicz * Legacy os image header, if it is a multi component image 2059a4daad0SMarian Balakowicz * then boot_get_ramdisk() and get_fdt() will attempt to get 206d5934ad7SMarian Balakowicz * data from second and third component accordingly. 207d5934ad7SMarian Balakowicz */ 208cb1c4896SMarian Balakowicz image_header_t *legacy_hdr_os; /* image header pointer */ 209cb1c4896SMarian Balakowicz image_header_t legacy_hdr_os_copy; /* header copy */ 210d5934ad7SMarian Balakowicz ulong legacy_hdr_valid; 211d5934ad7SMarian Balakowicz 212d5934ad7SMarian Balakowicz #if defined(CONFIG_FIT) 213f773bea8SMarian Balakowicz const char *fit_uname_cfg; /* configuration node unit name */ 214f773bea8SMarian Balakowicz 215d5934ad7SMarian Balakowicz void *fit_hdr_os; /* os FIT image header */ 216eb6175edSMarian Balakowicz const char *fit_uname_os; /* os subimage node unit name */ 2173dfe1101SMarian Balakowicz int fit_noffset_os; /* os subimage node offset */ 218d5934ad7SMarian Balakowicz 219d5934ad7SMarian Balakowicz void *fit_hdr_rd; /* init ramdisk FIT image header */ 2203dfe1101SMarian Balakowicz const char *fit_uname_rd; /* init ramdisk subimage node unit name */ 2213dfe1101SMarian Balakowicz int fit_noffset_rd; /* init ramdisk subimage node offset */ 222d5934ad7SMarian Balakowicz 223d5934ad7SMarian Balakowicz #if defined(CONFIG_PPC) 224d5934ad7SMarian Balakowicz void *fit_hdr_fdt; /* FDT blob FIT image header */ 2253dfe1101SMarian Balakowicz const char *fit_uname_fdt; /* FDT blob subimage node unit name */ 2263dfe1101SMarian Balakowicz int fit_noffset_fdt;/* FDT blob subimage node offset */ 227d5934ad7SMarian Balakowicz #endif 2281ec73761SMarian Balakowicz #endif 2291ec73761SMarian Balakowicz 230396f635bSKumar Gala image_info_t os; /* os image info */ 231c160a954SKumar Gala ulong ep; /* entry point of OS */ 232c160a954SKumar Gala 233c4f9419cSKumar Gala ulong rd_start, rd_end;/* ramdisk start/end */ 234c4f9419cSKumar Gala 23506a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT 23606a09918SKumar Gala char *ft_addr; /* flat dev tree address */ 23706a09918SKumar Gala #endif 23806a09918SKumar Gala ulong ft_len; /* length of flat device tree */ 23906a09918SKumar Gala 2408a5ea3e6SMarian Balakowicz int verify; /* getenv("verify")[0] != 'n' */ 241396f635bSKumar Gala int valid; /* set to 1 if we've set values in the header */ 242e906cfaeSKumar Gala #ifndef USE_HOSTCC 243e906cfaeSKumar Gala struct lmb lmb; /* for memory mgmt */ 244e906cfaeSKumar Gala #endif 245d5934ad7SMarian Balakowicz } bootm_headers_t; 246d5934ad7SMarian Balakowicz 247d5934ad7SMarian Balakowicz /* 248559316faSMarian Balakowicz * Some systems (for example LWMON) have very short watchdog periods; 249559316faSMarian Balakowicz * we must make sure to split long operations like memmove() or 2507590378fSBartlomiej Sieka * checksum calculations into reasonable chunks. 251559316faSMarian Balakowicz */ 2527590378fSBartlomiej Sieka #ifndef CHUNKSZ 253559316faSMarian Balakowicz #define CHUNKSZ (64 * 1024) 2547590378fSBartlomiej Sieka #endif 2557590378fSBartlomiej Sieka 2567590378fSBartlomiej Sieka #ifndef CHUNKSZ_CRC32 2577590378fSBartlomiej Sieka #define CHUNKSZ_CRC32 (64 * 1024) 2587590378fSBartlomiej Sieka #endif 2597590378fSBartlomiej Sieka 2607590378fSBartlomiej Sieka #ifndef CHUNKSZ_MD5 2617590378fSBartlomiej Sieka #define CHUNKSZ_MD5 (64 * 1024) 2627590378fSBartlomiej Sieka #endif 2637590378fSBartlomiej Sieka 2647590378fSBartlomiej Sieka #ifndef CHUNKSZ_SHA1 2657590378fSBartlomiej Sieka #define CHUNKSZ_SHA1 (64 * 1024) 2667590378fSBartlomiej Sieka #endif 267559316faSMarian Balakowicz 2689a4daad0SMarian Balakowicz #define uimage_to_cpu(x) ntohl(x) 2699a4daad0SMarian Balakowicz #define cpu_to_uimage(x) htonl(x) 270b97a2a0aSMarian Balakowicz 271570abb0aSMarian Balakowicz const char *genimg_get_os_name (uint8_t os); 272570abb0aSMarian Balakowicz const char *genimg_get_arch_name (uint8_t arch); 273570abb0aSMarian Balakowicz const char *genimg_get_type_name (uint8_t type); 274570abb0aSMarian Balakowicz const char *genimg_get_comp_name (uint8_t comp); 275570abb0aSMarian Balakowicz int genimg_get_os_id (const char *name); 276570abb0aSMarian Balakowicz int genimg_get_arch_id (const char *name); 277570abb0aSMarian Balakowicz int genimg_get_type_id (const char *name); 278570abb0aSMarian Balakowicz int genimg_get_comp_id (const char *name); 279570abb0aSMarian Balakowicz 2809a4daad0SMarian Balakowicz #ifndef USE_HOSTCC 2819a4daad0SMarian Balakowicz /* Image format types, returned by _get_format() routine */ 2829a4daad0SMarian Balakowicz #define IMAGE_FORMAT_INVALID 0x00 2839a4daad0SMarian Balakowicz #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 2849a4daad0SMarian Balakowicz #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 2859a4daad0SMarian Balakowicz 2869a4daad0SMarian Balakowicz int genimg_get_format (void *img_addr); 287f773bea8SMarian Balakowicz int genimg_has_config (bootm_headers_t *images); 2889a4daad0SMarian Balakowicz ulong genimg_get_image (ulong img_addr); 2899a4daad0SMarian Balakowicz 290d985c849SMarian Balakowicz int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images, 291d985c849SMarian Balakowicz uint8_t arch, ulong *rd_start, ulong *rd_end); 2929a4daad0SMarian Balakowicz 29306a09918SKumar Gala 29406a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT 29506a09918SKumar Gala int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images, 29606a09918SKumar Gala char **of_flat_tree, ulong *of_size); 29706a09918SKumar Gala int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base, 29806a09918SKumar Gala char **of_flat_tree, ulong *of_size); 29906a09918SKumar Gala #endif 30006a09918SKumar Gala 3019a4daad0SMarian Balakowicz #if defined(CONFIG_PPC) || defined(CONFIG_M68K) 3029a4daad0SMarian Balakowicz int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len, 3039a4daad0SMarian Balakowicz ulong *initrd_start, ulong *initrd_end); 3049a4daad0SMarian Balakowicz 3059a4daad0SMarian Balakowicz int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end, 3069a4daad0SMarian Balakowicz ulong bootmap_base); 3079a4daad0SMarian Balakowicz int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base); 3089a4daad0SMarian Balakowicz #endif /* CONFIG_PPC || CONFIG_M68K */ 309570abb0aSMarian Balakowicz #endif /* !USE_HOSTCC */ 3109a4daad0SMarian Balakowicz 3119a4daad0SMarian Balakowicz /*******************************************************************/ 3129a4daad0SMarian Balakowicz /* Legacy format specific code (prefixed with image_) */ 3139a4daad0SMarian Balakowicz /*******************************************************************/ 314b97a2a0aSMarian Balakowicz static inline uint32_t image_get_header_size (void) 315b97a2a0aSMarian Balakowicz { 316b97a2a0aSMarian Balakowicz return (sizeof (image_header_t)); 317b97a2a0aSMarian Balakowicz } 318b97a2a0aSMarian Balakowicz 319b97a2a0aSMarian Balakowicz #define image_get_hdr_l(f) \ 320b97a2a0aSMarian Balakowicz static inline uint32_t image_get_##f(image_header_t *hdr) \ 321b97a2a0aSMarian Balakowicz { \ 3229a4daad0SMarian Balakowicz return uimage_to_cpu (hdr->ih_##f); \ 323b97a2a0aSMarian Balakowicz } 324b97a2a0aSMarian Balakowicz image_get_hdr_l (magic); 325b97a2a0aSMarian Balakowicz image_get_hdr_l (hcrc); 326b97a2a0aSMarian Balakowicz image_get_hdr_l (time); 327b97a2a0aSMarian Balakowicz image_get_hdr_l (size); 328b97a2a0aSMarian Balakowicz image_get_hdr_l (load); 329b97a2a0aSMarian Balakowicz image_get_hdr_l (ep); 330b97a2a0aSMarian Balakowicz image_get_hdr_l (dcrc); 331b97a2a0aSMarian Balakowicz 332b97a2a0aSMarian Balakowicz #define image_get_hdr_b(f) \ 333b97a2a0aSMarian Balakowicz static inline uint8_t image_get_##f(image_header_t *hdr) \ 334b97a2a0aSMarian Balakowicz { \ 335b97a2a0aSMarian Balakowicz return hdr->ih_##f; \ 336b97a2a0aSMarian Balakowicz } 337b97a2a0aSMarian Balakowicz image_get_hdr_b (os); 338b97a2a0aSMarian Balakowicz image_get_hdr_b (arch); 339b97a2a0aSMarian Balakowicz image_get_hdr_b (type); 340b97a2a0aSMarian Balakowicz image_get_hdr_b (comp); 341b97a2a0aSMarian Balakowicz 342b97a2a0aSMarian Balakowicz static inline char *image_get_name (image_header_t *hdr) 343b97a2a0aSMarian Balakowicz { 344b97a2a0aSMarian Balakowicz return (char *)hdr->ih_name; 345b97a2a0aSMarian Balakowicz } 346b97a2a0aSMarian Balakowicz 347b97a2a0aSMarian Balakowicz static inline uint32_t image_get_data_size (image_header_t *hdr) 348b97a2a0aSMarian Balakowicz { 349b97a2a0aSMarian Balakowicz return image_get_size (hdr); 350b97a2a0aSMarian Balakowicz } 351f13e7b2eSMarian Balakowicz 352f13e7b2eSMarian Balakowicz /** 353f13e7b2eSMarian Balakowicz * image_get_data - get image payload start address 354f13e7b2eSMarian Balakowicz * @hdr: image header 355f13e7b2eSMarian Balakowicz * 356f13e7b2eSMarian Balakowicz * image_get_data() returns address of the image payload. For single 357f13e7b2eSMarian Balakowicz * component images it is image data start. For multi component 358f13e7b2eSMarian Balakowicz * images it points to the null terminated table of sub-images sizes. 359f13e7b2eSMarian Balakowicz * 360f13e7b2eSMarian Balakowicz * returns: 361f13e7b2eSMarian Balakowicz * image payload data start address 362f13e7b2eSMarian Balakowicz */ 363f13e7b2eSMarian Balakowicz static inline ulong image_get_data (image_header_t *hdr) 364f13e7b2eSMarian Balakowicz { 365f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_header_size ()); 366f13e7b2eSMarian Balakowicz } 367f13e7b2eSMarian Balakowicz 368b97a2a0aSMarian Balakowicz static inline uint32_t image_get_image_size (image_header_t *hdr) 369b97a2a0aSMarian Balakowicz { 370b97a2a0aSMarian Balakowicz return (image_get_size (hdr) + image_get_header_size ()); 371b97a2a0aSMarian Balakowicz } 372f13e7b2eSMarian Balakowicz static inline ulong image_get_image_end (image_header_t *hdr) 373b97a2a0aSMarian Balakowicz { 374f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_image_size (hdr)); 375b97a2a0aSMarian Balakowicz } 376b97a2a0aSMarian Balakowicz 377b97a2a0aSMarian Balakowicz #define image_set_hdr_l(f) \ 378b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 379b97a2a0aSMarian Balakowicz { \ 3809a4daad0SMarian Balakowicz hdr->ih_##f = cpu_to_uimage (val); \ 381b97a2a0aSMarian Balakowicz } 382b97a2a0aSMarian Balakowicz image_set_hdr_l (magic); 383b97a2a0aSMarian Balakowicz image_set_hdr_l (hcrc); 384b97a2a0aSMarian Balakowicz image_set_hdr_l (time); 385b97a2a0aSMarian Balakowicz image_set_hdr_l (size); 386b97a2a0aSMarian Balakowicz image_set_hdr_l (load); 387b97a2a0aSMarian Balakowicz image_set_hdr_l (ep); 388b97a2a0aSMarian Balakowicz image_set_hdr_l (dcrc); 389b97a2a0aSMarian Balakowicz 390b97a2a0aSMarian Balakowicz #define image_set_hdr_b(f) \ 391b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 392b97a2a0aSMarian Balakowicz { \ 393b97a2a0aSMarian Balakowicz hdr->ih_##f = val; \ 394b97a2a0aSMarian Balakowicz } 395b97a2a0aSMarian Balakowicz image_set_hdr_b (os); 396b97a2a0aSMarian Balakowicz image_set_hdr_b (arch); 397b97a2a0aSMarian Balakowicz image_set_hdr_b (type); 398b97a2a0aSMarian Balakowicz image_set_hdr_b (comp); 399b97a2a0aSMarian Balakowicz 400b97a2a0aSMarian Balakowicz static inline void image_set_name (image_header_t *hdr, const char *name) 401b97a2a0aSMarian Balakowicz { 402b97a2a0aSMarian Balakowicz strncpy (image_get_name (hdr), name, IH_NMLEN); 403b97a2a0aSMarian Balakowicz } 404b97a2a0aSMarian Balakowicz 405b97a2a0aSMarian Balakowicz int image_check_hcrc (image_header_t *hdr); 406b97a2a0aSMarian Balakowicz int image_check_dcrc (image_header_t *hdr); 407af13cdbcSMarian Balakowicz #ifndef USE_HOSTCC 408edbed247SBartlomiej Sieka int getenv_yesno (char *var); 409d3f2fa0dSKumar Gala ulong getenv_bootm_low(void); 410391fd93aSBecky Bruce phys_size_t getenv_bootm_size(void); 411af13cdbcSMarian Balakowicz void memmove_wd (void *to, void *from, size_t len, ulong chunksz); 412af13cdbcSMarian Balakowicz #endif 413b97a2a0aSMarian Balakowicz 414b97a2a0aSMarian Balakowicz static inline int image_check_magic (image_header_t *hdr) 415b97a2a0aSMarian Balakowicz { 416b97a2a0aSMarian Balakowicz return (image_get_magic (hdr) == IH_MAGIC); 417b97a2a0aSMarian Balakowicz } 418b97a2a0aSMarian Balakowicz static inline int image_check_type (image_header_t *hdr, uint8_t type) 419b97a2a0aSMarian Balakowicz { 420b97a2a0aSMarian Balakowicz return (image_get_type (hdr) == type); 421b97a2a0aSMarian Balakowicz } 422b97a2a0aSMarian Balakowicz static inline int image_check_arch (image_header_t *hdr, uint8_t arch) 423b97a2a0aSMarian Balakowicz { 424b97a2a0aSMarian Balakowicz return (image_get_arch (hdr) == arch); 425b97a2a0aSMarian Balakowicz } 426b97a2a0aSMarian Balakowicz static inline int image_check_os (image_header_t *hdr, uint8_t os) 427b97a2a0aSMarian Balakowicz { 428b97a2a0aSMarian Balakowicz return (image_get_os (hdr) == os); 429b97a2a0aSMarian Balakowicz } 430b97a2a0aSMarian Balakowicz 43142b73e8eSMarian Balakowicz ulong image_multi_count (image_header_t *hdr); 43242b73e8eSMarian Balakowicz void image_multi_getimg (image_header_t *hdr, ulong idx, 43342b73e8eSMarian Balakowicz ulong *data, ulong *len); 43442b73e8eSMarian Balakowicz 435edbed247SBartlomiej Sieka void image_print_contents (image_header_t *hdr); 436570abb0aSMarian Balakowicz 437b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC 438b97a2a0aSMarian Balakowicz static inline int image_check_target_arch (image_header_t *hdr) 439b97a2a0aSMarian Balakowicz { 440b97a2a0aSMarian Balakowicz #if defined(__ARM__) 441b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_ARM)) 442b97a2a0aSMarian Balakowicz #elif defined(__avr32__) 443b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_AVR32)) 444b97a2a0aSMarian Balakowicz #elif defined(__bfin__) 445b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_BLACKFIN)) 446b97a2a0aSMarian Balakowicz #elif defined(__I386__) 447b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_I386)) 448b97a2a0aSMarian Balakowicz #elif defined(__M68K__) 449b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_M68K)) 450b97a2a0aSMarian Balakowicz #elif defined(__microblaze__) 451b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE)) 452b97a2a0aSMarian Balakowicz #elif defined(__mips__) 453b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_MIPS)) 454b97a2a0aSMarian Balakowicz #elif defined(__nios__) 455b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_NIOS)) 456b97a2a0aSMarian Balakowicz #elif defined(__nios2__) 457b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_NIOS2)) 458b97a2a0aSMarian Balakowicz #elif defined(__PPC__) 459b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_PPC)) 460b97a2a0aSMarian Balakowicz #elif defined(__sh__) 461b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_SH)) 462bf3d8b31SDaniel Hellstrom #elif defined(__sparc__) 463bf3d8b31SDaniel Hellstrom if (!image_check_arch (hdr, IH_ARCH_SPARC)) 464b97a2a0aSMarian Balakowicz #else 465b97a2a0aSMarian Balakowicz # error Unknown CPU type 466b97a2a0aSMarian Balakowicz #endif 467b97a2a0aSMarian Balakowicz return 0; 468b97a2a0aSMarian Balakowicz 469b97a2a0aSMarian Balakowicz return 1; 470b97a2a0aSMarian Balakowicz } 4715dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 4725b1d7137Swdenk 473d5934ad7SMarian Balakowicz /*******************************************************************/ 4749a4daad0SMarian Balakowicz /* New uImage format specific code (prefixed with fit_) */ 475d5934ad7SMarian Balakowicz /*******************************************************************/ 476f50433d6SMarian Balakowicz #if defined(CONFIG_FIT) 4775dfb5213SMarian Balakowicz 4785dfb5213SMarian Balakowicz #define FIT_IMAGES_PATH "/images" 4795dfb5213SMarian Balakowicz #define FIT_CONFS_PATH "/configurations" 4805dfb5213SMarian Balakowicz 4815dfb5213SMarian Balakowicz /* hash node */ 4825dfb5213SMarian Balakowicz #define FIT_HASH_NODENAME "hash" 4835dfb5213SMarian Balakowicz #define FIT_ALGO_PROP "algo" 4845dfb5213SMarian Balakowicz #define FIT_VALUE_PROP "value" 4855dfb5213SMarian Balakowicz 4865dfb5213SMarian Balakowicz /* image node */ 4875dfb5213SMarian Balakowicz #define FIT_DATA_PROP "data" 4885dfb5213SMarian Balakowicz #define FIT_TIMESTAMP_PROP "timestamp" 4895dfb5213SMarian Balakowicz #define FIT_DESC_PROP "description" 4905dfb5213SMarian Balakowicz #define FIT_ARCH_PROP "arch" 4915dfb5213SMarian Balakowicz #define FIT_TYPE_PROP "type" 4925dfb5213SMarian Balakowicz #define FIT_OS_PROP "os" 4935dfb5213SMarian Balakowicz #define FIT_COMP_PROP "compression" 4945dfb5213SMarian Balakowicz #define FIT_ENTRY_PROP "entry" 4955dfb5213SMarian Balakowicz #define FIT_LOAD_PROP "load" 4965dfb5213SMarian Balakowicz 4975dfb5213SMarian Balakowicz /* configuration node */ 4985dfb5213SMarian Balakowicz #define FIT_KERNEL_PROP "kernel" 4995dfb5213SMarian Balakowicz #define FIT_RAMDISK_PROP "ramdisk" 5005dfb5213SMarian Balakowicz #define FIT_FDT_PROP "fdt" 5015dfb5213SMarian Balakowicz #define FIT_DEFAULT_PROP "default" 5025dfb5213SMarian Balakowicz 5035dfb5213SMarian Balakowicz #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */ 5045dfb5213SMarian Balakowicz 5055dfb5213SMarian Balakowicz /* cmdline argument format parsing */ 506f50433d6SMarian Balakowicz inline int fit_parse_conf (const char *spec, ulong addr_curr, 507f50433d6SMarian Balakowicz ulong *addr, const char **conf_name); 508f50433d6SMarian Balakowicz inline int fit_parse_subimage (const char *spec, ulong addr_curr, 509f50433d6SMarian Balakowicz ulong *addr, const char **image_name); 510d5934ad7SMarian Balakowicz 511edbed247SBartlomiej Sieka void fit_print_contents (const void *fit); 5125dfb5213SMarian Balakowicz void fit_image_print (const void *fit, int noffset, const char *p); 5135dfb5213SMarian Balakowicz void fit_image_print_hash (const void *fit, int noffset, const char *p); 5145dfb5213SMarian Balakowicz 5155dfb5213SMarian Balakowicz /** 5165dfb5213SMarian Balakowicz * fit_get_end - get FIT image size 5175dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5185dfb5213SMarian Balakowicz * 5195dfb5213SMarian Balakowicz * returns: 5205dfb5213SMarian Balakowicz * size of the FIT image (blob) in memory 5215dfb5213SMarian Balakowicz */ 5225dfb5213SMarian Balakowicz static inline ulong fit_get_size (const void *fit) 5235dfb5213SMarian Balakowicz { 5245dfb5213SMarian Balakowicz return fdt_totalsize (fit); 5255dfb5213SMarian Balakowicz } 5265dfb5213SMarian Balakowicz 5275dfb5213SMarian Balakowicz /** 5285dfb5213SMarian Balakowicz * fit_get_end - get FIT image end 5295dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5305dfb5213SMarian Balakowicz * 5315dfb5213SMarian Balakowicz * returns: 5325dfb5213SMarian Balakowicz * end address of the FIT image (blob) in memory 5335dfb5213SMarian Balakowicz */ 5345dfb5213SMarian Balakowicz static inline ulong fit_get_end (const void *fit) 5355dfb5213SMarian Balakowicz { 5365dfb5213SMarian Balakowicz return (ulong)fit + fdt_totalsize (fit); 5375dfb5213SMarian Balakowicz } 5385dfb5213SMarian Balakowicz 5395dfb5213SMarian Balakowicz /** 5405dfb5213SMarian Balakowicz * fit_get_name - get FIT node name 5415dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5425dfb5213SMarian Balakowicz * 5435dfb5213SMarian Balakowicz * returns: 5445dfb5213SMarian Balakowicz * NULL, on error 5455dfb5213SMarian Balakowicz * pointer to node name, on success 5465dfb5213SMarian Balakowicz */ 5475dfb5213SMarian Balakowicz static inline const char *fit_get_name (const void *fit_hdr, 5485dfb5213SMarian Balakowicz int noffset, int *len) 5495dfb5213SMarian Balakowicz { 5505dfb5213SMarian Balakowicz return fdt_get_name (fit_hdr, noffset, len); 5515dfb5213SMarian Balakowicz } 5525dfb5213SMarian Balakowicz 5535dfb5213SMarian Balakowicz int fit_get_desc (const void *fit, int noffset, char **desc); 5545dfb5213SMarian Balakowicz int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp); 5555dfb5213SMarian Balakowicz 5565dfb5213SMarian Balakowicz int fit_image_get_node (const void *fit, const char *image_uname); 5575dfb5213SMarian Balakowicz int fit_image_get_os (const void *fit, int noffset, uint8_t *os); 5585dfb5213SMarian Balakowicz int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch); 5595dfb5213SMarian Balakowicz int fit_image_get_type (const void *fit, int noffset, uint8_t *type); 5605dfb5213SMarian Balakowicz int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp); 5615dfb5213SMarian Balakowicz int fit_image_get_load (const void *fit, int noffset, ulong *load); 5625dfb5213SMarian Balakowicz int fit_image_get_entry (const void *fit, int noffset, ulong *entry); 5635dfb5213SMarian Balakowicz int fit_image_get_data (const void *fit, int noffset, 5645dfb5213SMarian Balakowicz const void **data, size_t *size); 5655dfb5213SMarian Balakowicz 5665dfb5213SMarian Balakowicz int fit_image_hash_get_algo (const void *fit, int noffset, char **algo); 5675dfb5213SMarian Balakowicz int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value, 5685dfb5213SMarian Balakowicz int *value_len); 5695dfb5213SMarian Balakowicz 5705dfb5213SMarian Balakowicz int fit_set_timestamp (void *fit, int noffset, time_t timestamp); 5715dfb5213SMarian Balakowicz int fit_set_hashes (void *fit); 5725dfb5213SMarian Balakowicz int fit_image_set_hashes (void *fit, int image_noffset); 5735dfb5213SMarian Balakowicz int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value, 5745dfb5213SMarian Balakowicz int value_len); 5755dfb5213SMarian Balakowicz 5765dfb5213SMarian Balakowicz int fit_image_check_hashes (const void *fit, int noffset); 5775dfb5213SMarian Balakowicz int fit_image_check_os (const void *fit, int noffset, uint8_t os); 5785dfb5213SMarian Balakowicz int fit_image_check_arch (const void *fit, int noffset, uint8_t arch); 5795dfb5213SMarian Balakowicz int fit_image_check_type (const void *fit, int noffset, uint8_t type); 5805dfb5213SMarian Balakowicz int fit_image_check_comp (const void *fit, int noffset, uint8_t comp); 5815dfb5213SMarian Balakowicz int fit_check_format (const void *fit); 5825dfb5213SMarian Balakowicz 5835dfb5213SMarian Balakowicz int fit_conf_get_node (const void *fit, const char *conf_uname); 5845dfb5213SMarian Balakowicz int fit_conf_get_kernel_node (const void *fit, int noffset); 5855dfb5213SMarian Balakowicz int fit_conf_get_ramdisk_node (const void *fit, int noffset); 5865dfb5213SMarian Balakowicz int fit_conf_get_fdt_node (const void *fit, int noffset); 5875dfb5213SMarian Balakowicz 5885dfb5213SMarian Balakowicz void fit_conf_print (const void *fit, int noffset, const char *p); 5895dfb5213SMarian Balakowicz 5905dfb5213SMarian Balakowicz #ifndef USE_HOSTCC 5915dfb5213SMarian Balakowicz static inline int fit_image_check_target_arch (const void *fdt, int node) 5925dfb5213SMarian Balakowicz { 5935dfb5213SMarian Balakowicz #if defined(__ARM__) 5945dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM)) 5955dfb5213SMarian Balakowicz #elif defined(__avr32__) 5965dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32)) 5975dfb5213SMarian Balakowicz #elif defined(__bfin__) 5985dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN)) 5995dfb5213SMarian Balakowicz #elif defined(__I386__) 6005dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_I386)) 6015dfb5213SMarian Balakowicz #elif defined(__M68K__) 6025dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K)) 6035dfb5213SMarian Balakowicz #elif defined(__microblaze__) 6045dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE)) 6055dfb5213SMarian Balakowicz #elif defined(__mips__) 6065dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS)) 6075dfb5213SMarian Balakowicz #elif defined(__nios__) 6085dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS)) 6095dfb5213SMarian Balakowicz #elif defined(__nios2__) 6105dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2)) 6115dfb5213SMarian Balakowicz #elif defined(__PPC__) 6125dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC)) 6135dfb5213SMarian Balakowicz #elif defined(__sh__) 6145dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_SH)) 615bf3d8b31SDaniel Hellstrom #elif defined(__sparc__) 616bf3d8b31SDaniel Hellstrom if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC)) 6175dfb5213SMarian Balakowicz #else 6185dfb5213SMarian Balakowicz # error Unknown CPU type 6195dfb5213SMarian Balakowicz #endif 6205dfb5213SMarian Balakowicz return 0; 6215dfb5213SMarian Balakowicz 6225dfb5213SMarian Balakowicz return 1; 6235dfb5213SMarian Balakowicz } 6245dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 6255dfb5213SMarian Balakowicz 626d5934ad7SMarian Balakowicz #ifdef CONFIG_FIT_VERBOSE 627d5934ad7SMarian Balakowicz #define fit_unsupported(msg) printf ("! %s:%d " \ 628d5934ad7SMarian Balakowicz "FIT images not supported for '%s'\n", \ 629d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 630d5934ad7SMarian Balakowicz 631d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) printf ("! %s:%d " \ 632d5934ad7SMarian Balakowicz "FIT images not supported for '%s' " \ 633d5934ad7SMarian Balakowicz "- must reset board to recover!\n", \ 634d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 635d5934ad7SMarian Balakowicz #else 636d5934ad7SMarian Balakowicz #define fit_unsupported(msg) 637d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) 638d5934ad7SMarian Balakowicz #endif /* CONFIG_FIT_VERBOSE */ 639f50433d6SMarian Balakowicz #endif /* CONFIG_FIT */ 6405ad03eb3SMarian Balakowicz 6415b1d7137Swdenk #endif /* __IMAGE_H__ */ 642