[people/ms/u-boot.git] / tools / mkimage.c

/*
 * (C) Copyright 2008 Semihalf
 *
 * (C) Copyright 2000-2009
 * DENX Software Engineering
 * Wolfgang Denk, wd@denx.de
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include "mkimage.h"
#include <image.h>
#include <version.h>

static void copy_file(int, const char *, int);

/* parameters initialized by core will be used by the image type code */
static struct image_tool_params params = {
	.os = IH_OS_LINUX,
	.arch = IH_ARCH_PPC,
	.type = IH_TYPE_KERNEL,
	.comp = IH_COMP_GZIP,
	.dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
	.imagename = "",
	.imagename2 = "",
};

static enum ih_category cur_category;

static int h_compare_category_name(const void *vtype1, const void *vtype2)
{
	const int *type1 = vtype1;
	const int *type2 = vtype2;
	const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
	const char *name2 = genimg_get_cat_short_name(cur_category, *type2);

	return strcmp(name1, name2);
}

static int show_valid_options(enum ih_category category)
{
	int *order;
	int count;
	int item;
	int i;

	count = genimg_get_cat_count(category);
	order = calloc(count, sizeof(*order));
	if (!order)
		return -ENOMEM;

	/* Sort the names in order of short name for easier reading */
	for (item = 0; item < count; item++)
		order[item] = item;
	cur_category = category;
	qsort(order, count, sizeof(int), h_compare_category_name);

	fprintf(stderr, "\nInvalid %s, supported are:\n",
		genimg_get_cat_desc(category));
	for (i = 0; i < count; i++) {
		item = order[i];
		fprintf(stderr, "\t%-15s  %s\n",
			genimg_get_cat_short_name(category, item),
			genimg_get_cat_name(category, item));
	}
	fprintf(stderr, "\n");

	return 0;
}

static void usage(const char *msg)
{
	fprintf(stderr, "Error: %s\n", msg);
	fprintf(stderr, "Usage: %s -l image\n"
			 "          -l ==> list image header information\n",
		params.cmdname);
	fprintf(stderr,
		"       %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
		"          -A ==> set architecture to 'arch'\n"
		"          -O ==> set operating system to 'os'\n"
		"          -T ==> set image type to 'type'\n"
		"          -C ==> set compression type 'comp'\n"
		"          -a ==> set load address to 'addr' (hex)\n"
		"          -e ==> set entry point to 'ep' (hex)\n"
		"          -n ==> set image name to 'name'\n"
		"          -d ==> use image data from 'datafile'\n"
		"          -x ==> set XIP (execute in place)\n",
		params.cmdname);
	fprintf(stderr,
		"       %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] fit-image\n"
		"           <dtb> file is used with -f auto, it may occour multiple times.\n",
		params.cmdname);
	fprintf(stderr,
		"          -D => set all options for device tree compiler\n"
		"          -f => input filename for FIT source\n");
#ifdef CONFIG_FIT_SIGNATURE
	fprintf(stderr,
		"Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r]\n"
		"          -E => place data outside of the FIT structure\n"
		"          -k => set directory containing private keys\n"
		"          -K => write public keys to this .dtb file\n"
		"          -c => add comment in signature node\n"
		"          -F => re-sign existing FIT image\n"
		"          -p => place external data at a static position\n"
		"          -r => mark keys used as 'required' in dtb\n");
#else
	fprintf(stderr,
		"Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
#endif
	fprintf(stderr, "       %s -V ==> print version information and exit\n",
		params.cmdname);
	fprintf(stderr, "Use -T to see a list of available image types\n");

	exit(EXIT_FAILURE);
}

static int add_content(int type, const char *fname)
{
	struct content_info *cont;

	cont = calloc(1, sizeof(*cont));
	if (!cont)
		return -1;
	cont->type = type;
	cont->fname = fname;
	if (params.content_tail)
		params.content_tail->next = cont;
	else
		params.content_head = cont;
	params.content_tail = cont;

	return 0;
}

static void process_args(int argc, char **argv)
{
	char *ptr;
	int type = IH_TYPE_INVALID;
	char *datafile = NULL;
	int opt;

	while ((opt = getopt(argc, argv,
			     "a:A:b:c:C:d:D:e:Ef:Fk:K:ln:p:O:rR:qsT:vVx")) != -1) {
		switch (opt) {
		case 'a':
			params.addr = strtoull(optarg, &ptr, 16);
			if (*ptr) {
				fprintf(stderr, "%s: invalid load address %s\n",
					params.cmdname, optarg);
				exit(EXIT_FAILURE);
			}
			break;
		case 'A':
			params.arch = genimg_get_arch_id(optarg);
			if (params.arch < 0) {
				show_valid_options(IH_ARCH);
				usage("Invalid architecture");
			}
			break;
		case 'b':
			if (add_content(IH_TYPE_FLATDT, optarg)) {
				fprintf(stderr,
					"%s: Out of memory adding content '%s'",
					params.cmdname, optarg);
				exit(EXIT_FAILURE);
			}
			break;
		case 'c':
			params.comment = optarg;
			break;
		case 'C':
			params.comp = genimg_get_comp_id(optarg);
			if (params.comp < 0) {
				show_valid_options(IH_COMP);
				usage("Invalid compression type");
			}
			break;
		case 'd':
			params.datafile = optarg;
			params.dflag = 1;
			break;
		case 'D':
			params.dtc = optarg;
			break;
		case 'e':
			params.ep = strtoull(optarg, &ptr, 16);
			if (*ptr) {
				fprintf(stderr, "%s: invalid entry point %s\n",
					params.cmdname, optarg);
				exit(EXIT_FAILURE);
			}
			params.eflag = 1;
			break;
		case 'E':
			params.external_data = true;
			break;
		case 'f':
			datafile = optarg;
			params.auto_its = !strcmp(datafile, "auto");
			/* no break */
		case 'F':
			/*
			 * The flattened image tree (FIT) format
			 * requires a flattened device tree image type
			 */
			params.type = IH_TYPE_FLATDT;
			params.fflag = 1;
			break;
		case 'k':
			params.keydir = optarg;
			break;
		case 'K':
			params.keydest = optarg;
			break;
		case 'l':
			params.lflag = 1;
			break;
		case 'n':
			params.imagename = optarg;
			break;
		case 'O':
			params.os = genimg_get_os_id(optarg);
			if (params.os < 0) {
				show_valid_options(IH_OS);
				usage("Invalid operating system");
			}
			break;
		case 'p':
			params.external_offset = strtoull(optarg, &ptr, 16);
			if (*ptr) {
				fprintf(stderr, "%s: invalid offset size %s\n",
					params.cmdname, optarg);
				exit(EXIT_FAILURE);
			}
			break;
		case 'q':
			params.quiet = 1;
			break;
		case 'r':
			params.require_keys = 1;
			break;
		case 'R':
			/*
			 * This entry is for the second configuration
			 * file, if only one is not enough.
			 */
			params.imagename2 = optarg;
			break;
		case 's':
			params.skipcpy = 1;
			break;
		case 'T':
			type = genimg_get_type_id(optarg);
			if (type < 0) {
				show_valid_options(IH_TYPE);
				usage("Invalid image type");
			}
			break;
		case 'v':
			params.vflag++;
			break;
		case 'V':
			printf("mkimage version %s\n", PLAIN_VERSION);
			exit(EXIT_SUCCESS);
		case 'x':
			params.xflag++;
			break;
		default:
			usage("Invalid option");
		}
	}

	/* The last parameter is expected to be the imagefile */
	if (optind < argc)
		params.imagefile = argv[optind];

	/*
	 * For auto-generated FIT images we need to know the image type to put
	 * in the FIT, which is separate from the file's image type (which
	 * will always be IH_TYPE_FLATDT in this case).
	 */
	if (params.type == IH_TYPE_FLATDT) {
		params.fit_image_type = type ? type : IH_TYPE_KERNEL;
		/* For auto_its, datafile is always 'auto' */
		if (!params.auto_its)
			params.datafile = datafile;
		else if (!params.datafile)
			usage("Missing data file for auto-FIT (use -d)");
	} else if (type != IH_TYPE_INVALID) {
		params.type = type;
	}

	if (!params.imagefile)
		usage("Missing output filename");
}

int main(int argc, char **argv)
{
	int ifd = -1;
	struct stat sbuf;
	char *ptr;
	int retval = 0;
	struct image_type_params *tparams = NULL;
	int pad_len = 0;
	int dfd;

	params.cmdname = *argv;
	params.addr = 0;
	params.ep = 0;

	process_args(argc, argv);

	/* set tparams as per input type_id */
	tparams = imagetool_get_type(params.type);
	if (tparams == NULL) {
		fprintf (stderr, "%s: unsupported type %s\n",
			params.cmdname, genimg_get_type_name(params.type));
		exit (EXIT_FAILURE);
	}

	/*
	 * check the passed arguments parameters meets the requirements
	 * as per image type to be generated/listed
	 */
	if (tparams->check_params)
		if (tparams->check_params (&params))
			usage("Bad parameters for image type");

	if (!params.eflag) {
		params.ep = params.addr;
		/* If XIP, entry point must be after the U-Boot header */
		if (params.xflag)
			params.ep += tparams->header_size;
	}

	if (params.fflag){
		if (tparams->fflag_handle)
			/*
			 * in some cases, some additional processing needs
			 * to be done if fflag is defined
			 *
			 * For ex. fit_handle_file for Fit file support
			 */
			retval = tparams->fflag_handle(&params);

		if (retval != EXIT_SUCCESS)
			exit (retval);
	}

	if (params.lflag || params.fflag) {
		ifd = open (params.imagefile, O_RDONLY|O_BINARY);
	} else {
		ifd = open (params.imagefile,
			O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
	}

	if (ifd < 0) {
		fprintf (stderr, "%s: Can't open %s: %s\n",
			params.cmdname, params.imagefile,
			strerror(errno));
		exit (EXIT_FAILURE);
	}

	if (params.lflag || params.fflag) {
		/*
		 * list header information of existing image
		 */
		if (fstat(ifd, &sbuf) < 0) {
			fprintf (stderr, "%s: Can't stat %s: %s\n",
				params.cmdname, params.imagefile,
				strerror(errno));
			exit (EXIT_FAILURE);
		}

		if ((unsigned)sbuf.st_size < tparams->header_size) {
			fprintf (stderr,
				"%s: Bad size: \"%s\" is not valid image\n",
				params.cmdname, params.imagefile);
			exit (EXIT_FAILURE);
		}

		ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
		if (ptr == MAP_FAILED) {
			fprintf (stderr, "%s: Can't read %s: %s\n",
				params.cmdname, params.imagefile,
				strerror(errno));
			exit (EXIT_FAILURE);
		}

		/*
		 * scan through mkimage registry for all supported image types
		 * and verify the input image file header for match
		 * Print the image information for matched image type
		 * Returns the error code if not matched
		 */
		retval = imagetool_verify_print_header(ptr, &sbuf,
				tparams, &params);

		(void) munmap((void *)ptr, sbuf.st_size);
		(void) close (ifd);

		exit (retval);
	}

	if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
		dfd = open(params.datafile, O_RDONLY | O_BINARY);
		if (dfd < 0) {
			fprintf(stderr, "%s: Can't open %s: %s\n",
				params.cmdname, params.datafile,
				strerror(errno));
			exit(EXIT_FAILURE);
		}

		if (fstat(dfd, &sbuf) < 0) {
			fprintf(stderr, "%s: Can't stat %s: %s\n",
				params.cmdname, params.datafile,
				strerror(errno));
			exit(EXIT_FAILURE);
		}

		params.file_size = sbuf.st_size + tparams->header_size;
		close(dfd);
	}

	/*
	 * In case there an header with a variable
	 * length will be added, the corresponding
	 * function is called. This is responsible to
	 * allocate memory for the header itself.
	 */
	if (tparams->vrec_header)
		pad_len = tparams->vrec_header(&params, tparams);
	else
		memset(tparams->hdr, 0, tparams->header_size);

	if (write(ifd, tparams->hdr, tparams->header_size)
					!= tparams->header_size) {
		fprintf (stderr, "%s: Write error on %s: %s\n",
			params.cmdname, params.imagefile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	if (!params.skipcpy) {
		if (params.type == IH_TYPE_MULTI ||
		    params.type == IH_TYPE_SCRIPT) {
			char *file = params.datafile;
			uint32_t size;

			for (;;) {
				char *sep = NULL;

				if (file) {
					if ((sep = strchr(file, ':')) != NULL) {
						*sep = '\0';
					}

					if (stat (file, &sbuf) < 0) {
						fprintf (stderr, "%s: Can't stat %s: %s\n",
							 params.cmdname, file, strerror(errno));
						exit (EXIT_FAILURE);
					}
					size = cpu_to_uimage (sbuf.st_size);
				} else {
					size = 0;
				}

				if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
					fprintf (stderr, "%s: Write error on %s: %s\n",
						 params.cmdname, params.imagefile,
						 strerror(errno));
					exit (EXIT_FAILURE);
				}

				if (!file) {
					break;
				}

				if (sep) {
					*sep = ':';
					file = sep + 1;
				} else {
					file = NULL;
				}
			}

			file = params.datafile;

			for (;;) {
				char *sep = strchr(file, ':');
				if (sep) {
					*sep = '\0';
					copy_file (ifd, file, 1);
					*sep++ = ':';
					file = sep;
				} else {
					copy_file (ifd, file, 0);
					break;
				}
			}
		} else if (params.type == IH_TYPE_PBLIMAGE) {
			/* PBL has special Image format, implements its' own */
			pbl_load_uboot(ifd, &params);
		} else {
			copy_file(ifd, params.datafile, pad_len);
		}
	}

	/* We're a bit of paranoid */
#if defined(_POSIX_SYNCHRONIZED_IO) && \
   !defined(__sun__) && \
   !defined(__FreeBSD__) && \
   !defined(__OpenBSD__) && \
   !defined(__APPLE__)
	(void) fdatasync (ifd);
#else
	(void) fsync (ifd);
#endif

	if (fstat(ifd, &sbuf) < 0) {
		fprintf (stderr, "%s: Can't stat %s: %s\n",
			params.cmdname, params.imagefile, strerror(errno));
		exit (EXIT_FAILURE);
	}
	params.file_size = sbuf.st_size;

	ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
	if (ptr == MAP_FAILED) {
		fprintf (stderr, "%s: Can't map %s: %s\n",
			params.cmdname, params.imagefile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	/* Setup the image header as per input image type*/
	if (tparams->set_header)
		tparams->set_header (ptr, &sbuf, ifd, &params);
	else {
		fprintf (stderr, "%s: Can't set header for %s: %s\n",
			params.cmdname, tparams->name, strerror(errno));
		exit (EXIT_FAILURE);
	}

	/* Print the image information by processing image header */
	if (tparams->print_header)
		tparams->print_header (ptr);
	else {
		fprintf (stderr, "%s: Can't print header for %s: %s\n",
			params.cmdname, tparams->name, strerror(errno));
		exit (EXIT_FAILURE);
	}

	(void) munmap((void *)ptr, sbuf.st_size);

	/* We're a bit of paranoid */
#if defined(_POSIX_SYNCHRONIZED_IO) && \
   !defined(__sun__) && \
   !defined(__FreeBSD__) && \
   !defined(__OpenBSD__) && \
   !defined(__APPLE__)
	(void) fdatasync (ifd);
#else
	(void) fsync (ifd);
#endif

	if (close(ifd)) {
		fprintf (stderr, "%s: Write error on %s: %s\n",
			params.cmdname, params.imagefile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	exit (EXIT_SUCCESS);
}

static void
copy_file (int ifd, const char *datafile, int pad)
{
	int dfd;
	struct stat sbuf;
	unsigned char *ptr;
	int tail;
	int zero = 0;
	uint8_t zeros[4096];
	int offset = 0;
	int size;
	struct image_type_params *tparams = imagetool_get_type(params.type);

	memset(zeros, 0, sizeof(zeros));

	if (params.vflag) {
		fprintf (stderr, "Adding Image %s\n", datafile);
	}

	if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
		fprintf (stderr, "%s: Can't open %s: %s\n",
			params.cmdname, datafile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	if (fstat(dfd, &sbuf) < 0) {
		fprintf (stderr, "%s: Can't stat %s: %s\n",
			params.cmdname, datafile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
	if (ptr == MAP_FAILED) {
		fprintf (stderr, "%s: Can't read %s: %s\n",
			params.cmdname, datafile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	if (params.xflag) {
		unsigned char *p = NULL;
		/*
		 * XIP: do not append the image_header_t at the
		 * beginning of the file, but consume the space
		 * reserved for it.
		 */

		if ((unsigned)sbuf.st_size < tparams->header_size) {
			fprintf (stderr,
				"%s: Bad size: \"%s\" is too small for XIP\n",
				params.cmdname, datafile);
			exit (EXIT_FAILURE);
		}

		for (p = ptr; p < ptr + tparams->header_size; p++) {
			if ( *p != 0xff ) {
				fprintf (stderr,
					"%s: Bad file: \"%s\" has invalid buffer for XIP\n",
					params.cmdname, datafile);
				exit (EXIT_FAILURE);
			}
		}

		offset = tparams->header_size;
	}

	size = sbuf.st_size - offset;
	if (write(ifd, ptr + offset, size) != size) {
		fprintf (stderr, "%s: Write error on %s: %s\n",
			params.cmdname, params.imagefile, strerror(errno));
		exit (EXIT_FAILURE);
	}

	tail = size % 4;
	if ((pad == 1) && (tail != 0)) {

		if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
			fprintf (stderr, "%s: Write error on %s: %s\n",
				params.cmdname, params.imagefile,
				strerror(errno));
			exit (EXIT_FAILURE);
		}
	} else if (pad > 1) {
		while (pad > 0) {
			int todo = sizeof(zeros);

			if (todo > pad)
				todo = pad;
			if (write(ifd, (char *)&zeros, todo) != todo) {
				fprintf(stderr, "%s: Write error on %s: %s\n",
					params.cmdname, params.imagefile,
					strerror(errno));
				exit(EXIT_FAILURE);
			}
			pad -= todo;
		}
	}

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