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