]> git.sur5r.net Git - u-boot/blob - tools/mkimage.c
mkimage: fix display of image types list
[u-boot] / tools / mkimage.c
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2009
5  * DENX Software Engineering
6  * Wolfgang Denk, wd@denx.de
7  *
8  * SPDX-License-Identifier:     GPL-2.0+
9  */
10
11 #include "mkimage.h"
12 #include "imximage.h"
13 #include <image.h>
14 #include <version.h>
15
16 static void copy_file(int, const char *, int);
17
18 /* parameters initialized by core will be used by the image type code */
19 static struct image_tool_params params = {
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,
25         .imagename = "",
26         .imagename2 = "",
27 };
28
29 static enum ih_category cur_category;
30
31 static int h_compare_category_name(const void *vtype1, const void *vtype2)
32 {
33         const int *type1 = vtype1;
34         const int *type2 = vtype2;
35         const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
36         const char *name2 = genimg_get_cat_short_name(cur_category, *type2);
37
38         return strcmp(name1, name2);
39 }
40
41 static int show_valid_options(enum ih_category category)
42 {
43         int *order;
44         int count;
45         int item;
46         int i;
47
48         count = genimg_get_cat_count(category);
49         order = calloc(count, sizeof(*order));
50         if (!order)
51                 return -ENOMEM;
52
53         /* Sort the names in order of short name for easier reading */
54         for (item = 0; item < count; item++)
55                 order[item] = item;
56         cur_category = category;
57         qsort(order, count, sizeof(int), h_compare_category_name);
58
59         fprintf(stderr, "\nInvalid %s, supported are:\n",
60                 genimg_get_cat_desc(category));
61         for (i = 0; i < count; i++) {
62                 item = order[i];
63                 fprintf(stderr, "\t%-15s  %s\n",
64                         genimg_get_cat_short_name(category, item),
65                         genimg_get_cat_name(category, item));
66         }
67         fprintf(stderr, "\n");
68         free(order);
69
70         return 0;
71 }
72
73 static void usage(const char *msg)
74 {
75         fprintf(stderr, "Error: %s\n", msg);
76         fprintf(stderr, "Usage: %s -l image\n"
77                          "          -l ==> list image header information\n",
78                 params.cmdname);
79         fprintf(stderr,
80                 "       %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
81                 "          -A ==> set architecture to 'arch'\n"
82                 "          -O ==> set operating system to 'os'\n"
83                 "          -T ==> set image type to 'type'\n"
84                 "          -C ==> set compression type 'comp'\n"
85                 "          -a ==> set load address to 'addr' (hex)\n"
86                 "          -e ==> set entry point to 'ep' (hex)\n"
87                 "          -n ==> set image name to 'name'\n"
88                 "          -d ==> use image data from 'datafile'\n"
89                 "          -x ==> set XIP (execute in place)\n",
90                 params.cmdname);
91         fprintf(stderr,
92                 "       %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-i <ramdisk.cpio.gz>] fit-image\n"
93                 "           <dtb> file is used with -f auto, it may occur multiple times.\n",
94                 params.cmdname);
95         fprintf(stderr,
96                 "          -D => set all options for device tree compiler\n"
97                 "          -f => input filename for FIT source\n"
98                 "          -i => input filename for ramdisk file\n");
99 #ifdef CONFIG_FIT_SIGNATURE
100         fprintf(stderr,
101                 "Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
102                 "          -E => place data outside of the FIT structure\n"
103                 "          -k => set directory containing private keys\n"
104                 "          -K => write public keys to this .dtb file\n"
105                 "          -c => add comment in signature node\n"
106                 "          -F => re-sign existing FIT image\n"
107                 "          -p => place external data at a static position\n"
108                 "          -r => mark keys used as 'required' in dtb\n"
109                 "          -N => engine to use for signing (pkcs11)\n");
110 #else
111         fprintf(stderr,
112                 "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
113 #endif
114         fprintf(stderr, "       %s -V ==> print version information and exit\n",
115                 params.cmdname);
116         fprintf(stderr, "Use '-T list' to see a list of available image types\n");
117
118         exit(EXIT_FAILURE);
119 }
120
121 static int add_content(int type, const char *fname)
122 {
123         struct content_info *cont;
124
125         cont = calloc(1, sizeof(*cont));
126         if (!cont)
127                 return -1;
128         cont->type = type;
129         cont->fname = fname;
130         if (params.content_tail)
131                 params.content_tail->next = cont;
132         else
133                 params.content_head = cont;
134         params.content_tail = cont;
135
136         return 0;
137 }
138
139 static void process_args(int argc, char **argv)
140 {
141         char *ptr;
142         int type = IH_TYPE_INVALID;
143         char *datafile = NULL;
144         int opt;
145
146         while ((opt = getopt(argc, argv,
147                              "a:A:b:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
148                 switch (opt) {
149                 case 'a':
150                         params.addr = strtoull(optarg, &ptr, 16);
151                         if (*ptr) {
152                                 fprintf(stderr, "%s: invalid load address %s\n",
153                                         params.cmdname, optarg);
154                                 exit(EXIT_FAILURE);
155                         }
156                         break;
157                 case 'A':
158                         params.arch = genimg_get_arch_id(optarg);
159                         if (params.arch < 0) {
160                                 show_valid_options(IH_ARCH);
161                                 usage("Invalid architecture");
162                         }
163                         break;
164                 case 'b':
165                         if (add_content(IH_TYPE_FLATDT, optarg)) {
166                                 fprintf(stderr,
167                                         "%s: Out of memory adding content '%s'",
168                                         params.cmdname, optarg);
169                                 exit(EXIT_FAILURE);
170                         }
171                         break;
172                 case 'c':
173                         params.comment = optarg;
174                         break;
175                 case 'C':
176                         params.comp = genimg_get_comp_id(optarg);
177                         if (params.comp < 0) {
178                                 show_valid_options(IH_COMP);
179                                 usage("Invalid compression type");
180                         }
181                         break;
182                 case 'd':
183                         params.datafile = optarg;
184                         params.dflag = 1;
185                         break;
186                 case 'D':
187                         params.dtc = optarg;
188                         break;
189                 case 'e':
190                         params.ep = strtoull(optarg, &ptr, 16);
191                         if (*ptr) {
192                                 fprintf(stderr, "%s: invalid entry point %s\n",
193                                         params.cmdname, optarg);
194                                 exit(EXIT_FAILURE);
195                         }
196                         params.eflag = 1;
197                         break;
198                 case 'E':
199                         params.external_data = true;
200                         break;
201                 case 'f':
202                         datafile = optarg;
203                         params.auto_its = !strcmp(datafile, "auto");
204                         /* no break */
205                 case 'F':
206                         /*
207                          * The flattened image tree (FIT) format
208                          * requires a flattened device tree image type
209                          */
210                         params.type = IH_TYPE_FLATDT;
211                         params.fflag = 1;
212                         break;
213                 case 'i':
214                         params.fit_ramdisk = optarg;
215                         break;
216                 case 'k':
217                         params.keydir = optarg;
218                         break;
219                 case 'K':
220                         params.keydest = optarg;
221                         break;
222                 case 'l':
223                         params.lflag = 1;
224                         break;
225                 case 'n':
226                         params.imagename = optarg;
227                         break;
228                 case 'N':
229                         params.engine_id = optarg;
230                         break;
231                 case 'O':
232                         params.os = genimg_get_os_id(optarg);
233                         if (params.os < 0) {
234                                 show_valid_options(IH_OS);
235                                 usage("Invalid operating system");
236                         }
237                         break;
238                 case 'p':
239                         params.external_offset = strtoull(optarg, &ptr, 16);
240                         if (*ptr) {
241                                 fprintf(stderr, "%s: invalid offset size %s\n",
242                                         params.cmdname, optarg);
243                                 exit(EXIT_FAILURE);
244                         }
245                         break;
246                 case 'q':
247                         params.quiet = 1;
248                         break;
249                 case 'r':
250                         params.require_keys = 1;
251                         break;
252                 case 'R':
253                         /*
254                          * This entry is for the second configuration
255                          * file, if only one is not enough.
256                          */
257                         params.imagename2 = optarg;
258                         break;
259                 case 's':
260                         params.skipcpy = 1;
261                         break;
262                 case 'T':
263                         if (strcmp(optarg, "list") == 0) {
264                                 show_valid_options(IH_TYPE);
265                                 exit(EXIT_SUCCESS);
266                         }
267                         type = genimg_get_type_id(optarg);
268                         if (type < 0) {
269                                 show_valid_options(IH_TYPE);
270                                 usage("Invalid image type");
271                         }
272                         break;
273                 case 'v':
274                         params.vflag++;
275                         break;
276                 case 'V':
277                         printf("mkimage version %s\n", PLAIN_VERSION);
278                         exit(EXIT_SUCCESS);
279                 case 'x':
280                         params.xflag++;
281                         break;
282                 default:
283                         usage("Invalid option");
284                 }
285         }
286
287         /* The last parameter is expected to be the imagefile */
288         if (optind < argc)
289                 params.imagefile = argv[optind];
290
291         /*
292          * For auto-generated FIT images we need to know the image type to put
293          * in the FIT, which is separate from the file's image type (which
294          * will always be IH_TYPE_FLATDT in this case).
295          */
296         if (params.type == IH_TYPE_FLATDT) {
297                 params.fit_image_type = type ? type : IH_TYPE_KERNEL;
298                 /* For auto_its, datafile is always 'auto' */
299                 if (!params.auto_its)
300                         params.datafile = datafile;
301                 else if (!params.datafile)
302                         usage("Missing data file for auto-FIT (use -d)");
303         } else if (type != IH_TYPE_INVALID) {
304                 params.type = type;
305         }
306
307         if (!params.imagefile)
308                 usage("Missing output filename");
309 }
310
311 int main(int argc, char **argv)
312 {
313         int ifd = -1;
314         struct stat sbuf;
315         char *ptr;
316         int retval = 0;
317         struct image_type_params *tparams = NULL;
318         int pad_len = 0;
319         int dfd;
320
321         params.cmdname = *argv;
322         params.addr = 0;
323         params.ep = 0;
324
325         process_args(argc, argv);
326
327         /* set tparams as per input type_id */
328         tparams = imagetool_get_type(params.type);
329         if (tparams == NULL) {
330                 fprintf (stderr, "%s: unsupported type %s\n",
331                         params.cmdname, genimg_get_type_name(params.type));
332                 exit (EXIT_FAILURE);
333         }
334
335         /*
336          * check the passed arguments parameters meets the requirements
337          * as per image type to be generated/listed
338          */
339         if (tparams->check_params)
340                 if (tparams->check_params (&params))
341                         usage("Bad parameters for image type");
342
343         if (!params.eflag) {
344                 params.ep = params.addr;
345                 /* If XIP, entry point must be after the U-Boot header */
346                 if (params.xflag)
347                         params.ep += tparams->header_size;
348         }
349
350         if (params.fflag){
351                 if (tparams->fflag_handle)
352                         /*
353                          * in some cases, some additional processing needs
354                          * to be done if fflag is defined
355                          *
356                          * For ex. fit_handle_file for Fit file support
357                          */
358                         retval = tparams->fflag_handle(&params);
359
360                 if (retval != EXIT_SUCCESS)
361                         exit (retval);
362         }
363
364         if (params.lflag || params.fflag) {
365                 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
366         } else {
367                 ifd = open (params.imagefile,
368                         O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
369         }
370
371         if (ifd < 0) {
372                 fprintf (stderr, "%s: Can't open %s: %s\n",
373                         params.cmdname, params.imagefile,
374                         strerror(errno));
375                 exit (EXIT_FAILURE);
376         }
377
378         if (params.lflag || params.fflag) {
379                 /*
380                  * list header information of existing image
381                  */
382                 if (fstat(ifd, &sbuf) < 0) {
383                         fprintf (stderr, "%s: Can't stat %s: %s\n",
384                                 params.cmdname, params.imagefile,
385                                 strerror(errno));
386                         exit (EXIT_FAILURE);
387                 }
388
389                 if ((unsigned)sbuf.st_size < tparams->header_size) {
390                         fprintf (stderr,
391                                 "%s: Bad size: \"%s\" is not valid image\n",
392                                 params.cmdname, params.imagefile);
393                         exit (EXIT_FAILURE);
394                 }
395
396                 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
397                 if (ptr == MAP_FAILED) {
398                         fprintf (stderr, "%s: Can't read %s: %s\n",
399                                 params.cmdname, params.imagefile,
400                                 strerror(errno));
401                         exit (EXIT_FAILURE);
402                 }
403
404                 /*
405                  * scan through mkimage registry for all supported image types
406                  * and verify the input image file header for match
407                  * Print the image information for matched image type
408                  * Returns the error code if not matched
409                  */
410                 retval = imagetool_verify_print_header(ptr, &sbuf,
411                                 tparams, &params);
412
413                 (void) munmap((void *)ptr, sbuf.st_size);
414                 (void) close (ifd);
415
416                 exit (retval);
417         }
418
419         if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
420                 dfd = open(params.datafile, O_RDONLY | O_BINARY);
421                 if (dfd < 0) {
422                         fprintf(stderr, "%s: Can't open %s: %s\n",
423                                 params.cmdname, params.datafile,
424                                 strerror(errno));
425                         exit(EXIT_FAILURE);
426                 }
427
428                 if (fstat(dfd, &sbuf) < 0) {
429                         fprintf(stderr, "%s: Can't stat %s: %s\n",
430                                 params.cmdname, params.datafile,
431                                 strerror(errno));
432                         exit(EXIT_FAILURE);
433                 }
434
435                 params.file_size = sbuf.st_size + tparams->header_size;
436                 close(dfd);
437         }
438
439         /*
440          * In case there an header with a variable
441          * length will be added, the corresponding
442          * function is called. This is responsible to
443          * allocate memory for the header itself.
444          */
445         if (tparams->vrec_header)
446                 pad_len = tparams->vrec_header(&params, tparams);
447         else
448                 memset(tparams->hdr, 0, tparams->header_size);
449
450         if (write(ifd, tparams->hdr, tparams->header_size)
451                                         != tparams->header_size) {
452                 fprintf (stderr, "%s: Write error on %s: %s\n",
453                         params.cmdname, params.imagefile, strerror(errno));
454                 exit (EXIT_FAILURE);
455         }
456
457         if (!params.skipcpy) {
458                 if (params.type == IH_TYPE_MULTI ||
459                     params.type == IH_TYPE_SCRIPT) {
460                         char *file = params.datafile;
461                         uint32_t size;
462
463                         for (;;) {
464                                 char *sep = NULL;
465
466                                 if (file) {
467                                         if ((sep = strchr(file, ':')) != NULL) {
468                                                 *sep = '\0';
469                                         }
470
471                                         if (stat (file, &sbuf) < 0) {
472                                                 fprintf (stderr, "%s: Can't stat %s: %s\n",
473                                                          params.cmdname, file, strerror(errno));
474                                                 exit (EXIT_FAILURE);
475                                         }
476                                         size = cpu_to_uimage (sbuf.st_size);
477                                 } else {
478                                         size = 0;
479                                 }
480
481                                 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
482                                         fprintf (stderr, "%s: Write error on %s: %s\n",
483                                                  params.cmdname, params.imagefile,
484                                                  strerror(errno));
485                                         exit (EXIT_FAILURE);
486                                 }
487
488                                 if (!file) {
489                                         break;
490                                 }
491
492                                 if (sep) {
493                                         *sep = ':';
494                                         file = sep + 1;
495                                 } else {
496                                         file = NULL;
497                                 }
498                         }
499
500                         file = params.datafile;
501
502                         for (;;) {
503                                 char *sep = strchr(file, ':');
504                                 if (sep) {
505                                         *sep = '\0';
506                                         copy_file (ifd, file, 1);
507                                         *sep++ = ':';
508                                         file = sep;
509                                 } else {
510                                         copy_file (ifd, file, 0);
511                                         break;
512                                 }
513                         }
514                 } else if (params.type == IH_TYPE_PBLIMAGE) {
515                         /* PBL has special Image format, implements its' own */
516                         pbl_load_uboot(ifd, &params);
517                 } else {
518                         copy_file(ifd, params.datafile, pad_len);
519                 }
520                 if (params.type == IH_TYPE_FIRMWARE_IVT) {
521                         /* Add alignment and IVT */
522                         uint32_t aligned_filesize = (params.file_size + 0x1000
523                                         - 1) & ~(0x1000 - 1);
524                         flash_header_v2_t ivt_header = { { 0xd1, 0x2000, 0x40 },
525                                         params.addr, 0, 0, 0, params.addr
526                                                         + aligned_filesize
527                                                         - tparams->header_size,
528                                         params.addr + aligned_filesize
529                                                         - tparams->header_size
530                                                         + 0x20, 0 };
531                         int i = params.file_size;
532                         for (; i < aligned_filesize; i++) {
533                                 if (write(ifd, (char *) &i, 1) != 1) {
534                                         fprintf(stderr,
535                                                         "%s: Write error on %s: %s\n",
536                                                         params.cmdname,
537                                                         params.imagefile,
538                                                         strerror(errno));
539                                         exit(EXIT_FAILURE);
540                                 }
541                         }
542                         if (write(ifd, &ivt_header, sizeof(flash_header_v2_t))
543                                         != sizeof(flash_header_v2_t)) {
544                                 fprintf(stderr, "%s: Write error on %s: %s\n",
545                                                 params.cmdname,
546                                                 params.imagefile,
547                                                 strerror(errno));
548                                 exit(EXIT_FAILURE);
549                         }
550                 }
551         }
552
553         /* We're a bit of paranoid */
554 #if defined(_POSIX_SYNCHRONIZED_IO) && \
555    !defined(__sun__) && \
556    !defined(__FreeBSD__) && \
557    !defined(__OpenBSD__) && \
558    !defined(__APPLE__)
559         (void) fdatasync (ifd);
560 #else
561         (void) fsync (ifd);
562 #endif
563
564         if (fstat(ifd, &sbuf) < 0) {
565                 fprintf (stderr, "%s: Can't stat %s: %s\n",
566                         params.cmdname, params.imagefile, strerror(errno));
567                 exit (EXIT_FAILURE);
568         }
569         params.file_size = sbuf.st_size;
570
571         ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
572         if (ptr == MAP_FAILED) {
573                 fprintf (stderr, "%s: Can't map %s: %s\n",
574                         params.cmdname, params.imagefile, strerror(errno));
575                 exit (EXIT_FAILURE);
576         }
577
578         /* Setup the image header as per input image type*/
579         if (tparams->set_header)
580                 tparams->set_header (ptr, &sbuf, ifd, &params);
581         else {
582                 fprintf (stderr, "%s: Can't set header for %s: %s\n",
583                         params.cmdname, tparams->name, strerror(errno));
584                 exit (EXIT_FAILURE);
585         }
586
587         /* Print the image information by processing image header */
588         if (tparams->print_header)
589                 tparams->print_header (ptr);
590         else {
591                 fprintf (stderr, "%s: Can't print header for %s: %s\n",
592                         params.cmdname, tparams->name, strerror(errno));
593                 exit (EXIT_FAILURE);
594         }
595
596         (void) munmap((void *)ptr, sbuf.st_size);
597
598         /* We're a bit of paranoid */
599 #if defined(_POSIX_SYNCHRONIZED_IO) && \
600    !defined(__sun__) && \
601    !defined(__FreeBSD__) && \
602    !defined(__OpenBSD__) && \
603    !defined(__APPLE__)
604         (void) fdatasync (ifd);
605 #else
606         (void) fsync (ifd);
607 #endif
608
609         if (close(ifd)) {
610                 fprintf (stderr, "%s: Write error on %s: %s\n",
611                         params.cmdname, params.imagefile, strerror(errno));
612                 exit (EXIT_FAILURE);
613         }
614
615         exit (EXIT_SUCCESS);
616 }
617
618 static void
619 copy_file (int ifd, const char *datafile, int pad)
620 {
621         int dfd;
622         struct stat sbuf;
623         unsigned char *ptr;
624         int tail;
625         int zero = 0;
626         uint8_t zeros[4096];
627         int offset = 0;
628         int size;
629         struct image_type_params *tparams = imagetool_get_type(params.type);
630
631         memset(zeros, 0, sizeof(zeros));
632
633         if (params.vflag) {
634                 fprintf (stderr, "Adding Image %s\n", datafile);
635         }
636
637         if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
638                 fprintf (stderr, "%s: Can't open %s: %s\n",
639                         params.cmdname, datafile, strerror(errno));
640                 exit (EXIT_FAILURE);
641         }
642
643         if (fstat(dfd, &sbuf) < 0) {
644                 fprintf (stderr, "%s: Can't stat %s: %s\n",
645                         params.cmdname, datafile, strerror(errno));
646                 exit (EXIT_FAILURE);
647         }
648
649         ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
650         if (ptr == MAP_FAILED) {
651                 fprintf (stderr, "%s: Can't read %s: %s\n",
652                         params.cmdname, datafile, strerror(errno));
653                 exit (EXIT_FAILURE);
654         }
655
656         if (params.xflag) {
657                 unsigned char *p = NULL;
658                 /*
659                  * XIP: do not append the image_header_t at the
660                  * beginning of the file, but consume the space
661                  * reserved for it.
662                  */
663
664                 if ((unsigned)sbuf.st_size < tparams->header_size) {
665                         fprintf (stderr,
666                                 "%s: Bad size: \"%s\" is too small for XIP\n",
667                                 params.cmdname, datafile);
668                         exit (EXIT_FAILURE);
669                 }
670
671                 for (p = ptr; p < ptr + tparams->header_size; p++) {
672                         if ( *p != 0xff ) {
673                                 fprintf (stderr,
674                                         "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
675                                         params.cmdname, datafile);
676                                 exit (EXIT_FAILURE);
677                         }
678                 }
679
680                 offset = tparams->header_size;
681         }
682
683         size = sbuf.st_size - offset;
684         if (write(ifd, ptr + offset, size) != size) {
685                 fprintf (stderr, "%s: Write error on %s: %s\n",
686                         params.cmdname, params.imagefile, strerror(errno));
687                 exit (EXIT_FAILURE);
688         }
689
690         tail = size % 4;
691         if ((pad == 1) && (tail != 0)) {
692
693                 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
694                         fprintf (stderr, "%s: Write error on %s: %s\n",
695                                 params.cmdname, params.imagefile,
696                                 strerror(errno));
697                         exit (EXIT_FAILURE);
698                 }
699         } else if (pad > 1) {
700                 while (pad > 0) {
701                         int todo = sizeof(zeros);
702
703                         if (todo > pad)
704                                 todo = pad;
705                         if (write(ifd, (char *)&zeros, todo) != todo) {
706                                 fprintf(stderr, "%s: Write error on %s: %s\n",
707                                         params.cmdname, params.imagefile,
708                                         strerror(errno));
709                                 exit(EXIT_FAILURE);
710                         }
711                         pad -= todo;
712                 }
713         }
714
715         (void) munmap((void *)ptr, sbuf.st_size);
716         (void) close (dfd);
717 }