blob: 5aca634b5e935e6baf95312eef48f028f7cd8f2e [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
Luca Boccassibff733f2019-05-14 19:35:02 +010036 tfd = mmap_fdt(params->cmdname, tmpfile, size_inc, &ptr, &sbuf, true,
37 false);
Simon Glass802aa822014-06-02 22:04:53 -060038 if (tfd < 0)
39 return -EIO;
40
41 if (params->keydest) {
42 struct stat dest_sbuf;
43
44 destfd = mmap_fdt(params->cmdname, params->keydest, size_inc,
Luca Boccassibff733f2019-05-14 19:35:02 +010045 &dest_blob, &dest_sbuf, false,
46 false);
Simon Glass802aa822014-06-02 22:04:53 -060047 if (destfd < 0) {
48 ret = -EIO;
49 goto err_keydest;
50 }
51 destfd_size = dest_sbuf.st_size;
52 }
53
54 /* for first image creation, add a timestamp at offset 0 i.e., root */
Vagrant Cascadianf8e066c2016-06-16 12:28:40 -070055 if (params->datafile) {
Alex Kiernanc4c7e0d2018-06-20 20:10:51 +000056 time_t time = imagetool_get_source_date(params->cmdname,
57 sbuf.st_mtime);
Vagrant Cascadianf8e066c2016-06-16 12:28:40 -070058 ret = fit_set_timestamp(ptr, 0, time);
59 }
Simon Glass802aa822014-06-02 22:04:53 -060060
61 if (!ret) {
62 ret = fit_add_verification_data(params->keydir, dest_blob, ptr,
63 params->comment,
George McCollister23d14892017-01-06 13:14:17 -060064 params->require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +000065 params->engine_id,
66 params->cmdname);
Simon Glass802aa822014-06-02 22:04:53 -060067 }
68
69 if (dest_blob) {
70 munmap(dest_blob, destfd_size);
71 close(destfd);
72 }
73
74err_keydest:
75 munmap(ptr, sbuf.st_size);
76 close(tfd);
77
78 return ret;
79}
80
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +053081/**
Simon Glass88e31cb2016-02-22 22:55:51 -070082 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
83 */
84static int fit_calc_size(struct image_tool_params *params)
85{
Simon Glassbd8bc5d2016-02-22 22:55:52 -070086 struct content_info *cont;
Simon Glass88e31cb2016-02-22 22:55:51 -070087 int size, total_size;
88
89 size = imagetool_get_filesize(params, params->datafile);
90 if (size < 0)
91 return -1;
Simon Glass88e31cb2016-02-22 22:55:51 -070092 total_size = size;
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +010093
94 if (params->fit_ramdisk) {
95 size = imagetool_get_filesize(params, params->fit_ramdisk);
96 if (size < 0)
97 return -1;
98 total_size += size;
99 }
100
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700101 for (cont = params->content_head; cont; cont = cont->next) {
102 size = imagetool_get_filesize(params, cont->fname);
103 if (size < 0)
104 return -1;
Simon Glass88e31cb2016-02-22 22:55:51 -0700105
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700106 /* Add space for properties */
107 total_size += size + 300;
108 }
Simon Glass88e31cb2016-02-22 22:55:51 -0700109
110 /* Add plenty of space for headers, properties, nodes, etc. */
111 total_size += 4096;
112
113 return total_size;
114}
115
116static int fdt_property_file(struct image_tool_params *params,
117 void *fdt, const char *name, const char *fname)
118{
119 struct stat sbuf;
120 void *ptr;
121 int ret;
122 int fd;
123
124 fd = open(fname, O_RDWR | O_BINARY);
125 if (fd < 0) {
126 fprintf(stderr, "%s: Can't open %s: %s\n",
127 params->cmdname, fname, strerror(errno));
128 return -1;
129 }
130
131 if (fstat(fd, &sbuf) < 0) {
132 fprintf(stderr, "%s: Can't stat %s: %s\n",
133 params->cmdname, fname, strerror(errno));
134 goto err;
135 }
136
137 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
138 if (ret)
Simon Glass9ab7f052016-03-16 07:45:42 -0600139 goto err;
Simon Glass88e31cb2016-02-22 22:55:51 -0700140 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));
144 goto err;
145 }
Simon Glass9ab7f052016-03-16 07:45:42 -0600146 close(fd);
Simon Glass88e31cb2016-02-22 22:55:51 -0700147
148 return 0;
149err:
150 close(fd);
151 return -1;
152}
153
154static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
155{
156 char str[100];
157 va_list ptr;
158
159 va_start(ptr, fmt);
160 vsnprintf(str, sizeof(str), fmt, ptr);
161 va_end(ptr);
162 return fdt_property_string(fdt, name, str);
163}
164
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700165static void get_basename(char *str, int size, const char *fname)
166{
167 const char *p, *start, *end;
168 int len;
169
170 /*
171 * Use the base name as the 'name' field. So for example:
172 *
173 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
174 * becomes "sun7i-a20-bananapro"
175 */
176 p = strrchr(fname, '/');
177 start = p ? p + 1 : fname;
178 p = strrchr(fname, '.');
179 end = p ? p : fname + strlen(fname);
180 len = end - start;
181 if (len >= size)
182 len = size - 1;
183 memcpy(str, start, len);
184 str[len] = '\0';
185}
186
Simon Glass88e31cb2016-02-22 22:55:51 -0700187/**
188 * fit_write_images() - Write out a list of images to the FIT
189 *
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700190 * We always include the main image (params->datafile). If there are device
Andre Przywara9ef25e82017-12-04 02:05:12 +0000191 * tree files, we include an fdt- node for each of those too.
Simon Glass88e31cb2016-02-22 22:55:51 -0700192 */
193static int fit_write_images(struct image_tool_params *params, char *fdt)
194{
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700195 struct content_info *cont;
Simon Glass88e31cb2016-02-22 22:55:51 -0700196 const char *typename;
197 char str[100];
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700198 int upto;
Simon Glass88e31cb2016-02-22 22:55:51 -0700199 int ret;
200
201 fdt_begin_node(fdt, "images");
202
203 /* First the main image */
204 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000205 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glass88e31cb2016-02-22 22:55:51 -0700206 fdt_begin_node(fdt, str);
Michal Simeka4e678d2018-07-20 12:31:02 +0200207 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,
Simon Glassaeeea7f2016-06-30 10:52:12 -0600210 genimg_get_arch_short_name(params->arch));
Michal Simeka4e678d2018-07-20 12:31:02 +0200211 fdt_property_string(fdt, FIT_OS_PROP,
212 genimg_get_os_short_name(params->os));
213 fdt_property_string(fdt, FIT_COMP_PROP,
Simon Glass88e31cb2016-02-22 22:55:51 -0700214 genimg_get_comp_short_name(params->comp));
Michal Simeka4e678d2018-07-20 12:31:02 +0200215 fdt_property_u32(fdt, FIT_LOAD_PROP, params->addr);
216 fdt_property_u32(fdt, FIT_ENTRY_PROP, params->ep);
Simon Glass88e31cb2016-02-22 22:55:51 -0700217
218 /*
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.
221 */
Michal Simeka4e678d2018-07-20 12:31:02 +0200222 ret = fdt_property_file(params, fdt, FIT_DATA_PROP, params->datafile);
Simon Glass88e31cb2016-02-22 22:55:51 -0700223 if (ret)
224 return ret;
225 fdt_end_node(fdt);
226
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700227 /* Now the device tree files if available */
228 upto = 0;
229 for (cont = params->content_head; cont; cont = cont->next) {
230 if (cont->type != IH_TYPE_FLATDT)
231 continue;
Andre Przywara9ef25e82017-12-04 02:05:12 +0000232 snprintf(str, sizeof(str), "%s-%d", FIT_FDT_PROP, ++upto);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700233 fdt_begin_node(fdt, str);
234
235 get_basename(str, sizeof(str), cont->fname);
Michal Simeka4e678d2018-07-20 12:31:02 +0200236 fdt_property_string(fdt, FIT_DESC_PROP, str);
237 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
238 cont->fname);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700239 if (ret)
240 return ret;
Michal Simeka4e678d2018-07-20 12:31:02 +0200241 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
242 fdt_property_string(fdt, FIT_ARCH_PROP,
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700243 genimg_get_arch_short_name(params->arch));
Michal Simeka4e678d2018-07-20 12:31:02 +0200244 fdt_property_string(fdt, FIT_COMP_PROP,
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700245 genimg_get_comp_short_name(IH_COMP_NONE));
246 fdt_end_node(fdt);
247 }
248
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100249 /* And a ramdisk file if available */
250 if (params->fit_ramdisk) {
Andre Przywara9ef25e82017-12-04 02:05:12 +0000251 fdt_begin_node(fdt, FIT_RAMDISK_PROP "-1");
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100252
Michal Simeka4e678d2018-07-20 12:31:02 +0200253 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));
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100256
Michal Simeka4e678d2018-07-20 12:31:02 +0200257 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
258 params->fit_ramdisk);
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100259 if (ret)
260 return ret;
261
262 fdt_end_node(fdt);
263 }
264
Simon Glass88e31cb2016-02-22 22:55:51 -0700265 fdt_end_node(fdt);
266
267 return 0;
268}
269
270/**
271 * fit_write_configs() - Write out a list of configurations to the FIT
272 *
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700273 * If there are device tree files, we include a configuration for each, which
274 * selects the main image (params->datafile) and its corresponding device
275 * tree file.
276 *
277 * Otherwise we just create a configuration with the main image in it.
Simon Glass88e31cb2016-02-22 22:55:51 -0700278 */
279static void fit_write_configs(struct image_tool_params *params, char *fdt)
280{
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700281 struct content_info *cont;
Simon Glass88e31cb2016-02-22 22:55:51 -0700282 const char *typename;
283 char str[100];
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700284 int upto;
Simon Glass88e31cb2016-02-22 22:55:51 -0700285
286 fdt_begin_node(fdt, "configurations");
Michal Simeka4e678d2018-07-20 12:31:02 +0200287 fdt_property_string(fdt, FIT_DEFAULT_PROP, "conf-1");
Simon Glass88e31cb2016-02-22 22:55:51 -0700288
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700289 upto = 0;
290 for (cont = params->content_head; cont; cont = cont->next) {
291 if (cont->type != IH_TYPE_FLATDT)
292 continue;
293 typename = genimg_get_type_short_name(cont->type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000294 snprintf(str, sizeof(str), "conf-%d", ++upto);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700295 fdt_begin_node(fdt, str);
296
297 get_basename(str, sizeof(str), cont->fname);
Michal Simeka4e678d2018-07-20 12:31:02 +0200298 fdt_property_string(fdt, FIT_DESC_PROP, str);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700299
300 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000301 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700302 fdt_property_string(fdt, typename, str);
Abel Vesa7e0cb5e2019-03-12 08:34:32 +0000303 fdt_property_string(fdt, FIT_LOADABLE_PROP, str);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700304
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100305 if (params->fit_ramdisk)
306 fdt_property_string(fdt, FIT_RAMDISK_PROP,
Andre Przywara9ef25e82017-12-04 02:05:12 +0000307 FIT_RAMDISK_PROP "-1");
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100308
Andre Przywara9ef25e82017-12-04 02:05:12 +0000309 snprintf(str, sizeof(str), FIT_FDT_PROP "-%d", upto);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700310 fdt_property_string(fdt, FIT_FDT_PROP, str);
311 fdt_end_node(fdt);
312 }
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100313
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700314 if (!upto) {
Andre Przywara9ef25e82017-12-04 02:05:12 +0000315 fdt_begin_node(fdt, "conf-1");
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700316 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara9ef25e82017-12-04 02:05:12 +0000317 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700318 fdt_property_string(fdt, typename, str);
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100319
320 if (params->fit_ramdisk)
321 fdt_property_string(fdt, FIT_RAMDISK_PROP,
Andre Przywara9ef25e82017-12-04 02:05:12 +0000322 FIT_RAMDISK_PROP "-1");
Tomeu Vizoso8d83ed22016-11-04 14:22:15 +0100323
Simon Glassbd8bc5d2016-02-22 22:55:52 -0700324 fdt_end_node(fdt);
325 }
Simon Glass88e31cb2016-02-22 22:55:51 -0700326
327 fdt_end_node(fdt);
328}
329
330static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
331{
332 int ret;
333
334 ret = fdt_create(fdt, size);
335 if (ret)
336 return ret;
337 fdt_finish_reservemap(fdt);
338 fdt_begin_node(fdt, "");
Michal Simeka4e678d2018-07-20 12:31:02 +0200339 fdt_property_strf(fdt, FIT_DESC_PROP,
Simon Glass88e31cb2016-02-22 22:55:51 -0700340 "%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);
345 if (ret)
346 return ret;
347 fit_write_configs(params, fdt);
348 fdt_end_node(fdt);
349 ret = fdt_finish(fdt);
350 if (ret)
351 return ret;
352
353 return fdt_totalsize(fdt);
354}
355
356static int fit_build(struct image_tool_params *params, const char *fname)
357{
358 char *buf;
359 int size;
360 int ret;
361 int fd;
362
363 size = fit_calc_size(params);
364 if (size < 0)
365 return -1;
366 buf = malloc(size);
367 if (!buf) {
368 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
369 params->cmdname, size);
370 return -1;
371 }
372 ret = fit_build_fdt(params, buf, size);
373 if (ret < 0) {
374 fprintf(stderr, "%s: Failed to build FIT image\n",
375 params->cmdname);
Simon Glassc0ee1ca2016-03-16 07:45:41 -0600376 goto err_buf;
Simon Glass88e31cb2016-02-22 22:55:51 -0700377 }
378 size = ret;
379 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
380 if (fd < 0) {
381 fprintf(stderr, "%s: Can't open %s: %s\n",
382 params->cmdname, fname, strerror(errno));
Tom Rinib8286652017-09-26 22:14:44 -0400383 goto err_buf;
Simon Glass88e31cb2016-02-22 22:55:51 -0700384 }
385 ret = write(fd, buf, size);
386 if (ret != size) {
387 fprintf(stderr, "%s: Can't write %s: %s\n",
388 params->cmdname, fname, strerror(errno));
Simon Glass88e31cb2016-02-22 22:55:51 -0700389 goto err;
390 }
391 close(fd);
Simon Glassc0ee1ca2016-03-16 07:45:41 -0600392 free(buf);
Simon Glass88e31cb2016-02-22 22:55:51 -0700393
394 return 0;
395err:
Simon Glassc0ee1ca2016-03-16 07:45:41 -0600396 close(fd);
397err_buf:
Simon Glass88e31cb2016-02-22 22:55:51 -0700398 free(buf);
399 return -1;
400}
401
402/**
Simon Glassafd728c2016-02-22 22:55:53 -0700403 * fit_extract_data() - Move all data outside the FIT
404 *
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.
409 *
410 * This function cannot cope with FITs with 'data-offset' properties. All
411 * data must be in 'data' properties on entry.
412 */
413static int fit_extract_data(struct image_tool_params *params, const char *fname)
414{
415 void *buf;
416 int buf_ptr;
417 int fit_size, new_size;
418 int fd;
419 struct stat sbuf;
420 void *fdt;
421 int ret;
422 int images;
423 int node;
424
Luca Boccassibff733f2019-05-14 19:35:02 +0100425 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false, false);
Simon Glassafd728c2016-02-22 22:55:53 -0700426 if (fd < 0)
427 return -EIO;
428 fit_size = fdt_totalsize(fdt);
429
430 /* Allocate space to hold the image data we will extract */
431 buf = malloc(fit_size);
432 if (!buf) {
433 ret = -ENOMEM;
Simon Glass4e7505f2016-03-16 07:45:39 -0600434 goto err_munmap;
Simon Glassafd728c2016-02-22 22:55:53 -0700435 }
436 buf_ptr = 0;
437
438 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
439 if (images < 0) {
440 debug("%s: Cannot find /images node: %d\n", __func__, images);
441 ret = -EINVAL;
Simon Glass4e7505f2016-03-16 07:45:39 -0600442 goto err_munmap;
Simon Glassafd728c2016-02-22 22:55:53 -0700443 }
444
445 for (node = fdt_first_subnode(fdt, images);
446 node >= 0;
447 node = fdt_next_subnode(fdt, node)) {
448 const char *data;
449 int len;
450
Michal Simeka4e678d2018-07-20 12:31:02 +0200451 data = fdt_getprop(fdt, node, FIT_DATA_PROP, &len);
Simon Glassafd728c2016-02-22 22:55:53 -0700452 if (!data)
453 continue;
454 memcpy(buf + buf_ptr, data, len);
455 debug("Extracting data size %x\n", len);
456
Michal Simeka4e678d2018-07-20 12:31:02 +0200457 ret = fdt_delprop(fdt, node, FIT_DATA_PROP);
Simon Glassafd728c2016-02-22 22:55:53 -0700458 if (ret) {
459 ret = -EPERM;
Simon Glass4e7505f2016-03-16 07:45:39 -0600460 goto err_munmap;
Simon Glassafd728c2016-02-22 22:55:53 -0700461 }
Teddy Reeda8457622016-06-09 19:38:02 -0700462 if (params->external_offset > 0) {
463 /* An external offset positions the data absolutely. */
Michal Simeka4e678d2018-07-20 12:31:02 +0200464 fdt_setprop_u32(fdt, node, FIT_DATA_POSITION_PROP,
Teddy Reeda8457622016-06-09 19:38:02 -0700465 params->external_offset + buf_ptr);
466 } else {
Michal Simeka4e678d2018-07-20 12:31:02 +0200467 fdt_setprop_u32(fdt, node, FIT_DATA_OFFSET_PROP,
468 buf_ptr);
Teddy Reeda8457622016-06-09 19:38:02 -0700469 }
Michal Simeka4e678d2018-07-20 12:31:02 +0200470 fdt_setprop_u32(fdt, node, FIT_DATA_SIZE_PROP, len);
Simon Glassafd728c2016-02-22 22:55:53 -0700471
472 buf_ptr += (len + 3) & ~3;
473 }
474
475 /* Pack the FDT and place the data after it */
476 fdt_pack(fdt);
477
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);
483
484 if (ftruncate(fd, new_size)) {
485 debug("%s: Failed to truncate file: %s\n", __func__,
486 strerror(errno));
487 ret = -EIO;
488 goto err;
489 }
Teddy Reeda8457622016-06-09 19:38:02 -0700490
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);
496 ret = -EINVAL;
497 goto err;
498 }
499 new_size = params->external_offset;
500 }
Simon Glassafd728c2016-02-22 22:55:53 -0700501 if (lseek(fd, new_size, SEEK_SET) < 0) {
502 debug("%s: Failed to seek to end of file: %s\n", __func__,
503 strerror(errno));
504 ret = -EIO;
505 goto err;
506 }
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));
510 ret = -EIO;
511 goto err;
512 }
Tom Rinib8286652017-09-26 22:14:44 -0400513 free(buf);
Simon Glass4e7505f2016-03-16 07:45:39 -0600514 close(fd);
515 return 0;
Simon Glassafd728c2016-02-22 22:55:53 -0700516
Simon Glass4e7505f2016-03-16 07:45:39 -0600517err_munmap:
518 munmap(fdt, sbuf.st_size);
Simon Glassafd728c2016-02-22 22:55:53 -0700519err:
Simon Glassf3a6e8f2016-03-16 07:45:40 -0600520 if (buf)
521 free(buf);
Simon Glassafd728c2016-02-22 22:55:53 -0700522 close(fd);
523 return ret;
524}
525
Simon Glassd11b7002016-02-22 22:55:54 -0700526static int fit_import_data(struct image_tool_params *params, const char *fname)
527{
528 void *fdt, *old_fdt;
529 int fit_size, new_size, size, data_base;
530 int fd;
531 struct stat sbuf;
532 int ret;
533 int images;
534 int node;
535
Luca Boccassibff733f2019-05-14 19:35:02 +0100536 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false, false);
Simon Glassd11b7002016-02-22 22:55:54 -0700537 if (fd < 0)
538 return -EIO;
539 fit_size = fdt_totalsize(old_fdt);
540 data_base = (fit_size + 3) & ~3;
541
542 /* Allocate space to hold the new FIT */
543 size = sbuf.st_size + 16384;
544 fdt = malloc(size);
545 if (!fdt) {
546 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
547 __func__, size);
548 ret = -ENOMEM;
Tom Rinia29829e2017-10-07 11:27:59 -0400549 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700550 }
551 ret = fdt_open_into(old_fdt, fdt, size);
552 if (ret) {
553 debug("%s: Failed to expand FIT: %s\n", __func__,
554 fdt_strerror(errno));
555 ret = -EINVAL;
Tom Rinia29829e2017-10-07 11:27:59 -0400556 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700557 }
558
559 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
560 if (images < 0) {
561 debug("%s: Cannot find /images node: %d\n", __func__, images);
562 ret = -EINVAL;
Tom Rinia29829e2017-10-07 11:27:59 -0400563 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700564 }
565
566 for (node = fdt_first_subnode(fdt, images);
567 node >= 0;
568 node = fdt_next_subnode(fdt, node)) {
569 int buf_ptr;
570 int len;
571
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)
575 continue;
576 debug("Importing data size %x\n", len);
577
578 ret = fdt_setprop(fdt, node, "data", fdt + data_base + buf_ptr,
579 len);
580 if (ret) {
581 debug("%s: Failed to write property: %s\n", __func__,
582 fdt_strerror(ret));
583 ret = -EINVAL;
Tom Rinia29829e2017-10-07 11:27:59 -0400584 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700585 }
586 }
587
Tom Rinia29829e2017-10-07 11:27:59 -0400588 /* Close the old fd so we can re-use it. */
Simon Glassd11b7002016-02-22 22:55:54 -0700589 close(fd);
590
591 /* Pack the FDT and place the data after it */
592 fdt_pack(fdt);
593
594 new_size = fdt_totalsize(fdt);
595 debug("Size expanded from %x to %x\n", fit_size, new_size);
596
597 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
598 if (fd < 0) {
599 fprintf(stderr, "%s: Can't open %s: %s\n",
600 params->cmdname, fname, strerror(errno));
Tom Rinia29829e2017-10-07 11:27:59 -0400601 ret = -EIO;
602 goto err_no_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700603 }
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));
607 ret = -EIO;
Tom Rinia29829e2017-10-07 11:27:59 -0400608 goto err_has_fd;
Simon Glassd11b7002016-02-22 22:55:54 -0700609 }
Simon Glassd11b7002016-02-22 22:55:54 -0700610
611 ret = 0;
612
Tom Rinia29829e2017-10-07 11:27:59 -0400613err_has_fd:
614 close(fd);
615err_no_fd:
Tom Rinib8286652017-09-26 22:14:44 -0400616 munmap(old_fdt, sbuf.st_size);
Simon Glass5014cc12016-03-16 07:45:38 -0600617 free(fdt);
Simon Glassd11b7002016-02-22 22:55:54 -0700618 return ret;
619}
620
Simon Glassafd728c2016-02-22 22:55:53 -0700621/**
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530622 * fit_handle_file - main FIT file processing function
623 *
624 * fit_handle_file() runs dtc to convert .its to .itb, includes
625 * binary data, updates timestamp property and calculates hashes.
626 *
627 * datafile - .its file
628 * imagefile - .itb file
629 *
630 * returns:
631 * only on success, otherwise calls exit (EXIT_FAILURE);
632 */
Guilherme Maciel Ferreira8ed4d1c2013-12-01 12:43:10 -0700633static int fit_handle_file(struct image_tool_params *params)
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530634{
635 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
636 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
Simon Glass802aa822014-06-02 22:04:53 -0600637 size_t size_inc;
638 int ret;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530639
640 /* Flattened Image Tree (FIT) format handling */
641 debug ("FIT format handling\n");
642
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);
650 }
651 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
652
Simon Glassce8c3ca2013-06-13 15:10:05 -0700653 /* We either compile the source file, or use the existing FIT image */
Simon Glass88e31cb2016-02-22 22:55:51 -0700654 if (params->auto_its) {
655 if (fit_build(params, tmpfile)) {
656 fprintf(stderr, "%s: failed to build FIT\n",
657 params->cmdname);
658 return EXIT_FAILURE;
659 }
660 *cmd = '\0';
661 } else if (params->datafile) {
Stefan Theilff6c3b22018-03-08 09:00:13 +0100662 /* 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);
Simon Glassce8c3ca2013-06-13 15:10:05 -0700665 debug("Trying to execute \"%s\"\n", cmd);
666 } else {
Mirza, Taimoor74a21dd2017-10-04 20:28:03 +0500667 snprintf(cmd, sizeof(cmd), "cp \"%s\" \"%s\"",
Simon Glassce8c3ca2013-06-13 15:10:05 -0700668 params->imagefile, tmpfile);
669 }
Simon Glass88e31cb2016-02-22 22:55:51 -0700670 if (*cmd && system(cmd) == -1) {
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530671 fprintf (stderr, "%s: system(%s) failed: %s\n",
672 params->cmdname, cmd, strerror(errno));
Simon Glass4161c412013-05-08 08:05:57 +0000673 goto err_system;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530674 }
675
Simon Glassd11b7002016-02-22 22:55:54 -0700676 /* Move the data so it is internal to the FIT, if needed */
677 ret = fit_import_data(params, tmpfile);
678 if (ret)
679 goto err_system;
680
Simon Glass802aa822014-06-02 22:04:53 -0600681 /*
682 * Set hashes for images in the blob. Unfortunately we may need more
683 * space in either FDT, so keep trying until we succeed.
684 *
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.
690 */
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)
694 break;
Simon Glassb4d8b092013-06-13 15:10:04 -0700695 }
696
Simon Glass802aa822014-06-02 22:04:53 -0600697 if (ret) {
Simon Glass061752e2016-07-03 09:40:43 -0600698 fprintf(stderr, "%s Can't add hashes to FIT blob: %d\n",
699 params->cmdname, ret);
Simon Glass802aa822014-06-02 22:04:53 -0600700 goto err_system;
Simon Glassb4d8b092013-06-13 15:10:04 -0700701 }
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530702
Simon Glassafd728c2016-02-22 22:55:53 -0700703 /* Move the data so it is external to the FIT, if requested */
704 if (params->external_data) {
705 ret = fit_extract_data(params, tmpfile);
706 if (ret)
707 goto err_system;
708 }
709
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530710 if (rename (tmpfile, params->imagefile) == -1) {
711 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
712 params->cmdname, tmpfile, params->imagefile,
713 strerror (errno));
714 unlink (tmpfile);
715 unlink (params->imagefile);
Simon Glass802aa822014-06-02 22:04:53 -0600716 return EXIT_FAILURE;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530717 }
Simon Glass802aa822014-06-02 22:04:53 -0600718 return EXIT_SUCCESS;
Simon Glass4161c412013-05-08 08:05:57 +0000719
Simon Glass4161c412013-05-08 08:05:57 +0000720err_system:
721 unlink(tmpfile);
722 return -1;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530723}
724
Guilherme Maciel Ferreira3c46bcd2015-01-15 02:54:42 -0200725/**
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
730 *
731 * returns:
732 * zero in case of success or a negative value if fail.
733 */
734static int fit_image_extract(
735 const void *fit,
736 int image_noffset,
737 const char *file_name)
738{
739 const void *file_data;
740 size_t file_size = 0;
741
742 /* get the "data" property of component at offset "image_noffset" */
743 fit_image_get_data(fit, image_noffset, &file_data, &file_size);
744
745 /* save the "file_data" into the file specified by "file_name" */
746 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
747}
748
749/**
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
753 *
754 * returns:
755 * zero in case of success or a negative value if fail.
756 */
757static int fit_extract_contents(void *ptr, struct image_tool_params *params)
758{
759 int images_noffset;
760 int noffset;
761 int ndepth;
762 const void *fit = ptr;
763 int count = 0;
764 const char *p;
765
766 /* Indent string is defined in header image.h */
767 p = IMAGE_INDENT_STRING;
768
769 if (!fit_check_format(fit)) {
770 printf("Bad FIT image format\n");
771 return -1;
772 }
773
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));
779 return -1;
780 }
781
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);
786 return -1;
787 }
788
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)) {
794 if (ndepth == 1) {
795 /*
796 * Direct child node of the images parent node,
797 * i.e. component image node.
798 */
799 if (params->pflag == count) {
800 printf("Extracted:\n%s Image %u (%s)\n", p,
801 count, fit_get_name(fit, noffset, NULL));
802
803 fit_image_print(fit, noffset, p);
804
805 return fit_image_extract(fit, noffset,
806 params->outfile);
807 }
808
809 count++;
810 }
811 }
812
813 return 0;
814}
815
Guilherme Maciel Ferreira8ed4d1c2013-12-01 12:43:10 -0700816static int fit_check_params(struct image_tool_params *params)
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530817{
Simon Glass88e31cb2016-02-22 22:55:51 -0700818 if (params->auto_its)
819 return 0;
Prafulla Wadaskarfabf3cf2009-08-19 17:36:46 +0530820 return ((params->dflag && (params->fflag || params->lflag)) ||
821 (params->fflag && (params->dflag || params->lflag)) ||
822 (params->lflag && (params->dflag || params->fflag)));
823}
824
Guilherme Maciel Ferreira28be1cf2015-01-15 02:48:07 -0200825U_BOOT_IMAGE_TYPE(
826 fitimage,
827 "FIT Image support",
828 sizeof(image_header_t),
829 (void *)&header,
830 fit_check_params,
831 fit_verify_header,
832 fit_print_contents,
833 NULL,
Guilherme Maciel Ferreira3c46bcd2015-01-15 02:54:42 -0200834 fit_extract_contents,
Guilherme Maciel Ferreira28be1cf2015-01-15 02:48:07 -0200835 fit_check_image_types,
836 fit_handle_file,
837 NULL /* FIT images use DTB header */
838);