blob: 15f7c82d619320e4ed1653c4bc57bf3d03085ae2 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Prafulla Wadaskar89a4d6b2009-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 Wadaskar89a4d6b2009-08-19 17:36:46 +053014 */
15
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070016#include "imagetool.h"
Heiko Schocher6bf4ca02014-03-03 12:19:29 +010017#include "fit_common.h"
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053018#include "mkimage.h"
19#include <image.h>
Sven Roedererea5d3732020-04-27 02:08:39 +020020#include <string.h>
Simon Glass8e35bb02016-02-22 22:55:51 -070021#include <stdarg.h>
22#include <version.h>
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053023#include <u-boot/crc.h>
24
25static image_header_t header;
26
Simon Glassa9468112014-06-02 22:04:53 -060027static int fit_add_file_data(struct image_tool_params *params, size_t size_inc,
28 const char *tmpfile)
29{
30 int tfd, destfd = 0;
31 void *dest_blob = NULL;
32 off_t destfd_size = 0;
33 struct stat sbuf;
34 void *ptr;
35 int ret = 0;
36
Luca Boccassi7d574852019-05-14 19:35:02 +010037 tfd = mmap_fdt(params->cmdname, tmpfile, size_inc, &ptr, &sbuf, true,
38 false);
Simon Glassa9468112014-06-02 22:04:53 -060039 if (tfd < 0)
40 return -EIO;
41
42 if (params->keydest) {
43 struct stat dest_sbuf;
44
45 destfd = mmap_fdt(params->cmdname, params->keydest, size_inc,
Luca Boccassi7d574852019-05-14 19:35:02 +010046 &dest_blob, &dest_sbuf, false,
47 false);
Simon Glassa9468112014-06-02 22:04:53 -060048 if (destfd < 0) {
49 ret = -EIO;
50 goto err_keydest;
51 }
52 destfd_size = dest_sbuf.st_size;
53 }
54
55 /* for first image creation, add a timestamp at offset 0 i.e., root */
Simon Glass152b2462020-07-09 18:39:43 -060056 if (params->datafile || params->reset_timestamp) {
Alex Kiernan87925df2018-06-20 20:10:51 +000057 time_t time = imagetool_get_source_date(params->cmdname,
58 sbuf.st_mtime);
Vagrant Cascadian58470842016-06-16 12:28:40 -070059 ret = fit_set_timestamp(ptr, 0, time);
60 }
Simon Glassa9468112014-06-02 22:04:53 -060061
62 if (!ret) {
Philippe Reynes7298e422019-12-18 18:25:41 +010063 ret = fit_cipher_data(params->keydir, dest_blob, ptr,
64 params->comment,
65 params->require_keys,
66 params->engine_id,
67 params->cmdname);
68 }
69
70 if (!ret) {
Alexandru Gagniuc36bfcb62021-02-19 12:45:17 -060071 ret = fit_add_verification_data(params->keydir,
72 params->keyfile, dest_blob, ptr,
Simon Glassa9468112014-06-02 22:04:53 -060073 params->comment,
George McCollisterf1ca1fd2017-01-06 13:14:17 -060074 params->require_keys,
Alex Kiernan795f4522018-06-20 20:10:52 +000075 params->engine_id,
Jan Kiszka5902a392022-01-14 10:21:19 +010076 params->cmdname,
Simon Glass2d2384b2021-11-12 12:28:13 -070077 params->algo_name,
78 &params->summary);
Simon Glassa9468112014-06-02 22:04:53 -060079 }
80
81 if (dest_blob) {
82 munmap(dest_blob, destfd_size);
83 close(destfd);
84 }
85
86err_keydest:
87 munmap(ptr, sbuf.st_size);
88 close(tfd);
Simon Glassa9468112014-06-02 22:04:53 -060089 return ret;
90}
91
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053092/**
Simon Glass8e35bb02016-02-22 22:55:51 -070093 * fit_calc_size() - Calculate the approximate size of the FIT we will generate
94 */
95static int fit_calc_size(struct image_tool_params *params)
96{
Simon Glassfb4cce02016-02-22 22:55:52 -070097 struct content_info *cont;
Simon Glass8e35bb02016-02-22 22:55:51 -070098 int size, total_size;
99
100 size = imagetool_get_filesize(params, params->datafile);
101 if (size < 0)
102 return -1;
Simon Glass8e35bb02016-02-22 22:55:51 -0700103 total_size = size;
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100104
105 if (params->fit_ramdisk) {
106 size = imagetool_get_filesize(params, params->fit_ramdisk);
107 if (size < 0)
108 return -1;
109 total_size += size;
110 }
111
Simon Glassfb4cce02016-02-22 22:55:52 -0700112 for (cont = params->content_head; cont; cont = cont->next) {
113 size = imagetool_get_filesize(params, cont->fname);
114 if (size < 0)
115 return -1;
Simon Glass8e35bb02016-02-22 22:55:51 -0700116
Simon Glass31729112020-05-27 07:24:55 -0600117 /* Add space for properties and hash node */
Simon Glassfb4cce02016-02-22 22:55:52 -0700118 total_size += size + 300;
119 }
Simon Glass8e35bb02016-02-22 22:55:51 -0700120
121 /* Add plenty of space for headers, properties, nodes, etc. */
122 total_size += 4096;
123
124 return total_size;
125}
126
127static int fdt_property_file(struct image_tool_params *params,
128 void *fdt, const char *name, const char *fname)
129{
130 struct stat sbuf;
131 void *ptr;
132 int ret;
133 int fd;
134
135 fd = open(fname, O_RDWR | O_BINARY);
136 if (fd < 0) {
137 fprintf(stderr, "%s: Can't open %s: %s\n",
138 params->cmdname, fname, strerror(errno));
139 return -1;
140 }
141
142 if (fstat(fd, &sbuf) < 0) {
143 fprintf(stderr, "%s: Can't stat %s: %s\n",
144 params->cmdname, fname, strerror(errno));
145 goto err;
146 }
147
148 ret = fdt_property_placeholder(fdt, "data", sbuf.st_size, &ptr);
149 if (ret)
Simon Glass3bd3a542016-03-16 07:45:42 -0600150 goto err;
Simon Glass8e35bb02016-02-22 22:55:51 -0700151 ret = read(fd, ptr, sbuf.st_size);
152 if (ret != sbuf.st_size) {
153 fprintf(stderr, "%s: Can't read %s: %s\n",
154 params->cmdname, fname, strerror(errno));
155 goto err;
156 }
Simon Glass3bd3a542016-03-16 07:45:42 -0600157 close(fd);
Simon Glass8e35bb02016-02-22 22:55:51 -0700158
159 return 0;
160err:
161 close(fd);
162 return -1;
163}
164
165static int fdt_property_strf(void *fdt, const char *name, const char *fmt, ...)
166{
167 char str[100];
168 va_list ptr;
169
170 va_start(ptr, fmt);
171 vsnprintf(str, sizeof(str), fmt, ptr);
172 va_end(ptr);
173 return fdt_property_string(fdt, name, str);
174}
175
Simon Glassfb4cce02016-02-22 22:55:52 -0700176static void get_basename(char *str, int size, const char *fname)
177{
178 const char *p, *start, *end;
179 int len;
180
181 /*
182 * Use the base name as the 'name' field. So for example:
183 *
184 * "arch/arm/dts/sun7i-a20-bananapro.dtb"
185 * becomes "sun7i-a20-bananapro"
186 */
187 p = strrchr(fname, '/');
188 start = p ? p + 1 : fname;
189 p = strrchr(fname, '.');
190 end = p ? p : fname + strlen(fname);
191 len = end - start;
192 if (len >= size)
193 len = size - 1;
194 memcpy(str, start, len);
195 str[len] = '\0';
196}
197
Simon Glass8e35bb02016-02-22 22:55:51 -0700198/**
Simon Glass31729112020-05-27 07:24:55 -0600199 * add_crc_node() - Add a hash node to request a CRC checksum for an image
200 *
201 * @fdt: Device tree to add to (in sequential-write mode)
202 */
203static void add_crc_node(void *fdt)
204{
205 fdt_begin_node(fdt, "hash-1");
206 fdt_property_string(fdt, FIT_ALGO_PROP, "crc32");
207 fdt_end_node(fdt);
208}
209
210/**
Simon Glass8e35bb02016-02-22 22:55:51 -0700211 * fit_write_images() - Write out a list of images to the FIT
212 *
Simon Glassfb4cce02016-02-22 22:55:52 -0700213 * We always include the main image (params->datafile). If there are device
Andre Przywara2eda8e92017-12-04 02:05:12 +0000214 * tree files, we include an fdt- node for each of those too.
Simon Glass8e35bb02016-02-22 22:55:51 -0700215 */
216static int fit_write_images(struct image_tool_params *params, char *fdt)
217{
Simon Glassfb4cce02016-02-22 22:55:52 -0700218 struct content_info *cont;
Simon Glass8e35bb02016-02-22 22:55:51 -0700219 const char *typename;
220 char str[100];
Simon Glassfb4cce02016-02-22 22:55:52 -0700221 int upto;
Simon Glass8e35bb02016-02-22 22:55:51 -0700222 int ret;
223
224 fdt_begin_node(fdt, "images");
225
226 /* First the main image */
227 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara2eda8e92017-12-04 02:05:12 +0000228 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glass8e35bb02016-02-22 22:55:51 -0700229 fdt_begin_node(fdt, str);
Michal Simek4a8b6e02018-07-20 12:31:02 +0200230 fdt_property_string(fdt, FIT_DESC_PROP, params->imagename);
231 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
232 fdt_property_string(fdt, FIT_ARCH_PROP,
Simon Glass3a45f382016-06-30 10:52:12 -0600233 genimg_get_arch_short_name(params->arch));
Michal Simek4a8b6e02018-07-20 12:31:02 +0200234 fdt_property_string(fdt, FIT_OS_PROP,
235 genimg_get_os_short_name(params->os));
236 fdt_property_string(fdt, FIT_COMP_PROP,
Simon Glass8e35bb02016-02-22 22:55:51 -0700237 genimg_get_comp_short_name(params->comp));
Michal Simek4a8b6e02018-07-20 12:31:02 +0200238 fdt_property_u32(fdt, FIT_LOAD_PROP, params->addr);
239 fdt_property_u32(fdt, FIT_ENTRY_PROP, params->ep);
Simon Glass8e35bb02016-02-22 22:55:51 -0700240
241 /*
242 * Put data last since it is large. SPL may only load the first part
243 * of the DT, so this way it can access all the above fields.
244 */
Michal Simek4a8b6e02018-07-20 12:31:02 +0200245 ret = fdt_property_file(params, fdt, FIT_DATA_PROP, params->datafile);
Simon Glass8e35bb02016-02-22 22:55:51 -0700246 if (ret)
247 return ret;
Simon Glass31729112020-05-27 07:24:55 -0600248 add_crc_node(fdt);
Simon Glass8e35bb02016-02-22 22:55:51 -0700249 fdt_end_node(fdt);
250
Simon Glassfb4cce02016-02-22 22:55:52 -0700251 /* Now the device tree files if available */
252 upto = 0;
253 for (cont = params->content_head; cont; cont = cont->next) {
254 if (cont->type != IH_TYPE_FLATDT)
255 continue;
Michal Sojka12e288a2019-09-13 12:43:12 +0200256 typename = genimg_get_type_short_name(cont->type);
Andre Przywara2eda8e92017-12-04 02:05:12 +0000257 snprintf(str, sizeof(str), "%s-%d", FIT_FDT_PROP, ++upto);
Simon Glassfb4cce02016-02-22 22:55:52 -0700258 fdt_begin_node(fdt, str);
259
260 get_basename(str, sizeof(str), cont->fname);
Michal Simek4a8b6e02018-07-20 12:31:02 +0200261 fdt_property_string(fdt, FIT_DESC_PROP, str);
262 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
263 cont->fname);
Simon Glassfb4cce02016-02-22 22:55:52 -0700264 if (ret)
265 return ret;
Michal Simek4a8b6e02018-07-20 12:31:02 +0200266 fdt_property_string(fdt, FIT_TYPE_PROP, typename);
267 fdt_property_string(fdt, FIT_ARCH_PROP,
Simon Glassfb4cce02016-02-22 22:55:52 -0700268 genimg_get_arch_short_name(params->arch));
Michal Simek4a8b6e02018-07-20 12:31:02 +0200269 fdt_property_string(fdt, FIT_COMP_PROP,
Simon Glassfb4cce02016-02-22 22:55:52 -0700270 genimg_get_comp_short_name(IH_COMP_NONE));
Simon Glass31729112020-05-27 07:24:55 -0600271 add_crc_node(fdt);
Simon Glassfb4cce02016-02-22 22:55:52 -0700272 fdt_end_node(fdt);
273 }
274
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100275 /* And a ramdisk file if available */
276 if (params->fit_ramdisk) {
Andre Przywara2eda8e92017-12-04 02:05:12 +0000277 fdt_begin_node(fdt, FIT_RAMDISK_PROP "-1");
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100278
Michal Simek4a8b6e02018-07-20 12:31:02 +0200279 fdt_property_string(fdt, FIT_TYPE_PROP, FIT_RAMDISK_PROP);
280 fdt_property_string(fdt, FIT_OS_PROP,
281 genimg_get_os_short_name(params->os));
Michal Sojka12e288a2019-09-13 12:43:12 +0200282 fdt_property_string(fdt, FIT_ARCH_PROP,
283 genimg_get_arch_short_name(params->arch));
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100284
Michal Simek4a8b6e02018-07-20 12:31:02 +0200285 ret = fdt_property_file(params, fdt, FIT_DATA_PROP,
286 params->fit_ramdisk);
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100287 if (ret)
288 return ret;
Simon Glass31729112020-05-27 07:24:55 -0600289 add_crc_node(fdt);
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100290 fdt_end_node(fdt);
291 }
292
Simon Glass8e35bb02016-02-22 22:55:51 -0700293 fdt_end_node(fdt);
294
295 return 0;
296}
297
298/**
299 * fit_write_configs() - Write out a list of configurations to the FIT
300 *
Simon Glassfb4cce02016-02-22 22:55:52 -0700301 * If there are device tree files, we include a configuration for each, which
302 * selects the main image (params->datafile) and its corresponding device
303 * tree file.
304 *
305 * Otherwise we just create a configuration with the main image in it.
Simon Glass8e35bb02016-02-22 22:55:51 -0700306 */
307static void fit_write_configs(struct image_tool_params *params, char *fdt)
308{
Simon Glassfb4cce02016-02-22 22:55:52 -0700309 struct content_info *cont;
Simon Glass8e35bb02016-02-22 22:55:51 -0700310 const char *typename;
311 char str[100];
Simon Glassfb4cce02016-02-22 22:55:52 -0700312 int upto;
Simon Glass8e35bb02016-02-22 22:55:51 -0700313
314 fdt_begin_node(fdt, "configurations");
Michal Simek4a8b6e02018-07-20 12:31:02 +0200315 fdt_property_string(fdt, FIT_DEFAULT_PROP, "conf-1");
Simon Glass8e35bb02016-02-22 22:55:51 -0700316
Simon Glassfb4cce02016-02-22 22:55:52 -0700317 upto = 0;
318 for (cont = params->content_head; cont; cont = cont->next) {
319 if (cont->type != IH_TYPE_FLATDT)
320 continue;
321 typename = genimg_get_type_short_name(cont->type);
Andre Przywara2eda8e92017-12-04 02:05:12 +0000322 snprintf(str, sizeof(str), "conf-%d", ++upto);
Simon Glassfb4cce02016-02-22 22:55:52 -0700323 fdt_begin_node(fdt, str);
324
325 get_basename(str, sizeof(str), cont->fname);
Michal Simek4a8b6e02018-07-20 12:31:02 +0200326 fdt_property_string(fdt, FIT_DESC_PROP, str);
Simon Glassfb4cce02016-02-22 22:55:52 -0700327
328 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara2eda8e92017-12-04 02:05:12 +0000329 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glassfb4cce02016-02-22 22:55:52 -0700330 fdt_property_string(fdt, typename, str);
Abel Vesacabde442019-03-12 08:34:32 +0000331 fdt_property_string(fdt, FIT_LOADABLE_PROP, str);
Simon Glassfb4cce02016-02-22 22:55:52 -0700332
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100333 if (params->fit_ramdisk)
334 fdt_property_string(fdt, FIT_RAMDISK_PROP,
Andre Przywara2eda8e92017-12-04 02:05:12 +0000335 FIT_RAMDISK_PROP "-1");
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100336
Andre Przywara2eda8e92017-12-04 02:05:12 +0000337 snprintf(str, sizeof(str), FIT_FDT_PROP "-%d", upto);
Simon Glassfb4cce02016-02-22 22:55:52 -0700338 fdt_property_string(fdt, FIT_FDT_PROP, str);
339 fdt_end_node(fdt);
340 }
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100341
Simon Glassfb4cce02016-02-22 22:55:52 -0700342 if (!upto) {
Andre Przywara2eda8e92017-12-04 02:05:12 +0000343 fdt_begin_node(fdt, "conf-1");
Simon Glassfb4cce02016-02-22 22:55:52 -0700344 typename = genimg_get_type_short_name(params->fit_image_type);
Andre Przywara2eda8e92017-12-04 02:05:12 +0000345 snprintf(str, sizeof(str), "%s-1", typename);
Simon Glassfb4cce02016-02-22 22:55:52 -0700346 fdt_property_string(fdt, typename, str);
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100347
348 if (params->fit_ramdisk)
349 fdt_property_string(fdt, FIT_RAMDISK_PROP,
Andre Przywara2eda8e92017-12-04 02:05:12 +0000350 FIT_RAMDISK_PROP "-1");
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +0100351
Simon Glassfb4cce02016-02-22 22:55:52 -0700352 fdt_end_node(fdt);
353 }
Simon Glass8e35bb02016-02-22 22:55:51 -0700354
355 fdt_end_node(fdt);
356}
357
358static int fit_build_fdt(struct image_tool_params *params, char *fdt, int size)
359{
360 int ret;
361
362 ret = fdt_create(fdt, size);
363 if (ret)
364 return ret;
365 fdt_finish_reservemap(fdt);
366 fdt_begin_node(fdt, "");
Michal Simek4a8b6e02018-07-20 12:31:02 +0200367 fdt_property_strf(fdt, FIT_DESC_PROP,
Simon Glass8e35bb02016-02-22 22:55:51 -0700368 "%s image with one or more FDT blobs",
369 genimg_get_type_name(params->fit_image_type));
370 fdt_property_strf(fdt, "creator", "U-Boot mkimage %s", PLAIN_VERSION);
371 fdt_property_u32(fdt, "#address-cells", 1);
372 ret = fit_write_images(params, fdt);
373 if (ret)
374 return ret;
375 fit_write_configs(params, fdt);
376 fdt_end_node(fdt);
377 ret = fdt_finish(fdt);
378 if (ret)
379 return ret;
380
381 return fdt_totalsize(fdt);
382}
383
384static int fit_build(struct image_tool_params *params, const char *fname)
385{
386 char *buf;
387 int size;
388 int ret;
389 int fd;
390
391 size = fit_calc_size(params);
392 if (size < 0)
393 return -1;
Fabio Estevamaaa91a42020-07-27 21:03:13 -0300394 buf = calloc(1, size);
Simon Glass8e35bb02016-02-22 22:55:51 -0700395 if (!buf) {
396 fprintf(stderr, "%s: Out of memory (%d bytes)\n",
397 params->cmdname, size);
398 return -1;
399 }
400 ret = fit_build_fdt(params, buf, size);
401 if (ret < 0) {
402 fprintf(stderr, "%s: Failed to build FIT image\n",
403 params->cmdname);
Simon Glass7b0bbd82016-03-16 07:45:41 -0600404 goto err_buf;
Simon Glass8e35bb02016-02-22 22:55:51 -0700405 }
406 size = ret;
407 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
408 if (fd < 0) {
409 fprintf(stderr, "%s: Can't open %s: %s\n",
410 params->cmdname, fname, strerror(errno));
Tom Rini3c2dff52017-09-26 22:14:44 -0400411 goto err_buf;
Simon Glass8e35bb02016-02-22 22:55:51 -0700412 }
413 ret = write(fd, buf, size);
414 if (ret != size) {
415 fprintf(stderr, "%s: Can't write %s: %s\n",
416 params->cmdname, fname, strerror(errno));
Simon Glass8e35bb02016-02-22 22:55:51 -0700417 goto err;
418 }
419 close(fd);
Simon Glass7b0bbd82016-03-16 07:45:41 -0600420 free(buf);
Simon Glass8e35bb02016-02-22 22:55:51 -0700421
422 return 0;
423err:
Simon Glass7b0bbd82016-03-16 07:45:41 -0600424 close(fd);
425err_buf:
Simon Glass8e35bb02016-02-22 22:55:51 -0700426 free(buf);
427 return -1;
428}
429
430/**
Simon Glass722ebc82016-02-22 22:55:53 -0700431 * fit_extract_data() - Move all data outside the FIT
432 *
433 * This takes a normal FIT file and removes all the 'data' properties from it.
434 * The data is placed in an area after the FIT so that it can be accessed
435 * using an offset into that area. The 'data' properties turn into
436 * 'data-offset' properties.
437 *
438 * This function cannot cope with FITs with 'data-offset' properties. All
439 * data must be in 'data' properties on entry.
440 */
441static int fit_extract_data(struct image_tool_params *params, const char *fname)
442{
Kever Yangebfe6112020-03-30 11:56:24 +0800443 void *buf = NULL;
Simon Glass722ebc82016-02-22 22:55:53 -0700444 int buf_ptr;
445 int fit_size, new_size;
446 int fd;
447 struct stat sbuf;
448 void *fdt;
449 int ret;
450 int images;
451 int node;
Kever Yangebfe6112020-03-30 11:56:24 +0800452 int image_number;
453 int align_size;
Simon Glass722ebc82016-02-22 22:55:53 -0700454
Tom Rini7946a812020-05-06 11:05:17 -0400455 align_size = params->bl_len ? params->bl_len : 4;
Luca Boccassi7d574852019-05-14 19:35:02 +0100456 fd = mmap_fdt(params->cmdname, fname, 0, &fdt, &sbuf, false, false);
Simon Glass722ebc82016-02-22 22:55:53 -0700457 if (fd < 0)
458 return -EIO;
459 fit_size = fdt_totalsize(fdt);
460
Simon Glass722ebc82016-02-22 22:55:53 -0700461 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
462 if (images < 0) {
463 debug("%s: Cannot find /images node: %d\n", __func__, images);
464 ret = -EINVAL;
Simon Glassb97d71e2016-03-16 07:45:39 -0600465 goto err_munmap;
Simon Glass722ebc82016-02-22 22:55:53 -0700466 }
Kever Yangebfe6112020-03-30 11:56:24 +0800467 image_number = fdtdec_get_child_count(fdt, images);
468
469 /*
470 * Allocate space to hold the image data we will extract,
471 * extral space allocate for image alignment to prevent overflow.
472 */
Fabio Estevamaaa91a42020-07-27 21:03:13 -0300473 buf = calloc(1, fit_size + (align_size * image_number));
Kever Yangebfe6112020-03-30 11:56:24 +0800474 if (!buf) {
475 ret = -ENOMEM;
476 goto err_munmap;
477 }
478 buf_ptr = 0;
Simon Glass722ebc82016-02-22 22:55:53 -0700479
480 for (node = fdt_first_subnode(fdt, images);
481 node >= 0;
482 node = fdt_next_subnode(fdt, node)) {
483 const char *data;
484 int len;
485
Michal Simek4a8b6e02018-07-20 12:31:02 +0200486 data = fdt_getprop(fdt, node, FIT_DATA_PROP, &len);
Simon Glass722ebc82016-02-22 22:55:53 -0700487 if (!data)
488 continue;
489 memcpy(buf + buf_ptr, data, len);
490 debug("Extracting data size %x\n", len);
491
Michal Simek4a8b6e02018-07-20 12:31:02 +0200492 ret = fdt_delprop(fdt, node, FIT_DATA_PROP);
Simon Glass722ebc82016-02-22 22:55:53 -0700493 if (ret) {
494 ret = -EPERM;
Simon Glassb97d71e2016-03-16 07:45:39 -0600495 goto err_munmap;
Simon Glass722ebc82016-02-22 22:55:53 -0700496 }
Teddy Reedf8f91072016-06-09 19:38:02 -0700497 if (params->external_offset > 0) {
498 /* An external offset positions the data absolutely. */
Michal Simek4a8b6e02018-07-20 12:31:02 +0200499 fdt_setprop_u32(fdt, node, FIT_DATA_POSITION_PROP,
Teddy Reedf8f91072016-06-09 19:38:02 -0700500 params->external_offset + buf_ptr);
501 } else {
Michal Simek4a8b6e02018-07-20 12:31:02 +0200502 fdt_setprop_u32(fdt, node, FIT_DATA_OFFSET_PROP,
503 buf_ptr);
Teddy Reedf8f91072016-06-09 19:38:02 -0700504 }
Michal Simek4a8b6e02018-07-20 12:31:02 +0200505 fdt_setprop_u32(fdt, node, FIT_DATA_SIZE_PROP, len);
Kever Yangebfe6112020-03-30 11:56:24 +0800506 buf_ptr += ALIGN(len, align_size);
Simon Glass722ebc82016-02-22 22:55:53 -0700507 }
508
509 /* Pack the FDT and place the data after it */
510 fdt_pack(fdt);
511
Kever Yangebfe6112020-03-30 11:56:24 +0800512 new_size = fdt_totalsize(fdt);
Tom Rini7946a812020-05-06 11:05:17 -0400513 new_size = ALIGN(new_size, align_size);
Kever Yangebfe6112020-03-30 11:56:24 +0800514 fdt_set_totalsize(fdt, new_size);
Simon Glass722ebc82016-02-22 22:55:53 -0700515 debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
516 debug("External data size %x\n", buf_ptr);
Simon Glass722ebc82016-02-22 22:55:53 -0700517 munmap(fdt, sbuf.st_size);
518
519 if (ftruncate(fd, new_size)) {
520 debug("%s: Failed to truncate file: %s\n", __func__,
521 strerror(errno));
522 ret = -EIO;
523 goto err;
524 }
Teddy Reedf8f91072016-06-09 19:38:02 -0700525
526 /* Check if an offset for the external data was set. */
527 if (params->external_offset > 0) {
528 if (params->external_offset < new_size) {
Simon Glass206117a2022-01-09 20:13:38 -0700529 fprintf(stderr,
530 "External offset %x overlaps FIT length %x\n",
531 params->external_offset, new_size);
Teddy Reedf8f91072016-06-09 19:38:02 -0700532 ret = -EINVAL;
533 goto err;
534 }
535 new_size = params->external_offset;
536 }
Simon Glass722ebc82016-02-22 22:55:53 -0700537 if (lseek(fd, new_size, SEEK_SET) < 0) {
538 debug("%s: Failed to seek to end of file: %s\n", __func__,
539 strerror(errno));
540 ret = -EIO;
541 goto err;
542 }
543 if (write(fd, buf, buf_ptr) != buf_ptr) {
544 debug("%s: Failed to write external data to file %s\n",
545 __func__, strerror(errno));
546 ret = -EIO;
547 goto err;
548 }
Tom Rini3c2dff52017-09-26 22:14:44 -0400549 free(buf);
Simon Glassb97d71e2016-03-16 07:45:39 -0600550 close(fd);
551 return 0;
Simon Glass722ebc82016-02-22 22:55:53 -0700552
Simon Glassb97d71e2016-03-16 07:45:39 -0600553err_munmap:
554 munmap(fdt, sbuf.st_size);
Simon Glass722ebc82016-02-22 22:55:53 -0700555err:
Bin Meng0dbd6e32020-04-18 01:59:11 -0700556 free(buf);
Simon Glass722ebc82016-02-22 22:55:53 -0700557 close(fd);
558 return ret;
559}
560
Simon Glass529fd182016-02-22 22:55:54 -0700561static int fit_import_data(struct image_tool_params *params, const char *fname)
562{
563 void *fdt, *old_fdt;
564 int fit_size, new_size, size, data_base;
565 int fd;
566 struct stat sbuf;
567 int ret;
568 int images;
569 int node;
570
Luca Boccassi7d574852019-05-14 19:35:02 +0100571 fd = mmap_fdt(params->cmdname, fname, 0, &old_fdt, &sbuf, false, false);
Simon Glass529fd182016-02-22 22:55:54 -0700572 if (fd < 0)
573 return -EIO;
574 fit_size = fdt_totalsize(old_fdt);
Kever Yang02560b12020-03-30 11:56:22 +0800575 data_base = ALIGN(fit_size, 4);
Simon Glass529fd182016-02-22 22:55:54 -0700576
577 /* Allocate space to hold the new FIT */
578 size = sbuf.st_size + 16384;
Fabio Estevamaaa91a42020-07-27 21:03:13 -0300579 fdt = calloc(1, size);
Simon Glass529fd182016-02-22 22:55:54 -0700580 if (!fdt) {
581 fprintf(stderr, "%s: Failed to allocate memory (%d bytes)\n",
582 __func__, size);
583 ret = -ENOMEM;
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700584 goto err_munmap;
Simon Glass529fd182016-02-22 22:55:54 -0700585 }
586 ret = fdt_open_into(old_fdt, fdt, size);
587 if (ret) {
588 debug("%s: Failed to expand FIT: %s\n", __func__,
589 fdt_strerror(errno));
590 ret = -EINVAL;
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700591 goto err_munmap;
Simon Glass529fd182016-02-22 22:55:54 -0700592 }
593
594 images = fdt_path_offset(fdt, FIT_IMAGES_PATH);
595 if (images < 0) {
596 debug("%s: Cannot find /images node: %d\n", __func__, images);
597 ret = -EINVAL;
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700598 goto err_munmap;
Simon Glass529fd182016-02-22 22:55:54 -0700599 }
600
601 for (node = fdt_first_subnode(fdt, images);
602 node >= 0;
603 node = fdt_next_subnode(fdt, node)) {
604 int buf_ptr;
605 int len;
606
607 buf_ptr = fdtdec_get_int(fdt, node, "data-offset", -1);
608 len = fdtdec_get_int(fdt, node, "data-size", -1);
609 if (buf_ptr == -1 || len == -1)
610 continue;
611 debug("Importing data size %x\n", len);
612
Patrick Oppenlanderc995d852020-07-30 14:31:48 +1000613 ret = fdt_setprop(fdt, node, "data",
614 old_fdt + data_base + buf_ptr, len);
Simon Glass529fd182016-02-22 22:55:54 -0700615 if (ret) {
616 debug("%s: Failed to write property: %s\n", __func__,
617 fdt_strerror(ret));
618 ret = -EINVAL;
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700619 goto err_munmap;
Simon Glass529fd182016-02-22 22:55:54 -0700620 }
621 }
622
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700623 munmap(old_fdt, sbuf.st_size);
624
Tom Rinibf52fcd2017-10-07 11:27:59 -0400625 /* Close the old fd so we can re-use it. */
Simon Glass529fd182016-02-22 22:55:54 -0700626 close(fd);
627
628 /* Pack the FDT and place the data after it */
629 fdt_pack(fdt);
630
631 new_size = fdt_totalsize(fdt);
632 debug("Size expanded from %x to %x\n", fit_size, new_size);
633
634 fd = open(fname, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
635 if (fd < 0) {
636 fprintf(stderr, "%s: Can't open %s: %s\n",
637 params->cmdname, fname, strerror(errno));
Tom Rinibf52fcd2017-10-07 11:27:59 -0400638 ret = -EIO;
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700639 goto err;
Simon Glass529fd182016-02-22 22:55:54 -0700640 }
641 if (write(fd, fdt, new_size) != new_size) {
642 debug("%s: Failed to write external data to file %s\n",
643 __func__, strerror(errno));
644 ret = -EIO;
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700645 goto err;
Simon Glass529fd182016-02-22 22:55:54 -0700646 }
Simon Glass529fd182016-02-22 22:55:54 -0700647
Simon Glass6e0ffce2016-03-16 07:45:38 -0600648 free(fdt);
Lihua Zhao3fc85a72020-04-18 01:59:10 -0700649 close(fd);
650 return 0;
651
652err_munmap:
653 munmap(old_fdt, sbuf.st_size);
654err:
655 free(fdt);
656 close(fd);
Simon Glass529fd182016-02-22 22:55:54 -0700657 return ret;
658}
659
Simon Glass722ebc82016-02-22 22:55:53 -0700660/**
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530661 * fit_handle_file - main FIT file processing function
662 *
663 * fit_handle_file() runs dtc to convert .its to .itb, includes
664 * binary data, updates timestamp property and calculates hashes.
665 *
666 * datafile - .its file
667 * imagefile - .itb file
668 *
669 * returns:
670 * only on success, otherwise calls exit (EXIT_FAILURE);
671 */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700672static int fit_handle_file(struct image_tool_params *params)
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530673{
674 char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
Philippe Reynes7298e422019-12-18 18:25:41 +0100675 char bakfile[MKIMAGE_MAX_TMPFILE_LEN + 4] = {0};
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530676 char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
Simon Glassa9468112014-06-02 22:04:53 -0600677 size_t size_inc;
678 int ret;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530679
680 /* Flattened Image Tree (FIT) format handling */
681 debug ("FIT format handling\n");
682
683 /* call dtc to include binary properties into the tmp file */
684 if (strlen (params->imagefile) +
685 strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
686 fprintf (stderr, "%s: Image file name (%s) too long, "
Sven Roederer9c702372021-05-25 23:15:27 +0200687 "can't create tmpfile.\n",
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530688 params->imagefile, params->cmdname);
689 return (EXIT_FAILURE);
690 }
691 sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
692
Simon Glass95d77b42013-06-13 15:10:05 -0700693 /* We either compile the source file, or use the existing FIT image */
Simon Glass8e35bb02016-02-22 22:55:51 -0700694 if (params->auto_its) {
695 if (fit_build(params, tmpfile)) {
696 fprintf(stderr, "%s: failed to build FIT\n",
697 params->cmdname);
698 return EXIT_FAILURE;
699 }
700 *cmd = '\0';
701 } else if (params->datafile) {
Stefan Theil63f881d2018-03-08 09:00:13 +0100702 /* dtc -I dts -O dtb -p 500 -o tmpfile datafile */
703 snprintf(cmd, sizeof(cmd), "%s %s -o \"%s\" \"%s\"",
704 MKIMAGE_DTC, params->dtc, tmpfile, params->datafile);
Simon Glass95d77b42013-06-13 15:10:05 -0700705 debug("Trying to execute \"%s\"\n", cmd);
706 } else {
Mirza, Taimoora6e98102017-10-04 20:28:03 +0500707 snprintf(cmd, sizeof(cmd), "cp \"%s\" \"%s\"",
Simon Glass95d77b42013-06-13 15:10:05 -0700708 params->imagefile, tmpfile);
709 }
Sven Roedererea5d3732020-04-27 02:08:39 +0200710 if (strlen(cmd) >= MKIMAGE_MAX_DTC_CMDLINE_LEN - 1) {
711 fprintf(stderr, "WARNING: command-line for FIT creation might be truncated and will probably fail.\n");
712 }
Philippe Reynes7298e422019-12-18 18:25:41 +0100713
Simon Glass8e35bb02016-02-22 22:55:51 -0700714 if (*cmd && system(cmd) == -1) {
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530715 fprintf (stderr, "%s: system(%s) failed: %s\n",
716 params->cmdname, cmd, strerror(errno));
Simon Glassaa6d6db2013-05-08 08:05:57 +0000717 goto err_system;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530718 }
719
Simon Glass529fd182016-02-22 22:55:54 -0700720 /* Move the data so it is internal to the FIT, if needed */
721 ret = fit_import_data(params, tmpfile);
722 if (ret)
723 goto err_system;
724
Simon Glassa9468112014-06-02 22:04:53 -0600725 /*
Philippe Reynes7298e422019-12-18 18:25:41 +0100726 * Copy the tmpfile to bakfile, then in the following loop
727 * we copy bakfile to tmpfile. So we always start from the
728 * beginning.
729 */
730 sprintf(bakfile, "%s%s", tmpfile, ".bak");
731 rename(tmpfile, bakfile);
732
733 /*
Simon Glassa9468112014-06-02 22:04:53 -0600734 * Set hashes for images in the blob. Unfortunately we may need more
735 * space in either FDT, so keep trying until we succeed.
736 *
737 * Note: this is pretty inefficient for signing, since we must
738 * calculate the signature every time. It would be better to calculate
739 * all the data and then store it in a separate step. However, this
740 * would be considerably more complex to implement. Generally a few
741 * steps of this loop is enough to sign with several keys.
742 */
743 for (size_inc = 0; size_inc < 64 * 1024; size_inc += 1024) {
Philippe Reynes7298e422019-12-18 18:25:41 +0100744 if (copyfile(bakfile, tmpfile) < 0) {
745 printf("Can't copy %s to %s\n", bakfile, tmpfile);
746 ret = -EIO;
747 break;
748 }
Simon Glassa9468112014-06-02 22:04:53 -0600749 ret = fit_add_file_data(params, size_inc, tmpfile);
750 if (!ret || ret != -ENOSPC)
751 break;
Simon Glasse29495d2013-06-13 15:10:04 -0700752 }
753
Simon Glassa9468112014-06-02 22:04:53 -0600754 if (ret) {
Simon Glass655cc692016-07-03 09:40:43 -0600755 fprintf(stderr, "%s Can't add hashes to FIT blob: %d\n",
756 params->cmdname, ret);
Simon Glassa9468112014-06-02 22:04:53 -0600757 goto err_system;
Simon Glasse29495d2013-06-13 15:10:04 -0700758 }
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530759
Simon Glass722ebc82016-02-22 22:55:53 -0700760 /* Move the data so it is external to the FIT, if requested */
761 if (params->external_data) {
762 ret = fit_extract_data(params, tmpfile);
763 if (ret)
764 goto err_system;
765 }
766
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530767 if (rename (tmpfile, params->imagefile) == -1) {
768 fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
769 params->cmdname, tmpfile, params->imagefile,
770 strerror (errno));
771 unlink (tmpfile);
Philippe Reynes7298e422019-12-18 18:25:41 +0100772 unlink(bakfile);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530773 unlink (params->imagefile);
Simon Glassa9468112014-06-02 22:04:53 -0600774 return EXIT_FAILURE;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530775 }
Philippe Reynes7298e422019-12-18 18:25:41 +0100776 unlink(bakfile);
Simon Glassa9468112014-06-02 22:04:53 -0600777 return EXIT_SUCCESS;
Simon Glassaa6d6db2013-05-08 08:05:57 +0000778
Simon Glassaa6d6db2013-05-08 08:05:57 +0000779err_system:
780 unlink(tmpfile);
Philippe Reynes7298e422019-12-18 18:25:41 +0100781 unlink(bakfile);
Simon Glassaa6d6db2013-05-08 08:05:57 +0000782 return -1;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530783}
784
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200785/**
786 * fit_image_extract - extract a FIT component image
787 * @fit: pointer to the FIT format image header
788 * @image_noffset: offset of the component image node
789 * @file_name: name of the file to store the FIT sub-image
790 *
791 * returns:
792 * zero in case of success or a negative value if fail.
793 */
794static int fit_image_extract(
795 const void *fit,
796 int image_noffset,
797 const char *file_name)
798{
799 const void *file_data;
800 size_t file_size = 0;
Andrew F. Davise5b56282019-09-17 17:09:34 -0400801 int ret;
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200802
Andrew F. Davise5b56282019-09-17 17:09:34 -0400803 /* get the data address and size of component at offset "image_noffset" */
804 ret = fit_image_get_data_and_size(fit, image_noffset, &file_data, &file_size);
805 if (ret) {
806 fprintf(stderr, "Could not get component information\n");
807 return ret;
808 }
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200809
810 /* save the "file_data" into the file specified by "file_name" */
811 return imagetool_save_subimage(file_name, (ulong) file_data, file_size);
812}
813
814/**
815 * fit_extract_contents - retrieve a sub-image component from the FIT image
816 * @ptr: pointer to the FIT format image header
817 * @params: command line parameters
818 *
819 * returns:
820 * zero in case of success or a negative value if fail.
821 */
822static int fit_extract_contents(void *ptr, struct image_tool_params *params)
823{
824 int images_noffset;
825 int noffset;
826 int ndepth;
827 const void *fit = ptr;
828 int count = 0;
829 const char *p;
830
831 /* Indent string is defined in header image.h */
832 p = IMAGE_INDENT_STRING;
833
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200834 /* Find images parent node offset */
835 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
836 if (images_noffset < 0) {
837 printf("Can't find images parent node '%s' (%s)\n",
838 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
839 return -1;
840 }
841
842 /* Avoid any overrun */
843 count = fit_get_subimage_count(fit, images_noffset);
844 if ((params->pflag < 0) || (count <= params->pflag)) {
845 printf("No such component at '%d'\n", params->pflag);
846 return -1;
847 }
848
849 /* Process its subnodes, extract the desired component from image */
850 for (ndepth = 0, count = 0,
851 noffset = fdt_next_node(fit, images_noffset, &ndepth);
852 (noffset >= 0) && (ndepth > 0);
853 noffset = fdt_next_node(fit, noffset, &ndepth)) {
854 if (ndepth == 1) {
855 /*
856 * Direct child node of the images parent node,
857 * i.e. component image node.
858 */
859 if (params->pflag == count) {
860 printf("Extracted:\n%s Image %u (%s)\n", p,
861 count, fit_get_name(fit, noffset, NULL));
862
863 fit_image_print(fit, noffset, p);
864
865 return fit_image_extract(fit, noffset,
866 params->outfile);
867 }
868
869 count++;
870 }
871 }
872
873 return 0;
874}
875
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700876static int fit_check_params(struct image_tool_params *params)
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530877{
Simon Glass8e35bb02016-02-22 22:55:51 -0700878 if (params->auto_its)
879 return 0;
Heinrich Schuchardt58194662019-12-11 13:51:38 +0100880 return ((params->dflag && params->fflag) ||
881 (params->fflag && params->lflag) ||
882 (params->lflag && params->dflag));
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530883}
884
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200885U_BOOT_IMAGE_TYPE(
886 fitimage,
887 "FIT Image support",
888 sizeof(image_header_t),
889 (void *)&header,
890 fit_check_params,
891 fit_verify_header,
892 fit_print_contents,
893 NULL,
Guilherme Maciel Ferreira39931f92015-01-15 02:54:42 -0200894 fit_extract_contents,
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200895 fit_check_image_types,
896 fit_handle_file,
897 NULL /* FIT images use DTB header */
898);