include/image.h

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