2 * Copyright (c) 2013, Google Inc.
4 * (C) Copyright 2008 Semihalf
6 * (C) Copyright 2000-2006
7 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9 * SPDX-License-Identifier: GPL-2.0+
21 DECLARE_GLOBAL_DATA_PTR;
22 #endif /* !USE_HOSTCC*/
24 #include <bootstage.h>
25 #include <u-boot/crc.h>
26 #include <u-boot/md5.h>
27 #include <u-boot/sha1.h>
28 #include <u-boot/sha256.h>
30 /*****************************************************************************/
31 /* New uImage format routines */
32 /*****************************************************************************/
34 static int fit_parse_spec(const char *spec, char sepc, ulong addr_curr,
35 ulong *addr, const char **name)
42 sep = strchr(spec, sepc);
45 *addr = simple_strtoul(spec, NULL, 16);
55 * fit_parse_conf - parse FIT configuration spec
56 * @spec: input string, containing configuration spec
57 * @add_curr: current image address (to be used as a possible default)
58 * @addr: pointer to a ulong variable, will hold FIT image address of a given
60 * @conf_name double pointer to a char, will hold pointer to a configuration
63 * fit_parse_conf() expects configuration spec in the form of [<addr>]#<conf>,
64 * where <addr> is a FIT image address that contains configuration
65 * with a <conf> unit name.
67 * Address part is optional, and if omitted default add_curr will
71 * 1 if spec is a valid configuration string,
72 * addr and conf_name are set accordingly
75 int fit_parse_conf(const char *spec, ulong addr_curr,
76 ulong *addr, const char **conf_name)
78 return fit_parse_spec(spec, '#', addr_curr, addr, conf_name);
82 * fit_parse_subimage - parse FIT subimage spec
83 * @spec: input string, containing subimage spec
84 * @add_curr: current image address (to be used as a possible default)
85 * @addr: pointer to a ulong variable, will hold FIT image address of a given
87 * @image_name: double pointer to a char, will hold pointer to a subimage name
89 * fit_parse_subimage() expects subimage spec in the form of
90 * [<addr>]:<subimage>, where <addr> is a FIT image address that contains
91 * subimage with a <subimg> unit name.
93 * Address part is optional, and if omitted default add_curr will
97 * 1 if spec is a valid subimage string,
98 * addr and image_name are set accordingly
101 int fit_parse_subimage(const char *spec, ulong addr_curr,
102 ulong *addr, const char **image_name)
104 return fit_parse_spec(spec, ':', addr_curr, addr, image_name);
106 #endif /* !USE_HOSTCC */
108 static void fit_get_debug(const void *fit, int noffset,
109 char *prop_name, int err)
111 debug("Can't get '%s' property from FIT 0x%08lx, node: offset %d, name %s (%s)\n",
112 prop_name, (ulong)fit, noffset, fit_get_name(fit, noffset, NULL),
117 * fit_get_subimage_count - get component (sub-image) count
118 * @fit: pointer to the FIT format image header
119 * @images_noffset: offset of images node
122 * number of image components
124 int fit_get_subimage_count(const void *fit, int images_noffset)
130 /* Process its subnodes, print out component images details */
131 for (ndepth = 0, count = 0,
132 noffset = fdt_next_node(fit, images_noffset, &ndepth);
133 (noffset >= 0) && (ndepth > 0);
134 noffset = fdt_next_node(fit, noffset, &ndepth)) {
143 #if !defined(CONFIG_SPL_BUILD) || defined(CONFIG_FIT_SPL_PRINT)
145 * fit_print_contents - prints out the contents of the FIT format image
146 * @fit: pointer to the FIT format image header
147 * @p: pointer to prefix string
149 * fit_print_contents() formats a multi line FIT image contents description.
150 * The routine prints out FIT image properties (root node level) follwed by
151 * the details of each component image.
154 * no returned results
156 void fit_print_contents(const void *fit)
169 /* Indent string is defined in header image.h */
170 p = IMAGE_INDENT_STRING;
172 /* Root node properties */
173 ret = fit_get_desc(fit, 0, &desc);
174 printf("%sFIT description: ", p);
176 printf("unavailable\n");
178 printf("%s\n", desc);
180 if (IMAGE_ENABLE_TIMESTAMP) {
181 ret = fit_get_timestamp(fit, 0, ×tamp);
182 printf("%sCreated: ", p);
184 printf("unavailable\n");
186 genimg_print_time(timestamp);
189 /* Find images parent node offset */
190 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
191 if (images_noffset < 0) {
192 printf("Can't find images parent node '%s' (%s)\n",
193 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
197 /* Process its subnodes, print out component images details */
198 for (ndepth = 0, count = 0,
199 noffset = fdt_next_node(fit, images_noffset, &ndepth);
200 (noffset >= 0) && (ndepth > 0);
201 noffset = fdt_next_node(fit, noffset, &ndepth)) {
204 * Direct child node of the images parent node,
205 * i.e. component image node.
207 printf("%s Image %u (%s)\n", p, count++,
208 fit_get_name(fit, noffset, NULL));
210 fit_image_print(fit, noffset, p);
214 /* Find configurations parent node offset */
215 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
216 if (confs_noffset < 0) {
217 debug("Can't get configurations parent node '%s' (%s)\n",
218 FIT_CONFS_PATH, fdt_strerror(confs_noffset));
222 /* get default configuration unit name from default property */
223 uname = (char *)fdt_getprop(fit, noffset, FIT_DEFAULT_PROP, NULL);
225 printf("%s Default Configuration: '%s'\n", p, uname);
227 /* Process its subnodes, print out configurations details */
228 for (ndepth = 0, count = 0,
229 noffset = fdt_next_node(fit, confs_noffset, &ndepth);
230 (noffset >= 0) && (ndepth > 0);
231 noffset = fdt_next_node(fit, noffset, &ndepth)) {
234 * Direct child node of the configurations parent node,
235 * i.e. configuration node.
237 printf("%s Configuration %u (%s)\n", p, count++,
238 fit_get_name(fit, noffset, NULL));
240 fit_conf_print(fit, noffset, p);
246 * fit_image_print_data() - prints out the hash node details
247 * @fit: pointer to the FIT format image header
248 * @noffset: offset of the hash node
249 * @p: pointer to prefix string
250 * @type: Type of information to print ("hash" or "sign")
252 * fit_image_print_data() lists properies for the processed hash node
254 * This function avoid using puts() since it prints a newline on the host
255 * but does not in U-Boot.
258 * no returned results
260 static void fit_image_print_data(const void *fit, int noffset, const char *p,
270 debug("%s %s node: '%s'\n", p, type,
271 fit_get_name(fit, noffset, NULL));
272 printf("%s %s algo: ", p, type);
273 if (fit_image_hash_get_algo(fit, noffset, &algo)) {
274 printf("invalid/unsupported\n");
278 keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
279 required = fdt_getprop(fit, noffset, "required", NULL) != NULL;
281 printf(":%s", keyname);
283 printf(" (required)");
286 ret = fit_image_hash_get_value(fit, noffset, &value,
288 printf("%s %s value: ", p, type);
290 printf("unavailable\n");
292 for (i = 0; i < value_len; i++)
293 printf("%02x", value[i]);
297 debug("%s %s len: %d\n", p, type, value_len);
299 /* Signatures have a time stamp */
300 if (IMAGE_ENABLE_TIMESTAMP && keyname) {
303 printf("%s Timestamp: ", p);
304 if (fit_get_timestamp(fit, noffset, ×tamp))
305 printf("unavailable\n");
307 genimg_print_time(timestamp);
312 * fit_image_print_verification_data() - prints out the hash/signature details
313 * @fit: pointer to the FIT format image header
314 * @noffset: offset of the hash or signature node
315 * @p: pointer to prefix string
317 * This lists properies for the processed hash node
320 * no returned results
322 static void fit_image_print_verification_data(const void *fit, int noffset,
328 * Check subnode name, must be equal to "hash" or "signature".
329 * Multiple hash/signature nodes require unique unit node
330 * names, e.g. hash@1, hash@2, signature@1, signature@2, etc.
332 name = fit_get_name(fit, noffset, NULL);
333 if (!strncmp(name, FIT_HASH_NODENAME, strlen(FIT_HASH_NODENAME))) {
334 fit_image_print_data(fit, noffset, p, "Hash");
335 } else if (!strncmp(name, FIT_SIG_NODENAME,
336 strlen(FIT_SIG_NODENAME))) {
337 fit_image_print_data(fit, noffset, p, "Sign");
342 * fit_image_print - prints out the FIT component image details
343 * @fit: pointer to the FIT format image header
344 * @image_noffset: offset of the component image node
345 * @p: pointer to prefix string
347 * fit_image_print() lists all mandatory properies for the processed component
348 * image. If present, hash nodes are printed out as well. Load
349 * address for images of type firmware is also printed out. Since the load
350 * address is not mandatory for firmware images, it will be output as
351 * "unavailable" when not present.
354 * no returned results
356 void fit_image_print(const void *fit, int image_noffset, const char *p)
359 uint8_t type, arch, os, comp;
367 /* Mandatory properties */
368 ret = fit_get_desc(fit, image_noffset, &desc);
369 printf("%s Description: ", p);
371 printf("unavailable\n");
373 printf("%s\n", desc);
375 if (IMAGE_ENABLE_TIMESTAMP) {
378 ret = fit_get_timestamp(fit, 0, ×tamp);
379 printf("%s Created: ", p);
381 printf("unavailable\n");
383 genimg_print_time(timestamp);
386 fit_image_get_type(fit, image_noffset, &type);
387 printf("%s Type: %s\n", p, genimg_get_type_name(type));
389 fit_image_get_comp(fit, image_noffset, &comp);
390 printf("%s Compression: %s\n", p, genimg_get_comp_name(comp));
392 ret = fit_image_get_data(fit, image_noffset, &data, &size);
395 printf("%s Data Start: ", p);
397 printf("unavailable\n");
399 void *vdata = (void *)data;
401 printf("0x%08lx\n", (ulong)map_to_sysmem(vdata));
405 printf("%s Data Size: ", p);
407 printf("unavailable\n");
409 genimg_print_size(size);
411 /* Remaining, type dependent properties */
412 if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
413 (type == IH_TYPE_RAMDISK) || (type == IH_TYPE_FIRMWARE) ||
414 (type == IH_TYPE_FLATDT)) {
415 fit_image_get_arch(fit, image_noffset, &arch);
416 printf("%s Architecture: %s\n", p, genimg_get_arch_name(arch));
419 if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_RAMDISK)) {
420 fit_image_get_os(fit, image_noffset, &os);
421 printf("%s OS: %s\n", p, genimg_get_os_name(os));
424 if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
425 (type == IH_TYPE_FIRMWARE) || (type == IH_TYPE_RAMDISK)) {
426 ret = fit_image_get_load(fit, image_noffset, &load);
427 printf("%s Load Address: ", p);
429 printf("unavailable\n");
431 printf("0x%08lx\n", load);
434 if ((type == IH_TYPE_KERNEL) || (type == IH_TYPE_STANDALONE) ||
435 (type == IH_TYPE_RAMDISK)) {
436 ret = fit_image_get_entry(fit, image_noffset, &entry);
437 printf("%s Entry Point: ", p);
439 printf("unavailable\n");
441 printf("0x%08lx\n", entry);
444 /* Process all hash subnodes of the component image node */
445 for (ndepth = 0, noffset = fdt_next_node(fit, image_noffset, &ndepth);
446 (noffset >= 0) && (ndepth > 0);
447 noffset = fdt_next_node(fit, noffset, &ndepth)) {
449 /* Direct child node of the component image node */
450 fit_image_print_verification_data(fit, noffset, p);
455 #endif /* !defined(CONFIG_SPL_BUILD) || defined(CONFIG_FIT_SPL_PRINT) */
458 * fit_get_desc - get node description property
459 * @fit: pointer to the FIT format image header
460 * @noffset: node offset
461 * @desc: double pointer to the char, will hold pointer to the descrption
463 * fit_get_desc() reads description property from a given node, if
464 * description is found pointer to it is returened in third call argument.
470 int fit_get_desc(const void *fit, int noffset, char **desc)
474 *desc = (char *)fdt_getprop(fit, noffset, FIT_DESC_PROP, &len);
476 fit_get_debug(fit, noffset, FIT_DESC_PROP, len);
484 * fit_get_timestamp - get node timestamp property
485 * @fit: pointer to the FIT format image header
486 * @noffset: node offset
487 * @timestamp: pointer to the time_t, will hold read timestamp
489 * fit_get_timestamp() reads timestamp poperty from given node, if timestamp
490 * is found and has a correct size its value is retured in third call
495 * -1, on property read failure
496 * -2, on wrong timestamp size
498 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp)
503 data = fdt_getprop(fit, noffset, FIT_TIMESTAMP_PROP, &len);
505 fit_get_debug(fit, noffset, FIT_TIMESTAMP_PROP, len);
508 if (len != sizeof(uint32_t)) {
509 debug("FIT timestamp with incorrect size of (%u)\n", len);
513 *timestamp = uimage_to_cpu(*((uint32_t *)data));
518 * fit_image_get_node - get node offset for component image of a given unit name
519 * @fit: pointer to the FIT format image header
520 * @image_uname: component image node unit name
522 * fit_image_get_node() finds a component image (withing the '/images'
523 * node) of a provided unit name. If image is found its node offset is
524 * returned to the caller.
527 * image node offset when found (>=0)
528 * negative number on failure (FDT_ERR_* code)
530 int fit_image_get_node(const void *fit, const char *image_uname)
532 int noffset, images_noffset;
534 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
535 if (images_noffset < 0) {
536 debug("Can't find images parent node '%s' (%s)\n",
537 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
538 return images_noffset;
541 noffset = fdt_subnode_offset(fit, images_noffset, image_uname);
543 debug("Can't get node offset for image unit name: '%s' (%s)\n",
544 image_uname, fdt_strerror(noffset));
551 * fit_image_get_os - get os id for a given component image node
552 * @fit: pointer to the FIT format image header
553 * @noffset: component image node offset
554 * @os: pointer to the uint8_t, will hold os numeric id
556 * fit_image_get_os() finds os property in a given component image node.
557 * If the property is found, its (string) value is translated to the numeric
558 * id which is returned to the caller.
564 int fit_image_get_os(const void *fit, int noffset, uint8_t *os)
569 /* Get OS name from property data */
570 data = fdt_getprop(fit, noffset, FIT_OS_PROP, &len);
572 fit_get_debug(fit, noffset, FIT_OS_PROP, len);
577 /* Translate OS name to id */
578 *os = genimg_get_os_id(data);
583 * fit_image_get_arch - get arch id for a given component image node
584 * @fit: pointer to the FIT format image header
585 * @noffset: component image node offset
586 * @arch: pointer to the uint8_t, will hold arch numeric id
588 * fit_image_get_arch() finds arch property in a given component image node.
589 * If the property is found, its (string) value is translated to the numeric
590 * id which is returned to the caller.
596 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch)
601 /* Get architecture name from property data */
602 data = fdt_getprop(fit, noffset, FIT_ARCH_PROP, &len);
604 fit_get_debug(fit, noffset, FIT_ARCH_PROP, len);
609 /* Translate architecture name to id */
610 *arch = genimg_get_arch_id(data);
615 * fit_image_get_type - get type id for a given component image node
616 * @fit: pointer to the FIT format image header
617 * @noffset: component image node offset
618 * @type: pointer to the uint8_t, will hold type numeric id
620 * fit_image_get_type() finds type property in a given component image node.
621 * If the property is found, its (string) value is translated to the numeric
622 * id which is returned to the caller.
628 int fit_image_get_type(const void *fit, int noffset, uint8_t *type)
633 /* Get image type name from property data */
634 data = fdt_getprop(fit, noffset, FIT_TYPE_PROP, &len);
636 fit_get_debug(fit, noffset, FIT_TYPE_PROP, len);
641 /* Translate image type name to id */
642 *type = genimg_get_type_id(data);
647 * fit_image_get_comp - get comp id for a given component image node
648 * @fit: pointer to the FIT format image header
649 * @noffset: component image node offset
650 * @comp: pointer to the uint8_t, will hold comp numeric id
652 * fit_image_get_comp() finds comp property in a given component image node.
653 * If the property is found, its (string) value is translated to the numeric
654 * id which is returned to the caller.
660 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp)
665 /* Get compression name from property data */
666 data = fdt_getprop(fit, noffset, FIT_COMP_PROP, &len);
668 fit_get_debug(fit, noffset, FIT_COMP_PROP, len);
673 /* Translate compression name to id */
674 *comp = genimg_get_comp_id(data);
678 static int fit_image_get_address(const void *fit, int noffset, char *name,
682 const uint32_t *data;
684 data = fdt_getprop(fit, noffset, name, &len);
686 fit_get_debug(fit, noffset, name, len);
690 *load = uimage_to_cpu(*data);
695 * fit_image_get_load() - get load addr property for given component image node
696 * @fit: pointer to the FIT format image header
697 * @noffset: component image node offset
698 * @load: pointer to the uint32_t, will hold load address
700 * fit_image_get_load() finds load address property in a given component
701 * image node. If the property is found, its value is returned to the caller.
707 int fit_image_get_load(const void *fit, int noffset, ulong *load)
709 return fit_image_get_address(fit, noffset, FIT_LOAD_PROP, load);
713 * fit_image_get_entry() - get entry point address property
714 * @fit: pointer to the FIT format image header
715 * @noffset: component image node offset
716 * @entry: pointer to the uint32_t, will hold entry point address
718 * This gets the entry point address property for a given component image
721 * fit_image_get_entry() finds entry point address property in a given
722 * component image node. If the property is found, its value is returned
729 int fit_image_get_entry(const void *fit, int noffset, ulong *entry)
731 return fit_image_get_address(fit, noffset, FIT_ENTRY_PROP, entry);
735 * fit_image_get_data - get data property and its size for a given component image node
736 * @fit: pointer to the FIT format image header
737 * @noffset: component image node offset
738 * @data: double pointer to void, will hold data property's data address
739 * @size: pointer to size_t, will hold data property's data size
741 * fit_image_get_data() finds data property in a given component image node.
742 * If the property is found its data start address and size are returned to
749 int fit_image_get_data(const void *fit, int noffset,
750 const void **data, size_t *size)
754 *data = fdt_getprop(fit, noffset, FIT_DATA_PROP, &len);
756 fit_get_debug(fit, noffset, FIT_DATA_PROP, len);
766 * fit_image_hash_get_algo - get hash algorithm name
767 * @fit: pointer to the FIT format image header
768 * @noffset: hash node offset
769 * @algo: double pointer to char, will hold pointer to the algorithm name
771 * fit_image_hash_get_algo() finds hash algorithm property in a given hash node.
772 * If the property is found its data start address is returned to the caller.
778 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo)
782 *algo = (char *)fdt_getprop(fit, noffset, FIT_ALGO_PROP, &len);
784 fit_get_debug(fit, noffset, FIT_ALGO_PROP, len);
792 * fit_image_hash_get_value - get hash value and length
793 * @fit: pointer to the FIT format image header
794 * @noffset: hash node offset
795 * @value: double pointer to uint8_t, will hold address of a hash value data
796 * @value_len: pointer to an int, will hold hash data length
798 * fit_image_hash_get_value() finds hash value property in a given hash node.
799 * If the property is found its data start address and size are returned to
806 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
811 *value = (uint8_t *)fdt_getprop(fit, noffset, FIT_VALUE_PROP, &len);
812 if (*value == NULL) {
813 fit_get_debug(fit, noffset, FIT_VALUE_PROP, len);
823 * fit_image_hash_get_ignore - get hash ignore flag
824 * @fit: pointer to the FIT format image header
825 * @noffset: hash node offset
826 * @ignore: pointer to an int, will hold hash ignore flag
828 * fit_image_hash_get_ignore() finds hash ignore property in a given hash node.
829 * If the property is found and non-zero, the hash algorithm is not verified by
830 * u-boot automatically.
833 * 0, on ignore not found
834 * value, on ignore found
836 static int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore)
841 value = (int *)fdt_getprop(fit, noffset, FIT_IGNORE_PROP, &len);
842 if (value == NULL || len != sizeof(int))
850 ulong fit_get_end(const void *fit)
852 return map_to_sysmem((void *)(fit + fdt_totalsize(fit)));
856 * fit_set_timestamp - set node timestamp property
857 * @fit: pointer to the FIT format image header
858 * @noffset: node offset
859 * @timestamp: timestamp value to be set
861 * fit_set_timestamp() attempts to set timestamp property in the requested
862 * node and returns operation status to the caller.
866 * -ENOSPC if no space in device tree, -1 for other error
868 int fit_set_timestamp(void *fit, int noffset, time_t timestamp)
873 t = cpu_to_uimage(timestamp);
874 ret = fdt_setprop(fit, noffset, FIT_TIMESTAMP_PROP, &t,
877 printf("Can't set '%s' property for '%s' node (%s)\n",
878 FIT_TIMESTAMP_PROP, fit_get_name(fit, noffset, NULL),
880 return ret == -FDT_ERR_NOSPACE ? -ENOSPC : -1;
887 * calculate_hash - calculate and return hash for provided input data
888 * @data: pointer to the input data
889 * @data_len: data length
890 * @algo: requested hash algorithm
891 * @value: pointer to the char, will hold hash value data (caller must
892 * allocate enough free space)
893 * value_len: length of the calculated hash
895 * calculate_hash() computes input data hash according to the requested
897 * Resulting hash value is placed in caller provided 'value' buffer, length
898 * of the calculated hash is returned via value_len pointer argument.
902 * -1, when algo is unsupported
904 int calculate_hash(const void *data, int data_len, const char *algo,
905 uint8_t *value, int *value_len)
907 if (IMAGE_ENABLE_CRC32 && strcmp(algo, "crc32") == 0) {
908 *((uint32_t *)value) = crc32_wd(0, data, data_len,
910 *((uint32_t *)value) = cpu_to_uimage(*((uint32_t *)value));
912 } else if (IMAGE_ENABLE_SHA1 && strcmp(algo, "sha1") == 0) {
913 sha1_csum_wd((unsigned char *)data, data_len,
914 (unsigned char *)value, CHUNKSZ_SHA1);
916 } else if (IMAGE_ENABLE_SHA256 && strcmp(algo, "sha256") == 0) {
917 sha256_csum_wd((unsigned char *)data, data_len,
918 (unsigned char *)value, CHUNKSZ_SHA256);
919 *value_len = SHA256_SUM_LEN;
920 } else if (IMAGE_ENABLE_MD5 && strcmp(algo, "md5") == 0) {
921 md5_wd((unsigned char *)data, data_len, value, CHUNKSZ_MD5);
924 debug("Unsupported hash alogrithm\n");
930 static int fit_image_check_hash(const void *fit, int noffset, const void *data,
931 size_t size, char **err_msgp)
933 uint8_t value[FIT_MAX_HASH_LEN];
942 if (fit_image_hash_get_algo(fit, noffset, &algo)) {
943 *err_msgp = "Can't get hash algo property";
948 if (IMAGE_ENABLE_IGNORE) {
949 fit_image_hash_get_ignore(fit, noffset, &ignore);
956 if (fit_image_hash_get_value(fit, noffset, &fit_value,
958 *err_msgp = "Can't get hash value property";
962 if (calculate_hash(data, size, algo, value, &value_len)) {
963 *err_msgp = "Unsupported hash algorithm";
967 if (value_len != fit_value_len) {
968 *err_msgp = "Bad hash value len";
970 } else if (memcmp(value, fit_value, value_len) != 0) {
971 *err_msgp = "Bad hash value";
979 * fit_image_verify - verify data intergity
980 * @fit: pointer to the FIT format image header
981 * @image_noffset: component image node offset
983 * fit_image_verify() goes over component image hash nodes,
984 * re-calculates each data hash and compares with the value stored in hash
988 * 1, if all hashes are valid
989 * 0, otherwise (or on error)
991 int fit_image_verify(const void *fit, int image_noffset)
1000 /* Get image data and data length */
1001 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
1002 err_msg = "Can't get image data/size";
1006 /* Verify all required signatures */
1007 if (IMAGE_ENABLE_VERIFY &&
1008 fit_image_verify_required_sigs(fit, image_noffset, data, size,
1009 gd_fdt_blob(), &verify_all)) {
1010 err_msg = "Unable to verify required signature";
1014 /* Process all hash subnodes of the component image node */
1015 fdt_for_each_subnode(fit, noffset, image_noffset) {
1016 const char *name = fit_get_name(fit, noffset, NULL);
1019 * Check subnode name, must be equal to "hash".
1020 * Multiple hash nodes require unique unit node
1021 * names, e.g. hash@1, hash@2, etc.
1023 if (!strncmp(name, FIT_HASH_NODENAME,
1024 strlen(FIT_HASH_NODENAME))) {
1025 if (fit_image_check_hash(fit, noffset, data, size,
1029 } else if (IMAGE_ENABLE_VERIFY && verify_all &&
1030 !strncmp(name, FIT_SIG_NODENAME,
1031 strlen(FIT_SIG_NODENAME))) {
1032 ret = fit_image_check_sig(fit, noffset, data,
1033 size, -1, &err_msg);
1036 * Show an indication on failure, but do not return
1037 * an error. Only keys marked 'required' can cause
1038 * an image validation failure. See the call to
1039 * fit_image_verify_required_sigs() above.
1048 if (noffset == -FDT_ERR_TRUNCATED || noffset == -FDT_ERR_BADSTRUCTURE) {
1049 err_msg = "Corrupted or truncated tree";
1056 printf(" error!\n%s for '%s' hash node in '%s' image node\n",
1057 err_msg, fit_get_name(fit, noffset, NULL),
1058 fit_get_name(fit, image_noffset, NULL));
1063 * fit_all_image_verify - verify data intergity for all images
1064 * @fit: pointer to the FIT format image header
1066 * fit_all_image_verify() goes over all images in the FIT and
1067 * for every images checks if all it's hashes are valid.
1070 * 1, if all hashes of all images are valid
1071 * 0, otherwise (or on error)
1073 int fit_all_image_verify(const void *fit)
1080 /* Find images parent node offset */
1081 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1082 if (images_noffset < 0) {
1083 printf("Can't find images parent node '%s' (%s)\n",
1084 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
1088 /* Process all image subnodes, check hashes for each */
1089 printf("## Checking hash(es) for FIT Image at %08lx ...\n",
1091 for (ndepth = 0, count = 0,
1092 noffset = fdt_next_node(fit, images_noffset, &ndepth);
1093 (noffset >= 0) && (ndepth > 0);
1094 noffset = fdt_next_node(fit, noffset, &ndepth)) {
1097 * Direct child node of the images parent node,
1098 * i.e. component image node.
1100 printf(" Hash(es) for Image %u (%s): ", count,
1101 fit_get_name(fit, noffset, NULL));
1104 if (!fit_image_verify(fit, noffset))
1113 * fit_image_check_os - check whether image node is of a given os type
1114 * @fit: pointer to the FIT format image header
1115 * @noffset: component image node offset
1116 * @os: requested image os
1118 * fit_image_check_os() reads image os property and compares its numeric
1119 * id with the requested os. Comparison result is returned to the caller.
1122 * 1 if image is of given os type
1123 * 0 otherwise (or on error)
1125 int fit_image_check_os(const void *fit, int noffset, uint8_t os)
1129 if (fit_image_get_os(fit, noffset, &image_os))
1131 return (os == image_os);
1135 * fit_image_check_arch - check whether image node is of a given arch
1136 * @fit: pointer to the FIT format image header
1137 * @noffset: component image node offset
1138 * @arch: requested imagearch
1140 * fit_image_check_arch() reads image arch property and compares its numeric
1141 * id with the requested arch. Comparison result is returned to the caller.
1144 * 1 if image is of given arch
1145 * 0 otherwise (or on error)
1147 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch)
1151 if (fit_image_get_arch(fit, noffset, &image_arch))
1153 return (arch == image_arch) ||
1154 (arch == IH_ARCH_I386 && image_arch == IH_ARCH_X86_64);
1158 * fit_image_check_type - check whether image node is of a given type
1159 * @fit: pointer to the FIT format image header
1160 * @noffset: component image node offset
1161 * @type: requested image type
1163 * fit_image_check_type() reads image type property and compares its numeric
1164 * id with the requested type. Comparison result is returned to the caller.
1167 * 1 if image is of given type
1168 * 0 otherwise (or on error)
1170 int fit_image_check_type(const void *fit, int noffset, uint8_t type)
1174 if (fit_image_get_type(fit, noffset, &image_type))
1176 return (type == image_type);
1180 * fit_image_check_comp - check whether image node uses given compression
1181 * @fit: pointer to the FIT format image header
1182 * @noffset: component image node offset
1183 * @comp: requested image compression type
1185 * fit_image_check_comp() reads image compression property and compares its
1186 * numeric id with the requested compression type. Comparison result is
1187 * returned to the caller.
1190 * 1 if image uses requested compression
1191 * 0 otherwise (or on error)
1193 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp)
1197 if (fit_image_get_comp(fit, noffset, &image_comp))
1199 return (comp == image_comp);
1203 * fit_check_format - sanity check FIT image format
1204 * @fit: pointer to the FIT format image header
1206 * fit_check_format() runs a basic sanity FIT image verification.
1207 * Routine checks for mandatory properties, nodes, etc.
1213 int fit_check_format(const void *fit)
1215 /* mandatory / node 'description' property */
1216 if (fdt_getprop(fit, 0, FIT_DESC_PROP, NULL) == NULL) {
1217 debug("Wrong FIT format: no description\n");
1221 if (IMAGE_ENABLE_TIMESTAMP) {
1222 /* mandatory / node 'timestamp' property */
1223 if (fdt_getprop(fit, 0, FIT_TIMESTAMP_PROP, NULL) == NULL) {
1224 debug("Wrong FIT format: no timestamp\n");
1229 /* mandatory subimages parent '/images' node */
1230 if (fdt_path_offset(fit, FIT_IMAGES_PATH) < 0) {
1231 debug("Wrong FIT format: no images parent node\n");
1240 * fit_conf_find_compat
1241 * @fit: pointer to the FIT format image header
1242 * @fdt: pointer to the device tree to compare against
1244 * fit_conf_find_compat() attempts to find the configuration whose fdt is the
1245 * most compatible with the passed in device tree.
1254 * |-o configurations
1262 * |-compatible = "foo,bar", "bim,bam"
1265 * |-compatible = "foo,bar",
1268 * |-compatible = "bim,bam", "baz,biz"
1270 * Configuration 1 would be picked because the first string in U-Boot's
1271 * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
1272 * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
1275 * offset to the configuration to use if one was found
1278 int fit_conf_find_compat(const void *fit, const void *fdt)
1281 int noffset, confs_noffset, images_noffset;
1282 const void *fdt_compat;
1284 int best_match_offset = 0;
1285 int best_match_pos = 0;
1287 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1288 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1289 if (confs_noffset < 0 || images_noffset < 0) {
1290 debug("Can't find configurations or images nodes.\n");
1294 fdt_compat = fdt_getprop(fdt, 0, "compatible", &fdt_compat_len);
1296 debug("Fdt for comparison has no \"compatible\" property.\n");
1301 * Loop over the configurations in the FIT image.
1303 for (noffset = fdt_next_node(fit, confs_noffset, &ndepth);
1304 (noffset >= 0) && (ndepth > 0);
1305 noffset = fdt_next_node(fit, noffset, &ndepth)) {
1307 const char *kfdt_name;
1309 const char *cur_fdt_compat;
1317 kfdt_name = fdt_getprop(fit, noffset, "fdt", &len);
1319 debug("No fdt property found.\n");
1322 kfdt_noffset = fdt_subnode_offset(fit, images_noffset,
1324 if (kfdt_noffset < 0) {
1325 debug("No image node named \"%s\" found.\n",
1330 * Get a pointer to this configuration's fdt.
1332 if (fit_image_get_data(fit, kfdt_noffset, &kfdt, &size)) {
1333 debug("Failed to get fdt \"%s\".\n", kfdt_name);
1337 len = fdt_compat_len;
1338 cur_fdt_compat = fdt_compat;
1340 * Look for a match for each U-Boot compatibility string in
1341 * turn in this configuration's fdt.
1343 for (i = 0; len > 0 &&
1344 (!best_match_offset || best_match_pos > i); i++) {
1345 int cur_len = strlen(cur_fdt_compat) + 1;
1347 if (!fdt_node_check_compatible(kfdt, 0,
1349 best_match_offset = noffset;
1354 cur_fdt_compat += cur_len;
1357 if (!best_match_offset) {
1358 debug("No match found.\n");
1362 return best_match_offset;
1366 * fit_conf_get_node - get node offset for configuration of a given unit name
1367 * @fit: pointer to the FIT format image header
1368 * @conf_uname: configuration node unit name
1370 * fit_conf_get_node() finds a configuration (withing the '/configurations'
1371 * parant node) of a provided unit name. If configuration is found its node
1372 * offset is returned to the caller.
1374 * When NULL is provided in second argument fit_conf_get_node() will search
1375 * for a default configuration node instead. Default configuration node unit
1376 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1380 * configuration node offset when found (>=0)
1381 * negative number on failure (FDT_ERR_* code)
1383 int fit_conf_get_node(const void *fit, const char *conf_uname)
1385 int noffset, confs_noffset;
1388 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1389 if (confs_noffset < 0) {
1390 debug("Can't find configurations parent node '%s' (%s)\n",
1391 FIT_CONFS_PATH, fdt_strerror(confs_noffset));
1392 return confs_noffset;
1395 if (conf_uname == NULL) {
1396 /* get configuration unit name from the default property */
1397 debug("No configuration specified, trying default...\n");
1398 conf_uname = (char *)fdt_getprop(fit, confs_noffset,
1399 FIT_DEFAULT_PROP, &len);
1400 if (conf_uname == NULL) {
1401 fit_get_debug(fit, confs_noffset, FIT_DEFAULT_PROP,
1405 debug("Found default configuration: '%s'\n", conf_uname);
1408 noffset = fdt_subnode_offset(fit, confs_noffset, conf_uname);
1410 debug("Can't get node offset for configuration unit name: '%s' (%s)\n",
1411 conf_uname, fdt_strerror(noffset));
1417 int fit_conf_get_prop_node(const void *fit, int noffset,
1418 const char *prop_name)
1423 /* get kernel image unit name from configuration kernel property */
1424 uname = (char *)fdt_getprop(fit, noffset, prop_name, &len);
1428 return fit_image_get_node(fit, uname);
1432 * fit_conf_print - prints out the FIT configuration details
1433 * @fit: pointer to the FIT format image header
1434 * @noffset: offset of the configuration node
1435 * @p: pointer to prefix string
1437 * fit_conf_print() lists all mandatory properies for the processed
1438 * configuration node.
1441 * no returned results
1443 void fit_conf_print(const void *fit, int noffset, const char *p)
1448 int loadables_index;
1450 /* Mandatory properties */
1451 ret = fit_get_desc(fit, noffset, &desc);
1452 printf("%s Description: ", p);
1454 printf("unavailable\n");
1456 printf("%s\n", desc);
1458 uname = (char *)fdt_getprop(fit, noffset, FIT_KERNEL_PROP, NULL);
1459 printf("%s Kernel: ", p);
1461 printf("unavailable\n");
1463 printf("%s\n", uname);
1465 /* Optional properties */
1466 uname = (char *)fdt_getprop(fit, noffset, FIT_RAMDISK_PROP, NULL);
1468 printf("%s Init Ramdisk: %s\n", p, uname);
1470 uname = (char *)fdt_getprop(fit, noffset, FIT_FDT_PROP, NULL);
1472 printf("%s FDT: %s\n", p, uname);
1474 /* Print out all of the specified loadables */
1475 for (loadables_index = 0;
1476 fdt_get_string_index(fit, noffset,
1479 (const char **)&uname) == 0;
1482 if (loadables_index == 0) {
1483 printf("%s Loadables: ", p);
1487 printf("%s\n", uname);
1491 static int fit_image_select(const void *fit, int rd_noffset, int verify)
1493 fit_image_print(fit, rd_noffset, " ");
1496 puts(" Verifying Hash Integrity ... ");
1497 if (!fit_image_verify(fit, rd_noffset)) {
1498 puts("Bad Data Hash\n");
1507 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
1514 debug("* %s: using config '%s' from image at 0x%08lx\n",
1515 prop_name, images->fit_uname_cfg, addr);
1517 /* Check whether configuration has this property defined */
1518 fit_hdr = map_sysmem(addr, 0);
1519 cfg_noffset = fit_conf_get_node(fit_hdr, images->fit_uname_cfg);
1520 if (cfg_noffset < 0) {
1521 debug("* %s: no such config\n", prop_name);
1525 noffset = fit_conf_get_prop_node(fit_hdr, cfg_noffset, prop_name);
1527 debug("* %s: no '%s' in config\n", prop_name, prop_name);
1535 * fit_get_image_type_property() - get property name for IH_TYPE_...
1537 * @return the properly name where we expect to find the image in the
1540 static const char *fit_get_image_type_property(int type)
1543 * This is sort-of available in the uimage_type[] table in image.c
1544 * but we don't have access to the sohrt name, and "fdt" is different
1545 * anyway. So let's just keep it here.
1548 case IH_TYPE_FLATDT:
1549 return FIT_FDT_PROP;
1550 case IH_TYPE_KERNEL:
1551 return FIT_KERNEL_PROP;
1552 case IH_TYPE_RAMDISK:
1553 return FIT_RAMDISK_PROP;
1554 case IH_TYPE_X86_SETUP:
1555 return FIT_SETUP_PROP;
1556 case IH_TYPE_LOADABLE:
1557 return FIT_LOADABLE_PROP;
1563 int fit_image_load(bootm_headers_t *images, ulong addr,
1564 const char **fit_unamep, const char **fit_uname_configp,
1565 int arch, int image_type, int bootstage_id,
1566 enum fit_load_op load_op, ulong *datap, ulong *lenp)
1568 int cfg_noffset, noffset;
1569 const char *fit_uname;
1570 const char *fit_uname_config;
1575 ulong load, data, len;
1577 const char *prop_name;
1580 fit = map_sysmem(addr, 0);
1581 fit_uname = fit_unamep ? *fit_unamep : NULL;
1582 fit_uname_config = fit_uname_configp ? *fit_uname_configp : NULL;
1583 prop_name = fit_get_image_type_property(image_type);
1584 printf("## Loading %s from FIT Image at %08lx ...\n", prop_name, addr);
1586 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_FORMAT);
1587 if (!fit_check_format(fit)) {
1588 printf("Bad FIT %s image format!\n", prop_name);
1589 bootstage_error(bootstage_id + BOOTSTAGE_SUB_FORMAT);
1592 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_FORMAT_OK);
1594 /* get FIT component image node offset */
1595 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_UNIT_NAME);
1596 noffset = fit_image_get_node(fit, fit_uname);
1599 * no image node unit name, try to get config
1600 * node first. If config unit node name is NULL
1601 * fit_conf_get_node() will try to find default config node
1603 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_NO_UNIT_NAME);
1604 if (IMAGE_ENABLE_BEST_MATCH && !fit_uname_config) {
1605 cfg_noffset = fit_conf_find_compat(fit, gd_fdt_blob());
1607 cfg_noffset = fit_conf_get_node(fit,
1610 if (cfg_noffset < 0) {
1611 puts("Could not find configuration node\n");
1612 bootstage_error(bootstage_id +
1613 BOOTSTAGE_SUB_NO_UNIT_NAME);
1616 fit_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
1617 printf(" Using '%s' configuration\n", fit_uname_config);
1618 if (image_type == IH_TYPE_KERNEL) {
1619 /* Remember (and possibly verify) this config */
1620 images->fit_uname_cfg = fit_uname_config;
1621 if (IMAGE_ENABLE_VERIFY && images->verify) {
1622 puts(" Verifying Hash Integrity ... ");
1623 if (fit_config_verify(fit, cfg_noffset)) {
1624 puts("Bad Data Hash\n");
1625 bootstage_error(bootstage_id +
1626 BOOTSTAGE_SUB_HASH);
1631 bootstage_mark(BOOTSTAGE_ID_FIT_CONFIG);
1634 noffset = fit_conf_get_prop_node(fit, cfg_noffset,
1636 fit_uname = fit_get_name(fit, noffset, NULL);
1639 puts("Could not find subimage node\n");
1640 bootstage_error(bootstage_id + BOOTSTAGE_SUB_SUBNODE);
1644 printf(" Trying '%s' %s subimage\n", fit_uname, prop_name);
1646 ret = fit_image_select(fit, noffset, images->verify);
1648 bootstage_error(bootstage_id + BOOTSTAGE_SUB_HASH);
1652 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ARCH);
1653 #if !defined(USE_HOSTCC) && !defined(CONFIG_SANDBOX)
1654 if (!fit_image_check_target_arch(fit, noffset)) {
1655 puts("Unsupported Architecture\n");
1656 bootstage_error(bootstage_id + BOOTSTAGE_SUB_CHECK_ARCH);
1660 if (image_type == IH_TYPE_FLATDT &&
1661 !fit_image_check_comp(fit, noffset, IH_COMP_NONE)) {
1662 puts("FDT image is compressed");
1663 return -EPROTONOSUPPORT;
1666 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL);
1667 type_ok = fit_image_check_type(fit, noffset, image_type) ||
1668 (image_type == IH_TYPE_KERNEL &&
1669 fit_image_check_type(fit, noffset,
1670 IH_TYPE_KERNEL_NOLOAD));
1672 os_ok = image_type == IH_TYPE_FLATDT ||
1673 fit_image_check_os(fit, noffset, IH_OS_LINUX) ||
1674 fit_image_check_os(fit, noffset, IH_OS_OPENRTOS);
1677 * If either of the checks fail, we should report an error, but
1678 * if the image type is coming from the "loadables" field, we
1679 * don't care what it is
1681 if ((!type_ok || !os_ok) && image_type != IH_TYPE_LOADABLE) {
1682 fit_image_get_os(fit, noffset, &os);
1683 printf("No %s %s %s Image\n",
1684 genimg_get_os_name(os),
1685 genimg_get_arch_name(arch),
1686 genimg_get_type_name(image_type));
1687 bootstage_error(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL);
1691 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_CHECK_ALL_OK);
1693 /* get image data address and length */
1694 if (fit_image_get_data(fit, noffset, &buf, &size)) {
1695 printf("Could not find %s subimage data!\n", prop_name);
1696 bootstage_error(bootstage_id + BOOTSTAGE_SUB_GET_DATA);
1701 /* verify that image data is a proper FDT blob */
1702 if (image_type == IH_TYPE_FLATDT && fdt_check_header(buf)) {
1703 puts("Subimage data is not a FDT");
1707 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_GET_DATA_OK);
1710 * Work-around for eldk-4.2 which gives this warning if we try to
1711 * cast in the unmap_sysmem() call:
1712 * warning: initialization discards qualifiers from pointer target type
1715 void *vbuf = (void *)buf;
1717 data = map_to_sysmem(vbuf);
1720 if (load_op == FIT_LOAD_IGNORED) {
1722 } else if (fit_image_get_load(fit, noffset, &load)) {
1723 if (load_op == FIT_LOAD_REQUIRED) {
1724 printf("Can't get %s subimage load address!\n",
1726 bootstage_error(bootstage_id + BOOTSTAGE_SUB_LOAD);
1729 } else if (load_op != FIT_LOAD_OPTIONAL_NON_ZERO || load) {
1730 ulong image_start, image_end;
1735 * move image data to the load address,
1736 * make sure we don't overwrite initial image
1739 image_end = addr + fit_get_size(fit);
1741 load_end = load + len;
1742 if (image_type != IH_TYPE_KERNEL &&
1743 load < image_end && load_end > image_start) {
1744 printf("Error: %s overwritten\n", prop_name);
1748 printf(" Loading %s from 0x%08lx to 0x%08lx\n",
1749 prop_name, data, load);
1751 dst = map_sysmem(load, len);
1752 memmove(dst, buf, len);
1755 bootstage_mark(bootstage_id + BOOTSTAGE_SUB_LOAD);
1760 *fit_unamep = (char *)fit_uname;
1761 if (fit_uname_configp)
1762 *fit_uname_configp = (char *)fit_uname_config;
1767 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
1768 ulong *setup_start, ulong *setup_len)
1775 addr = map_to_sysmem(images->fit_hdr_os);
1776 noffset = fit_get_node_from_config(images, FIT_SETUP_PROP, addr);
1780 ret = fit_image_load(images, addr, NULL, NULL, arch,
1781 IH_TYPE_X86_SETUP, BOOTSTAGE_ID_FIT_SETUP_START,
1782 FIT_LOAD_REQUIRED, setup_start, &len);