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

/*
 * (C) Copyright 2011 Free Electrons
 * David Wagner <david.wagner@free-electrons.com>
 *
 * Inspired from envcrc.c:
 * (C) Copyright 2001
 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <unistd.h>
#include <libgen.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/mman.h>

#include "compiler.h"
#include <u-boot/crc.h>
#include <version.h>

#define CRC_SIZE sizeof(uint32_t)

static void usage(const char *exec_name)
{
	fprintf(stderr, "%s [-h] [-r] [-b] [-p <byte>] -s <environment partition size> -o <output> <input file>\n"
	       "\n"
	       "This tool takes a key=value input file (same as would a `printenv' show) and generates the corresponding environment image, ready to be flashed.\n"
	       "\n"
	       "\tThe input file is in format:\n"
	       "\t\tkey1=value1\n"
	       "\t\tkey2=value2\n"
	       "\t\t...\n"
	       "\tEmpty lines are skipped, and lines with a # in the first\n"
	       "\tcolumn are treated as comments (also skipped).\n"
	       "\t-r : the environment has multiple copies in flash\n"
	       "\t-b : the target is big endian (default is little endian)\n"
	       "\t-p <byte> : fill the image with <byte> bytes instead of 0xff bytes\n"
	       "\t-V : print version information and exit\n"
	       "\n"
	       "If the input file is \"-\", data is read from standard input\n",
	       exec_name);
}

long int xstrtol(const char *s)
{
	long int tmp;

	errno = 0;
	tmp = strtol(s, NULL, 0);
	if (!errno)
		return tmp;

	if (errno == ERANGE)
		fprintf(stderr, "Bad integer format: %s\n",  s);
	else
		fprintf(stderr, "Error while parsing %s: %s\n", s,
				strerror(errno));

	exit(EXIT_FAILURE);
}

int main(int argc, char **argv)
{
	uint32_t crc, targetendian_crc;
	const char *txt_filename = NULL, *bin_filename = NULL;
	int txt_fd, bin_fd;
	unsigned char *dataptr, *envptr;
	unsigned char *filebuf = NULL;
	unsigned int filesize = 0, envsize = 0, datasize = 0;
	int bigendian = 0;
	int redundant = 0;
	unsigned char padbyte = 0xff;

	int option;
	int ret = EXIT_SUCCESS;

	struct stat txt_file_stat;

	int fp, ep;
	const char *prg;

	prg = basename(argv[0]);

	/* Turn off getopt()'s internal error message */
	opterr = 0;

	/* Parse the cmdline */
	while ((option = getopt(argc, argv, ":s:o:rbp:hV")) != -1) {
		switch (option) {
		case 's':
			datasize = xstrtol(optarg);
			break;
		case 'o':
			bin_filename = strdup(optarg);
			if (!bin_filename) {
				fprintf(stderr, "Can't strdup() the output filename\n");
				return EXIT_FAILURE;
			}
			break;
		case 'r':
			redundant = 1;
			break;
		case 'b':
			bigendian = 1;
			break;
		case 'p':
			padbyte = xstrtol(optarg);
			break;
		case 'h':
			usage(prg);
			return EXIT_SUCCESS;
		case 'V':
			printf("%s version %s\n", prg, PLAIN_VERSION);
			return EXIT_SUCCESS;
		case ':':
			fprintf(stderr, "Missing argument for option -%c\n",
				optopt);
			usage(prg);
			return EXIT_FAILURE;
		default:
			fprintf(stderr, "Wrong option -%c\n", optopt);
			usage(prg);
			return EXIT_FAILURE;
		}
	}

	/* Check datasize and allocate the data */
	if (datasize == 0) {
		fprintf(stderr, "Please specify the size of the environment partition.\n");
		usage(prg);
		return EXIT_FAILURE;
	}

	dataptr = malloc(datasize * sizeof(*dataptr));
	if (!dataptr) {
		fprintf(stderr, "Can't alloc %d bytes for dataptr.\n",
				datasize);
		return EXIT_FAILURE;
	}

	/*
	 * envptr points to the beginning of the actual environment (after the
	 * crc and possible `redundant' byte
	 */
	envsize = datasize - (CRC_SIZE + redundant);
	envptr = dataptr + CRC_SIZE + redundant;

	/* Pad the environment with the padding byte */
	memset(envptr, padbyte, envsize);

	/* Open the input file ... */
	if (optind >= argc || strcmp(argv[optind], "-") == 0) {
		int readbytes = 0;
		int readlen = sizeof(*envptr) * 4096;
		txt_fd = STDIN_FILENO;

		do {
			filebuf = realloc(filebuf, readlen);
			if (!filebuf) {
				fprintf(stderr, "Can't realloc memory for the input file buffer\n");
				return EXIT_FAILURE;
			}
			readbytes = read(txt_fd, filebuf + filesize, readlen);
			if (errno) {
				fprintf(stderr, "Error while reading stdin: %s\n",
						strerror(errno));
				return EXIT_FAILURE;
			}
			filesize += readbytes;
		} while (readbytes == readlen);

	} else {
		txt_filename = argv[optind];
		txt_fd = open(txt_filename, O_RDONLY);
		if (txt_fd == -1) {
			fprintf(stderr, "Can't open \"%s\": %s\n",
					txt_filename, strerror(errno));
			return EXIT_FAILURE;
		}
		/* ... and check it */
		ret = fstat(txt_fd, &txt_file_stat);
		if (ret == -1) {
			fprintf(stderr, "Can't stat() on \"%s\": %s\n",
					txt_filename, strerror(errno));
			return EXIT_FAILURE;
		}

		filesize = txt_file_stat.st_size;

		filebuf = mmap(NULL, sizeof(*envptr) * filesize, PROT_READ,
			       MAP_PRIVATE, txt_fd, 0);
		if (filebuf == MAP_FAILED) {
			fprintf(stderr, "mmap (%zu bytes) failed: %s\n",
					sizeof(*envptr) * filesize,
					strerror(errno));
			fprintf(stderr, "Falling back to read()\n");

			filebuf = malloc(sizeof(*envptr) * filesize);
			ret = read(txt_fd, filebuf, sizeof(*envptr) * filesize);
			if (ret != sizeof(*envptr) * filesize) {
				fprintf(stderr, "Can't read the whole input file (%zu bytes): %s\n",
					sizeof(*envptr) * filesize,
					strerror(errno));

				return EXIT_FAILURE;
			}
		}
		ret = close(txt_fd);
	}

	/* Parse a byte at time until reaching the file OR until the environment fills
	 * up. Check ep against envsize - 1 to allow for extra trailing '\0'. */
	for (fp = 0, ep = 0 ; fp < filesize && ep < envsize - 1; fp++) {
		if (filebuf[fp] == '\n') {
			if (fp == 0 || filebuf[fp-1] == '\n') {
				/*
				 * Skip empty lines.
				 */
				continue;
			} else if (filebuf[fp-1] == '\\') {
				/*
				 * Embedded newline in a variable.
				 *
				 * The backslash was added to the envptr; rewind
				 * and replace it with a newline
				 */
				ep--;
				envptr[ep++] = '\n';
			} else {
				/* End of a variable */
				envptr[ep++] = '\0';
			}
		} else if ((fp == 0 || filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
			/* Comment, skip the line. */
			while (++fp < filesize && filebuf[fp] != '\n')
			continue;
		} else {
			envptr[ep++] = filebuf[fp];
		}
	}
	/* If there are more bytes in the file still, it means the env filled up
	 * before parsing the whole file.  Eat comments & whitespace here to see if
	 * there was anything meaning full left in the file, and if so, throw a error
	 * and exit. */
	for( ; fp < filesize; fp++ )
	{
		if (filebuf[fp] == '\n') {
			if (fp == 0 || filebuf[fp-1] == '\n') {
				/* Ignore blank lines */
				continue;
			}
		} else if ((fp == 0 || filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
			while (++fp < filesize && filebuf[fp] != '\n')
			continue;
		} else {
			fprintf(stderr, "The environment file is too large for the target environment storage\n");
			return EXIT_FAILURE;
		}
	}
	/*
	 * Make sure there is a final '\0'
	 * And do it again on the next byte to mark the end of the environment.
	 */
	if (envptr[ep-1] != '\0') {
		envptr[ep++] = '\0';
		/*
		 * The text file doesn't have an ending newline.  We need to
		 * check the env size again to make sure we have room for two \0
		 */
		if (ep >= envsize) {
			fprintf(stderr, "The environment file is too large for the target environment storage\n");
			return EXIT_FAILURE;
		}
		envptr[ep] = '\0';
	} else {
		envptr[ep] = '\0';
	}

	/* Computes the CRC and put it at the beginning of the data */
	crc = crc32(0, envptr, envsize);
	targetendian_crc = bigendian ? cpu_to_be32(crc) : cpu_to_le32(crc);

	memcpy(dataptr, &targetendian_crc, sizeof(targetendian_crc));
	if (redundant)
		dataptr[sizeof(targetendian_crc)] = 1;

	if (!bin_filename || strcmp(bin_filename, "-") == 0) {
		bin_fd = STDOUT_FILENO;
	} else {
		bin_fd = creat(bin_filename, S_IRUSR | S_IWUSR | S_IRGRP |
					     S_IWGRP);
		if (bin_fd == -1) {
			fprintf(stderr, "Can't open output file \"%s\": %s\n",
					bin_filename, strerror(errno));
			return EXIT_FAILURE;
		}
	}

	if (write(bin_fd, dataptr, sizeof(*dataptr) * datasize) !=
			sizeof(*dataptr) * datasize) {
		fprintf(stderr, "write() failed: %s\n", strerror(errno));
		return EXIT_FAILURE;
	}

	ret = close(bin_fd);

	return ret;
}
Commit	Line	Data
a6337e6f DW	1	/*
	2	* (C) Copyright 2011 Free Electrons
	3	* David Wagner <david.wagner@free-electrons.com>
	4	*
	5	* Inspired from envcrc.c:
	6	* (C) Copyright 2001
	7	* Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
	8	*
1a459660	9	* SPDX-License-Identifier: GPL-2.0+
a6337e6f DW	10	*/
	11
	12	#include <errno.h>
	13	#include <fcntl.h>
	14	#include <stdio.h>
d1acdae9	15	#include <stdlib.h>
a6337e6f DW	16	#include <stdint.h>
	17	#include <string.h>
	18	#include <unistd.h>
558cd995	19	#include <libgen.h>
a6337e6f DW	20	#include <sys/types.h>
a6337e6f DW	21	#include <sys/stat.h>
6ee39f80	22	#include <sys/mman.h>
a6337e6f	23
d1acdae9	24	#include "compiler.h"
a6337e6f	25	#include <u-boot/crc.h>
1895420b	26	#include <version.h>
a6337e6f DW	27
	28	#define CRC_SIZE sizeof(uint32_t)
	29
	30	static void usage(const char *exec_name)
	31	{
8a1b8fc7	32	fprintf(stderr, "%s [-h] [-r] [-b] [-p <byte>] -s <environment partition size> -o <output> <input file>\n"
a6337e6f	33	"\n"
8a1b8fc7	34	"This tool takes a key=value input file (same as would a `printenv' show) and generates the corresponding environment image, ready to be flashed.\n"
a6337e6f DW	35	"\n"
	36	"\tThe input file is in format:\n"
	37	"\t\tkey1=value1\n"
	38	"\t\tkey2=value2\n"
	39	"\t\t...\n"
e72be894 DM	40	"\tEmpty lines are skipped, and lines with a # in the first\n"
e72be894 DM	41	"\tcolumn are treated as comments (also skipped).\n"
a6337e6f DW	42	"\t-r : the environment has multiple copies in flash\n"
a6337e6f DW	43	"\t-b : the target is big endian (default is little endian)\n"
8a1b8fc7	44	"\t-p <byte> : fill the image with <byte> bytes instead of 0xff bytes\n"
1895420b	45	"\t-V : print version information and exit\n"
a6337e6f DW	46	"\n"
	47	"If the input file is \"-\", data is read from standard input\n",
	48	exec_name);
	49	}
	50
3d0f9bd0 DW	51	long int xstrtol(const char *s)
	52	{
	53	long int tmp;
	54
	55	errno = 0;
	56	tmp = strtol(s, NULL, 0);
	57	if (!errno)
	58	return tmp;
	59
	60	if (errno == ERANGE)
	61	fprintf(stderr, "Bad integer format: %s\n", s);
	62	else
	63	fprintf(stderr, "Error while parsing %s: %s\n", s,
	64	strerror(errno));
	65
	66	exit(EXIT_FAILURE);
	67	}
	68
a6337e6f DW	69	int main(int argc, char **argv)
	70	{
	71	uint32_t crc, targetendian_crc;
	72	const char txt_filename = NULL, bin_filename = NULL;
	73	int txt_fd, bin_fd;
	74	unsigned char dataptr, envptr;
	75	unsigned char *filebuf = NULL;
	76	unsigned int filesize = 0, envsize = 0, datasize = 0;
	77	int bigendian = 0;
	78	int redundant = 0;
	79	unsigned char padbyte = 0xff;
	80
	81	int option;
	82	int ret = EXIT_SUCCESS;
	83
	84	struct stat txt_file_stat;
	85
	86	int fp, ep;
af44f4b2 HK	87	const char *prg;
	88
	89	prg = basename(argv[0]);
a6337e6f	90
5e0c63e2 HK	91	/* Turn off getopt()'s internal error message */
	92	opterr = 0;
	93
a6337e6f	94	/* Parse the cmdline */
1895420b	95	while ((option = getopt(argc, argv, ":s:o:rbp:hV")) != -1) {
a6337e6f DW	96	switch (option) {
a6337e6f DW	97	case 's':
3d0f9bd0	98	datasize = xstrtol(optarg);
a6337e6f DW	99	break;
	100	case 'o':
	101	bin_filename = strdup(optarg);
	102	if (!bin_filename) {
8a1b8fc7	103	fprintf(stderr, "Can't strdup() the output filename\n");
a6337e6f DW	104	return EXIT_FAILURE;
	105	}
	106	break;
	107	case 'r':
	108	redundant = 1;
	109	break;
	110	case 'b':
	111	bigendian = 1;
	112	break;
	113	case 'p':
3d0f9bd0	114	padbyte = xstrtol(optarg);
a6337e6f DW	115	break;
a6337e6f DW	116	case 'h':
af44f4b2	117	usage(prg);
a6337e6f	118	return EXIT_SUCCESS;
1895420b HK	119	case 'V':
	120	printf("%s version %s\n", prg, PLAIN_VERSION);
	121	return EXIT_SUCCESS;
5e0c63e2 HK	122	case ':':
5e0c63e2 HK	123	fprintf(stderr, "Missing argument for option -%c\n",
72ebafbe	124	optopt);
e758a5c4	125	usage(prg);
5e0c63e2	126	return EXIT_FAILURE;
a6337e6f	127	default:
72ebafbe	128	fprintf(stderr, "Wrong option -%c\n", optopt);
af44f4b2	129	usage(prg);
a6337e6f DW	130	return EXIT_FAILURE;
	131	}
	132	}
	133
	134	/* Check datasize and allocate the data */
	135	if (datasize == 0) {
8a1b8fc7	136	fprintf(stderr, "Please specify the size of the environment partition.\n");
af44f4b2	137	usage(prg);
a6337e6f DW	138	return EXIT_FAILURE;
	139	}
	140
	141	dataptr = malloc(datasize * sizeof(*dataptr));
	142	if (!dataptr) {
8a1b8fc7 DW	143	fprintf(stderr, "Can't alloc %d bytes for dataptr.\n",
8a1b8fc7 DW	144	datasize);
a6337e6f DW	145	return EXIT_FAILURE;
	146	}
	147
	148	/*
	149	* envptr points to the beginning of the actual environment (after the
8a1b8fc7	150	* crc and possible `redundant' byte
a6337e6f DW	151	*/
	152	envsize = datasize - (CRC_SIZE + redundant);
	153	envptr = dataptr + CRC_SIZE + redundant;
	154
	155	/* Pad the environment with the padding byte */
	156	memset(envptr, padbyte, envsize);
	157
	158	/* Open the input file ... */
48995b5a	159	if (optind >= argc \|\| strcmp(argv[optind], "-") == 0) {
a6337e6f	160	int readbytes = 0;
48995b5a	161	int readlen = sizeof(envptr) 4096;
a6337e6f DW	162	txt_fd = STDIN_FILENO;
	163
	164	do {
	165	filebuf = realloc(filebuf, readlen);
3d0f9bd0 DW	166	if (!filebuf) {
	167	fprintf(stderr, "Can't realloc memory for the input file buffer\n");
	168	return EXIT_FAILURE;
	169	}
a6337e6f	170	readbytes = read(txt_fd, filebuf + filesize, readlen);
3d0f9bd0 DW	171	if (errno) {
	172	fprintf(stderr, "Error while reading stdin: %s\n",
	173	strerror(errno));
	174	return EXIT_FAILURE;
	175	}
a6337e6f DW	176	filesize += readbytes;
	177	} while (readbytes == readlen);
	178
	179	} else {
48995b5a	180	txt_filename = argv[optind];
a6337e6f DW	181	txt_fd = open(txt_filename, O_RDONLY);
	182	if (txt_fd == -1) {
	183	fprintf(stderr, "Can't open \"%s\": %s\n",
	184	txt_filename, strerror(errno));
	185	return EXIT_FAILURE;
	186	}
	187	/* ... and check it */
	188	ret = fstat(txt_fd, &txt_file_stat);
	189	if (ret == -1) {
8a1b8fc7 DW	190	fprintf(stderr, "Can't stat() on \"%s\": %s\n",
8a1b8fc7 DW	191	txt_filename, strerror(errno));
a6337e6f DW	192	return EXIT_FAILURE;
	193	}
	194
	195	filesize = txt_file_stat.st_size;
6ee39f80 DW	196
	197	filebuf = mmap(NULL, sizeof(envptr) filesize, PROT_READ,
	198	MAP_PRIVATE, txt_fd, 0);
	199	if (filebuf == MAP_FAILED) {
1ebff63f	200	fprintf(stderr, "mmap (%zu bytes) failed: %s\n",
6ee39f80 DW	201	sizeof(envptr) filesize,
	202	strerror(errno));
	203	fprintf(stderr, "Falling back to read()\n");
	204
	205	filebuf = malloc(sizeof(envptr) filesize);
	206	ret = read(txt_fd, filebuf, sizeof(envptr) filesize);
	207	if (ret != sizeof(envptr) filesize) {
1ebff63f	208	fprintf(stderr, "Can't read the whole input file (%zu bytes): %s\n",
6ee39f80 DW	209	sizeof(envptr) filesize,
	210	strerror(errno));
	211
	212	return EXIT_FAILURE;
	213	}
a6337e6f DW	214	}
	215	ret = close(txt_fd);
	216	}
a6337e6f	217
80ee0196 BM	218	/* Parse a byte at time until reaching the file OR until the environment fills
	219	* up. Check ep against envsize - 1 to allow for extra trailing '\0'. */
	220	for (fp = 0, ep = 0 ; fp < filesize && ep < envsize - 1; fp++) {
a6337e6f	221	if (filebuf[fp] == '\n') {
e72be894	222	if (fp == 0 \|\| filebuf[fp-1] == '\n') {
a6337e6f	223	/*
e72be894	224	* Skip empty lines.
a6337e6f DW	225	*/
	226	continue;
	227	} else if (filebuf[fp-1] == '\\') {
	228	/*
	229	* Embedded newline in a variable.
	230	*
dbee61db DW	231	* The backslash was added to the envptr; rewind
dbee61db DW	232	* and replace it with a newline
a6337e6f DW	233	*/
	234	ep--;
	235	envptr[ep++] = '\n';
	236	} else {
	237	/* End of a variable */
	238	envptr[ep++] = '\0';
	239	}
e72be894 DM	240	} else if ((fp == 0 \|\| filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
	241	/* Comment, skip the line. */
	242	while (++fp < filesize && filebuf[fp] != '\n')
	243	continue;
a6337e6f DW	244	} else {
	245	envptr[ep++] = filebuf[fp];
	246	}
	247	}
80ee0196 BM	248	/* If there are more bytes in the file still, it means the env filled up
	249	* before parsing the whole file. Eat comments & whitespace here to see if
	250	* there was anything meaning full left in the file, and if so, throw a error
	251	* and exit. */
	252	for( ; fp < filesize; fp++ )
	253	{
	254	if (filebuf[fp] == '\n') {
	255	if (fp == 0 \|\| filebuf[fp-1] == '\n') {
	256	/* Ignore blank lines */
	257	continue;
	258	}
	259	} else if ((fp == 0 \|\| filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
	260	while (++fp < filesize && filebuf[fp] != '\n')
	261	continue;
	262	} else {
	263	fprintf(stderr, "The environment file is too large for the target environment storage\n");
	264	return EXIT_FAILURE;
	265	}
	266	}
a6337e6f DW	267	/*
	268	* Make sure there is a final '\0'
	269	* And do it again on the next byte to mark the end of the environment.
	270	*/
	271	if (envptr[ep-1] != '\0') {
	272	envptr[ep++] = '\0';
	273	/*
	274	* The text file doesn't have an ending newline. We need to
	275	* check the env size again to make sure we have room for two \0
	276	*/
	277	if (ep >= envsize) {
8a1b8fc7	278	fprintf(stderr, "The environment file is too large for the target environment storage\n");
a6337e6f DW	279	return EXIT_FAILURE;
	280	}
	281	envptr[ep] = '\0';
	282	} else {
	283	envptr[ep] = '\0';
	284	}
	285
	286	/* Computes the CRC and put it at the beginning of the data */
	287	crc = crc32(0, envptr, envsize);
	288	targetendian_crc = bigendian ? cpu_to_be32(crc) : cpu_to_le32(crc);
	289
d8d26599 DW	290	memcpy(dataptr, &targetendian_crc, sizeof(targetendian_crc));
	291	if (redundant)
	292	dataptr[sizeof(targetendian_crc)] = 1;
a6337e6f	293
48995b5a DW	294	if (!bin_filename \|\| strcmp(bin_filename, "-") == 0) {
	295	bin_fd = STDOUT_FILENO;
	296	} else {
4f7136e7 MF	297	bin_fd = creat(bin_filename, S_IRUSR \| S_IWUSR \| S_IRGRP \|
4f7136e7 MF	298	S_IWGRP);
48995b5a DW	299	if (bin_fd == -1) {
	300	fprintf(stderr, "Can't open output file \"%s\": %s\n",
	301	bin_filename, strerror(errno));
	302	return EXIT_FAILURE;
	303	}
a6337e6f DW	304	}
	305
	306	if (write(bin_fd, dataptr, sizeof(dataptr) datasize) !=
	307	sizeof(dataptr) datasize) {
	308	fprintf(stderr, "write() failed: %s\n", strerror(errno));
	309	return EXIT_FAILURE;
	310	}
	311
	312	ret = close(bin_fd);
	313
	314	return ret;
	315	}