image: support board_fit_config_name_match
[platform/kernel/u-boot.git] / common / image-fit.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (c) 2013, Google Inc.
4  *
5  * (C) Copyright 2008 Semihalf
6  *
7  * (C) Copyright 2000-2006
8  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9  */
10
11 #ifdef USE_HOSTCC
12 #include "mkimage.h"
13 #include <time.h>
14 #include <linux/libfdt.h>
15 #include <u-boot/crc.h>
16 #else
17 #include <linux/compiler.h>
18 #include <common.h>
19 #include <errno.h>
20 #include <log.h>
21 #include <mapmem.h>
22 #include <asm/io.h>
23 #include <malloc.h>
24 DECLARE_GLOBAL_DATA_PTR;
25 #endif /* !USE_HOSTCC*/
26
27 #include <bootm.h>
28 #include <image.h>
29 #include <bootstage.h>
30 #include <linux/kconfig.h>
31 #include <u-boot/crc.h>
32 #include <u-boot/md5.h>
33 #include <u-boot/sha1.h>
34 #include <u-boot/sha256.h>
35 #include <u-boot/sha512.h>
36
37 /*****************************************************************************/
38 /* New uImage format routines */
39 /*****************************************************************************/
40 #ifndef USE_HOSTCC
41 static int fit_parse_spec(const char *spec, char sepc, ulong addr_curr,
42                 ulong *addr, const char **name)
43 {
44         const char *sep;
45
46         *addr = addr_curr;
47         *name = NULL;
48
49         sep = strchr(spec, sepc);
50         if (sep) {
51                 if (sep - spec > 0)
52                         *addr = simple_strtoul(spec, NULL, 16);
53
54                 *name = sep + 1;
55                 return 1;
56         }
57
58         return 0;
59 }
60
61 /**
62  * fit_parse_conf - parse FIT configuration spec
63  * @spec: input string, containing configuration spec
64  * @add_curr: current image address (to be used as a possible default)
65  * @addr: pointer to a ulong variable, will hold FIT image address of a given
66  * configuration
67  * @conf_name double pointer to a char, will hold pointer to a configuration
68  * unit name
69  *
70  * fit_parse_conf() expects configuration spec in the form of [<addr>]#<conf>,
71  * where <addr> is a FIT image address that contains configuration
72  * with a <conf> unit name.
73  *
74  * Address part is optional, and if omitted default add_curr will
75  * be used instead.
76  *
77  * returns:
78  *     1 if spec is a valid configuration string,
79  *     addr and conf_name are set accordingly
80  *     0 otherwise
81  */
82 int fit_parse_conf(const char *spec, ulong addr_curr,
83                 ulong *addr, const char **conf_name)
84 {
85         return fit_parse_spec(spec, '#', addr_curr, addr, conf_name);
86 }
87
88 /**
89  * fit_parse_subimage - parse FIT subimage spec
90  * @spec: input string, containing subimage spec
91  * @add_curr: current image address (to be used as a possible default)
92  * @addr: pointer to a ulong variable, will hold FIT image address of a given
93  * subimage
94  * @image_name: double pointer to a char, will hold pointer to a subimage name
95  *
96  * fit_parse_subimage() expects subimage spec in the form of
97  * [<addr>]:<subimage>, where <addr> is a FIT image address that contains
98  * subimage with a <subimg> unit name.
99  *
100  * Address part is optional, and if omitted default add_curr will
101  * be used instead.
102  *
103  * returns:
104  *     1 if spec is a valid subimage string,
105  *     addr and image_name are set accordingly
106  *     0 otherwise
107  */
108 int fit_parse_subimage(const char *spec, ulong addr_curr,
109                 ulong *addr, const char **image_name)
110 {
111         return fit_parse_spec(spec, ':', addr_curr, addr, image_name);
112 }
113 #endif /* !USE_HOSTCC */
114
115 static void fit_get_debug(const void *fit, int noffset,
116                 char *prop_name, int err)
117 {
118         debug("Can't get '%s' property from FIT 0x%08lx, node: offset %d, name %s (%s)\n",
119               prop_name, (ulong)fit, noffset, fit_get_name(fit, noffset, NULL),
120               fdt_strerror(err));
121 }
122
123 /**
124  * fit_get_subimage_count - get component (sub-image) count
125  * @fit: pointer to the FIT format image header
126  * @images_noffset: offset of images node
127  *
128  * returns:
129  *     number of image components
130  */
131 int fit_get_subimage_count(const void *fit, int images_noffset)
132 {
133         int noffset;
134         int ndepth;
135         int count = 0;
136
137         /* Process its subnodes, print out component images details */
138         for (ndepth = 0, count = 0,
139                 noffset = fdt_next_node(fit, images_noffset, &ndepth);
140              (noffset >= 0) && (ndepth > 0);
141              noffset = fdt_next_node(fit, noffset, &ndepth)) {
142                 if (ndepth == 1) {
143                         count++;
144                 }
145         }
146
147         return count;
148 }
149
150 #if !defined(CONFIG_SPL_BUILD) || defined(CONFIG_SPL_FIT_PRINT)
151 /**
152  * fit_image_print_data() - prints out the hash node details
153  * @fit: pointer to the FIT format image header
154  * @noffset: offset of the hash node
155  * @p: pointer to prefix string
156  * @type: Type of information to print ("hash" or "sign")
157  *
158  * fit_image_print_data() lists properties for the processed hash node
159  *
160  * This function avoid using puts() since it prints a newline on the host
161  * but does not in U-Boot.
162  *
163  * returns:
164  *     no returned results
165  */
166 static void fit_image_print_data(const void *fit, int noffset, const char *p,
167                                  const char *type)
168 {
169         const char *keyname;
170         uint8_t *value;
171         int value_len;
172         char *algo;
173         const char *padding;
174         bool required;
175         int ret, i;
176
177         debug("%s  %s node:    '%s'\n", p, type,
178               fit_get_name(fit, noffset, NULL));
179         printf("%s  %s algo:    ", p, type);
180         if (fit_image_hash_get_algo(fit, noffset, &algo)) {
181                 printf("invalid/unsupported\n");
182                 return;
183         }
184         printf("%s", algo);
185         keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
186         required = fdt_getprop(fit, noffset, FIT_KEY_REQUIRED, NULL) != NULL;
187         if (keyname)
188                 printf(":%s", keyname);
189         if (required)
190                 printf(" (required)");
191         printf("\n");
192
193         padding = fdt_getprop(fit, noffset, "padding", NULL);
194         if (padding)
195                 printf("%s  %s padding: %s\n", p, type, padding);
196
197         ret = fit_image_hash_get_value(fit, noffset, &value,
198                                        &value_len);
199         printf("%s  %s value:   ", p, type);
200         if (ret) {
201                 printf("unavailable\n");
202         } else {
203                 for (i = 0; i < value_len; i++)
204                         printf("%02x", value[i]);
205                 printf("\n");
206         }
207
208         debug("%s  %s len:     %d\n", p, type, value_len);
209
210         /* Signatures have a time stamp */
211         if (IMAGE_ENABLE_TIMESTAMP && keyname) {
212                 time_t timestamp;
213
214                 printf("%s  Timestamp:    ", p);
215                 if (fit_get_timestamp(fit, noffset, &timestamp))
216                         printf("unavailable\n");
217                 else
218                         genimg_print_time(timestamp);
219         }
220 }
221
222 /**
223  * fit_image_print_verification_data() - prints out the hash/signature details
224  * @fit: pointer to the FIT format image header
225  * @noffset: offset of the hash or signature node
226  * @p: pointer to prefix string
227  *
228  * This lists properties for the processed hash node
229  *
230  * returns:
231  *     no returned results
232  */
233 static void fit_image_print_verification_data(const void *fit, int noffset,
234                                               const char *p)
235 {
236         const char *name;
237
238         /*
239          * Check subnode name, must be equal to "hash" or "signature".
240          * Multiple hash/signature nodes require unique unit node
241          * names, e.g. hash-1, hash-2, signature-1, signature-2, etc.
242          */
243         name = fit_get_name(fit, noffset, NULL);
244         if (!strncmp(name, FIT_HASH_NODENAME, strlen(FIT_HASH_NODENAME))) {
245                 fit_image_print_data(fit, noffset, p, "Hash");
246         } else if (!strncmp(name, FIT_SIG_NODENAME,
247                                 strlen(FIT_SIG_NODENAME))) {
248                 fit_image_print_data(fit, noffset, p, "Sign");
249         }
250 }
251
252 /**
253  * fit_conf_print - prints out the FIT configuration details
254  * @fit: pointer to the FIT format image header
255  * @noffset: offset of the configuration node
256  * @p: pointer to prefix string
257  *
258  * fit_conf_print() lists all mandatory properties for the processed
259  * configuration node.
260  *
261  * returns:
262  *     no returned results
263  */
264 static void fit_conf_print(const void *fit, int noffset, const char *p)
265 {
266         char *desc;
267         const char *uname;
268         int ret;
269         int fdt_index, loadables_index;
270         int ndepth;
271
272         /* Mandatory properties */
273         ret = fit_get_desc(fit, noffset, &desc);
274         printf("%s  Description:  ", p);
275         if (ret)
276                 printf("unavailable\n");
277         else
278                 printf("%s\n", desc);
279
280         uname = fdt_getprop(fit, noffset, FIT_KERNEL_PROP, NULL);
281         printf("%s  Kernel:       ", p);
282         if (!uname)
283                 printf("unavailable\n");
284         else
285                 printf("%s\n", uname);
286
287         /* Optional properties */
288         uname = fdt_getprop(fit, noffset, FIT_RAMDISK_PROP, NULL);
289         if (uname)
290                 printf("%s  Init Ramdisk: %s\n", p, uname);
291
292         uname = fdt_getprop(fit, noffset, FIT_FIRMWARE_PROP, NULL);
293         if (uname)
294                 printf("%s  Firmware:     %s\n", p, uname);
295
296         for (fdt_index = 0;
297              uname = fdt_stringlist_get(fit, noffset, FIT_FDT_PROP,
298                                         fdt_index, NULL), uname;
299              fdt_index++) {
300                 if (fdt_index == 0)
301                         printf("%s  FDT:          ", p);
302                 else
303                         printf("%s                ", p);
304                 printf("%s\n", uname);
305         }
306
307         uname = fdt_getprop(fit, noffset, FIT_FPGA_PROP, NULL);
308         if (uname)
309                 printf("%s  FPGA:         %s\n", p, uname);
310
311         /* Print out all of the specified loadables */
312         for (loadables_index = 0;
313              uname = fdt_stringlist_get(fit, noffset, FIT_LOADABLE_PROP,
314                                         loadables_index, NULL), uname;
315              loadables_index++) {
316                 if (loadables_index == 0) {
317                         printf("%s  Loadables:    ", p);
318                 } else {
319                         printf("%s                ", p);
320                 }
321                 printf("%s\n", uname);
322         }
323
324         /* Process all hash subnodes of the component configuration node */
325         for (ndepth = 0, noffset = fdt_next_node(fit, noffset, &ndepth);
326              (noffset >= 0) && (ndepth > 0);
327              noffset = fdt_next_node(fit, noffset, &ndepth)) {
328                 if (ndepth == 1) {
329                         /* Direct child node of the component configuration node */
330                         fit_image_print_verification_data(fit, noffset, p);
331                 }
332         }
333 }
334
335 /**
336  * fit_print_contents - prints out the contents of the FIT format image
337  * @fit: pointer to the FIT format image header
338  * @p: pointer to prefix string
339  *
340  * fit_print_contents() formats a multi line FIT image contents description.
341  * The routine prints out FIT image properties (root node level) followed by
342  * the details of each component image.
343  *
344  * returns:
345  *     no returned results
346  */
347 void fit_print_contents(const void *fit)
348 {
349         char *desc;
350         char *uname;
351         int images_noffset;
352         int confs_noffset;
353         int noffset;
354         int ndepth;
355         int count = 0;
356         int ret;
357         const char *p;
358         time_t timestamp;
359
360         /* Indent string is defined in header image.h */
361         p = IMAGE_INDENT_STRING;
362
363         /* Root node properties */
364         ret = fit_get_desc(fit, 0, &desc);
365         printf("%sFIT description: ", p);
366         if (ret)
367                 printf("unavailable\n");
368         else
369                 printf("%s\n", desc);
370
371         if (IMAGE_ENABLE_TIMESTAMP) {
372                 ret = fit_get_timestamp(fit, 0, &timestamp);
373                 printf("%sCreated:         ", p);
374                 if (ret)
375                         printf("unavailable\n");
376                 else
377                         genimg_print_time(timestamp);
378         }
379
380         /* Find images parent node offset */
381         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
382         if (images_noffset < 0) {
383                 printf("Can't find images parent node '%s' (%s)\n",
384                        FIT_IMAGES_PATH, fdt_strerror(images_noffset));
385                 return;
386         }
387
388         /* Process its subnodes, print out component images details */
389         for (ndepth = 0, count = 0,
390                 noffset = fdt_next_node(fit, images_noffset, &ndepth);
391              (noffset >= 0) && (ndepth > 0);
392              noffset = fdt_next_node(fit, noffset, &ndepth)) {
393                 if (ndepth == 1) {
394                         /*
395                          * Direct child node of the images parent node,
396                          * i.e. component image node.
397                          */
398                         printf("%s Image %u (%s)\n", p, count++,
399                                fit_get_name(fit, noffset, NULL));
400
401                         fit_image_print(fit, noffset, p);
402                 }
403         }
404
405         /* Find configurations parent node offset */
406         confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
407         if (confs_noffset < 0) {
408                 debug("Can't get configurations parent node '%s' (%s)\n",
409                       FIT_CONFS_PATH, fdt_strerror(confs_noffset));
410                 return;
411         }
412
413         /* get default configuration unit name from default property */
414         uname = (char *)fdt_getprop(fit, noffset, FIT_DEFAULT_PROP, NULL);
415         if (uname)
416                 printf("%s Default Configuration: '%s'\n", p, uname);
417
418         /* Process its subnodes, print out configurations details */
419         for (ndepth = 0, count = 0,
420                 noffset = fdt_next_node(fit, confs_noffset, &ndepth);
421              (noffset >= 0) && (ndepth > 0);
422              noffset = fdt_next_node(fit, noffset, &ndepth)) {
423                 if (ndepth == 1) {
424                         /*
425                          * Direct child node of the configurations parent node,
426                          * i.e. configuration node.
427                          */
428                         printf("%s Configuration %u (%s)\n", p, count++,
429                                fit_get_name(fit, noffset, NULL));
430
431                         fit_conf_print(fit, noffset, p);
432                 }
433         }
434 }
435
436 /**
437  * fit_image_print - prints out the FIT component image details
438  * @fit: pointer to the FIT format image header
439  * @image_noffset: offset of the component image node
440  * @p: pointer to prefix string
441  *
442  * fit_image_print() lists all mandatory properties for the processed component
443  * image. If present, hash nodes are printed out as well. Load
444  * address for images of type firmware is also printed out. Since the load
445  * address is not mandatory for firmware images, it will be output as
446  * "unavailable" when not present.
447  *
448  * returns:
449  *     no returned results
450  */
451 void fit_image_print(const void *fit, int image_noffset, const char *p)
452 {
453         char *desc;
454         uint8_t type, arch, os, comp;
455         size_t size;
456         ulong load, entry;
457         const void *data;
458         int noffset;
459         int ndepth;
460         int ret;
461
462         /* Mandatory properties */
463         ret = fit_get_desc(fit, image_noffset, &desc);
464         printf("%s  Description:  ", p);
465         if (ret)
466                 printf("unavailable\n");
467         else
468                 printf("%s\n", desc);
469
470         if (IMAGE_ENABLE_TIMESTAMP) {
471                 time_t timestamp;
472
473                 ret = fit_get_timestamp(fit, 0, &timestamp);
474                 printf("%s  Created:      ", p);
475                 if (ret)
476                         printf("unavailable\n");
477                 else
478                         genimg_print_time(timestamp);
479         }
480
481         fit_image_get_type(fit, image_noffset, &type);
482         printf("%s  Type:         %s\n", p, genimg_get_type_name(type));
483
484         fit_image_get_comp(fit, image_noffset, &comp);
485         printf("%s  Compression:  %s\n", p, genimg_get_comp_name(comp));
486
487         ret = fit_image_get_data_and_size(fit, image_noffset, &data, &size);
488
489         if (!host_build()) {
490                 printf("%s  Data Start:   ", p);
491                 if (ret) {
492                         printf("unavailable\n");
493                 } else {
494                         void *vdata = (void *)data;
495
496                         printf("0x%08lx\n", (ulong)map_to_sysmem(vdata));
497                 }
498         }
499
500         printf("%s  Data Size:    ", p);
501         if (ret)
502                 printf("unavailable\n");
503         else
504                 genimg_print_size(size);
505
506         /* Remaining, type dependent properties */
507         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
508             (type == IH_TYPE_RAMDISK) || (type == IH_TYPE_FIRMWARE) ||
509             (type == IH_TYPE_FLATDT)) {
510                 fit_image_get_arch(fit, image_noffset, &arch);
511                 printf("%s  Architecture: %s\n", p, genimg_get_arch_name(arch));
512         }
513
514         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_RAMDISK) ||
515             (type == IH_TYPE_FIRMWARE)) {
516                 fit_image_get_os(fit, image_noffset, &os);
517                 printf("%s  OS:           %s\n", p, genimg_get_os_name(os));
518         }
519
520         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
521             (type == IH_TYPE_FIRMWARE) || (type == IH_TYPE_RAMDISK) ||
522             (type == IH_TYPE_FPGA)) {
523                 ret = fit_image_get_load(fit, image_noffset, &load);
524                 printf("%s  Load Address: ", p);
525                 if (ret)
526                         printf("unavailable\n");
527                 else
528                         printf("0x%08lx\n", load);
529         }
530
531         /* optional load address for FDT */
532         if (type == IH_TYPE_FLATDT && !fit_image_get_load(fit, image_noffset, &load))
533                 printf("%s  Load Address: 0x%08lx\n", p, load);
534
535         if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
536             (type == IH_TYPE_RAMDISK)) {
537                 ret = fit_image_get_entry(fit, image_noffset, &entry);
538                 printf("%s  Entry Point:  ", p);
539                 if (ret)
540                         printf("unavailable\n");
541                 else
542                         printf("0x%08lx\n", entry);
543         }
544
545         /* Process all hash subnodes of the component image node */
546         for (ndepth = 0, noffset = fdt_next_node(fit, image_noffset, &ndepth);
547              (noffset >= 0) && (ndepth > 0);
548              noffset = fdt_next_node(fit, noffset, &ndepth)) {
549                 if (ndepth == 1) {
550                         /* Direct child node of the component image node */
551                         fit_image_print_verification_data(fit, noffset, p);
552                 }
553         }
554 }
555 #else
556 void fit_print_contents(const void *fit) { }
557 void fit_image_print(const void *fit, int image_noffset, const char *p) { }
558 #endif /* !defined(CONFIG_SPL_BUILD) || defined(CONFIG_SPL_FIT_PRINT) */
559
560 /**
561  * fit_get_desc - get node description property
562  * @fit: pointer to the FIT format image header
563  * @noffset: node offset
564  * @desc: double pointer to the char, will hold pointer to the description
565  *
566  * fit_get_desc() reads description property from a given node, if
567  * description is found pointer to it is returned in third call argument.
568  *
569  * returns:
570  *     0, on success
571  *     -1, on failure
572  */
573 int fit_get_desc(const void *fit, int noffset, char **desc)
574 {
575         int len;
576
577         *desc = (char *)fdt_getprop(fit, noffset, FIT_DESC_PROP, &len);
578         if (*desc == NULL) {
579                 fit_get_debug(fit, noffset, FIT_DESC_PROP, len);
580                 return -1;
581         }
582
583         return 0;
584 }
585
586 /**
587  * fit_get_timestamp - get node timestamp property
588  * @fit: pointer to the FIT format image header
589  * @noffset: node offset
590  * @timestamp: pointer to the time_t, will hold read timestamp
591  *
592  * fit_get_timestamp() reads timestamp property from given node, if timestamp
593  * is found and has a correct size its value is returned in third call
594  * argument.
595  *
596  * returns:
597  *     0, on success
598  *     -1, on property read failure
599  *     -2, on wrong timestamp size
600  */
601 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp)
602 {
603         int len;
604         const void *data;
605
606         data = fdt_getprop(fit, noffset, FIT_TIMESTAMP_PROP, &len);
607         if (data == NULL) {
608                 fit_get_debug(fit, noffset, FIT_TIMESTAMP_PROP, len);
609                 return -1;
610         }
611         if (len != sizeof(uint32_t)) {
612                 debug("FIT timestamp with incorrect size of (%u)\n", len);
613                 return -2;
614         }
615
616         *timestamp = uimage_to_cpu(*((uint32_t *)data));
617         return 0;
618 }
619
620 /**
621  * fit_image_get_node - get node offset for component image of a given unit name
622  * @fit: pointer to the FIT format image header
623  * @image_uname: component image node unit name
624  *
625  * fit_image_get_node() finds a component image (within the '/images'
626  * node) of a provided unit name. If image is found its node offset is
627  * returned to the caller.
628  *
629  * returns:
630  *     image node offset when found (>=0)
631  *     negative number on failure (FDT_ERR_* code)
632  */
633 int fit_image_get_node(const void *fit, const char *image_uname)
634 {
635         int noffset, images_noffset;
636
637         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
638         if (images_noffset < 0) {
639                 debug("Can't find images parent node '%s' (%s)\n",
640                       FIT_IMAGES_PATH, fdt_strerror(images_noffset));
641                 return images_noffset;
642         }
643
644         noffset = fdt_subnode_offset(fit, images_noffset, image_uname);
645         if (noffset < 0) {
646                 debug("Can't get node offset for image unit name: '%s' (%s)\n",
647                       image_uname, fdt_strerror(noffset));
648         }
649
650         return noffset;
651 }
652
653 /**
654  * fit_image_get_os - get os id for a given component image node
655  * @fit: pointer to the FIT format image header
656  * @noffset: component image node offset
657  * @os: pointer to the uint8_t, will hold os numeric id
658  *
659  * fit_image_get_os() finds os property in a given component image node.
660  * If the property is found, its (string) value is translated to the numeric
661  * id which is returned to the caller.
662  *
663  * returns:
664  *     0, on success
665  *     -1, on failure
666  */
667 int fit_image_get_os(const void *fit, int noffset, uint8_t *os)
668 {
669         int len;
670         const void *data;
671
672         /* Get OS name from property data */
673         data = fdt_getprop(fit, noffset, FIT_OS_PROP, &len);
674         if (data == NULL) {
675                 fit_get_debug(fit, noffset, FIT_OS_PROP, len);
676                 *os = -1;
677                 return -1;
678         }
679
680         /* Translate OS name to id */
681         *os = genimg_get_os_id(data);
682         return 0;
683 }
684
685 /**
686  * fit_image_get_arch - get arch id for a given component image node
687  * @fit: pointer to the FIT format image header
688  * @noffset: component image node offset
689  * @arch: pointer to the uint8_t, will hold arch numeric id
690  *
691  * fit_image_get_arch() finds arch property in a given component image node.
692  * If the property is found, its (string) value is translated to the numeric
693  * id which is returned to the caller.
694  *
695  * returns:
696  *     0, on success
697  *     -1, on failure
698  */
699 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch)
700 {
701         int len;
702         const void *data;
703
704         /* Get architecture name from property data */
705         data = fdt_getprop(fit, noffset, FIT_ARCH_PROP, &len);
706         if (data == NULL) {
707                 fit_get_debug(fit, noffset, FIT_ARCH_PROP, len);
708                 *arch = -1;
709                 return -1;
710         }
711
712         /* Translate architecture name to id */
713         *arch = genimg_get_arch_id(data);
714         return 0;
715 }
716
717 /**
718  * fit_image_get_type - get type id for a given component image node
719  * @fit: pointer to the FIT format image header
720  * @noffset: component image node offset
721  * @type: pointer to the uint8_t, will hold type numeric id
722  *
723  * fit_image_get_type() finds type property in a given component image node.
724  * If the property is found, its (string) value is translated to the numeric
725  * id which is returned to the caller.
726  *
727  * returns:
728  *     0, on success
729  *     -1, on failure
730  */
731 int fit_image_get_type(const void *fit, int noffset, uint8_t *type)
732 {
733         int len;
734         const void *data;
735
736         /* Get image type name from property data */
737         data = fdt_getprop(fit, noffset, FIT_TYPE_PROP, &len);
738         if (data == NULL) {
739                 fit_get_debug(fit, noffset, FIT_TYPE_PROP, len);
740                 *type = -1;
741                 return -1;
742         }
743
744         /* Translate image type name to id */
745         *type = genimg_get_type_id(data);
746         return 0;
747 }
748
749 /**
750  * fit_image_get_comp - get comp id for a given component image node
751  * @fit: pointer to the FIT format image header
752  * @noffset: component image node offset
753  * @comp: pointer to the uint8_t, will hold comp numeric id
754  *
755  * fit_image_get_comp() finds comp property in a given component image node.
756  * If the property is found, its (string) value is translated to the numeric
757  * id which is returned to the caller.
758  *
759  * returns:
760  *     0, on success
761  *     -1, on failure
762  */
763 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp)
764 {
765         int len;
766         const void *data;
767
768         /* Get compression name from property data */
769         data = fdt_getprop(fit, noffset, FIT_COMP_PROP, &len);
770         if (data == NULL) {
771                 fit_get_debug(fit, noffset, FIT_COMP_PROP, len);
772                 *comp = -1;
773                 return -1;
774         }
775
776         /* Translate compression name to id */
777         *comp = genimg_get_comp_id(data);
778         return 0;
779 }
780
781 static int fit_image_get_address(const void *fit, int noffset, char *name,
782                           ulong *load)
783 {
784         int len, cell_len;
785         const fdt32_t *cell;
786         uint64_t load64 = 0;
787
788         cell = fdt_getprop(fit, noffset, name, &len);
789         if (cell == NULL) {
790                 fit_get_debug(fit, noffset, name, len);
791                 return -1;
792         }
793
794         cell_len = len >> 2;
795         /* Use load64 to avoid compiling warning for 32-bit target */
796         while (cell_len--) {
797                 load64 = (load64 << 32) | uimage_to_cpu(*cell);
798                 cell++;
799         }
800
801         if (len > sizeof(ulong) && (uint32_t)(load64 >> 32)) {
802                 printf("Unsupported %s address size\n", name);
803                 return -1;
804         }
805
806         *load = (ulong)load64;
807
808         return 0;
809 }
810 /**
811  * fit_image_get_load() - get load addr property for given component image node
812  * @fit: pointer to the FIT format image header
813  * @noffset: component image node offset
814  * @load: pointer to the uint32_t, will hold load address
815  *
816  * fit_image_get_load() finds load address property in a given component
817  * image node. If the property is found, its value is returned to the caller.
818  *
819  * returns:
820  *     0, on success
821  *     -1, on failure
822  */
823 int fit_image_get_load(const void *fit, int noffset, ulong *load)
824 {
825         return fit_image_get_address(fit, noffset, FIT_LOAD_PROP, load);
826 }
827
828 /**
829  * fit_image_get_entry() - get entry point address property
830  * @fit: pointer to the FIT format image header
831  * @noffset: component image node offset
832  * @entry: pointer to the uint32_t, will hold entry point address
833  *
834  * This gets the entry point address property for a given component image
835  * node.
836  *
837  * fit_image_get_entry() finds entry point address property in a given
838  * component image node.  If the property is found, its value is returned
839  * to the caller.
840  *
841  * returns:
842  *     0, on success
843  *     -1, on failure
844  */
845 int fit_image_get_entry(const void *fit, int noffset, ulong *entry)
846 {
847         return fit_image_get_address(fit, noffset, FIT_ENTRY_PROP, entry);
848 }
849
850 /**
851  * fit_image_get_data - get data property and its size for a given component image node
852  * @fit: pointer to the FIT format image header
853  * @noffset: component image node offset
854  * @data: double pointer to void, will hold data property's data address
855  * @size: pointer to size_t, will hold data property's data size
856  *
857  * fit_image_get_data() finds data property in a given component image node.
858  * If the property is found its data start address and size are returned to
859  * the caller.
860  *
861  * returns:
862  *     0, on success
863  *     -1, on failure
864  */
865 int fit_image_get_data(const void *fit, int noffset,
866                 const void **data, size_t *size)
867 {
868         int len;
869
870         *data = fdt_getprop(fit, noffset, FIT_DATA_PROP, &len);
871         if (*data == NULL) {
872                 fit_get_debug(fit, noffset, FIT_DATA_PROP, len);
873                 *size = 0;
874                 return -1;
875         }
876
877         *size = len;
878         return 0;
879 }
880
881 /**
882  * Get 'data-offset' property from a given image node.
883  *
884  * @fit: pointer to the FIT image header
885  * @noffset: component image node offset
886  * @data_offset: holds the data-offset property
887  *
888  * returns:
889  *     0, on success
890  *     -ENOENT if the property could not be found
891  */
892 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset)
893 {
894         const fdt32_t *val;
895
896         val = fdt_getprop(fit, noffset, FIT_DATA_OFFSET_PROP, NULL);
897         if (!val)
898                 return -ENOENT;
899
900         *data_offset = fdt32_to_cpu(*val);
901
902         return 0;
903 }
904
905 /**
906  * Get 'data-position' property from a given image node.
907  *
908  * @fit: pointer to the FIT image header
909  * @noffset: component image node offset
910  * @data_position: holds the data-position property
911  *
912  * returns:
913  *     0, on success
914  *     -ENOENT if the property could not be found
915  */
916 int fit_image_get_data_position(const void *fit, int noffset,
917                                 int *data_position)
918 {
919         const fdt32_t *val;
920
921         val = fdt_getprop(fit, noffset, FIT_DATA_POSITION_PROP, NULL);
922         if (!val)
923                 return -ENOENT;
924
925         *data_position = fdt32_to_cpu(*val);
926
927         return 0;
928 }
929
930 /**
931  * Get 'data-size' property from a given image node.
932  *
933  * @fit: pointer to the FIT image header
934  * @noffset: component image node offset
935  * @data_size: holds the data-size property
936  *
937  * returns:
938  *     0, on success
939  *     -ENOENT if the property could not be found
940  */
941 int fit_image_get_data_size(const void *fit, int noffset, int *data_size)
942 {
943         const fdt32_t *val;
944
945         val = fdt_getprop(fit, noffset, FIT_DATA_SIZE_PROP, NULL);
946         if (!val)
947                 return -ENOENT;
948
949         *data_size = fdt32_to_cpu(*val);
950
951         return 0;
952 }
953
954 /**
955  * Get 'data-size-unciphered' property from a given image node.
956  *
957  * @fit: pointer to the FIT image header
958  * @noffset: component image node offset
959  * @data_size: holds the data-size property
960  *
961  * returns:
962  *     0, on success
963  *     -ENOENT if the property could not be found
964  */
965 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
966                                        size_t *data_size)
967 {
968         const fdt32_t *val;
969
970         val = fdt_getprop(fit, noffset, "data-size-unciphered", NULL);
971         if (!val)
972                 return -ENOENT;
973
974         *data_size = (size_t)fdt32_to_cpu(*val);
975
976         return 0;
977 }
978
979 /**
980  * fit_image_get_data_and_size - get data and its size including
981  *                               both embedded and external data
982  * @fit: pointer to the FIT format image header
983  * @noffset: component image node offset
984  * @data: double pointer to void, will hold data property's data address
985  * @size: pointer to size_t, will hold data property's data size
986  *
987  * fit_image_get_data_and_size() finds data and its size including
988  * both embedded and external data. If the property is found
989  * its data start address and size are returned to the caller.
990  *
991  * returns:
992  *     0, on success
993  *     otherwise, on failure
994  */
995 int fit_image_get_data_and_size(const void *fit, int noffset,
996                                 const void **data, size_t *size)
997 {
998         bool external_data = false;
999         int offset;
1000         int len;
1001         int ret;
1002
1003         if (!fit_image_get_data_position(fit, noffset, &offset)) {
1004                 external_data = true;
1005         } else if (!fit_image_get_data_offset(fit, noffset, &offset)) {
1006                 external_data = true;
1007                 /*
1008                  * For FIT with external data, figure out where
1009                  * the external images start. This is the base
1010                  * for the data-offset properties in each image.
1011                  */
1012                 offset += ((fdt_totalsize(fit) + 3) & ~3);
1013         }
1014
1015         if (external_data) {
1016                 debug("External Data\n");
1017                 ret = fit_image_get_data_size(fit, noffset, &len);
1018                 if (!ret) {
1019                         *data = fit + offset;
1020                         *size = len;
1021                 }
1022         } else {
1023                 ret = fit_image_get_data(fit, noffset, data, size);
1024         }
1025
1026         return ret;
1027 }
1028
1029 /**
1030  * fit_image_hash_get_algo - get hash algorithm name
1031  * @fit: pointer to the FIT format image header
1032  * @noffset: hash node offset
1033  * @algo: double pointer to char, will hold pointer to the algorithm name
1034  *
1035  * fit_image_hash_get_algo() finds hash algorithm property in a given hash node.
1036  * If the property is found its data start address is returned to the caller.
1037  *
1038  * returns:
1039  *     0, on success
1040  *     -1, on failure
1041  */
1042 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo)
1043 {
1044         int len;
1045
1046         *algo = (char *)fdt_getprop(fit, noffset, FIT_ALGO_PROP, &len);
1047         if (*algo == NULL) {
1048                 fit_get_debug(fit, noffset, FIT_ALGO_PROP, len);
1049                 return -1;
1050         }
1051
1052         return 0;
1053 }
1054
1055 /**
1056  * fit_image_hash_get_value - get hash value and length
1057  * @fit: pointer to the FIT format image header
1058  * @noffset: hash node offset
1059  * @value: double pointer to uint8_t, will hold address of a hash value data
1060  * @value_len: pointer to an int, will hold hash data length
1061  *
1062  * fit_image_hash_get_value() finds hash value property in a given hash node.
1063  * If the property is found its data start address and size are returned to
1064  * the caller.
1065  *
1066  * returns:
1067  *     0, on success
1068  *     -1, on failure
1069  */
1070 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1071                                 int *value_len)
1072 {
1073         int len;
1074
1075         *value = (uint8_t *)fdt_getprop(fit, noffset, FIT_VALUE_PROP, &len);
1076         if (*value == NULL) {
1077                 fit_get_debug(fit, noffset, FIT_VALUE_PROP, len);
1078                 *value_len = 0;
1079                 return -1;
1080         }
1081
1082         *value_len = len;
1083         return 0;
1084 }
1085
1086 /**
1087  * fit_image_hash_get_ignore - get hash ignore flag
1088  * @fit: pointer to the FIT format image header
1089  * @noffset: hash node offset
1090  * @ignore: pointer to an int, will hold hash ignore flag
1091  *
1092  * fit_image_hash_get_ignore() finds hash ignore property in a given hash node.
1093  * If the property is found and non-zero, the hash algorithm is not verified by
1094  * u-boot automatically.
1095  *
1096  * returns:
1097  *     0, on ignore not found
1098  *     value, on ignore found
1099  */
1100 static int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore)
1101 {
1102         int len;
1103         int *value;
1104
1105         value = (int *)fdt_getprop(fit, noffset, FIT_IGNORE_PROP, &len);
1106         if (value == NULL || len != sizeof(int))
1107                 *ignore = 0;
1108         else
1109                 *ignore = *value;
1110
1111         return 0;
1112 }
1113
1114 /**
1115  * fit_image_cipher_get_algo - get cipher algorithm name
1116  * @fit: pointer to the FIT format image header
1117  * @noffset: cipher node offset
1118  * @algo: double pointer to char, will hold pointer to the algorithm name
1119  *
1120  * fit_image_cipher_get_algo() finds cipher algorithm property in a given
1121  * cipher node. If the property is found its data start address is returned
1122  * to the caller.
1123  *
1124  * returns:
1125  *     0, on success
1126  *     -1, on failure
1127  */
1128 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo)
1129 {
1130         int len;
1131
1132         *algo = (char *)fdt_getprop(fit, noffset, FIT_ALGO_PROP, &len);
1133         if (!*algo) {
1134                 fit_get_debug(fit, noffset, FIT_ALGO_PROP, len);
1135                 return -1;
1136         }
1137
1138         return 0;
1139 }
1140
1141 ulong fit_get_end(const void *fit)
1142 {
1143         return map_to_sysmem((void *)(fit + fdt_totalsize(fit)));
1144 }
1145
1146 /**
1147  * fit_set_timestamp - set node timestamp property
1148  * @fit: pointer to the FIT format image header
1149  * @noffset: node offset
1150  * @timestamp: timestamp value to be set
1151  *
1152  * fit_set_timestamp() attempts to set timestamp property in the requested
1153  * node and returns operation status to the caller.
1154  *
1155  * returns:
1156  *     0, on success
1157  *     -ENOSPC if no space in device tree, -1 for other error
1158  */
1159 int fit_set_timestamp(void *fit, int noffset, time_t timestamp)
1160 {
1161         uint32_t t;
1162         int ret;
1163
1164         t = cpu_to_uimage(timestamp);
1165         ret = fdt_setprop(fit, noffset, FIT_TIMESTAMP_PROP, &t,
1166                                 sizeof(uint32_t));
1167         if (ret) {
1168                 debug("Can't set '%s' property for '%s' node (%s)\n",
1169                       FIT_TIMESTAMP_PROP, fit_get_name(fit, noffset, NULL),
1170                       fdt_strerror(ret));
1171                 return ret == -FDT_ERR_NOSPACE ? -ENOSPC : -1;
1172         }
1173
1174         return 0;
1175 }
1176
1177 /**
1178  * calculate_hash - calculate and return hash for provided input data
1179  * @data: pointer to the input data
1180  * @data_len: data length
1181  * @algo: requested hash algorithm
1182  * @value: pointer to the char, will hold hash value data (caller must
1183  * allocate enough free space)
1184  * value_len: length of the calculated hash
1185  *
1186  * calculate_hash() computes input data hash according to the requested
1187  * algorithm.
1188  * Resulting hash value is placed in caller provided 'value' buffer, length
1189  * of the calculated hash is returned via value_len pointer argument.
1190  *
1191  * returns:
1192  *     0, on success
1193  *    -1, when algo is unsupported
1194  */
1195 int calculate_hash(const void *data, int data_len, const char *algo,
1196                         uint8_t *value, int *value_len)
1197 {
1198         if (IMAGE_ENABLE_CRC32 && strcmp(algo, "crc32") == 0) {
1199                 *((uint32_t *)value) = crc32_wd(0, data, data_len,
1200                                                         CHUNKSZ_CRC32);
1201                 *((uint32_t *)value) = cpu_to_uimage(*((uint32_t *)value));
1202                 *value_len = 4;
1203         } else if (IMAGE_ENABLE_SHA1 && strcmp(algo, "sha1") == 0) {
1204                 sha1_csum_wd((unsigned char *)data, data_len,
1205                              (unsigned char *)value, CHUNKSZ_SHA1);
1206                 *value_len = 20;
1207         } else if (IMAGE_ENABLE_SHA256 && strcmp(algo, "sha256") == 0) {
1208                 sha256_csum_wd((unsigned char *)data, data_len,
1209                                (unsigned char *)value, CHUNKSZ_SHA256);
1210                 *value_len = SHA256_SUM_LEN;
1211         } else if (IMAGE_ENABLE_SHA384 && strcmp(algo, "sha384") == 0) {
1212                 sha384_csum_wd((unsigned char *)data, data_len,
1213                                (unsigned char *)value, CHUNKSZ_SHA384);
1214                 *value_len = SHA384_SUM_LEN;
1215         } else if (IMAGE_ENABLE_SHA512 && strcmp(algo, "sha512") == 0) {
1216                 sha512_csum_wd((unsigned char *)data, data_len,
1217                                (unsigned char *)value, CHUNKSZ_SHA512);
1218                 *value_len = SHA512_SUM_LEN;
1219         } else if (IMAGE_ENABLE_MD5 && strcmp(algo, "md5") == 0) {
1220                 md5_wd((unsigned char *)data, data_len, value, CHUNKSZ_MD5);
1221                 *value_len = 16;
1222         } else {
1223                 debug("Unsupported hash alogrithm\n");
1224                 return -1;
1225         }
1226         return 0;
1227 }
1228
1229 static int fit_image_check_hash(const void *fit, int noffset, const void *data,
1230                                 size_t size, char **err_msgp)
1231 {
1232         uint8_t value[FIT_MAX_HASH_LEN];
1233         int value_len;
1234         char *algo;
1235         uint8_t *fit_value;
1236         int fit_value_len;
1237         int ignore;
1238
1239         *err_msgp = NULL;
1240
1241         if (fit_image_hash_get_algo(fit, noffset, &algo)) {
1242                 *err_msgp = "Can't get hash algo property";
1243                 return -1;
1244         }
1245         printf("%s", algo);
1246
1247         if (IMAGE_ENABLE_IGNORE) {
1248                 fit_image_hash_get_ignore(fit, noffset, &ignore);
1249                 if (ignore) {
1250                         printf("-skipped ");
1251                         return 0;
1252                 }
1253         }
1254
1255         if (fit_image_hash_get_value(fit, noffset, &fit_value,
1256                                      &fit_value_len)) {
1257                 *err_msgp = "Can't get hash value property";
1258                 return -1;
1259         }
1260
1261         if (calculate_hash(data, size, algo, value, &value_len)) {
1262                 *err_msgp = "Unsupported hash algorithm";
1263                 return -1;
1264         }
1265
1266         if (value_len != fit_value_len) {
1267                 *err_msgp = "Bad hash value len";
1268                 return -1;
1269         } else if (memcmp(value, fit_value, value_len) != 0) {
1270                 *err_msgp = "Bad hash value";
1271                 return -1;
1272         }
1273
1274         return 0;
1275 }
1276
1277 int fit_image_verify_with_data(const void *fit, int image_noffset,
1278                                const void *data, size_t size)
1279 {
1280         int             noffset = 0;
1281         char            *err_msg = "";
1282         int verify_all = 1;
1283         int ret;
1284
1285         /* Verify all required signatures */
1286         if (FIT_IMAGE_ENABLE_VERIFY &&
1287             fit_image_verify_required_sigs(fit, image_noffset, data, size,
1288                                            gd_fdt_blob(), &verify_all)) {
1289                 err_msg = "Unable to verify required signature";
1290                 goto error;
1291         }
1292
1293         /* Process all hash subnodes of the component image node */
1294         fdt_for_each_subnode(noffset, fit, image_noffset) {
1295                 const char *name = fit_get_name(fit, noffset, NULL);
1296
1297                 /*
1298                  * Check subnode name, must be equal to "hash".
1299                  * Multiple hash nodes require unique unit node
1300                  * names, e.g. hash-1, hash-2, etc.
1301                  */
1302                 if (!strncmp(name, FIT_HASH_NODENAME,
1303                              strlen(FIT_HASH_NODENAME))) {
1304                         if (fit_image_check_hash(fit, noffset, data, size,
1305                                                  &err_msg))
1306                                 goto error;
1307                         puts("+ ");
1308                 } else if (FIT_IMAGE_ENABLE_VERIFY && verify_all &&
1309                                 !strncmp(name, FIT_SIG_NODENAME,
1310                                         strlen(FIT_SIG_NODENAME))) {
1311                         ret = fit_image_check_sig(fit, noffset, data,
1312                                                         size, -1, &err_msg);
1313
1314                         /*
1315                          * Show an indication on failure, but do not return
1316                          * an error. Only keys marked 'required' can cause
1317                          * an image validation failure. See the call to
1318                          * fit_image_verify_required_sigs() above.
1319                          */
1320                         if (ret)
1321                                 puts("- ");
1322                         else
1323                                 puts("+ ");
1324                 }
1325         }
1326
1327         if (noffset == -FDT_ERR_TRUNCATED || noffset == -FDT_ERR_BADSTRUCTURE) {
1328                 err_msg = "Corrupted or truncated tree";
1329                 goto error;
1330         }
1331
1332         return 1;
1333
1334 error:
1335         printf(" error!\n%s for '%s' hash node in '%s' image node\n",
1336                err_msg, fit_get_name(fit, noffset, NULL),
1337                fit_get_name(fit, image_noffset, NULL));
1338         return 0;
1339 }
1340
1341 /**
1342  * fit_image_verify - verify data integrity
1343  * @fit: pointer to the FIT format image header
1344  * @image_noffset: component image node offset
1345  *
1346  * fit_image_verify() goes over component image hash nodes,
1347  * re-calculates each data hash and compares with the value stored in hash
1348  * node.
1349  *
1350  * returns:
1351  *     1, if all hashes are valid
1352  *     0, otherwise (or on error)
1353  */
1354 int fit_image_verify(const void *fit, int image_noffset)
1355 {
1356         const void      *data;
1357         size_t          size;
1358         int             noffset = 0;
1359         char            *err_msg = "";
1360
1361         /* Get image data and data length */
1362         if (fit_image_get_data_and_size(fit, image_noffset, &data, &size)) {
1363                 err_msg = "Can't get image data/size";
1364                 printf("error!\n%s for '%s' hash node in '%s' image node\n",
1365                        err_msg, fit_get_name(fit, noffset, NULL),
1366                        fit_get_name(fit, image_noffset, NULL));
1367                 return 0;
1368         }
1369
1370         return fit_image_verify_with_data(fit, image_noffset, data, size);
1371 }
1372
1373 /**
1374  * fit_all_image_verify - verify data integrity for all images
1375  * @fit: pointer to the FIT format image header
1376  *
1377  * fit_all_image_verify() goes over all images in the FIT and
1378  * for every images checks if all it's hashes are valid.
1379  *
1380  * returns:
1381  *     1, if all hashes of all images are valid
1382  *     0, otherwise (or on error)
1383  */
1384 int fit_all_image_verify(const void *fit)
1385 {
1386         int images_noffset;
1387         int noffset;
1388         int ndepth;
1389         int count;
1390
1391         /* Find images parent node offset */
1392         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1393         if (images_noffset < 0) {
1394                 printf("Can't find images parent node '%s' (%s)\n",
1395                        FIT_IMAGES_PATH, fdt_strerror(images_noffset));
1396                 return 0;
1397         }
1398
1399         /* Process all image subnodes, check hashes for each */
1400         printf("## Checking hash(es) for FIT Image at %08lx ...\n",
1401                (ulong)fit);
1402         for (ndepth = 0, count = 0,
1403              noffset = fdt_next_node(fit, images_noffset, &ndepth);
1404                         (noffset >= 0) && (ndepth > 0);
1405                         noffset = fdt_next_node(fit, noffset, &ndepth)) {
1406                 if (ndepth == 1) {
1407                         /*
1408                          * Direct child node of the images parent node,
1409                          * i.e. component image node.
1410                          */
1411                         printf("   Hash(es) for Image %u (%s): ", count,
1412                                fit_get_name(fit, noffset, NULL));
1413                         count++;
1414
1415                         if (!fit_image_verify(fit, noffset))
1416                                 return 0;
1417                         printf("\n");
1418                 }
1419         }
1420         return 1;
1421 }
1422
1423 static int fit_image_uncipher(const void *fit, int image_noffset,
1424                               void **data, size_t *size)
1425 {
1426         int cipher_noffset, ret;
1427         void *dst;
1428         size_t size_dst;
1429
1430         cipher_noffset = fdt_subnode_offset(fit, image_noffset,
1431                                             FIT_CIPHER_NODENAME);
1432         if (cipher_noffset < 0)
1433                 return 0;
1434
1435         ret = fit_image_decrypt_data(fit, image_noffset, cipher_noffset,
1436                                      *data, *size, &dst, &size_dst);
1437         if (ret)
1438                 goto out;
1439
1440         *data = dst;
1441         *size = size_dst;
1442
1443  out:
1444         return ret;
1445 }
1446
1447 /**
1448  * fit_image_check_os - check whether image node is of a given os type
1449  * @fit: pointer to the FIT format image header
1450  * @noffset: component image node offset
1451  * @os: requested image os
1452  *
1453  * fit_image_check_os() reads image os property and compares its numeric
1454  * id with the requested os. Comparison result is returned to the caller.
1455  *
1456  * returns:
1457  *     1 if image is of given os type
1458  *     0 otherwise (or on error)
1459  */
1460 int fit_image_check_os(const void *fit, int noffset, uint8_t os)
1461 {
1462         uint8_t image_os;
1463
1464         if (fit_image_get_os(fit, noffset, &image_os))
1465                 return 0;
1466         return (os == image_os);
1467 }
1468
1469 /**
1470  * fit_image_check_arch - check whether image node is of a given arch
1471  * @fit: pointer to the FIT format image header
1472  * @noffset: component image node offset
1473  * @arch: requested imagearch
1474  *
1475  * fit_image_check_arch() reads image arch property and compares its numeric
1476  * id with the requested arch. Comparison result is returned to the caller.
1477  *
1478  * returns:
1479  *     1 if image is of given arch
1480  *     0 otherwise (or on error)
1481  */
1482 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch)
1483 {
1484         uint8_t image_arch;
1485         int aarch32_support = 0;
1486
1487         if (IS_ENABLED(CONFIG_ARM64_SUPPORT_AARCH32))
1488                 aarch32_support = 1;
1489
1490         if (fit_image_get_arch(fit, noffset, &image_arch))
1491                 return 0;
1492         return (arch == image_arch) ||
1493                 (arch == IH_ARCH_I386 && image_arch == IH_ARCH_X86_64) ||
1494                 (arch == IH_ARCH_ARM64 && image_arch == IH_ARCH_ARM &&
1495                  aarch32_support);
1496 }
1497
1498 /**
1499  * fit_image_check_type - check whether image node is of a given type
1500  * @fit: pointer to the FIT format image header
1501  * @noffset: component image node offset
1502  * @type: requested image type
1503  *
1504  * fit_image_check_type() reads image type property and compares its numeric
1505  * id with the requested type. Comparison result is returned to the caller.
1506  *
1507  * returns:
1508  *     1 if image is of given type
1509  *     0 otherwise (or on error)
1510  */
1511 int fit_image_check_type(const void *fit, int noffset, uint8_t type)
1512 {
1513         uint8_t image_type;
1514
1515         if (fit_image_get_type(fit, noffset, &image_type))
1516                 return 0;
1517         return (type == image_type);
1518 }
1519
1520 /**
1521  * fit_image_check_comp - check whether image node uses given compression
1522  * @fit: pointer to the FIT format image header
1523  * @noffset: component image node offset
1524  * @comp: requested image compression type
1525  *
1526  * fit_image_check_comp() reads image compression property and compares its
1527  * numeric id with the requested compression type. Comparison result is
1528  * returned to the caller.
1529  *
1530  * returns:
1531  *     1 if image uses requested compression
1532  *     0 otherwise (or on error)
1533  */
1534 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp)
1535 {
1536         uint8_t image_comp;
1537
1538         if (fit_image_get_comp(fit, noffset, &image_comp))
1539                 return 0;
1540         return (comp == image_comp);
1541 }
1542
1543 /**
1544  * fit_check_format - sanity check FIT image format
1545  * @fit: pointer to the FIT format image header
1546  *
1547  * fit_check_format() runs a basic sanity FIT image verification.
1548  * Routine checks for mandatory properties, nodes, etc.
1549  *
1550  * returns:
1551  *     1, on success
1552  *     0, on failure
1553  */
1554 int fit_check_format(const void *fit)
1555 {
1556         /* mandatory / node 'description' property */
1557         if (fdt_getprop(fit, 0, FIT_DESC_PROP, NULL) == NULL) {
1558                 debug("Wrong FIT format: no description\n");
1559                 return 0;
1560         }
1561
1562         if (IMAGE_ENABLE_TIMESTAMP) {
1563                 /* mandatory / node 'timestamp' property */
1564                 if (fdt_getprop(fit, 0, FIT_TIMESTAMP_PROP, NULL) == NULL) {
1565                         debug("Wrong FIT format: no timestamp\n");
1566                         return 0;
1567                 }
1568         }
1569
1570         /* mandatory subimages parent '/images' node */
1571         if (fdt_path_offset(fit, FIT_IMAGES_PATH) < 0) {
1572                 debug("Wrong FIT format: no images parent node\n");
1573                 return 0;
1574         }
1575
1576         return 1;
1577 }
1578
1579
1580 /**
1581  * fit_conf_find_compat
1582  * @fit: pointer to the FIT format image header
1583  * @fdt: pointer to the device tree to compare against
1584  *
1585  * fit_conf_find_compat() attempts to find the configuration whose fdt is the
1586  * most compatible with the passed in device tree.
1587  *
1588  * Example:
1589  *
1590  * / o image-tree
1591  *   |-o images
1592  *   | |-o fdt-1
1593  *   | |-o fdt-2
1594  *   |
1595  *   |-o configurations
1596  *     |-o config-1
1597  *     | |-fdt = fdt-1
1598  *     |
1599  *     |-o config-2
1600  *       |-fdt = fdt-2
1601  *
1602  * / o U-Boot fdt
1603  *   |-compatible = "foo,bar", "bim,bam"
1604  *
1605  * / o kernel fdt1
1606  *   |-compatible = "foo,bar",
1607  *
1608  * / o kernel fdt2
1609  *   |-compatible = "bim,bam", "baz,biz"
1610  *
1611  * Configuration 1 would be picked because the first string in U-Boot's
1612  * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
1613  * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
1614  *
1615  * As an optimization, the compatible property from the FDT's root node can be
1616  * copied into the configuration node in the FIT image. This is required to
1617  * match configurations with compressed FDTs.
1618  *
1619  * returns:
1620  *     offset to the configuration to use if one was found
1621  *     -1 otherwise
1622  */
1623 int fit_conf_find_compat(const void *fit, const void *fdt)
1624 {
1625         int ndepth = 0;
1626         int noffset, confs_noffset, images_noffset;
1627         const void *fdt_compat;
1628         int fdt_compat_len;
1629         int best_match_offset = 0;
1630         int best_match_pos = 0;
1631
1632         confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1633         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1634         if (confs_noffset < 0 || images_noffset < 0) {
1635                 debug("Can't find configurations or images nodes.\n");
1636                 return -1;
1637         }
1638
1639         fdt_compat = fdt_getprop(fdt, 0, "compatible", &fdt_compat_len);
1640         if (!fdt_compat) {
1641                 debug("Fdt for comparison has no \"compatible\" property.\n");
1642                 return -1;
1643         }
1644
1645         /*
1646          * Loop over the configurations in the FIT image.
1647          */
1648         for (noffset = fdt_next_node(fit, confs_noffset, &ndepth);
1649                         (noffset >= 0) && (ndepth > 0);
1650                         noffset = fdt_next_node(fit, noffset, &ndepth)) {
1651                 const void *fdt;
1652                 const char *kfdt_name;
1653                 int kfdt_noffset, compat_noffset;
1654                 const char *cur_fdt_compat;
1655                 int len;
1656                 size_t sz;
1657                 int i;
1658
1659                 if (ndepth > 1)
1660                         continue;
1661
1662                 /* If there's a compat property in the config node, use that. */
1663                 if (fdt_getprop(fit, noffset, "compatible", NULL)) {
1664                         fdt = fit;                /* search in FIT image */
1665                         compat_noffset = noffset; /* search under config node */
1666                 } else {        /* Otherwise extract it from the kernel FDT. */
1667                         kfdt_name = fdt_getprop(fit, noffset, "fdt", &len);
1668                         if (!kfdt_name) {
1669                                 debug("No fdt property found.\n");
1670                                 continue;
1671                         }
1672                         kfdt_noffset = fdt_subnode_offset(fit, images_noffset,
1673                                                           kfdt_name);
1674                         if (kfdt_noffset < 0) {
1675                                 debug("No image node named \"%s\" found.\n",
1676                                       kfdt_name);
1677                                 continue;
1678                         }
1679
1680                         if (!fit_image_check_comp(fit, kfdt_noffset,
1681                                                   IH_COMP_NONE)) {
1682                                 debug("Can't extract compat from \"%s\" "
1683                                       "(compressed)\n", kfdt_name);
1684                                 continue;
1685                         }
1686
1687                         /* search in this config's kernel FDT */
1688                         if (fit_image_get_data(fit, kfdt_noffset, &fdt, &sz)) {
1689                                 debug("Failed to get fdt \"%s\".\n", kfdt_name);
1690                                 continue;
1691                         }
1692
1693                         compat_noffset = 0;  /* search kFDT under root node */
1694                 }
1695
1696                 len = fdt_compat_len;
1697                 cur_fdt_compat = fdt_compat;
1698                 /*
1699                  * Look for a match for each U-Boot compatibility string in
1700                  * turn in the compat string property.
1701                  */
1702                 for (i = 0; len > 0 &&
1703                      (!best_match_offset || best_match_pos > i); i++) {
1704                         int cur_len = strlen(cur_fdt_compat) + 1;
1705
1706                         if (!fdt_node_check_compatible(fdt, compat_noffset,
1707                                                        cur_fdt_compat)) {
1708                                 best_match_offset = noffset;
1709                                 best_match_pos = i;
1710                                 break;
1711                         }
1712                         len -= cur_len;
1713                         cur_fdt_compat += cur_len;
1714                 }
1715         }
1716         if (!best_match_offset) {
1717                 debug("No match found.\n");
1718                 return -1;
1719         }
1720
1721         return best_match_offset;
1722 }
1723
1724 int fit_conf_get_node(const void *fit, const char *conf_uname)
1725 {
1726         int noffset, confs_noffset;
1727         int len;
1728         const char *s;
1729         char *conf_uname_copy = NULL;
1730
1731         confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1732         if (confs_noffset < 0) {
1733                 debug("Can't find configurations parent node '%s' (%s)\n",
1734                       FIT_CONFS_PATH, fdt_strerror(confs_noffset));
1735                 return confs_noffset;
1736         }
1737
1738         if (conf_uname == NULL) {
1739                 /* get configuration unit name from the default property */
1740                 debug("No configuration specified, trying default...\n");
1741                 if (!host_build() && IS_ENABLED(CONFIG_MULTI_DTB_FIT)) {
1742                         noffset = fit_find_config_node(fit);
1743                         if (noffset < 0)
1744                                 return noffset;
1745                         conf_uname = fdt_get_name(fit, noffset, NULL);
1746                 } else {
1747                         conf_uname = (char *)fdt_getprop(fit, confs_noffset,
1748                                                          FIT_DEFAULT_PROP, &len);
1749                         if (conf_uname == NULL) {
1750                                 fit_get_debug(fit, confs_noffset, FIT_DEFAULT_PROP,
1751                                               len);
1752                                 return len;
1753                         }
1754                 }
1755                 debug("Found default configuration: '%s'\n", conf_uname);
1756         }
1757
1758         s = strchr(conf_uname, '#');
1759         if (s) {
1760                 len = s - conf_uname;
1761                 conf_uname_copy = malloc(len + 1);
1762                 if (!conf_uname_copy) {
1763                         debug("Can't allocate uname copy: '%s'\n",
1764                                         conf_uname);
1765                         return -ENOMEM;
1766                 }
1767                 memcpy(conf_uname_copy, conf_uname, len);
1768                 conf_uname_copy[len] = '\0';
1769                 conf_uname = conf_uname_copy;
1770         }
1771
1772         noffset = fdt_subnode_offset(fit, confs_noffset, conf_uname);
1773         if (noffset < 0) {
1774                 debug("Can't get node offset for configuration unit name: '%s' (%s)\n",
1775                       conf_uname, fdt_strerror(noffset));
1776         }
1777
1778         if (conf_uname_copy)
1779                 free(conf_uname_copy);
1780
1781         return noffset;
1782 }
1783
1784 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1785                 const char *prop_name)
1786 {
1787         return fdt_stringlist_count(fit, noffset, prop_name);
1788 }
1789
1790 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1791                 const char *prop_name, int index)
1792 {
1793         const char *uname;
1794         int len;
1795
1796         /* get kernel image unit name from configuration kernel property */
1797         uname = fdt_stringlist_get(fit, noffset, prop_name, index, &len);
1798         if (uname == NULL)
1799                 return len;
1800
1801         return fit_image_get_node(fit, uname);
1802 }
1803
1804 int fit_conf_get_prop_node(const void *fit, int noffset,
1805                 const char *prop_name)
1806 {
1807         return fit_conf_get_prop_node_index(fit, noffset, prop_name, 0);
1808 }
1809
1810 static int fit_image_select(const void *fit, int rd_noffset, int verify)
1811 {
1812         fit_image_print(fit, rd_noffset, "   ");
1813
1814         if (verify) {
1815                 puts("   Verifying Hash Integrity ... ");
1816                 if (!fit_image_verify(fit, rd_noffset)) {
1817                         puts("Bad Data Hash\n");
1818                         return -EACCES;
1819                 }
1820                 puts("OK\n");
1821         }
1822
1823         return 0;
1824 }
1825
1826 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
1827                         ulong addr)
1828 {
1829         int cfg_noffset;
1830         void *fit_hdr;
1831         int noffset;
1832
1833         debug("*  %s: using config '%s' from image at 0x%08lx\n",
1834               prop_name, images->fit_uname_cfg, addr);
1835
1836         /* Check whether configuration has this property defined */
1837         fit_hdr = map_sysmem(addr, 0);
1838         cfg_noffset = fit_conf_get_node(fit_hdr, images->fit_uname_cfg);
1839         if (cfg_noffset < 0) {
1840                 debug("*  %s: no such config\n", prop_name);
1841                 return -EINVAL;
1842         }
1843
1844         noffset = fit_conf_get_prop_node(fit_hdr, cfg_noffset, prop_name);
1845         if (noffset < 0) {
1846                 debug("*  %s: no '%s' in config\n", prop_name, prop_name);
1847                 return -ENOENT;
1848         }
1849
1850         return noffset;
1851 }
1852
1853 /**
1854  * fit_get_image_type_property() - get property name for IH_TYPE_...
1855  *
1856  * @return the properly name where we expect to find the image in the
1857  * config node
1858  */
1859 static const char *fit_get_image_type_property(int type)
1860 {
1861         /*
1862          * This is sort-of available in the uimage_type[] table in image.c
1863          * but we don't have access to the short name, and "fdt" is different
1864          * anyway. So let's just keep it here.
1865          */
1866         switch (type) {
1867         case IH_TYPE_FLATDT:
1868                 return FIT_FDT_PROP;
1869         case IH_TYPE_KERNEL:
1870                 return FIT_KERNEL_PROP;
1871         case IH_TYPE_RAMDISK:
1872                 return FIT_RAMDISK_PROP;
1873         case IH_TYPE_X86_SETUP:
1874                 return FIT_SETUP_PROP;
1875         case IH_TYPE_LOADABLE:
1876                 return FIT_LOADABLE_PROP;
1877         case IH_TYPE_FPGA:
1878                 return FIT_FPGA_PROP;
1879         case IH_TYPE_STANDALONE:
1880                 return FIT_STANDALONE_PROP;
1881         }
1882
1883         return "unknown";
1884 }
1885
1886 int fit_image_load(bootm_headers_t *images, ulong addr,
1887                    const char **fit_unamep, const char **fit_uname_configp,
1888                    int arch, int image_type, int bootstage_id,
1889                    enum fit_load_op load_op, ulong *datap, ulong *lenp)
1890 {
1891         int cfg_noffset, noffset;
1892         const char *fit_uname;
1893         const char *fit_uname_config;
1894         const char *fit_base_uname_config;
1895         const void *fit;
1896         void *buf;
1897         void *loadbuf;
1898         size_t size;
1899         int type_ok, os_ok;
1900         ulong load, load_end, data, len;
1901         uint8_t os, comp;
1902 #ifndef USE_HOSTCC
1903         uint8_t os_arch;
1904 #endif
1905         const char *prop_name;
1906         int ret;
1907
1908         fit = map_sysmem(addr, 0);
1909         fit_uname = fit_unamep ? *fit_unamep : NULL;
1910         fit_uname_config = fit_uname_configp ? *fit_uname_configp : NULL;
1911         fit_base_uname_config = NULL;
1912         prop_name = fit_get_image_type_property(image_type);
1913         printf("## Loading %s from FIT Image at %08lx ...\n", prop_name, addr);
1914
1915         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_FORMAT);
1916         if (!fit_check_format(fit)) {
1917                 printf("Bad FIT %s image format!\n", prop_name);
1918                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_FORMAT);
1919                 return -ENOEXEC;
1920         }
1921         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_FORMAT_OK);
1922         if (fit_uname) {
1923                 /* get FIT component image node offset */
1924                 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_UNIT_NAME);
1925                 noffset = fit_image_get_node(fit, fit_uname);
1926         } else {
1927                 /*
1928                  * no image node unit name, try to get config
1929                  * node first. If config unit node name is NULL
1930                  * fit_conf_get_node() will try to find default config node
1931                  */
1932                 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_NO_UNIT_NAME);
1933                 if (IMAGE_ENABLE_BEST_MATCH && !fit_uname_config) {
1934                         cfg_noffset = fit_conf_find_compat(fit, gd_fdt_blob());
1935                 } else {
1936                         cfg_noffset = fit_conf_get_node(fit,
1937                                                         fit_uname_config);
1938                 }
1939                 if (cfg_noffset < 0) {
1940                         puts("Could not find configuration node\n");
1941                         bootstage_error(bootstage_id +
1942                                         BOOTSTAGE_SUB_NO_UNIT_NAME);
1943                         return -ENOENT;
1944                 }
1945
1946                 fit_base_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
1947                 printf("   Using '%s' configuration\n", fit_base_uname_config);
1948                 /* Remember this config */
1949                 if (image_type == IH_TYPE_KERNEL)
1950                         images->fit_uname_cfg = fit_base_uname_config;
1951
1952                 if (FIT_IMAGE_ENABLE_VERIFY && images->verify) {
1953                         puts("   Verifying Hash Integrity ... ");
1954                         if (fit_config_verify(fit, cfg_noffset)) {
1955                                 puts("Bad Data Hash\n");
1956                                 bootstage_error(bootstage_id +
1957                                         BOOTSTAGE_SUB_HASH);
1958                                 return -EACCES;
1959                         }
1960                         puts("OK\n");
1961                 }
1962
1963                 bootstage_mark(BOOTSTAGE_ID_FIT_CONFIG);
1964
1965                 noffset = fit_conf_get_prop_node(fit, cfg_noffset,
1966                                                  prop_name);
1967                 fit_uname = fit_get_name(fit, noffset, NULL);
1968         }
1969         if (noffset < 0) {
1970                 printf("Could not find subimage node type '%s'\n", prop_name);
1971                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_SUBNODE);
1972                 return -ENOENT;
1973         }
1974
1975         printf("   Trying '%s' %s subimage\n", fit_uname, prop_name);
1976
1977         ret = fit_image_select(fit, noffset, images->verify);
1978         if (ret) {
1979                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_HASH);
1980                 return ret;
1981         }
1982
1983         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ARCH);
1984         if (!host_build() && IS_ENABLED(CONFIG_SANDBOX)) {
1985                 if (!fit_image_check_target_arch(fit, noffset)) {
1986                         puts("Unsupported Architecture\n");
1987                         bootstage_error(bootstage_id + BOOTSTAGE_SUB_CHECK_ARCH);
1988                         return -ENOEXEC;
1989                 }
1990         }
1991
1992 #ifndef USE_HOSTCC
1993         fit_image_get_arch(fit, noffset, &os_arch);
1994         images->os.arch = os_arch;
1995 #endif
1996
1997         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL);
1998         type_ok = fit_image_check_type(fit, noffset, image_type) ||
1999                   fit_image_check_type(fit, noffset, IH_TYPE_FIRMWARE) ||
2000                   (image_type == IH_TYPE_KERNEL &&
2001                    fit_image_check_type(fit, noffset, IH_TYPE_KERNEL_NOLOAD));
2002
2003         os_ok = image_type == IH_TYPE_FLATDT ||
2004                 image_type == IH_TYPE_FPGA ||
2005                 fit_image_check_os(fit, noffset, IH_OS_LINUX) ||
2006                 fit_image_check_os(fit, noffset, IH_OS_U_BOOT) ||
2007                 fit_image_check_os(fit, noffset, IH_OS_OPENRTOS) ||
2008                 fit_image_check_os(fit, noffset, IH_OS_EFI) ||
2009                 fit_image_check_os(fit, noffset, IH_OS_VXWORKS);
2010
2011         /*
2012          * If either of the checks fail, we should report an error, but
2013          * if the image type is coming from the "loadables" field, we
2014          * don't care what it is
2015          */
2016         if ((!type_ok || !os_ok) && image_type != IH_TYPE_LOADABLE) {
2017                 fit_image_get_os(fit, noffset, &os);
2018                 printf("No %s %s %s Image\n",
2019                        genimg_get_os_name(os),
2020                        genimg_get_arch_name(arch),
2021                        genimg_get_type_name(image_type));
2022                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL);
2023                 return -EIO;
2024         }
2025
2026         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL_OK);
2027
2028         /* get image data address and length */
2029         if (fit_image_get_data_and_size(fit, noffset,
2030                                         (const void **)&buf, &size)) {
2031                 printf("Could not find %s subimage data!\n", prop_name);
2032                 bootstage_error(bootstage_id + BOOTSTAGE_SUB_GET_DATA);
2033                 return -ENOENT;
2034         }
2035
2036         /* Decrypt data before uncompress/move */
2037         if (IS_ENABLED(CONFIG_FIT_CIPHER) && IMAGE_ENABLE_DECRYPT) {
2038                 puts("   Decrypting Data ... ");
2039                 if (fit_image_uncipher(fit, noffset, &buf, &size)) {
2040                         puts("Error\n");
2041                         return -EACCES;
2042                 }
2043                 puts("OK\n");
2044         }
2045
2046         /* perform any post-processing on the image data */
2047         if (!host_build() && IS_ENABLED(CONFIG_FIT_IMAGE_POST_PROCESS))
2048                 board_fit_image_post_process(&buf, &size);
2049
2050         len = (ulong)size;
2051
2052         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_GET_DATA_OK);
2053
2054         data = map_to_sysmem(buf);
2055         load = data;
2056         if (load_op == FIT_LOAD_IGNORED) {
2057                 /* Don't load */
2058         } else if (fit_image_get_load(fit, noffset, &load)) {
2059                 if (load_op == FIT_LOAD_REQUIRED) {
2060                         printf("Can't get %s subimage load address!\n",
2061                                prop_name);
2062                         bootstage_error(bootstage_id + BOOTSTAGE_SUB_LOAD);
2063                         return -EBADF;
2064                 }
2065         } else if (load_op != FIT_LOAD_OPTIONAL_NON_ZERO || load) {
2066                 ulong image_start, image_end;
2067
2068                 /*
2069                  * move image data to the load address,
2070                  * make sure we don't overwrite initial image
2071                  */
2072                 image_start = addr;
2073                 image_end = addr + fit_get_size(fit);
2074
2075                 load_end = load + len;
2076                 if (image_type != IH_TYPE_KERNEL &&
2077                     load < image_end && load_end > image_start) {
2078                         printf("Error: %s overwritten\n", prop_name);
2079                         return -EXDEV;
2080                 }
2081
2082                 printf("   Loading %s from 0x%08lx to 0x%08lx\n",
2083                        prop_name, data, load);
2084         } else {
2085                 load = data;    /* No load address specified */
2086         }
2087
2088         comp = IH_COMP_NONE;
2089         loadbuf = buf;
2090         /* Kernel images get decompressed later in bootm_load_os(). */
2091         if (!fit_image_get_comp(fit, noffset, &comp) &&
2092             comp != IH_COMP_NONE &&
2093             !(image_type == IH_TYPE_KERNEL ||
2094               image_type == IH_TYPE_KERNEL_NOLOAD ||
2095               image_type == IH_TYPE_RAMDISK)) {
2096                 ulong max_decomp_len = len * 20;
2097                 if (load == data) {
2098                         loadbuf = malloc(max_decomp_len);
2099                         load = map_to_sysmem(loadbuf);
2100                 } else {
2101                         loadbuf = map_sysmem(load, max_decomp_len);
2102                 }
2103                 if (image_decomp(comp, load, data, image_type,
2104                                 loadbuf, buf, len, max_decomp_len, &load_end)) {
2105                         printf("Error decompressing %s\n", prop_name);
2106
2107                         return -ENOEXEC;
2108                 }
2109                 len = load_end - load;
2110         } else if (load != data) {
2111                 loadbuf = map_sysmem(load, len);
2112                 memcpy(loadbuf, buf, len);
2113         }
2114
2115         if (image_type == IH_TYPE_RAMDISK && comp != IH_COMP_NONE)
2116                 puts("WARNING: 'compression' nodes for ramdisks are deprecated,"
2117                      " please fix your .its file!\n");
2118
2119         /* verify that image data is a proper FDT blob */
2120         if (image_type == IH_TYPE_FLATDT && fdt_check_header(loadbuf)) {
2121                 puts("Subimage data is not a FDT");
2122                 return -ENOEXEC;
2123         }
2124
2125         bootstage_mark(bootstage_id + BOOTSTAGE_SUB_LOAD);
2126
2127         *datap = load;
2128         *lenp = len;
2129         if (fit_unamep)
2130                 *fit_unamep = (char *)fit_uname;
2131         if (fit_uname_configp)
2132                 *fit_uname_configp = (char *)(fit_uname_config ? :
2133                                               fit_base_uname_config);
2134
2135         return noffset;
2136 }
2137
2138 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
2139                         ulong *setup_start, ulong *setup_len)
2140 {
2141         int noffset;
2142         ulong addr;
2143         ulong len;
2144         int ret;
2145
2146         addr = map_to_sysmem(images->fit_hdr_os);
2147         noffset = fit_get_node_from_config(images, FIT_SETUP_PROP, addr);
2148         if (noffset < 0)
2149                 return noffset;
2150
2151         ret = fit_image_load(images, addr, NULL, NULL, arch,
2152                              IH_TYPE_X86_SETUP, BOOTSTAGE_ID_FIT_SETUP_START,
2153                              FIT_LOAD_REQUIRED, setup_start, &len);
2154
2155         return ret;
2156 }
2157
2158 #ifndef USE_HOSTCC
2159 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
2160                    const char **fit_unamep, const char **fit_uname_configp,
2161                    int arch, ulong *datap, ulong *lenp)
2162 {
2163         int fdt_noffset, cfg_noffset, count;
2164         const void *fit;
2165         const char *fit_uname = NULL;
2166         const char *fit_uname_config = NULL;
2167         char *fit_uname_config_copy = NULL;
2168         char *next_config = NULL;
2169         ulong load, len;
2170 #ifdef CONFIG_OF_LIBFDT_OVERLAY
2171         ulong image_start, image_end;
2172         ulong ovload, ovlen;
2173         const char *uconfig;
2174         const char *uname;
2175         void *base, *ov;
2176         int i, err, noffset, ov_noffset;
2177 #endif
2178
2179         fit_uname = fit_unamep ? *fit_unamep : NULL;
2180
2181         if (fit_uname_configp && *fit_uname_configp) {
2182                 fit_uname_config_copy = strdup(*fit_uname_configp);
2183                 if (!fit_uname_config_copy)
2184                         return -ENOMEM;
2185
2186                 next_config = strchr(fit_uname_config_copy, '#');
2187                 if (next_config)
2188                         *next_config++ = '\0';
2189                 if (next_config - 1 > fit_uname_config_copy)
2190                         fit_uname_config = fit_uname_config_copy;
2191         }
2192
2193         fdt_noffset = fit_image_load(images,
2194                 addr, &fit_uname, &fit_uname_config,
2195                 arch, IH_TYPE_FLATDT,
2196                 BOOTSTAGE_ID_FIT_FDT_START,
2197                 FIT_LOAD_OPTIONAL, &load, &len);
2198
2199         if (fdt_noffset < 0)
2200                 goto out;
2201
2202         debug("fit_uname=%s, fit_uname_config=%s\n",
2203                         fit_uname ? fit_uname : "<NULL>",
2204                         fit_uname_config ? fit_uname_config : "<NULL>");
2205
2206         fit = map_sysmem(addr, 0);
2207
2208         cfg_noffset = fit_conf_get_node(fit, fit_uname_config);
2209
2210         /* single blob, or error just return as well */
2211         count = fit_conf_get_prop_node_count(fit, cfg_noffset, FIT_FDT_PROP);
2212         if (count <= 1 && !next_config)
2213                 goto out;
2214
2215         /* we need to apply overlays */
2216
2217 #ifdef CONFIG_OF_LIBFDT_OVERLAY
2218         image_start = addr;
2219         image_end = addr + fit_get_size(fit);
2220         /* verify that relocation took place by load address not being in fit */
2221         if (load >= image_start && load < image_end) {
2222                 /* check is simplified; fit load checks for overlaps */
2223                 printf("Overlayed FDT requires relocation\n");
2224                 fdt_noffset = -EBADF;
2225                 goto out;
2226         }
2227
2228         base = map_sysmem(load, len);
2229
2230         /* apply extra configs in FIT first, followed by args */
2231         for (i = 1; ; i++) {
2232                 if (i < count) {
2233                         noffset = fit_conf_get_prop_node_index(fit, cfg_noffset,
2234                                                                FIT_FDT_PROP, i);
2235                         uname = fit_get_name(fit, noffset, NULL);
2236                         uconfig = NULL;
2237                 } else {
2238                         if (!next_config)
2239                                 break;
2240                         uconfig = next_config;
2241                         next_config = strchr(next_config, '#');
2242                         if (next_config)
2243                                 *next_config++ = '\0';
2244                         uname = NULL;
2245
2246                         /*
2247                          * fit_image_load() would load the first FDT from the
2248                          * extra config only when uconfig is specified.
2249                          * Check if the extra config contains multiple FDTs and
2250                          * if so, load them.
2251                          */
2252                         cfg_noffset = fit_conf_get_node(fit, uconfig);
2253
2254                         i = 0;
2255                         count = fit_conf_get_prop_node_count(fit, cfg_noffset,
2256                                                              FIT_FDT_PROP);
2257                 }
2258
2259                 debug("%d: using uname=%s uconfig=%s\n", i, uname, uconfig);
2260
2261                 ov_noffset = fit_image_load(images,
2262                         addr, &uname, &uconfig,
2263                         arch, IH_TYPE_FLATDT,
2264                         BOOTSTAGE_ID_FIT_FDT_START,
2265                         FIT_LOAD_REQUIRED, &ovload, &ovlen);
2266                 if (ov_noffset < 0) {
2267                         printf("load of %s failed\n", uname);
2268                         continue;
2269                 }
2270                 debug("%s loaded at 0x%08lx len=0x%08lx\n",
2271                                 uname, ovload, ovlen);
2272                 ov = map_sysmem(ovload, ovlen);
2273
2274                 base = map_sysmem(load, len + ovlen);
2275                 err = fdt_open_into(base, base, len + ovlen);
2276                 if (err < 0) {
2277                         printf("failed on fdt_open_into\n");
2278                         fdt_noffset = err;
2279                         goto out;
2280                 }
2281                 /* the verbose method prints out messages on error */
2282                 err = fdt_overlay_apply_verbose(base, ov);
2283                 if (err < 0) {
2284                         fdt_noffset = err;
2285                         goto out;
2286                 }
2287                 fdt_pack(base);
2288                 len = fdt_totalsize(base);
2289         }
2290 #else
2291         printf("config with overlays but CONFIG_OF_LIBFDT_OVERLAY not set\n");
2292         fdt_noffset = -EBADF;
2293 #endif
2294
2295 out:
2296         if (datap)
2297                 *datap = load;
2298         if (lenp)
2299                 *lenp = len;
2300         if (fit_unamep)
2301                 *fit_unamep = fit_uname;
2302         if (fit_uname_configp)
2303                 *fit_uname_configp = fit_uname_config;
2304
2305         if (fit_uname_config_copy)
2306                 free(fit_uname_config_copy);
2307         return fdt_noffset;
2308 }
2309 #endif