blob: 4b626354fb3f1e235af40a3c1110de5830236ae8 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +05302/*
3 * (C) Copyright 2008 Semihalf
4 *
5 * (C) Copyright 2000-2004
6 * DENX Software Engineering
7 * Wolfgang Denk, wd@denx.de
8 *
9 * Updated-by: Prafulla Wadaskar <prafulla@marvell.com>
10 * FIT image specific code abstracted from mkimage.c
11 * some functions added to address abstraction
12 *
13 * All rights reserved.
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +053014 */
15
Guilherme Maciel Ferreira8ed4d1c2013-12-01 12:43:10 -070016#include "imagetool.h"
Heiko Schocher3cb743c2014-03-03 12:19:29 +010017#include "fit_common.h"
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +053018#include "mkimage.h"
19#include <image.h>
Simon Glass88e31cb2016-02-22 22:55:51 -070020#include <stdarg.h>
21#include <version.h>
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +053022#include <u-boot/crc.h>
23
24static image_header_t header;
25
Simon Glass802aa822014-06-02 22:04:53 -060026static int fit_add_file_data(struct image_tool_params *params, size_t size_inc,
27 const char *tmpfile)
28{
29 int tfd, destfd = 0;
30 void *dest_blob = NULL;
31 off_t destfd_size = 0;
32 struct stat sbuf;
33 void *ptr;
34 int ret = 0;
35
36 tfd = mmap_fdt(params->cmdname, tmpfile, size_inc, &ptr, &sbuf, true);
37 if (tfd < 0)
38 return -EIO;
39
40 if (params->keydest) {
41 struct stat dest_sbuf;
42
43 destfd = mmap_fdt(params->cmdname, params->keydest, size_inc,
44 &dest_blob, &dest_sbuf, false);
45 if (destfd < 0) {
46 ret = -EIO;
47 goto err_keydest;
48 }
49 destfd_size = dest_sbuf.st_size;
50 }
51
52 /* for first image creation, add a timestamp at offset 0 i.e., root */
Vagrant Cascadianf8e066c2016-06-16 12:28:40 -070053 if (params->datafile) {
Alex Kiernanc4c7e0d2018-06-20 20:10:51 +000054 time_t time = imagetool_get_source_date(params->cmdname,
55 sbuf.st_mtime);
Vagrant Cascadianf8e066c2016-06-16 12:28:40 -070056 ret = fit_set_timestamp(ptr, 0, time);
57 }
Simon Glass802aa822014-06-02 22:04:53 -060058
59 if (!ret) {
60 ret = fit_add_verification_data(params->keydir, dest_blob, ptr,
61 params->comment,
George McCollister23d14892017-01-06 13:14:17 -060062 params->require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +000063 params->engine_id,
64 params->cmdname);
Simon Glass802aa822014-06-02 22:04:53 -060065 }
66
67 if (dest_blob) {
68 munmap(dest_blob, destfd_size);
69 close(destfd);
70 }
71
72err_keydest:
73 munmap(ptr, sbuf.st_size);
74 close(tfd);
75
76 return ret;
77}
78
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +053079/**
Simon Glass88e31cb2016-02-22 22:55:51 -070080 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
81 */
82static int fit_calc_size(struct image_tool_params *params)
83{
Simon Glassbd8bc5d2016-02-22 22:55:52 -070084 struct content_info *cont;
Simon Glass88e31cb2016-02-22 22:55:51 -070085 int size, total_size;
86
87 size = imagetool_get_filesize(params, params->datafile);
88 if (size < 0)
89 return -1;
Simon Glass88e31cb2016-02-22 22:55:51 -070090 total_size = size;
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +010091
92 if (params->fit_ramdisk) {
93 size = imagetool_get_filesize(params, params->fit_ramdisk);
94 if (size < 0)
95 return -1;
96 total_size += size;
97 }
98
Simon Glassbd8bc5d2016-02-22 22:55:52 -070099 for (cont = params->content_head; cont; cont = cont->next) {
100 size = imagetool_get_filesize(params, cont->fname);
101 if (size < 0)
102 return -1;
Simon Glass88e31cb2016-02-22 22:55:51 -0700103
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700104 /* Add space for properties */
105 total_size += size + 300;
106 }
Simon Glass88e31cb2016-02-22 22:55:51 -0700107
108 /* Add plenty of space for headers, properties, nodes, etc. */
109 total_size += 4096;
110
111 return total_size;
112}
113
114static int fdt_property_file(struct image_tool_params *params,
115 void *fdt, const char *name, const char *fname)
116{
117 struct stat sbuf;
118 void *ptr;
119 int ret;
120 int fd;
121
122 fd = open(fname, O_RDWR | O_BINARY);
123 if (fd < 0) {
124 fprintf(stderr, "%s: Can't open %s: %s\n",
125 params->cmdname, fname, strerror(errno));
126 return -1;
127 }
128
129 if (fstat(fd, &sbuf) < 0) {
130 fprintf(stderr, "%s: Can't stat %s: %s\n",
131 params->cmdname, fname, strerror(errno));
132 goto err;
133 }
134
135 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
136 if (ret)
Simon Glass9ab7f052016-03-16 07:45:42 -0600137 goto err;
Simon Glass88e31cb2016-02-22 22:55:51 -0700138 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));
142 goto err;
143 }
Simon Glass9ab7f052016-03-16 07:45:42 -0600144 close(fd);
Simon Glass88e31cb2016-02-22 22:55:51 -0700145
146 return 0;
147err:
148 close(fd);
149 return -1;
150}
151
152static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
153{
154 char str[100];
155 va_list ptr;
156
157 va_start(ptr, fmt);
158 vsnprintf(str, sizeof(str), fmt, ptr);
159 va_end(ptr);
160 return fdt_property_string(fdt, name, str);
161}
162
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700163static void get_basename(char *str, int size, const char *fname)
164{
165 const char *p, *start, *end;
166 int len;
167
168 /*
169 * Use the base name as the 'name' field. So for example:
170 *
171 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
172 * becomes "sun7i-a20-bananapro"
173 */
174 p = strrchr(fname, '/');
175 start = p ? p + 1 : fname;
176 p = strrchr(fname, '.');
177 end = p ? p : fname + strlen(fname);
178 len = end - start;
179 if (len >= size)
180 len = size - 1;
181 memcpy(str, start, len);
182 str[len] = '\0';
183}
184
Simon Glass88e31cb2016-02-22 22:55:51 -0700185/**
186 * fit_write_images() - Write out a list of images to the FIT
187 *
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700188 * We always include the main image (params->datafile). If there are device
Andre Przywara9ef25e82017-12-04 02:05:12 +0000189 * tree files, we include an fdt- node for each of those too.
Simon Glass88e31cb2016-02-22 22:55:51 -0700190 */
191static int fit_write_images(struct image_tool_params *params, char *fdt)
192{
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700193 struct content_info *cont;
Simon Glass88e31cb2016-02-22 22:55:51 -0700194 const char *typename;
195 char str[100];
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700196 int upto;
Simon Glass88e31cb2016-02-22 22:55:51 -0700197 int ret;
198
199 fdt_begin_node(fdt, "images");
200
201 /* First the main image */
202 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000203 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glass88e31cb2016-02-22 22:55:51 -0700204 fdt_begin_node(fdt, str);
Michal Simeka4e678d2018-07-20 12:31:02 +0200205 fdt_property_string(fdt, FIT_DESC_PROP, params->imagename);
206 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
207 fdt_property_string(fdt, FIT_ARCH_PROP,
Simon Glassaeeea7f2016-06-30 10:52:12 -0600208 genimg_get_arch_short_name(params->arch));
Michal Simeka4e678d2018-07-20 12:31:02 +0200209 fdt_property_string(fdt, FIT_OS_PROP,
210 genimg_get_os_short_name(params->os));
211 fdt_property_string(fdt, FIT_COMP_PROP,
Simon Glass88e31cb2016-02-22 22:55:51 -0700212 genimg_get_comp_short_name(params->comp));
Michal Simeka4e678d2018-07-20 12:31:02 +0200213 fdt_property_u32(fdt, FIT_LOAD_PROP, params->addr);
214 fdt_property_u32(fdt, FIT_ENTRY_PROP, params->ep);
Simon Glass88e31cb2016-02-22 22:55:51 -0700215
216 /*
217 * Put data last since it is large. SPL may only load the first part
218 * of the DT, so this way it can access all the above fields.
219 */
Michal Simeka4e678d2018-07-20 12:31:02 +0200220 ret = fdt_property_file(params, fdt, FIT_DATA_PROP, params->datafile);
Simon Glass88e31cb2016-02-22 22:55:51 -0700221 if (ret)
222 return ret;
223 fdt_end_node(fdt);
224
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700225 /* Now the device tree files if available */
226 upto = 0;
227 for (cont = params->content_head; cont; cont = cont->next) {
228 if (cont->type != IH_TYPE_FLATDT)
229 continue;
Andre Przywara9ef25e82017-12-04 02:05:12 +0000230 snprintf(str, sizeof(str), "%s-%d", FIT_FDT_PROP, ++upto);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700231 fdt_begin_node(fdt, str);
232
233 get_basename(str, sizeof(str), cont->fname);
Michal Simeka4e678d2018-07-20 12:31:02 +0200234 fdt_property_string(fdt, FIT_DESC_PROP, str);
235 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
236 cont->fname);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700237 if (ret)
238 return ret;
Michal Simeka4e678d2018-07-20 12:31:02 +0200239 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
240 fdt_property_string(fdt, FIT_ARCH_PROP,
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700241 genimg_get_arch_short_name(params->arch));
Michal Simeka4e678d2018-07-20 12:31:02 +0200242 fdt_property_string(fdt, FIT_COMP_PROP,
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700243 genimg_get_comp_short_name(IH_COMP_NONE));
244 fdt_end_node(fdt);
245 }
246
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100247 /* And a ramdisk file if available */
248 if (params->fit_ramdisk) {
Andre Przywara9ef25e82017-12-04 02:05:12 +0000249 fdt_begin_node(fdt, FIT_RAMDISK_PROP "-1");
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100250
Michal Simeka4e678d2018-07-20 12:31:02 +0200251 fdt_property_string(fdt, FIT_TYPE_PROP, FIT_RAMDISK_PROP);
252 fdt_property_string(fdt, FIT_OS_PROP,
253 genimg_get_os_short_name(params->os));
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100254
Michal Simeka4e678d2018-07-20 12:31:02 +0200255 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
256 params->fit_ramdisk);
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100257 if (ret)
258 return ret;
259
260 fdt_end_node(fdt);
261 }
262
Simon Glass88e31cb2016-02-22 22:55:51 -0700263 fdt_end_node(fdt);
264
265 return 0;
266}
267
268/**
269 * fit_write_configs() - Write out a list of configurations to the FIT
270 *
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700271 * If there are device tree files, we include a configuration for each, which
272 * selects the main image (params->datafile) and its corresponding device
273 * tree file.
274 *
275 * Otherwise we just create a configuration with the main image in it.
Simon Glass88e31cb2016-02-22 22:55:51 -0700276 */
277static void fit_write_configs(struct image_tool_params *params, char *fdt)
278{
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700279 struct content_info *cont;
Simon Glass88e31cb2016-02-22 22:55:51 -0700280 const char *typename;
281 char str[100];
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700282 int upto;
Simon Glass88e31cb2016-02-22 22:55:51 -0700283
284 fdt_begin_node(fdt, "configurations");
Michal Simeka4e678d2018-07-20 12:31:02 +0200285 fdt_property_string(fdt, FIT_DEFAULT_PROP, "conf-1");
Simon Glass88e31cb2016-02-22 22:55:51 -0700286
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700287 upto = 0;
288 for (cont = params->content_head; cont; cont = cont->next) {
289 if (cont->type != IH_TYPE_FLATDT)
290 continue;
291 typename = genimg_get_type_short_name(cont->type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000292 snprintf(str, sizeof(str), "conf-%d", ++upto);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700293 fdt_begin_node(fdt, str);
294
295 get_basename(str, sizeof(str), cont->fname);
Michal Simeka4e678d2018-07-20 12:31:02 +0200296 fdt_property_string(fdt, FIT_DESC_PROP, str);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700297
298 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000299 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700300 fdt_property_string(fdt, typename, str);
301
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100302 if (params->fit_ramdisk)
303 fdt_property_string(fdt, FIT_RAMDISK_PROP,
Andre Przywara9ef25e82017-12-04 02:05:12 +0000304 FIT_RAMDISK_PROP "-1");
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100305
Andre Przywara9ef25e82017-12-04 02:05:12 +0000306 snprintf(str, sizeof(str), FIT_FDT_PROP "-%d", upto);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700307 fdt_property_string(fdt, FIT_FDT_PROP, str);
308 fdt_end_node(fdt);
309 }
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100310
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700311 if (!upto) {
Andre Przywara9ef25e82017-12-04 02:05:12 +0000312 fdt_begin_node(fdt, "conf-1");
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700313 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000314 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700315 fdt_property_string(fdt, typename, str);
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100316
317 if (params->fit_ramdisk)
318 fdt_property_string(fdt, FIT_RAMDISK_PROP,
Andre Przywara9ef25e82017-12-04 02:05:12 +0000319 FIT_RAMDISK_PROP "-1");
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100320
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700321 fdt_end_node(fdt);
322 }
Simon Glass88e31cb2016-02-22 22:55:51 -0700323
324 fdt_end_node(fdt);
325}
326
327static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
328{
329 int ret;
330
331 ret = fdt_create(fdt, size);
332 if (ret)
333 return ret;
334 fdt_finish_reservemap(fdt);
335 fdt_begin_node(fdt, "");
Michal Simeka4e678d2018-07-20 12:31:02 +0200336 fdt_property_strf(fdt, FIT_DESC_PROP,
Simon Glass88e31cb2016-02-22 22:55:51 -0700337 "%s image with one or more FDT blobs",
338 genimg_get_type_name(params->fit_image_type));
339 fdt_property_strf(fdt, "creator", "U-Boot mkimage %s", PLAIN_VERSION);
340 fdt_property_u32(fdt, "#address-cells", 1);
341 ret = fit_write_images(params, fdt);
342 if (ret)
343 return ret;
344 fit_write_configs(params, fdt);
345 fdt_end_node(fdt);
346 ret = fdt_finish(fdt);
347 if (ret)
348 return ret;
349
350 return fdt_totalsize(fdt);
351}
352
353static int fit_build(struct image_tool_params *params, const char *fname)
354{
355 char *buf;
356 int size;
357 int ret;
358 int fd;
359
360 size = fit_calc_size(params);
361 if (size < 0)
362 return -1;
363 buf = malloc(size);
364 if (!buf) {
365 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
366 params->cmdname, size);
367 return -1;
368 }
369 ret = fit_build_fdt(params, buf, size);
370 if (ret < 0) {
371 fprintf(stderr, "%s: Failed to build FIT image\n",
372 params->cmdname);
Simon Glassc0ee1ca2016-03-16 07:45:41 -0600373 goto err_buf;
Simon Glass88e31cb2016-02-22 22:55:51 -0700374 }
375 size = ret;
376 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
377 if (fd < 0) {
378 fprintf(stderr, "%s: Can't open %s: %s\n",
379 params->cmdname, fname, strerror(errno));
Tom Rinib8286652017-09-26 22:14:44 -0400380 goto err_buf;
Simon Glass88e31cb2016-02-22 22:55:51 -0700381 }
382 ret = write(fd, buf, size);
383 if (ret != size) {
384 fprintf(stderr, "%s: Can't write %s: %s\n",
385 params->cmdname, fname, strerror(errno));
Simon Glass88e31cb2016-02-22 22:55:51 -0700386 goto err;
387 }
388 close(fd);
Simon Glassc0ee1ca2016-03-16 07:45:41 -0600389 free(buf);
Simon Glass88e31cb2016-02-22 22:55:51 -0700390
391 return 0;
392err:
Simon Glassc0ee1ca2016-03-16 07:45:41 -0600393 close(fd);
394err_buf:
Simon Glass88e31cb2016-02-22 22:55:51 -0700395 free(buf);
396 return -1;
397}
398
399/**
Simon Glassafd728c2016-02-22 22:55:53 -0700400 * fit_extract_data() - Move all data outside the FIT
401 *
402 * This takes a normal FIT file and removes all the 'data' properties from it.
403 * The data is placed in an area after the FIT so that it can be accessed
404 * using an offset into that area. The 'data' properties turn into
405 * 'data-offset' properties.
406 *
407 * This function cannot cope with FITs with 'data-offset' properties. All
408 * data must be in 'data' properties on entry.
409 */
410static int fit_extract_data(struct image_tool_params *params, const char *fname)
411{
412 void *buf;
413 int buf_ptr;
414 int fit_size, new_size;
415 int fd;
416 struct stat sbuf;
417 void *fdt;
418 int ret;
419 int images;
420 int node;
421
422 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false);
423 if (fd < 0)
424 return -EIO;
425 fit_size = fdt_totalsize(fdt);
426
427 /* Allocate space to hold the image data we will extract */
428 buf = malloc(fit_size);
429 if (!buf) {
430 ret = -ENOMEM;
Simon Glass4e7505f2016-03-16 07:45:39 -0600431 goto err_munmap;
Simon Glassafd728c2016-02-22 22:55:53 -0700432 }
433 buf_ptr = 0;
434
435 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
436 if (images < 0) {
437 debug("%s: Cannot find /images node: %d\n", __func__, images);
438 ret = -EINVAL;
Simon Glass4e7505f2016-03-16 07:45:39 -0600439 goto err_munmap;
Simon Glassafd728c2016-02-22 22:55:53 -0700440 }
441
442 for (node = fdt_first_subnode(fdt, images);
443 node >= 0;
444 node = fdt_next_subnode(fdt, node)) {
445 const char *data;
446 int len;
447
Michal Simeka4e678d2018-07-20 12:31:02 +0200448 data = fdt_getprop(fdt, node, FIT_DATA_PROP, &len);
Simon Glassafd728c2016-02-22 22:55:53 -0700449 if (!data)
450 continue;
451 memcpy(buf + buf_ptr, data, len);
452 debug("Extracting data size %x\n", len);
453
Michal Simeka4e678d2018-07-20 12:31:02 +0200454 ret = fdt_delprop(fdt, node, FIT_DATA_PROP);
Simon Glassafd728c2016-02-22 22:55:53 -0700455 if (ret) {
456 ret = -EPERM;
Simon Glass4e7505f2016-03-16 07:45:39 -0600457 goto err_munmap;
Simon Glassafd728c2016-02-22 22:55:53 -0700458 }
Teddy Reeda8457622016-06-09 19:38:02 -0700459 if (params->external_offset > 0) {
460 /* An external offset positions the data absolutely. */
Michal Simeka4e678d2018-07-20 12:31:02 +0200461 fdt_setprop_u32(fdt, node, FIT_DATA_POSITION_PROP,
Teddy Reeda8457622016-06-09 19:38:02 -0700462 params->external_offset + buf_ptr);
463 } else {
Michal Simeka4e678d2018-07-20 12:31:02 +0200464 fdt_setprop_u32(fdt, node, FIT_DATA_OFFSET_PROP,
465 buf_ptr);
Teddy Reeda8457622016-06-09 19:38:02 -0700466 }
Michal Simeka4e678d2018-07-20 12:31:02 +0200467 fdt_setprop_u32(fdt, node, FIT_DATA_SIZE_PROP, len);
Simon Glassafd728c2016-02-22 22:55:53 -0700468
469 buf_ptr += (len + 3) & ~3;
470 }
471
472 /* Pack the FDT and place the data after it */
473 fdt_pack(fdt);
474
475 debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
476 debug("External data size %x\n", buf_ptr);
477 new_size = fdt_totalsize(fdt);
478 new_size = (new_size + 3) & ~3;
479 munmap(fdt, sbuf.st_size);
480
481 if (ftruncate(fd, new_size)) {
482 debug("%s: Failed to truncate file: %s\n", __func__,
483 strerror(errno));
484 ret = -EIO;
485 goto err;
486 }
Teddy Reeda8457622016-06-09 19:38:02 -0700487
488 /* Check if an offset for the external data was set. */
489 if (params->external_offset > 0) {
490 if (params->external_offset < new_size) {
491 debug("External offset %x overlaps FIT length %x",
492 params->external_offset, new_size);
493 ret = -EINVAL;
494 goto err;
495 }
496 new_size = params->external_offset;
497 }
Simon Glassafd728c2016-02-22 22:55:53 -0700498 if (lseek(fd, new_size, SEEK_SET) < 0) {
499 debug("%s: Failed to seek to end of file: %s\n", __func__,
500 strerror(errno));
501 ret = -EIO;
502 goto err;
503 }
504 if (write(fd, buf, buf_ptr) != buf_ptr) {
505 debug("%s: Failed to write external data to file %s\n",
506 __func__, strerror(errno));
507 ret = -EIO;
508 goto err;
509 }
Tom Rinib8286652017-09-26 22:14:44 -0400510 free(buf);
Simon Glass4e7505f2016-03-16 07:45:39 -0600511 close(fd);
512 return 0;
Simon Glassafd728c2016-02-22 22:55:53 -0700513
Simon Glass4e7505f2016-03-16 07:45:39 -0600514err_munmap:
515 munmap(fdt, sbuf.st_size);
Simon Glassafd728c2016-02-22 22:55:53 -0700516err:
Simon Glassf3a6e8f2016-03-16 07:45:40 -0600517 if (buf)
518 free(buf);
Simon Glassafd728c2016-02-22 22:55:53 -0700519 close(fd);
520 return ret;
521}
522
Simon Glassd11b7002016-02-22 22:55:54 -0700523static int fit_import_data(struct image_tool_params *params, const char *fname)
524{
525 void *fdt, *old_fdt;
526 int fit_size, new_size, size, data_base;
527 int fd;
528 struct stat sbuf;
529 int ret;
530 int images;
531 int node;
532
533 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false);
534 if (fd < 0)
535 return -EIO;
536 fit_size = fdt_totalsize(old_fdt);
537 data_base = (fit_size + 3) & ~3;
538
539 /* Allocate space to hold the new FIT */
540 size = sbuf.st_size + 16384;
541 fdt = malloc(size);
542 if (!fdt) {
543 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
544 __func__, size);
545 ret = -ENOMEM;
Tom Rinia29829e2017-10-07 11:27:59 -0400546 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700547 }
548 ret = fdt_open_into(old_fdt, fdt, size);
549 if (ret) {
550 debug("%s: Failed to expand FIT: %s\n", __func__,
551 fdt_strerror(errno));
552 ret = -EINVAL;
Tom Rinia29829e2017-10-07 11:27:59 -0400553 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700554 }
555
556 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
557 if (images < 0) {
558 debug("%s: Cannot find /images node: %d\n", __func__, images);
559 ret = -EINVAL;
Tom Rinia29829e2017-10-07 11:27:59 -0400560 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700561 }
562
563 for (node = fdt_first_subnode(fdt, images);
564 node >= 0;
565 node = fdt_next_subnode(fdt, node)) {
566 int buf_ptr;
567 int len;
568
569 buf_ptr = fdtdec_get_int(fdt, node, "data-offset", -1);
570 len = fdtdec_get_int(fdt, node, "data-size", -1);
571 if (buf_ptr == -1 || len == -1)
572 continue;
573 debug("Importing data size %x\n", len);
574
575 ret = fdt_setprop(fdt, node, "data", fdt + data_base + buf_ptr,
576 len);
577 if (ret) {
578 debug("%s: Failed to write property: %s\n", __func__,
579 fdt_strerror(ret));
580 ret = -EINVAL;
Tom Rinia29829e2017-10-07 11:27:59 -0400581 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700582 }
583 }
584
Tom Rinia29829e2017-10-07 11:27:59 -0400585 /* Close the old fd so we can re-use it. */
Simon Glassd11b7002016-02-22 22:55:54 -0700586 close(fd);
587
588 /* Pack the FDT and place the data after it */
589 fdt_pack(fdt);
590
591 new_size = fdt_totalsize(fdt);
592 debug("Size expanded from %x to %x\n", fit_size, new_size);
593
594 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
595 if (fd < 0) {
596 fprintf(stderr, "%s: Can't open %s: %s\n",
597 params->cmdname, fname, strerror(errno));
Tom Rinia29829e2017-10-07 11:27:59 -0400598 ret = -EIO;
599 goto err_no_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700600 }
601 if (write(fd, fdt, new_size) != new_size) {
602 debug("%s: Failed to write external data to file %s\n",
603 __func__, strerror(errno));
604 ret = -EIO;
Tom Rinia29829e2017-10-07 11:27:59 -0400605 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700606 }
Simon Glassd11b7002016-02-22 22:55:54 -0700607
608 ret = 0;
609
Tom Rinia29829e2017-10-07 11:27:59 -0400610err_has_fd:
611 close(fd);
612err_no_fd:
Tom Rinib8286652017-09-26 22:14:44 -0400613 munmap(old_fdt, sbuf.st_size);
Simon Glass5014cc12016-03-16 07:45:38 -0600614 free(fdt);
Simon Glassd11b7002016-02-22 22:55:54 -0700615 return ret;
616}
617
Simon Glassafd728c2016-02-22 22:55:53 -0700618/**
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530619 * fit_handle_file - main FIT file processing function
620 *
621 * fit_handle_file() runs dtc to convert .its to .itb, includes
622 * binary data, updates timestamp property and calculates hashes.
623 *
624 * datafile - .its file
625 * imagefile - .itb file
626 *
627 * returns:
628 * only on success, otherwise calls exit (EXIT_FAILURE);
629 */
Guilherme Maciel Ferreira8ed4d1c2013-12-01 12:43:10 -0700630static int fit_handle_file(struct image_tool_params *params)
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530631{
632 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
633 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
Simon Glass802aa822014-06-02 22:04:53 -0600634 size_t size_inc;
635 int ret;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530636
637 /* Flattened Image Tree (FIT) format handling */
638 debug ("FIT format handling\n");
639
640 /* call dtc to include binary properties into the tmp file */
641 if (strlen (params->imagefile) +
642 strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
643 fprintf (stderr, "%s: Image file name (%s) too long, "
644 "can't create tmpfile",
645 params->imagefile, params->cmdname);
646 return (EXIT_FAILURE);
647 }
648 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
649
Simon Glassce8c3ca2013-06-13 15:10:05 -0700650 /* We either compile the source file, or use the existing FIT image */
Simon Glass88e31cb2016-02-22 22:55:51 -0700651 if (params->auto_its) {
652 if (fit_build(params, tmpfile)) {
653 fprintf(stderr, "%s: failed to build FIT\n",
654 params->cmdname);
655 return EXIT_FAILURE;
656 }
657 *cmd = '\0';
658 } else if (params->datafile) {
Stefan Theilff6c3b22018-03-08 09:00:13 +0100659 /* dtc -I dts -O dtb -p 500 -o tmpfile datafile */
660 snprintf(cmd, sizeof(cmd), "%s %s -o \"%s\" \"%s\"",
661 MKIMAGE_DTC, params->dtc, tmpfile, params->datafile);
Simon Glassce8c3ca2013-06-13 15:10:05 -0700662 debug("Trying to execute \"%s\"\n", cmd);
663 } else {
Mirza, Taimoor74a21dd2017-10-04 20:28:03 +0500664 snprintf(cmd, sizeof(cmd), "cp \"%s\" \"%s\"",
Simon Glassce8c3ca2013-06-13 15:10:05 -0700665 params->imagefile, tmpfile);
666 }
Simon Glass88e31cb2016-02-22 22:55:51 -0700667 if (*cmd && system(cmd) == -1) {
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530668 fprintf (stderr, "%s: system(%s) failed: %s\n",
669 params->cmdname, cmd, strerror(errno));
Simon Glass4161c412013-05-08 08:05:57 +0000670 goto err_system;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530671 }
672
Simon Glassd11b7002016-02-22 22:55:54 -0700673 /* Move the data so it is internal to the FIT, if needed */
674 ret = fit_import_data(params, tmpfile);
675 if (ret)
676 goto err_system;
677
Simon Glass802aa822014-06-02 22:04:53 -0600678 /*
679 * Set hashes for images in the blob. Unfortunately we may need more
680 * space in either FDT, so keep trying until we succeed.
681 *
682 * Note: this is pretty inefficient for signing, since we must
683 * calculate the signature every time. It would be better to calculate
684 * all the data and then store it in a separate step. However, this
685 * would be considerably more complex to implement. Generally a few
686 * steps of this loop is enough to sign with several keys.
687 */
688 for (size_inc = 0; size_inc < 64 * 1024; size_inc += 1024) {
689 ret = fit_add_file_data(params, size_inc, tmpfile);
690 if (!ret || ret != -ENOSPC)
691 break;
Simon Glassb4d8b092013-06-13 15:10:04 -0700692 }
693
Simon Glass802aa822014-06-02 22:04:53 -0600694 if (ret) {
Simon Glass061752e2016-07-03 09:40:43 -0600695 fprintf(stderr, "%s Can't add hashes to FIT blob: %d\n",
696 params->cmdname, ret);
Simon Glass802aa822014-06-02 22:04:53 -0600697 goto err_system;
Simon Glassb4d8b092013-06-13 15:10:04 -0700698 }
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530699
Simon Glassafd728c2016-02-22 22:55:53 -0700700 /* Move the data so it is external to the FIT, if requested */
701 if (params->external_data) {
702 ret = fit_extract_data(params, tmpfile);
703 if (ret)
704 goto err_system;
705 }
706
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530707 if (rename (tmpfile, params->imagefile) == -1) {
708 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
709 params->cmdname, tmpfile, params->imagefile,
710 strerror (errno));
711 unlink (tmpfile);
712 unlink (params->imagefile);
Simon Glass802aa822014-06-02 22:04:53 -0600713 return EXIT_FAILURE;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530714 }
Simon Glass802aa822014-06-02 22:04:53 -0600715 return EXIT_SUCCESS;
Simon Glass4161c412013-05-08 08:05:57 +0000716
Simon Glass4161c412013-05-08 08:05:57 +0000717err_system:
718 unlink(tmpfile);
719 return -1;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530720}
721
Guilherme Maciel Ferreira3c46bcd2015-01-15 02:54:42 -0200722/**
723 * fit_image_extract - extract a FIT component image
724 * @fit: pointer to the FIT format image header
725 * @image_noffset: offset of the component image node
726 * @file_name: name of the file to store the FIT sub-image
727 *
728 * returns:
729 * zero in case of success or a negative value if fail.
730 */
731static int fit_image_extract(
732 const void *fit,
733 int image_noffset,
734 const char *file_name)
735{
736 const void *file_data;
737 size_t file_size = 0;
738
739 /* get the "data" property of component at offset "image_noffset" */
740 fit_image_get_data(fit, image_noffset, &file_data, &file_size);
741
742 /* save the "file_data" into the file specified by "file_name" */
743 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
744}
745
746/**
747 * fit_extract_contents - retrieve a sub-image component from the FIT image
748 * @ptr: pointer to the FIT format image header
749 * @params: command line parameters
750 *
751 * returns:
752 * zero in case of success or a negative value if fail.
753 */
754static int fit_extract_contents(void *ptr, struct image_tool_params *params)
755{
756 int images_noffset;
757 int noffset;
758 int ndepth;
759 const void *fit = ptr;
760 int count = 0;
761 const char *p;
762
763 /* Indent string is defined in header image.h */
764 p = IMAGE_INDENT_STRING;
765
766 if (!fit_check_format(fit)) {
767 printf("Bad FIT image format\n");
768 return -1;
769 }
770
771 /* Find images parent node offset */
772 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
773 if (images_noffset < 0) {
774 printf("Can't find images parent node '%s' (%s)\n",
775 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
776 return -1;
777 }
778
779 /* Avoid any overrun */
780 count = fit_get_subimage_count(fit, images_noffset);
781 if ((params->pflag < 0) || (count <= params->pflag)) {
782 printf("No such component at '%d'\n", params->pflag);
783 return -1;
784 }
785
786 /* Process its subnodes, extract the desired component from image */
787 for (ndepth = 0, count = 0,
788 noffset = fdt_next_node(fit, images_noffset, &ndepth);
789 (noffset >= 0) && (ndepth > 0);
790 noffset = fdt_next_node(fit, noffset, &ndepth)) {
791 if (ndepth == 1) {
792 /*
793 * Direct child node of the images parent node,
794 * i.e. component image node.
795 */
796 if (params->pflag == count) {
797 printf("Extracted:\n%s Image %u (%s)\n", p,
798 count, fit_get_name(fit, noffset, NULL));
799
800 fit_image_print(fit, noffset, p);
801
802 return fit_image_extract(fit, noffset,
803 params->outfile);
804 }
805
806 count++;
807 }
808 }
809
810 return 0;
811}
812
Guilherme Maciel Ferreira8ed4d1c2013-12-01 12:43:10 -0700813static int fit_check_params(struct image_tool_params *params)
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530814{
Simon Glass88e31cb2016-02-22 22:55:51 -0700815 if (params->auto_its)
816 return 0;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530817 return ((params->dflag && (params->fflag || params->lflag)) ||
818 (params->fflag && (params->dflag || params->lflag)) ||
819 (params->lflag && (params->dflag || params->fflag)));
820}
821
Guilherme Maciel Ferreira28be1cf2015-01-15 02:48:07 -0200822U_BOOT_IMAGE_TYPE(
823 fitimage,
824 "FIT Image support",
825 sizeof(image_header_t),
826 (void *)&header,
827 fit_check_params,
828 fit_verify_header,
829 fit_print_contents,
830 NULL,
Guilherme Maciel Ferreira3c46bcd2015-01-15 02:54:42 -0200831 fit_extract_contents,
Guilherme Maciel Ferreira28be1cf2015-01-15 02:48:07 -0200832 fit_check_image_types,
833 fit_handle_file,
834 NULL /* FIT images use DTB header */
835);