]> git.ipfire.org Git - people/ms/u-boot.git/blame - tools/mkimage.c
common: board: Dont relocate FDT incase of CONFIG_OF_EMBED
[people/ms/u-boot.git] / tools / mkimage.c
CommitLineData
5b1d7137 1/*
9d25438f
BS
2 * (C) Copyright 2008 Semihalf
3 *
89a4d6b1 4 * (C) Copyright 2000-2009
5b1d7137
WD
5 * DENX Software Engineering
6 * Wolfgang Denk, wd@denx.de
0c852a28 7 *
1a459660 8 * SPDX-License-Identifier: GPL-2.0+
5b1d7137
WD
9 */
10
b97a2a0a 11#include "mkimage.h"
5b1d7137 12#include <image.h>
976b38c0 13#include <version.h>
89a4d6b1
PW
14
15static void copy_file(int, const char *, int);
16static void usage(void);
17
89a4d6b1 18/* parameters initialized by core will be used by the image type code */
f86ed6a8 19struct image_tool_params params = {
89a4d6b1
PW
20 .os = IH_OS_LINUX,
21 .arch = IH_ARCH_PPC,
22 .type = IH_TYPE_KERNEL,
23 .comp = IH_COMP_GZIP,
24 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
04387d24 25 .imagename = "",
5d898a00 26 .imagename2 = "",
89a4d6b1
PW
27};
28
5b9d44df
SG
29static int h_compare_image_name(const void *vtype1, const void *vtype2)
30{
31 const int *type1 = vtype1;
32 const int *type2 = vtype2;
33 const char *name1 = genimg_get_type_short_name(*type1);
34 const char *name2 = genimg_get_type_short_name(*type2);
35
36 return strcmp(name1, name2);
37}
38
39/* Show all image types supported by mkimage */
40static void show_image_types(void)
41{
42 struct image_type_params *tparams;
43 int order[IH_TYPE_COUNT];
44 int count;
45 int type;
46 int i;
47
48 /* Sort the names in order of short name for easier reading */
49 memset(order, '\0', sizeof(order));
50 for (count = 0, type = 0; type < IH_TYPE_COUNT; type++) {
51 tparams = imagetool_get_type(type);
52 if (tparams)
53 order[count++] = type;
54 }
55 qsort(order, count, sizeof(int), h_compare_image_name);
56
57 fprintf(stderr, "\nInvalid image type. Supported image types:\n");
58 for (i = 0; i < count; i++) {
59 type = order[i];
60 tparams = imagetool_get_type(type);
61 if (tparams) {
62 fprintf(stderr, "\t%-15s %s\n",
63 genimg_get_type_short_name(type),
64 genimg_get_type_name(type));
65 }
66 }
67 fprintf(stderr, "\n");
68}
69
70int main(int argc, char **argv)
5b1d7137 71{
9d25438f 72 int ifd = -1;
5b1d7137 73 struct stat sbuf;
a2513e27 74 char *ptr;
449609f5 75 int retval = 0;
89a4d6b1 76 struct image_type_params *tparams = NULL;
9bac0bb3 77 int pad_len = 0;
92a655c3 78 int dfd;
5b1d7137 79
89a4d6b1
PW
80 params.cmdname = *argv;
81 params.addr = params.ep = 0;
5b1d7137
WD
82
83 while (--argc > 0 && **++argv == '-') {
84 while (*++*argv) {
85 switch (**argv) {
86 case 'l':
89a4d6b1 87 params.lflag = 1;
5b1d7137
WD
88 break;
89 case 'A':
90 if ((--argc <= 0) ||
89a4d6b1
PW
91 (params.arch =
92 genimg_get_arch_id (*++argv)) < 0)
5b1d7137
WD
93 usage ();
94 goto NXTARG;
4f610427
SG
95 case 'c':
96 if (--argc <= 0)
97 usage();
98 params.comment = *++argv;
99 goto NXTARG;
5b1d7137
WD
100 case 'C':
101 if ((--argc <= 0) ||
89a4d6b1
PW
102 (params.comp =
103 genimg_get_comp_id (*++argv)) < 0)
5b1d7137
WD
104 usage ();
105 goto NXTARG;
9d25438f
BS
106 case 'D':
107 if (--argc <= 0)
108 usage ();
89a4d6b1 109 params.dtc = *++argv;
9d25438f
BS
110 goto NXTARG;
111
5b1d7137
WD
112 case 'O':
113 if ((--argc <= 0) ||
89a4d6b1
PW
114 (params.os =
115 genimg_get_os_id (*++argv)) < 0)
5b1d7137
WD
116 usage ();
117 goto NXTARG;
118 case 'T':
5b9d44df
SG
119 params.type = -1;
120 if (--argc >= 0 && argv[1]) {
121 params.type =
122 genimg_get_type_id(*++argv);
123 }
124 if (params.type < 0) {
125 show_image_types();
126 usage();
127 }
5b1d7137 128 goto NXTARG;
5b1d7137
WD
129 case 'a':
130 if (--argc <= 0)
131 usage ();
a2513e27 132 params.addr = strtoul (*++argv, &ptr, 16);
5b1d7137
WD
133 if (*ptr) {
134 fprintf (stderr,
135 "%s: invalid load address %s\n",
89a4d6b1 136 params.cmdname, *argv);
5b1d7137
WD
137 exit (EXIT_FAILURE);
138 }
139 goto NXTARG;
140 case 'd':
141 if (--argc <= 0)
142 usage ();
89a4d6b1
PW
143 params.datafile = *++argv;
144 params.dflag = 1;
5b1d7137
WD
145 goto NXTARG;
146 case 'e':
147 if (--argc <= 0)
148 usage ();
a2513e27 149 params.ep = strtoul (*++argv, &ptr, 16);
5b1d7137
WD
150 if (*ptr) {
151 fprintf (stderr,
152 "%s: invalid entry point %s\n",
89a4d6b1 153 params.cmdname, *argv);
5b1d7137
WD
154 exit (EXIT_FAILURE);
155 }
89a4d6b1 156 params.eflag = 1;
5b1d7137 157 goto NXTARG;
9d25438f
BS
158 case 'f':
159 if (--argc <= 0)
160 usage ();
95d77b44
SG
161 params.datafile = *++argv;
162 /* no break */
163 case 'F':
1a99de2c
PT
164 /*
165 * The flattened image tree (FIT) format
166 * requires a flattened device tree image type
167 */
168 params.type = IH_TYPE_FLATDT;
fbc1c8f6 169 params.fflag = 1;
9d25438f 170 goto NXTARG;
80e4df8a
SG
171 case 'k':
172 if (--argc <= 0)
173 usage();
174 params.keydir = *++argv;
175 goto NXTARG;
e29495d3
SG
176 case 'K':
177 if (--argc <= 0)
178 usage();
179 params.keydest = *++argv;
180 goto NXTARG;
5b1d7137
WD
181 case 'n':
182 if (--argc <= 0)
183 usage ();
89a4d6b1 184 params.imagename = *++argv;
5b1d7137 185 goto NXTARG;
399c744b
SG
186 case 'r':
187 params.require_keys = 1;
188 break;
5d898a00
SX
189 case 'R':
190 if (--argc <= 0)
191 usage();
192 /*
193 * This entry is for the second configuration
194 * file, if only one is not enough.
195 */
196 params.imagename2 = *++argv;
197 goto NXTARG;
f0662105
SB
198 case 's':
199 params.skipcpy = 1;
200 break;
5b1d7137 201 case 'v':
89a4d6b1 202 params.vflag++;
5b1d7137 203 break;
976b38c0
WD
204 case 'V':
205 printf("mkimage version %s\n", PLAIN_VERSION);
206 exit(EXIT_SUCCESS);
5b1d7137 207 case 'x':
89a4d6b1 208 params.xflag++;
5b1d7137
WD
209 break;
210 default:
211 usage ();
212 }
213 }
214NXTARG: ;
215 }
216
89a4d6b1
PW
217 if (argc != 1)
218 usage ();
219
220 /* set tparams as per input type_id */
a93648d1 221 tparams = imagetool_get_type(params.type);
89a4d6b1
PW
222 if (tparams == NULL) {
223 fprintf (stderr, "%s: unsupported type %s\n",
224 params.cmdname, genimg_get_type_name(params.type));
225 exit (EXIT_FAILURE);
226 }
5b1d7137 227
89a4d6b1
PW
228 /*
229 * check the passed arguments parameters meets the requirements
230 * as per image type to be generated/listed
231 */
232 if (tparams->check_params)
233 if (tparams->check_params (&params))
234 usage ();
235
236 if (!params.eflag) {
237 params.ep = params.addr;
5b1d7137 238 /* If XIP, entry point must be after the U-Boot header */
89a4d6b1
PW
239 if (params.xflag)
240 params.ep += tparams->header_size;
5b1d7137
WD
241 }
242
89a4d6b1 243 params.imagefile = *argv;
5b1d7137 244
c81296c1
PT
245 if (params.fflag){
246 if (tparams->fflag_handle)
247 /*
248 * in some cases, some additional processing needs
249 * to be done if fflag is defined
250 *
251 * For ex. fit_handle_file for Fit file support
252 */
253 retval = tparams->fflag_handle(&params);
5b1d7137 254
c81296c1
PT
255 if (retval != EXIT_SUCCESS)
256 exit (retval);
257 }
258
259 if (params.lflag || params.fflag) {
260 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
261 } else {
262 ifd = open (params.imagefile,
263 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
264 }
265
266 if (ifd < 0) {
267 fprintf (stderr, "%s: Can't open %s: %s\n",
268 params.cmdname, params.imagefile,
269 strerror(errno));
270 exit (EXIT_FAILURE);
5b1d7137
WD
271 }
272
c81296c1 273 if (params.lflag || params.fflag) {
5b1d7137
WD
274 /*
275 * list header information of existing image
276 */
277 if (fstat(ifd, &sbuf) < 0) {
278 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1
PW
279 params.cmdname, params.imagefile,
280 strerror(errno));
5b1d7137
WD
281 exit (EXIT_FAILURE);
282 }
283
89a4d6b1 284 if ((unsigned)sbuf.st_size < tparams->header_size) {
5b1d7137 285 fprintf (stderr,
89a4d6b1
PW
286 "%s: Bad size: \"%s\" is not valid image\n",
287 params.cmdname, params.imagefile);
5b1d7137
WD
288 exit (EXIT_FAILURE);
289 }
290
fa956fde
MF
291 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
292 if (ptr == MAP_FAILED) {
5b1d7137 293 fprintf (stderr, "%s: Can't read %s: %s\n",
89a4d6b1
PW
294 params.cmdname, params.imagefile,
295 strerror(errno));
5b1d7137
WD
296 exit (EXIT_FAILURE);
297 }
298
89a4d6b1
PW
299 /*
300 * scan through mkimage registry for all supported image types
301 * and verify the input image file header for match
302 * Print the image information for matched image type
303 * Returns the error code if not matched
304 */
0ca6691c
GMF
305 retval = imagetool_verify_print_header(ptr, &sbuf,
306 tparams, &params);
5b1d7137 307
5b1d7137
WD
308 (void) munmap((void *)ptr, sbuf.st_size);
309 (void) close (ifd);
310
f7644c0b 311 exit (retval);
5b1d7137
WD
312 }
313
92a655c3
SG
314 dfd = open(params.datafile, O_RDONLY | O_BINARY);
315 if (dfd < 0) {
316 fprintf(stderr, "%s: Can't open %s: %s\n",
317 params.cmdname, params.datafile, strerror(errno));
318 exit(EXIT_FAILURE);
319 }
320
321 if (fstat(dfd, &sbuf) < 0) {
322 fprintf(stderr, "%s: Can't stat %s: %s\n",
323 params.cmdname, params.datafile, strerror(errno));
324 exit(EXIT_FAILURE);
325 }
326
327 params.file_size = sbuf.st_size + tparams->header_size;
328 close(dfd);
329
5b1d7137 330 /*
f0662105
SB
331 * In case there an header with a variable
332 * length will be added, the corresponding
333 * function is called. This is responsible to
334 * allocate memory for the header itself.
5b1d7137 335 */
f0662105 336 if (tparams->vrec_header)
9bac0bb3 337 pad_len = tparams->vrec_header(&params, tparams);
f0662105
SB
338 else
339 memset(tparams->hdr, 0, tparams->header_size);
5b1d7137 340
89a4d6b1
PW
341 if (write(ifd, tparams->hdr, tparams->header_size)
342 != tparams->header_size) {
5b1d7137 343 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 344 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
345 exit (EXIT_FAILURE);
346 }
347
d1be8f92
CR
348 if (!params.skipcpy) {
349 if (params.type == IH_TYPE_MULTI ||
350 params.type == IH_TYPE_SCRIPT) {
351 char *file = params.datafile;
352 uint32_t size;
353
354 for (;;) {
355 char *sep = NULL;
356
357 if (file) {
358 if ((sep = strchr(file, ':')) != NULL) {
359 *sep = '\0';
360 }
361
362 if (stat (file, &sbuf) < 0) {
363 fprintf (stderr, "%s: Can't stat %s: %s\n",
364 params.cmdname, file, strerror(errno));
365 exit (EXIT_FAILURE);
366 }
367 size = cpu_to_uimage (sbuf.st_size);
368 } else {
369 size = 0;
5b1d7137
WD
370 }
371
d1be8f92
CR
372 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
373 fprintf (stderr, "%s: Write error on %s: %s\n",
374 params.cmdname, params.imagefile,
375 strerror(errno));
5b1d7137
WD
376 exit (EXIT_FAILURE);
377 }
5b1d7137 378
d1be8f92
CR
379 if (!file) {
380 break;
381 }
5b1d7137 382
d1be8f92
CR
383 if (sep) {
384 *sep = ':';
385 file = sep + 1;
386 } else {
387 file = NULL;
388 }
5b1d7137
WD
389 }
390
d1be8f92 391 file = params.datafile;
5b1d7137 392
d1be8f92
CR
393 for (;;) {
394 char *sep = strchr(file, ':');
395 if (sep) {
396 *sep = '\0';
397 copy_file (ifd, file, 1);
398 *sep++ = ':';
399 file = sep;
400 } else {
401 copy_file (ifd, file, 0);
402 break;
403 }
5b1d7137 404 }
5d898a00
SX
405 } else if (params.type == IH_TYPE_PBLIMAGE) {
406 /* PBL has special Image format, implements its' own */
407 pbl_load_uboot(ifd, &params);
d1be8f92 408 } else {
9bac0bb3 409 copy_file(ifd, params.datafile, pad_len);
5b1d7137 410 }
5b1d7137
WD
411 }
412
413 /* We're a bit of paranoid */
89a4d6b1
PW
414#if defined(_POSIX_SYNCHRONIZED_IO) && \
415 !defined(__sun__) && \
416 !defined(__FreeBSD__) && \
31cbe80c 417 !defined(__OpenBSD__) && \
89a4d6b1 418 !defined(__APPLE__)
5b1d7137
WD
419 (void) fdatasync (ifd);
420#else
421 (void) fsync (ifd);
422#endif
423
424 if (fstat(ifd, &sbuf) < 0) {
425 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1 426 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
427 exit (EXIT_FAILURE);
428 }
92a655c3 429 params.file_size = sbuf.st_size;
5b1d7137 430
fa956fde
MF
431 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
432 if (ptr == MAP_FAILED) {
5b1d7137 433 fprintf (stderr, "%s: Can't map %s: %s\n",
89a4d6b1 434 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
435 exit (EXIT_FAILURE);
436 }
437
89a4d6b1
PW
438 /* Setup the image header as per input image type*/
439 if (tparams->set_header)
440 tparams->set_header (ptr, &sbuf, ifd, &params);
441 else {
442 fprintf (stderr, "%s: Can't set header for %s: %s\n",
443 params.cmdname, tparams->name, strerror(errno));
444 exit (EXIT_FAILURE);
445 }
5b1d7137 446
89a4d6b1
PW
447 /* Print the image information by processing image header */
448 if (tparams->print_header)
449 tparams->print_header (ptr);
450 else {
451 fprintf (stderr, "%s: Can't print header for %s: %s\n",
452 params.cmdname, tparams->name, strerror(errno));
453 exit (EXIT_FAILURE);
454 }
5b1d7137
WD
455
456 (void) munmap((void *)ptr, sbuf.st_size);
457
458 /* We're a bit of paranoid */
89a4d6b1
PW
459#if defined(_POSIX_SYNCHRONIZED_IO) && \
460 !defined(__sun__) && \
461 !defined(__FreeBSD__) && \
31cbe80c 462 !defined(__OpenBSD__) && \
89a4d6b1 463 !defined(__APPLE__)
5b1d7137
WD
464 (void) fdatasync (ifd);
465#else
466 (void) fsync (ifd);
467#endif
468
469 if (close(ifd)) {
470 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 471 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
472 exit (EXIT_FAILURE);
473 }
474
475 exit (EXIT_SUCCESS);
476}
477
478static void
479copy_file (int ifd, const char *datafile, int pad)
480{
481 int dfd;
482 struct stat sbuf;
483 unsigned char *ptr;
484 int tail;
485 int zero = 0;
9bac0bb3 486 uint8_t zeros[4096];
5b1d7137
WD
487 int offset = 0;
488 int size;
a93648d1 489 struct image_type_params *tparams = imagetool_get_type(params.type);
5b1d7137 490
9bac0bb3
SB
491 memset(zeros, 0, sizeof(zeros));
492
89a4d6b1 493 if (params.vflag) {
5b1d7137
WD
494 fprintf (stderr, "Adding Image %s\n", datafile);
495 }
496
ef1464cc 497 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
5b1d7137 498 fprintf (stderr, "%s: Can't open %s: %s\n",
89a4d6b1 499 params.cmdname, datafile, strerror(errno));
5b1d7137
WD
500 exit (EXIT_FAILURE);
501 }
502
503 if (fstat(dfd, &sbuf) < 0) {
504 fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1 505 params.cmdname, datafile, strerror(errno));
5b1d7137
WD
506 exit (EXIT_FAILURE);
507 }
508
fa956fde
MF
509 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
510 if (ptr == MAP_FAILED) {
5b1d7137 511 fprintf (stderr, "%s: Can't read %s: %s\n",
89a4d6b1 512 params.cmdname, datafile, strerror(errno));
5b1d7137
WD
513 exit (EXIT_FAILURE);
514 }
515
89a4d6b1 516 if (params.xflag) {
5b1d7137
WD
517 unsigned char *p = NULL;
518 /*
519 * XIP: do not append the image_header_t at the
520 * beginning of the file, but consume the space
521 * reserved for it.
522 */
523
89a4d6b1 524 if ((unsigned)sbuf.st_size < tparams->header_size) {
5b1d7137
WD
525 fprintf (stderr,
526 "%s: Bad size: \"%s\" is too small for XIP\n",
89a4d6b1 527 params.cmdname, datafile);
5b1d7137
WD
528 exit (EXIT_FAILURE);
529 }
530
89a4d6b1 531 for (p = ptr; p < ptr + tparams->header_size; p++) {
5b1d7137
WD
532 if ( *p != 0xff ) {
533 fprintf (stderr,
534 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
89a4d6b1 535 params.cmdname, datafile);
5b1d7137
WD
536 exit (EXIT_FAILURE);
537 }
538 }
539
89a4d6b1 540 offset = tparams->header_size;
5b1d7137
WD
541 }
542
543 size = sbuf.st_size - offset;
544 if (write(ifd, ptr + offset, size) != size) {
545 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 546 params.cmdname, params.imagefile, strerror(errno));
5b1d7137
WD
547 exit (EXIT_FAILURE);
548 }
549
9bac0bb3
SB
550 tail = size % 4;
551 if ((pad == 1) && (tail != 0)) {
5b1d7137
WD
552
553 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
554 fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1
PW
555 params.cmdname, params.imagefile,
556 strerror(errno));
5b1d7137
WD
557 exit (EXIT_FAILURE);
558 }
9bac0bb3 559 } else if (pad > 1) {
424b86ae
SG
560 while (pad > 0) {
561 int todo = sizeof(zeros);
562
563 if (todo > pad)
564 todo = pad;
565 if (write(ifd, (char *)&zeros, todo) != todo) {
566 fprintf(stderr, "%s: Write error on %s: %s\n",
567 params.cmdname, params.imagefile,
568 strerror(errno));
569 exit(EXIT_FAILURE);
570 }
571 pad -= todo;
9bac0bb3 572 }
5b1d7137
WD
573 }
574
575 (void) munmap((void *)ptr, sbuf.st_size);
576 (void) close (dfd);
577}
578
f1cc458c 579static void usage(void)
5b1d7137
WD
580{
581 fprintf (stderr, "Usage: %s -l image\n"
9d25438f 582 " -l ==> list image header information\n",
89a4d6b1 583 params.cmdname);
9d25438f
BS
584 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
585 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
586 " -A ==> set architecture to 'arch'\n"
5b1d7137
WD
587 " -O ==> set operating system to 'os'\n"
588 " -T ==> set image type to 'type'\n"
589 " -C ==> set compression type 'comp'\n"
590 " -a ==> set load address to 'addr' (hex)\n"
591 " -e ==> set entry point to 'ep' (hex)\n"
592 " -n ==> set image name to 'name'\n"
593 " -d ==> use image data from 'datafile'\n"
9d25438f 594 " -x ==> set XIP (execute in place)\n",
89a4d6b1 595 params.cmdname);
95d77b44 596 fprintf(stderr, " %s [-D dtc_options] [-f fit-image.its|-F] fit-image\n",
89a4d6b1 597 params.cmdname);
35497307 598 fprintf(stderr, " -D => set all options for device tree compiler\n"
80e4df8a
SG
599 " -f => input filename for FIT source\n");
600#ifdef CONFIG_FIT_SIGNATURE
399c744b 601 fprintf(stderr, "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-r]\n"
e29495d3 602 " -k => set directory containing private keys\n"
95d77b44 603 " -K => write public keys to this .dtb file\n"
4f610427 604 " -c => add comment in signature node\n"
399c744b
SG
605 " -F => re-sign existing FIT image\n"
606 " -r => mark keys used as 'required' in dtb\n");
80e4df8a
SG
607#else
608 fprintf(stderr, "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
609#endif
976b38c0
WD
610 fprintf (stderr, " %s -V ==> print version information and exit\n",
611 params.cmdname);
5b9d44df 612 fprintf(stderr, "Use -T to see a list of available image types\n");
9d25438f 613
5b1d7137
WD
614 exit (EXIT_FAILURE);
615}