1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2004
6 * DENX Software Engineering
7 * Wolfgang Denk, wd@denx.de
9 * Updated-by: Prafulla Wadaskar <prafulla@marvell.com>
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"
22 #include <u-boot/crc.h>
24 static image_header_t header;
26 static int fit_add_file_data(struct image_tool_params *params, size_t size_inc,
30 void *dest_blob = NULL;
31 off_t destfd_size = 0;
36 tfd = mmap_fdt(params->cmdname, tmpfile, size_inc, &ptr, &sbuf, true);
40 if (params->keydest) {
41 struct stat dest_sbuf;
43 destfd = mmap_fdt(params->cmdname, params->keydest, size_inc,
44 &dest_blob, &dest_sbuf, false);
49 destfd_size = dest_sbuf.st_size;
52 /* for first image creation, add a timestamp at offset 0 i.e., root */
53 if (params->datafile) {
54 time_t time = imagetool_get_source_date(params->cmdname,
56 ret = fit_set_timestamp(ptr, 0, time);
60 ret = fit_add_verification_data(params->keydir, dest_blob, ptr,
68 munmap(dest_blob, destfd_size);
73 munmap(ptr, sbuf.st_size);
80 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
82 static int fit_calc_size(struct image_tool_params *params)
84 struct content_info *cont;
87 size = imagetool_get_filesize(params, params->datafile);
92 if (params->fit_ramdisk) {
93 size = imagetool_get_filesize(params, params->fit_ramdisk);
99 for (cont = params->content_head; cont; cont = cont->next) {
100 size = imagetool_get_filesize(params, cont->fname);
104 /* Add space for properties */
105 total_size += size + 300;
108 /* Add plenty of space for headers, properties, nodes, etc. */
114 static int fdt_property_file(struct image_tool_params *params,
115 void *fdt, const char *name, const char *fname)
122 fd = open(fname, O_RDWR | O_BINARY);
124 fprintf(stderr, "%s: Can't open %s: %s\n",
125 params->cmdname, fname, strerror(errno));
129 if (fstat(fd, &sbuf) < 0) {
130 fprintf(stderr, "%s: Can't stat %s: %s\n",
131 params->cmdname, fname, strerror(errno));
135 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
138 ret = read(fd, ptr, sbuf.st_size);
139 if (ret != sbuf.st_size) {
140 fprintf(stderr, "%s: Can't read %s: %s\n",
141 params->cmdname, fname, strerror(errno));
152 static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
158 vsnprintf(str, sizeof(str), fmt, ptr);
160 return fdt_property_string(fdt, name, str);
163 static void get_basename(char *str, int size, const char *fname)
165 const char *p, *start, *end;
169 * Use the base name as the 'name' field. So for example:
171 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
172 * becomes "sun7i-a20-bananapro"
174 p = strrchr(fname, '/');
175 start = p ? p + 1 : fname;
176 p = strrchr(fname, '.');
177 end = p ? p : fname + strlen(fname);
181 memcpy(str, start, len);
186 * fit_write_images() - Write out a list of images to the FIT
188 * We always include the main image (params->datafile). If there are device
189 * tree files, we include an fdt- node for each of those too.
191 static int fit_write_images(struct image_tool_params *params, char *fdt)
193 struct content_info *cont;
194 const char *typename;
199 fdt_begin_node(fdt, "images");
201 /* First the main image */
202 typename = genimg_get_type_short_name(params->fit_image_type);
203 snprintf(str, sizeof(str), "%s-1", typename);
204 fdt_begin_node(fdt, str);
205 fdt_property_string(fdt, "description", params->imagename);
206 fdt_property_string(fdt, "type", typename);
207 fdt_property_string(fdt, "arch",
208 genimg_get_arch_short_name(params->arch));
209 fdt_property_string(fdt, "os", genimg_get_os_short_name(params->os));
210 fdt_property_string(fdt, "compression",
211 genimg_get_comp_short_name(params->comp));
212 fdt_property_u32(fdt, "load", params->addr);
213 fdt_property_u32(fdt, "entry", params->ep);
216 * Put data last since it is large. SPL may only load the first part
217 * of the DT, so this way it can access all the above fields.
219 ret = fdt_property_file(params, fdt, "data", params->datafile);
224 /* Now the device tree files if available */
226 for (cont = params->content_head; cont; cont = cont->next) {
227 if (cont->type != IH_TYPE_FLATDT)
229 snprintf(str, sizeof(str), "%s-%d", FIT_FDT_PROP, ++upto);
230 fdt_begin_node(fdt, str);
232 get_basename(str, sizeof(str), cont->fname);
233 fdt_property_string(fdt, "description", str);
234 ret = fdt_property_file(params, fdt, "data", cont->fname);
237 fdt_property_string(fdt, "type", typename);
238 fdt_property_string(fdt, "arch",
239 genimg_get_arch_short_name(params->arch));
240 fdt_property_string(fdt, "compression",
241 genimg_get_comp_short_name(IH_COMP_NONE));
245 /* And a ramdisk file if available */
246 if (params->fit_ramdisk) {
247 fdt_begin_node(fdt, FIT_RAMDISK_PROP "-1");
249 fdt_property_string(fdt, "type", FIT_RAMDISK_PROP);
250 fdt_property_string(fdt, "os", genimg_get_os_short_name(params->os));
252 ret = fdt_property_file(params, fdt, "data", params->fit_ramdisk);
265 * fit_write_configs() - Write out a list of configurations to the FIT
267 * If there are device tree files, we include a configuration for each, which
268 * selects the main image (params->datafile) and its corresponding device
271 * Otherwise we just create a configuration with the main image in it.
273 static void fit_write_configs(struct image_tool_params *params, char *fdt)
275 struct content_info *cont;
276 const char *typename;
280 fdt_begin_node(fdt, "configurations");
281 fdt_property_string(fdt, "default", "conf-1");
284 for (cont = params->content_head; cont; cont = cont->next) {
285 if (cont->type != IH_TYPE_FLATDT)
287 typename = genimg_get_type_short_name(cont->type);
288 snprintf(str, sizeof(str), "conf-%d", ++upto);
289 fdt_begin_node(fdt, str);
291 get_basename(str, sizeof(str), cont->fname);
292 fdt_property_string(fdt, "description", str);
294 typename = genimg_get_type_short_name(params->fit_image_type);
295 snprintf(str, sizeof(str), "%s-1", typename);
296 fdt_property_string(fdt, typename, str);
298 if (params->fit_ramdisk)
299 fdt_property_string(fdt, FIT_RAMDISK_PROP,
300 FIT_RAMDISK_PROP "-1");
302 snprintf(str, sizeof(str), FIT_FDT_PROP "-%d", upto);
303 fdt_property_string(fdt, FIT_FDT_PROP, str);
308 fdt_begin_node(fdt, "conf-1");
309 typename = genimg_get_type_short_name(params->fit_image_type);
310 snprintf(str, sizeof(str), "%s-1", typename);
311 fdt_property_string(fdt, typename, str);
313 if (params->fit_ramdisk)
314 fdt_property_string(fdt, FIT_RAMDISK_PROP,
315 FIT_RAMDISK_PROP "-1");
323 static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
327 ret = fdt_create(fdt, size);
330 fdt_finish_reservemap(fdt);
331 fdt_begin_node(fdt, "");
332 fdt_property_strf(fdt, "description",
333 "%s image with one or more FDT blobs",
334 genimg_get_type_name(params->fit_image_type));
335 fdt_property_strf(fdt, "creator", "U-Boot mkimage %s", PLAIN_VERSION);
336 fdt_property_u32(fdt, "#address-cells", 1);
337 ret = fit_write_images(params, fdt);
340 fit_write_configs(params, fdt);
342 ret = fdt_finish(fdt);
346 return fdt_totalsize(fdt);
349 static int fit_build(struct image_tool_params *params, const char *fname)
356 size = fit_calc_size(params);
361 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
362 params->cmdname, size);
365 ret = fit_build_fdt(params, buf, size);
367 fprintf(stderr, "%s: Failed to build FIT image\n",
372 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
374 fprintf(stderr, "%s: Can't open %s: %s\n",
375 params->cmdname, fname, strerror(errno));
378 ret = write(fd, buf, size);
380 fprintf(stderr, "%s: Can't write %s: %s\n",
381 params->cmdname, fname, strerror(errno));
396 * fit_extract_data() - Move all data outside the FIT
398 * This takes a normal FIT file and removes all the 'data' properties from it.
399 * The data is placed in an area after the FIT so that it can be accessed
400 * using an offset into that area. The 'data' properties turn into
401 * 'data-offset' properties.
403 * This function cannot cope with FITs with 'data-offset' properties. All
404 * data must be in 'data' properties on entry.
406 static int fit_extract_data(struct image_tool_params *params, const char *fname)
410 int fit_size, new_size;
418 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false);
421 fit_size = fdt_totalsize(fdt);
423 /* Allocate space to hold the image data we will extract */
424 buf = malloc(fit_size);
431 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
433 debug("%s: Cannot find /images node: %d\n", __func__, images);
438 for (node = fdt_first_subnode(fdt, images);
440 node = fdt_next_subnode(fdt, node)) {
444 data = fdt_getprop(fdt, node, "data", &len);
447 memcpy(buf + buf_ptr, data, len);
448 debug("Extracting data size %x\n", len);
450 ret = fdt_delprop(fdt, node, "data");
455 if (params->external_offset > 0) {
456 /* An external offset positions the data absolutely. */
457 fdt_setprop_u32(fdt, node, "data-position",
458 params->external_offset + buf_ptr);
460 fdt_setprop_u32(fdt, node, "data-offset", buf_ptr);
462 fdt_setprop_u32(fdt, node, "data-size", len);
464 buf_ptr += (len + 3) & ~3;
467 /* Pack the FDT and place the data after it */
470 debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
471 debug("External data size %x\n", buf_ptr);
472 new_size = fdt_totalsize(fdt);
473 new_size = (new_size + 3) & ~3;
474 munmap(fdt, sbuf.st_size);
476 if (ftruncate(fd, new_size)) {
477 debug("%s: Failed to truncate file: %s\n", __func__,
483 /* Check if an offset for the external data was set. */
484 if (params->external_offset > 0) {
485 if (params->external_offset < new_size) {
486 debug("External offset %x overlaps FIT length %x",
487 params->external_offset, new_size);
491 new_size = params->external_offset;
493 if (lseek(fd, new_size, SEEK_SET) < 0) {
494 debug("%s: Failed to seek to end of file: %s\n", __func__,
499 if (write(fd, buf, buf_ptr) != buf_ptr) {
500 debug("%s: Failed to write external data to file %s\n",
501 __func__, strerror(errno));
510 munmap(fdt, sbuf.st_size);
518 static int fit_import_data(struct image_tool_params *params, const char *fname)
521 int fit_size, new_size, size, data_base;
528 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false);
531 fit_size = fdt_totalsize(old_fdt);
532 data_base = (fit_size + 3) & ~3;
534 /* Allocate space to hold the new FIT */
535 size = sbuf.st_size + 16384;
538 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
543 ret = fdt_open_into(old_fdt, fdt, size);
545 debug("%s: Failed to expand FIT: %s\n", __func__,
546 fdt_strerror(errno));
551 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
553 debug("%s: Cannot find /images node: %d\n", __func__, images);
558 for (node = fdt_first_subnode(fdt, images);
560 node = fdt_next_subnode(fdt, node)) {
564 buf_ptr = fdtdec_get_int(fdt, node, "data-offset", -1);
565 len = fdtdec_get_int(fdt, node, "data-size", -1);
566 if (buf_ptr == -1 || len == -1)
568 debug("Importing data size %x\n", len);
570 ret = fdt_setprop(fdt, node, "data", fdt + data_base + buf_ptr,
573 debug("%s: Failed to write property: %s\n", __func__,
580 /* Close the old fd so we can re-use it. */
583 /* Pack the FDT and place the data after it */
586 new_size = fdt_totalsize(fdt);
587 debug("Size expanded from %x to %x\n", fit_size, new_size);
589 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
591 fprintf(stderr, "%s: Can't open %s: %s\n",
592 params->cmdname, fname, strerror(errno));
596 if (write(fd, fdt, new_size) != new_size) {
597 debug("%s: Failed to write external data to file %s\n",
598 __func__, strerror(errno));
608 munmap(old_fdt, sbuf.st_size);
614 * fit_handle_file - main FIT file processing function
616 * fit_handle_file() runs dtc to convert .its to .itb, includes
617 * binary data, updates timestamp property and calculates hashes.
619 * datafile - .its file
620 * imagefile - .itb file
623 * only on success, otherwise calls exit (EXIT_FAILURE);
625 static int fit_handle_file(struct image_tool_params *params)
627 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
628 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
632 /* Flattened Image Tree (FIT) format handling */
633 debug ("FIT format handling\n");
635 /* call dtc to include binary properties into the tmp file */
636 if (strlen (params->imagefile) +
637 strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
638 fprintf (stderr, "%s: Image file name (%s) too long, "
639 "can't create tmpfile",
640 params->imagefile, params->cmdname);
641 return (EXIT_FAILURE);
643 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
645 /* We either compile the source file, or use the existing FIT image */
646 if (params->auto_its) {
647 if (fit_build(params, tmpfile)) {
648 fprintf(stderr, "%s: failed to build FIT\n",
653 } else if (params->datafile) {
654 /* dtc -I dts -O dtb -p 500 -o tmpfile datafile */
655 snprintf(cmd, sizeof(cmd), "%s %s -o \"%s\" \"%s\"",
656 MKIMAGE_DTC, params->dtc, tmpfile, params->datafile);
657 debug("Trying to execute \"%s\"\n", cmd);
659 snprintf(cmd, sizeof(cmd), "cp \"%s\" \"%s\"",
660 params->imagefile, tmpfile);
662 if (*cmd && system(cmd) == -1) {
663 fprintf (stderr, "%s: system(%s) failed: %s\n",
664 params->cmdname, cmd, strerror(errno));
668 /* Move the data so it is internal to the FIT, if needed */
669 ret = fit_import_data(params, tmpfile);
674 * Set hashes for images in the blob. Unfortunately we may need more
675 * space in either FDT, so keep trying until we succeed.
677 * Note: this is pretty inefficient for signing, since we must
678 * calculate the signature every time. It would be better to calculate
679 * all the data and then store it in a separate step. However, this
680 * would be considerably more complex to implement. Generally a few
681 * steps of this loop is enough to sign with several keys.
683 for (size_inc = 0; size_inc < 64 * 1024; size_inc += 1024) {
684 ret = fit_add_file_data(params, size_inc, tmpfile);
685 if (!ret || ret != -ENOSPC)
690 fprintf(stderr, "%s Can't add hashes to FIT blob: %d\n",
691 params->cmdname, ret);
695 /* Move the data so it is external to the FIT, if requested */
696 if (params->external_data) {
697 ret = fit_extract_data(params, tmpfile);
702 if (rename (tmpfile, params->imagefile) == -1) {
703 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
704 params->cmdname, tmpfile, params->imagefile,
707 unlink (params->imagefile);
718 * fit_image_extract - extract a FIT component image
719 * @fit: pointer to the FIT format image header
720 * @image_noffset: offset of the component image node
721 * @file_name: name of the file to store the FIT sub-image
724 * zero in case of success or a negative value if fail.
726 static int fit_image_extract(
729 const char *file_name)
731 const void *file_data;
732 size_t file_size = 0;
734 /* get the "data" property of component at offset "image_noffset" */
735 fit_image_get_data(fit, image_noffset, &file_data, &file_size);
737 /* save the "file_data" into the file specified by "file_name" */
738 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
742 * fit_extract_contents - retrieve a sub-image component from the FIT image
743 * @ptr: pointer to the FIT format image header
744 * @params: command line parameters
747 * zero in case of success or a negative value if fail.
749 static int fit_extract_contents(void *ptr, struct image_tool_params *params)
754 const void *fit = ptr;
758 /* Indent string is defined in header image.h */
759 p = IMAGE_INDENT_STRING;
761 if (!fit_check_format(fit)) {
762 printf("Bad FIT image format\n");
766 /* Find images parent node offset */
767 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
768 if (images_noffset < 0) {
769 printf("Can't find images parent node '%s' (%s)\n",
770 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
774 /* Avoid any overrun */
775 count = fit_get_subimage_count(fit, images_noffset);
776 if ((params->pflag < 0) || (count <= params->pflag)) {
777 printf("No such component at '%d'\n", params->pflag);
781 /* Process its subnodes, extract the desired component from image */
782 for (ndepth = 0, count = 0,
783 noffset = fdt_next_node(fit, images_noffset, &ndepth);
784 (noffset >= 0) && (ndepth > 0);
785 noffset = fdt_next_node(fit, noffset, &ndepth)) {
788 * Direct child node of the images parent node,
789 * i.e. component image node.
791 if (params->pflag == count) {
792 printf("Extracted:\n%s Image %u (%s)\n", p,
793 count, fit_get_name(fit, noffset, NULL));
795 fit_image_print(fit, noffset, p);
797 return fit_image_extract(fit, noffset,
808 static int fit_check_params(struct image_tool_params *params)
810 if (params->auto_its)
812 return ((params->dflag && (params->fflag || params->lflag)) ||
813 (params->fflag && (params->dflag || params->lflag)) ||
814 (params->lflag && (params->dflag || params->fflag)));
820 sizeof(image_header_t),
826 fit_extract_contents,
827 fit_check_image_types,
829 NULL /* FIT images use DTB header */