1 /* BFD back-end for Intel Hex objects.
2 Copyright 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor of Cygnus Support <ian@cygnus.com>.
5 This file is part of BFD, the Binary File Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
21 /* This is what Intel Hex files look like:
27 16-bit address-field format, for files 64k bytes in length or less.
30 Byte 1 Header = colon(:)
31 2..3 The number of data bytes in hex notation
32 4..5 High byte of the record load address
33 6..7 Low byte of the record load address
34 8..9 Record type, must be "00"
35 10..x Data bytes in hex notation:
36 x = (number of bytes - 1) * 2 + 11
37 x+1..x+2 Checksum in hex notation
38 x+3..x+4 Carriage return, line feed
41 Byte 1 Header = colon (:)
42 2..3 The byte count, must be "00"
43 4..7 Transfer-address (usually "0000")
44 the jump-to address, execution start address
45 8..9 Record type, must be "01"
46 10..11 Checksum, in hex notation
47 12..13 Carriage return, line feed
51 MCS-86 format, using a 20-bit address for files larger than 64K bytes.
54 Byte 1 Header = colon (:)
55 2..3 The byte count of this record, hex notation
56 4..5 High byte of the record load address
57 6..7 Low byte of the record load address
58 8..9 Record type, must be "00"
59 10..x The data bytes in hex notation:
60 x = (number of data bytes - 1) * 2 + 11
61 x+1..x+2 Checksum in hex notation
62 x+3..x+4 Carriage return, line feed
64 EXTENDED ADDRESS RECORD
65 Byte 1 Header = colon(:)
66 2..3 The byte count, must be "02"
67 4..7 Load address, must be "0000"
68 8..9 Record type, must be "02"
69 10..11 High byte of the offset address
70 12..13 Low byte of the offset address
71 14..15 Checksum in hex notation
72 16..17 Carriage return, line feed
74 The checksums are the two's complement of the 8-bit sum
75 without carry of the byte count, offset address, and the
79 Byte 1 Header = colon (:)
80 2..3 The byte count, must be "04"
81 4..7 Load address, must be "0000"
82 8..9 Record type, must be "03"
85 18..19 Checksum in hex notation
86 20..21 Carriage return, line feed
88 Another document reports these additional types:
90 EXTENDED LINEAR ADDRESS RECORD
91 Byte 1 Header = colon (:)
92 2..3 The byte count, must be "02"
93 4..7 Load address, must be "0000"
94 8..9 Record type, must be "04"
95 10..13 Upper 16 bits of address of subsequent records
96 14..15 Checksum in hex notation
97 16..17 Carriage return, line feed
99 START LINEAR ADDRESS RECORD
100 Byte 1 Header = colon (:)
101 2..3 The byte count, must be "02"
102 4..7 Load address, must be "0000"
103 8..9 Record type, must be "05"
104 10..13 Upper 16 bits of start address
105 14..15 Checksum in hex notation
106 16..17 Carriage return, line feed
108 The MRI compiler uses this, which is a repeat of type 5:
110 EXTENDED START RECORD
111 Byte 1 Header = colon (:)
112 2..3 The byte count, must be "04"
113 4..7 Load address, must be "0000"
114 8..9 Record type, must be "05"
115 10..13 Upper 16 bits of start address
116 14..17 Lower 16 bits of start address
117 18..19 Checksum in hex notation
118 20..21 Carriage return, line feed
124 #include "libiberty.h"
128 static void ihex_init PARAMS ((void));
129 static boolean ihex_mkobject PARAMS ((bfd *));
130 static INLINE int ihex_get_byte PARAMS ((bfd *, boolean *));
131 static void ihex_bad_byte PARAMS ((bfd *, unsigned int, int, boolean));
132 static boolean ihex_scan PARAMS ((bfd *));
133 static const bfd_target *ihex_object_p PARAMS ((bfd *));
134 static boolean ihex_read_section PARAMS ((bfd *, asection *, bfd_byte *));
135 static boolean ihex_get_section_contents
136 PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
137 static boolean ihex_set_section_contents
138 PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
139 static boolean ihex_write_record
140 PARAMS ((bfd *, bfd_size_type, bfd_vma, unsigned int, bfd_byte *));
141 static boolean ihex_write_object_contents PARAMS ((bfd *));
142 static asymbol *ihex_make_empty_symbol PARAMS ((bfd *));
143 static boolean ihex_set_arch_mach
144 PARAMS ((bfd *, enum bfd_architecture, unsigned long));
145 static int ihex_sizeof_headers PARAMS ((bfd *, boolean));
147 /* The number of bytes we put on one line during output. */
151 /* Macros for converting between hex and binary. */
153 #define NIBBLE(x) (hex_value (x))
154 #define HEX2(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
155 #define HEX4(buffer) ((HEX2 (buffer) << 8) + HEX2 ((buffer) + 2))
156 #define ISHEX(x) (hex_p (x))
158 /* When we write out an ihex value, the values can not be output as
159 they are seen. Instead, we hold them in memory in this structure. */
161 struct ihex_data_list
163 struct ihex_data_list *next;
169 /* The ihex tdata information. */
171 struct ihex_data_struct
173 struct ihex_data_list *head;
174 struct ihex_data_list *tail;
177 /* Initialize by filling in the hex conversion array. */
182 static boolean inited;
191 /* Create an ihex object. */
197 if (abfd->tdata.ihex_data == NULL)
199 struct ihex_data_struct *tdata;
201 tdata = ((struct ihex_data_struct *)
202 bfd_alloc (abfd, sizeof (struct ihex_data_struct)));
205 abfd->tdata.ihex_data = tdata;
213 /* Read a byte from a BFD. Set *ERRORPTR if an error occurred.
214 Return EOF on error or end of file. */
217 ihex_get_byte (abfd, errorptr)
223 if (bfd_read (&c, 1, 1, abfd) != 1)
225 if (bfd_get_error () != bfd_error_file_truncated)
230 return (int) (c & 0xff);
233 /* Report a problem in an Intel Hex file. */
236 ihex_bad_byte (abfd, lineno, c, error)
245 bfd_set_error (bfd_error_file_truncated);
252 sprintf (buf, "\\%03o", (unsigned int) c);
258 (*_bfd_error_handler)
259 (_("%s:%d: unexpected character `%s' in Intel Hex file\n"),
260 bfd_get_filename (abfd), lineno, buf);
261 bfd_set_error (bfd_error_bad_value);
265 /* Read an Intel hex file and turn it into sections. We create a new
266 section for each contiguous set of bytes. */
277 bfd_byte *buf = NULL;
281 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
284 abfd->start_address = 0;
292 while ((c = ihex_get_byte (abfd, &error)) != EOF)
303 ihex_bad_byte (abfd, lineno, c, error);
317 /* This is a data record. */
319 pos = bfd_tell (abfd) - 1;
321 /* Read the header bytes. */
323 if (bfd_read (hdr, 1, 8, abfd) != 8)
326 for (i = 0; i < 8; i++)
328 if (! ISHEX (hdr[i]))
330 ihex_bad_byte (abfd, lineno, hdr[i], error);
336 addr = HEX4 (hdr + 2);
337 type = HEX2 (hdr + 6);
339 /* Read the data bytes. */
342 if (chars >= bufsize)
344 buf = (bfd_byte *) bfd_realloc (buf, chars);
350 if (bfd_read (buf, 1, chars, abfd) != chars)
353 for (i = 0; i < chars; i++)
355 if (! ISHEX (buf[i]))
357 ihex_bad_byte (abfd, lineno, hdr[i], error);
362 /* Check the checksum. */
363 chksum = len + addr + (addr >> 8) + type;
364 for (i = 0; i < len; i++)
365 chksum += HEX2 (buf + 2 * i);
366 if (((- chksum) & 0xff) != (unsigned int) HEX2 (buf + 2 * i))
368 (*_bfd_error_handler)
369 (_("%s:%d: bad checksum in Intel Hex file (expected %u, found %u)"),
370 bfd_get_filename (abfd), lineno,
371 (- chksum) & 0xff, (unsigned int) HEX2 (buf + 2 * i));
372 bfd_set_error (bfd_error_bad_value);
379 /* This is a data record. */
381 && sec->vma + sec->_raw_size == extbase + segbase + addr)
383 /* This data goes at the end of the section we are
384 currently building. */
385 sec->_raw_size += len;
392 sprintf (secbuf, ".sec%d", bfd_count_sections (abfd) + 1);
393 secname = (char *) bfd_alloc (abfd, strlen (secbuf) + 1);
396 strcpy (secname, secbuf);
397 sec = bfd_make_section (abfd, secname);
400 sec->flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
401 sec->vma = extbase + segbase + addr;
402 sec->lma = extbase + segbase + addr;
403 sec->_raw_size = len;
410 if (abfd->start_address == 0)
411 abfd->start_address = addr;
417 /* An extended address record. */
420 (*_bfd_error_handler)
421 (_("%s:%d: bad extended address record length in Intel Hex file"),
422 bfd_get_filename (abfd), lineno);
423 bfd_set_error (bfd_error_bad_value);
427 segbase = HEX4 (buf) << 4;
434 /* An extended start address record. */
437 (*_bfd_error_handler)
438 (_("%s:%d: bad extended start address length in Intel Hex file"),
439 bfd_get_filename (abfd), lineno);
440 bfd_set_error (bfd_error_bad_value);
444 abfd->start_address += (HEX4 (buf) << 4) + HEX4 (buf + 4);
451 /* An extended linear address record. */
454 (*_bfd_error_handler)
455 (_("%s:%d: bad extended linear address record length in Intel Hex file"),
456 bfd_get_filename (abfd), lineno);
457 bfd_set_error (bfd_error_bad_value);
461 extbase = HEX4 (buf) << 16;
468 /* An extended linear start address record. */
469 if (len != 2 && len != 4)
471 (*_bfd_error_handler)
472 (_("%s:%d: bad extended linear start address length in Intel Hex file"),
473 bfd_get_filename (abfd), lineno);
474 bfd_set_error (bfd_error_bad_value);
479 abfd->start_address += HEX4 (buf) << 16;
481 abfd->start_address = (HEX4 (buf) << 16) + HEX4 (buf + 4);
488 (*_bfd_error_handler)
489 (_("%s:%d: unrecognized ihex type %u in Intel Hex file\n"),
490 bfd_get_filename (abfd), lineno, type);
491 bfd_set_error (bfd_error_bad_value);
511 /* Try to recognize an Intel Hex file. */
513 static const bfd_target *
523 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
525 if (bfd_read (b, 1, 9, abfd) != 9)
527 if (bfd_get_error () == bfd_error_file_truncated)
528 bfd_set_error (bfd_error_wrong_format);
534 bfd_set_error (bfd_error_wrong_format);
538 for (i = 1; i < 9; i++)
542 bfd_set_error (bfd_error_wrong_format);
550 bfd_set_error (bfd_error_wrong_format);
554 /* OK, it looks like it really is an Intel Hex file. */
556 if (! ihex_mkobject (abfd)
557 || ! ihex_scan (abfd))
563 /* Read the contents of a section in an Intel Hex file. */
566 ihex_read_section (abfd, section, contents)
573 bfd_byte *buf = NULL;
577 if (bfd_seek (abfd, section->filepos, SEEK_SET) != 0)
583 while ((c = ihex_get_byte (abfd, &error)) != EOF)
591 if (c == '\r' || c == '\n')
594 /* This is called after ihex_scan has succeeded, so we ought to
595 know the exact format. */
596 BFD_ASSERT (c == ':');
598 if (bfd_read (hdr, 1, 8, abfd) != 8)
602 addr = HEX4 (hdr + 2);
603 type = HEX2 (hdr + 6);
605 /* We should only see type 0 records here. */
608 (*_bfd_error_handler)
609 (_("%s: internal error in ihex_read_section"),
610 bfd_get_filename (abfd));
611 bfd_set_error (bfd_error_bad_value);
615 if (len * 2 > bufsize)
617 buf = (bfd_byte *) bfd_realloc (buf, len * 2);
623 if (bfd_read (buf, 1, len * 2, abfd) != len * 2)
626 for (i = 0; i < len; i++)
627 *p++ = HEX2 (buf + 2 * i);
628 if ((bfd_size_type) (p - contents) >= section->_raw_size)
630 /* We've read everything in the section. */
636 /* Skip the checksum. */
637 if (bfd_read (buf, 1, 2, abfd) != 2)
641 if ((bfd_size_type) (p - contents) < section->_raw_size)
643 (*_bfd_error_handler)
644 (_("%s: bad section length in ihex_read_section"),
645 bfd_get_filename (abfd));
646 bfd_set_error (bfd_error_bad_value);
661 /* Get the contents of a section in an Intel Hex file. */
664 ihex_get_section_contents (abfd, section, location, offset, count)
671 if (section->used_by_bfd == NULL)
673 section->used_by_bfd = bfd_alloc (abfd, section->_raw_size);
674 if (section->used_by_bfd == NULL)
676 if (! ihex_read_section (abfd, section, section->used_by_bfd))
680 memcpy (location, (bfd_byte *) section->used_by_bfd + offset,
686 /* Set the contents of a section in an Intel Hex file. */
689 ihex_set_section_contents (abfd, section, location, offset, count)
696 struct ihex_data_list *n;
698 struct ihex_data_struct *tdata;
701 || (section->flags & SEC_ALLOC) == 0
702 || (section->flags & SEC_LOAD) == 0)
705 n = ((struct ihex_data_list *)
706 bfd_alloc (abfd, sizeof (struct ihex_data_list)));
710 data = (bfd_byte *) bfd_alloc (abfd, count);
713 memcpy (data, location, (size_t) count);
716 n->where = section->lma + offset;
719 /* Sort the records by address. Optimize for the common case of
720 adding a record to the end of the list. */
721 tdata = abfd->tdata.ihex_data;
722 if (tdata->tail != NULL
723 && n->where >= tdata->tail->where)
725 tdata->tail->next = n;
731 register struct ihex_data_list **pp;
733 for (pp = &tdata->head;
734 *pp != NULL && (*pp)->where < n->where;
746 /* Write a record out to an Intel Hex file. */
749 ihex_write_record (abfd, count, addr, type, data)
756 static const char digs[] = "0123456789ABCDEF";
757 char buf[9 + CHUNK * 2 + 4];
762 #define TOHEX(buf, v) \
763 ((buf)[0] = digs[((v) >> 4) & 0xf], (buf)[1] = digs[(v) & 0xf])
766 TOHEX (buf + 1, count);
767 TOHEX (buf + 3, (addr >> 8) & 0xff);
768 TOHEX (buf + 5, addr & 0xff);
769 TOHEX (buf + 7, type);
771 chksum = count + addr + (addr >> 8) + type;
773 for (i = 0, p = buf + 9; i < count; i++, p += 2, data++)
779 TOHEX (p, (- chksum) & 0xff);
783 if (bfd_write (buf, 1, 9 + count * 2 + 4, abfd) != 9 + count * 2 + 4)
789 /* Write out an Intel Hex file. */
792 ihex_write_object_contents (abfd)
797 struct ihex_data_list *l;
801 for (l = abfd->tdata.ihex_data->head; l != NULL; l = l->next)
818 if (where > segbase + extbase + 0xffff)
822 /* We need a new base address. */
823 if (where <= 0xfffff)
825 /* The addresses should be sorted. */
826 BFD_ASSERT (extbase == 0);
828 segbase = where & 0xf0000;
829 addr[0] = (bfd_byte)(segbase >> 12) & 0xff;
830 addr[1] = (bfd_byte)(segbase >> 4) & 0xff;
831 if (! ihex_write_record (abfd, 2, 0, 2, addr))
836 /* The extended address record and the extended
837 linear address record are combined, at least by
838 some readers. We need an extended linear address
839 record here, so if we've already written out an
840 extended address record, zero it out to avoid
846 if (! ihex_write_record (abfd, 2, 0, 2, addr))
851 extbase = where & 0xffff0000;
852 if (where > extbase + 0xffff)
856 sprintf_vma (buf, where);
857 (*_bfd_error_handler)
858 (_("%s: address 0x%s out of range for Intex Hex file"),
859 bfd_get_filename (abfd), buf);
860 bfd_set_error (bfd_error_bad_value);
863 addr[0] = (bfd_byte)(extbase >> 24) & 0xff;
864 addr[1] = (bfd_byte)(extbase >> 16) & 0xff;
865 if (! ihex_write_record (abfd, 2, 0, 4, addr))
870 if (! ihex_write_record (abfd, now, where - (extbase + segbase),
880 if (abfd->start_address != 0)
883 bfd_byte startbuf[4];
885 start = abfd->start_address;
887 if (start <= 0xfffff)
889 startbuf[0] = (bfd_byte)((start & 0xf0000) >> 12) & 0xff;
891 startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
892 startbuf[3] = (bfd_byte)start & 0xff;
893 if (! ihex_write_record (abfd, 4, 0, 3, startbuf))
898 startbuf[0] = (bfd_byte)(start >> 24) & 0xff;
899 startbuf[1] = (bfd_byte)(start >> 16) & 0xff;
900 startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
901 startbuf[3] = (bfd_byte)start & 0xff;
902 if (! ihex_write_record (abfd, 4, 0, 5, startbuf))
907 if (! ihex_write_record (abfd, 0, 0, 1, NULL))
913 /* Make an empty symbol. This is required only because
914 bfd_make_section_anyway wants to create a symbol for the section. */
917 ihex_make_empty_symbol (abfd)
922 new = (asymbol *) bfd_zalloc (abfd, sizeof (asymbol));
928 /* Set the architecture for the output file. The architecture is
929 irrelevant, so we ignore errors about unknown architectures. */
932 ihex_set_arch_mach (abfd, arch, mach)
934 enum bfd_architecture arch;
937 if (! bfd_default_set_arch_mach (abfd, arch, mach))
939 if (arch != bfd_arch_unknown)
945 /* Get the size of the headers, for the linker. */
949 ihex_sizeof_headers (abfd, exec)
950 bfd *abfd ATTRIBUTE_UNUSED;
951 boolean exec ATTRIBUTE_UNUSED;
956 /* Some random definitions for the target vector. */
958 #define ihex_close_and_cleanup _bfd_generic_close_and_cleanup
959 #define ihex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
960 #define ihex_new_section_hook _bfd_generic_new_section_hook
961 #define ihex_get_section_contents_in_window \
962 _bfd_generic_get_section_contents_in_window
964 #define ihex_get_symtab_upper_bound bfd_0l
965 #define ihex_get_symtab \
966 ((long (*) PARAMS ((bfd *, asymbol **))) bfd_0l)
967 #define ihex_print_symbol _bfd_nosymbols_print_symbol
968 #define ihex_get_symbol_info _bfd_nosymbols_get_symbol_info
969 #define ihex_bfd_is_local_label_name _bfd_nosymbols_bfd_is_local_label_name
970 #define ihex_get_lineno _bfd_nosymbols_get_lineno
971 #define ihex_find_nearest_line _bfd_nosymbols_find_nearest_line
972 #define ihex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
973 #define ihex_read_minisymbols _bfd_nosymbols_read_minisymbols
974 #define ihex_minisymbol_to_symbol _bfd_nosymbols_minisymbol_to_symbol
976 #define ihex_get_reloc_upper_bound \
977 ((long (*) PARAMS ((bfd *, asection *))) bfd_0l)
978 #define ihex_canonicalize_reloc \
979 ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) bfd_0l)
980 #define ihex_bfd_reloc_type_lookup _bfd_norelocs_bfd_reloc_type_lookup
982 #define ihex_bfd_get_relocated_section_contents \
983 bfd_generic_get_relocated_section_contents
984 #define ihex_bfd_relax_section bfd_generic_relax_section
985 #define ihex_bfd_gc_sections bfd_generic_gc_sections
986 #define ihex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
987 #define ihex_bfd_link_add_symbols _bfd_generic_link_add_symbols
988 #define ihex_bfd_final_link _bfd_generic_final_link
989 #define ihex_bfd_link_split_section _bfd_generic_link_split_section
991 /* The Intel Hex target vector. */
993 const bfd_target ihex_vec =
996 bfd_target_ihex_flavour,
997 BFD_ENDIAN_UNKNOWN, /* target byte order */
998 BFD_ENDIAN_UNKNOWN, /* target headers byte order */
999 0, /* object flags */
1000 (SEC_HAS_CONTENTS | SEC_ALLOC | SEC_LOAD), /* section flags */
1001 0, /* leading underscore */
1002 ' ', /* ar_pad_char */
1003 16, /* ar_max_namelen */
1004 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
1005 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
1006 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* data */
1007 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
1008 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
1009 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* hdrs */
1013 ihex_object_p, /* bfd_check_format */
1020 _bfd_generic_mkarchive,
1023 { /* bfd_write_contents */
1025 ihex_write_object_contents,
1026 _bfd_write_archive_contents,
1030 BFD_JUMP_TABLE_GENERIC (ihex),
1031 BFD_JUMP_TABLE_COPY (_bfd_generic),
1032 BFD_JUMP_TABLE_CORE (_bfd_nocore),
1033 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
1034 BFD_JUMP_TABLE_SYMBOLS (ihex),
1035 BFD_JUMP_TABLE_RELOCS (ihex),
1036 BFD_JUMP_TABLE_WRITE (ihex),
1037 BFD_JUMP_TABLE_LINK (ihex),
1038 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),