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"
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,
42 if (params
->keydest
) {
43 struct stat dest_sbuf
;
45 destfd
= mmap_fdt(params
->cmdname
, params
->keydest
, size_inc
,
46 &dest_blob
, &dest_sbuf
, false,
52 destfd_size
= dest_sbuf
.st_size
;
55 /* for first image creation, add a timestamp at offset 0 i.e., root */
56 if (params
->datafile
) {
57 time_t time
= imagetool_get_source_date(params
->cmdname
,
59 ret
= fit_set_timestamp(ptr
, 0, time
);
63 ret
= fit_cipher_data(params
->keydir
, dest_blob
, ptr
,
71 ret
= fit_add_verification_data(params
->keydir
, dest_blob
, ptr
,
79 munmap(dest_blob
, destfd_size
);
84 munmap(ptr
, sbuf
.st_size
);
90 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
92 static int fit_calc_size(struct image_tool_params
*params
)
94 struct content_info
*cont
;
97 size
= imagetool_get_filesize(params
, params
->datafile
);
102 if (params
->fit_ramdisk
) {
103 size
= imagetool_get_filesize(params
, params
->fit_ramdisk
);
109 for (cont
= params
->content_head
; cont
; cont
= cont
->next
) {
110 size
= imagetool_get_filesize(params
, cont
->fname
);
114 /* Add space for properties */
115 total_size
+= size
+ 300;
118 /* Add plenty of space for headers, properties, nodes, etc. */
124 static int fdt_property_file(struct image_tool_params
*params
,
125 void *fdt
, const char *name
, const char *fname
)
132 fd
= open(fname
, O_RDWR
| O_BINARY
);
134 fprintf(stderr
, "%s: Can't open %s: %s\n",
135 params
->cmdname
, fname
, strerror(errno
));
139 if (fstat(fd
, &sbuf
) < 0) {
140 fprintf(stderr
, "%s: Can't stat %s: %s\n",
141 params
->cmdname
, fname
, strerror(errno
));
145 ret
= fdt_property_placeholder(fdt
, "data", sbuf
.st_size
, &ptr
);
148 ret
= read(fd
, ptr
, sbuf
.st_size
);
149 if (ret
!= sbuf
.st_size
) {
150 fprintf(stderr
, "%s: Can't read %s: %s\n",
151 params
->cmdname
, fname
, strerror(errno
));
162 static int fdt_property_strf(void *fdt
, const char *name
, const char *fmt
, ...)
168 vsnprintf(str
, sizeof(str
), fmt
, ptr
);
170 return fdt_property_string(fdt
, name
, str
);
173 static void get_basename(char *str
, int size
, const char *fname
)
175 const char *p
, *start
, *end
;
179 * Use the base name as the 'name' field. So for example:
181 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
182 * becomes "sun7i-a20-bananapro"
184 p
= strrchr(fname
, '/');
185 start
= p
? p
+ 1 : fname
;
186 p
= strrchr(fname
, '.');
187 end
= p
? p
: fname
+ strlen(fname
);
191 memcpy(str
, start
, len
);
196 * fit_write_images() - Write out a list of images to the FIT
198 * We always include the main image (params->datafile). If there are device
199 * tree files, we include an fdt- node for each of those too.
201 static int fit_write_images(struct image_tool_params
*params
, char *fdt
)
203 struct content_info
*cont
;
204 const char *typename
;
209 fdt_begin_node(fdt
, "images");
211 /* First the main image */
212 typename
= genimg_get_type_short_name(params
->fit_image_type
);
213 snprintf(str
, sizeof(str
), "%s-1", typename
);
214 fdt_begin_node(fdt
, str
);
215 fdt_property_string(fdt
, FIT_DESC_PROP
, params
->imagename
);
216 fdt_property_string(fdt
, FIT_TYPE_PROP
, typename
);
217 fdt_property_string(fdt
, FIT_ARCH_PROP
,
218 genimg_get_arch_short_name(params
->arch
));
219 fdt_property_string(fdt
, FIT_OS_PROP
,
220 genimg_get_os_short_name(params
->os
));
221 fdt_property_string(fdt
, FIT_COMP_PROP
,
222 genimg_get_comp_short_name(params
->comp
));
223 fdt_property_u32(fdt
, FIT_LOAD_PROP
, params
->addr
);
224 fdt_property_u32(fdt
, FIT_ENTRY_PROP
, params
->ep
);
227 * Put data last since it is large. SPL may only load the first part
228 * of the DT, so this way it can access all the above fields.
230 ret
= fdt_property_file(params
, fdt
, FIT_DATA_PROP
, params
->datafile
);
235 /* Now the device tree files if available */
237 for (cont
= params
->content_head
; cont
; cont
= cont
->next
) {
238 if (cont
->type
!= IH_TYPE_FLATDT
)
240 typename
= genimg_get_type_short_name(cont
->type
);
241 snprintf(str
, sizeof(str
), "%s-%d", FIT_FDT_PROP
, ++upto
);
242 fdt_begin_node(fdt
, str
);
244 get_basename(str
, sizeof(str
), cont
->fname
);
245 fdt_property_string(fdt
, FIT_DESC_PROP
, str
);
246 ret
= fdt_property_file(params
, fdt
, FIT_DATA_PROP
,
250 fdt_property_string(fdt
, FIT_TYPE_PROP
, typename
);
251 fdt_property_string(fdt
, FIT_ARCH_PROP
,
252 genimg_get_arch_short_name(params
->arch
));
253 fdt_property_string(fdt
, FIT_COMP_PROP
,
254 genimg_get_comp_short_name(IH_COMP_NONE
));
258 /* And a ramdisk file if available */
259 if (params
->fit_ramdisk
) {
260 fdt_begin_node(fdt
, FIT_RAMDISK_PROP
"-1");
262 fdt_property_string(fdt
, FIT_TYPE_PROP
, FIT_RAMDISK_PROP
);
263 fdt_property_string(fdt
, FIT_OS_PROP
,
264 genimg_get_os_short_name(params
->os
));
265 fdt_property_string(fdt
, FIT_ARCH_PROP
,
266 genimg_get_arch_short_name(params
->arch
));
268 ret
= fdt_property_file(params
, fdt
, FIT_DATA_PROP
,
269 params
->fit_ramdisk
);
282 * fit_write_configs() - Write out a list of configurations to the FIT
284 * If there are device tree files, we include a configuration for each, which
285 * selects the main image (params->datafile) and its corresponding device
288 * Otherwise we just create a configuration with the main image in it.
290 static void fit_write_configs(struct image_tool_params
*params
, char *fdt
)
292 struct content_info
*cont
;
293 const char *typename
;
297 fdt_begin_node(fdt
, "configurations");
298 fdt_property_string(fdt
, FIT_DEFAULT_PROP
, "conf-1");
301 for (cont
= params
->content_head
; cont
; cont
= cont
->next
) {
302 if (cont
->type
!= IH_TYPE_FLATDT
)
304 typename
= genimg_get_type_short_name(cont
->type
);
305 snprintf(str
, sizeof(str
), "conf-%d", ++upto
);
306 fdt_begin_node(fdt
, str
);
308 get_basename(str
, sizeof(str
), cont
->fname
);
309 fdt_property_string(fdt
, FIT_DESC_PROP
, str
);
311 typename
= genimg_get_type_short_name(params
->fit_image_type
);
312 snprintf(str
, sizeof(str
), "%s-1", typename
);
313 fdt_property_string(fdt
, typename
, str
);
314 fdt_property_string(fdt
, FIT_LOADABLE_PROP
, str
);
316 if (params
->fit_ramdisk
)
317 fdt_property_string(fdt
, FIT_RAMDISK_PROP
,
318 FIT_RAMDISK_PROP
"-1");
320 snprintf(str
, sizeof(str
), FIT_FDT_PROP
"-%d", upto
);
321 fdt_property_string(fdt
, FIT_FDT_PROP
, str
);
326 fdt_begin_node(fdt
, "conf-1");
327 typename
= genimg_get_type_short_name(params
->fit_image_type
);
328 snprintf(str
, sizeof(str
), "%s-1", typename
);
329 fdt_property_string(fdt
, typename
, str
);
331 if (params
->fit_ramdisk
)
332 fdt_property_string(fdt
, FIT_RAMDISK_PROP
,
333 FIT_RAMDISK_PROP
"-1");
341 static int fit_build_fdt(struct image_tool_params
*params
, char *fdt
, int size
)
345 ret
= fdt_create(fdt
, size
);
348 fdt_finish_reservemap(fdt
);
349 fdt_begin_node(fdt
, "");
350 fdt_property_strf(fdt
, FIT_DESC_PROP
,
351 "%s image with one or more FDT blobs",
352 genimg_get_type_name(params
->fit_image_type
));
353 fdt_property_strf(fdt
, "creator", "U-Boot mkimage %s", PLAIN_VERSION
);
354 fdt_property_u32(fdt
, "#address-cells", 1);
355 ret
= fit_write_images(params
, fdt
);
358 fit_write_configs(params
, fdt
);
360 ret
= fdt_finish(fdt
);
364 return fdt_totalsize(fdt
);
367 static int fit_build(struct image_tool_params
*params
, const char *fname
)
374 size
= fit_calc_size(params
);
379 fprintf(stderr
, "%s: Out of memory (%d bytes)\n",
380 params
->cmdname
, size
);
383 ret
= fit_build_fdt(params
, buf
, size
);
385 fprintf(stderr
, "%s: Failed to build FIT image\n",
390 fd
= open(fname
, O_RDWR
| O_CREAT
| O_TRUNC
| O_BINARY
, 0666);
392 fprintf(stderr
, "%s: Can't open %s: %s\n",
393 params
->cmdname
, fname
, strerror(errno
));
396 ret
= write(fd
, buf
, size
);
398 fprintf(stderr
, "%s: Can't write %s: %s\n",
399 params
->cmdname
, fname
, strerror(errno
));
414 * fit_extract_data() - Move all data outside the FIT
416 * This takes a normal FIT file and removes all the 'data' properties from it.
417 * The data is placed in an area after the FIT so that it can be accessed
418 * using an offset into that area. The 'data' properties turn into
419 * 'data-offset' properties.
421 * This function cannot cope with FITs with 'data-offset' properties. All
422 * data must be in 'data' properties on entry.
424 static int fit_extract_data(struct image_tool_params
*params
, const char *fname
)
428 int fit_size
, new_size
;
438 align_size
= params
->bl_len
? params
->bl_len
: 4;
439 fd
= mmap_fdt(params
->cmdname
, fname
, 0, &fdt
, &sbuf
, false, false);
442 fit_size
= fdt_totalsize(fdt
);
444 images
= fdt_path_offset(fdt
, FIT_IMAGES_PATH
);
446 debug("%s: Cannot find /images node: %d\n", __func__
, images
);
450 image_number
= fdtdec_get_child_count(fdt
, images
);
453 * Allocate space to hold the image data we will extract,
454 * extral space allocate for image alignment to prevent overflow.
456 buf
= malloc(fit_size
+ (align_size
* image_number
));
463 for (node
= fdt_first_subnode(fdt
, images
);
465 node
= fdt_next_subnode(fdt
, node
)) {
469 data
= fdt_getprop(fdt
, node
, FIT_DATA_PROP
, &len
);
472 memcpy(buf
+ buf_ptr
, data
, len
);
473 debug("Extracting data size %x\n", len
);
475 ret
= fdt_delprop(fdt
, node
, FIT_DATA_PROP
);
480 if (params
->external_offset
> 0) {
481 /* An external offset positions the data absolutely. */
482 fdt_setprop_u32(fdt
, node
, FIT_DATA_POSITION_PROP
,
483 params
->external_offset
+ buf_ptr
);
485 fdt_setprop_u32(fdt
, node
, FIT_DATA_OFFSET_PROP
,
488 fdt_setprop_u32(fdt
, node
, FIT_DATA_SIZE_PROP
, len
);
489 buf_ptr
+= ALIGN(len
, align_size
);
492 /* Pack the FDT and place the data after it */
495 new_size
= fdt_totalsize(fdt
);
496 new_size
= ALIGN(new_size
, align_size
);
497 fdt_set_totalsize(fdt
, new_size
);
498 debug("Size reduced from %x to %x\n", fit_size
, fdt_totalsize(fdt
));
499 debug("External data size %x\n", buf_ptr
);
500 munmap(fdt
, sbuf
.st_size
);
502 if (ftruncate(fd
, new_size
)) {
503 debug("%s: Failed to truncate file: %s\n", __func__
,
509 /* Check if an offset for the external data was set. */
510 if (params
->external_offset
> 0) {
511 if (params
->external_offset
< new_size
) {
512 debug("External offset %x overlaps FIT length %x",
513 params
->external_offset
, new_size
);
517 new_size
= params
->external_offset
;
519 if (lseek(fd
, new_size
, SEEK_SET
) < 0) {
520 debug("%s: Failed to seek to end of file: %s\n", __func__
,
525 if (write(fd
, buf
, buf_ptr
) != buf_ptr
) {
526 debug("%s: Failed to write external data to file %s\n",
527 __func__
, strerror(errno
));
536 munmap(fdt
, sbuf
.st_size
);
543 static int fit_import_data(struct image_tool_params
*params
, const char *fname
)
546 int fit_size
, new_size
, size
, data_base
;
553 fd
= mmap_fdt(params
->cmdname
, fname
, 0, &old_fdt
, &sbuf
, false, false);
556 fit_size
= fdt_totalsize(old_fdt
);
557 data_base
= ALIGN(fit_size
, 4);
559 /* Allocate space to hold the new FIT */
560 size
= sbuf
.st_size
+ 16384;
563 fprintf(stderr
, "%s: Failed to allocate memory (%d bytes)\n",
568 ret
= fdt_open_into(old_fdt
, fdt
, size
);
570 debug("%s: Failed to expand FIT: %s\n", __func__
,
571 fdt_strerror(errno
));
576 images
= fdt_path_offset(fdt
, FIT_IMAGES_PATH
);
578 debug("%s: Cannot find /images node: %d\n", __func__
, images
);
583 for (node
= fdt_first_subnode(fdt
, images
);
585 node
= fdt_next_subnode(fdt
, node
)) {
589 buf_ptr
= fdtdec_get_int(fdt
, node
, "data-offset", -1);
590 len
= fdtdec_get_int(fdt
, node
, "data-size", -1);
591 if (buf_ptr
== -1 || len
== -1)
593 debug("Importing data size %x\n", len
);
595 ret
= fdt_setprop(fdt
, node
, "data", fdt
+ data_base
+ buf_ptr
,
598 debug("%s: Failed to write property: %s\n", __func__
,
605 munmap(old_fdt
, sbuf
.st_size
);
607 /* Close the old fd so we can re-use it. */
610 /* Pack the FDT and place the data after it */
613 new_size
= fdt_totalsize(fdt
);
614 debug("Size expanded from %x to %x\n", fit_size
, new_size
);
616 fd
= open(fname
, O_RDWR
| O_CREAT
| O_TRUNC
| O_BINARY
, 0666);
618 fprintf(stderr
, "%s: Can't open %s: %s\n",
619 params
->cmdname
, fname
, strerror(errno
));
623 if (write(fd
, fdt
, new_size
) != new_size
) {
624 debug("%s: Failed to write external data to file %s\n",
625 __func__
, strerror(errno
));
635 munmap(old_fdt
, sbuf
.st_size
);
642 static int copyfile(const char *src
, const char *dst
)
644 int fd_src
= -1, fd_dst
= -1;
650 fd_src
= open(src
, O_RDONLY
);
652 printf("Can't open file %s (%s)\n", src
, strerror(errno
));
656 fd_dst
= open(dst
, O_WRONLY
| O_CREAT
, 0666);
658 printf("Can't open file %s (%s)\n", dst
, strerror(errno
));
664 printf("Can't allocate buffer to copy file\n");
669 size
= read(fd_src
, buf
, 512);
671 printf("Can't read file %s\n", src
);
678 size
= write(fd_dst
, buf
, count
);
680 printf("Can't write file %s\n", dst
);
699 * fit_handle_file - main FIT file processing function
701 * fit_handle_file() runs dtc to convert .its to .itb, includes
702 * binary data, updates timestamp property and calculates hashes.
704 * datafile - .its file
705 * imagefile - .itb file
708 * only on success, otherwise calls exit (EXIT_FAILURE);
710 static int fit_handle_file(struct image_tool_params
*params
)
712 char tmpfile
[MKIMAGE_MAX_TMPFILE_LEN
];
713 char bakfile
[MKIMAGE_MAX_TMPFILE_LEN
+ 4] = {0};
714 char cmd
[MKIMAGE_MAX_DTC_CMDLINE_LEN
];
718 /* Flattened Image Tree (FIT) format handling */
719 debug ("FIT format handling\n");
721 /* call dtc to include binary properties into the tmp file */
722 if (strlen (params
->imagefile
) +
723 strlen (MKIMAGE_TMPFILE_SUFFIX
) + 1 > sizeof (tmpfile
)) {
724 fprintf (stderr
, "%s: Image file name (%s) too long, "
725 "can't create tmpfile",
726 params
->imagefile
, params
->cmdname
);
727 return (EXIT_FAILURE
);
729 sprintf (tmpfile
, "%s%s", params
->imagefile
, MKIMAGE_TMPFILE_SUFFIX
);
731 /* We either compile the source file, or use the existing FIT image */
732 if (params
->auto_its
) {
733 if (fit_build(params
, tmpfile
)) {
734 fprintf(stderr
, "%s: failed to build FIT\n",
739 } else if (params
->datafile
) {
740 /* dtc -I dts -O dtb -p 500 -o tmpfile datafile */
741 snprintf(cmd
, sizeof(cmd
), "%s %s -o \"%s\" \"%s\"",
742 MKIMAGE_DTC
, params
->dtc
, tmpfile
, params
->datafile
);
743 debug("Trying to execute \"%s\"\n", cmd
);
745 snprintf(cmd
, sizeof(cmd
), "cp \"%s\" \"%s\"",
746 params
->imagefile
, tmpfile
);
748 if (strlen(cmd
) >= MKIMAGE_MAX_DTC_CMDLINE_LEN
- 1) {
749 fprintf(stderr
, "WARNING: command-line for FIT creation might be truncated and will probably fail.\n");
752 if (*cmd
&& system(cmd
) == -1) {
753 fprintf (stderr
, "%s: system(%s) failed: %s\n",
754 params
->cmdname
, cmd
, strerror(errno
));
758 /* Move the data so it is internal to the FIT, if needed */
759 ret
= fit_import_data(params
, tmpfile
);
764 * Copy the tmpfile to bakfile, then in the following loop
765 * we copy bakfile to tmpfile. So we always start from the
768 sprintf(bakfile
, "%s%s", tmpfile
, ".bak");
769 rename(tmpfile
, bakfile
);
772 * Set hashes for images in the blob. Unfortunately we may need more
773 * space in either FDT, so keep trying until we succeed.
775 * Note: this is pretty inefficient for signing, since we must
776 * calculate the signature every time. It would be better to calculate
777 * all the data and then store it in a separate step. However, this
778 * would be considerably more complex to implement. Generally a few
779 * steps of this loop is enough to sign with several keys.
781 for (size_inc
= 0; size_inc
< 64 * 1024; size_inc
+= 1024) {
782 if (copyfile(bakfile
, tmpfile
) < 0) {
783 printf("Can't copy %s to %s\n", bakfile
, tmpfile
);
787 ret
= fit_add_file_data(params
, size_inc
, tmpfile
);
788 if (!ret
|| ret
!= -ENOSPC
)
793 fprintf(stderr
, "%s Can't add hashes to FIT blob: %d\n",
794 params
->cmdname
, ret
);
798 /* Move the data so it is external to the FIT, if requested */
799 if (params
->external_data
) {
800 ret
= fit_extract_data(params
, tmpfile
);
805 if (rename (tmpfile
, params
->imagefile
) == -1) {
806 fprintf (stderr
, "%s: Can't rename %s to %s: %s\n",
807 params
->cmdname
, tmpfile
, params
->imagefile
,
811 unlink (params
->imagefile
);
824 * fit_image_extract - extract a FIT component image
825 * @fit: pointer to the FIT format image header
826 * @image_noffset: offset of the component image node
827 * @file_name: name of the file to store the FIT sub-image
830 * zero in case of success or a negative value if fail.
832 static int fit_image_extract(
835 const char *file_name
)
837 const void *file_data
;
838 size_t file_size
= 0;
841 /* get the data address and size of component at offset "image_noffset" */
842 ret
= fit_image_get_data_and_size(fit
, image_noffset
, &file_data
, &file_size
);
844 fprintf(stderr
, "Could not get component information\n");
848 /* save the "file_data" into the file specified by "file_name" */
849 return imagetool_save_subimage(file_name
, (ulong
) file_data
, file_size
);
853 * fit_extract_contents - retrieve a sub-image component from the FIT image
854 * @ptr: pointer to the FIT format image header
855 * @params: command line parameters
858 * zero in case of success or a negative value if fail.
860 static int fit_extract_contents(void *ptr
, struct image_tool_params
*params
)
865 const void *fit
= ptr
;
869 /* Indent string is defined in header image.h */
870 p
= IMAGE_INDENT_STRING
;
872 if (!fit_check_format(fit
)) {
873 printf("Bad FIT image format\n");
877 /* Find images parent node offset */
878 images_noffset
= fdt_path_offset(fit
, FIT_IMAGES_PATH
);
879 if (images_noffset
< 0) {
880 printf("Can't find images parent node '%s' (%s)\n",
881 FIT_IMAGES_PATH
, fdt_strerror(images_noffset
));
885 /* Avoid any overrun */
886 count
= fit_get_subimage_count(fit
, images_noffset
);
887 if ((params
->pflag
< 0) || (count
<= params
->pflag
)) {
888 printf("No such component at '%d'\n", params
->pflag
);
892 /* Process its subnodes, extract the desired component from image */
893 for (ndepth
= 0, count
= 0,
894 noffset
= fdt_next_node(fit
, images_noffset
, &ndepth
);
895 (noffset
>= 0) && (ndepth
> 0);
896 noffset
= fdt_next_node(fit
, noffset
, &ndepth
)) {
899 * Direct child node of the images parent node,
900 * i.e. component image node.
902 if (params
->pflag
== count
) {
903 printf("Extracted:\n%s Image %u (%s)\n", p
,
904 count
, fit_get_name(fit
, noffset
, NULL
));
906 fit_image_print(fit
, noffset
, p
);
908 return fit_image_extract(fit
, noffset
,
919 static int fit_check_params(struct image_tool_params
*params
)
921 if (params
->auto_its
)
923 return ((params
->dflag
&& params
->fflag
) ||
924 (params
->fflag
&& params
->lflag
) ||
925 (params
->lflag
&& params
->dflag
));
931 sizeof(image_header_t
),
937 fit_extract_contents
,
938 fit_check_image_types
,
940 NULL
/* FIT images use DTB header */