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