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

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, filesize + 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 (readbytes < 0) {
				fprintf(stderr, "Error while reading stdin: %s\n",
						strerror(errno));
				return EXIT_FAILURE;
			}
			filesize += readbytes;
		} while (readbytes > 0);
	} 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
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
a6337e6f DW	68	int main(int argc, char **argv)
	69	{
	70	uint32_t crc, targetendian_crc;
	71	const char txt_filename = NULL, bin_filename = NULL;
	72	int txt_fd, bin_fd;
	73	unsigned char dataptr, envptr;
	74	unsigned char *filebuf = NULL;
	75	unsigned int filesize = 0, envsize = 0, datasize = 0;
	76	int bigendian = 0;
	77	int redundant = 0;
	78	unsigned char padbyte = 0xff;
	79
	80	int option;
	81	int ret = EXIT_SUCCESS;
	82
	83	struct stat txt_file_stat;
	84
	85	int fp, ep;
af44f4b2 HK	86	const char *prg;
	87
	88	prg = basename(argv[0]);
a6337e6f	89
5e0c63e2 HK	90	/* Turn off getopt()'s internal error message */
	91	opterr = 0;
	92
a6337e6f	93	/* Parse the cmdline */
1895420b	94	while ((option = getopt(argc, argv, ":s:o:rbp:hV")) != -1) {
a6337e6f DW	95	switch (option) {
a6337e6f DW	96	case 's':
3d0f9bd0	97	datasize = xstrtol(optarg);
a6337e6f DW	98	break;
	99	case 'o':
	100	bin_filename = strdup(optarg);
	101	if (!bin_filename) {
8a1b8fc7	102	fprintf(stderr, "Can't strdup() the output filename\n");
a6337e6f DW	103	return EXIT_FAILURE;
	104	}
	105	break;
	106	case 'r':
	107	redundant = 1;
	108	break;
	109	case 'b':
	110	bigendian = 1;
	111	break;
	112	case 'p':
3d0f9bd0	113	padbyte = xstrtol(optarg);
a6337e6f DW	114	break;
a6337e6f DW	115	case 'h':
af44f4b2	116	usage(prg);
a6337e6f	117	return EXIT_SUCCESS;
1895420b HK	118	case 'V':
	119	printf("%s version %s\n", prg, PLAIN_VERSION);
	120	return EXIT_SUCCESS;
5e0c63e2 HK	121	case ':':
5e0c63e2 HK	122	fprintf(stderr, "Missing argument for option -%c\n",
72ebafbe	123	optopt);
e758a5c4	124	usage(prg);
5e0c63e2	125	return EXIT_FAILURE;
a6337e6f	126	default:
72ebafbe	127	fprintf(stderr, "Wrong option -%c\n", optopt);
af44f4b2	128	usage(prg);
a6337e6f DW	129	return EXIT_FAILURE;
	130	}
	131	}
	132
	133	/* Check datasize and allocate the data */
	134	if (datasize == 0) {
8a1b8fc7	135	fprintf(stderr, "Please specify the size of the environment partition.\n");
af44f4b2	136	usage(prg);
a6337e6f DW	137	return EXIT_FAILURE;
	138	}
	139
	140	dataptr = malloc(datasize * sizeof(*dataptr));
	141	if (!dataptr) {
8a1b8fc7 DW	142	fprintf(stderr, "Can't alloc %d bytes for dataptr.\n",
8a1b8fc7 DW	143	datasize);
a6337e6f DW	144	return EXIT_FAILURE;
	145	}
	146
	147	/*
	148	* envptr points to the beginning of the actual environment (after the
8a1b8fc7	149	* crc and possible `redundant' byte
a6337e6f DW	150	*/
	151	envsize = datasize - (CRC_SIZE + redundant);
	152	envptr = dataptr + CRC_SIZE + redundant;
	153
	154	/* Pad the environment with the padding byte */
	155	memset(envptr, padbyte, envsize);
	156
	157	/* Open the input file ... */
48995b5a	158	if (optind >= argc \|\| strcmp(argv[optind], "-") == 0) {
a6337e6f	159	int readbytes = 0;
48995b5a	160	int readlen = sizeof(envptr) 4096;
a6337e6f DW	161	txt_fd = STDIN_FILENO;
	162
	163	do {
c3b115f4	164	filebuf = realloc(filebuf, filesize + readlen);
3d0f9bd0 DW	165	if (!filebuf) {
	166	fprintf(stderr, "Can't realloc memory for the input file buffer\n");
	167	return EXIT_FAILURE;
	168	}
a6337e6f	169	readbytes = read(txt_fd, filebuf + filesize, readlen);
3559028c	170	if (readbytes < 0) {
3d0f9bd0 DW	171	fprintf(stderr, "Error while reading stdin: %s\n",
	172	strerror(errno));
	173	return EXIT_FAILURE;
	174	}
a6337e6f	175	filesize += readbytes;
40e7b3ce	176	} while (readbytes > 0);
a6337e6f	177	} else {
48995b5a	178	txt_filename = argv[optind];
a6337e6f DW	179	txt_fd = open(txt_filename, O_RDONLY);
	180	if (txt_fd == -1) {
	181	fprintf(stderr, "Can't open \"%s\": %s\n",
	182	txt_filename, strerror(errno));
	183	return EXIT_FAILURE;
	184	}
	185	/* ... and check it */
	186	ret = fstat(txt_fd, &txt_file_stat);
	187	if (ret == -1) {
8a1b8fc7 DW	188	fprintf(stderr, "Can't stat() on \"%s\": %s\n",
8a1b8fc7 DW	189	txt_filename, strerror(errno));
a6337e6f DW	190	return EXIT_FAILURE;
	191	}
	192
	193	filesize = txt_file_stat.st_size;
6ee39f80 DW	194
	195	filebuf = mmap(NULL, sizeof(envptr) filesize, PROT_READ,
	196	MAP_PRIVATE, txt_fd, 0);
	197	if (filebuf == MAP_FAILED) {
1ebff63f	198	fprintf(stderr, "mmap (%zu bytes) failed: %s\n",
6ee39f80 DW	199	sizeof(envptr) filesize,
	200	strerror(errno));
	201	fprintf(stderr, "Falling back to read()\n");
	202
	203	filebuf = malloc(sizeof(envptr) filesize);
	204	ret = read(txt_fd, filebuf, sizeof(envptr) filesize);
	205	if (ret != sizeof(envptr) filesize) {
1ebff63f	206	fprintf(stderr, "Can't read the whole input file (%zu bytes): %s\n",
6ee39f80 DW	207	sizeof(envptr) filesize,
	208	strerror(errno));
	209
	210	return EXIT_FAILURE;
	211	}
a6337e6f DW	212	}
	213	ret = close(txt_fd);
	214	}
a6337e6f	215
80ee0196 BM	216	/* Parse a byte at time until reaching the file OR until the environment fills
	217	* up. Check ep against envsize - 1 to allow for extra trailing '\0'. */
	218	for (fp = 0, ep = 0 ; fp < filesize && ep < envsize - 1; fp++) {
a6337e6f	219	if (filebuf[fp] == '\n') {
e72be894	220	if (fp == 0 \|\| filebuf[fp-1] == '\n') {
a6337e6f	221	/*
e72be894	222	* Skip empty lines.
a6337e6f DW	223	*/
	224	continue;
	225	} else if (filebuf[fp-1] == '\\') {
	226	/*
	227	* Embedded newline in a variable.
	228	*
dbee61db DW	229	* The backslash was added to the envptr; rewind
dbee61db DW	230	* and replace it with a newline
a6337e6f DW	231	*/
	232	ep--;
	233	envptr[ep++] = '\n';
	234	} else {
	235	/* End of a variable */
	236	envptr[ep++] = '\0';
	237	}
e72be894 DM	238	} else if ((fp == 0 \|\| filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
	239	/* Comment, skip the line. */
	240	while (++fp < filesize && filebuf[fp] != '\n')
	241	continue;
a6337e6f DW	242	} else {
	243	envptr[ep++] = filebuf[fp];
	244	}
	245	}
80ee0196 BM	246	/* If there are more bytes in the file still, it means the env filled up
	247	* before parsing the whole file. Eat comments & whitespace here to see if
	248	* there was anything meaning full left in the file, and if so, throw a error
	249	* and exit. */
	250	for( ; fp < filesize; fp++ )
	251	{
	252	if (filebuf[fp] == '\n') {
	253	if (fp == 0 \|\| filebuf[fp-1] == '\n') {
	254	/* Ignore blank lines */
	255	continue;
	256	}
	257	} else if ((fp == 0 \|\| filebuf[fp-1] == '\n') && filebuf[fp] == '#') {
	258	while (++fp < filesize && filebuf[fp] != '\n')
	259	continue;
	260	} else {
	261	fprintf(stderr, "The environment file is too large for the target environment storage\n");
	262	return EXIT_FAILURE;
	263	}
	264	}
a6337e6f DW	265	/*
	266	* Make sure there is a final '\0'
	267	* And do it again on the next byte to mark the end of the environment.
	268	*/
	269	if (envptr[ep-1] != '\0') {
	270	envptr[ep++] = '\0';
	271	/*
	272	* The text file doesn't have an ending newline. We need to
	273	* check the env size again to make sure we have room for two \0
	274	*/
	275	if (ep >= envsize) {
8a1b8fc7	276	fprintf(stderr, "The environment file is too large for the target environment storage\n");
a6337e6f DW	277	return EXIT_FAILURE;
	278	}
	279	envptr[ep] = '\0';
	280	} else {
	281	envptr[ep] = '\0';
	282	}
	283
	284	/* Computes the CRC and put it at the beginning of the data */
	285	crc = crc32(0, envptr, envsize);
	286	targetendian_crc = bigendian ? cpu_to_be32(crc) : cpu_to_le32(crc);
	287
d8d26599 DW	288	memcpy(dataptr, &targetendian_crc, sizeof(targetendian_crc));
	289	if (redundant)
	290	dataptr[sizeof(targetendian_crc)] = 1;
a6337e6f	291
48995b5a DW	292	if (!bin_filename \|\| strcmp(bin_filename, "-") == 0) {
	293	bin_fd = STDOUT_FILENO;
	294	} else {
4f7136e7 MF	295	bin_fd = creat(bin_filename, S_IRUSR \| S_IWUSR \| S_IRGRP \|
4f7136e7 MF	296	S_IWGRP);
48995b5a DW	297	if (bin_fd == -1) {
	298	fprintf(stderr, "Can't open output file \"%s\": %s\n",
	299	bin_filename, strerror(errno));
	300	return EXIT_FAILURE;
	301	}
a6337e6f DW	302	}
	303
	304	if (write(bin_fd, dataptr, sizeof(dataptr) datasize) !=
	305	sizeof(dataptr) datasize) {
	306	fprintf(stderr, "write() failed: %s\n", strerror(errno));
	307	return EXIT_FAILURE;
	308	}
	309
	310	ret = close(bin_fd);
	311
	312	return ret;
	313	}