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 for (cont = params->content_head; cont; cont = cont->next) {
91 size = imagetool_get_filesize(params, cont->fname);
95 /* Add space for properties */
96 total_size += size + 300;
99 /* Add plenty of space for headers, properties, nodes, etc. */
105 static int fdt_property_file(struct image_tool_params *params,
106 void *fdt, const char *name, const char *fname)
113 fd = open(fname, O_RDWR | O_BINARY);
115 fprintf(stderr, "%s: Can't open %s: %s\n",
116 params->cmdname, fname, strerror(errno));
120 if (fstat(fd, &sbuf) < 0) {
121 fprintf(stderr, "%s: Can't stat %s: %s\n",
122 params->cmdname, fname, strerror(errno));
126 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
129 ret = read(fd, ptr, sbuf.st_size);
130 if (ret != sbuf.st_size) {
131 fprintf(stderr, "%s: Can't read %s: %s\n",
132 params->cmdname, fname, strerror(errno));
143 static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
149 vsnprintf(str, sizeof(str), fmt, ptr);
151 return fdt_property_string(fdt, name, str);
154 static void get_basename(char *str, int size, const char *fname)
156 const char *p, *start, *end;
160 * Use the base name as the 'name' field. So for example:
162 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
163 * becomes "sun7i-a20-bananapro"
165 p = strrchr(fname, '/');
166 start = p ? p + 1 : fname;
167 p = strrchr(fname, '.');
168 end = p ? p : fname + strlen(fname);
172 memcpy(str, start, len);
177 * fit_write_images() - Write out a list of images to the FIT
179 * We always include the main image (params->datafile). If there are device
180 * tree files, we include an fdt@ node for each of those too.
182 static int fit_write_images(struct image_tool_params *params, char *fdt)
184 struct content_info *cont;
185 const char *typename;
190 fdt_begin_node(fdt, "images");
192 /* First the main image */
193 typename = genimg_get_type_short_name(params->fit_image_type);
194 snprintf(str, sizeof(str), "%s@1", typename);
195 fdt_begin_node(fdt, str);
196 fdt_property_string(fdt, "description", params->imagename);
197 fdt_property_string(fdt, "type", typename);
198 fdt_property_string(fdt, "arch", genimg_get_arch_name(params->arch));
199 fdt_property_string(fdt, "os", genimg_get_os_short_name(params->os));
200 fdt_property_string(fdt, "compression",
201 genimg_get_comp_short_name(params->comp));
202 fdt_property_u32(fdt, "load", params->addr);
203 fdt_property_u32(fdt, "entry", params->ep);
206 * Put data last since it is large. SPL may only load the first part
207 * of the DT, so this way it can access all the above fields.
209 ret = fdt_property_file(params, fdt, "data", params->datafile);
214 /* Now the device tree files if available */
216 for (cont = params->content_head; cont; cont = cont->next) {
217 if (cont->type != IH_TYPE_FLATDT)
219 snprintf(str, sizeof(str), "%s@%d", FIT_FDT_PROP, ++upto);
220 fdt_begin_node(fdt, str);
222 get_basename(str, sizeof(str), cont->fname);
223 fdt_property_string(fdt, "description", str);
224 ret = fdt_property_file(params, fdt, "data", cont->fname);
227 fdt_property_string(fdt, "type", typename);
228 fdt_property_string(fdt, "arch",
229 genimg_get_arch_short_name(params->arch));
230 fdt_property_string(fdt, "compression",
231 genimg_get_comp_short_name(IH_COMP_NONE));
241 * fit_write_configs() - Write out a list of configurations to the FIT
243 * If there are device tree files, we include a configuration for each, which
244 * selects the main image (params->datafile) and its corresponding device
247 * Otherwise we just create a configuration with the main image in it.
249 static void fit_write_configs(struct image_tool_params *params, char *fdt)
251 struct content_info *cont;
252 const char *typename;
256 fdt_begin_node(fdt, "configurations");
257 fdt_property_string(fdt, "default", "conf@1");
260 for (cont = params->content_head; cont; cont = cont->next) {
261 if (cont->type != IH_TYPE_FLATDT)
263 typename = genimg_get_type_short_name(cont->type);
264 snprintf(str, sizeof(str), "conf@%d", ++upto);
265 fdt_begin_node(fdt, str);
267 get_basename(str, sizeof(str), cont->fname);
268 fdt_property_string(fdt, "description", str);
270 typename = genimg_get_type_short_name(params->fit_image_type);
271 snprintf(str, sizeof(str), "%s@1", typename);
272 fdt_property_string(fdt, typename, str);
274 snprintf(str, sizeof(str), FIT_FDT_PROP "@%d", upto);
275 fdt_property_string(fdt, FIT_FDT_PROP, str);
279 fdt_begin_node(fdt, "conf@1");
280 typename = genimg_get_type_short_name(params->fit_image_type);
281 snprintf(str, sizeof(str), "%s@1", typename);
282 fdt_property_string(fdt, typename, str);
289 static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
293 ret = fdt_create(fdt, size);
296 fdt_finish_reservemap(fdt);
297 fdt_begin_node(fdt, "");
298 fdt_property_strf(fdt, "description",
299 "%s image with one or more FDT blobs",
300 genimg_get_type_name(params->fit_image_type));
301 fdt_property_strf(fdt, "creator", "U-Boot mkimage %s", PLAIN_VERSION);
302 fdt_property_u32(fdt, "#address-cells", 1);
303 ret = fit_write_images(params, fdt);
306 fit_write_configs(params, fdt);
308 ret = fdt_finish(fdt);
312 return fdt_totalsize(fdt);
315 static int fit_build(struct image_tool_params *params, const char *fname)
322 size = fit_calc_size(params);
327 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
328 params->cmdname, size);
331 ret = fit_build_fdt(params, buf, size);
333 fprintf(stderr, "%s: Failed to build FIT image\n",
338 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
340 fprintf(stderr, "%s: Can't open %s: %s\n",
341 params->cmdname, fname, strerror(errno));
344 ret = write(fd, buf, size);
346 fprintf(stderr, "%s: Can't write %s: %s\n",
347 params->cmdname, fname, strerror(errno));
362 * fit_extract_data() - Move all data outside the FIT
364 * This takes a normal FIT file and removes all the 'data' properties from it.
365 * The data is placed in an area after the FIT so that it can be accessed
366 * using an offset into that area. The 'data' properties turn into
367 * 'data-offset' properties.
369 * This function cannot cope with FITs with 'data-offset' properties. All
370 * data must be in 'data' properties on entry.
372 static int fit_extract_data(struct image_tool_params *params, const char *fname)
376 int fit_size, new_size;
384 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false);
387 fit_size = fdt_totalsize(fdt);
389 /* Allocate space to hold the image data we will extract */
390 buf = malloc(fit_size);
397 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
399 debug("%s: Cannot find /images node: %d\n", __func__, images);
404 for (node = fdt_first_subnode(fdt, images);
406 node = fdt_next_subnode(fdt, node)) {
410 data = fdt_getprop(fdt, node, "data", &len);
413 memcpy(buf + buf_ptr, data, len);
414 debug("Extracting data size %x\n", len);
416 ret = fdt_delprop(fdt, node, "data");
421 if (params->external_offset > 0) {
422 /* An external offset positions the data absolutely. */
423 fdt_setprop_u32(fdt, node, "data-position",
424 params->external_offset + buf_ptr);
426 fdt_setprop_u32(fdt, node, "data-offset", buf_ptr);
428 fdt_setprop_u32(fdt, node, "data-size", len);
430 buf_ptr += (len + 3) & ~3;
433 /* Pack the FDT and place the data after it */
436 debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
437 debug("External data size %x\n", buf_ptr);
438 new_size = fdt_totalsize(fdt);
439 new_size = (new_size + 3) & ~3;
440 munmap(fdt, sbuf.st_size);
442 if (ftruncate(fd, new_size)) {
443 debug("%s: Failed to truncate file: %s\n", __func__,
449 /* Check if an offset for the external data was set. */
450 if (params->external_offset > 0) {
451 if (params->external_offset < new_size) {
452 debug("External offset %x overlaps FIT length %x",
453 params->external_offset, new_size);
457 new_size = params->external_offset;
459 if (lseek(fd, new_size, SEEK_SET) < 0) {
460 debug("%s: Failed to seek to end of file: %s\n", __func__,
465 if (write(fd, buf, buf_ptr) != buf_ptr) {
466 debug("%s: Failed to write external data to file %s\n",
467 __func__, strerror(errno));
475 munmap(fdt, sbuf.st_size);
483 static int fit_import_data(struct image_tool_params *params, const char *fname)
486 int fit_size, new_size, size, data_base;
493 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false);
496 fit_size = fdt_totalsize(old_fdt);
497 data_base = (fit_size + 3) & ~3;
499 /* Allocate space to hold the new FIT */
500 size = sbuf.st_size + 16384;
503 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
508 ret = fdt_open_into(old_fdt, fdt, size);
510 debug("%s: Failed to expand FIT: %s\n", __func__,
511 fdt_strerror(errno));
516 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
518 debug("%s: Cannot find /images node: %d\n", __func__, images);
523 for (node = fdt_first_subnode(fdt, images);
525 node = fdt_next_subnode(fdt, node)) {
529 buf_ptr = fdtdec_get_int(fdt, node, "data-offset", -1);
530 len = fdtdec_get_int(fdt, node, "data-size", -1);
531 if (buf_ptr == -1 || len == -1)
533 debug("Importing data size %x\n", len);
535 ret = fdt_setprop(fdt, node, "data", fdt + data_base + buf_ptr,
538 debug("%s: Failed to write property: %s\n", __func__,
545 munmap(old_fdt, sbuf.st_size);
548 /* Pack the FDT and place the data after it */
551 new_size = fdt_totalsize(fdt);
552 debug("Size expanded from %x to %x\n", fit_size, new_size);
554 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
556 fprintf(stderr, "%s: Can't open %s: %s\n",
557 params->cmdname, fname, strerror(errno));
561 if (write(fd, fdt, new_size) != new_size) {
562 debug("%s: Failed to write external data to file %s\n",
563 __func__, strerror(errno));
577 * fit_handle_file - main FIT file processing function
579 * fit_handle_file() runs dtc to convert .its to .itb, includes
580 * binary data, updates timestamp property and calculates hashes.
582 * datafile - .its file
583 * imagefile - .itb file
586 * only on success, otherwise calls exit (EXIT_FAILURE);
588 static int fit_handle_file(struct image_tool_params *params)
590 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
591 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
595 /* Flattened Image Tree (FIT) format handling */
596 debug ("FIT format handling\n");
598 /* call dtc to include binary properties into the tmp file */
599 if (strlen (params->imagefile) +
600 strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
601 fprintf (stderr, "%s: Image file name (%s) too long, "
602 "can't create tmpfile",
603 params->imagefile, params->cmdname);
604 return (EXIT_FAILURE);
606 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
608 /* We either compile the source file, or use the existing FIT image */
609 if (params->auto_its) {
610 if (fit_build(params, tmpfile)) {
611 fprintf(stderr, "%s: failed to build FIT\n",
616 } else if (params->datafile) {
617 /* dtc -I dts -O dtb -p 500 datafile > tmpfile */
618 snprintf(cmd, sizeof(cmd), "%s %s %s > %s",
619 MKIMAGE_DTC, params->dtc, params->datafile, tmpfile);
620 debug("Trying to execute \"%s\"\n", cmd);
622 snprintf(cmd, sizeof(cmd), "cp %s %s",
623 params->imagefile, tmpfile);
625 if (*cmd && system(cmd) == -1) {
626 fprintf (stderr, "%s: system(%s) failed: %s\n",
627 params->cmdname, cmd, strerror(errno));
631 /* Move the data so it is internal to the FIT, if needed */
632 ret = fit_import_data(params, tmpfile);
637 * Set hashes for images in the blob. Unfortunately we may need more
638 * space in either FDT, so keep trying until we succeed.
640 * Note: this is pretty inefficient for signing, since we must
641 * calculate the signature every time. It would be better to calculate
642 * all the data and then store it in a separate step. However, this
643 * would be considerably more complex to implement. Generally a few
644 * steps of this loop is enough to sign with several keys.
646 for (size_inc = 0; size_inc < 64 * 1024; size_inc += 1024) {
647 ret = fit_add_file_data(params, size_inc, tmpfile);
648 if (!ret || ret != -ENOSPC)
653 fprintf(stderr, "%s Can't add hashes to FIT blob\n",
658 /* Move the data so it is external to the FIT, if requested */
659 if (params->external_data) {
660 ret = fit_extract_data(params, tmpfile);
665 if (rename (tmpfile, params->imagefile) == -1) {
666 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
667 params->cmdname, tmpfile, params->imagefile,
670 unlink (params->imagefile);
681 * fit_image_extract - extract a FIT component image
682 * @fit: pointer to the FIT format image header
683 * @image_noffset: offset of the component image node
684 * @file_name: name of the file to store the FIT sub-image
687 * zero in case of success or a negative value if fail.
689 static int fit_image_extract(
692 const char *file_name)
694 const void *file_data;
695 size_t file_size = 0;
697 /* get the "data" property of component at offset "image_noffset" */
698 fit_image_get_data(fit, image_noffset, &file_data, &file_size);
700 /* save the "file_data" into the file specified by "file_name" */
701 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
705 * fit_extract_contents - retrieve a sub-image component from the FIT image
706 * @ptr: pointer to the FIT format image header
707 * @params: command line parameters
710 * zero in case of success or a negative value if fail.
712 static int fit_extract_contents(void *ptr, struct image_tool_params *params)
717 const void *fit = ptr;
721 /* Indent string is defined in header image.h */
722 p = IMAGE_INDENT_STRING;
724 if (!fit_check_format(fit)) {
725 printf("Bad FIT image format\n");
729 /* Find images parent node offset */
730 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
731 if (images_noffset < 0) {
732 printf("Can't find images parent node '%s' (%s)\n",
733 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
737 /* Avoid any overrun */
738 count = fit_get_subimage_count(fit, images_noffset);
739 if ((params->pflag < 0) || (count <= params->pflag)) {
740 printf("No such component at '%d'\n", params->pflag);
744 /* Process its subnodes, extract the desired component from image */
745 for (ndepth = 0, count = 0,
746 noffset = fdt_next_node(fit, images_noffset, &ndepth);
747 (noffset >= 0) && (ndepth > 0);
748 noffset = fdt_next_node(fit, noffset, &ndepth)) {
751 * Direct child node of the images parent node,
752 * i.e. component image node.
754 if (params->pflag == count) {
755 printf("Extracted:\n%s Image %u (%s)\n", p,
756 count, fit_get_name(fit, noffset, NULL));
758 fit_image_print(fit, noffset, p);
760 return fit_image_extract(fit, noffset,
771 static int fit_check_params(struct image_tool_params *params)
773 if (params->auto_its)
775 return ((params->dflag && (params->fflag || params->lflag)) ||
776 (params->fflag && (params->dflag || params->lflag)) ||
777 (params->lflag && (params->dflag || params->fflag)));
783 sizeof(image_header_t),
789 fit_extract_contents,
790 fit_check_image_types,
792 NULL /* FIT images use DTB header */