[deliverable/linux.git] / firmware / ihex2fw.c

/*
 * Parser/loader for IHEX formatted data.
 *
 * Copyright © 2008 David Woodhouse <dwmw2@infradead.org>
 * Copyright © 2005 Jan Harkes <jaharkes@cs.cmu.edu>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <stdint.h>
#include <arpa/inet.h>
#include <stdio.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/mman.h>
#include <fcntl.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#define _GNU_SOURCE
#include <getopt.h>


struct ihex_binrec {
	struct ihex_binrec *next; /* not part of the real data structure */
        uint32_t addr;
        uint16_t len;
        uint8_t data[];
};

/**
 * nybble/hex are little helpers to parse hexadecimal numbers to a byte value
 **/
static uint8_t nybble(const uint8_t n)
{
       if      (n >= '0' && n <= '9') return n - '0';
       else if (n >= 'A' && n <= 'F') return n - ('A' - 10);
       else if (n >= 'a' && n <= 'f') return n - ('a' - 10);
       return 0;
}

static uint8_t hex(const uint8_t *data, uint8_t *crc)
{
       uint8_t val = (nybble(data[0]) << 4) | nybble(data[1]);
       *crc += val;
       return val;
}

static int process_ihex(uint8_t *data, ssize_t size);
static void file_record(struct ihex_binrec *record);
static int output_records(int outfd);

static int sort_records = 0;
static int wide_records = 0;
static int include_jump = 0;

static int usage(void)
{
	fprintf(stderr, "ihex2fw: Convert ihex files into binary "
		"representation for use by Linux kernel\n");
	fprintf(stderr, "usage: ihex2fw [<options>] <src.HEX> <dst.fw>\n");
	fprintf(stderr, "       -w: wide records (16-bit length)\n");
	fprintf(stderr, "       -s: sort records by address\n");
	fprintf(stderr, "       -j: include records for CS:IP/EIP address\n");
	return 1;
}

int main(int argc, char **argv)
{
	int infd, outfd;
	struct stat st;
	uint8_t *data;
	int opt;

	while ((opt = getopt(argc, argv, "wsj")) != -1) {
		switch (opt) {
		case 'w':
			wide_records = 1;
			break;
		case 's':
			sort_records = 1;
			break;
		case 'j':
			include_jump = 1;
			break;
		default:
			return usage();
		}
	}

	if (optind + 2 != argc)
		return usage();

	if (!strcmp(argv[optind], "-"))
	    infd = 0;
	else
		infd = open(argv[optind], O_RDONLY);
	if (infd == -1) {
		fprintf(stderr, "Failed to open source file: %s",
			strerror(errno));
		return usage();
	}
	if (fstat(infd, &st)) {
		perror("stat");
		return 1;
	}
	data = mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, infd, 0);
	if (data == MAP_FAILED) {
		perror("mmap");
		return 1;
	}

	if (!strcmp(argv[optind+1], "-"))
	    outfd = 1;
	else
		outfd = open(argv[optind+1], O_TRUNC|O_CREAT|O_WRONLY, 0644);
	if (outfd == -1) {
		fprintf(stderr, "Failed to open destination file: %s",
			strerror(errno));
		return usage();
	}
	if (process_ihex(data, st.st_size))
		return 1;

	return output_records(outfd);
}

static int process_ihex(uint8_t *data, ssize_t size)
{
	struct ihex_binrec *record;
	uint32_t offset = 0;
	uint32_t data32;
	uint8_t type, crc = 0, crcbyte = 0;
	int i, j;
	int line = 1;
	int len;

	i = 0;
next_record:
	/* search for the start of record character */
	while (i < size) {
		if (data[i] == '\n') line++;
		if (data[i++] == ':') break;
	}

	/* Minimum record length would be about 10 characters */
	if (i + 10 > size) {
		fprintf(stderr, "Can't find valid record at line %d\n", line);
		return -EINVAL;
	}

	len = hex(data + i, &crc); i += 2;
	if (wide_records) {
		len <<= 8;
		len += hex(data + i, &crc); i += 2;
	}
	record = malloc((sizeof (*record) + len + 3) & ~3);
	if (!record) {
		fprintf(stderr, "out of memory for records\n");
		return -ENOMEM;
	}
	memset(record, 0, (sizeof(*record) + len + 3) & ~3);
	record->len = len;

	/* now check if we have enough data to read everything */
	if (i + 8 + (record->len * 2) > size) {
		fprintf(stderr, "Not enough data to read complete record at line %d\n",
			line);
		return -EINVAL;
	}

	record->addr  = hex(data + i, &crc) << 8; i += 2;
	record->addr |= hex(data + i, &crc); i += 2;
	type = hex(data + i, &crc); i += 2;

	for (j = 0; j < record->len; j++, i += 2)
		record->data[j] = hex(data + i, &crc);

	/* check CRC */
	crcbyte = hex(data + i, &crc); i += 2;
	if (crc != 0) {
		fprintf(stderr, "CRC failure at line %d: got 0x%X, expected 0x%X\n",
			line, crcbyte, (unsigned char)(crcbyte-crc));
		return -EINVAL;
	}

	/* Done reading the record */
	switch (type) {
	case 0:
		/* old style EOF record? */
		if (!record->len)
			break;

		record->addr += offset;
		file_record(record);
		goto next_record;

	case 1: /* End-Of-File Record */
		if (record->addr || record->len) {
			fprintf(stderr, "Bad EOF record (type 01) format at line %d",
				line);
			return -EINVAL;
		}
		break;

	case 2: /* Extended Segment Address Record (HEX86) */
	case 4: /* Extended Linear Address Record (HEX386) */
		if (record->addr || record->len != 2) {
			fprintf(stderr, "Bad HEX86/HEX386 record (type %02X) at line %d\n",
				type, line);
			return -EINVAL;
		}

		/* We shouldn't really be using the offset for HEX86 because
		 * the wraparound case is specified quite differently. */
		offset = record->data[0] << 8 | record->data[1];
		offset <<= (type == 2 ? 4 : 16);
		goto next_record;

	case 3: /* Start Segment Address Record */
	case 5: /* Start Linear Address Record */
		if (record->addr || record->len != 4) {
			fprintf(stderr, "Bad Start Address record (type %02X) at line %d\n",
				type, line);
			return -EINVAL;
		}

		memcpy(&data32, &record->data[0], sizeof(data32));
		data32 = htonl(data32);
		memcpy(&record->data[0], &data32, sizeof(data32));

		/* These records contain the CS/IP or EIP where execution
		 * starts. If requested output this as a record. */
		if (include_jump)
			file_record(record);
		goto next_record;

	default:
		fprintf(stderr, "Unknown record (type %02X)\n", type);
		return -EINVAL;
	}

	return 0;
}

static struct ihex_binrec *records;

static void file_record(struct ihex_binrec *record)
{
	struct ihex_binrec **p = &records;

	while ((*p) && (!sort_records || (*p)->addr < record->addr))
		p = &((*p)->next);

	record->next = *p;
	*p = record;
}

static int output_records(int outfd)
{
	unsigned char zeroes[6] = {0, 0, 0, 0, 0, 0};
	struct ihex_binrec *p = records;

	while (p) {
		uint16_t writelen = (p->len + 9) & ~3;

		p->addr = htonl(p->addr);
		p->len = htons(p->len);
		if (write(outfd, &p->addr, writelen) != writelen)
			return 1;
		p = p->next;
	}
	/* EOF record is zero length, since we don't bother to represent
	   the type field in the binary version */
	if (write(outfd, zeroes, 6) != 6)
		return 1;
	return 0;
}
Commit	Line	Data
8bd6b222 DW	1	/*
	2	* Parser/loader for IHEX formatted data.
	3	*
	4	* Copyright © 2008 David Woodhouse <dwmw2@infradead.org>
	5	* Copyright © 2005 Jan Harkes <jaharkes@cs.cmu.edu>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11
	12	#include <stdint.h>
	13	#include <arpa/inet.h>
	14	#include <stdio.h>
	15	#include <errno.h>
	16	#include <sys/types.h>
	17	#include <sys/stat.h>
	18	#include <sys/mman.h>
	19	#include <fcntl.h>
	20	#include <string.h>
	21	#include <unistd.h>
	22	#include <stdlib.h>
59890f74 DW	23	#define _GNU_SOURCE
	24	#include <getopt.h>
	25
8bd6b222 DW	26
	27	struct ihex_binrec {
	28	struct ihex_binrec next; / not part of the real data structure */
	29	uint32_t addr;
	30	uint16_t len;
	31	uint8_t data[];
	32	};
	33
	34	/**
	35	* nybble/hex are little helpers to parse hexadecimal numbers to a byte value
	36	**/
	37	static uint8_t nybble(const uint8_t n)
	38	{
	39	if (n >= '0' && n <= '9') return n - '0';
	40	else if (n >= 'A' && n <= 'F') return n - ('A' - 10);
	41	else if (n >= 'a' && n <= 'f') return n - ('a' - 10);
	42	return 0;
	43	}
	44
	45	static uint8_t hex(const uint8_t data, uint8_t crc)
	46	{
	47	uint8_t val = (nybble(data[0]) << 4) \| nybble(data[1]);
	48	*crc += val;
	49	return val;
	50	}
	51
	52	static int process_ihex(uint8_t *data, ssize_t size);
	53	static void file_record(struct ihex_binrec *record);
	54	static int output_records(int outfd);
	55
	56	static int sort_records = 0;
59890f74	57	static int wide_records = 0;
2473238e	58	static int include_jump = 0;
59890f74	59
b7ed698c	60	static int usage(void)
59890f74 DW	61	{
	62	fprintf(stderr, "ihex2fw: Convert ihex files into binary "
	63	"representation for use by Linux kernel\n");
	64	fprintf(stderr, "usage: ihex2fw [<options>] <src.HEX> <dst.fw>\n");
	65	fprintf(stderr, " -w: wide records (16-bit length)\n");
	66	fprintf(stderr, " -s: sort records by address\n");
2473238e	67	fprintf(stderr, " -j: include records for CS:IP/EIP address\n");
59890f74 DW	68	return 1;
59890f74 DW	69	}
8bd6b222 DW	70
	71	int main(int argc, char **argv)
	72	{
	73	int infd, outfd;
	74	struct stat st;
	75	uint8_t *data;
59890f74 DW	76	int opt;
59890f74 DW	77
2473238e	78	while ((opt = getopt(argc, argv, "wsj")) != -1) {
59890f74 DW	79	switch (opt) {
	80	case 'w':
	81	wide_records = 1;
	82	break;
	83	case 's':
	84	sort_records = 1;
	85	break;
2473238e MB	86	case 'j':
	87	include_jump = 1;
	88	break;
d43698e8	89	default:
59890f74 DW	90	return usage();
59890f74 DW	91	}
8bd6b222	92	}
59890f74 DW	93
	94	if (optind + 2 != argc)
	95	return usage();
	96
	97	if (!strcmp(argv[optind], "-"))
8bd6b222 DW	98	infd = 0;
8bd6b222 DW	99	else
59890f74	100	infd = open(argv[optind], O_RDONLY);
8bd6b222 DW	101	if (infd == -1) {
	102	fprintf(stderr, "Failed to open source file: %s",
	103	strerror(errno));
59890f74	104	return usage();
8bd6b222 DW	105	}
	106	if (fstat(infd, &st)) {
	107	perror("stat");
	108	return 1;
	109	}
	110	data = mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, infd, 0);
	111	if (data == MAP_FAILED) {
	112	perror("mmap");
	113	return 1;
	114	}
	115
59890f74	116	if (!strcmp(argv[optind+1], "-"))
8bd6b222 DW	117	outfd = 1;
8bd6b222 DW	118	else
59890f74	119	outfd = open(argv[optind+1], O_TRUNC\|O_CREAT\|O_WRONLY, 0644);
8bd6b222 DW	120	if (outfd == -1) {
	121	fprintf(stderr, "Failed to open destination file: %s",
	122	strerror(errno));
59890f74	123	return usage();
8bd6b222 DW	124	}
	125	if (process_ihex(data, st.st_size))
	126	return 1;
	127
b8cb464e	128	return output_records(outfd);
8bd6b222 DW	129	}
	130
	131	static int process_ihex(uint8_t *data, ssize_t size)
	132	{
	133	struct ihex_binrec *record;
	134	uint32_t offset = 0;
2473238e	135	uint32_t data32;
8bd6b222 DW	136	uint8_t type, crc = 0, crcbyte = 0;
	137	int i, j;
	138	int line = 1;
	139	int len;
	140
	141	i = 0;
	142	next_record:
	143	/* search for the start of record character */
	144	while (i < size) {
	145	if (data[i] == '\n') line++;
	146	if (data[i++] == ':') break;
	147	}
	148
	149	/* Minimum record length would be about 10 characters */
	150	if (i + 10 > size) {
	151	fprintf(stderr, "Can't find valid record at line %d\n", line);
	152	return -EINVAL;
	153	}
	154
	155	len = hex(data + i, &crc); i += 2;
59890f74 DW	156	if (wide_records) {
	157	len <<= 8;
	158	len += hex(data + i, &crc); i += 2;
	159	}
8bd6b222 DW	160	record = malloc((sizeof (*record) + len + 3) & ~3);
	161	if (!record) {
	162	fprintf(stderr, "out of memory for records\n");
	163	return -ENOMEM;
	164	}
	165	memset(record, 0, (sizeof(*record) + len + 3) & ~3);
	166	record->len = len;
	167
	168	/* now check if we have enough data to read everything */
	169	if (i + 8 + (record->len * 2) > size) {
	170	fprintf(stderr, "Not enough data to read complete record at line %d\n",
	171	line);
	172	return -EINVAL;
	173	}
	174
	175	record->addr = hex(data + i, &crc) << 8; i += 2;
	176	record->addr \|= hex(data + i, &crc); i += 2;
	177	type = hex(data + i, &crc); i += 2;
	178
	179	for (j = 0; j < record->len; j++, i += 2)
	180	record->data[j] = hex(data + i, &crc);
	181
	182	/* check CRC */
	183	crcbyte = hex(data + i, &crc); i += 2;
	184	if (crc != 0) {
	185	fprintf(stderr, "CRC failure at line %d: got 0x%X, expected 0x%X\n",
	186	line, crcbyte, (unsigned char)(crcbyte-crc));
	187	return -EINVAL;
	188	}
	189
	190	/* Done reading the record */
	191	switch (type) {
	192	case 0:
	193	/* old style EOF record? */
	194	if (!record->len)
	195	break;
	196
	197	record->addr += offset;
	198	file_record(record);
	199	goto next_record;
	200
	201	case 1: /* End-Of-File Record */
	202	if (record->addr \|\| record->len) {
	203	fprintf(stderr, "Bad EOF record (type 01) format at line %d",
	204	line);
	205	return -EINVAL;
	206	}
	207	break;
	208
	209	case 2: /* Extended Segment Address Record (HEX86) */
	210	case 4: /* Extended Linear Address Record (HEX386) */
	211	if (record->addr \|\| record->len != 2) {
	212	fprintf(stderr, "Bad HEX86/HEX386 record (type %02X) at line %d\n",
	213	type, line);
	214	return -EINVAL;
	215	}
	216
	217	/* We shouldn't really be using the offset for HEX86 because
	218	* the wraparound case is specified quite differently. */
	219	offset = record->data[0] << 8 \| record->data[1];
	220	offset <<= (type == 2 ? 4 : 16);
	221	goto next_record;
	222
	223	case 3: /* Start Segment Address Record */
224	case 5: /* Start Linear Address Record */
225	if (record->addr \|\| record->len != 4) {
226	fprintf(stderr, "Bad Start Address record (type %02X) at line %d\n",
227	type, line);
228	return -EINVAL;
229	}
230
2473238e MB	231	memcpy(&data32, &record->data[0], sizeof(data32));
	232	data32 = htonl(data32);
	233	memcpy(&record->data[0], &data32, sizeof(data32));
	234
8bd6b222	235	/* These records contain the CS/IP or EIP where execution
2473238e MB	236	* starts. If requested output this as a record. */
	237	if (include_jump)
	238	file_record(record);
8bd6b222 DW	239	goto next_record;
	240
	241	default:
	242	fprintf(stderr, "Unknown record (type %02X)\n", type);
	243	return -EINVAL;
	244	}
	245
	246	return 0;
	247	}
	248
	249	static struct ihex_binrec *records;
	250
	251	static void file_record(struct ihex_binrec *record)
	252	{
	253	struct ihex_binrec **p = &records;
	254
	255	while ((p) && (!sort_records \|\| (p)->addr < record->addr))
	256	p = &((*p)->next);
	257
	258	record->next = *p;
	259	*p = record;
	260	}
	261
	262	static int output_records(int outfd)
	263	{
85ebd003	264	unsigned char zeroes[6] = {0, 0, 0, 0, 0, 0};
8bd6b222 DW	265	struct ihex_binrec *p = records;
	266
	267	while (p) {
	268	uint16_t writelen = (p->len + 9) & ~3;
	269
	270	p->addr = htonl(p->addr);
85ebd003	271	p->len = htons(p->len);
b8cb464e CR	272	if (write(outfd, &p->addr, writelen) != writelen)
b8cb464e CR	273	return 1;
8bd6b222 DW	274	p = p->next;
	275	}
	276	/* EOF record is zero length, since we don't bother to represent
	277	the type field in the binary version */
b8cb464e CR	278	if (write(outfd, zeroes, 6) != 6)
b8cb464e CR	279	return 1;
8bd6b222 DW	280	return 0;
8bd6b222 DW	281	}