[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
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

/* We want the GNU version of basename() */
#define _GNU_SOURCE

#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.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"
	       "\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) {
		fprintf(stderr, "Please specify an input filename\n");
		return EXIT_FAILURE;
	}

	txt_filename = argv[optind];
	if (strcmp(txt_filename, "-") == 0) {
		int readbytes = 0;
		int readlen = sizeof(*envptr) * 2048;
		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_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;
		/* Read the raw input file and transform it */
		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\n");
			return EXIT_FAILURE;
		}
		ret = close(txt_fd);
	}
	/* The +1 is for the additionnal ending \0. See below. */
	if (filesize + 1 > envsize) {
		fprintf(stderr, "The input file is larger than the environment partition size\n");
		return EXIT_FAILURE;
	}

	/* Replace newlines separating variables with \0 */
	for (fp = 0, ep = 0 ; fp < filesize ; fp++) {
		if (filebuf[fp] == '\n') {
			if (ep == 0) {
				/*
				 * Newlines at the beginning of the file ?
				 * Ignore them.
				 */
				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 (filebuf[fp] == '#') {
			if (fp != 0 && filebuf[fp-1] == '\n') {
				/* This line is a comment, let's skip it */
				while (fp < txt_file_stat.st_size && fp++ &&
				       filebuf[fp] != '\n');
			} else {
				envptr[ep++] = filebuf[fp];
			}
		} else {
			envptr[ep++] = filebuf[fp];
		}
	}
	/*
	 * 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(uint32_t));

	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	*
	9	* See file CREDITS for list of people who contributed to this
	10	* project.
	11	*
	12	* This program is free software; you can redistribute it and/or
	13	* modify it under the terms of the GNU General Public License as
	14	* published by the Free Software Foundation; either version 2 of
	15	* the License, or (at your option) any later version.
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	25	* MA 02111-1307 USA
	26	*/
	27
af44f4b2 HK	28	/* We want the GNU version of basename() */
	29	#define _GNU_SOURCE
	30
a6337e6f DW	31	#include <errno.h>
	32	#include <fcntl.h>
	33	#include <stdio.h>
d1acdae9	34	#include <stdlib.h>
a6337e6f DW	35	#include <stdint.h>
	36	#include <string.h>
	37	#include <unistd.h>
a6337e6f DW	38	#include <sys/types.h>
	39	#include <sys/stat.h>
	40
d1acdae9	41	#include "compiler.h"
a6337e6f	42	#include <u-boot/crc.h>
1895420b	43	#include <version.h>
a6337e6f DW	44
	45	#define CRC_SIZE sizeof(uint32_t)
	46
	47	static void usage(const char *exec_name)
	48	{
8a1b8fc7	49	fprintf(stderr, "%s [-h] [-r] [-b] [-p <byte>] -s <environment partition size> -o <output> <input file>\n"
a6337e6f	50	"\n"
8a1b8fc7	51	"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	52	"\n"
	53	"\tThe input file is in format:\n"
	54	"\t\tkey1=value1\n"
	55	"\t\tkey2=value2\n"
	56	"\t\t...\n"
	57	"\t-r : the environment has multiple copies in flash\n"
	58	"\t-b : the target is big endian (default is little endian)\n"
8a1b8fc7	59	"\t-p <byte> : fill the image with <byte> bytes instead of 0xff bytes\n"
1895420b	60	"\t-V : print version information and exit\n"
a6337e6f DW	61	"\n"
	62	"If the input file is \"-\", data is read from standard input\n",
	63	exec_name);
	64	}
	65
3d0f9bd0 DW	66	long int xstrtol(const char *s)
	67	{
	68	long int tmp;
	69
	70	errno = 0;
	71	tmp = strtol(s, NULL, 0);
	72	if (!errno)
	73	return tmp;
	74
	75	if (errno == ERANGE)
	76	fprintf(stderr, "Bad integer format: %s\n", s);
	77	else
	78	fprintf(stderr, "Error while parsing %s: %s\n", s,
	79	strerror(errno));
	80
	81	exit(EXIT_FAILURE);
	82	}
	83
a6337e6f DW	84	int main(int argc, char **argv)
	85	{
	86	uint32_t crc, targetendian_crc;
	87	const char txt_filename = NULL, bin_filename = NULL;
	88	int txt_fd, bin_fd;
	89	unsigned char dataptr, envptr;
	90	unsigned char *filebuf = NULL;
	91	unsigned int filesize = 0, envsize = 0, datasize = 0;
	92	int bigendian = 0;
	93	int redundant = 0;
	94	unsigned char padbyte = 0xff;
	95
	96	int option;
	97	int ret = EXIT_SUCCESS;
	98
	99	struct stat txt_file_stat;
	100
	101	int fp, ep;
af44f4b2 HK	102	const char *prg;
	103
	104	prg = basename(argv[0]);
a6337e6f	105
5e0c63e2 HK	106	/* Turn off getopt()'s internal error message */
	107	opterr = 0;
	108
a6337e6f	109	/* Parse the cmdline */
1895420b	110	while ((option = getopt(argc, argv, ":s:o:rbp:hV")) != -1) {
a6337e6f DW	111	switch (option) {
a6337e6f DW	112	case 's':
3d0f9bd0	113	datasize = xstrtol(optarg);
a6337e6f DW	114	break;
	115	case 'o':
	116	bin_filename = strdup(optarg);
	117	if (!bin_filename) {
8a1b8fc7	118	fprintf(stderr, "Can't strdup() the output filename\n");
a6337e6f DW	119	return EXIT_FAILURE;
	120	}
	121	break;
	122	case 'r':
	123	redundant = 1;
	124	break;
	125	case 'b':
	126	bigendian = 1;
	127	break;
	128	case 'p':
3d0f9bd0	129	padbyte = xstrtol(optarg);
a6337e6f DW	130	break;
a6337e6f DW	131	case 'h':
af44f4b2	132	usage(prg);
a6337e6f	133	return EXIT_SUCCESS;
1895420b HK	134	case 'V':
	135	printf("%s version %s\n", prg, PLAIN_VERSION);
	136	return EXIT_SUCCESS;
5e0c63e2 HK	137	case ':':
5e0c63e2 HK	138	fprintf(stderr, "Missing argument for option -%c\n",
72ebafbe	139	optopt);
e758a5c4	140	usage(prg);
5e0c63e2	141	return EXIT_FAILURE;
a6337e6f	142	default:
72ebafbe	143	fprintf(stderr, "Wrong option -%c\n", optopt);
af44f4b2	144	usage(prg);
a6337e6f DW	145	return EXIT_FAILURE;
	146	}
	147	}
	148
	149	/* Check datasize and allocate the data */
	150	if (datasize == 0) {
8a1b8fc7	151	fprintf(stderr, "Please specify the size of the environment partition.\n");
af44f4b2	152	usage(prg);
a6337e6f DW	153	return EXIT_FAILURE;
	154	}
	155
	156	dataptr = malloc(datasize * sizeof(*dataptr));
	157	if (!dataptr) {
8a1b8fc7 DW	158	fprintf(stderr, "Can't alloc %d bytes for dataptr.\n",
8a1b8fc7 DW	159	datasize);
a6337e6f DW	160	return EXIT_FAILURE;
	161	}
	162
	163	/*
	164	* envptr points to the beginning of the actual environment (after the
8a1b8fc7	165	* crc and possible `redundant' byte
a6337e6f DW	166	*/
	167	envsize = datasize - (CRC_SIZE + redundant);
	168	envptr = dataptr + CRC_SIZE + redundant;
	169
	170	/* Pad the environment with the padding byte */
	171	memset(envptr, padbyte, envsize);
	172
	173	/* Open the input file ... */
	174	if (optind >= argc) {
	175	fprintf(stderr, "Please specify an input filename\n");
	176	return EXIT_FAILURE;
	177	}
	178
	179	txt_filename = argv[optind];
	180	if (strcmp(txt_filename, "-") == 0) {
	181	int readbytes = 0;
	182	int readlen = sizeof(envptr) 2048;
	183	txt_fd = STDIN_FILENO;
	184
	185	do {
	186	filebuf = realloc(filebuf, readlen);
3d0f9bd0 DW	187	if (!filebuf) {
	188	fprintf(stderr, "Can't realloc memory for the input file buffer\n");
	189	return EXIT_FAILURE;
	190	}
a6337e6f	191	readbytes = read(txt_fd, filebuf + filesize, readlen);
3d0f9bd0 DW	192	if (errno) {
	193	fprintf(stderr, "Error while reading stdin: %s\n",
	194	strerror(errno));
	195	return EXIT_FAILURE;
	196	}
a6337e6f DW	197	filesize += readbytes;
	198	} while (readbytes == readlen);
	199
	200	} else {
	201	txt_fd = open(txt_filename, O_RDONLY);
	202	if (txt_fd == -1) {
	203	fprintf(stderr, "Can't open \"%s\": %s\n",
	204	txt_filename, strerror(errno));
	205	return EXIT_FAILURE;
	206	}
	207	/* ... and check it */
	208	ret = fstat(txt_fd, &txt_file_stat);
	209	if (ret == -1) {
8a1b8fc7 DW	210	fprintf(stderr, "Can't stat() on \"%s\": %s\n",
8a1b8fc7 DW	211	txt_filename, strerror(errno));
a6337e6f DW	212	return EXIT_FAILURE;
	213	}
	214
	215	filesize = txt_file_stat.st_size;
	216	/* Read the raw input file and transform it */
	217	filebuf = malloc(sizeof(envptr) filesize);
	218	ret = read(txt_fd, filebuf, sizeof(envptr) filesize);
	219	if (ret != sizeof(envptr) filesize) {
	220	fprintf(stderr, "Can't read the whole input file\n");
	221	return EXIT_FAILURE;
	222	}
	223	ret = close(txt_fd);
	224	}
8a1b8fc7 DW	225	/* The +1 is for the additionnal ending \0. See below. */
	226	if (filesize + 1 > envsize) {
	227	fprintf(stderr, "The input file is larger than the environment partition size\n");
a6337e6f DW	228	return EXIT_FAILURE;
	229	}
	230
	231	/* Replace newlines separating variables with \0 */
	232	for (fp = 0, ep = 0 ; fp < filesize ; fp++) {
	233	if (filebuf[fp] == '\n') {
dbee61db	234	if (ep == 0) {
a6337e6f	235	/*
dbee61db DW	236	* Newlines at the beginning of the file ?
dbee61db DW	237	* Ignore them.
a6337e6f DW	238	*/
	239	continue;
	240	} else if (filebuf[fp-1] == '\\') {
	241	/*
	242	* Embedded newline in a variable.
	243	*
dbee61db DW	244	* The backslash was added to the envptr; rewind
dbee61db DW	245	* and replace it with a newline
a6337e6f DW	246	*/
	247	ep--;
	248	envptr[ep++] = '\n';
	249	} else {
	250	/* End of a variable */
	251	envptr[ep++] = '\0';
	252	}
	253	} else if (filebuf[fp] == '#') {
	254	if (fp != 0 && filebuf[fp-1] == '\n') {
	255	/* This line is a comment, let's skip it */
	256	while (fp < txt_file_stat.st_size && fp++ &&
	257	filebuf[fp] != '\n');
	258	} else {
	259	envptr[ep++] = filebuf[fp];
	260	}
	261	} else {
	262	envptr[ep++] = filebuf[fp];
	263	}
	264	}
	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
	288	memcpy(dataptr, &targetendian_crc, sizeof(uint32_t));
	289
	290	bin_fd = creat(bin_filename, S_IRUSR \| S_IWUSR \| S_IRGRP \| S_IWGRP);
	291	if (bin_fd == -1) {
	292	fprintf(stderr, "Can't open output file \"%s\": %s\n",
	293	bin_filename, strerror(errno));
	294	return EXIT_FAILURE;
	295	}
	296
	297	if (write(bin_fd, dataptr, sizeof(dataptr) datasize) !=
	298	sizeof(dataptr) datasize) {
	299	fprintf(stderr, "write() failed: %s\n", strerror(errno));
	300	return EXIT_FAILURE;
	301	}
	302
	303	ret = close(bin_fd);
	304
	305	return ret;
	306	}