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,
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,
51 destfd_size
= dest_sbuf
.st_size
;
54 /* for first image creation, add a timestamp at offset 0 i.e., root */
55 if (params
->datafile
) {
56 time_t time
= imagetool_get_source_date(params
->cmdname
,
58 ret
= fit_set_timestamp(ptr
, 0, time
);
62 ret
= fit_add_verification_data(params
->keydir
, dest_blob
, ptr
,
70 munmap(dest_blob
, destfd_size
);
75 munmap(ptr
, sbuf
.st_size
);
82 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
84 static int fit_calc_size(struct image_tool_params
*params
)
86 struct content_info
*cont
;
89 size
= imagetool_get_filesize(params
, params
->datafile
);
94 if (params
->fit_ramdisk
) {
95 size
= imagetool_get_filesize(params
, params
->fit_ramdisk
);
101 for (cont
= params
->content_head
; cont
; cont
= cont
->next
) {
102 size
= imagetool_get_filesize(params
, cont
->fname
);
106 /* Add space for properties */
107 total_size
+= size
+ 300;
110 /* Add plenty of space for headers, properties, nodes, etc. */
116 static int fdt_property_file(struct image_tool_params
*params
,
117 void *fdt
, const char *name
, const char *fname
)
124 fd
= open(fname
, O_RDWR
| O_BINARY
);
126 fprintf(stderr
, "%s: Can't open %s: %s\n",
127 params
->cmdname
, fname
, strerror(errno
));
131 if (fstat(fd
, &sbuf
) < 0) {
132 fprintf(stderr
, "%s: Can't stat %s: %s\n",
133 params
->cmdname
, fname
, strerror(errno
));
137 ret
= fdt_property_placeholder(fdt
, "data", sbuf
.st_size
, &ptr
);
140 ret
= read(fd
, ptr
, sbuf
.st_size
);
141 if (ret
!= sbuf
.st_size
) {
142 fprintf(stderr
, "%s: Can't read %s: %s\n",
143 params
->cmdname
, fname
, strerror(errno
));
154 static int fdt_property_strf(void *fdt
, const char *name
, const char *fmt
, ...)
160 vsnprintf(str
, sizeof(str
), fmt
, ptr
);
162 return fdt_property_string(fdt
, name
, str
);
165 static void get_basename(char *str
, int size
, const char *fname
)
167 const char *p
, *start
, *end
;
171 * Use the base name as the 'name' field. So for example:
173 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
174 * becomes "sun7i-a20-bananapro"
176 p
= strrchr(fname
, '/');
177 start
= p
? p
+ 1 : fname
;
178 p
= strrchr(fname
, '.');
179 end
= p
? p
: fname
+ strlen(fname
);
183 memcpy(str
, start
, len
);
188 * fit_write_images() - Write out a list of images to the FIT
190 * We always include the main image (params->datafile). If there are device
191 * tree files, we include an fdt- node for each of those too.
193 static int fit_write_images(struct image_tool_params
*params
, char *fdt
)
195 struct content_info
*cont
;
196 const char *typename
;
201 fdt_begin_node(fdt
, "images");
203 /* First the main image */
204 typename
= genimg_get_type_short_name(params
->fit_image_type
);
205 snprintf(str
, sizeof(str
), "%s-1", typename
);
206 fdt_begin_node(fdt
, str
);
207 fdt_property_string(fdt
, FIT_DESC_PROP
, params
->imagename
);
208 fdt_property_string(fdt
, FIT_TYPE_PROP
, typename
);
209 fdt_property_string(fdt
, FIT_ARCH_PROP
,
210 genimg_get_arch_short_name(params
->arch
));
211 fdt_property_string(fdt
, FIT_OS_PROP
,
212 genimg_get_os_short_name(params
->os
));
213 fdt_property_string(fdt
, FIT_COMP_PROP
,
214 genimg_get_comp_short_name(params
->comp
));
215 fdt_property_u32(fdt
, FIT_LOAD_PROP
, params
->addr
);
216 fdt_property_u32(fdt
, FIT_ENTRY_PROP
, params
->ep
);
219 * Put data last since it is large. SPL may only load the first part
220 * of the DT, so this way it can access all the above fields.
222 ret
= fdt_property_file(params
, fdt
, FIT_DATA_PROP
, params
->datafile
);
227 /* Now the device tree files if available */
229 for (cont
= params
->content_head
; cont
; cont
= cont
->next
) {
230 if (cont
->type
!= IH_TYPE_FLATDT
)
232 snprintf(str
, sizeof(str
), "%s-%d", FIT_FDT_PROP
, ++upto
);
233 fdt_begin_node(fdt
, str
);
235 get_basename(str
, sizeof(str
), cont
->fname
);
236 fdt_property_string(fdt
, FIT_DESC_PROP
, str
);
237 ret
= fdt_property_file(params
, fdt
, FIT_DATA_PROP
,
241 fdt_property_string(fdt
, FIT_TYPE_PROP
, typename
);
242 fdt_property_string(fdt
, FIT_ARCH_PROP
,
243 genimg_get_arch_short_name(params
->arch
));
244 fdt_property_string(fdt
, FIT_COMP_PROP
,
245 genimg_get_comp_short_name(IH_COMP_NONE
));
249 /* And a ramdisk file if available */
250 if (params
->fit_ramdisk
) {
251 fdt_begin_node(fdt
, FIT_RAMDISK_PROP
"-1");
253 fdt_property_string(fdt
, FIT_TYPE_PROP
, FIT_RAMDISK_PROP
);
254 fdt_property_string(fdt
, FIT_OS_PROP
,
255 genimg_get_os_short_name(params
->os
));
257 ret
= fdt_property_file(params
, fdt
, FIT_DATA_PROP
,
258 params
->fit_ramdisk
);
271 * fit_write_configs() - Write out a list of configurations to the FIT
273 * If there are device tree files, we include a configuration for each, which
274 * selects the main image (params->datafile) and its corresponding device
277 * Otherwise we just create a configuration with the main image in it.
279 static void fit_write_configs(struct image_tool_params
*params
, char *fdt
)
281 struct content_info
*cont
;
282 const char *typename
;
286 fdt_begin_node(fdt
, "configurations");
287 fdt_property_string(fdt
, FIT_DEFAULT_PROP
, "conf-1");
290 for (cont
= params
->content_head
; cont
; cont
= cont
->next
) {
291 if (cont
->type
!= IH_TYPE_FLATDT
)
293 typename
= genimg_get_type_short_name(cont
->type
);
294 snprintf(str
, sizeof(str
), "conf-%d", ++upto
);
295 fdt_begin_node(fdt
, str
);
297 get_basename(str
, sizeof(str
), cont
->fname
);
298 fdt_property_string(fdt
, FIT_DESC_PROP
, str
);
300 typename
= genimg_get_type_short_name(params
->fit_image_type
);
301 snprintf(str
, sizeof(str
), "%s-1", typename
);
302 fdt_property_string(fdt
, typename
, str
);
303 fdt_property_string(fdt
, FIT_LOADABLE_PROP
, str
);
305 if (params
->fit_ramdisk
)
306 fdt_property_string(fdt
, FIT_RAMDISK_PROP
,
307 FIT_RAMDISK_PROP
"-1");
309 snprintf(str
, sizeof(str
), FIT_FDT_PROP
"-%d", upto
);
310 fdt_property_string(fdt
, FIT_FDT_PROP
, str
);
315 fdt_begin_node(fdt
, "conf-1");
316 typename
= genimg_get_type_short_name(params
->fit_image_type
);
317 snprintf(str
, sizeof(str
), "%s-1", typename
);
318 fdt_property_string(fdt
, typename
, str
);
320 if (params
->fit_ramdisk
)
321 fdt_property_string(fdt
, FIT_RAMDISK_PROP
,
322 FIT_RAMDISK_PROP
"-1");
330 static int fit_build_fdt(struct image_tool_params
*params
, char *fdt
, int size
)
334 ret
= fdt_create(fdt
, size
);
337 fdt_finish_reservemap(fdt
);
338 fdt_begin_node(fdt
, "");
339 fdt_property_strf(fdt
, FIT_DESC_PROP
,
340 "%s image with one or more FDT blobs",
341 genimg_get_type_name(params
->fit_image_type
));
342 fdt_property_strf(fdt
, "creator", "U-Boot mkimage %s", PLAIN_VERSION
);
343 fdt_property_u32(fdt
, "#address-cells", 1);
344 ret
= fit_write_images(params
, fdt
);
347 fit_write_configs(params
, fdt
);
349 ret
= fdt_finish(fdt
);
353 return fdt_totalsize(fdt
);
356 static int fit_build(struct image_tool_params
*params
, const char *fname
)
363 size
= fit_calc_size(params
);
368 fprintf(stderr
, "%s: Out of memory (%d bytes)\n",
369 params
->cmdname
, size
);
372 ret
= fit_build_fdt(params
, buf
, size
);
374 fprintf(stderr
, "%s: Failed to build FIT image\n",
379 fd
= open(fname
, O_RDWR
| O_CREAT
| O_TRUNC
| O_BINARY
, 0666);
381 fprintf(stderr
, "%s: Can't open %s: %s\n",
382 params
->cmdname
, fname
, strerror(errno
));
385 ret
= write(fd
, buf
, size
);
387 fprintf(stderr
, "%s: Can't write %s: %s\n",
388 params
->cmdname
, fname
, strerror(errno
));
403 * fit_extract_data() - Move all data outside the FIT
405 * This takes a normal FIT file and removes all the 'data' properties from it.
406 * The data is placed in an area after the FIT so that it can be accessed
407 * using an offset into that area. The 'data' properties turn into
408 * 'data-offset' properties.
410 * This function cannot cope with FITs with 'data-offset' properties. All
411 * data must be in 'data' properties on entry.
413 static int fit_extract_data(struct image_tool_params
*params
, const char *fname
)
417 int fit_size
, new_size
;
425 fd
= mmap_fdt(params
->cmdname
, fname
, 0, &fdt
, &sbuf
, false, false);
428 fit_size
= fdt_totalsize(fdt
);
430 /* Allocate space to hold the image data we will extract */
431 buf
= malloc(fit_size
);
438 images
= fdt_path_offset(fdt
, FIT_IMAGES_PATH
);
440 debug("%s: Cannot find /images node: %d\n", __func__
, images
);
445 for (node
= fdt_first_subnode(fdt
, images
);
447 node
= fdt_next_subnode(fdt
, node
)) {
451 data
= fdt_getprop(fdt
, node
, FIT_DATA_PROP
, &len
);
454 memcpy(buf
+ buf_ptr
, data
, len
);
455 debug("Extracting data size %x\n", len
);
457 ret
= fdt_delprop(fdt
, node
, FIT_DATA_PROP
);
462 if (params
->external_offset
> 0) {
463 /* An external offset positions the data absolutely. */
464 fdt_setprop_u32(fdt
, node
, FIT_DATA_POSITION_PROP
,
465 params
->external_offset
+ buf_ptr
);
467 fdt_setprop_u32(fdt
, node
, FIT_DATA_OFFSET_PROP
,
470 fdt_setprop_u32(fdt
, node
, FIT_DATA_SIZE_PROP
, len
);
472 buf_ptr
+= (len
+ 3) & ~3;
475 /* Pack the FDT and place the data after it */
478 debug("Size reduced from %x to %x\n", fit_size
, fdt_totalsize(fdt
));
479 debug("External data size %x\n", buf_ptr
);
480 new_size
= fdt_totalsize(fdt
);
481 new_size
= (new_size
+ 3) & ~3;
482 munmap(fdt
, sbuf
.st_size
);
484 if (ftruncate(fd
, new_size
)) {
485 debug("%s: Failed to truncate file: %s\n", __func__
,
491 /* Check if an offset for the external data was set. */
492 if (params
->external_offset
> 0) {
493 if (params
->external_offset
< new_size
) {
494 debug("External offset %x overlaps FIT length %x",
495 params
->external_offset
, new_size
);
499 new_size
= params
->external_offset
;
501 if (lseek(fd
, new_size
, SEEK_SET
) < 0) {
502 debug("%s: Failed to seek to end of file: %s\n", __func__
,
507 if (write(fd
, buf
, buf_ptr
) != buf_ptr
) {
508 debug("%s: Failed to write external data to file %s\n",
509 __func__
, strerror(errno
));
518 munmap(fdt
, sbuf
.st_size
);
526 static int fit_import_data(struct image_tool_params
*params
, const char *fname
)
529 int fit_size
, new_size
, size
, data_base
;
536 fd
= mmap_fdt(params
->cmdname
, fname
, 0, &old_fdt
, &sbuf
, false, false);
539 fit_size
= fdt_totalsize(old_fdt
);
540 data_base
= (fit_size
+ 3) & ~3;
542 /* Allocate space to hold the new FIT */
543 size
= sbuf
.st_size
+ 16384;
546 fprintf(stderr
, "%s: Failed to allocate memory (%d bytes)\n",
551 ret
= fdt_open_into(old_fdt
, fdt
, size
);
553 debug("%s: Failed to expand FIT: %s\n", __func__
,
554 fdt_strerror(errno
));
559 images
= fdt_path_offset(fdt
, FIT_IMAGES_PATH
);
561 debug("%s: Cannot find /images node: %d\n", __func__
, images
);
566 for (node
= fdt_first_subnode(fdt
, images
);
568 node
= fdt_next_subnode(fdt
, node
)) {
572 buf_ptr
= fdtdec_get_int(fdt
, node
, "data-offset", -1);
573 len
= fdtdec_get_int(fdt
, node
, "data-size", -1);
574 if (buf_ptr
== -1 || len
== -1)
576 debug("Importing data size %x\n", len
);
578 ret
= fdt_setprop(fdt
, node
, "data", fdt
+ data_base
+ buf_ptr
,
581 debug("%s: Failed to write property: %s\n", __func__
,
588 /* Close the old fd so we can re-use it. */
591 /* Pack the FDT and place the data after it */
594 new_size
= fdt_totalsize(fdt
);
595 debug("Size expanded from %x to %x\n", fit_size
, new_size
);
597 fd
= open(fname
, O_RDWR
| O_CREAT
| O_TRUNC
| O_BINARY
, 0666);
599 fprintf(stderr
, "%s: Can't open %s: %s\n",
600 params
->cmdname
, fname
, strerror(errno
));
604 if (write(fd
, fdt
, new_size
) != new_size
) {
605 debug("%s: Failed to write external data to file %s\n",
606 __func__
, strerror(errno
));
616 munmap(old_fdt
, sbuf
.st_size
);
622 * fit_handle_file - main FIT file processing function
624 * fit_handle_file() runs dtc to convert .its to .itb, includes
625 * binary data, updates timestamp property and calculates hashes.
627 * datafile - .its file
628 * imagefile - .itb file
631 * only on success, otherwise calls exit (EXIT_FAILURE);
633 static int fit_handle_file(struct image_tool_params
*params
)
635 char tmpfile
[MKIMAGE_MAX_TMPFILE_LEN
];
636 char cmd
[MKIMAGE_MAX_DTC_CMDLINE_LEN
];
640 /* Flattened Image Tree (FIT) format handling */
641 debug ("FIT format handling\n");
643 /* call dtc to include binary properties into the tmp file */
644 if (strlen (params
->imagefile
) +
645 strlen (MKIMAGE_TMPFILE_SUFFIX
) + 1 > sizeof (tmpfile
)) {
646 fprintf (stderr
, "%s: Image file name (%s) too long, "
647 "can't create tmpfile",
648 params
->imagefile
, params
->cmdname
);
649 return (EXIT_FAILURE
);
651 sprintf (tmpfile
, "%s%s", params
->imagefile
, MKIMAGE_TMPFILE_SUFFIX
);
653 /* We either compile the source file, or use the existing FIT image */
654 if (params
->auto_its
) {
655 if (fit_build(params
, tmpfile
)) {
656 fprintf(stderr
, "%s: failed to build FIT\n",
661 } else if (params
->datafile
) {
662 /* dtc -I dts -O dtb -p 500 -o tmpfile datafile */
663 snprintf(cmd
, sizeof(cmd
), "%s %s -o \"%s\" \"%s\"",
664 MKIMAGE_DTC
, params
->dtc
, tmpfile
, params
->datafile
);
665 debug("Trying to execute \"%s\"\n", cmd
);
667 snprintf(cmd
, sizeof(cmd
), "cp \"%s\" \"%s\"",
668 params
->imagefile
, tmpfile
);
670 if (*cmd
&& system(cmd
) == -1) {
671 fprintf (stderr
, "%s: system(%s) failed: %s\n",
672 params
->cmdname
, cmd
, strerror(errno
));
676 /* Move the data so it is internal to the FIT, if needed */
677 ret
= fit_import_data(params
, tmpfile
);
682 * Set hashes for images in the blob. Unfortunately we may need more
683 * space in either FDT, so keep trying until we succeed.
685 * Note: this is pretty inefficient for signing, since we must
686 * calculate the signature every time. It would be better to calculate
687 * all the data and then store it in a separate step. However, this
688 * would be considerably more complex to implement. Generally a few
689 * steps of this loop is enough to sign with several keys.
691 for (size_inc
= 0; size_inc
< 64 * 1024; size_inc
+= 1024) {
692 ret
= fit_add_file_data(params
, size_inc
, tmpfile
);
693 if (!ret
|| ret
!= -ENOSPC
)
698 fprintf(stderr
, "%s Can't add hashes to FIT blob: %d\n",
699 params
->cmdname
, ret
);
703 /* Move the data so it is external to the FIT, if requested */
704 if (params
->external_data
) {
705 ret
= fit_extract_data(params
, tmpfile
);
710 if (rename (tmpfile
, params
->imagefile
) == -1) {
711 fprintf (stderr
, "%s: Can't rename %s to %s: %s\n",
712 params
->cmdname
, tmpfile
, params
->imagefile
,
715 unlink (params
->imagefile
);
726 * fit_image_extract - extract a FIT component image
727 * @fit: pointer to the FIT format image header
728 * @image_noffset: offset of the component image node
729 * @file_name: name of the file to store the FIT sub-image
732 * zero in case of success or a negative value if fail.
734 static int fit_image_extract(
737 const char *file_name
)
739 const void *file_data
;
740 size_t file_size
= 0;
742 /* get the "data" property of component at offset "image_noffset" */
743 fit_image_get_data(fit
, image_noffset
, &file_data
, &file_size
);
745 /* save the "file_data" into the file specified by "file_name" */
746 return imagetool_save_subimage(file_name
, (ulong
) file_data
, file_size
);
750 * fit_extract_contents - retrieve a sub-image component from the FIT image
751 * @ptr: pointer to the FIT format image header
752 * @params: command line parameters
755 * zero in case of success or a negative value if fail.
757 static int fit_extract_contents(void *ptr
, struct image_tool_params
*params
)
762 const void *fit
= ptr
;
766 /* Indent string is defined in header image.h */
767 p
= IMAGE_INDENT_STRING
;
769 if (!fit_check_format(fit
)) {
770 printf("Bad FIT image format\n");
774 /* Find images parent node offset */
775 images_noffset
= fdt_path_offset(fit
, FIT_IMAGES_PATH
);
776 if (images_noffset
< 0) {
777 printf("Can't find images parent node '%s' (%s)\n",
778 FIT_IMAGES_PATH
, fdt_strerror(images_noffset
));
782 /* Avoid any overrun */
783 count
= fit_get_subimage_count(fit
, images_noffset
);
784 if ((params
->pflag
< 0) || (count
<= params
->pflag
)) {
785 printf("No such component at '%d'\n", params
->pflag
);
789 /* Process its subnodes, extract the desired component from image */
790 for (ndepth
= 0, count
= 0,
791 noffset
= fdt_next_node(fit
, images_noffset
, &ndepth
);
792 (noffset
>= 0) && (ndepth
> 0);
793 noffset
= fdt_next_node(fit
, noffset
, &ndepth
)) {
796 * Direct child node of the images parent node,
797 * i.e. component image node.
799 if (params
->pflag
== count
) {
800 printf("Extracted:\n%s Image %u (%s)\n", p
,
801 count
, fit_get_name(fit
, noffset
, NULL
));
803 fit_image_print(fit
, noffset
, p
);
805 return fit_image_extract(fit
, noffset
,
816 static int fit_check_params(struct image_tool_params
*params
)
818 if (params
->auto_its
)
820 return ((params
->dflag
&& (params
->fflag
|| params
->lflag
)) ||
821 (params
->fflag
&& (params
->dflag
|| params
->lflag
)) ||
822 (params
->lflag
&& (params
->dflag
|| params
->fflag
)));
828 sizeof(image_header_t
),
834 fit_extract_contents
,
835 fit_check_image_types
,
837 NULL
/* FIT images use DTB header */