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