2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2004
5 * DENX Software Engineering
6 * Wolfgang Denk, wd@denx.de
8 * Updated-by: Prafulla Wadaskar <prafulla@marvell.com>
9 * FIT image specific code abstracted from mkimage.c
10 * some functions added to address abstraction
12 * All rights reserved.
14 * SPDX-License-Identifier: GPL-2.0+
17 #include "imagetool.h"
18 #include "fit_common.h"
23 #include <u-boot/crc.h>
25 static image_header_t 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);
41 if (params->keydest) {
42 struct stat dest_sbuf;
44 destfd = mmap_fdt(params->cmdname, params->keydest, size_inc,
45 &dest_blob, &dest_sbuf, false);
50 destfd_size = dest_sbuf.st_size;
53 /* for first image creation, add a timestamp at offset 0 i.e., root */
54 if (params->datafile) {
55 time_t time = imagetool_get_source_date(params, sbuf.st_mtime);
56 ret = fit_set_timestamp(ptr, 0, time);
60 ret = fit_add_verification_data(params->keydir, dest_blob, ptr,
62 params->require_keys);
66 munmap(dest_blob, destfd_size);
71 munmap(ptr, sbuf.st_size);
78 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
80 static int fit_calc_size(struct image_tool_params *params)
82 struct content_info *cont;
85 size = imagetool_get_filesize(params, params->datafile);
90 if (params->fit_ramdisk) {
91 size = imagetool_get_filesize(params, params->fit_ramdisk);
97 for (cont = params->content_head; cont; cont = cont->next) {
98 size = imagetool_get_filesize(params, cont->fname);
102 /* Add space for properties */
103 total_size += size + 300;
106 /* Add plenty of space for headers, properties, nodes, etc. */
112 static int fdt_property_file(struct image_tool_params *params,
113 void *fdt, const char *name, const char *fname)
120 fd = open(fname, O_RDWR | O_BINARY);
122 fprintf(stderr, "%s: Can't open %s: %s\n",
123 params->cmdname, fname, strerror(errno));
127 if (fstat(fd, &sbuf) < 0) {
128 fprintf(stderr, "%s: Can't stat %s: %s\n",
129 params->cmdname, fname, strerror(errno));
133 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
136 ret = read(fd, ptr, sbuf.st_size);
137 if (ret != sbuf.st_size) {
138 fprintf(stderr, "%s: Can't read %s: %s\n",
139 params->cmdname, fname, strerror(errno));
150 static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
156 vsnprintf(str, sizeof(str), fmt, ptr);
158 return fdt_property_string(fdt, name, str);
161 static void get_basename(char *str, int size, const char *fname)
163 const char *p, *start, *end;
167 * Use the base name as the 'name' field. So for example:
169 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
170 * becomes "sun7i-a20-bananapro"
172 p = strrchr(fname, '/');
173 start = p ? p + 1 : fname;
174 p = strrchr(fname, '.');
175 end = p ? p : fname + strlen(fname);
179 memcpy(str, start, len);
184 * fit_write_images() - Write out a list of images to the FIT
186 * We always include the main image (params->datafile). If there are device
187 * tree files, we include an fdt@ node for each of those too.
189 static int fit_write_images(struct image_tool_params *params, char *fdt)
191 struct content_info *cont;
192 const char *typename;
197 fdt_begin_node(fdt, "images");
199 /* First the main image */
200 typename = genimg_get_type_short_name(params->fit_image_type);
201 snprintf(str, sizeof(str), "%s@1", typename);
202 fdt_begin_node(fdt, str);
203 fdt_property_string(fdt, "description", params->imagename);
204 fdt_property_string(fdt, "type", typename);
205 fdt_property_string(fdt, "arch",
206 genimg_get_arch_short_name(params->arch));
207 fdt_property_string(fdt, "os", genimg_get_os_short_name(params->os));
208 fdt_property_string(fdt, "compression",
209 genimg_get_comp_short_name(params->comp));
210 fdt_property_u32(fdt, "load", params->addr);
211 fdt_property_u32(fdt, "entry", params->ep);
214 * Put data last since it is large. SPL may only load the first part
215 * of the DT, so this way it can access all the above fields.
217 ret = fdt_property_file(params, fdt, "data", params->datafile);
222 /* Now the device tree files if available */
224 for (cont = params->content_head; cont; cont = cont->next) {
225 if (cont->type != IH_TYPE_FLATDT)
227 snprintf(str, sizeof(str), "%s@%d", FIT_FDT_PROP, ++upto);
228 fdt_begin_node(fdt, str);
230 get_basename(str, sizeof(str), cont->fname);
231 fdt_property_string(fdt, "description", str);
232 ret = fdt_property_file(params, fdt, "data", cont->fname);
235 fdt_property_string(fdt, "type", typename);
236 fdt_property_string(fdt, "arch",
237 genimg_get_arch_short_name(params->arch));
238 fdt_property_string(fdt, "compression",
239 genimg_get_comp_short_name(IH_COMP_NONE));
243 /* And a ramdisk file if available */
244 if (params->fit_ramdisk) {
245 fdt_begin_node(fdt, FIT_RAMDISK_PROP "@1");
247 fdt_property_string(fdt, "type", FIT_RAMDISK_PROP);
248 fdt_property_string(fdt, "os", genimg_get_os_short_name(params->os));
250 ret = fdt_property_file(params, fdt, "data", params->fit_ramdisk);
263 * fit_write_configs() - Write out a list of configurations to the FIT
265 * If there are device tree files, we include a configuration for each, which
266 * selects the main image (params->datafile) and its corresponding device
269 * Otherwise we just create a configuration with the main image in it.
271 static void fit_write_configs(struct image_tool_params *params, char *fdt)
273 struct content_info *cont;
274 const char *typename;
278 fdt_begin_node(fdt, "configurations");
279 fdt_property_string(fdt, "default", "conf@1");
282 for (cont = params->content_head; cont; cont = cont->next) {
283 if (cont->type != IH_TYPE_FLATDT)
285 typename = genimg_get_type_short_name(cont->type);
286 snprintf(str, sizeof(str), "conf@%d", ++upto);
287 fdt_begin_node(fdt, str);
289 get_basename(str, sizeof(str), cont->fname);
290 fdt_property_string(fdt, "description", str);
292 typename = genimg_get_type_short_name(params->fit_image_type);
293 snprintf(str, sizeof(str), "%s@1", typename);
294 fdt_property_string(fdt, typename, str);
296 if (params->fit_ramdisk)
297 fdt_property_string(fdt, FIT_RAMDISK_PROP,
298 FIT_RAMDISK_PROP "@1");
300 snprintf(str, sizeof(str), FIT_FDT_PROP "@%d", upto);
301 fdt_property_string(fdt, FIT_FDT_PROP, str);
306 fdt_begin_node(fdt, "conf@1");
307 typename = genimg_get_type_short_name(params->fit_image_type);
308 snprintf(str, sizeof(str), "%s@1", typename);
309 fdt_property_string(fdt, typename, str);
311 if (params->fit_ramdisk)
312 fdt_property_string(fdt, FIT_RAMDISK_PROP,
313 FIT_RAMDISK_PROP "@1");
321 static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
325 ret = fdt_create(fdt, size);
328 fdt_finish_reservemap(fdt);
329 fdt_begin_node(fdt, "");
330 fdt_property_strf(fdt, "description",
331 "%s image with one or more FDT blobs",
332 genimg_get_type_name(params->fit_image_type));
333 fdt_property_strf(fdt, "creator", "U-Boot mkimage %s", PLAIN_VERSION);
334 fdt_property_u32(fdt, "#address-cells", 1);
335 ret = fit_write_images(params, fdt);
338 fit_write_configs(params, fdt);
340 ret = fdt_finish(fdt);
344 return fdt_totalsize(fdt);
347 static int fit_build(struct image_tool_params *params, const char *fname)
354 size = fit_calc_size(params);
359 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
360 params->cmdname, size);
363 ret = fit_build_fdt(params, buf, size);
365 fprintf(stderr, "%s: Failed to build FIT image\n",
370 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
372 fprintf(stderr, "%s: Can't open %s: %s\n",
373 params->cmdname, fname, strerror(errno));
376 ret = write(fd, buf, size);
378 fprintf(stderr, "%s: Can't write %s: %s\n",
379 params->cmdname, fname, strerror(errno));
394 * fit_extract_data() - Move all data outside the FIT
396 * This takes a normal FIT file and removes all the 'data' properties from it.
397 * The data is placed in an area after the FIT so that it can be accessed
398 * using an offset into that area. The 'data' properties turn into
399 * 'data-offset' properties.
401 * This function cannot cope with FITs with 'data-offset' properties. All
402 * data must be in 'data' properties on entry.
404 static int fit_extract_data(struct image_tool_params *params, const char *fname)
408 int fit_size, new_size;
416 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false);
419 fit_size = fdt_totalsize(fdt);
421 /* Allocate space to hold the image data we will extract */
422 buf = malloc(fit_size);
429 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
431 debug("%s: Cannot find /images node: %d\n", __func__, images);
436 for (node = fdt_first_subnode(fdt, images);
438 node = fdt_next_subnode(fdt, node)) {
442 data = fdt_getprop(fdt, node, "data", &len);
445 memcpy(buf + buf_ptr, data, len);
446 debug("Extracting data size %x\n", len);
448 ret = fdt_delprop(fdt, node, "data");
453 if (params->external_offset > 0) {
454 /* An external offset positions the data absolutely. */
455 fdt_setprop_u32(fdt, node, "data-position",
456 params->external_offset + buf_ptr);
458 fdt_setprop_u32(fdt, node, "data-offset", buf_ptr);
460 fdt_setprop_u32(fdt, node, "data-size", len);
462 buf_ptr += (len + 3) & ~3;
465 /* Pack the FDT and place the data after it */
468 debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
469 debug("External data size %x\n", buf_ptr);
470 new_size = fdt_totalsize(fdt);
471 new_size = (new_size + 3) & ~3;
472 munmap(fdt, sbuf.st_size);
474 if (ftruncate(fd, new_size)) {
475 debug("%s: Failed to truncate file: %s\n", __func__,
481 /* Check if an offset for the external data was set. */
482 if (params->external_offset > 0) {
483 if (params->external_offset < new_size) {
484 debug("External offset %x overlaps FIT length %x",
485 params->external_offset, new_size);
489 new_size = params->external_offset;
491 if (lseek(fd, new_size, SEEK_SET) < 0) {
492 debug("%s: Failed to seek to end of file: %s\n", __func__,
497 if (write(fd, buf, buf_ptr) != buf_ptr) {
498 debug("%s: Failed to write external data to file %s\n",
499 __func__, strerror(errno));
507 munmap(fdt, sbuf.st_size);
515 static int fit_import_data(struct image_tool_params *params, const char *fname)
518 int fit_size, new_size, size, data_base;
525 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false);
528 fit_size = fdt_totalsize(old_fdt);
529 data_base = (fit_size + 3) & ~3;
531 /* Allocate space to hold the new FIT */
532 size = sbuf.st_size + 16384;
535 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
540 ret = fdt_open_into(old_fdt, fdt, size);
542 debug("%s: Failed to expand FIT: %s\n", __func__,
543 fdt_strerror(errno));
548 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
550 debug("%s: Cannot find /images node: %d\n", __func__, images);
555 for (node = fdt_first_subnode(fdt, images);
557 node = fdt_next_subnode(fdt, node)) {
561 buf_ptr = fdtdec_get_int(fdt, node, "data-offset", -1);
562 len = fdtdec_get_int(fdt, node, "data-size", -1);
563 if (buf_ptr == -1 || len == -1)
565 debug("Importing data size %x\n", len);
567 ret = fdt_setprop(fdt, node, "data", fdt + data_base + buf_ptr,
570 debug("%s: Failed to write property: %s\n", __func__,
577 munmap(old_fdt, sbuf.st_size);
580 /* Pack the FDT and place the data after it */
583 new_size = fdt_totalsize(fdt);
584 debug("Size expanded from %x to %x\n", fit_size, new_size);
586 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
588 fprintf(stderr, "%s: Can't open %s: %s\n",
589 params->cmdname, fname, strerror(errno));
593 if (write(fd, fdt, new_size) != new_size) {
594 debug("%s: Failed to write external data to file %s\n",
595 __func__, strerror(errno));
609 * fit_handle_file - main FIT file processing function
611 * fit_handle_file() runs dtc to convert .its to .itb, includes
612 * binary data, updates timestamp property and calculates hashes.
614 * datafile - .its file
615 * imagefile - .itb file
618 * only on success, otherwise calls exit (EXIT_FAILURE);
620 static int fit_handle_file(struct image_tool_params *params)
622 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
623 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
627 /* Flattened Image Tree (FIT) format handling */
628 debug ("FIT format handling\n");
630 /* call dtc to include binary properties into the tmp file */
631 if (strlen (params->imagefile) +
632 strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
633 fprintf (stderr, "%s: Image file name (%s) too long, "
634 "can't create tmpfile",
635 params->imagefile, params->cmdname);
636 return (EXIT_FAILURE);
638 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
640 /* We either compile the source file, or use the existing FIT image */
641 if (params->auto_its) {
642 if (fit_build(params, tmpfile)) {
643 fprintf(stderr, "%s: failed to build FIT\n",
648 } else if (params->datafile) {
649 /* dtc -I dts -O dtb -p 500 datafile > tmpfile */
650 snprintf(cmd, sizeof(cmd), "%s %s %s > %s",
651 MKIMAGE_DTC, params->dtc, params->datafile, tmpfile);
652 debug("Trying to execute \"%s\"\n", cmd);
654 snprintf(cmd, sizeof(cmd), "cp %s %s",
655 params->imagefile, tmpfile);
657 if (*cmd && system(cmd) == -1) {
658 fprintf (stderr, "%s: system(%s) failed: %s\n",
659 params->cmdname, cmd, strerror(errno));
663 /* Move the data so it is internal to the FIT, if needed */
664 ret = fit_import_data(params, tmpfile);
669 * Set hashes for images in the blob. Unfortunately we may need more
670 * space in either FDT, so keep trying until we succeed.
672 * Note: this is pretty inefficient for signing, since we must
673 * calculate the signature every time. It would be better to calculate
674 * all the data and then store it in a separate step. However, this
675 * would be considerably more complex to implement. Generally a few
676 * steps of this loop is enough to sign with several keys.
678 for (size_inc = 0; size_inc < 64 * 1024; size_inc += 1024) {
679 ret = fit_add_file_data(params, size_inc, tmpfile);
680 if (!ret || ret != -ENOSPC)
685 fprintf(stderr, "%s Can't add hashes to FIT blob: %d\n",
686 params->cmdname, ret);
690 /* Move the data so it is external to the FIT, if requested */
691 if (params->external_data) {
692 ret = fit_extract_data(params, tmpfile);
697 if (rename (tmpfile, params->imagefile) == -1) {
698 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
699 params->cmdname, tmpfile, params->imagefile,
702 unlink (params->imagefile);
713 * fit_image_extract - extract a FIT component image
714 * @fit: pointer to the FIT format image header
715 * @image_noffset: offset of the component image node
716 * @file_name: name of the file to store the FIT sub-image
719 * zero in case of success or a negative value if fail.
721 static int fit_image_extract(
724 const char *file_name)
726 const void *file_data;
727 size_t file_size = 0;
729 /* get the "data" property of component at offset "image_noffset" */
730 fit_image_get_data(fit, image_noffset, &file_data, &file_size);
732 /* save the "file_data" into the file specified by "file_name" */
733 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
737 * fit_extract_contents - retrieve a sub-image component from the FIT image
738 * @ptr: pointer to the FIT format image header
739 * @params: command line parameters
742 * zero in case of success or a negative value if fail.
744 static int fit_extract_contents(void *ptr, struct image_tool_params *params)
749 const void *fit = ptr;
753 /* Indent string is defined in header image.h */
754 p = IMAGE_INDENT_STRING;
756 if (!fit_check_format(fit)) {
757 printf("Bad FIT image format\n");
761 /* Find images parent node offset */
762 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
763 if (images_noffset < 0) {
764 printf("Can't find images parent node '%s' (%s)\n",
765 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
769 /* Avoid any overrun */
770 count = fit_get_subimage_count(fit, images_noffset);
771 if ((params->pflag < 0) || (count <= params->pflag)) {
772 printf("No such component at '%d'\n", params->pflag);
776 /* Process its subnodes, extract the desired component from image */
777 for (ndepth = 0, count = 0,
778 noffset = fdt_next_node(fit, images_noffset, &ndepth);
779 (noffset >= 0) && (ndepth > 0);
780 noffset = fdt_next_node(fit, noffset, &ndepth)) {
783 * Direct child node of the images parent node,
784 * i.e. component image node.
786 if (params->pflag == count) {
787 printf("Extracted:\n%s Image %u (%s)\n", p,
788 count, fit_get_name(fit, noffset, NULL));
790 fit_image_print(fit, noffset, p);
792 return fit_image_extract(fit, noffset,
803 static int fit_check_params(struct image_tool_params *params)
805 if (params->auto_its)
807 return ((params->dflag && (params->fflag || params->lflag)) ||
808 (params->fflag && (params->dflag || params->lflag)) ||
809 (params->lflag && (params->dflag || params->fflag)));
815 sizeof(image_header_t),
821 fit_extract_contents,
822 fit_check_image_types,
824 NULL /* FIT images use DTB header */