ihex.c revision 1.1.1.4 1 1.1 christos /* BFD back-end for Intel Hex objects.
2 1.1.1.4 christos Copyright (C) 1995-2018 Free Software Foundation, Inc.
3 1.1 christos Written by Ian Lance Taylor of Cygnus Support <ian (at) cygnus.com>.
4 1.1 christos
5 1.1 christos This file is part of BFD, the Binary File Descriptor library.
6 1.1 christos
7 1.1 christos This program is free software; you can redistribute it and/or modify
8 1.1 christos it under the terms of the GNU General Public License as published by
9 1.1 christos the Free Software Foundation; either version 3 of the License, or
10 1.1 christos (at your option) any later version.
11 1.1 christos
12 1.1 christos This program is distributed in the hope that it will be useful,
13 1.1 christos but WITHOUT ANY WARRANTY; without even the implied warranty of
14 1.1 christos MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 1.1 christos GNU General Public License for more details.
16 1.1 christos
17 1.1 christos You should have received a copy of the GNU General Public License
18 1.1 christos along with this program; if not, write to the Free Software
19 1.1 christos Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20 1.1 christos MA 02110-1301, USA. */
21 1.1 christos
22 1.1 christos
23 1.1 christos /* This is what Intel Hex files look like:
24 1.1 christos
25 1.1 christos 1. INTEL FORMATS
26 1.1 christos
27 1.1 christos A. Intel 1
28 1.1 christos
29 1.1 christos 16-bit address-field format, for files 64k bytes in length or less.
30 1.1 christos
31 1.1 christos DATA RECORD
32 1.1 christos Byte 1 Header = colon(:)
33 1.1 christos 2..3 The number of data bytes in hex notation
34 1.1 christos 4..5 High byte of the record load address
35 1.1 christos 6..7 Low byte of the record load address
36 1.1 christos 8..9 Record type, must be "00"
37 1.1 christos 10..x Data bytes in hex notation:
38 1.1 christos x = (number of bytes - 1) * 2 + 11
39 1.1 christos x+1..x+2 Checksum in hex notation
40 1.1 christos x+3..x+4 Carriage return, line feed
41 1.1 christos
42 1.1 christos END RECORD
43 1.1 christos Byte 1 Header = colon (:)
44 1.1 christos 2..3 The byte count, must be "00"
45 1.1 christos 4..7 Transfer-address (usually "0000")
46 1.1 christos the jump-to address, execution start address
47 1.1 christos 8..9 Record type, must be "01"
48 1.1 christos 10..11 Checksum, in hex notation
49 1.1 christos 12..13 Carriage return, line feed
50 1.1 christos
51 1.1 christos B. INTEL 2
52 1.1 christos
53 1.1 christos MCS-86 format, using a 20-bit address for files larger than 64K bytes.
54 1.1 christos
55 1.1 christos DATA RECORD
56 1.1 christos Byte 1 Header = colon (:)
57 1.1 christos 2..3 The byte count of this record, hex notation
58 1.1 christos 4..5 High byte of the record load address
59 1.1 christos 6..7 Low byte of the record load address
60 1.1 christos 8..9 Record type, must be "00"
61 1.1 christos 10..x The data bytes in hex notation:
62 1.1 christos x = (number of data bytes - 1) * 2 + 11
63 1.1 christos x+1..x+2 Checksum in hex notation
64 1.1 christos x+3..x+4 Carriage return, line feed
65 1.1 christos
66 1.1 christos EXTENDED ADDRESS RECORD
67 1.1 christos Byte 1 Header = colon(:)
68 1.1 christos 2..3 The byte count, must be "02"
69 1.1 christos 4..7 Load address, must be "0000"
70 1.1 christos 8..9 Record type, must be "02"
71 1.1 christos 10..11 High byte of the offset address
72 1.1 christos 12..13 Low byte of the offset address
73 1.1 christos 14..15 Checksum in hex notation
74 1.1 christos 16..17 Carriage return, line feed
75 1.1 christos
76 1.1 christos The checksums are the two's complement of the 8-bit sum
77 1.1 christos without carry of the byte count, offset address, and the
78 1.1 christos record type.
79 1.1 christos
80 1.1 christos START ADDRESS RECORD
81 1.1 christos Byte 1 Header = colon (:)
82 1.1 christos 2..3 The byte count, must be "04"
83 1.1 christos 4..7 Load address, must be "0000"
84 1.1 christos 8..9 Record type, must be "03"
85 1.1 christos 10..13 8086 CS value
86 1.1 christos 14..17 8086 IP value
87 1.1 christos 18..19 Checksum in hex notation
88 1.1 christos 20..21 Carriage return, line feed
89 1.1 christos
90 1.1 christos Another document reports these additional types:
91 1.1 christos
92 1.1 christos EXTENDED LINEAR ADDRESS RECORD
93 1.1 christos Byte 1 Header = colon (:)
94 1.1 christos 2..3 The byte count, must be "02"
95 1.1 christos 4..7 Load address, must be "0000"
96 1.1 christos 8..9 Record type, must be "04"
97 1.1 christos 10..13 Upper 16 bits of address of subsequent records
98 1.1 christos 14..15 Checksum in hex notation
99 1.1 christos 16..17 Carriage return, line feed
100 1.1 christos
101 1.1 christos START LINEAR ADDRESS RECORD
102 1.1 christos Byte 1 Header = colon (:)
103 1.1 christos 2..3 The byte count, must be "02"
104 1.1 christos 4..7 Load address, must be "0000"
105 1.1 christos 8..9 Record type, must be "05"
106 1.1 christos 10..13 Upper 16 bits of start address
107 1.1 christos 14..15 Checksum in hex notation
108 1.1 christos 16..17 Carriage return, line feed
109 1.1 christos
110 1.1 christos The MRI compiler uses this, which is a repeat of type 5:
111 1.1 christos
112 1.1 christos EXTENDED START RECORD
113 1.1 christos Byte 1 Header = colon (:)
114 1.1 christos 2..3 The byte count, must be "04"
115 1.1 christos 4..7 Load address, must be "0000"
116 1.1 christos 8..9 Record type, must be "05"
117 1.1 christos 10..13 Upper 16 bits of start address
118 1.1 christos 14..17 Lower 16 bits of start address
119 1.1 christos 18..19 Checksum in hex notation
120 1.1 christos 20..21 Carriage return, line feed. */
121 1.1 christos
122 1.1 christos #include "sysdep.h"
123 1.1 christos #include "bfd.h"
124 1.1 christos #include "libbfd.h"
125 1.1 christos #include "libiberty.h"
126 1.1 christos #include "safe-ctype.h"
127 1.1 christos
128 1.1 christos /* The number of bytes we put on one line during output. */
129 1.1 christos
130 1.1 christos #define CHUNK 16
131 1.1 christos
132 1.1 christos /* Macros for converting between hex and binary. */
133 1.1 christos
134 1.1 christos #define NIBBLE(x) (hex_value (x))
135 1.1 christos #define HEX2(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
136 1.1 christos #define HEX4(buffer) ((HEX2 (buffer) << 8) + HEX2 ((buffer) + 2))
137 1.1 christos #define ISHEX(x) (hex_p (x))
138 1.1 christos
139 1.1 christos /* When we write out an ihex value, the values can not be output as
140 1.1 christos they are seen. Instead, we hold them in memory in this structure. */
141 1.1 christos
142 1.1 christos struct ihex_data_list
143 1.1 christos {
144 1.1 christos struct ihex_data_list *next;
145 1.1 christos bfd_byte *data;
146 1.1 christos bfd_vma where;
147 1.1 christos bfd_size_type size;
148 1.1 christos };
149 1.1 christos
150 1.1 christos /* The ihex tdata information. */
151 1.1 christos
152 1.1 christos struct ihex_data_struct
153 1.1 christos {
154 1.1 christos struct ihex_data_list *head;
155 1.1 christos struct ihex_data_list *tail;
156 1.1 christos };
157 1.1 christos
158 1.1 christos /* Initialize by filling in the hex conversion array. */
159 1.1 christos
160 1.1 christos static void
161 1.1 christos ihex_init (void)
162 1.1 christos {
163 1.1 christos static bfd_boolean inited;
164 1.1 christos
165 1.1 christos if (! inited)
166 1.1 christos {
167 1.1 christos inited = TRUE;
168 1.1 christos hex_init ();
169 1.1 christos }
170 1.1 christos }
171 1.1 christos
172 1.1 christos /* Create an ihex object. */
173 1.1 christos
174 1.1 christos static bfd_boolean
175 1.1 christos ihex_mkobject (bfd *abfd)
176 1.1 christos {
177 1.1 christos struct ihex_data_struct *tdata;
178 1.1 christos
179 1.1 christos tdata = (struct ihex_data_struct *) bfd_alloc (abfd, sizeof (* tdata));
180 1.1 christos if (tdata == NULL)
181 1.1 christos return FALSE;
182 1.1 christos
183 1.1 christos abfd->tdata.ihex_data = tdata;
184 1.1 christos tdata->head = NULL;
185 1.1 christos tdata->tail = NULL;
186 1.1 christos return TRUE;
187 1.1 christos }
188 1.1 christos
189 1.1 christos /* Read a byte from a BFD. Set *ERRORPTR if an error occurred.
190 1.1 christos Return EOF on error or end of file. */
191 1.1 christos
192 1.1 christos static INLINE int
193 1.1 christos ihex_get_byte (bfd *abfd, bfd_boolean *errorptr)
194 1.1 christos {
195 1.1 christos bfd_byte c;
196 1.1 christos
197 1.1 christos if (bfd_bread (&c, (bfd_size_type) 1, abfd) != 1)
198 1.1 christos {
199 1.1 christos if (bfd_get_error () != bfd_error_file_truncated)
200 1.1 christos *errorptr = TRUE;
201 1.1 christos return EOF;
202 1.1 christos }
203 1.1 christos
204 1.1 christos return (int) (c & 0xff);
205 1.1 christos }
206 1.1 christos
207 1.1 christos /* Report a problem in an Intel Hex file. */
208 1.1 christos
209 1.1 christos static void
210 1.1 christos ihex_bad_byte (bfd *abfd, unsigned int lineno, int c, bfd_boolean error)
211 1.1 christos {
212 1.1 christos if (c == EOF)
213 1.1 christos {
214 1.1 christos if (! error)
215 1.1 christos bfd_set_error (bfd_error_file_truncated);
216 1.1 christos }
217 1.1 christos else
218 1.1 christos {
219 1.1 christos char buf[10];
220 1.1 christos
221 1.1 christos if (! ISPRINT (c))
222 1.1.1.2 christos sprintf (buf, "\\%03o", (unsigned int) c & 0xff);
223 1.1 christos else
224 1.1 christos {
225 1.1 christos buf[0] = c;
226 1.1 christos buf[1] = '\0';
227 1.1 christos }
228 1.1.1.4 christos _bfd_error_handler
229 1.1.1.4 christos /* xgettext:c-format */
230 1.1.1.4 christos (_("%pB:%d: unexpected character `%s' in Intel Hex file"),
231 1.1 christos abfd, lineno, buf);
232 1.1 christos bfd_set_error (bfd_error_bad_value);
233 1.1 christos }
234 1.1 christos }
235 1.1 christos
236 1.1 christos /* Read an Intel hex file and turn it into sections. We create a new
237 1.1 christos section for each contiguous set of bytes. */
238 1.1 christos
239 1.1 christos static bfd_boolean
240 1.1 christos ihex_scan (bfd *abfd)
241 1.1 christos {
242 1.1 christos bfd_vma segbase;
243 1.1 christos bfd_vma extbase;
244 1.1 christos asection *sec;
245 1.1 christos unsigned int lineno;
246 1.1 christos bfd_boolean error;
247 1.1 christos bfd_byte *buf = NULL;
248 1.1 christos size_t bufsize;
249 1.1 christos int c;
250 1.1 christos
251 1.1 christos if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
252 1.1 christos goto error_return;
253 1.1 christos
254 1.1 christos abfd->start_address = 0;
255 1.1 christos
256 1.1 christos segbase = 0;
257 1.1 christos extbase = 0;
258 1.1 christos sec = NULL;
259 1.1 christos lineno = 1;
260 1.1 christos error = FALSE;
261 1.1 christos bufsize = 0;
262 1.1 christos
263 1.1 christos while ((c = ihex_get_byte (abfd, &error)) != EOF)
264 1.1 christos {
265 1.1 christos if (c == '\r')
266 1.1 christos continue;
267 1.1 christos else if (c == '\n')
268 1.1 christos {
269 1.1 christos ++lineno;
270 1.1 christos continue;
271 1.1 christos }
272 1.1 christos else if (c != ':')
273 1.1 christos {
274 1.1 christos ihex_bad_byte (abfd, lineno, c, error);
275 1.1 christos goto error_return;
276 1.1 christos }
277 1.1 christos else
278 1.1 christos {
279 1.1 christos file_ptr pos;
280 1.1.1.2 christos unsigned char hdr[8];
281 1.1 christos unsigned int i;
282 1.1 christos unsigned int len;
283 1.1 christos bfd_vma addr;
284 1.1 christos unsigned int type;
285 1.1 christos unsigned int chars;
286 1.1 christos unsigned int chksum;
287 1.1 christos
288 1.1 christos /* This is a data record. */
289 1.1 christos pos = bfd_tell (abfd) - 1;
290 1.1 christos
291 1.1 christos /* Read the header bytes. */
292 1.1 christos if (bfd_bread (hdr, (bfd_size_type) 8, abfd) != 8)
293 1.1 christos goto error_return;
294 1.1 christos
295 1.1 christos for (i = 0; i < 8; i++)
296 1.1 christos {
297 1.1 christos if (! ISHEX (hdr[i]))
298 1.1 christos {
299 1.1 christos ihex_bad_byte (abfd, lineno, hdr[i], error);
300 1.1 christos goto error_return;
301 1.1 christos }
302 1.1 christos }
303 1.1 christos
304 1.1 christos len = HEX2 (hdr);
305 1.1 christos addr = HEX4 (hdr + 2);
306 1.1 christos type = HEX2 (hdr + 6);
307 1.1 christos
308 1.1 christos /* Read the data bytes. */
309 1.1 christos chars = len * 2 + 2;
310 1.1 christos if (chars >= bufsize)
311 1.1 christos {
312 1.1 christos buf = (bfd_byte *) bfd_realloc (buf, (bfd_size_type) chars);
313 1.1 christos if (buf == NULL)
314 1.1 christos goto error_return;
315 1.1 christos bufsize = chars;
316 1.1 christos }
317 1.1 christos
318 1.1 christos if (bfd_bread (buf, (bfd_size_type) chars, abfd) != chars)
319 1.1 christos goto error_return;
320 1.1 christos
321 1.1 christos for (i = 0; i < chars; i++)
322 1.1 christos {
323 1.1 christos if (! ISHEX (buf[i]))
324 1.1 christos {
325 1.1.1.2 christos ihex_bad_byte (abfd, lineno, buf[i], error);
326 1.1 christos goto error_return;
327 1.1 christos }
328 1.1 christos }
329 1.1 christos
330 1.1 christos /* Check the checksum. */
331 1.1 christos chksum = len + addr + (addr >> 8) + type;
332 1.1 christos for (i = 0; i < len; i++)
333 1.1 christos chksum += HEX2 (buf + 2 * i);
334 1.1 christos if (((- chksum) & 0xff) != (unsigned int) HEX2 (buf + 2 * i))
335 1.1 christos {
336 1.1.1.4 christos _bfd_error_handler
337 1.1.1.4 christos /* xgettext:c-format */
338 1.1.1.4 christos (_("%pB:%u: bad checksum in Intel Hex file (expected %u, found %u)"),
339 1.1 christos abfd, lineno,
340 1.1 christos (- chksum) & 0xff, (unsigned int) HEX2 (buf + 2 * i));
341 1.1 christos bfd_set_error (bfd_error_bad_value);
342 1.1 christos goto error_return;
343 1.1 christos }
344 1.1 christos
345 1.1 christos switch (type)
346 1.1 christos {
347 1.1 christos case 0:
348 1.1 christos /* This is a data record. */
349 1.1 christos if (sec != NULL
350 1.1 christos && sec->vma + sec->size == extbase + segbase + addr)
351 1.1 christos {
352 1.1 christos /* This data goes at the end of the section we are
353 1.1.1.4 christos currently building. */
354 1.1 christos sec->size += len;
355 1.1 christos }
356 1.1 christos else if (len > 0)
357 1.1 christos {
358 1.1 christos char secbuf[20];
359 1.1 christos char *secname;
360 1.1 christos bfd_size_type amt;
361 1.1 christos flagword flags;
362 1.1 christos
363 1.1 christos sprintf (secbuf, ".sec%d", bfd_count_sections (abfd) + 1);
364 1.1 christos amt = strlen (secbuf) + 1;
365 1.1 christos secname = (char *) bfd_alloc (abfd, amt);
366 1.1 christos if (secname == NULL)
367 1.1 christos goto error_return;
368 1.1 christos strcpy (secname, secbuf);
369 1.1 christos flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
370 1.1 christos sec = bfd_make_section_with_flags (abfd, secname, flags);
371 1.1 christos if (sec == NULL)
372 1.1 christos goto error_return;
373 1.1 christos sec->vma = extbase + segbase + addr;
374 1.1 christos sec->lma = extbase + segbase + addr;
375 1.1 christos sec->size = len;
376 1.1 christos sec->filepos = pos;
377 1.1 christos }
378 1.1 christos break;
379 1.1 christos
380 1.1 christos case 1:
381 1.1 christos /* An end record. */
382 1.1 christos if (abfd->start_address == 0)
383 1.1 christos abfd->start_address = addr;
384 1.1 christos if (buf != NULL)
385 1.1 christos free (buf);
386 1.1 christos return TRUE;
387 1.1 christos
388 1.1 christos case 2:
389 1.1 christos /* An extended address record. */
390 1.1 christos if (len != 2)
391 1.1 christos {
392 1.1.1.4 christos _bfd_error_handler
393 1.1.1.4 christos /* xgettext:c-format */
394 1.1.1.4 christos (_("%pB:%u: bad extended address record length in Intel Hex file"),
395 1.1 christos abfd, lineno);
396 1.1 christos bfd_set_error (bfd_error_bad_value);
397 1.1 christos goto error_return;
398 1.1 christos }
399 1.1 christos
400 1.1 christos segbase = HEX4 (buf) << 4;
401 1.1 christos
402 1.1 christos sec = NULL;
403 1.1 christos
404 1.1 christos break;
405 1.1 christos
406 1.1 christos case 3:
407 1.1 christos /* An extended start address record. */
408 1.1 christos if (len != 4)
409 1.1 christos {
410 1.1.1.4 christos _bfd_error_handler
411 1.1.1.4 christos /* xgettext:c-format */
412 1.1.1.4 christos (_("%pB:%u: bad extended start address length in Intel Hex file"),
413 1.1 christos abfd, lineno);
414 1.1 christos bfd_set_error (bfd_error_bad_value);
415 1.1 christos goto error_return;
416 1.1 christos }
417 1.1 christos
418 1.1 christos abfd->start_address += (HEX4 (buf) << 4) + HEX4 (buf + 4);
419 1.1 christos
420 1.1 christos sec = NULL;
421 1.1 christos
422 1.1 christos break;
423 1.1 christos
424 1.1 christos case 4:
425 1.1 christos /* An extended linear address record. */
426 1.1 christos if (len != 2)
427 1.1 christos {
428 1.1.1.4 christos _bfd_error_handler
429 1.1.1.4 christos /* xgettext:c-format */
430 1.1.1.4 christos (_("%pB:%u: bad extended linear address record length in Intel Hex file"),
431 1.1 christos abfd, lineno);
432 1.1 christos bfd_set_error (bfd_error_bad_value);
433 1.1 christos goto error_return;
434 1.1 christos }
435 1.1 christos
436 1.1 christos extbase = HEX4 (buf) << 16;
437 1.1 christos
438 1.1 christos sec = NULL;
439 1.1 christos
440 1.1 christos break;
441 1.1 christos
442 1.1 christos case 5:
443 1.1 christos /* An extended linear start address record. */
444 1.1 christos if (len != 2 && len != 4)
445 1.1 christos {
446 1.1.1.4 christos _bfd_error_handler
447 1.1.1.4 christos /* xgettext:c-format */
448 1.1.1.4 christos (_("%pB:%u: bad extended linear start address length in Intel Hex file"),
449 1.1 christos abfd, lineno);
450 1.1 christos bfd_set_error (bfd_error_bad_value);
451 1.1 christos goto error_return;
452 1.1 christos }
453 1.1 christos
454 1.1 christos if (len == 2)
455 1.1 christos abfd->start_address += HEX4 (buf) << 16;
456 1.1 christos else
457 1.1 christos abfd->start_address = (HEX4 (buf) << 16) + HEX4 (buf + 4);
458 1.1 christos
459 1.1 christos sec = NULL;
460 1.1 christos
461 1.1 christos break;
462 1.1 christos
463 1.1 christos default:
464 1.1.1.4 christos _bfd_error_handler
465 1.1.1.4 christos /* xgettext:c-format */
466 1.1.1.4 christos (_("%pB:%u: unrecognized ihex type %u in Intel Hex file"),
467 1.1 christos abfd, lineno, type);
468 1.1 christos bfd_set_error (bfd_error_bad_value);
469 1.1 christos goto error_return;
470 1.1 christos }
471 1.1 christos }
472 1.1 christos }
473 1.1 christos
474 1.1 christos if (error)
475 1.1 christos goto error_return;
476 1.1 christos
477 1.1 christos if (buf != NULL)
478 1.1 christos free (buf);
479 1.1 christos
480 1.1 christos return TRUE;
481 1.1 christos
482 1.1 christos error_return:
483 1.1 christos if (buf != NULL)
484 1.1 christos free (buf);
485 1.1 christos return FALSE;
486 1.1 christos }
487 1.1 christos
488 1.1 christos /* Try to recognize an Intel Hex file. */
489 1.1 christos
490 1.1 christos static const bfd_target *
491 1.1 christos ihex_object_p (bfd *abfd)
492 1.1 christos {
493 1.1 christos void * tdata_save;
494 1.1 christos bfd_byte b[9];
495 1.1 christos unsigned int i;
496 1.1 christos unsigned int type;
497 1.1 christos
498 1.1 christos ihex_init ();
499 1.1 christos
500 1.1 christos if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
501 1.1 christos return NULL;
502 1.1 christos if (bfd_bread (b, (bfd_size_type) 9, abfd) != 9)
503 1.1 christos {
504 1.1 christos if (bfd_get_error () == bfd_error_file_truncated)
505 1.1 christos bfd_set_error (bfd_error_wrong_format);
506 1.1 christos return NULL;
507 1.1 christos }
508 1.1 christos
509 1.1 christos if (b[0] != ':')
510 1.1 christos {
511 1.1 christos bfd_set_error (bfd_error_wrong_format);
512 1.1 christos return NULL;
513 1.1 christos }
514 1.1 christos
515 1.1 christos for (i = 1; i < 9; i++)
516 1.1 christos {
517 1.1 christos if (! ISHEX (b[i]))
518 1.1 christos {
519 1.1 christos bfd_set_error (bfd_error_wrong_format);
520 1.1 christos return NULL;
521 1.1 christos }
522 1.1 christos }
523 1.1 christos
524 1.1 christos type = HEX2 (b + 7);
525 1.1 christos if (type > 5)
526 1.1 christos {
527 1.1 christos bfd_set_error (bfd_error_wrong_format);
528 1.1 christos return NULL;
529 1.1 christos }
530 1.1 christos
531 1.1 christos /* OK, it looks like it really is an Intel Hex file. */
532 1.1 christos tdata_save = abfd->tdata.any;
533 1.1 christos if (! ihex_mkobject (abfd) || ! ihex_scan (abfd))
534 1.1 christos {
535 1.1 christos if (abfd->tdata.any != tdata_save && abfd->tdata.any != NULL)
536 1.1 christos bfd_release (abfd, abfd->tdata.any);
537 1.1 christos abfd->tdata.any = tdata_save;
538 1.1 christos return NULL;
539 1.1 christos }
540 1.1 christos
541 1.1 christos return abfd->xvec;
542 1.1 christos }
543 1.1 christos
544 1.1 christos /* Read the contents of a section in an Intel Hex file. */
545 1.1 christos
546 1.1 christos static bfd_boolean
547 1.1 christos ihex_read_section (bfd *abfd, asection *section, bfd_byte *contents)
548 1.1 christos {
549 1.1 christos int c;
550 1.1 christos bfd_byte *p;
551 1.1 christos bfd_byte *buf = NULL;
552 1.1 christos size_t bufsize;
553 1.1 christos bfd_boolean error;
554 1.1 christos
555 1.1 christos if (bfd_seek (abfd, section->filepos, SEEK_SET) != 0)
556 1.1 christos goto error_return;
557 1.1 christos
558 1.1 christos p = contents;
559 1.1 christos bufsize = 0;
560 1.1 christos error = FALSE;
561 1.1 christos while ((c = ihex_get_byte (abfd, &error)) != EOF)
562 1.1 christos {
563 1.1.1.2 christos unsigned char hdr[8];
564 1.1 christos unsigned int len;
565 1.1 christos unsigned int type;
566 1.1 christos unsigned int i;
567 1.1 christos
568 1.1 christos if (c == '\r' || c == '\n')
569 1.1 christos continue;
570 1.1 christos
571 1.1 christos /* This is called after ihex_scan has succeeded, so we ought to
572 1.1.1.4 christos know the exact format. */
573 1.1 christos BFD_ASSERT (c == ':');
574 1.1 christos
575 1.1 christos if (bfd_bread (hdr, (bfd_size_type) 8, abfd) != 8)
576 1.1 christos goto error_return;
577 1.1 christos
578 1.1 christos len = HEX2 (hdr);
579 1.1 christos type = HEX2 (hdr + 6);
580 1.1 christos
581 1.1 christos /* We should only see type 0 records here. */
582 1.1 christos if (type != 0)
583 1.1 christos {
584 1.1.1.4 christos _bfd_error_handler
585 1.1.1.4 christos (_("%pB: internal error in ihex_read_section"), abfd);
586 1.1 christos bfd_set_error (bfd_error_bad_value);
587 1.1 christos goto error_return;
588 1.1 christos }
589 1.1 christos
590 1.1 christos if (len * 2 > bufsize)
591 1.1 christos {
592 1.1 christos buf = (bfd_byte *) bfd_realloc (buf, (bfd_size_type) len * 2);
593 1.1 christos if (buf == NULL)
594 1.1 christos goto error_return;
595 1.1 christos bufsize = len * 2;
596 1.1 christos }
597 1.1 christos
598 1.1 christos if (bfd_bread (buf, (bfd_size_type) len * 2, abfd) != len * 2)
599 1.1 christos goto error_return;
600 1.1 christos
601 1.1 christos for (i = 0; i < len; i++)
602 1.1 christos *p++ = HEX2 (buf + 2 * i);
603 1.1 christos if ((bfd_size_type) (p - contents) >= section->size)
604 1.1 christos {
605 1.1 christos /* We've read everything in the section. */
606 1.1 christos if (buf != NULL)
607 1.1 christos free (buf);
608 1.1 christos return TRUE;
609 1.1 christos }
610 1.1 christos
611 1.1 christos /* Skip the checksum. */
612 1.1 christos if (bfd_bread (buf, (bfd_size_type) 2, abfd) != 2)
613 1.1 christos goto error_return;
614 1.1 christos }
615 1.1 christos
616 1.1 christos if ((bfd_size_type) (p - contents) < section->size)
617 1.1 christos {
618 1.1.1.4 christos _bfd_error_handler
619 1.1.1.4 christos (_("%pB: bad section length in ihex_read_section"), abfd);
620 1.1 christos bfd_set_error (bfd_error_bad_value);
621 1.1 christos goto error_return;
622 1.1 christos }
623 1.1 christos
624 1.1 christos if (buf != NULL)
625 1.1 christos free (buf);
626 1.1 christos
627 1.1 christos return TRUE;
628 1.1 christos
629 1.1 christos error_return:
630 1.1 christos if (buf != NULL)
631 1.1 christos free (buf);
632 1.1 christos return FALSE;
633 1.1 christos }
634 1.1 christos
635 1.1 christos /* Get the contents of a section in an Intel Hex file. */
636 1.1 christos
637 1.1 christos static bfd_boolean
638 1.1 christos ihex_get_section_contents (bfd *abfd,
639 1.1 christos asection *section,
640 1.1 christos void * location,
641 1.1 christos file_ptr offset,
642 1.1 christos bfd_size_type count)
643 1.1 christos {
644 1.1 christos if (section->used_by_bfd == NULL)
645 1.1 christos {
646 1.1 christos section->used_by_bfd = bfd_alloc (abfd, section->size);
647 1.1 christos if (section->used_by_bfd == NULL)
648 1.1 christos return FALSE;
649 1.1 christos if (! ihex_read_section (abfd, section,
650 1.1.1.4 christos (bfd_byte *) section->used_by_bfd))
651 1.1 christos return FALSE;
652 1.1 christos }
653 1.1 christos
654 1.1 christos memcpy (location, (bfd_byte *) section->used_by_bfd + offset,
655 1.1 christos (size_t) count);
656 1.1 christos
657 1.1 christos return TRUE;
658 1.1 christos }
659 1.1 christos
660 1.1 christos /* Set the contents of a section in an Intel Hex file. */
661 1.1 christos
662 1.1 christos static bfd_boolean
663 1.1 christos ihex_set_section_contents (bfd *abfd,
664 1.1 christos asection *section,
665 1.1 christos const void * location,
666 1.1 christos file_ptr offset,
667 1.1 christos bfd_size_type count)
668 1.1 christos {
669 1.1 christos struct ihex_data_list *n;
670 1.1 christos bfd_byte *data;
671 1.1 christos struct ihex_data_struct *tdata;
672 1.1 christos
673 1.1 christos if (count == 0
674 1.1 christos || (section->flags & SEC_ALLOC) == 0
675 1.1 christos || (section->flags & SEC_LOAD) == 0)
676 1.1 christos return TRUE;
677 1.1 christos
678 1.1 christos n = (struct ihex_data_list *) bfd_alloc (abfd, sizeof (* n));
679 1.1 christos if (n == NULL)
680 1.1 christos return FALSE;
681 1.1 christos
682 1.1 christos data = (bfd_byte *) bfd_alloc (abfd, count);
683 1.1 christos if (data == NULL)
684 1.1 christos return FALSE;
685 1.1 christos memcpy (data, location, (size_t) count);
686 1.1 christos
687 1.1 christos n->data = data;
688 1.1 christos n->where = section->lma + offset;
689 1.1 christos n->size = count;
690 1.1 christos
691 1.1 christos /* Sort the records by address. Optimize for the common case of
692 1.1 christos adding a record to the end of the list. */
693 1.1 christos tdata = abfd->tdata.ihex_data;
694 1.1 christos if (tdata->tail != NULL
695 1.1 christos && n->where >= tdata->tail->where)
696 1.1 christos {
697 1.1 christos tdata->tail->next = n;
698 1.1 christos n->next = NULL;
699 1.1 christos tdata->tail = n;
700 1.1 christos }
701 1.1 christos else
702 1.1 christos {
703 1.1 christos struct ihex_data_list **pp;
704 1.1 christos
705 1.1 christos for (pp = &tdata->head;
706 1.1 christos *pp != NULL && (*pp)->where < n->where;
707 1.1 christos pp = &(*pp)->next)
708 1.1 christos ;
709 1.1 christos n->next = *pp;
710 1.1 christos *pp = n;
711 1.1 christos if (n->next == NULL)
712 1.1 christos tdata->tail = n;
713 1.1 christos }
714 1.1 christos
715 1.1 christos return TRUE;
716 1.1 christos }
717 1.1 christos
718 1.1 christos /* Write a record out to an Intel Hex file. */
719 1.1 christos
720 1.1 christos static bfd_boolean
721 1.1 christos ihex_write_record (bfd *abfd,
722 1.1 christos size_t count,
723 1.1 christos unsigned int addr,
724 1.1 christos unsigned int type,
725 1.1 christos bfd_byte *data)
726 1.1 christos {
727 1.1 christos static const char digs[] = "0123456789ABCDEF";
728 1.1 christos char buf[9 + CHUNK * 2 + 4];
729 1.1 christos char *p;
730 1.1 christos unsigned int chksum;
731 1.1 christos unsigned int i;
732 1.1 christos size_t total;
733 1.1 christos
734 1.1 christos #define TOHEX(buf, v) \
735 1.1 christos ((buf)[0] = digs[((v) >> 4) & 0xf], (buf)[1] = digs[(v) & 0xf])
736 1.1 christos
737 1.1 christos buf[0] = ':';
738 1.1 christos TOHEX (buf + 1, count);
739 1.1 christos TOHEX (buf + 3, (addr >> 8) & 0xff);
740 1.1 christos TOHEX (buf + 5, addr & 0xff);
741 1.1 christos TOHEX (buf + 7, type);
742 1.1 christos
743 1.1 christos chksum = count + addr + (addr >> 8) + type;
744 1.1 christos
745 1.1 christos for (i = 0, p = buf + 9; i < count; i++, p += 2, data++)
746 1.1 christos {
747 1.1 christos TOHEX (p, *data);
748 1.1 christos chksum += *data;
749 1.1 christos }
750 1.1 christos
751 1.1 christos TOHEX (p, (- chksum) & 0xff);
752 1.1 christos p[2] = '\r';
753 1.1 christos p[3] = '\n';
754 1.1 christos
755 1.1 christos total = 9 + count * 2 + 4;
756 1.1 christos if (bfd_bwrite (buf, (bfd_size_type) total, abfd) != total)
757 1.1 christos return FALSE;
758 1.1 christos
759 1.1 christos return TRUE;
760 1.1 christos }
761 1.1 christos
762 1.1 christos /* Write out an Intel Hex file. */
763 1.1 christos
764 1.1 christos static bfd_boolean
765 1.1 christos ihex_write_object_contents (bfd *abfd)
766 1.1 christos {
767 1.1 christos bfd_vma segbase;
768 1.1 christos bfd_vma extbase;
769 1.1 christos struct ihex_data_list *l;
770 1.1 christos
771 1.1 christos segbase = 0;
772 1.1 christos extbase = 0;
773 1.1 christos for (l = abfd->tdata.ihex_data->head; l != NULL; l = l->next)
774 1.1 christos {
775 1.1 christos bfd_vma where;
776 1.1 christos bfd_byte *p;
777 1.1 christos bfd_size_type count;
778 1.1 christos
779 1.1 christos where = l->where;
780 1.1 christos p = l->data;
781 1.1 christos count = l->size;
782 1.1 christos
783 1.1 christos while (count > 0)
784 1.1 christos {
785 1.1 christos size_t now;
786 1.1 christos unsigned int rec_addr;
787 1.1 christos
788 1.1 christos now = count;
789 1.1 christos if (count > CHUNK)
790 1.1 christos now = CHUNK;
791 1.1 christos
792 1.1 christos if (where > segbase + extbase + 0xffff)
793 1.1 christos {
794 1.1 christos bfd_byte addr[2];
795 1.1 christos
796 1.1 christos /* We need a new base address. */
797 1.1 christos if (where <= 0xfffff)
798 1.1 christos {
799 1.1 christos /* The addresses should be sorted. */
800 1.1 christos BFD_ASSERT (extbase == 0);
801 1.1 christos
802 1.1 christos segbase = where & 0xf0000;
803 1.1 christos addr[0] = (bfd_byte)(segbase >> 12) & 0xff;
804 1.1 christos addr[1] = (bfd_byte)(segbase >> 4) & 0xff;
805 1.1 christos if (! ihex_write_record (abfd, 2, 0, 2, addr))
806 1.1 christos return FALSE;
807 1.1 christos }
808 1.1 christos else
809 1.1 christos {
810 1.1 christos /* The extended address record and the extended
811 1.1.1.4 christos linear address record are combined, at least by
812 1.1.1.4 christos some readers. We need an extended linear address
813 1.1.1.4 christos record here, so if we've already written out an
814 1.1.1.4 christos extended address record, zero it out to avoid
815 1.1.1.4 christos confusion. */
816 1.1 christos if (segbase != 0)
817 1.1 christos {
818 1.1 christos addr[0] = 0;
819 1.1 christos addr[1] = 0;
820 1.1 christos if (! ihex_write_record (abfd, 2, 0, 2, addr))
821 1.1 christos return FALSE;
822 1.1 christos segbase = 0;
823 1.1 christos }
824 1.1 christos
825 1.1 christos extbase = where & 0xffff0000;
826 1.1 christos if (where > extbase + 0xffff)
827 1.1 christos {
828 1.1.1.4 christos _bfd_error_handler
829 1.1.1.4 christos /* xgettext:c-format */
830 1.1.1.4 christos (_("%pB: address %#" PRIx64
831 1.1.1.4 christos " out of range for Intel Hex file"),
832 1.1.1.4 christos abfd, (uint64_t) where);
833 1.1 christos bfd_set_error (bfd_error_bad_value);
834 1.1 christos return FALSE;
835 1.1 christos }
836 1.1 christos addr[0] = (bfd_byte)(extbase >> 24) & 0xff;
837 1.1 christos addr[1] = (bfd_byte)(extbase >> 16) & 0xff;
838 1.1 christos if (! ihex_write_record (abfd, 2, 0, 4, addr))
839 1.1 christos return FALSE;
840 1.1 christos }
841 1.1 christos }
842 1.1 christos
843 1.1 christos rec_addr = where - (extbase + segbase);
844 1.1 christos
845 1.1.1.4 christos /* Output records shouldn't cross 64K boundaries. */
846 1.1.1.4 christos if (rec_addr + now > 0xffff)
847 1.1.1.4 christos now = 0x10000 - rec_addr;
848 1.1 christos
849 1.1 christos if (! ihex_write_record (abfd, now, rec_addr, 0, p))
850 1.1 christos return FALSE;
851 1.1 christos
852 1.1 christos where += now;
853 1.1 christos p += now;
854 1.1 christos count -= now;
855 1.1 christos }
856 1.1 christos }
857 1.1 christos
858 1.1 christos if (abfd->start_address != 0)
859 1.1 christos {
860 1.1 christos bfd_vma start;
861 1.1 christos bfd_byte startbuf[4];
862 1.1 christos
863 1.1 christos start = abfd->start_address;
864 1.1 christos
865 1.1 christos if (start <= 0xfffff)
866 1.1 christos {
867 1.1 christos startbuf[0] = (bfd_byte)((start & 0xf0000) >> 12) & 0xff;
868 1.1 christos startbuf[1] = 0;
869 1.1 christos startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
870 1.1 christos startbuf[3] = (bfd_byte)start & 0xff;
871 1.1 christos if (! ihex_write_record (abfd, 4, 0, 3, startbuf))
872 1.1 christos return FALSE;
873 1.1 christos }
874 1.1 christos else
875 1.1 christos {
876 1.1 christos startbuf[0] = (bfd_byte)(start >> 24) & 0xff;
877 1.1 christos startbuf[1] = (bfd_byte)(start >> 16) & 0xff;
878 1.1 christos startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
879 1.1 christos startbuf[3] = (bfd_byte)start & 0xff;
880 1.1 christos if (! ihex_write_record (abfd, 4, 0, 5, startbuf))
881 1.1 christos return FALSE;
882 1.1 christos }
883 1.1 christos }
884 1.1 christos
885 1.1 christos if (! ihex_write_record (abfd, 0, 0, 1, NULL))
886 1.1 christos return FALSE;
887 1.1 christos
888 1.1 christos return TRUE;
889 1.1 christos }
890 1.1 christos
891 1.1 christos /* Set the architecture for the output file. The architecture is
892 1.1 christos irrelevant, so we ignore errors about unknown architectures. */
893 1.1 christos
894 1.1 christos static bfd_boolean
895 1.1 christos ihex_set_arch_mach (bfd *abfd,
896 1.1 christos enum bfd_architecture arch,
897 1.1 christos unsigned long mach)
898 1.1 christos {
899 1.1 christos if (! bfd_default_set_arch_mach (abfd, arch, mach))
900 1.1 christos {
901 1.1 christos if (arch != bfd_arch_unknown)
902 1.1 christos return FALSE;
903 1.1 christos }
904 1.1 christos return TRUE;
905 1.1 christos }
906 1.1 christos
907 1.1 christos /* Get the size of the headers, for the linker. */
908 1.1 christos
909 1.1 christos static int
910 1.1 christos ihex_sizeof_headers (bfd *abfd ATTRIBUTE_UNUSED,
911 1.1 christos struct bfd_link_info *info ATTRIBUTE_UNUSED)
912 1.1 christos {
913 1.1 christos return 0;
914 1.1 christos }
915 1.1 christos
916 1.1 christos /* Some random definitions for the target vector. */
917 1.1 christos
918 1.1.1.4 christos #define ihex_close_and_cleanup _bfd_generic_close_and_cleanup
919 1.1.1.4 christos #define ihex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
920 1.1.1.4 christos #define ihex_new_section_hook _bfd_generic_new_section_hook
921 1.1.1.4 christos #define ihex_get_section_contents_in_window _bfd_generic_get_section_contents_in_window
922 1.1.1.4 christos #define ihex_get_symtab_upper_bound _bfd_long_bfd_0
923 1.1.1.4 christos #define ihex_canonicalize_symtab _bfd_nosymbols_canonicalize_symtab
924 1.1.1.4 christos #define ihex_make_empty_symbol _bfd_generic_make_empty_symbol
925 1.1.1.4 christos #define ihex_print_symbol _bfd_nosymbols_print_symbol
926 1.1.1.4 christos #define ihex_get_symbol_info _bfd_nosymbols_get_symbol_info
927 1.1.1.2 christos #define ihex_get_symbol_version_string _bfd_nosymbols_get_symbol_version_string
928 1.1.1.4 christos #define ihex_bfd_is_target_special_symbol _bfd_bool_bfd_asymbol_false
929 1.1.1.4 christos #define ihex_bfd_is_local_label_name _bfd_nosymbols_bfd_is_local_label_name
930 1.1.1.4 christos #define ihex_get_lineno _bfd_nosymbols_get_lineno
931 1.1.1.4 christos #define ihex_find_nearest_line _bfd_nosymbols_find_nearest_line
932 1.1.1.4 christos #define ihex_find_line _bfd_nosymbols_find_line
933 1.1.1.4 christos #define ihex_find_inliner_info _bfd_nosymbols_find_inliner_info
934 1.1.1.4 christos #define ihex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
935 1.1.1.4 christos #define ihex_read_minisymbols _bfd_nosymbols_read_minisymbols
936 1.1.1.4 christos #define ihex_minisymbol_to_symbol _bfd_nosymbols_minisymbol_to_symbol
937 1.1.1.4 christos #define ihex_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
938 1.1.1.4 christos #define ihex_bfd_relax_section bfd_generic_relax_section
939 1.1.1.4 christos #define ihex_bfd_gc_sections bfd_generic_gc_sections
940 1.1.1.4 christos #define ihex_bfd_lookup_section_flags bfd_generic_lookup_section_flags
941 1.1.1.4 christos #define ihex_bfd_merge_sections bfd_generic_merge_sections
942 1.1.1.4 christos #define ihex_bfd_is_group_section bfd_generic_is_group_section
943 1.1.1.4 christos #define ihex_bfd_discard_group bfd_generic_discard_group
944 1.1.1.4 christos #define ihex_section_already_linked _bfd_generic_section_already_linked
945 1.1.1.4 christos #define ihex_bfd_define_common_symbol bfd_generic_define_common_symbol
946 1.1.1.4 christos #define ihex_bfd_link_hide_symbol _bfd_generic_link_hide_symbol
947 1.1.1.4 christos #define ihex_bfd_define_start_stop bfd_generic_define_start_stop
948 1.1.1.4 christos #define ihex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
949 1.1.1.4 christos #define ihex_bfd_link_add_symbols _bfd_generic_link_add_symbols
950 1.1.1.4 christos #define ihex_bfd_link_just_syms _bfd_generic_link_just_syms
951 1.1.1.4 christos #define ihex_bfd_copy_link_hash_symbol_type _bfd_generic_copy_link_hash_symbol_type
952 1.1.1.4 christos #define ihex_bfd_final_link _bfd_generic_final_link
953 1.1.1.4 christos #define ihex_bfd_link_split_section _bfd_generic_link_split_section
954 1.1.1.4 christos #define ihex_bfd_link_check_relocs _bfd_generic_link_check_relocs
955 1.1 christos
956 1.1 christos /* The Intel Hex target vector. */
957 1.1 christos
958 1.1 christos const bfd_target ihex_vec =
959 1.1 christos {
960 1.1 christos "ihex", /* Name. */
961 1.1 christos bfd_target_ihex_flavour,
962 1.1 christos BFD_ENDIAN_UNKNOWN, /* Target byte order. */
963 1.1 christos BFD_ENDIAN_UNKNOWN, /* Target headers byte order. */
964 1.1 christos 0, /* Object flags. */
965 1.1 christos (SEC_HAS_CONTENTS | SEC_ALLOC | SEC_LOAD), /* Section flags. */
966 1.1 christos 0, /* Leading underscore. */
967 1.1 christos ' ', /* AR_pad_char. */
968 1.1 christos 16, /* AR_max_namelen. */
969 1.1 christos 0, /* match priority. */
970 1.1 christos bfd_getb64, bfd_getb_signed_64, bfd_putb64,
971 1.1 christos bfd_getb32, bfd_getb_signed_32, bfd_putb32,
972 1.1 christos bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Data. */
973 1.1 christos bfd_getb64, bfd_getb_signed_64, bfd_putb64,
974 1.1 christos bfd_getb32, bfd_getb_signed_32, bfd_putb32,
975 1.1 christos bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Headers. */
976 1.1 christos
977 1.1 christos {
978 1.1 christos _bfd_dummy_target,
979 1.1 christos ihex_object_p, /* bfd_check_format. */
980 1.1 christos _bfd_dummy_target,
981 1.1 christos _bfd_dummy_target,
982 1.1 christos },
983 1.1 christos {
984 1.1.1.4 christos _bfd_bool_bfd_false_error,
985 1.1 christos ihex_mkobject,
986 1.1 christos _bfd_generic_mkarchive,
987 1.1.1.4 christos _bfd_bool_bfd_false_error,
988 1.1 christos },
989 1.1 christos { /* bfd_write_contents. */
990 1.1.1.4 christos _bfd_bool_bfd_false_error,
991 1.1 christos ihex_write_object_contents,
992 1.1 christos _bfd_write_archive_contents,
993 1.1.1.4 christos _bfd_bool_bfd_false_error,
994 1.1 christos },
995 1.1 christos
996 1.1 christos BFD_JUMP_TABLE_GENERIC (ihex),
997 1.1 christos BFD_JUMP_TABLE_COPY (_bfd_generic),
998 1.1 christos BFD_JUMP_TABLE_CORE (_bfd_nocore),
999 1.1 christos BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
1000 1.1 christos BFD_JUMP_TABLE_SYMBOLS (ihex),
1001 1.1 christos BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
1002 1.1 christos BFD_JUMP_TABLE_WRITE (ihex),
1003 1.1 christos BFD_JUMP_TABLE_LINK (ihex),
1004 1.1 christos BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
1005 1.1 christos
1006 1.1 christos NULL,
1007 1.1 christos
1008 1.1 christos NULL
1009 1.1 christos };
1010