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