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