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