1
2
3
4
5
6
7
8
9
10#include "imagetool.h"
11#include "mkimage.h"
12#include "imximage.h"
13#include <image.h>
14#include <version.h>
15#ifdef __linux__
16#include <sys/ioctl.h>
17#endif
18
19static void copy_file(int, const char *, int);
20
21
22static struct image_tool_params params = {
23 .os = IH_OS_LINUX,
24 .arch = IH_ARCH_PPC,
25 .type = IH_TYPE_KERNEL,
26 .comp = IH_COMP_GZIP,
27 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
28 .imagename = "",
29 .imagename2 = "",
30};
31
32static enum ih_category cur_category;
33
34static int h_compare_category_name(const void *vtype1, const void *vtype2)
35{
36 const int *type1 = vtype1;
37 const int *type2 = vtype2;
38 const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
39 const char *name2 = genimg_get_cat_short_name(cur_category, *type2);
40
41 return strcmp(name1, name2);
42}
43
44static int show_valid_options(enum ih_category category)
45{
46 int *order;
47 int count;
48 int item;
49 int i;
50
51 count = genimg_get_cat_count(category);
52 order = calloc(count, sizeof(*order));
53 if (!order)
54 return -ENOMEM;
55
56
57 for (i = 0, item = 0; i < count; i++, item++) {
58 while (!genimg_cat_has_id(category, item) && i < count) {
59 item++;
60 count--;
61 }
62 order[i] = item;
63 }
64 cur_category = category;
65 qsort(order, count, sizeof(int), h_compare_category_name);
66
67 fprintf(stderr, "\nInvalid %s, supported are:\n",
68 genimg_get_cat_desc(category));
69 for (i = 0; i < count; i++) {
70 item = order[i];
71 fprintf(stderr, "\t%-15s %s\n",
72 genimg_get_cat_short_name(category, item),
73 genimg_get_cat_name(category, item));
74 }
75 fprintf(stderr, "\n");
76 free(order);
77
78 return 0;
79}
80
81static void usage(const char *msg)
82{
83 fprintf(stderr, "Error: %s\n", msg);
84 fprintf(stderr, "Usage: %s -l image\n"
85 " -l ==> list image header information\n",
86 params.cmdname);
87 fprintf(stderr,
88 " %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
89 " -A ==> set architecture to 'arch'\n"
90 " -O ==> set operating system to 'os'\n"
91 " -T ==> set image type to 'type'\n"
92 " -C ==> set compression type 'comp'\n"
93 " -a ==> set load address to 'addr' (hex)\n"
94 " -e ==> set entry point to 'ep' (hex)\n"
95 " -n ==> set image name to 'name'\n"
96 " -d ==> use image data from 'datafile'\n"
97 " -x ==> set XIP (execute in place)\n",
98 params.cmdname);
99 fprintf(stderr,
100 " %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-E] [-B size] [-i <ramdisk.cpio.gz>] fit-image\n"
101 " <dtb> file is used with -f auto, it may occur multiple times.\n",
102 params.cmdname);
103 fprintf(stderr,
104 " -D => set all options for device tree compiler\n"
105 " -f => input filename for FIT source\n"
106 " -i => input filename for ramdisk file\n"
107 " -E => place data outside of the FIT structure\n"
108 " -B => align size in hex for FIT structure and header\n");
109#ifdef CONFIG_FIT_SIGNATURE
110 fprintf(stderr,
111 "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
112 " -k => set directory containing private keys\n"
113 " -K => write public keys to this .dtb file\n"
114 " -G => use this signing key (in lieu of -k)\n"
115 " -c => add comment in signature node\n"
116 " -F => re-sign existing FIT image\n"
117 " -p => place external data at a static position\n"
118 " -r => mark keys used as 'required' in dtb\n"
119 " -N => openssl engine to use for signing\n");
120#else
121 fprintf(stderr,
122 "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
123#endif
124 fprintf(stderr, " %s -V ==> print version information and exit\n",
125 params.cmdname);
126 fprintf(stderr, "Use '-T list' to see a list of available image types\n");
127
128 exit(EXIT_FAILURE);
129}
130
131static int add_content(int type, const char *fname)
132{
133 struct content_info *cont;
134
135 cont = calloc(1, sizeof(*cont));
136 if (!cont)
137 return -1;
138 cont->type = type;
139 cont->fname = fname;
140 if (params.content_tail)
141 params.content_tail->next = cont;
142 else
143 params.content_head = cont;
144 params.content_tail = cont;
145
146 return 0;
147}
148
149#define OPT_STRING "a:A:b:B:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qstT:vVx"
150static void process_args(int argc, char **argv)
151{
152 char *ptr;
153 int type = IH_TYPE_INVALID;
154 char *datafile = NULL;
155 int opt;
156
157 while ((opt = getopt(argc, argv,
158 "a:A:b:B:c:C:d:D:e:Ef:FG:k:i:K:ln:N:p:O:rR:qstT:vVx")) != -1) {
159 switch (opt) {
160 case 'a':
161 params.addr = strtoull(optarg, &ptr, 16);
162 if (*ptr) {
163 fprintf(stderr, "%s: invalid load address %s\n",
164 params.cmdname, optarg);
165 exit(EXIT_FAILURE);
166 }
167 break;
168 case 'A':
169 params.arch = genimg_get_arch_id(optarg);
170 if (params.arch < 0) {
171 show_valid_options(IH_ARCH);
172 usage("Invalid architecture");
173 }
174 break;
175 case 'b':
176 if (add_content(IH_TYPE_FLATDT, optarg)) {
177 fprintf(stderr,
178 "%s: Out of memory adding content '%s'",
179 params.cmdname, optarg);
180 exit(EXIT_FAILURE);
181 }
182 break;
183 case 'B':
184 params.bl_len = strtoull(optarg, &ptr, 16);
185 if (*ptr) {
186 fprintf(stderr, "%s: invalid block length %s\n",
187 params.cmdname, optarg);
188 exit(EXIT_FAILURE);
189 }
190
191 break;
192 case 'c':
193 params.comment = optarg;
194 break;
195 case 'C':
196 params.comp = genimg_get_comp_id(optarg);
197 if (params.comp < 0) {
198 show_valid_options(IH_COMP);
199 usage("Invalid compression type");
200 }
201 break;
202 case 'd':
203 params.datafile = optarg;
204 params.dflag = 1;
205 break;
206 case 'D':
207 params.dtc = optarg;
208 break;
209 case 'e':
210 params.ep = strtoull(optarg, &ptr, 16);
211 if (*ptr) {
212 fprintf(stderr, "%s: invalid entry point %s\n",
213 params.cmdname, optarg);
214 exit(EXIT_FAILURE);
215 }
216 params.eflag = 1;
217 break;
218 case 'E':
219 params.external_data = true;
220 break;
221 case 'f':
222 datafile = optarg;
223 params.auto_its = !strcmp(datafile, "auto");
224
225 case 'F':
226
227
228
229
230 params.type = IH_TYPE_FLATDT;
231 params.fflag = 1;
232 break;
233 case 'G':
234 params.keyfile = optarg;
235 break;
236 case 'i':
237 params.fit_ramdisk = optarg;
238 break;
239 case 'k':
240 params.keydir = optarg;
241 break;
242 case 'K':
243 params.keydest = optarg;
244 break;
245 case 'l':
246 params.lflag = 1;
247 break;
248 case 'n':
249 params.imagename = optarg;
250 break;
251 case 'N':
252 params.engine_id = optarg;
253 break;
254 case 'O':
255 params.os = genimg_get_os_id(optarg);
256 if (params.os < 0) {
257 show_valid_options(IH_OS);
258 usage("Invalid operating system");
259 }
260 break;
261 case 'p':
262 params.external_offset = strtoull(optarg, &ptr, 16);
263 if (*ptr) {
264 fprintf(stderr, "%s: invalid offset size %s\n",
265 params.cmdname, optarg);
266 exit(EXIT_FAILURE);
267 }
268 break;
269 case 'q':
270 params.quiet = 1;
271 break;
272 case 'r':
273 params.require_keys = 1;
274 break;
275 case 'R':
276
277
278
279
280 params.imagename2 = optarg;
281 break;
282 case 's':
283 params.skipcpy = 1;
284 break;
285 case 't':
286 params.reset_timestamp = 1;
287 break;
288 case 'T':
289 if (strcmp(optarg, "list") == 0) {
290 show_valid_options(IH_TYPE);
291 exit(EXIT_SUCCESS);
292 }
293 type = genimg_get_type_id(optarg);
294 if (type < 0) {
295 show_valid_options(IH_TYPE);
296 usage("Invalid image type");
297 }
298 break;
299 case 'v':
300 params.vflag++;
301 break;
302 case 'V':
303 printf("mkimage version %s\n", PLAIN_VERSION);
304 exit(EXIT_SUCCESS);
305 case 'x':
306 params.xflag++;
307 break;
308 default:
309 usage("Invalid option");
310 }
311 }
312
313
314 if (optind < argc)
315 params.imagefile = argv[optind];
316
317
318
319
320
321
322 if (params.type == IH_TYPE_FLATDT) {
323 params.fit_image_type = type ? type : IH_TYPE_KERNEL;
324
325 if (!params.auto_its)
326 params.datafile = datafile;
327 else if (!params.datafile)
328 usage("Missing data file for auto-FIT (use -d)");
329 } else if (type != IH_TYPE_INVALID) {
330 if (type == IH_TYPE_SCRIPT && !params.datafile)
331 usage("Missing data file for script (use -d)");
332 params.type = type;
333 }
334
335 if (!params.imagefile)
336 usage("Missing output filename");
337}
338
339int main(int argc, char **argv)
340{
341 int ifd = -1;
342 struct stat sbuf;
343 char *ptr;
344 int retval = 0;
345 struct image_type_params *tparams = NULL;
346 int pad_len = 0;
347 int dfd;
348 size_t map_len;
349
350 params.cmdname = *argv;
351 params.addr = 0;
352 params.ep = 0;
353
354 process_args(argc, argv);
355
356
357 tparams = imagetool_get_type(params.type);
358 if (tparams == NULL) {
359 fprintf (stderr, "%s: unsupported type %s\n",
360 params.cmdname, genimg_get_type_name(params.type));
361 exit (EXIT_FAILURE);
362 }
363
364
365
366
367
368 if (tparams->check_params)
369 if (tparams->check_params (¶ms))
370 usage("Bad parameters for image type");
371
372 if (!params.eflag) {
373 params.ep = params.addr;
374
375 if (params.xflag)
376 params.ep += tparams->header_size;
377 }
378
379 if (params.fflag){
380 if (tparams->fflag_handle)
381
382
383
384
385
386
387 retval = tparams->fflag_handle(¶ms);
388
389 if (retval != EXIT_SUCCESS)
390 exit (retval);
391 }
392
393 if (params.lflag || params.fflag) {
394 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
395 } else {
396 ifd = open (params.imagefile,
397 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
398 }
399
400 if (ifd < 0) {
401 fprintf (stderr, "%s: Can't open %s: %s\n",
402 params.cmdname, params.imagefile,
403 strerror(errno));
404 exit (EXIT_FAILURE);
405 }
406
407 if (params.lflag || params.fflag) {
408 uint64_t size;
409
410
411
412 if (fstat(ifd, &sbuf) < 0) {
413 fprintf (stderr, "%s: Can't stat %s: %s\n",
414 params.cmdname, params.imagefile,
415 strerror(errno));
416 exit (EXIT_FAILURE);
417 }
418
419 if ((sbuf.st_mode & S_IFMT) == S_IFBLK) {
420#ifdef __linux__
421#if defined(__linux__) && defined(_IOR) && !defined(BLKGETSIZE64)
422#define BLKGETSIZE64 _IOR(0x12,114,size_t)
423#endif
424 if (ioctl(ifd, BLKGETSIZE64, &size) < 0) {
425 fprintf (stderr,
426 "%s: failed to get size of block device \"%s\"\n",
427 params.cmdname, params.imagefile);
428 exit (EXIT_FAILURE);
429 }
430#else
431 fprintf (stderr,
432 "%s: \"%s\" is block device, don't know how to get its size\n",
433 params.cmdname, params.imagefile);
434 exit (EXIT_FAILURE);
435#endif
436 } else if ((unsigned)sbuf.st_size < tparams->header_size) {
437 fprintf (stderr,
438 "%s: Bad size: \"%s\" is not valid image: size %ld < %u\n",
439 params.cmdname, params.imagefile,
440 sbuf.st_size, tparams->header_size);
441 exit (EXIT_FAILURE);
442 } else {
443 size = sbuf.st_size;
444 }
445
446 ptr = mmap(0, size, PROT_READ, MAP_SHARED, ifd, 0);
447 if (ptr == MAP_FAILED) {
448 fprintf (stderr, "%s: Can't read %s: %s\n",
449 params.cmdname, params.imagefile,
450 strerror(errno));
451 exit (EXIT_FAILURE);
452 }
453
454 if (params.fflag) {
455
456
457
458
459 retval = imagetool_verify_print_header_by_type(ptr, &sbuf,
460 tparams, ¶ms);
461 } else {
462
463
464
465
466 retval = imagetool_verify_print_header(ptr, &sbuf,
467 tparams, ¶ms);
468 }
469
470 (void) munmap((void *)ptr, sbuf.st_size);
471 (void) close (ifd);
472
473 exit (retval);
474 }
475
476 if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
477 dfd = open(params.datafile, O_RDONLY | O_BINARY);
478 if (dfd < 0) {
479 fprintf(stderr, "%s: Can't open %s: %s\n",
480 params.cmdname, params.datafile,
481 strerror(errno));
482 exit(EXIT_FAILURE);
483 }
484
485 if (fstat(dfd, &sbuf) < 0) {
486 fprintf(stderr, "%s: Can't stat %s: %s\n",
487 params.cmdname, params.datafile,
488 strerror(errno));
489 exit(EXIT_FAILURE);
490 }
491
492 params.file_size = sbuf.st_size + tparams->header_size;
493 close(dfd);
494 }
495
496
497
498
499
500
501
502 if (tparams->vrec_header)
503 pad_len = tparams->vrec_header(¶ms, tparams);
504 else
505 memset(tparams->hdr, 0, tparams->header_size);
506
507 if (write(ifd, tparams->hdr, tparams->header_size)
508 != tparams->header_size) {
509 fprintf (stderr, "%s: Write error on %s: %s\n",
510 params.cmdname, params.imagefile, strerror(errno));
511 exit (EXIT_FAILURE);
512 }
513
514 if (!params.skipcpy) {
515 if (params.type == IH_TYPE_MULTI ||
516 params.type == IH_TYPE_SCRIPT) {
517 char *file = params.datafile;
518 uint32_t size;
519
520 for (;;) {
521 char *sep = NULL;
522
523 if (file) {
524 if ((sep = strchr(file, ':')) != NULL) {
525 *sep = '\0';
526 }
527
528 if (stat (file, &sbuf) < 0) {
529 fprintf (stderr, "%s: Can't stat %s: %s\n",
530 params.cmdname, file, strerror(errno));
531 exit (EXIT_FAILURE);
532 }
533 size = cpu_to_uimage (sbuf.st_size);
534 } else {
535 size = 0;
536 }
537
538 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
539 fprintf (stderr, "%s: Write error on %s: %s\n",
540 params.cmdname, params.imagefile,
541 strerror(errno));
542 exit (EXIT_FAILURE);
543 }
544
545 if (!file) {
546 break;
547 }
548
549 if (sep) {
550 *sep = ':';
551 file = sep + 1;
552 } else {
553 file = NULL;
554 }
555 }
556
557 file = params.datafile;
558
559 for (;;) {
560 char *sep = strchr(file, ':');
561 if (sep) {
562 *sep = '\0';
563 copy_file (ifd, file, 1);
564 *sep++ = ':';
565 file = sep;
566 } else {
567 copy_file (ifd, file, 0);
568 break;
569 }
570 }
571 } else if (params.type == IH_TYPE_PBLIMAGE) {
572
573 pbl_load_uboot(ifd, ¶ms);
574 } else if (params.type == IH_TYPE_ZYNQMPBIF) {
575
576 int ret;
577
578 ret = zynqmpbif_copy_image(ifd, ¶ms);
579 if (ret)
580 return ret;
581 } else if (params.type == IH_TYPE_IMX8IMAGE) {
582
583 int ret;
584
585 ret = imx8image_copy_image(ifd, ¶ms);
586 if (ret)
587 return ret;
588 } else if (params.type == IH_TYPE_IMX8MIMAGE) {
589
590 int ret;
591
592 ret = imx8mimage_copy_image(ifd, ¶ms);
593 if (ret)
594 return ret;
595 } else if ((params.type == IH_TYPE_RKSD) ||
596 (params.type == IH_TYPE_RKSPI)) {
597
598 int ret;
599
600 ret = rockchip_copy_image(ifd, ¶ms);
601 if (ret)
602 return ret;
603 } else {
604 copy_file(ifd, params.datafile, pad_len);
605 }
606 if (params.type == IH_TYPE_FIRMWARE_IVT) {
607
608 uint32_t aligned_filesize = ALIGN(params.file_size,
609 0x1000);
610 flash_header_v2_t ivt_header = { { 0xd1, 0x2000, 0x40 },
611 params.addr, 0, 0, 0, params.addr
612 + aligned_filesize
613 - tparams->header_size,
614 params.addr + aligned_filesize
615 - tparams->header_size
616 + 0x20, 0 };
617 int i = params.file_size;
618 for (; i < aligned_filesize; i++) {
619 if (write(ifd, (char *) &i, 1) != 1) {
620 fprintf(stderr,
621 "%s: Write error on %s: %s\n",
622 params.cmdname,
623 params.imagefile,
624 strerror(errno));
625 exit(EXIT_FAILURE);
626 }
627 }
628 if (write(ifd, &ivt_header, sizeof(flash_header_v2_t))
629 != sizeof(flash_header_v2_t)) {
630 fprintf(stderr, "%s: Write error on %s: %s\n",
631 params.cmdname,
632 params.imagefile,
633 strerror(errno));
634 exit(EXIT_FAILURE);
635 }
636 }
637 }
638
639
640#if defined(_POSIX_SYNCHRONIZED_IO) && \
641 !defined(__sun__) && \
642 !defined(__FreeBSD__) && \
643 !defined(__OpenBSD__) && \
644 !defined(__APPLE__)
645 (void) fdatasync (ifd);
646#else
647 (void) fsync (ifd);
648#endif
649
650 if (fstat(ifd, &sbuf) < 0) {
651 fprintf (stderr, "%s: Can't stat %s: %s\n",
652 params.cmdname, params.imagefile, strerror(errno));
653 exit (EXIT_FAILURE);
654 }
655 params.file_size = sbuf.st_size;
656
657 map_len = sbuf.st_size;
658 ptr = mmap(0, map_len, PROT_READ | PROT_WRITE, MAP_SHARED, ifd, 0);
659 if (ptr == MAP_FAILED) {
660 fprintf (stderr, "%s: Can't map %s: %s\n",
661 params.cmdname, params.imagefile, strerror(errno));
662 exit (EXIT_FAILURE);
663 }
664
665
666 if (tparams->set_header)
667 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
668 else {
669 fprintf (stderr, "%s: Can't set header for %s: %s\n",
670 params.cmdname, tparams->name, strerror(errno));
671 exit (EXIT_FAILURE);
672 }
673
674
675 if (tparams->print_header)
676 tparams->print_header (ptr);
677 else {
678 fprintf (stderr, "%s: Can't print header for %s\n",
679 params.cmdname, tparams->name);
680 }
681
682 (void)munmap((void *)ptr, map_len);
683
684
685#if defined(_POSIX_SYNCHRONIZED_IO) && \
686 !defined(__sun__) && \
687 !defined(__FreeBSD__) && \
688 !defined(__OpenBSD__) && \
689 !defined(__APPLE__)
690 (void) fdatasync (ifd);
691#else
692 (void) fsync (ifd);
693#endif
694
695 if (close(ifd)) {
696 fprintf (stderr, "%s: Write error on %s: %s\n",
697 params.cmdname, params.imagefile, strerror(errno));
698 exit (EXIT_FAILURE);
699 }
700
701 exit (EXIT_SUCCESS);
702}
703
704static void
705copy_file (int ifd, const char *datafile, int pad)
706{
707 int dfd;
708 struct stat sbuf;
709 unsigned char *ptr;
710 int tail;
711 int zero = 0;
712 uint8_t zeros[4096];
713 int offset = 0;
714 int size, ret;
715 struct image_type_params *tparams = imagetool_get_type(params.type);
716
717 memset(zeros, 0, sizeof(zeros));
718
719 if (params.vflag) {
720 fprintf (stderr, "Adding Image %s\n", datafile);
721 }
722
723 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
724 fprintf (stderr, "%s: Can't open %s: %s\n",
725 params.cmdname, datafile, strerror(errno));
726 exit (EXIT_FAILURE);
727 }
728
729 if (fstat(dfd, &sbuf) < 0) {
730 fprintf (stderr, "%s: Can't stat %s: %s\n",
731 params.cmdname, datafile, strerror(errno));
732 exit (EXIT_FAILURE);
733 }
734
735 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
736 if (ptr == MAP_FAILED) {
737 fprintf (stderr, "%s: Can't read %s: %s\n",
738 params.cmdname, datafile, strerror(errno));
739 exit (EXIT_FAILURE);
740 }
741
742 if (params.xflag) {
743 unsigned char *p = NULL;
744
745
746
747
748
749
750 if ((unsigned)sbuf.st_size < tparams->header_size) {
751 fprintf (stderr,
752 "%s: Bad size: \"%s\" is too small for XIP\n",
753 params.cmdname, datafile);
754 exit (EXIT_FAILURE);
755 }
756
757 for (p = ptr; p < ptr + tparams->header_size; p++) {
758 if ( *p != 0xff ) {
759 fprintf (stderr,
760 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
761 params.cmdname, datafile);
762 exit (EXIT_FAILURE);
763 }
764 }
765
766 offset = tparams->header_size;
767 }
768
769 size = sbuf.st_size - offset;
770
771 ret = write(ifd, ptr + offset, size);
772 if (ret != size) {
773 if (ret < 0)
774 fprintf (stderr, "%s: Write error on %s: %s\n",
775 params.cmdname, params.imagefile, strerror(errno));
776 else if (ret < size)
777 fprintf (stderr, "%s: Write only %d/%d bytes, "\
778 "probably no space left on the device\n",
779 params.cmdname, ret, size);
780 exit (EXIT_FAILURE);
781 }
782
783 tail = size % 4;
784 if ((pad == 1) && (tail != 0)) {
785
786 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
787 fprintf (stderr, "%s: Write error on %s: %s\n",
788 params.cmdname, params.imagefile,
789 strerror(errno));
790 exit (EXIT_FAILURE);
791 }
792 } else if (pad > 1) {
793 while (pad > 0) {
794 int todo = sizeof(zeros);
795
796 if (todo > pad)
797 todo = pad;
798 if (write(ifd, (char *)&zeros, todo) != todo) {
799 fprintf(stderr, "%s: Write error on %s: %s\n",
800 params.cmdname, params.imagefile,
801 strerror(errno));
802 exit(EXIT_FAILURE);
803 }
804 pad -= todo;
805 }
806 }
807
808 (void) munmap((void *)ptr, sbuf.st_size);
809 (void) close (dfd);
810}
811
