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