[thirdparty/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 int h_compare_image_name(const void *vtype1, const void *vtype2)
{
	const int *type1 = vtype1;
	const int *type2 = vtype2;
	const char *name1 = genimg_get_type_short_name(*type1);
	const char *name2 = genimg_get_type_short_name(*type2);

	return strcmp(name1, name2);
}

/* Show all image types supported by mkimage */
static void show_image_types(void)
{
	struct image_type_params *tparams;
	int order[IH_TYPE_COUNT];
	int count;
	int type;
	int i;

	/* Sort the names in order of short name for easier reading */
	memset(order, '\0', sizeof(order));
	for (count = 0, type = 0; type < IH_TYPE_COUNT; type++) {
		tparams = imagetool_get_type(type);
		if (tparams)
			order[count++] = type;
	}
	qsort(order, count, sizeof(int), h_compare_image_name);

	fprintf(stderr, "\nInvalid image type. Supported image types:\n");
	for (i = 0; i < count; i++) {
		type = order[i];
		tparams = imagetool_get_type(type);
		if (tparams) {
			fprintf(stderr, "\t%-15s  %s\n",
				genimg_get_type_short_name(type),
				genimg_get_type_name(type));
		}
	}
	fprintf(stderr, "\n");
}

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_list>] fit-image\n"
		"           <dtb_list> is used with -f auto, and is a space-separated list of .dtb files\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: [-k keydir] [-K dtb] [ -c <comment>] [-r]\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"
		"          -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 expecting;
	int opt;

	expecting = IH_TYPE_COUNT;	/* Unknown */
	while ((opt = getopt(argc, argv,
			     "-a:A:bcC:d:D:e:f:Fk:K:ln:O:rR:sT: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)
				usage("Invalid architecture");
			break;
		case 'b':
			expecting = IH_TYPE_FLATDT;
			break;
		case 'c':
			params.comment = optarg;
			break;
		case 'C':
			params.comp = genimg_get_comp_id(optarg);
			if (params.comp < 0)
				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 '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.fit_image_type = params.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)
				usage("Invalid operating system");
			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_image_types();
				usage("Invalid image type");
			}
			expecting = type;
			break;
		case 'v':
			params.vflag++;
			break;
		case 'V':
			printf("mkimage version %s\n", PLAIN_VERSION);
			exit(EXIT_SUCCESS);
		case 'x':
			params.xflag++;
			break;
		case 1:
			if (expecting == type || optind == argc) {
				params.imagefile = optarg;
				expecting = IH_TYPE_INVALID;
			} else if (expecting == IH_TYPE_INVALID) {
				fprintf(stderr,
					"%s: Unknown content type: use -b before device tree files",
					params.cmdname);
				exit(EXIT_FAILURE);
			} else {
				if (add_content(expecting, optarg)) {
					fprintf(stderr,
						"%s: Out of memory adding content '%s'",
						params.cmdname, optarg);
					exit(EXIT_FAILURE);
				}
			}
			break;
		default:
			usage("Invalid option");
		}
	}

	/*
	 * 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;
		if (!params.auto_its)
			params.datafile = datafile;
	} 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
5b9d44df SG	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
15310348	69	static void usage(const char *msg)
b0a487a4	70	{
15310348	71	fprintf(stderr, "Error: %s\n", msg);
b0a487a4 SG	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,
fb4cce0f SG	88	" %s [-D dtc_options] [-f fit-image.its\|-f auto\|-F] [-b <dtb_list>] fit-image\n"
fb4cce0f SG	89	" <dtb_list> is used with -f auto, and is a space-separated list of .dtb files\n",
b0a487a4 SG	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
fb4cce0f SG	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
0b443dee	131	static void process_args(int argc, char **argv)
5b1d7137	132	{
a2513e27	133	char *ptr;
d505a09c SG	134	int type = IH_TYPE_INVALID;
	135	char *datafile = NULL;
	136	int expecting;
a02221f2 SG	137	int opt;
a02221f2 SG	138
d505a09c	139	expecting = IH_TYPE_COUNT; /* Unknown */
a02221f2	140	while ((opt = getopt(argc, argv,
fb4cce0f	141	"-a:A:bcC:d:D:e:f:Fk:K:ln:O:rR:sT:vVx")) != -1) {
a02221f2	142	switch (opt) {
07450081 SG	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	}
a02221f2 SG	150	break;
	151	case 'A':
	152	params.arch = genimg_get_arch_id(optarg);
	153	if (params.arch < 0)
15310348	154	usage("Invalid architecture");
a02221f2	155	break;
fb4cce0f SG	156	case 'b':
	157	expecting = IH_TYPE_FLATDT;
	158	break;
a02221f2 SG	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)
15310348	165	usage("Invalid compression type");
a02221f2	166	break;
a02221f2 SG	167	case 'd':
	168	params.datafile = optarg;
	169	params.dflag = 1;
	170	break;
07450081 SG	171	case 'D':
	172	params.dtc = optarg;
	173	break;
a02221f2 SG	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);
5b1d7137	180	}
a02221f2 SG	181	params.eflag = 1;
	182	break;
	183	case 'f':
8e35bb07 SG	184	datafile = optarg;
8e35bb07 SG	185	params.auto_its = !strcmp(datafile, "auto");
a02221f2 SG	186	/* no break */
	187	case 'F':
	188	/*
	189	* The flattened image tree (FIT) format
	190	* requires a flattened device tree image type
	191	*/
d505a09c	192	params.fit_image_type = params.type;
a02221f2 SG	193	params.type = IH_TYPE_FLATDT;
	194	params.fflag = 1;
	195	break;
	196	case 'k':
	197	params.keydir = optarg;
	198	break;
	199	case 'K':
	200	params.keydest = optarg;
	201	break;
07450081 SG	202	case 'l':
	203	params.lflag = 1;
	204	break;
a02221f2 SG	205	case 'n':
	206	params.imagename = optarg;
	207	break;
07450081 SG	208	case 'O':
	209	params.os = genimg_get_os_id(optarg);
	210	if (params.os < 0)
15310348	211	usage("Invalid operating system");
07450081	212	break;
a02221f2 SG	213	case 'r':
	214	params.require_keys = 1;
	215	break;
	216	case 'R':
	217	/*
	218	* This entry is for the second configuration
	219	* file, if only one is not enough.
	220	*/
	221	params.imagename2 = optarg;
	222	break;
	223	case 's':
	224	params.skipcpy = 1;
	225	break;
07450081	226	case 'T':
d505a09c SG	227	type = genimg_get_type_id(optarg);
d505a09c SG	228	if (type < 0) {
07450081	229	show_image_types();
15310348	230	usage("Invalid image type");
07450081	231	}
d505a09c	232	expecting = type;
07450081	233	break;
a02221f2 SG	234	case 'v':
	235	params.vflag++;
	236	break;
	237	case 'V':
	238	printf("mkimage version %s\n", PLAIN_VERSION);
	239	exit(EXIT_SUCCESS);
	240	case 'x':
	241	params.xflag++;
	242	break;
d505a09c SG	243	case 1:
	244	if (expecting == type \|\| optind == argc) {
	245	params.imagefile = optarg;
	246	expecting = IH_TYPE_INVALID;
fb4cce0f SG	247	} else if (expecting == IH_TYPE_INVALID) {
	248	fprintf(stderr,
	249	"%s: Unknown content type: use -b before device tree files",
	250	params.cmdname);
	251	exit(EXIT_FAILURE);
	252	} else {
	253	if (add_content(expecting, optarg)) {
	254	fprintf(stderr,
	255	"%s: Out of memory adding content '%s'",
	256	params.cmdname, optarg);
	257	exit(EXIT_FAILURE);
	258	}
d505a09c SG	259	}
d505a09c SG	260	break;
a02221f2	261	default:
15310348	262	usage("Invalid option");
5b1d7137	263	}
5b1d7137 WD	264	}
5b1d7137 WD	265
d505a09c SG	266	/*
	267	* For auto-generated FIT images we need to know the image type to put
	268	* in the FIT, which is separate from the file's image type (which
	269	* will always be IH_TYPE_FLATDT in this case).
	270	*/
	271	if (params.type == IH_TYPE_FLATDT) {
	272	params.fit_image_type = type;
8e35bb07 SG	273	if (!params.auto_its)
8e35bb07 SG	274	params.datafile = datafile;
d505a09c SG	275	} else if (type != IH_TYPE_INVALID) {
	276	params.type = type;
	277	}
	278
	279	if (!params.imagefile)
15310348	280	usage("Missing output filename");
0b443dee SG	281	}
	282
	283
	284	int main(int argc, char **argv)
	285	{
	286	int ifd = -1;
	287	struct stat sbuf;
	288	char *ptr;
	289	int retval = 0;
	290	struct image_type_params *tparams = NULL;
	291	int pad_len = 0;
	292	int dfd;
	293
	294	params.cmdname = *argv;
	295	params.addr = 0;
	296	params.ep = 0;
	297
	298	process_args(argc, argv);
89a4d6b1 PW	299
89a4d6b1 PW	300	/* set tparams as per input type_id */
a93648d1	301	tparams = imagetool_get_type(params.type);
89a4d6b1 PW	302	if (tparams == NULL) {
	303	fprintf (stderr, "%s: unsupported type %s\n",
	304	params.cmdname, genimg_get_type_name(params.type));
	305	exit (EXIT_FAILURE);
	306	}
5b1d7137	307
89a4d6b1 PW	308	/*
	309	* check the passed arguments parameters meets the requirements
	310	* as per image type to be generated/listed
	311	*/
	312	if (tparams->check_params)
	313	if (tparams->check_params (&params))
15310348	314	usage("Bad parameters for image type");
89a4d6b1 PW	315
	316	if (!params.eflag) {
	317	params.ep = params.addr;
5b1d7137	318	/* If XIP, entry point must be after the U-Boot header */
89a4d6b1 PW	319	if (params.xflag)
89a4d6b1 PW	320	params.ep += tparams->header_size;
5b1d7137 WD	321	}
5b1d7137 WD	322
c81296c1 PT	323	if (params.fflag){
	324	if (tparams->fflag_handle)
	325	/*
	326	* in some cases, some additional processing needs
	327	* to be done if fflag is defined
	328	*
	329	* For ex. fit_handle_file for Fit file support
	330	*/
	331	retval = tparams->fflag_handle(&params);
5b1d7137	332
c81296c1 PT	333	if (retval != EXIT_SUCCESS)
	334	exit (retval);
	335	}
	336
	337	if (params.lflag \|\| params.fflag) {
	338	ifd = open (params.imagefile, O_RDONLY\|O_BINARY);
	339	} else {
	340	ifd = open (params.imagefile,
	341	O_RDWR\|O_CREAT\|O_TRUNC\|O_BINARY, 0666);
	342	}
	343
	344	if (ifd < 0) {
	345	fprintf (stderr, "%s: Can't open %s: %s\n",
	346	params.cmdname, params.imagefile,
	347	strerror(errno));
	348	exit (EXIT_FAILURE);
5b1d7137 WD	349	}
5b1d7137 WD	350
c81296c1	351	if (params.lflag \|\| params.fflag) {
5b1d7137 WD	352	/*
	353	* list header information of existing image
	354	*/
	355	if (fstat(ifd, &sbuf) < 0) {
	356	fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1 PW	357	params.cmdname, params.imagefile,
89a4d6b1 PW	358	strerror(errno));
5b1d7137 WD	359	exit (EXIT_FAILURE);
	360	}
	361
89a4d6b1	362	if ((unsigned)sbuf.st_size < tparams->header_size) {
5b1d7137	363	fprintf (stderr,
89a4d6b1 PW	364	"%s: Bad size: \"%s\" is not valid image\n",
89a4d6b1 PW	365	params.cmdname, params.imagefile);
5b1d7137 WD	366	exit (EXIT_FAILURE);
	367	}
	368
fa956fde MF	369	ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
fa956fde MF	370	if (ptr == MAP_FAILED) {
5b1d7137	371	fprintf (stderr, "%s: Can't read %s: %s\n",
89a4d6b1 PW	372	params.cmdname, params.imagefile,
89a4d6b1 PW	373	strerror(errno));
5b1d7137 WD	374	exit (EXIT_FAILURE);
	375	}
	376
89a4d6b1 PW	377	/*
	378	* scan through mkimage registry for all supported image types
	379	* and verify the input image file header for match
	380	* Print the image information for matched image type
	381	* Returns the error code if not matched
	382	*/
0ca6691c GMF	383	retval = imagetool_verify_print_header(ptr, &sbuf,
0ca6691c GMF	384	tparams, &params);
5b1d7137	385
5b1d7137 WD	386	(void) munmap((void *)ptr, sbuf.st_size);
	387	(void) close (ifd);
	388
f7644c0b	389	exit (retval);
5b1d7137 WD	390	}
5b1d7137 WD	391
34633141	392	if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
6ae6e160 PDS	393	dfd = open(params.datafile, O_RDONLY \| O_BINARY);
	394	if (dfd < 0) {
	395	fprintf(stderr, "%s: Can't open %s: %s\n",
	396	params.cmdname, params.datafile,
	397	strerror(errno));
	398	exit(EXIT_FAILURE);
	399	}
92a655c3	400
6ae6e160 PDS	401	if (fstat(dfd, &sbuf) < 0) {
	402	fprintf(stderr, "%s: Can't stat %s: %s\n",
	403	params.cmdname, params.datafile,
	404	strerror(errno));
	405	exit(EXIT_FAILURE);
	406	}
92a655c3	407
6ae6e160 PDS	408	params.file_size = sbuf.st_size + tparams->header_size;
	409	close(dfd);
	410	}
92a655c3	411
5b1d7137	412	/*
f0662105 SB	413	* In case there an header with a variable
	414	* length will be added, the corresponding
	415	* function is called. This is responsible to
	416	* allocate memory for the header itself.
5b1d7137	417	*/
f0662105	418	if (tparams->vrec_header)
9bac0bb3	419	pad_len = tparams->vrec_header(&params, tparams);
f0662105 SB	420	else
f0662105 SB	421	memset(tparams->hdr, 0, tparams->header_size);
5b1d7137	422
89a4d6b1 PW	423	if (write(ifd, tparams->hdr, tparams->header_size)
89a4d6b1 PW	424	!= tparams->header_size) {
5b1d7137	425	fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1	426	params.cmdname, params.imagefile, strerror(errno));
5b1d7137 WD	427	exit (EXIT_FAILURE);
	428	}
	429
d1be8f92 CR	430	if (!params.skipcpy) {
	431	if (params.type == IH_TYPE_MULTI \|\|
	432	params.type == IH_TYPE_SCRIPT) {
	433	char *file = params.datafile;
	434	uint32_t size;
	435
	436	for (;;) {
	437	char *sep = NULL;
	438
	439	if (file) {
	440	if ((sep = strchr(file, ':')) != NULL) {
	441	*sep = '\0';
	442	}
	443
	444	if (stat (file, &sbuf) < 0) {
	445	fprintf (stderr, "%s: Can't stat %s: %s\n",
	446	params.cmdname, file, strerror(errno));
	447	exit (EXIT_FAILURE);
	448	}
	449	size = cpu_to_uimage (sbuf.st_size);
	450	} else {
	451	size = 0;
5b1d7137 WD	452	}
5b1d7137 WD	453
d1be8f92 CR	454	if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
	455	fprintf (stderr, "%s: Write error on %s: %s\n",
	456	params.cmdname, params.imagefile,
	457	strerror(errno));
5b1d7137 WD	458	exit (EXIT_FAILURE);
5b1d7137 WD	459	}
5b1d7137	460
d1be8f92 CR	461	if (!file) {
	462	break;
	463	}
5b1d7137	464
d1be8f92 CR	465	if (sep) {
	466	*sep = ':';
	467	file = sep + 1;
	468	} else {
	469	file = NULL;
	470	}
5b1d7137 WD	471	}
5b1d7137 WD	472
d1be8f92	473	file = params.datafile;
5b1d7137	474
d1be8f92 CR	475	for (;;) {
	476	char *sep = strchr(file, ':');
	477	if (sep) {
	478	*sep = '\0';
	479	copy_file (ifd, file, 1);
	480	*sep++ = ':';
	481	file = sep;
	482	} else {
	483	copy_file (ifd, file, 0);
	484	break;
	485	}
5b1d7137	486	}
5d898a00 SX	487	} else if (params.type == IH_TYPE_PBLIMAGE) {
	488	/* PBL has special Image format, implements its' own */
	489	pbl_load_uboot(ifd, &params);
d1be8f92	490	} else {
9bac0bb3	491	copy_file(ifd, params.datafile, pad_len);
5b1d7137	492	}
5b1d7137 WD	493	}
	494
	495	/* We're a bit of paranoid */
89a4d6b1 PW	496	#if defined(_POSIX_SYNCHRONIZED_IO) && \
	497	!defined(__sun__) && \
	498	!defined(__FreeBSD__) && \
31cbe80c	499	!defined(__OpenBSD__) && \
89a4d6b1	500	!defined(__APPLE__)
5b1d7137 WD	501	(void) fdatasync (ifd);
	502	#else
	503	(void) fsync (ifd);
	504	#endif
	505
	506	if (fstat(ifd, &sbuf) < 0) {
	507	fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1	508	params.cmdname, params.imagefile, strerror(errno));
5b1d7137 WD	509	exit (EXIT_FAILURE);
5b1d7137 WD	510	}
92a655c3	511	params.file_size = sbuf.st_size;
5b1d7137	512
fa956fde MF	513	ptr = mmap(0, sbuf.st_size, PROT_READ\|PROT_WRITE, MAP_SHARED, ifd, 0);
fa956fde MF	514	if (ptr == MAP_FAILED) {
5b1d7137	515	fprintf (stderr, "%s: Can't map %s: %s\n",
89a4d6b1	516	params.cmdname, params.imagefile, strerror(errno));
5b1d7137 WD	517	exit (EXIT_FAILURE);
	518	}
	519
89a4d6b1 PW	520	/* Setup the image header as per input image type*/
	521	if (tparams->set_header)
	522	tparams->set_header (ptr, &sbuf, ifd, &params);
	523	else {
	524	fprintf (stderr, "%s: Can't set header for %s: %s\n",
	525	params.cmdname, tparams->name, strerror(errno));
	526	exit (EXIT_FAILURE);
	527	}
5b1d7137	528
89a4d6b1 PW	529	/* Print the image information by processing image header */
	530	if (tparams->print_header)
	531	tparams->print_header (ptr);
	532	else {
	533	fprintf (stderr, "%s: Can't print header for %s: %s\n",
	534	params.cmdname, tparams->name, strerror(errno));
	535	exit (EXIT_FAILURE);
	536	}
5b1d7137 WD	537
	538	(void) munmap((void *)ptr, sbuf.st_size);
	539
	540	/* We're a bit of paranoid */
89a4d6b1 PW	541	#if defined(_POSIX_SYNCHRONIZED_IO) && \
	542	!defined(__sun__) && \
	543	!defined(__FreeBSD__) && \
31cbe80c	544	!defined(__OpenBSD__) && \
89a4d6b1	545	!defined(__APPLE__)
5b1d7137 WD	546	(void) fdatasync (ifd);
	547	#else
	548	(void) fsync (ifd);
	549	#endif
	550
	551	if (close(ifd)) {
	552	fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1	553	params.cmdname, params.imagefile, strerror(errno));
5b1d7137 WD	554	exit (EXIT_FAILURE);
	555	}
	556
	557	exit (EXIT_SUCCESS);
	558	}
	559
	560	static void
	561	copy_file (int ifd, const char *datafile, int pad)
	562	{
	563	int dfd;
	564	struct stat sbuf;
	565	unsigned char *ptr;
	566	int tail;
	567	int zero = 0;
9bac0bb3	568	uint8_t zeros[4096];
5b1d7137 WD	569	int offset = 0;
5b1d7137 WD	570	int size;
a93648d1	571	struct image_type_params *tparams = imagetool_get_type(params.type);
5b1d7137	572
9bac0bb3 SB	573	memset(zeros, 0, sizeof(zeros));
9bac0bb3 SB	574
89a4d6b1	575	if (params.vflag) {
5b1d7137 WD	576	fprintf (stderr, "Adding Image %s\n", datafile);
	577	}
	578
ef1464cc	579	if ((dfd = open(datafile, O_RDONLY\|O_BINARY)) < 0) {
5b1d7137	580	fprintf (stderr, "%s: Can't open %s: %s\n",
89a4d6b1	581	params.cmdname, datafile, strerror(errno));
5b1d7137 WD	582	exit (EXIT_FAILURE);
	583	}
	584
	585	if (fstat(dfd, &sbuf) < 0) {
	586	fprintf (stderr, "%s: Can't stat %s: %s\n",
89a4d6b1	587	params.cmdname, datafile, strerror(errno));
5b1d7137 WD	588	exit (EXIT_FAILURE);
	589	}
	590
fa956fde MF	591	ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
fa956fde MF	592	if (ptr == MAP_FAILED) {
5b1d7137	593	fprintf (stderr, "%s: Can't read %s: %s\n",
89a4d6b1	594	params.cmdname, datafile, strerror(errno));
5b1d7137 WD	595	exit (EXIT_FAILURE);
	596	}
	597
89a4d6b1	598	if (params.xflag) {
5b1d7137 WD	599	unsigned char *p = NULL;
	600	/*
	601	* XIP: do not append the image_header_t at the
	602	* beginning of the file, but consume the space
	603	* reserved for it.
	604	*/
	605
89a4d6b1	606	if ((unsigned)sbuf.st_size < tparams->header_size) {
5b1d7137 WD	607	fprintf (stderr,
5b1d7137 WD	608	"%s: Bad size: \"%s\" is too small for XIP\n",
89a4d6b1	609	params.cmdname, datafile);
5b1d7137 WD	610	exit (EXIT_FAILURE);
	611	}
	612
89a4d6b1	613	for (p = ptr; p < ptr + tparams->header_size; p++) {
5b1d7137 WD	614	if ( *p != 0xff ) {
	615	fprintf (stderr,
	616	"%s: Bad file: \"%s\" has invalid buffer for XIP\n",
89a4d6b1	617	params.cmdname, datafile);
5b1d7137 WD	618	exit (EXIT_FAILURE);
	619	}
	620	}
	621
89a4d6b1	622	offset = tparams->header_size;
5b1d7137 WD	623	}
	624
	625	size = sbuf.st_size - offset;
	626	if (write(ifd, ptr + offset, size) != size) {
	627	fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1	628	params.cmdname, params.imagefile, strerror(errno));
5b1d7137 WD	629	exit (EXIT_FAILURE);
	630	}
	631
9bac0bb3 SB	632	tail = size % 4;
9bac0bb3 SB	633	if ((pad == 1) && (tail != 0)) {
5b1d7137 WD	634
	635	if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
	636	fprintf (stderr, "%s: Write error on %s: %s\n",
89a4d6b1 PW	637	params.cmdname, params.imagefile,
89a4d6b1 PW	638	strerror(errno));
5b1d7137 WD	639	exit (EXIT_FAILURE);
5b1d7137 WD	640	}
9bac0bb3	641	} else if (pad > 1) {
424b86ae SG	642	while (pad > 0) {
	643	int todo = sizeof(zeros);
	644
	645	if (todo > pad)
	646	todo = pad;
	647	if (write(ifd, (char *)&zeros, todo) != todo) {
	648	fprintf(stderr, "%s: Write error on %s: %s\n",
	649	params.cmdname, params.imagefile,
	650	strerror(errno));
	651	exit(EXIT_FAILURE);
	652	}
	653	pad -= todo;
9bac0bb3	654	}
5b1d7137 WD	655	}
	656
	657	(void) munmap((void *)ptr, sbuf.st_size);
	658	(void) close (dfd);
	659	}