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 3637566090SMike Frysinger #include "compiler.h" 372f220500SKim Phillips #include <asm/byteorder.h> 3837566090SMike Frysinger 3937566090SMike Frysinger #ifdef USE_HOSTCC 409d25438fSBartlomiej Sieka 419d25438fSBartlomiej Sieka /* new uImage format support enabled on host */ 429d25438fSBartlomiej Sieka #define CONFIG_FIT 1 439d25438fSBartlomiej Sieka #define CONFIG_OF_LIBFDT 1 449d25438fSBartlomiej Sieka #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 459d25438fSBartlomiej Sieka 46def0819eSWolfgang Denk #else 47def0819eSWolfgang Denk 48def0819eSWolfgang Denk #include <lmb.h> 49def0819eSWolfgang Denk #include <asm/u-boot.h> 505daa1c18SMike Frysinger #include <command.h> 51def0819eSWolfgang Denk 529d25438fSBartlomiej Sieka #endif /* USE_HOSTCC */ 53d5934ad7SMarian Balakowicz 545dfb5213SMarian Balakowicz #if defined(CONFIG_FIT) 555dfb5213SMarian Balakowicz #include <fdt.h> 565dfb5213SMarian Balakowicz #include <libfdt.h> 575dfb5213SMarian Balakowicz #include <fdt_support.h> 58766529fcSBartlomiej Sieka #define CONFIG_MD5 /* FIT images need MD5 support */ 59dac4d7e8SMike Frysinger #define CONFIG_SHA1 /* and SHA1 */ 605dfb5213SMarian Balakowicz #endif 61b97a2a0aSMarian Balakowicz 625b1d7137Swdenk /* 635b1d7137Swdenk * Operating System Codes 645b1d7137Swdenk */ 655b1d7137Swdenk #define IH_OS_INVALID 0 /* Invalid OS */ 665b1d7137Swdenk #define IH_OS_OPENBSD 1 /* OpenBSD */ 675b1d7137Swdenk #define IH_OS_NETBSD 2 /* NetBSD */ 685b1d7137Swdenk #define IH_OS_FREEBSD 3 /* FreeBSD */ 695b1d7137Swdenk #define IH_OS_4_4BSD 4 /* 4.4BSD */ 705b1d7137Swdenk #define IH_OS_LINUX 5 /* Linux */ 715b1d7137Swdenk #define IH_OS_SVR4 6 /* SVR4 */ 725b1d7137Swdenk #define IH_OS_ESIX 7 /* Esix */ 735b1d7137Swdenk #define IH_OS_SOLARIS 8 /* Solaris */ 745b1d7137Swdenk #define IH_OS_IRIX 9 /* Irix */ 755b1d7137Swdenk #define IH_OS_SCO 10 /* SCO */ 765b1d7137Swdenk #define IH_OS_DELL 11 /* Dell */ 775b1d7137Swdenk #define IH_OS_NCR 12 /* NCR */ 785b1d7137Swdenk #define IH_OS_LYNXOS 13 /* LynxOS */ 795b1d7137Swdenk #define IH_OS_VXWORKS 14 /* VxWorks */ 805b1d7137Swdenk #define IH_OS_PSOS 15 /* pSOS */ 815b1d7137Swdenk #define IH_OS_QNX 16 /* QNX */ 825b1d7137Swdenk #define IH_OS_U_BOOT 17 /* Firmware */ 83d791b1dcSwdenk #define IH_OS_RTEMS 18 /* RTEMS */ 847f70e853Swdenk #define IH_OS_ARTOS 19 /* ARTOS */ 8527b207fdSwdenk #define IH_OS_UNITY 20 /* Unity OS */ 86f5ed9e39SPeter Tyser #define IH_OS_INTEGRITY 21 /* INTEGRITY */ 873df61957STorkel Lundgren #define IH_OS_OSE 22 /* OSE */ 885b1d7137Swdenk 895b1d7137Swdenk /* 905b1d7137Swdenk * CPU Architecture Codes (supported by Linux) 915b1d7137Swdenk */ 92b97a2a0aSMarian Balakowicz #define IH_ARCH_INVALID 0 /* Invalid CPU */ 93b97a2a0aSMarian Balakowicz #define IH_ARCH_ALPHA 1 /* Alpha */ 94b97a2a0aSMarian Balakowicz #define IH_ARCH_ARM 2 /* ARM */ 95b97a2a0aSMarian Balakowicz #define IH_ARCH_I386 3 /* Intel x86 */ 96b97a2a0aSMarian Balakowicz #define IH_ARCH_IA64 4 /* IA64 */ 97b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS 5 /* MIPS */ 98b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */ 99b97a2a0aSMarian Balakowicz #define IH_ARCH_PPC 7 /* PowerPC */ 100b97a2a0aSMarian Balakowicz #define IH_ARCH_S390 8 /* IBM S390 */ 101b97a2a0aSMarian Balakowicz #define IH_ARCH_SH 9 /* SuperH */ 102b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC 10 /* Sparc */ 103b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */ 104b97a2a0aSMarian Balakowicz #define IH_ARCH_M68K 12 /* M68K */ 105b97a2a0aSMarian Balakowicz #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */ 106b97a2a0aSMarian Balakowicz #define IH_ARCH_NIOS2 15 /* Nios-II */ 107b97a2a0aSMarian Balakowicz #define IH_ARCH_BLACKFIN 16 /* Blackfin */ 108b97a2a0aSMarian Balakowicz #define IH_ARCH_AVR32 17 /* AVR32 */ 109b97a2a0aSMarian Balakowicz #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */ 11065bf1d39SSimon Glass #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */ 111f52138aeSStefan Kristiansson #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */ 1123ddcaccdSStefan Kristiansson #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */ 1135b1d7137Swdenk 1145b1d7137Swdenk /* 1155b1d7137Swdenk * Image Types 1165b1d7137Swdenk * 1175b1d7137Swdenk * "Standalone Programs" are directly runnable in the environment 1185b1d7137Swdenk * provided by U-Boot; it is expected that (if they behave 1195b1d7137Swdenk * well) you can continue to work in U-Boot after return from 1205b1d7137Swdenk * the Standalone Program. 1215b1d7137Swdenk * "OS Kernel Images" are usually images of some Embedded OS which 1225b1d7137Swdenk * will take over control completely. Usually these programs 1235b1d7137Swdenk * will install their own set of exception handlers, device 1245b1d7137Swdenk * drivers, set up the MMU, etc. - this means, that you cannot 1255b1d7137Swdenk * expect to re-enter U-Boot except by resetting the CPU. 1265b1d7137Swdenk * "RAMDisk Images" are more or less just data blocks, and their 1275b1d7137Swdenk * parameters (address, size) are passed to an OS kernel that is 1285b1d7137Swdenk * being started. 1295b1d7137Swdenk * "Multi-File Images" contain several images, typically an OS 1305b1d7137Swdenk * (Linux) kernel image and one or more data images like 1315b1d7137Swdenk * RAMDisks. This construct is useful for instance when you want 1325b1d7137Swdenk * to boot over the network using BOOTP etc., where the boot 1335b1d7137Swdenk * server provides just a single image file, but you want to get 1345b1d7137Swdenk * for instance an OS kernel and a RAMDisk image. 1355b1d7137Swdenk * 1365b1d7137Swdenk * "Multi-File Images" start with a list of image sizes, each 1375b1d7137Swdenk * image size (in bytes) specified by an "uint32_t" in network 1385b1d7137Swdenk * byte order. This list is terminated by an "(uint32_t)0". 1395b1d7137Swdenk * Immediately after the terminating 0 follow the images, one by 1405b1d7137Swdenk * one, all aligned on "uint32_t" boundaries (size rounded up to 141e1599e83Swdenk * a multiple of 4 bytes - except for the last file). 1425b1d7137Swdenk * 1435b1d7137Swdenk * "Firmware Images" are binary images containing firmware (like 1445b1d7137Swdenk * U-Boot or FPGA images) which usually will be programmed to 1455b1d7137Swdenk * flash memory. 1465b1d7137Swdenk * 1475b1d7137Swdenk * "Script files" are command sequences that will be executed by 1485b1d7137Swdenk * U-Boot's command interpreter; this feature is especially 1495b1d7137Swdenk * useful when you configure U-Boot to use a real shell (hush) 15027b207fdSwdenk * as command interpreter (=> Shell Scripts). 1515b1d7137Swdenk */ 1525b1d7137Swdenk 1535b1d7137Swdenk #define IH_TYPE_INVALID 0 /* Invalid Image */ 1545b1d7137Swdenk #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 1555b1d7137Swdenk #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 1565b1d7137Swdenk #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 1575b1d7137Swdenk #define IH_TYPE_MULTI 4 /* Multi-File Image */ 1585b1d7137Swdenk #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 1595b1d7137Swdenk #define IH_TYPE_SCRIPT 6 /* Script file */ 160fbe4b5cbSwdenk #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ 16125c751e9SMatthew McClintock #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ 162aa0c7a86SPrafulla Wadaskar #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */ 1638edcde5eSStefano Babic #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */ 1647816f2cfSHeiko Schocher #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */ 1653decb14aSJohn Rigby #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */ 1664962e38eSStefano Babic #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */ 167b9b50e89SStephen Warren #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */ 1685d898a00SShaohui Xie #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */ 1695b1d7137Swdenk 1705b1d7137Swdenk /* 1715b1d7137Swdenk * Compression Types 1725b1d7137Swdenk */ 1735b1d7137Swdenk #define IH_COMP_NONE 0 /* No Compression Used */ 1745b1d7137Swdenk #define IH_COMP_GZIP 1 /* gzip Compression Used */ 1755b1d7137Swdenk #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ 176fc9c1727SLuigi 'Comio' Mantellini #define IH_COMP_LZMA 3 /* lzma Compression Used */ 17720dde48bSPeter Korsgaard #define IH_COMP_LZO 4 /* lzo Compression Used */ 1785b1d7137Swdenk 1795b1d7137Swdenk #define IH_MAGIC 0x27051956 /* Image Magic Number */ 1805b1d7137Swdenk #define IH_NMLEN 32 /* Image Name Length */ 1815b1d7137Swdenk 1825b1d7137Swdenk /* 1839a4daad0SMarian Balakowicz * Legacy format image header, 1849a4daad0SMarian Balakowicz * all data in network byte order (aka natural aka bigendian). 1855b1d7137Swdenk */ 1865b1d7137Swdenk typedef struct image_header { 1872f220500SKim Phillips __be32 ih_magic; /* Image Header Magic Number */ 1882f220500SKim Phillips __be32 ih_hcrc; /* Image Header CRC Checksum */ 1892f220500SKim Phillips __be32 ih_time; /* Image Creation Timestamp */ 1902f220500SKim Phillips __be32 ih_size; /* Image Data Size */ 1912f220500SKim Phillips __be32 ih_load; /* Data Load Address */ 1922f220500SKim Phillips __be32 ih_ep; /* Entry Point Address */ 1932f220500SKim Phillips __be32 ih_dcrc; /* Image Data CRC Checksum */ 1945b1d7137Swdenk uint8_t ih_os; /* Operating System */ 1955b1d7137Swdenk uint8_t ih_arch; /* CPU architecture */ 1965b1d7137Swdenk uint8_t ih_type; /* Image Type */ 1975b1d7137Swdenk uint8_t ih_comp; /* Compression Type */ 1985b1d7137Swdenk uint8_t ih_name[IH_NMLEN]; /* Image Name */ 1995b1d7137Swdenk } image_header_t; 2005b1d7137Swdenk 201396f635bSKumar Gala typedef struct image_info { 202396f635bSKumar Gala ulong start, end; /* start/end of blob */ 203396f635bSKumar Gala ulong image_start, image_len; /* start of image within blob, len of image */ 204396f635bSKumar Gala ulong load; /* load addr for the image */ 205396f635bSKumar Gala uint8_t comp, type, os; /* compression, type of image, os type */ 206396f635bSKumar Gala } image_info_t; 207396f635bSKumar Gala 208559316faSMarian Balakowicz /* 209d5934ad7SMarian Balakowicz * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() 210d5934ad7SMarian Balakowicz * routines. 211d5934ad7SMarian Balakowicz */ 212d5934ad7SMarian Balakowicz typedef struct bootm_headers { 213d5934ad7SMarian Balakowicz /* 214d5934ad7SMarian Balakowicz * Legacy os image header, if it is a multi component image 2159a4daad0SMarian Balakowicz * then boot_get_ramdisk() and get_fdt() will attempt to get 216d5934ad7SMarian Balakowicz * data from second and third component accordingly. 217d5934ad7SMarian Balakowicz */ 218cb1c4896SMarian Balakowicz image_header_t *legacy_hdr_os; /* image header pointer */ 219cb1c4896SMarian Balakowicz image_header_t legacy_hdr_os_copy; /* header copy */ 220d5934ad7SMarian Balakowicz ulong legacy_hdr_valid; 221d5934ad7SMarian Balakowicz 222d5934ad7SMarian Balakowicz #if defined(CONFIG_FIT) 223f773bea8SMarian Balakowicz const char *fit_uname_cfg; /* configuration node unit name */ 224f773bea8SMarian Balakowicz 225d5934ad7SMarian Balakowicz void *fit_hdr_os; /* os FIT image header */ 226eb6175edSMarian Balakowicz const char *fit_uname_os; /* os subimage node unit name */ 2273dfe1101SMarian Balakowicz int fit_noffset_os; /* os subimage node offset */ 228d5934ad7SMarian Balakowicz 229d5934ad7SMarian Balakowicz void *fit_hdr_rd; /* init ramdisk FIT image header */ 2303dfe1101SMarian Balakowicz const char *fit_uname_rd; /* init ramdisk subimage node unit name */ 2313dfe1101SMarian Balakowicz int fit_noffset_rd; /* init ramdisk subimage node offset */ 232d5934ad7SMarian Balakowicz 233d5934ad7SMarian Balakowicz void *fit_hdr_fdt; /* FDT blob FIT image header */ 2343dfe1101SMarian Balakowicz const char *fit_uname_fdt; /* FDT blob subimage node unit name */ 2353dfe1101SMarian Balakowicz int fit_noffset_fdt;/* FDT blob subimage node offset */ 236d5934ad7SMarian Balakowicz #endif 2371ec73761SMarian Balakowicz 23849c3a861SKumar Gala #ifndef USE_HOSTCC 239396f635bSKumar Gala image_info_t os; /* os image info */ 240c160a954SKumar Gala ulong ep; /* entry point of OS */ 241c160a954SKumar Gala 242c4f9419cSKumar Gala ulong rd_start, rd_end;/* ramdisk start/end */ 243c4f9419cSKumar Gala 24406a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT 24506a09918SKumar Gala char *ft_addr; /* flat dev tree address */ 24606a09918SKumar Gala #endif 24706a09918SKumar Gala ulong ft_len; /* length of flat device tree */ 24806a09918SKumar Gala 24949c3a861SKumar Gala ulong initrd_start; 25049c3a861SKumar Gala ulong initrd_end; 25149c3a861SKumar Gala ulong cmdline_start; 25249c3a861SKumar Gala ulong cmdline_end; 25349c3a861SKumar Gala bd_t *kbd; 25449c3a861SKumar Gala #endif 25549c3a861SKumar Gala 2568a5ea3e6SMarian Balakowicz int verify; /* getenv("verify")[0] != 'n' */ 25749c3a861SKumar Gala 25849c3a861SKumar Gala #define BOOTM_STATE_START (0x00000001) 25949c3a861SKumar Gala #define BOOTM_STATE_LOADOS (0x00000002) 26049c3a861SKumar Gala #define BOOTM_STATE_RAMDISK (0x00000004) 26149c3a861SKumar Gala #define BOOTM_STATE_FDT (0x00000008) 26249c3a861SKumar Gala #define BOOTM_STATE_OS_CMDLINE (0x00000010) 26349c3a861SKumar Gala #define BOOTM_STATE_OS_BD_T (0x00000020) 26449c3a861SKumar Gala #define BOOTM_STATE_OS_PREP (0x00000040) 26549c3a861SKumar Gala #define BOOTM_STATE_OS_GO (0x00000080) 26649c3a861SKumar Gala int state; 26749c3a861SKumar Gala 268a16028daSMike Frysinger #ifdef CONFIG_LMB 269e906cfaeSKumar Gala struct lmb lmb; /* for memory mgmt */ 270e906cfaeSKumar Gala #endif 271d5934ad7SMarian Balakowicz } bootm_headers_t; 272d5934ad7SMarian Balakowicz 2731648a375SSimon Schwarz extern bootm_headers_t images; 2741648a375SSimon Schwarz 275d5934ad7SMarian Balakowicz /* 276559316faSMarian Balakowicz * Some systems (for example LWMON) have very short watchdog periods; 277559316faSMarian Balakowicz * we must make sure to split long operations like memmove() or 2787590378fSBartlomiej Sieka * checksum calculations into reasonable chunks. 279559316faSMarian Balakowicz */ 2807590378fSBartlomiej Sieka #ifndef CHUNKSZ 281559316faSMarian Balakowicz #define CHUNKSZ (64 * 1024) 2827590378fSBartlomiej Sieka #endif 2837590378fSBartlomiej Sieka 2847590378fSBartlomiej Sieka #ifndef CHUNKSZ_CRC32 2857590378fSBartlomiej Sieka #define CHUNKSZ_CRC32 (64 * 1024) 2867590378fSBartlomiej Sieka #endif 2877590378fSBartlomiej Sieka 2887590378fSBartlomiej Sieka #ifndef CHUNKSZ_MD5 2897590378fSBartlomiej Sieka #define CHUNKSZ_MD5 (64 * 1024) 2907590378fSBartlomiej Sieka #endif 2917590378fSBartlomiej Sieka 2927590378fSBartlomiej Sieka #ifndef CHUNKSZ_SHA1 2937590378fSBartlomiej Sieka #define CHUNKSZ_SHA1 (64 * 1024) 2947590378fSBartlomiej Sieka #endif 295559316faSMarian Balakowicz 29637566090SMike Frysinger #define uimage_to_cpu(x) be32_to_cpu(x) 29737566090SMike Frysinger #define cpu_to_uimage(x) cpu_to_be32(x) 298b97a2a0aSMarian Balakowicz 299b029dddcSPrafulla Wadaskar /* 300b029dddcSPrafulla Wadaskar * Translation table for entries of a specific type; used by 301b029dddcSPrafulla Wadaskar * get_table_entry_id() and get_table_entry_name(). 302b029dddcSPrafulla Wadaskar */ 303b029dddcSPrafulla Wadaskar typedef struct table_entry { 304b029dddcSPrafulla Wadaskar int id; 305b029dddcSPrafulla Wadaskar char *sname; /* short (input) name to find table entry */ 306b029dddcSPrafulla Wadaskar char *lname; /* long (output) name to print for messages */ 307b029dddcSPrafulla Wadaskar } table_entry_t; 308b029dddcSPrafulla Wadaskar 309b029dddcSPrafulla Wadaskar /* 310b029dddcSPrafulla Wadaskar * get_table_entry_id() scans the translation table trying to find an 311b029dddcSPrafulla Wadaskar * entry that matches the given short name. If a matching entry is 312b029dddcSPrafulla Wadaskar * found, it's id is returned to the caller. 313b029dddcSPrafulla Wadaskar */ 3147edb186fSMike Frysinger int get_table_entry_id(const table_entry_t *table, 315b029dddcSPrafulla Wadaskar const char *table_name, const char *name); 316b029dddcSPrafulla Wadaskar /* 317b029dddcSPrafulla Wadaskar * get_table_entry_name() scans the translation table trying to find 318b029dddcSPrafulla Wadaskar * an entry that matches the given id. If a matching entry is found, 319b029dddcSPrafulla Wadaskar * its long name is returned to the caller. 320b029dddcSPrafulla Wadaskar */ 3217edb186fSMike Frysinger char *get_table_entry_name(const table_entry_t *table, char *msg, int id); 322b029dddcSPrafulla Wadaskar 323570abb0aSMarian Balakowicz const char *genimg_get_os_name(uint8_t os); 324570abb0aSMarian Balakowicz const char *genimg_get_arch_name(uint8_t arch); 325570abb0aSMarian Balakowicz const char *genimg_get_type_name(uint8_t type); 326570abb0aSMarian Balakowicz const char *genimg_get_comp_name(uint8_t comp); 327570abb0aSMarian Balakowicz int genimg_get_os_id(const char *name); 328570abb0aSMarian Balakowicz int genimg_get_arch_id(const char *name); 329570abb0aSMarian Balakowicz int genimg_get_type_id(const char *name); 330570abb0aSMarian Balakowicz int genimg_get_comp_id(const char *name); 331f666dea8SPrafulla Wadaskar void genimg_print_size(uint32_t size); 332570abb0aSMarian Balakowicz 3339a4daad0SMarian Balakowicz #ifndef USE_HOSTCC 3349a4daad0SMarian Balakowicz /* Image format types, returned by _get_format() routine */ 3359a4daad0SMarian Balakowicz #define IMAGE_FORMAT_INVALID 0x00 3369a4daad0SMarian Balakowicz #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 3379a4daad0SMarian Balakowicz #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 3389a4daad0SMarian Balakowicz 3399a4daad0SMarian Balakowicz int genimg_get_format(void *img_addr); 340f773bea8SMarian Balakowicz int genimg_has_config(bootm_headers_t *images); 3419a4daad0SMarian Balakowicz ulong genimg_get_image(ulong img_addr); 3429a4daad0SMarian Balakowicz 34354841ab5SWolfgang Denk int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, 344d985c849SMarian Balakowicz uint8_t arch, ulong *rd_start, ulong *rd_end); 3459a4daad0SMarian Balakowicz 34606a09918SKumar Gala 34706a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT 348712fbcf3SStephen Warren int boot_get_fdt(int flag, int argc, char * const argv[], 349712fbcf3SStephen Warren bootm_headers_t *images, char **of_flat_tree, ulong *of_size); 35055b0a393SGrant Likely void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob); 351590d3cacSGrant Likely int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size); 35206a09918SKumar Gala #endif 35306a09918SKumar Gala 354fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH 3559a4daad0SMarian Balakowicz int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len, 3569a4daad0SMarian Balakowicz ulong *initrd_start, ulong *initrd_end); 357fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */ 358fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_GET_CMDLINE 359590d3cacSGrant Likely int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); 360fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */ 361fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_GET_KBD 362590d3cacSGrant Likely int boot_get_kbd(struct lmb *lmb, bd_t **kbd); 363fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_GET_KBD */ 364570abb0aSMarian Balakowicz #endif /* !USE_HOSTCC */ 3659a4daad0SMarian Balakowicz 3669a4daad0SMarian Balakowicz /*******************************************************************/ 3679a4daad0SMarian Balakowicz /* Legacy format specific code (prefixed with image_) */ 3689a4daad0SMarian Balakowicz /*******************************************************************/ 369b97a2a0aSMarian Balakowicz static inline uint32_t image_get_header_size(void) 370b97a2a0aSMarian Balakowicz { 371b97a2a0aSMarian Balakowicz return (sizeof(image_header_t)); 372b97a2a0aSMarian Balakowicz } 373b97a2a0aSMarian Balakowicz 374b97a2a0aSMarian Balakowicz #define image_get_hdr_l(f) \ 3753a2003f6SWolfgang Denk static inline uint32_t image_get_##f(const image_header_t *hdr) \ 376b97a2a0aSMarian Balakowicz { \ 3779a4daad0SMarian Balakowicz return uimage_to_cpu(hdr->ih_##f); \ 378b97a2a0aSMarian Balakowicz } 379178e26d7SWolfgang Denk image_get_hdr_l(magic) /* image_get_magic */ 380178e26d7SWolfgang Denk image_get_hdr_l(hcrc) /* image_get_hcrc */ 381178e26d7SWolfgang Denk image_get_hdr_l(time) /* image_get_time */ 382178e26d7SWolfgang Denk image_get_hdr_l(size) /* image_get_size */ 383178e26d7SWolfgang Denk image_get_hdr_l(load) /* image_get_load */ 384178e26d7SWolfgang Denk image_get_hdr_l(ep) /* image_get_ep */ 385178e26d7SWolfgang Denk image_get_hdr_l(dcrc) /* image_get_dcrc */ 386b97a2a0aSMarian Balakowicz 387b97a2a0aSMarian Balakowicz #define image_get_hdr_b(f) \ 3883a2003f6SWolfgang Denk static inline uint8_t image_get_##f(const image_header_t *hdr) \ 389b97a2a0aSMarian Balakowicz { \ 390b97a2a0aSMarian Balakowicz return hdr->ih_##f; \ 391b97a2a0aSMarian Balakowicz } 392178e26d7SWolfgang Denk image_get_hdr_b(os) /* image_get_os */ 393178e26d7SWolfgang Denk image_get_hdr_b(arch) /* image_get_arch */ 394178e26d7SWolfgang Denk image_get_hdr_b(type) /* image_get_type */ 395178e26d7SWolfgang Denk image_get_hdr_b(comp) /* image_get_comp */ 396b97a2a0aSMarian Balakowicz 3973a2003f6SWolfgang Denk static inline char *image_get_name(const image_header_t *hdr) 398b97a2a0aSMarian Balakowicz { 399b97a2a0aSMarian Balakowicz return (char *)hdr->ih_name; 400b97a2a0aSMarian Balakowicz } 401b97a2a0aSMarian Balakowicz 4023a2003f6SWolfgang Denk static inline uint32_t image_get_data_size(const image_header_t *hdr) 403b97a2a0aSMarian Balakowicz { 404b97a2a0aSMarian Balakowicz return image_get_size(hdr); 405b97a2a0aSMarian Balakowicz } 406f13e7b2eSMarian Balakowicz 407f13e7b2eSMarian Balakowicz /** 408f13e7b2eSMarian Balakowicz * image_get_data - get image payload start address 409f13e7b2eSMarian Balakowicz * @hdr: image header 410f13e7b2eSMarian Balakowicz * 411f13e7b2eSMarian Balakowicz * image_get_data() returns address of the image payload. For single 412f13e7b2eSMarian Balakowicz * component images it is image data start. For multi component 413f13e7b2eSMarian Balakowicz * images it points to the null terminated table of sub-images sizes. 414f13e7b2eSMarian Balakowicz * 415f13e7b2eSMarian Balakowicz * returns: 416f13e7b2eSMarian Balakowicz * image payload data start address 417f13e7b2eSMarian Balakowicz */ 4183a2003f6SWolfgang Denk static inline ulong image_get_data(const image_header_t *hdr) 419f13e7b2eSMarian Balakowicz { 420f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_header_size()); 421f13e7b2eSMarian Balakowicz } 422f13e7b2eSMarian Balakowicz 4233a2003f6SWolfgang Denk static inline uint32_t image_get_image_size(const image_header_t *hdr) 424b97a2a0aSMarian Balakowicz { 425b97a2a0aSMarian Balakowicz return (image_get_size(hdr) + image_get_header_size()); 426b97a2a0aSMarian Balakowicz } 4273a2003f6SWolfgang Denk static inline ulong image_get_image_end(const image_header_t *hdr) 428b97a2a0aSMarian Balakowicz { 429f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_image_size(hdr)); 430b97a2a0aSMarian Balakowicz } 431b97a2a0aSMarian Balakowicz 432b97a2a0aSMarian Balakowicz #define image_set_hdr_l(f) \ 433b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 434b97a2a0aSMarian Balakowicz { \ 4359a4daad0SMarian Balakowicz hdr->ih_##f = cpu_to_uimage(val); \ 436b97a2a0aSMarian Balakowicz } 437178e26d7SWolfgang Denk image_set_hdr_l(magic) /* image_set_magic */ 438178e26d7SWolfgang Denk image_set_hdr_l(hcrc) /* image_set_hcrc */ 439178e26d7SWolfgang Denk image_set_hdr_l(time) /* image_set_time */ 440178e26d7SWolfgang Denk image_set_hdr_l(size) /* image_set_size */ 441178e26d7SWolfgang Denk image_set_hdr_l(load) /* image_set_load */ 442178e26d7SWolfgang Denk image_set_hdr_l(ep) /* image_set_ep */ 443178e26d7SWolfgang Denk image_set_hdr_l(dcrc) /* image_set_dcrc */ 444b97a2a0aSMarian Balakowicz 445b97a2a0aSMarian Balakowicz #define image_set_hdr_b(f) \ 446b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 447b97a2a0aSMarian Balakowicz { \ 448b97a2a0aSMarian Balakowicz hdr->ih_##f = val; \ 449b97a2a0aSMarian Balakowicz } 450178e26d7SWolfgang Denk image_set_hdr_b(os) /* image_set_os */ 451178e26d7SWolfgang Denk image_set_hdr_b(arch) /* image_set_arch */ 452178e26d7SWolfgang Denk image_set_hdr_b(type) /* image_set_type */ 453178e26d7SWolfgang Denk image_set_hdr_b(comp) /* image_set_comp */ 454b97a2a0aSMarian Balakowicz 455b97a2a0aSMarian Balakowicz static inline void image_set_name(image_header_t *hdr, const char *name) 456b97a2a0aSMarian Balakowicz { 457b97a2a0aSMarian Balakowicz strncpy(image_get_name(hdr), name, IH_NMLEN); 458b97a2a0aSMarian Balakowicz } 459b97a2a0aSMarian Balakowicz 4603a2003f6SWolfgang Denk int image_check_hcrc(const image_header_t *hdr); 4613a2003f6SWolfgang Denk int image_check_dcrc(const image_header_t *hdr); 462af13cdbcSMarian Balakowicz #ifndef USE_HOSTCC 463edbed247SBartlomiej Sieka int getenv_yesno(char *var); 464d3f2fa0dSKumar Gala ulong getenv_bootm_low(void); 465391fd93aSBecky Bruce phys_size_t getenv_bootm_size(void); 466c3624e6eSGrant Likely phys_size_t getenv_bootm_mapsize(void); 467af13cdbcSMarian Balakowicz void memmove_wd(void *to, void *from, size_t len, ulong chunksz); 468af13cdbcSMarian Balakowicz #endif 469b97a2a0aSMarian Balakowicz 4703a2003f6SWolfgang Denk static inline int image_check_magic(const image_header_t *hdr) 471b97a2a0aSMarian Balakowicz { 472b97a2a0aSMarian Balakowicz return (image_get_magic(hdr) == IH_MAGIC); 473b97a2a0aSMarian Balakowicz } 4743a2003f6SWolfgang Denk static inline int image_check_type(const image_header_t *hdr, uint8_t type) 475b97a2a0aSMarian Balakowicz { 476b97a2a0aSMarian Balakowicz return (image_get_type(hdr) == type); 477b97a2a0aSMarian Balakowicz } 4783a2003f6SWolfgang Denk static inline int image_check_arch(const image_header_t *hdr, uint8_t arch) 479b97a2a0aSMarian Balakowicz { 480b97a2a0aSMarian Balakowicz return (image_get_arch(hdr) == arch); 481b97a2a0aSMarian Balakowicz } 4823a2003f6SWolfgang Denk static inline int image_check_os(const image_header_t *hdr, uint8_t os) 483b97a2a0aSMarian Balakowicz { 484b97a2a0aSMarian Balakowicz return (image_get_os(hdr) == os); 485b97a2a0aSMarian Balakowicz } 486b97a2a0aSMarian Balakowicz 4873a2003f6SWolfgang Denk ulong image_multi_count(const image_header_t *hdr); 4883a2003f6SWolfgang Denk void image_multi_getimg(const image_header_t *hdr, ulong idx, 48942b73e8eSMarian Balakowicz ulong *data, ulong *len); 49042b73e8eSMarian Balakowicz 4913a2003f6SWolfgang Denk void image_print_contents(const void *hdr); 492570abb0aSMarian Balakowicz 493b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC 4943a2003f6SWolfgang Denk static inline int image_check_target_arch(const image_header_t *hdr) 495b97a2a0aSMarian Balakowicz { 496476af299SMike Frysinger #ifndef IH_ARCH_DEFAULT 497476af299SMike Frysinger # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h" 498b97a2a0aSMarian Balakowicz #endif 499476af299SMike Frysinger return image_check_arch(hdr, IH_ARCH_DEFAULT); 500b97a2a0aSMarian Balakowicz } 5015dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 5025b1d7137Swdenk 503d5934ad7SMarian Balakowicz /*******************************************************************/ 5049a4daad0SMarian Balakowicz /* New uImage format specific code (prefixed with fit_) */ 505d5934ad7SMarian Balakowicz /*******************************************************************/ 506f50433d6SMarian Balakowicz #if defined(CONFIG_FIT) 5075dfb5213SMarian Balakowicz 5085dfb5213SMarian Balakowicz #define FIT_IMAGES_PATH "/images" 5095dfb5213SMarian Balakowicz #define FIT_CONFS_PATH "/configurations" 5105dfb5213SMarian Balakowicz 5115dfb5213SMarian Balakowicz /* hash node */ 5125dfb5213SMarian Balakowicz #define FIT_HASH_NODENAME "hash" 5135dfb5213SMarian Balakowicz #define FIT_ALGO_PROP "algo" 5145dfb5213SMarian Balakowicz #define FIT_VALUE_PROP "value" 5158ac88f2dSJoe Hershberger #define FIT_IGNORE_PROP "uboot-ignore" 5165dfb5213SMarian Balakowicz 5175dfb5213SMarian Balakowicz /* image node */ 5185dfb5213SMarian Balakowicz #define FIT_DATA_PROP "data" 5195dfb5213SMarian Balakowicz #define FIT_TIMESTAMP_PROP "timestamp" 5205dfb5213SMarian Balakowicz #define FIT_DESC_PROP "description" 5215dfb5213SMarian Balakowicz #define FIT_ARCH_PROP "arch" 5225dfb5213SMarian Balakowicz #define FIT_TYPE_PROP "type" 5235dfb5213SMarian Balakowicz #define FIT_OS_PROP "os" 5245dfb5213SMarian Balakowicz #define FIT_COMP_PROP "compression" 5255dfb5213SMarian Balakowicz #define FIT_ENTRY_PROP "entry" 5265dfb5213SMarian Balakowicz #define FIT_LOAD_PROP "load" 5275dfb5213SMarian Balakowicz 5285dfb5213SMarian Balakowicz /* configuration node */ 5295dfb5213SMarian Balakowicz #define FIT_KERNEL_PROP "kernel" 5305dfb5213SMarian Balakowicz #define FIT_RAMDISK_PROP "ramdisk" 5315dfb5213SMarian Balakowicz #define FIT_FDT_PROP "fdt" 5325dfb5213SMarian Balakowicz #define FIT_DEFAULT_PROP "default" 5335dfb5213SMarian Balakowicz 5345dfb5213SMarian Balakowicz #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */ 5355dfb5213SMarian Balakowicz 5365dfb5213SMarian Balakowicz /* cmdline argument format parsing */ 537314f634bSMike Frysinger int fit_parse_conf(const char *spec, ulong addr_curr, 538f50433d6SMarian Balakowicz ulong *addr, const char **conf_name); 539314f634bSMike Frysinger int fit_parse_subimage(const char *spec, ulong addr_curr, 540f50433d6SMarian Balakowicz ulong *addr, const char **image_name); 541d5934ad7SMarian Balakowicz 542edbed247SBartlomiej Sieka void fit_print_contents(const void *fit); 5435dfb5213SMarian Balakowicz void fit_image_print(const void *fit, int noffset, const char *p); 5445dfb5213SMarian Balakowicz void fit_image_print_hash(const void *fit, int noffset, const char *p); 5455dfb5213SMarian Balakowicz 5465dfb5213SMarian Balakowicz /** 5475dfb5213SMarian Balakowicz * fit_get_end - get FIT image size 5485dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5495dfb5213SMarian Balakowicz * 5505dfb5213SMarian Balakowicz * returns: 5515dfb5213SMarian Balakowicz * size of the FIT image (blob) in memory 5525dfb5213SMarian Balakowicz */ 5535dfb5213SMarian Balakowicz static inline ulong fit_get_size(const void *fit) 5545dfb5213SMarian Balakowicz { 5555dfb5213SMarian Balakowicz return fdt_totalsize(fit); 5565dfb5213SMarian Balakowicz } 5575dfb5213SMarian Balakowicz 5585dfb5213SMarian Balakowicz /** 5595dfb5213SMarian Balakowicz * fit_get_end - get FIT image end 5605dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5615dfb5213SMarian Balakowicz * 5625dfb5213SMarian Balakowicz * returns: 5635dfb5213SMarian Balakowicz * end address of the FIT image (blob) in memory 5645dfb5213SMarian Balakowicz */ 5655dfb5213SMarian Balakowicz static inline ulong fit_get_end(const void *fit) 5665dfb5213SMarian Balakowicz { 5675dfb5213SMarian Balakowicz return (ulong)fit + fdt_totalsize(fit); 5685dfb5213SMarian Balakowicz } 5695dfb5213SMarian Balakowicz 5705dfb5213SMarian Balakowicz /** 5715dfb5213SMarian Balakowicz * fit_get_name - get FIT node name 5725dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 5735dfb5213SMarian Balakowicz * 5745dfb5213SMarian Balakowicz * returns: 5755dfb5213SMarian Balakowicz * NULL, on error 5765dfb5213SMarian Balakowicz * pointer to node name, on success 5775dfb5213SMarian Balakowicz */ 5785dfb5213SMarian Balakowicz static inline const char *fit_get_name(const void *fit_hdr, 5795dfb5213SMarian Balakowicz int noffset, int *len) 5805dfb5213SMarian Balakowicz { 5815dfb5213SMarian Balakowicz return fdt_get_name(fit_hdr, noffset, len); 5825dfb5213SMarian Balakowicz } 5835dfb5213SMarian Balakowicz 5845dfb5213SMarian Balakowicz int fit_get_desc(const void *fit, int noffset, char **desc); 5855dfb5213SMarian Balakowicz int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); 5865dfb5213SMarian Balakowicz 5875dfb5213SMarian Balakowicz int fit_image_get_node(const void *fit, const char *image_uname); 5885dfb5213SMarian Balakowicz int fit_image_get_os(const void *fit, int noffset, uint8_t *os); 5895dfb5213SMarian Balakowicz int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); 5905dfb5213SMarian Balakowicz int fit_image_get_type(const void *fit, int noffset, uint8_t *type); 5915dfb5213SMarian Balakowicz int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); 5925dfb5213SMarian Balakowicz int fit_image_get_load(const void *fit, int noffset, ulong *load); 5935dfb5213SMarian Balakowicz int fit_image_get_entry(const void *fit, int noffset, ulong *entry); 5945dfb5213SMarian Balakowicz int fit_image_get_data(const void *fit, int noffset, 5955dfb5213SMarian Balakowicz const void **data, size_t *size); 5965dfb5213SMarian Balakowicz 5975dfb5213SMarian Balakowicz int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); 5985dfb5213SMarian Balakowicz int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, 5995dfb5213SMarian Balakowicz int *value_len); 6008ac88f2dSJoe Hershberger #ifndef USE_HOSTCC 6018ac88f2dSJoe Hershberger int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore); 6028ac88f2dSJoe Hershberger #endif 6035dfb5213SMarian Balakowicz 6045dfb5213SMarian Balakowicz int fit_set_timestamp(void *fit, int noffset, time_t timestamp); 6055dfb5213SMarian Balakowicz int fit_set_hashes(void *fit); 6065dfb5213SMarian Balakowicz int fit_image_set_hashes(void *fit, int image_noffset); 6075dfb5213SMarian Balakowicz int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value, 6085dfb5213SMarian Balakowicz int value_len); 6095dfb5213SMarian Balakowicz 6105dfb5213SMarian Balakowicz int fit_image_check_hashes(const void *fit, int noffset); 611919f550dSBartlomiej Sieka int fit_all_image_check_hashes(const void *fit); 6125dfb5213SMarian Balakowicz int fit_image_check_os(const void *fit, int noffset, uint8_t os); 6135dfb5213SMarian Balakowicz int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); 6145dfb5213SMarian Balakowicz int fit_image_check_type(const void *fit, int noffset, uint8_t type); 6155dfb5213SMarian Balakowicz int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); 6165dfb5213SMarian Balakowicz int fit_check_format(const void *fit); 6175dfb5213SMarian Balakowicz 618*d95f6ec7SGabe Black int fit_conf_find_compat(const void *fit, const void *fdt); 6195dfb5213SMarian Balakowicz int fit_conf_get_node(const void *fit, const char *conf_uname); 6205dfb5213SMarian Balakowicz int fit_conf_get_kernel_node(const void *fit, int noffset); 6215dfb5213SMarian Balakowicz int fit_conf_get_ramdisk_node(const void *fit, int noffset); 6225dfb5213SMarian Balakowicz int fit_conf_get_fdt_node(const void *fit, int noffset); 6235dfb5213SMarian Balakowicz 6245dfb5213SMarian Balakowicz void fit_conf_print(const void *fit, int noffset, const char *p); 6255dfb5213SMarian Balakowicz 6265dfb5213SMarian Balakowicz #ifndef USE_HOSTCC 6275dfb5213SMarian Balakowicz static inline int fit_image_check_target_arch(const void *fdt, int node) 6285dfb5213SMarian Balakowicz { 6297566832aSThierry Reding return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); 6305dfb5213SMarian Balakowicz } 6315dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 6325dfb5213SMarian Balakowicz 633d5934ad7SMarian Balakowicz #ifdef CONFIG_FIT_VERBOSE 634d5934ad7SMarian Balakowicz #define fit_unsupported(msg) printf("! %s:%d " \ 635d5934ad7SMarian Balakowicz "FIT images not supported for '%s'\n", \ 636d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 637d5934ad7SMarian Balakowicz 638d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) printf("! %s:%d " \ 639d5934ad7SMarian Balakowicz "FIT images not supported for '%s' " \ 640d5934ad7SMarian Balakowicz "- must reset board to recover!\n", \ 641d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 642d5934ad7SMarian Balakowicz #else 643d5934ad7SMarian Balakowicz #define fit_unsupported(msg) 644d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) 645d5934ad7SMarian Balakowicz #endif /* CONFIG_FIT_VERBOSE */ 646f50433d6SMarian Balakowicz #endif /* CONFIG_FIT */ 6475ad03eb3SMarian Balakowicz 6485b1d7137Swdenk #endif /* __IMAGE_H__ */ 649