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