1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2004
6 * DENX Software Engineering
10 * FIT image specific code abstracted from mkimage.c
11 * some functions added to address abstraction
13 * All rights reserved.
16 #include "imagetool.h"
17 #include "fit_common.h"
23 #include <u-boot/crc.h>
25 static struct legacy_img_hdr header;
27 static int fit_add_file_data(struct image_tool_params *params, size_t size_inc,
31 void *dest_blob = NULL;
32 off_t destfd_size = 0;
37 tfd = mmap_fdt(params->cmdname, tmpfile, size_inc, &ptr, &sbuf, true,
40 fprintf(stderr, "Cannot map FDT file '%s'\n", tmpfile);
44 if (params->keydest) {
45 struct stat dest_sbuf;
47 destfd = mmap_fdt(params->cmdname, params->keydest, size_inc,
48 &dest_blob, &dest_sbuf, false,
54 destfd_size = dest_sbuf.st_size;
57 /* for first image creation, add a timestamp at offset 0 i.e., root */
58 if (params->datafile || params->reset_timestamp) {
59 time_t time = imagetool_get_source_date(params->cmdname,
61 ret = fit_set_timestamp(ptr, 0, time);
65 ret = fit_pre_load_data(params->keydir, dest_blob, ptr);
68 ret = fit_cipher_data(params->keydir, dest_blob, ptr,
76 ret = fit_add_verification_data(params->keydir,
77 params->keyfile, dest_blob, ptr,
87 munmap(dest_blob, destfd_size);
92 munmap(ptr, sbuf.st_size);
98 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
100 static int fit_calc_size(struct image_tool_params *params)
102 struct content_info *cont;
103 int size, total_size;
105 size = imagetool_get_filesize(params, params->datafile);
110 if (params->fit_ramdisk) {
111 size = imagetool_get_filesize(params, params->fit_ramdisk);
117 for (cont = params->content_head; cont; cont = cont->next) {
118 size = imagetool_get_filesize(params, cont->fname);
122 /* Add space for properties and hash node */
123 total_size += size + 300;
126 /* Add plenty of space for headers, properties, nodes, etc. */
132 static int fdt_property_file(struct image_tool_params *params,
133 void *fdt, const char *name, const char *fname)
140 fd = open(fname, O_RDWR | O_BINARY);
142 fprintf(stderr, "%s: Can't open %s: %s\n",
143 params->cmdname, fname, strerror(errno));
147 if (fstat(fd, &sbuf) < 0) {
148 fprintf(stderr, "%s: Can't stat %s: %s\n",
149 params->cmdname, fname, strerror(errno));
153 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
156 ret = read(fd, ptr, sbuf.st_size);
157 if (ret != sbuf.st_size) {
158 fprintf(stderr, "%s: Can't read %s: %s\n",
159 params->cmdname, fname, strerror(errno));
170 static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
176 vsnprintf(str, sizeof(str), fmt, ptr);
178 return fdt_property_string(fdt, name, str);
181 static void get_basename(char *str, int size, const char *fname)
183 const char *p, *start, *end;
187 * Use the base name as the 'name' field. So for example:
189 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
190 * becomes "sun7i-a20-bananapro"
192 p = strrchr(fname, '/');
193 start = p ? p + 1 : fname;
194 p = strrchr(fname, '.');
195 end = p ? p : fname + strlen(fname);
199 memcpy(str, start, len);
204 * fit_add_hash_or_sign() - Add a hash or signature node
206 * @params: Image parameters
207 * @fdt: Device tree to add to (in sequential-write mode)
208 * @is_images_subnode: true to add hash even if key name hint is provided
210 * If do_add_hash is false (default) and there is a key name hint, try to add
211 * a sign node to parent. Otherwise, just add a CRC. Rationale: if conf have
212 * to be signed, image/dt have to be hashed even if there is a key name hint.
214 static void fit_add_hash_or_sign(struct image_tool_params *params, void *fdt,
215 bool is_images_subnode)
217 const char *hash_algo = "crc32";
218 bool do_hash = false;
219 bool do_sign = false;
221 switch (params->auto_fit) {
225 do_hash = is_images_subnode;
228 do_sign = is_images_subnode;
231 if (is_images_subnode) {
240 "%s: Unsupported auto FIT mode %u\n",
241 params->cmdname, params->auto_fit);
246 fdt_begin_node(fdt, FIT_HASH_NODENAME);
247 fdt_property_string(fdt, FIT_ALGO_PROP, hash_algo);
252 fdt_begin_node(fdt, FIT_SIG_NODENAME);
253 fdt_property_string(fdt, FIT_ALGO_PROP, params->algo_name);
254 fdt_property_string(fdt, FIT_KEY_HINT, params->keyname);
260 * fit_write_images() - Write out a list of images to the FIT
262 * We always include the main image (params->datafile). If there are device
263 * tree files, we include an fdt- node for each of those too.
265 static int fit_write_images(struct image_tool_params *params, char *fdt)
267 struct content_info *cont;
268 const char *typename;
273 fdt_begin_node(fdt, "images");
275 /* First the main image */
276 typename = genimg_get_type_short_name(params->fit_image_type);
277 snprintf(str, sizeof(str), "%s-1", typename);
278 fdt_begin_node(fdt, str);
279 fdt_property_string(fdt, FIT_DESC_PROP, params->imagename);
280 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
281 fdt_property_string(fdt, FIT_ARCH_PROP,
282 genimg_get_arch_short_name(params->arch));
283 fdt_property_string(fdt, FIT_OS_PROP,
284 genimg_get_os_short_name(params->os));
285 fdt_property_string(fdt, FIT_COMP_PROP,
286 genimg_get_comp_short_name(params->comp));
287 fdt_property_u32(fdt, FIT_LOAD_PROP, params->addr);
288 fdt_property_u32(fdt, FIT_ENTRY_PROP, params->ep);
291 * Put data last since it is large. SPL may only load the first part
292 * of the DT, so this way it can access all the above fields.
294 ret = fdt_property_file(params, fdt, FIT_DATA_PROP, params->datafile);
297 fit_add_hash_or_sign(params, fdt, true);
300 /* Now the device tree files if available */
302 for (cont = params->content_head; cont; cont = cont->next) {
303 if (cont->type != IH_TYPE_FLATDT)
305 typename = genimg_get_type_short_name(cont->type);
306 snprintf(str, sizeof(str), "%s-%d", FIT_FDT_PROP, ++upto);
307 fdt_begin_node(fdt, str);
309 get_basename(str, sizeof(str), cont->fname);
310 fdt_property_string(fdt, FIT_DESC_PROP, str);
311 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
315 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
316 fdt_property_string(fdt, FIT_ARCH_PROP,
317 genimg_get_arch_short_name(params->arch));
318 fdt_property_string(fdt, FIT_COMP_PROP,
319 genimg_get_comp_short_name(IH_COMP_NONE));
320 fit_add_hash_or_sign(params, fdt, true);
326 /* And a ramdisk file if available */
327 if (params->fit_ramdisk) {
328 fdt_begin_node(fdt, FIT_RAMDISK_PROP "-1");
330 fdt_property_string(fdt, FIT_TYPE_PROP, FIT_RAMDISK_PROP);
331 fdt_property_string(fdt, FIT_OS_PROP,
332 genimg_get_os_short_name(params->os));
333 fdt_property_string(fdt, FIT_ARCH_PROP,
334 genimg_get_arch_short_name(params->arch));
336 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
337 params->fit_ramdisk);
340 fit_add_hash_or_sign(params, fdt, true);
352 * fit_write_configs() - Write out a list of configurations to the FIT
354 * If there are device tree files, we include a configuration for each, which
355 * selects the main image (params->datafile) and its corresponding device
358 * Otherwise we just create a configuration with the main image in it.
360 static void fit_write_configs(struct image_tool_params *params, char *fdt)
362 struct content_info *cont;
363 const char *typename;
367 fdt_begin_node(fdt, "configurations");
368 fdt_property_string(fdt, FIT_DEFAULT_PROP, "conf-1");
371 for (cont = params->content_head; cont; cont = cont->next) {
372 if (cont->type != IH_TYPE_FLATDT)
374 typename = genimg_get_type_short_name(cont->type);
375 snprintf(str, sizeof(str), "conf-%d", ++upto);
376 fdt_begin_node(fdt, str);
378 get_basename(str, sizeof(str), cont->fname);
379 fdt_property_string(fdt, FIT_DESC_PROP, str);
381 typename = genimg_get_type_short_name(params->fit_image_type);
382 snprintf(str, sizeof(str), "%s-1", typename);
383 fdt_property_string(fdt, typename, str);
384 fdt_property_string(fdt, FIT_LOADABLE_PROP, str);
386 if (params->fit_ramdisk)
387 fdt_property_string(fdt, FIT_RAMDISK_PROP,
388 FIT_RAMDISK_PROP "-1");
390 snprintf(str, sizeof(str), FIT_FDT_PROP "-%d", upto);
391 fdt_property_string(fdt, FIT_FDT_PROP, str);
392 fit_add_hash_or_sign(params, fdt, false);
397 fdt_begin_node(fdt, "conf-1");
398 typename = genimg_get_type_short_name(params->fit_image_type);
399 snprintf(str, sizeof(str), "%s-1", typename);
400 fdt_property_string(fdt, typename, str);
402 if (params->fit_ramdisk)
403 fdt_property_string(fdt, FIT_RAMDISK_PROP,
404 FIT_RAMDISK_PROP "-1");
405 fit_add_hash_or_sign(params, fdt, false);
413 static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
417 ret = fdt_create(fdt, size);
420 fdt_finish_reservemap(fdt);
421 fdt_begin_node(fdt, "");
422 fdt_property_strf(fdt, FIT_DESC_PROP,
423 "%s image with one or more FDT blobs",
424 genimg_get_type_name(params->fit_image_type));
425 fdt_property_strf(fdt, "creator", "U-Boot mkimage %s", PLAIN_VERSION);
426 fdt_property_u32(fdt, "#address-cells", 1);
427 ret = fit_write_images(params, fdt);
430 fit_write_configs(params, fdt);
432 ret = fdt_finish(fdt);
436 return fdt_totalsize(fdt);
439 static int fit_build(struct image_tool_params *params, const char *fname)
446 size = fit_calc_size(params);
449 buf = calloc(1, size);
451 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
452 params->cmdname, size);
455 ret = fit_build_fdt(params, buf, size);
457 fprintf(stderr, "%s: Failed to build FIT image\n",
462 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
464 fprintf(stderr, "%s: Can't open %s: %s\n",
465 params->cmdname, fname, strerror(errno));
468 ret = write(fd, buf, size);
470 fprintf(stderr, "%s: Can't write %s: %s\n",
471 params->cmdname, fname, strerror(errno));
486 * fit_extract_data() - Move all data outside the FIT
488 * This takes a normal FIT file and removes all the 'data' properties from it.
489 * The data is placed in an area after the FIT so that it can be accessed
490 * using an offset into that area. The 'data' properties turn into
491 * 'data-offset' properties.
493 * This function cannot cope with FITs with 'data-offset' properties. All
494 * data must be in 'data' properties on entry.
496 static int fit_extract_data(struct image_tool_params *params, const char *fname)
500 int fit_size, new_size;
510 align_size = params->bl_len ? params->bl_len : 4;
511 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false, false);
514 fit_size = fdt_totalsize(fdt);
516 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
518 debug("%s: Cannot find /images node: %d\n", __func__, images);
522 image_number = fdtdec_get_child_count(fdt, images);
525 * Allocate space to hold the image data we will extract,
526 * extral space allocate for image alignment to prevent overflow.
528 buf = calloc(1, fit_size + (align_size * image_number));
535 for (node = fdt_first_subnode(fdt, images);
537 node = fdt_next_subnode(fdt, node)) {
541 data = fdt_getprop(fdt, node, FIT_DATA_PROP, &len);
544 memcpy(buf + buf_ptr, data, len);
545 debug("Extracting data size %x\n", len);
547 ret = fdt_delprop(fdt, node, FIT_DATA_PROP);
552 if (params->external_offset > 0) {
553 /* An external offset positions the data absolutely. */
554 fdt_setprop_u32(fdt, node, FIT_DATA_POSITION_PROP,
555 params->external_offset + buf_ptr);
557 fdt_setprop_u32(fdt, node, FIT_DATA_OFFSET_PROP,
560 fdt_setprop_u32(fdt, node, FIT_DATA_SIZE_PROP, len);
561 buf_ptr += ALIGN(len, align_size);
564 /* Pack the FDT and place the data after it */
567 new_size = fdt_totalsize(fdt);
568 new_size = ALIGN(new_size, align_size);
569 fdt_set_totalsize(fdt, new_size);
570 debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
571 debug("External data size %x\n", buf_ptr);
572 munmap(fdt, sbuf.st_size);
574 if (ftruncate(fd, new_size)) {
575 debug("%s: Failed to truncate file: %s\n", __func__,
581 /* Check if an offset for the external data was set. */
582 if (params->external_offset > 0) {
583 if (params->external_offset < new_size) {
585 "External offset %x overlaps FIT length %x\n",
586 params->external_offset, new_size);
590 new_size = params->external_offset;
592 if (lseek(fd, new_size, SEEK_SET) < 0) {
593 debug("%s: Failed to seek to end of file: %s\n", __func__,
598 if (write(fd, buf, buf_ptr) != buf_ptr) {
599 debug("%s: Failed to write external data to file %s\n",
600 __func__, strerror(errno));
609 munmap(fdt, sbuf.st_size);
616 static int fit_import_data(struct image_tool_params *params, const char *fname)
619 int fit_size, new_size, size, data_base;
626 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false, false);
629 fit_size = fdt_totalsize(old_fdt);
630 data_base = ALIGN(fit_size, 4);
632 /* Allocate space to hold the new FIT */
633 size = sbuf.st_size + 16384;
634 fdt = calloc(1, size);
636 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
641 ret = fdt_open_into(old_fdt, fdt, size);
643 debug("%s: Failed to expand FIT: %s\n", __func__,
644 fdt_strerror(errno));
649 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
651 debug("%s: Cannot find /images node: %d\n", __func__, images);
656 for (node = fdt_first_subnode(fdt, images);
658 node = fdt_next_subnode(fdt, node)) {
662 buf_ptr = fdtdec_get_int(fdt, node, "data-offset", -1);
663 len = fdtdec_get_int(fdt, node, "data-size", -1);
664 if (buf_ptr == -1 || len == -1)
666 debug("Importing data size %x\n", len);
668 ret = fdt_setprop(fdt, node, "data",
669 old_fdt + data_base + buf_ptr, len);
671 debug("%s: Failed to write property: %s\n", __func__,
678 munmap(old_fdt, sbuf.st_size);
680 /* Close the old fd so we can re-use it. */
683 /* Pack the FDT and place the data after it */
686 new_size = fdt_totalsize(fdt);
687 debug("Size expanded from %x to %x\n", fit_size, new_size);
689 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
691 fprintf(stderr, "%s: Can't open %s: %s\n",
692 params->cmdname, fname, strerror(errno));
696 if (write(fd, fdt, new_size) != new_size) {
697 debug("%s: Failed to write external data to file %s\n",
698 __func__, strerror(errno));
708 munmap(old_fdt, sbuf.st_size);
716 * fit_handle_file - main FIT file processing function
718 * fit_handle_file() runs dtc to convert .its to .itb, includes
719 * binary data, updates timestamp property and calculates hashes.
721 * datafile - .its file
722 * imagefile - .itb file
725 * only on success, otherwise calls exit (EXIT_FAILURE);
727 static int fit_handle_file(struct image_tool_params *params)
729 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
730 char bakfile[MKIMAGE_MAX_TMPFILE_LEN + 4] = {0};
731 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
735 /* Flattened Image Tree (FIT) format handling */
736 debug ("FIT format handling\n");
738 /* call dtc to include binary properties into the tmp file */
739 if (strlen (params->imagefile) +
740 strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
741 fprintf (stderr, "%s: Image file name (%s) too long, "
742 "can't create tmpfile.\n",
743 params->imagefile, params->cmdname);
744 return (EXIT_FAILURE);
746 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
748 /* We either compile the source file, or use the existing FIT image */
749 if (params->auto_fit) {
750 if (fit_build(params, tmpfile)) {
751 fprintf(stderr, "%s: failed to build FIT\n",
756 } else if (params->datafile) {
757 /* dtc -I dts -O dtb -p 500 -o tmpfile datafile */
758 snprintf(cmd, sizeof(cmd), "%s %s -o \"%s\" \"%s\"",
759 MKIMAGE_DTC, params->dtc, tmpfile, params->datafile);
760 debug("Trying to execute \"%s\"\n", cmd);
762 snprintf(cmd, sizeof(cmd), "cp \"%s\" \"%s\"",
763 params->imagefile, tmpfile);
765 if (strlen(cmd) >= MKIMAGE_MAX_DTC_CMDLINE_LEN - 1) {
766 fprintf(stderr, "WARNING: command-line for FIT creation might be truncated and will probably fail.\n");
769 if (*cmd && system(cmd) == -1) {
770 fprintf (stderr, "%s: system(%s) failed: %s\n",
771 params->cmdname, cmd, strerror(errno));
775 /* Move the data so it is internal to the FIT, if needed */
776 ret = fit_import_data(params, tmpfile);
781 * Copy the tmpfile to bakfile, then in the following loop
782 * we copy bakfile to tmpfile. So we always start from the
785 sprintf(bakfile, "%s%s", tmpfile, ".bak");
786 rename(tmpfile, bakfile);
789 * Set hashes for images in the blob. Unfortunately we may need more
790 * space in either FDT, so keep trying until we succeed.
792 * Note: this is pretty inefficient for signing, since we must
793 * calculate the signature every time. It would be better to calculate
794 * all the data and then store it in a separate step. However, this
795 * would be considerably more complex to implement. Generally a few
796 * steps of this loop is enough to sign with several keys.
798 for (size_inc = 0; size_inc < 64 * 1024; size_inc += 1024) {
799 if (copyfile(bakfile, tmpfile) < 0) {
800 printf("Can't copy %s to %s\n", bakfile, tmpfile);
804 ret = fit_add_file_data(params, size_inc, tmpfile);
805 if (!ret || ret != -ENOSPC)
810 fprintf(stderr, "%s Can't add hashes to FIT blob: %d\n",
811 params->cmdname, ret);
815 /* Move the data so it is external to the FIT, if requested */
816 if (params->external_data) {
817 ret = fit_extract_data(params, tmpfile);
822 if (rename (tmpfile, params->imagefile) == -1) {
823 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
824 params->cmdname, tmpfile, params->imagefile,
828 unlink (params->imagefile);
841 * fit_image_extract - extract a FIT component image
842 * @fit: pointer to the FIT format image header
843 * @image_noffset: offset of the component image node
844 * @file_name: name of the file to store the FIT sub-image
847 * zero in case of success or a negative value if fail.
849 static int fit_image_extract(
852 const char *file_name)
854 const void *file_data;
855 size_t file_size = 0;
858 /* get the data address and size of component at offset "image_noffset" */
859 ret = fit_image_get_data_and_size(fit, image_noffset, &file_data, &file_size);
861 fprintf(stderr, "Could not get component information\n");
865 /* save the "file_data" into the file specified by "file_name" */
866 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
870 * fit_extract_contents - retrieve a sub-image component from the FIT image
871 * @ptr: pointer to the FIT format image header
872 * @params: command line parameters
875 * zero in case of success or a negative value if fail.
877 static int fit_extract_contents(void *ptr, struct image_tool_params *params)
882 const void *fit = ptr;
886 /* Indent string is defined in header image.h */
887 p = IMAGE_INDENT_STRING;
889 /* Find images parent node offset */
890 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
891 if (images_noffset < 0) {
892 printf("Can't find images parent node '%s' (%s)\n",
893 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
897 /* Avoid any overrun */
898 count = fit_get_subimage_count(fit, images_noffset);
899 if ((params->pflag < 0) || (count <= params->pflag)) {
900 printf("No such component at '%d'\n", params->pflag);
904 /* Process its subnodes, extract the desired component from image */
905 for (ndepth = 0, count = 0,
906 noffset = fdt_next_node(fit, images_noffset, &ndepth);
907 (noffset >= 0) && (ndepth > 0);
908 noffset = fdt_next_node(fit, noffset, &ndepth)) {
911 * Direct child node of the images parent node,
912 * i.e. component image node.
914 if (params->pflag == count) {
915 printf("Extracted:\n%s Image %u (%s)\n", p,
916 count, fit_get_name(fit, noffset, NULL));
918 fit_image_print(fit, noffset, p);
920 return fit_image_extract(fit, noffset,
931 static int fit_check_params(struct image_tool_params *params)
933 if (params->auto_fit)
935 return ((params->dflag && params->fflag) ||
936 (params->fflag && params->lflag) ||
937 (params->lflag && params->dflag));
943 sizeof(struct legacy_img_hdr),
949 fit_extract_contents,
950 fit_check_image_types,
952 NULL /* FIT images use DTB header */