[thirdparty/u-boot.git] / tools / mkenvimage.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (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
 */

#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);
}

#define CHUNK_SIZE 4096

int main(int argc, char **argv)
{
	uint32_t crc, targetendian_crc;
	const char *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 readbytes = 0;

	int option;
	int ret = EXIT_SUCCESS;

	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) {
		txt_fd = STDIN_FILENO;
	} else {
		txt_fd = open(argv[optind], O_RDONLY);
		if (txt_fd == -1) {
			fprintf(stderr, "Can't open \"%s\": %s\n",
					argv[optind], strerror(errno));
			return EXIT_FAILURE;
		}
	}

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

	if (txt_fd != STDIN_FILENO)
		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
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
a6337e6f DW	2	/*
	3	* (C) Copyright 2011 Free Electrons
	4	* David Wagner <david.wagner@free-electrons.com>
	5	*
	6	* Inspired from envcrc.c:
	7	* (C) Copyright 2001
	8	* Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
a6337e6f DW	9	*/
	10
	11	#include <errno.h>
	12	#include <fcntl.h>
	13	#include <stdio.h>
d1acdae9	14	#include <stdlib.h>
a6337e6f DW	15	#include <stdint.h>
	16	#include <string.h>
	17	#include <unistd.h>
558cd995	18	#include <libgen.h>
a6337e6f DW	19	#include <sys/types.h>
a6337e6f DW	20	#include <sys/stat.h>
6ee39f80	21	#include <sys/mman.h>
a6337e6f	22
d1acdae9	23	#include "compiler.h"
a6337e6f	24	#include <u-boot/crc.h>
1895420b	25	#include <version.h>
a6337e6f DW	26
	27	#define CRC_SIZE sizeof(uint32_t)
	28
	29	static void usage(const char *exec_name)
	30	{
8a1b8fc7	31	fprintf(stderr, "%s [-h] [-r] [-b] [-p <byte>] -s <environment partition size> -o <output> <input file>\n"
a6337e6f	32	"\n"
8a1b8fc7	33	"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	34	"\n"
	35	"\tThe input file is in format:\n"
	36	"\t\tkey1=value1\n"
	37	"\t\tkey2=value2\n"
	38	"\t\t...\n"
e72be894 DM	39	"\tEmpty lines are skipped, and lines with a # in the first\n"
e72be894 DM	40	"\tcolumn are treated as comments (also skipped).\n"
a6337e6f DW	41	"\t-r : the environment has multiple copies in flash\n"
a6337e6f DW	42	"\t-b : the target is big endian (default is little endian)\n"
8a1b8fc7	43	"\t-p <byte> : fill the image with <byte> bytes instead of 0xff bytes\n"
1895420b	44	"\t-V : print version information and exit\n"
a6337e6f DW	45	"\n"
	46	"If the input file is \"-\", data is read from standard input\n",
	47	exec_name);
	48	}
	49
3d0f9bd0 DW	50	long int xstrtol(const char *s)
	51	{
	52	long int tmp;
	53
	54	errno = 0;
	55	tmp = strtol(s, NULL, 0);
	56	if (!errno)
	57	return tmp;
	58
	59	if (errno == ERANGE)
	60	fprintf(stderr, "Bad integer format: %s\n", s);
	61	else
	62	fprintf(stderr, "Error while parsing %s: %s\n", s,
	63	strerror(errno));
	64
	65	exit(EXIT_FAILURE);
	66	}
	67
849f9bef AP	68	#define CHUNK_SIZE 4096
849f9bef AP	69
a6337e6f DW	70	int main(int argc, char **argv)
	71	{
	72	uint32_t crc, targetendian_crc;
849f9bef	73	const char *bin_filename = NULL;
a6337e6f DW	74	int txt_fd, bin_fd;
	75	unsigned char dataptr, envptr;
	76	unsigned char *filebuf = NULL;
	77	unsigned int filesize = 0, envsize = 0, datasize = 0;
	78	int bigendian = 0;
	79	int redundant = 0;
	80	unsigned char padbyte = 0xff;
849f9bef	81	int readbytes = 0;
a6337e6f DW	82
	83	int option;
	84	int ret = EXIT_SUCCESS;
	85
a6337e6f	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	txt_fd = STDIN_FILENO;
a6337e6f	161	} else {
849f9bef	162	txt_fd = open(argv[optind], O_RDONLY);
a6337e6f DW	163	if (txt_fd == -1) {
a6337e6f DW	164	fprintf(stderr, "Can't open \"%s\": %s\n",
849f9bef	165	argv[optind], strerror(errno));
a6337e6f DW	166	return EXIT_FAILURE;
a6337e6f DW	167	}
849f9bef AP	168	}
	169
	170	do {
	171	filebuf = realloc(filebuf, filesize + CHUNK_SIZE);
	172	if (!filebuf) {
	173	fprintf(stderr, "Can't realloc memory for the input file buffer\n");
a6337e6f DW	174	return EXIT_FAILURE;
a6337e6f DW	175	}
849f9bef AP	176	readbytes = read(txt_fd, filebuf + filesize, CHUNK_SIZE);
	177	if (readbytes < 0) {
	178	fprintf(stderr, "Error while reading: %s\n",
	179	strerror(errno));
	180	return EXIT_FAILURE;
a6337e6f	181	}
849f9bef AP	182	filesize += readbytes;
	183	} while (readbytes > 0);
	184
	185	if (txt_fd != STDIN_FILENO)
a6337e6f	186	ret = close(txt_fd);
a6337e6f	187
80ee0196 BM	188	/* Parse a byte at time until reaching the file OR until the environment fills
	189	* up. Check ep against envsize - 1 to allow for extra trailing '\0'. */
	190	for (fp = 0, ep = 0 ; fp < filesize && ep < envsize - 1; fp++) {
a6337e6f	191	if (filebuf[fp] == '\n') {
e72be894	192	if (fp == 0 \|\| filebuf[fp-1] == '\n') {
a6337e6f	193	/*
e72be894	194	* Skip empty lines.
a6337e6f DW	195	*/
	196	continue;
	197	} else if (filebuf[fp-1] == '\\') {
	198	/*
	199	* Embedded newline in a variable.
	200	*
dbee61db DW	201	* The backslash was added to the envptr; rewind
dbee61db DW	202	* and replace it with a newline
a6337e6f DW	203	*/
	204	ep--;
	205	envptr[ep++] = '\n';
	206	} else {
	207	/* End of a variable */
	208	envptr[ep++] = '\0';
	209	}
e72be894 DM	210	} else if ((fp == 0 \|\| filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
	211	/* Comment, skip the line. */
	212	while (++fp < filesize && filebuf[fp] != '\n')
	213	continue;
a6337e6f DW	214	} else {
	215	envptr[ep++] = filebuf[fp];
	216	}
	217	}
80ee0196 BM	218	/* If there are more bytes in the file still, it means the env filled up
	219	* before parsing the whole file. Eat comments & whitespace here to see if
	220	* there was anything meaning full left in the file, and if so, throw a error
	221	* and exit. */
	222	for( ; fp < filesize; fp++ )
	223	{
	224	if (filebuf[fp] == '\n') {
	225	if (fp == 0 \|\| filebuf[fp-1] == '\n') {
	226	/* Ignore blank lines */
	227	continue;
	228	}
	229	} else if ((fp == 0 \|\| filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
	230	while (++fp < filesize && filebuf[fp] != '\n')
	231	continue;
	232	} else {
	233	fprintf(stderr, "The environment file is too large for the target environment storage\n");
	234	return EXIT_FAILURE;
	235	}
	236	}
a6337e6f DW	237	/*
	238	* Make sure there is a final '\0'
	239	* And do it again on the next byte to mark the end of the environment.
	240	*/
	241	if (envptr[ep-1] != '\0') {
	242	envptr[ep++] = '\0';
	243	/*
	244	* The text file doesn't have an ending newline. We need to
	245	* check the env size again to make sure we have room for two \0
	246	*/
	247	if (ep >= envsize) {
8a1b8fc7	248	fprintf(stderr, "The environment file is too large for the target environment storage\n");
a6337e6f DW	249	return EXIT_FAILURE;
	250	}
	251	envptr[ep] = '\0';
	252	} else {
	253	envptr[ep] = '\0';
	254	}
	255
	256	/* Computes the CRC and put it at the beginning of the data */
	257	crc = crc32(0, envptr, envsize);
	258	targetendian_crc = bigendian ? cpu_to_be32(crc) : cpu_to_le32(crc);
	259
d8d26599 DW	260	memcpy(dataptr, &targetendian_crc, sizeof(targetendian_crc));
	261	if (redundant)
	262	dataptr[sizeof(targetendian_crc)] = 1;
a6337e6f	263
48995b5a DW	264	if (!bin_filename \|\| strcmp(bin_filename, "-") == 0) {
	265	bin_fd = STDOUT_FILENO;
	266	} else {
4f7136e7 MF	267	bin_fd = creat(bin_filename, S_IRUSR \| S_IWUSR \| S_IRGRP \|
4f7136e7 MF	268	S_IWGRP);
48995b5a DW	269	if (bin_fd == -1) {
	270	fprintf(stderr, "Can't open output file \"%s\": %s\n",
	271	bin_filename, strerror(errno));
	272	return EXIT_FAILURE;
	273	}
a6337e6f DW	274	}
	275
	276	if (write(bin_fd, dataptr, sizeof(dataptr) datasize) !=
	277	sizeof(dataptr) datasize) {
	278	fprintf(stderr, "write() failed: %s\n", strerror(errno));
	279	return EXIT_FAILURE;
	280	}
	281
	282	ret = close(bin_fd);
	283
	284	return ret;
	285	}