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 36*def0819eSWolfgang Denk #if USE_HOSTCC 37*def0819eSWolfgang Denk #include <endian.h> 389d25438fSBartlomiej Sieka 399d25438fSBartlomiej Sieka /* new uImage format support enabled on host */ 409d25438fSBartlomiej Sieka #define CONFIG_FIT 1 419d25438fSBartlomiej Sieka #define CONFIG_OF_LIBFDT 1 429d25438fSBartlomiej Sieka #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 439d25438fSBartlomiej Sieka 44*def0819eSWolfgang Denk #else 45*def0819eSWolfgang Denk 46*def0819eSWolfgang Denk #include <lmb.h> 47*def0819eSWolfgang Denk #include <linux/string.h> 48*def0819eSWolfgang Denk #include <asm/u-boot.h> 49*def0819eSWolfgang Denk #include <asm/byteorder.h> 50*def0819eSWolfgang Denk 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 57*def0819eSWolfgang Denk #include <command.h> 58*def0819eSWolfgang Denk 595dfb5213SMarian Balakowicz #if defined(CONFIG_FIT) 605dfb5213SMarian Balakowicz #include <fdt.h> 615dfb5213SMarian Balakowicz #include <libfdt.h> 625dfb5213SMarian Balakowicz #include <fdt_support.h> 63766529fcSBartlomiej Sieka #define CONFIG_MD5 /* FIT images need MD5 support */ 645dfb5213SMarian Balakowicz #endif 65b97a2a0aSMarian Balakowicz 665b1d7137Swdenk /* 675b1d7137Swdenk * Operating System Codes 685b1d7137Swdenk */ 695b1d7137Swdenk #define IH_OS_INVALID 0 /* Invalid OS */ 705b1d7137Swdenk #define IH_OS_OPENBSD 1 /* OpenBSD */ 715b1d7137Swdenk #define IH_OS_NETBSD 2 /* NetBSD */ 725b1d7137Swdenk #define IH_OS_FREEBSD 3 /* FreeBSD */ 735b1d7137Swdenk #define IH_OS_4_4BSD 4 /* 4.4BSD */ 745b1d7137Swdenk #define IH_OS_LINUX 5 /* Linux */ 755b1d7137Swdenk #define IH_OS_SVR4 6 /* SVR4 */ 765b1d7137Swdenk #define IH_OS_ESIX 7 /* Esix */ 775b1d7137Swdenk #define IH_OS_SOLARIS 8 /* Solaris */ 785b1d7137Swdenk #define IH_OS_IRIX 9 /* Irix */ 795b1d7137Swdenk #define IH_OS_SCO 10 /* SCO */ 805b1d7137Swdenk #define IH_OS_DELL 11 /* Dell */ 815b1d7137Swdenk #define IH_OS_NCR 12 /* NCR */ 825b1d7137Swdenk #define IH_OS_LYNXOS 13 /* LynxOS */ 835b1d7137Swdenk #define IH_OS_VXWORKS 14 /* VxWorks */ 845b1d7137Swdenk #define IH_OS_PSOS 15 /* pSOS */ 855b1d7137Swdenk #define IH_OS_QNX 16 /* QNX */ 865b1d7137Swdenk #define IH_OS_U_BOOT 17 /* Firmware */ 87d791b1dcSwdenk #define IH_OS_RTEMS 18 /* RTEMS */ 887f70e853Swdenk #define IH_OS_ARTOS 19 /* ARTOS */ 8927b207fdSwdenk #define IH_OS_UNITY 20 /* Unity OS */ 90f5ed9e39SPeter Tyser #define IH_OS_INTEGRITY 21 /* INTEGRITY */ 915b1d7137Swdenk 925b1d7137Swdenk /* 935b1d7137Swdenk * CPU Architecture Codes (supported by Linux) 945b1d7137Swdenk */ 95b97a2a0aSMarian Balakowicz #define IH_ARCH_INVALID 0 /* Invalid CPU */ 96b97a2a0aSMarian Balakowicz #define IH_ARCH_ALPHA 1 /* Alpha */ 97b97a2a0aSMarian Balakowicz #define IH_ARCH_ARM 2 /* ARM */ 98b97a2a0aSMarian Balakowicz #define IH_ARCH_I386 3 /* Intel x86 */ 99b97a2a0aSMarian Balakowicz #define IH_ARCH_IA64 4 /* IA64 */ 100b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS 5 /* MIPS */ 101b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */ 102b97a2a0aSMarian Balakowicz #define IH_ARCH_PPC 7 /* PowerPC */ 103b97a2a0aSMarian Balakowicz #define IH_ARCH_S390 8 /* IBM S390 */ 104b97a2a0aSMarian Balakowicz #define IH_ARCH_SH 9 /* SuperH */ 105b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC 10 /* Sparc */ 106b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */ 107b97a2a0aSMarian Balakowicz #define IH_ARCH_M68K 12 /* M68K */ 108b97a2a0aSMarian Balakowicz #define IH_ARCH_NIOS 13 /* Nios-32 */ 109b97a2a0aSMarian Balakowicz #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */ 110b97a2a0aSMarian Balakowicz #define IH_ARCH_NIOS2 15 /* Nios-II */ 111b97a2a0aSMarian Balakowicz #define IH_ARCH_BLACKFIN 16 /* Blackfin */ 112b97a2a0aSMarian Balakowicz #define IH_ARCH_AVR32 17 /* AVR32 */ 113b97a2a0aSMarian Balakowicz #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */ 1145b1d7137Swdenk 1155b1d7137Swdenk /* 1165b1d7137Swdenk * Image Types 1175b1d7137Swdenk * 1185b1d7137Swdenk * "Standalone Programs" are directly runnable in the environment 1195b1d7137Swdenk * provided by U-Boot; it is expected that (if they behave 1205b1d7137Swdenk * well) you can continue to work in U-Boot after return from 1215b1d7137Swdenk * the Standalone Program. 1225b1d7137Swdenk * "OS Kernel Images" are usually images of some Embedded OS which 1235b1d7137Swdenk * will take over control completely. Usually these programs 1245b1d7137Swdenk * will install their own set of exception handlers, device 1255b1d7137Swdenk * drivers, set up the MMU, etc. - this means, that you cannot 1265b1d7137Swdenk * expect to re-enter U-Boot except by resetting the CPU. 1275b1d7137Swdenk * "RAMDisk Images" are more or less just data blocks, and their 1285b1d7137Swdenk * parameters (address, size) are passed to an OS kernel that is 1295b1d7137Swdenk * being started. 1305b1d7137Swdenk * "Multi-File Images" contain several images, typically an OS 1315b1d7137Swdenk * (Linux) kernel image and one or more data images like 1325b1d7137Swdenk * RAMDisks. This construct is useful for instance when you want 1335b1d7137Swdenk * to boot over the network using BOOTP etc., where the boot 1345b1d7137Swdenk * server provides just a single image file, but you want to get 1355b1d7137Swdenk * for instance an OS kernel and a RAMDisk image. 1365b1d7137Swdenk * 1375b1d7137Swdenk * "Multi-File Images" start with a list of image sizes, each 1385b1d7137Swdenk * image size (in bytes) specified by an "uint32_t" in network 1395b1d7137Swdenk * byte order. This list is terminated by an "(uint32_t)0". 1405b1d7137Swdenk * Immediately after the terminating 0 follow the images, one by 1415b1d7137Swdenk * one, all aligned on "uint32_t" boundaries (size rounded up to 142e1599e83Swdenk * a multiple of 4 bytes - except for the last file). 1435b1d7137Swdenk * 1445b1d7137Swdenk * "Firmware Images" are binary images containing firmware (like 1455b1d7137Swdenk * U-Boot or FPGA images) which usually will be programmed to 1465b1d7137Swdenk * flash memory. 1475b1d7137Swdenk * 1485b1d7137Swdenk * "Script files" are command sequences that will be executed by 1495b1d7137Swdenk * U-Boot's command interpreter; this feature is especially 1505b1d7137Swdenk * useful when you configure U-Boot to use a real shell (hush) 15127b207fdSwdenk * as command interpreter (=> Shell Scripts). 1525b1d7137Swdenk */ 1535b1d7137Swdenk 1545b1d7137Swdenk #define IH_TYPE_INVALID 0 /* Invalid Image */ 1555b1d7137Swdenk #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 1565b1d7137Swdenk #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 1575b1d7137Swdenk #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 1585b1d7137Swdenk #define IH_TYPE_MULTI 4 /* Multi-File Image */ 1595b1d7137Swdenk #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 1605b1d7137Swdenk #define IH_TYPE_SCRIPT 6 /* Script file */ 161fbe4b5cbSwdenk #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ 16225c751e9SMatthew McClintock #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ 1635b1d7137Swdenk 1645b1d7137Swdenk /* 1655b1d7137Swdenk * Compression Types 1665b1d7137Swdenk */ 1675b1d7137Swdenk #define IH_COMP_NONE 0 /* No Compression Used */ 1685b1d7137Swdenk #define IH_COMP_GZIP 1 /* gzip Compression Used */ 1695b1d7137Swdenk #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ 170fc9c1727SLuigi 'Comio' Mantellini #define IH_COMP_LZMA 3 /* lzma Compression Used */ 1715b1d7137Swdenk 1725b1d7137Swdenk #define IH_MAGIC 0x27051956 /* Image Magic Number */ 1735b1d7137Swdenk #define IH_NMLEN 32 /* Image Name Length */ 1745b1d7137Swdenk 1755b1d7137Swdenk /* 1769a4daad0SMarian Balakowicz * Legacy format image header, 1779a4daad0SMarian Balakowicz * all data in network byte order (aka natural aka bigendian). 1785b1d7137Swdenk */ 1795b1d7137Swdenk typedef struct image_header { 1805b1d7137Swdenk uint32_t ih_magic; /* Image Header Magic Number */ 1815b1d7137Swdenk uint32_t ih_hcrc; /* Image Header CRC Checksum */ 1825b1d7137Swdenk uint32_t ih_time; /* Image Creation Timestamp */ 1835b1d7137Swdenk uint32_t ih_size; /* Image Data Size */ 1845b1d7137Swdenk uint32_t ih_load; /* Data Load Address */ 1855b1d7137Swdenk uint32_t ih_ep; /* Entry Point Address */ 1865b1d7137Swdenk uint32_t ih_dcrc; /* Image Data CRC Checksum */ 1875b1d7137Swdenk uint8_t ih_os; /* Operating System */ 1885b1d7137Swdenk uint8_t ih_arch; /* CPU architecture */ 1895b1d7137Swdenk uint8_t ih_type; /* Image Type */ 1905b1d7137Swdenk uint8_t ih_comp; /* Compression Type */ 1915b1d7137Swdenk uint8_t ih_name[IH_NMLEN]; /* Image Name */ 1925b1d7137Swdenk } image_header_t; 1935b1d7137Swdenk 194396f635bSKumar Gala typedef struct image_info { 195396f635bSKumar Gala ulong start, end; /* start/end of blob */ 196396f635bSKumar Gala ulong image_start, image_len; /* start of image within blob, len of image */ 197396f635bSKumar Gala ulong load; /* load addr for the image */ 198396f635bSKumar Gala uint8_t comp, type, os; /* compression, type of image, os type */ 199396f635bSKumar Gala } image_info_t; 200396f635bSKumar Gala 201559316faSMarian Balakowicz /* 202d5934ad7SMarian Balakowicz * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() 203d5934ad7SMarian Balakowicz * routines. 204d5934ad7SMarian Balakowicz */ 205d5934ad7SMarian Balakowicz typedef struct bootm_headers { 206d5934ad7SMarian Balakowicz /* 207d5934ad7SMarian Balakowicz * Legacy os image header, if it is a multi component image 2089a4daad0SMarian Balakowicz * then boot_get_ramdisk() and get_fdt() will attempt to get 209d5934ad7SMarian Balakowicz * data from second and third component accordingly. 210d5934ad7SMarian Balakowicz */ 211cb1c4896SMarian Balakowicz image_header_t *legacy_hdr_os; /* image header pointer */ 212cb1c4896SMarian Balakowicz image_header_t legacy_hdr_os_copy; /* header copy */ 213d5934ad7SMarian Balakowicz ulong legacy_hdr_valid; 214d5934ad7SMarian Balakowicz 215d5934ad7SMarian Balakowicz #if defined(CONFIG_FIT) 216f773bea8SMarian Balakowicz const char *fit_uname_cfg; /* configuration node unit name */ 217f773bea8SMarian Balakowicz 218d5934ad7SMarian Balakowicz void *fit_hdr_os; /* os FIT image header */ 219eb6175edSMarian Balakowicz const char *fit_uname_os; /* os subimage node unit name */ 2203dfe1101SMarian Balakowicz int fit_noffset_os; /* os subimage node offset */ 221d5934ad7SMarian Balakowicz 222d5934ad7SMarian Balakowicz void *fit_hdr_rd; /* init ramdisk FIT image header */ 2233dfe1101SMarian Balakowicz const char *fit_uname_rd; /* init ramdisk subimage node unit name */ 2243dfe1101SMarian Balakowicz int fit_noffset_rd; /* init ramdisk subimage node offset */ 225d5934ad7SMarian Balakowicz 226d5934ad7SMarian Balakowicz #if defined(CONFIG_PPC) 227d5934ad7SMarian Balakowicz void *fit_hdr_fdt; /* FDT blob FIT image header */ 2283dfe1101SMarian Balakowicz const char *fit_uname_fdt; /* FDT blob subimage node unit name */ 2293dfe1101SMarian Balakowicz int fit_noffset_fdt;/* FDT blob subimage node offset */ 230d5934ad7SMarian Balakowicz #endif 2311ec73761SMarian Balakowicz #endif 2321ec73761SMarian Balakowicz 233396f635bSKumar Gala image_info_t os; /* os image info */ 234c160a954SKumar Gala ulong ep; /* entry point of OS */ 235c160a954SKumar Gala 236c4f9419cSKumar Gala ulong rd_start, rd_end;/* ramdisk start/end */ 237c4f9419cSKumar Gala 23806a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT 23906a09918SKumar Gala char *ft_addr; /* flat dev tree address */ 24006a09918SKumar Gala #endif 24106a09918SKumar Gala ulong ft_len; /* length of flat device tree */ 24206a09918SKumar Gala 2438a5ea3e6SMarian Balakowicz int verify; /* getenv("verify")[0] != 'n' */ 244396f635bSKumar Gala int valid; /* set to 1 if we've set values in the header */ 245e906cfaeSKumar Gala #ifndef USE_HOSTCC 246e906cfaeSKumar Gala struct lmb lmb; /* for memory mgmt */ 247e906cfaeSKumar Gala #endif 248d5934ad7SMarian Balakowicz } bootm_headers_t; 249d5934ad7SMarian Balakowicz 250d5934ad7SMarian Balakowicz /* 251559316faSMarian Balakowicz * Some systems (for example LWMON) have very short watchdog periods; 252559316faSMarian Balakowicz * we must make sure to split long operations like memmove() or 2537590378fSBartlomiej Sieka * checksum calculations into reasonable chunks. 254559316faSMarian Balakowicz */ 2557590378fSBartlomiej Sieka #ifndef CHUNKSZ 256559316faSMarian Balakowicz #define CHUNKSZ (64 * 1024) 2577590378fSBartlomiej Sieka #endif 2587590378fSBartlomiej Sieka 2597590378fSBartlomiej Sieka #ifndef CHUNKSZ_CRC32 2607590378fSBartlomiej Sieka #define CHUNKSZ_CRC32 (64 * 1024) 2617590378fSBartlomiej Sieka #endif 2627590378fSBartlomiej Sieka 2637590378fSBartlomiej Sieka #ifndef CHUNKSZ_MD5 2647590378fSBartlomiej Sieka #define CHUNKSZ_MD5 (64 * 1024) 2657590378fSBartlomiej Sieka #endif 2667590378fSBartlomiej Sieka 2677590378fSBartlomiej Sieka #ifndef CHUNKSZ_SHA1 2687590378fSBartlomiej Sieka #define CHUNKSZ_SHA1 (64 * 1024) 2697590378fSBartlomiej Sieka #endif 270559316faSMarian Balakowicz 2719a4daad0SMarian Balakowicz #define uimage_to_cpu(x) ntohl(x) 2729a4daad0SMarian Balakowicz #define cpu_to_uimage(x) htonl(x) 273b97a2a0aSMarian Balakowicz 274570abb0aSMarian Balakowicz const char *genimg_get_os_name (uint8_t os); 275570abb0aSMarian Balakowicz const char *genimg_get_arch_name (uint8_t arch); 276570abb0aSMarian Balakowicz const char *genimg_get_type_name (uint8_t type); 277570abb0aSMarian Balakowicz const char *genimg_get_comp_name (uint8_t comp); 278570abb0aSMarian Balakowicz int genimg_get_os_id (const char *name); 279570abb0aSMarian Balakowicz int genimg_get_arch_id (const char *name); 280570abb0aSMarian Balakowicz int genimg_get_type_id (const char *name); 281570abb0aSMarian Balakowicz int genimg_get_comp_id (const char *name); 282570abb0aSMarian Balakowicz 2839a4daad0SMarian Balakowicz #ifndef USE_HOSTCC 2849a4daad0SMarian Balakowicz /* Image format types, returned by _get_format() routine */ 2859a4daad0SMarian Balakowicz #define IMAGE_FORMAT_INVALID 0x00 2869a4daad0SMarian Balakowicz #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 2879a4daad0SMarian Balakowicz #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 2889a4daad0SMarian Balakowicz 2899a4daad0SMarian Balakowicz int genimg_get_format (void *img_addr); 290f773bea8SMarian Balakowicz int genimg_has_config (bootm_headers_t *images); 2919a4daad0SMarian Balakowicz ulong genimg_get_image (ulong img_addr); 2929a4daad0SMarian Balakowicz 293d985c849SMarian Balakowicz int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images, 294d985c849SMarian Balakowicz uint8_t arch, ulong *rd_start, ulong *rd_end); 2959a4daad0SMarian Balakowicz 29606a09918SKumar Gala 29706a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT 29806a09918SKumar Gala int boot_get_fdt (int flag, int argc, char *argv[], bootm_headers_t *images, 29906a09918SKumar Gala char **of_flat_tree, ulong *of_size); 30006a09918SKumar Gala int boot_relocate_fdt (struct lmb *lmb, ulong bootmap_base, 30106a09918SKumar Gala char **of_flat_tree, ulong *of_size); 30206a09918SKumar Gala #endif 30306a09918SKumar Gala 3049a4daad0SMarian Balakowicz #if defined(CONFIG_PPC) || defined(CONFIG_M68K) 3059a4daad0SMarian Balakowicz int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len, 3069a4daad0SMarian Balakowicz ulong *initrd_start, ulong *initrd_end); 3079a4daad0SMarian Balakowicz 3089a4daad0SMarian Balakowicz int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end, 3099a4daad0SMarian Balakowicz ulong bootmap_base); 3109a4daad0SMarian Balakowicz int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base); 3119a4daad0SMarian Balakowicz #endif /* CONFIG_PPC || CONFIG_M68K */ 312570abb0aSMarian Balakowicz #endif /* !USE_HOSTCC */ 3139a4daad0SMarian Balakowicz 3149a4daad0SMarian Balakowicz /*******************************************************************/ 3159a4daad0SMarian Balakowicz /* Legacy format specific code (prefixed with image_) */ 3169a4daad0SMarian Balakowicz /*******************************************************************/ 317b97a2a0aSMarian Balakowicz static inline uint32_t image_get_header_size (void) 318b97a2a0aSMarian Balakowicz { 319b97a2a0aSMarian Balakowicz return (sizeof (image_header_t)); 320b97a2a0aSMarian Balakowicz } 321b97a2a0aSMarian Balakowicz 322b97a2a0aSMarian Balakowicz #define image_get_hdr_l(f) \ 323b97a2a0aSMarian Balakowicz static inline uint32_t image_get_##f(image_header_t *hdr) \ 324b97a2a0aSMarian Balakowicz { \ 3259a4daad0SMarian Balakowicz return uimage_to_cpu (hdr->ih_##f); \ 326b97a2a0aSMarian Balakowicz } 327b97a2a0aSMarian Balakowicz image_get_hdr_l (magic); 328b97a2a0aSMarian Balakowicz image_get_hdr_l (hcrc); 329b97a2a0aSMarian Balakowicz image_get_hdr_l (time); 330b97a2a0aSMarian Balakowicz image_get_hdr_l (size); 331b97a2a0aSMarian Balakowicz image_get_hdr_l (load); 332b97a2a0aSMarian Balakowicz image_get_hdr_l (ep); 333b97a2a0aSMarian Balakowicz image_get_hdr_l (dcrc); 334b97a2a0aSMarian Balakowicz 335b97a2a0aSMarian Balakowicz #define image_get_hdr_b(f) \ 336b97a2a0aSMarian Balakowicz static inline uint8_t image_get_##f(image_header_t *hdr) \ 337b97a2a0aSMarian Balakowicz { \ 338b97a2a0aSMarian Balakowicz return hdr->ih_##f; \ 339b97a2a0aSMarian Balakowicz } 340b97a2a0aSMarian Balakowicz image_get_hdr_b (os); 341b97a2a0aSMarian Balakowicz image_get_hdr_b (arch); 342b97a2a0aSMarian Balakowicz image_get_hdr_b (type); 343b97a2a0aSMarian Balakowicz image_get_hdr_b (comp); 344b97a2a0aSMarian Balakowicz 345b97a2a0aSMarian Balakowicz static inline char *image_get_name (image_header_t *hdr) 346b97a2a0aSMarian Balakowicz { 347b97a2a0aSMarian Balakowicz return (char *)hdr->ih_name; 348b97a2a0aSMarian Balakowicz } 349b97a2a0aSMarian Balakowicz 350b97a2a0aSMarian Balakowicz static inline uint32_t image_get_data_size (image_header_t *hdr) 351b97a2a0aSMarian Balakowicz { 352b97a2a0aSMarian Balakowicz return image_get_size (hdr); 353b97a2a0aSMarian Balakowicz } 354f13e7b2eSMarian Balakowicz 355f13e7b2eSMarian Balakowicz /** 356f13e7b2eSMarian Balakowicz * image_get_data - get image payload start address 357f13e7b2eSMarian Balakowicz * @hdr: image header 358f13e7b2eSMarian Balakowicz * 359f13e7b2eSMarian Balakowicz * image_get_data() returns address of the image payload. For single 360f13e7b2eSMarian Balakowicz * component images it is image data start. For multi component 361f13e7b2eSMarian Balakowicz * images it points to the null terminated table of sub-images sizes. 362f13e7b2eSMarian Balakowicz * 363f13e7b2eSMarian Balakowicz * returns: 364f13e7b2eSMarian Balakowicz * image payload data start address 365f13e7b2eSMarian Balakowicz */ 366f13e7b2eSMarian Balakowicz static inline ulong image_get_data (image_header_t *hdr) 367f13e7b2eSMarian Balakowicz { 368f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_header_size ()); 369f13e7b2eSMarian Balakowicz } 370f13e7b2eSMarian Balakowicz 371b97a2a0aSMarian Balakowicz static inline uint32_t image_get_image_size (image_header_t *hdr) 372b97a2a0aSMarian Balakowicz { 373b97a2a0aSMarian Balakowicz return (image_get_size (hdr) + image_get_header_size ()); 374b97a2a0aSMarian Balakowicz } 375f13e7b2eSMarian Balakowicz static inline ulong image_get_image_end (image_header_t *hdr) 376b97a2a0aSMarian Balakowicz { 377f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_image_size (hdr)); 378b97a2a0aSMarian Balakowicz } 379b97a2a0aSMarian Balakowicz 380b97a2a0aSMarian Balakowicz #define image_set_hdr_l(f) \ 381b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 382b97a2a0aSMarian Balakowicz { \ 3839a4daad0SMarian Balakowicz hdr->ih_##f = cpu_to_uimage (val); \ 384b97a2a0aSMarian Balakowicz } 385b97a2a0aSMarian Balakowicz image_set_hdr_l (magic); 386b97a2a0aSMarian Balakowicz image_set_hdr_l (hcrc); 387b97a2a0aSMarian Balakowicz image_set_hdr_l (time); 388b97a2a0aSMarian Balakowicz image_set_hdr_l (size); 389b97a2a0aSMarian Balakowicz image_set_hdr_l (load); 390b97a2a0aSMarian Balakowicz image_set_hdr_l (ep); 391b97a2a0aSMarian Balakowicz image_set_hdr_l (dcrc); 392b97a2a0aSMarian Balakowicz 393b97a2a0aSMarian Balakowicz #define image_set_hdr_b(f) \ 394b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 395b97a2a0aSMarian Balakowicz { \ 396b97a2a0aSMarian Balakowicz hdr->ih_##f = val; \ 397b97a2a0aSMarian Balakowicz } 398b97a2a0aSMarian Balakowicz image_set_hdr_b (os); 399b97a2a0aSMarian Balakowicz image_set_hdr_b (arch); 400b97a2a0aSMarian Balakowicz image_set_hdr_b (type); 401b97a2a0aSMarian Balakowicz image_set_hdr_b (comp); 402b97a2a0aSMarian Balakowicz 403b97a2a0aSMarian Balakowicz static inline void image_set_name (image_header_t *hdr, const char *name) 404b97a2a0aSMarian Balakowicz { 405b97a2a0aSMarian Balakowicz strncpy (image_get_name (hdr), name, IH_NMLEN); 406b97a2a0aSMarian Balakowicz } 407b97a2a0aSMarian Balakowicz 408b97a2a0aSMarian Balakowicz int image_check_hcrc (image_header_t *hdr); 409b97a2a0aSMarian Balakowicz int image_check_dcrc (image_header_t *hdr); 410af13cdbcSMarian Balakowicz #ifndef USE_HOSTCC 411edbed247SBartlomiej Sieka int getenv_yesno (char *var); 412d3f2fa0dSKumar Gala ulong getenv_bootm_low(void); 413391fd93aSBecky Bruce phys_size_t getenv_bootm_size(void); 414af13cdbcSMarian Balakowicz void memmove_wd (void *to, void *from, size_t len, ulong chunksz); 415af13cdbcSMarian Balakowicz #endif 416b97a2a0aSMarian Balakowicz 417b97a2a0aSMarian Balakowicz static inline int image_check_magic (image_header_t *hdr) 418b97a2a0aSMarian Balakowicz { 419b97a2a0aSMarian Balakowicz return (image_get_magic (hdr) == IH_MAGIC); 420b97a2a0aSMarian Balakowicz } 421b97a2a0aSMarian Balakowicz static inline int image_check_type (image_header_t *hdr, uint8_t type) 422b97a2a0aSMarian Balakowicz { 423b97a2a0aSMarian Balakowicz return (image_get_type (hdr) == type); 424b97a2a0aSMarian Balakowicz } 425b97a2a0aSMarian Balakowicz static inline int image_check_arch (image_header_t *hdr, uint8_t arch) 426b97a2a0aSMarian Balakowicz { 427b97a2a0aSMarian Balakowicz return (image_get_arch (hdr) == arch); 428b97a2a0aSMarian Balakowicz } 429b97a2a0aSMarian Balakowicz static inline int image_check_os (image_header_t *hdr, uint8_t os) 430b97a2a0aSMarian Balakowicz { 431b97a2a0aSMarian Balakowicz return (image_get_os (hdr) == os); 432b97a2a0aSMarian Balakowicz } 433b97a2a0aSMarian Balakowicz 43442b73e8eSMarian Balakowicz ulong image_multi_count (image_header_t *hdr); 43542b73e8eSMarian Balakowicz void image_multi_getimg (image_header_t *hdr, ulong idx, 43642b73e8eSMarian Balakowicz ulong *data, ulong *len); 43742b73e8eSMarian Balakowicz 438edbed247SBartlomiej Sieka void image_print_contents (image_header_t *hdr); 439570abb0aSMarian Balakowicz 440b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC 441b97a2a0aSMarian Balakowicz static inline int image_check_target_arch (image_header_t *hdr) 442b97a2a0aSMarian Balakowicz { 443b97a2a0aSMarian Balakowicz #if defined(__ARM__) 444b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_ARM)) 445b97a2a0aSMarian Balakowicz #elif defined(__avr32__) 446b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_AVR32)) 447b97a2a0aSMarian Balakowicz #elif defined(__bfin__) 448b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_BLACKFIN)) 449b97a2a0aSMarian Balakowicz #elif defined(__I386__) 450b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_I386)) 451b97a2a0aSMarian Balakowicz #elif defined(__M68K__) 452b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_M68K)) 453b97a2a0aSMarian Balakowicz #elif defined(__microblaze__) 454b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE)) 455b97a2a0aSMarian Balakowicz #elif defined(__mips__) 456b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_MIPS)) 457b97a2a0aSMarian Balakowicz #elif defined(__nios__) 458b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_NIOS)) 459b97a2a0aSMarian Balakowicz #elif defined(__nios2__) 460b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_NIOS2)) 461b97a2a0aSMarian Balakowicz #elif defined(__PPC__) 462b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_PPC)) 463b97a2a0aSMarian Balakowicz #elif defined(__sh__) 464b97a2a0aSMarian Balakowicz if (!image_check_arch (hdr, IH_ARCH_SH)) 465bf3d8b31SDaniel Hellstrom #elif defined(__sparc__) 466bf3d8b31SDaniel Hellstrom if (!image_check_arch (hdr, IH_ARCH_SPARC)) 467b97a2a0aSMarian Balakowicz #else 468b97a2a0aSMarian Balakowicz # error Unknown CPU type 469b97a2a0aSMarian Balakowicz #endif 470b97a2a0aSMarian Balakowicz return 0; 471b97a2a0aSMarian Balakowicz 472b97a2a0aSMarian Balakowicz return 1; 473b97a2a0aSMarian Balakowicz } 4745dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 4755b1d7137Swdenk 476d5934ad7SMarian Balakowicz /*******************************************************************/ 4779a4daad0SMarian Balakowicz /* New uImage format specific code (prefixed with fit_) */ 478d5934ad7SMarian Balakowicz /*******************************************************************/ 479f50433d6SMarian Balakowicz #if defined(CONFIG_FIT) 4805dfb5213SMarian Balakowicz 4815dfb5213SMarian Balakowicz #define FIT_IMAGES_PATH "/images" 4825dfb5213SMarian Balakowicz #define FIT_CONFS_PATH "/configurations" 4835dfb5213SMarian Balakowicz 4845dfb5213SMarian Balakowicz /* hash node */ 4855dfb5213SMarian Balakowicz #define FIT_HASH_NODENAME "hash" 4865dfb5213SMarian Balakowicz #define FIT_ALGO_PROP "algo" 4875dfb5213SMarian Balakowicz #define FIT_VALUE_PROP "value" 4885dfb5213SMarian Balakowicz 4895dfb5213SMarian Balakowicz /* image node */ 4905dfb5213SMarian Balakowicz #define FIT_DATA_PROP "data" 4915dfb5213SMarian Balakowicz #define FIT_TIMESTAMP_PROP "timestamp" 4925dfb5213SMarian Balakowicz #define FIT_DESC_PROP "description" 4935dfb5213SMarian Balakowicz #define FIT_ARCH_PROP "arch" 4945dfb5213SMarian Balakowicz #define FIT_TYPE_PROP "type" 4955dfb5213SMarian Balakowicz #define FIT_OS_PROP "os" 4965dfb5213SMarian Balakowicz #define FIT_COMP_PROP "compression" 4975dfb5213SMarian Balakowicz #define FIT_ENTRY_PROP "entry" 4985dfb5213SMarian Balakowicz #define FIT_LOAD_PROP "load" 4995dfb5213SMarian Balakowicz 5005dfb5213SMarian Balakowicz /* configuration node */ 5015dfb5213SMarian Balakowicz #define FIT_KERNEL_PROP "kernel" 5025dfb5213SMarian Balakowicz #define FIT_RAMDISK_PROP "ramdisk" 5035dfb5213SMarian Balakowicz #define FIT_FDT_PROP "fdt" 5045dfb5213SMarian Balakowicz #define FIT_DEFAULT_PROP "default" 5055dfb5213SMarian Balakowicz 5065dfb5213SMarian Balakowicz #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */ 5075dfb5213SMarian Balakowicz 5085dfb5213SMarian Balakowicz /* cmdline argument format parsing */ 509f50433d6SMarian Balakowicz inline int fit_parse_conf (const char *spec, ulong addr_curr, 510f50433d6SMarian Balakowicz ulong *addr, const char **conf_name); 511f50433d6SMarian Balakowicz inline int fit_parse_subimage (const char *spec, ulong addr_curr, 512f50433d6SMarian Balakowicz ulong *addr, const char **image_name); 513d5934ad7SMarian Balakowicz 514edbed247SBartlomiej Sieka void fit_print_contents (const void *fit); 5155dfb5213SMarian Balakowicz void fit_image_print (const void *fit, int noffset, const char *p); 5165dfb5213SMarian Balakowicz void fit_image_print_hash (const void *fit, int noffset, const char *p); 5175dfb5213SMarian Balakowicz 5185dfb5213SMarian Balakowicz /** 5195dfb5213SMarian Balakowicz * fit_get_end - get FIT image size 5205dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5215dfb5213SMarian Balakowicz * 5225dfb5213SMarian Balakowicz * returns: 5235dfb5213SMarian Balakowicz * size of the FIT image (blob) in memory 5245dfb5213SMarian Balakowicz */ 5255dfb5213SMarian Balakowicz static inline ulong fit_get_size (const void *fit) 5265dfb5213SMarian Balakowicz { 5275dfb5213SMarian Balakowicz return fdt_totalsize (fit); 5285dfb5213SMarian Balakowicz } 5295dfb5213SMarian Balakowicz 5305dfb5213SMarian Balakowicz /** 5315dfb5213SMarian Balakowicz * fit_get_end - get FIT image end 5325dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5335dfb5213SMarian Balakowicz * 5345dfb5213SMarian Balakowicz * returns: 5355dfb5213SMarian Balakowicz * end address of the FIT image (blob) in memory 5365dfb5213SMarian Balakowicz */ 5375dfb5213SMarian Balakowicz static inline ulong fit_get_end (const void *fit) 5385dfb5213SMarian Balakowicz { 5395dfb5213SMarian Balakowicz return (ulong)fit + fdt_totalsize (fit); 5405dfb5213SMarian Balakowicz } 5415dfb5213SMarian Balakowicz 5425dfb5213SMarian Balakowicz /** 5435dfb5213SMarian Balakowicz * fit_get_name - get FIT node name 5445dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5455dfb5213SMarian Balakowicz * 5465dfb5213SMarian Balakowicz * returns: 5475dfb5213SMarian Balakowicz * NULL, on error 5485dfb5213SMarian Balakowicz * pointer to node name, on success 5495dfb5213SMarian Balakowicz */ 5505dfb5213SMarian Balakowicz static inline const char *fit_get_name (const void *fit_hdr, 5515dfb5213SMarian Balakowicz int noffset, int *len) 5525dfb5213SMarian Balakowicz { 5535dfb5213SMarian Balakowicz return fdt_get_name (fit_hdr, noffset, len); 5545dfb5213SMarian Balakowicz } 5555dfb5213SMarian Balakowicz 5565dfb5213SMarian Balakowicz int fit_get_desc (const void *fit, int noffset, char **desc); 5575dfb5213SMarian Balakowicz int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp); 5585dfb5213SMarian Balakowicz 5595dfb5213SMarian Balakowicz int fit_image_get_node (const void *fit, const char *image_uname); 5605dfb5213SMarian Balakowicz int fit_image_get_os (const void *fit, int noffset, uint8_t *os); 5615dfb5213SMarian Balakowicz int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch); 5625dfb5213SMarian Balakowicz int fit_image_get_type (const void *fit, int noffset, uint8_t *type); 5635dfb5213SMarian Balakowicz int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp); 5645dfb5213SMarian Balakowicz int fit_image_get_load (const void *fit, int noffset, ulong *load); 5655dfb5213SMarian Balakowicz int fit_image_get_entry (const void *fit, int noffset, ulong *entry); 5665dfb5213SMarian Balakowicz int fit_image_get_data (const void *fit, int noffset, 5675dfb5213SMarian Balakowicz const void **data, size_t *size); 5685dfb5213SMarian Balakowicz 5695dfb5213SMarian Balakowicz int fit_image_hash_get_algo (const void *fit, int noffset, char **algo); 5705dfb5213SMarian Balakowicz int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value, 5715dfb5213SMarian Balakowicz int *value_len); 5725dfb5213SMarian Balakowicz 5735dfb5213SMarian Balakowicz int fit_set_timestamp (void *fit, int noffset, time_t timestamp); 5745dfb5213SMarian Balakowicz int fit_set_hashes (void *fit); 5755dfb5213SMarian Balakowicz int fit_image_set_hashes (void *fit, int image_noffset); 5765dfb5213SMarian Balakowicz int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value, 5775dfb5213SMarian Balakowicz int value_len); 5785dfb5213SMarian Balakowicz 5795dfb5213SMarian Balakowicz int fit_image_check_hashes (const void *fit, int noffset); 580919f550dSBartlomiej Sieka int fit_all_image_check_hashes (const void *fit); 5815dfb5213SMarian Balakowicz int fit_image_check_os (const void *fit, int noffset, uint8_t os); 5825dfb5213SMarian Balakowicz int fit_image_check_arch (const void *fit, int noffset, uint8_t arch); 5835dfb5213SMarian Balakowicz int fit_image_check_type (const void *fit, int noffset, uint8_t type); 5845dfb5213SMarian Balakowicz int fit_image_check_comp (const void *fit, int noffset, uint8_t comp); 5855dfb5213SMarian Balakowicz int fit_check_format (const void *fit); 5865dfb5213SMarian Balakowicz 5875dfb5213SMarian Balakowicz int fit_conf_get_node (const void *fit, const char *conf_uname); 5885dfb5213SMarian Balakowicz int fit_conf_get_kernel_node (const void *fit, int noffset); 5895dfb5213SMarian Balakowicz int fit_conf_get_ramdisk_node (const void *fit, int noffset); 5905dfb5213SMarian Balakowicz int fit_conf_get_fdt_node (const void *fit, int noffset); 5915dfb5213SMarian Balakowicz 5925dfb5213SMarian Balakowicz void fit_conf_print (const void *fit, int noffset, const char *p); 5935dfb5213SMarian Balakowicz 5945dfb5213SMarian Balakowicz #ifndef USE_HOSTCC 5955dfb5213SMarian Balakowicz static inline int fit_image_check_target_arch (const void *fdt, int node) 5965dfb5213SMarian Balakowicz { 5975dfb5213SMarian Balakowicz #if defined(__ARM__) 5985dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM)) 5995dfb5213SMarian Balakowicz #elif defined(__avr32__) 6005dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32)) 6015dfb5213SMarian Balakowicz #elif defined(__bfin__) 6025dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN)) 6035dfb5213SMarian Balakowicz #elif defined(__I386__) 6045dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_I386)) 6055dfb5213SMarian Balakowicz #elif defined(__M68K__) 6065dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K)) 6075dfb5213SMarian Balakowicz #elif defined(__microblaze__) 6085dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE)) 6095dfb5213SMarian Balakowicz #elif defined(__mips__) 6105dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS)) 6115dfb5213SMarian Balakowicz #elif defined(__nios__) 6125dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS)) 6135dfb5213SMarian Balakowicz #elif defined(__nios2__) 6145dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2)) 6155dfb5213SMarian Balakowicz #elif defined(__PPC__) 6165dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC)) 6175dfb5213SMarian Balakowicz #elif defined(__sh__) 6185dfb5213SMarian Balakowicz if (!fit_image_check_arch (fdt, node, IH_ARCH_SH)) 619bf3d8b31SDaniel Hellstrom #elif defined(__sparc__) 620bf3d8b31SDaniel Hellstrom if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC)) 6215dfb5213SMarian Balakowicz #else 6225dfb5213SMarian Balakowicz # error Unknown CPU type 6235dfb5213SMarian Balakowicz #endif 6245dfb5213SMarian Balakowicz return 0; 6255dfb5213SMarian Balakowicz 6265dfb5213SMarian Balakowicz return 1; 6275dfb5213SMarian Balakowicz } 6285dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 6295dfb5213SMarian Balakowicz 630d5934ad7SMarian Balakowicz #ifdef CONFIG_FIT_VERBOSE 631d5934ad7SMarian Balakowicz #define fit_unsupported(msg) printf ("! %s:%d " \ 632d5934ad7SMarian Balakowicz "FIT images not supported for '%s'\n", \ 633d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 634d5934ad7SMarian Balakowicz 635d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) printf ("! %s:%d " \ 636d5934ad7SMarian Balakowicz "FIT images not supported for '%s' " \ 637d5934ad7SMarian Balakowicz "- must reset board to recover!\n", \ 638d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 639d5934ad7SMarian Balakowicz #else 640d5934ad7SMarian Balakowicz #define fit_unsupported(msg) 641d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) 642d5934ad7SMarian Balakowicz #endif /* CONFIG_FIT_VERBOSE */ 643f50433d6SMarian Balakowicz #endif /* CONFIG_FIT */ 6445ad03eb3SMarian Balakowicz 6455b1d7137Swdenk #endif /* __IMAGE_H__ */ 646