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