2 * Parser/loader for IHEX formatted data.
4 * Copyright © 2008 David Woodhouse <dwmw2@infradead.org>
5 * Copyright © 2005 Jan Harkes <jaharkes@cs.cmu.edu>
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.
13 #include <arpa/inet.h>
16 #include <sys/types.h>
28 struct ihex_binrec *next; /* not part of the real data structure */
35 * nybble/hex are little helpers to parse hexadecimal numbers to a byte value
37 static uint8_t nybble(const uint8_t n)
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);
45 static uint8_t hex(const uint8_t *data, uint8_t *crc)
47 uint8_t val = (nybble(data[0]) << 4) | nybble(data[1]);
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);
56 static int sort_records = 0;
57 static int wide_records = 0;
58 static int include_jump = 0;
60 static int usage(void)
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");
67 fprintf(stderr, " -j: include records for CS:IP/EIP address\n");
71 int main(int argc, char **argv)
78 while ((opt = getopt(argc, argv, "wsj")) != -1) {
94 if (optind + 2 != argc)
97 if (!strcmp(argv[optind], "-"))
100 infd = open(argv[optind], O_RDONLY);
102 fprintf(stderr, "Failed to open source file: %s",
106 if (fstat(infd, &st)) {
110 data = mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, infd, 0);
111 if (data == MAP_FAILED) {
116 if (!strcmp(argv[optind+1], "-"))
119 outfd = open(argv[optind+1], O_TRUNC|O_CREAT|O_WRONLY, 0644);
121 fprintf(stderr, "Failed to open destination file: %s",
125 if (process_ihex(data, st.st_size))
128 return output_records(outfd);
131 static int process_ihex(uint8_t *data, ssize_t size)
133 struct ihex_binrec *record;
136 uint8_t type, crc = 0, crcbyte = 0;
143 /* search for the start of record character */
145 if (data[i] == '\n') line++;
146 if (data[i++] == ':') break;
149 /* Minimum record length would be about 10 characters */
151 fprintf(stderr, "Can't find valid record at line %d\n", line);
155 len = hex(data + i, &crc); i += 2;
158 len += hex(data + i, &crc); i += 2;
160 record = malloc((sizeof (*record) + len + 3) & ~3);
162 fprintf(stderr, "out of memory for records\n");
165 memset(record, 0, (sizeof(*record) + len + 3) & ~3);
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",
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;
179 for (j = 0; j < record->len; j++, i += 2)
180 record->data[j] = hex(data + i, &crc);
183 crcbyte = hex(data + i, &crc); i += 2;
185 fprintf(stderr, "CRC failure at line %d: got 0x%X, expected 0x%X\n",
186 line, crcbyte, (unsigned char)(crcbyte-crc));
190 /* Done reading the record */
193 /* old style EOF record? */
197 record->addr += offset;
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",
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",
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);
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",
231 memcpy(&data32, &record->data[0], sizeof(data32));
232 data32 = htonl(data32);
233 memcpy(&record->data[0], &data32, sizeof(data32));
235 /* These records contain the CS/IP or EIP where execution
236 * starts. If requested output this as a record. */
242 fprintf(stderr, "Unknown record (type %02X)\n", type);
249 static struct ihex_binrec *records;
251 static void file_record(struct ihex_binrec *record)
253 struct ihex_binrec **p = &records;
255 while ((*p) && (!sort_records || (*p)->addr < record->addr))
262 static int output_records(int outfd)
264 unsigned char zeroes[6] = {0, 0, 0, 0, 0, 0};
265 struct ihex_binrec *p = records;
268 uint16_t writelen = (p->len + 9) & ~3;
270 p->addr = htonl(p->addr);
271 p->len = htons(p->len);
272 if (write(outfd, &p->addr, writelen) != writelen)
276 /* EOF record is zero length, since we don't bother to represent
277 the type field in the binary version */
278 if (write(outfd, zeroes, 6) != 6)