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

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2011 Free Electrons
 * David Wagner <[email protected]>
 *
 * Inspired from envcrc.c:
 * (C) Copyright 2001
 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), [email protected]
 */

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