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