1 /* BFD back-end for Intel Hex objects.
2 Copyright (C) 1995-2014 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 3 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., 51 Franklin Street - Fifth Floor, Boston,
20 MA 02110-1301, USA. */
23 /* This is what Intel Hex files look like:
29 16-bit address-field format, for files 64k bytes in length or less.
32 Byte 1 Header = colon(:)
33 2..3 The number of data bytes in hex notation
34 4..5 High byte of the record load address
35 6..7 Low byte of the record load address
36 8..9 Record type, must be "00"
37 10..x Data bytes in hex notation:
38 x = (number of bytes - 1) * 2 + 11
39 x+1..x+2 Checksum in hex notation
40 x+3..x+4 Carriage return, line feed
43 Byte 1 Header = colon (:)
44 2..3 The byte count, must be "00"
45 4..7 Transfer-address (usually "0000")
46 the jump-to address, execution start address
47 8..9 Record type, must be "01"
48 10..11 Checksum, in hex notation
49 12..13 Carriage return, line feed
53 MCS-86 format, using a 20-bit address for files larger than 64K bytes.
56 Byte 1 Header = colon (:)
57 2..3 The byte count of this record, hex notation
58 4..5 High byte of the record load address
59 6..7 Low byte of the record load address
60 8..9 Record type, must be "00"
61 10..x The data bytes in hex notation:
62 x = (number of data bytes - 1) * 2 + 11
63 x+1..x+2 Checksum in hex notation
64 x+3..x+4 Carriage return, line feed
66 EXTENDED ADDRESS RECORD
67 Byte 1 Header = colon(:)
68 2..3 The byte count, must be "02"
69 4..7 Load address, must be "0000"
70 8..9 Record type, must be "02"
71 10..11 High byte of the offset address
72 12..13 Low byte of the offset address
73 14..15 Checksum in hex notation
74 16..17 Carriage return, line feed
76 The checksums are the two's complement of the 8-bit sum
77 without carry of the byte count, offset address, and the
81 Byte 1 Header = colon (:)
82 2..3 The byte count, must be "04"
83 4..7 Load address, must be "0000"
84 8..9 Record type, must be "03"
87 18..19 Checksum in hex notation
88 20..21 Carriage return, line feed
90 Another document reports these additional types:
92 EXTENDED LINEAR ADDRESS RECORD
93 Byte 1 Header = colon (:)
94 2..3 The byte count, must be "02"
95 4..7 Load address, must be "0000"
96 8..9 Record type, must be "04"
97 10..13 Upper 16 bits of address of subsequent records
98 14..15 Checksum in hex notation
99 16..17 Carriage return, line feed
101 START LINEAR ADDRESS RECORD
102 Byte 1 Header = colon (:)
103 2..3 The byte count, must be "02"
104 4..7 Load address, must be "0000"
105 8..9 Record type, must be "05"
106 10..13 Upper 16 bits of start address
107 14..15 Checksum in hex notation
108 16..17 Carriage return, line feed
110 The MRI compiler uses this, which is a repeat of type 5:
112 EXTENDED START RECORD
113 Byte 1 Header = colon (:)
114 2..3 The byte count, must be "04"
115 4..7 Load address, must be "0000"
116 8..9 Record type, must be "05"
117 10..13 Upper 16 bits of start address
118 14..17 Lower 16 bits of start address
119 18..19 Checksum in hex notation
120 20..21 Carriage return, line feed. */
125 #include "libiberty.h"
126 #include "safe-ctype.h"
128 /* The number of bytes we put on one line during output. */
132 /* Macros for converting between hex and binary. */
134 #define NIBBLE(x) (hex_value (x))
135 #define HEX2(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
136 #define HEX4(buffer) ((HEX2 (buffer) << 8) + HEX2 ((buffer) + 2))
137 #define ISHEX(x) (hex_p (x))
139 /* When we write out an ihex value, the values can not be output as
140 they are seen. Instead, we hold them in memory in this structure. */
142 struct ihex_data_list
144 struct ihex_data_list *next;
150 /* The ihex tdata information. */
152 struct ihex_data_struct
154 struct ihex_data_list *head;
155 struct ihex_data_list *tail;
158 /* Initialize by filling in the hex conversion array. */
163 static bfd_boolean inited;
172 /* Create an ihex object. */
175 ihex_mkobject (bfd *abfd)
177 struct ihex_data_struct *tdata;
179 tdata = (struct ihex_data_struct *) bfd_alloc (abfd, sizeof (* tdata));
183 abfd->tdata.ihex_data = tdata;
189 /* Read a byte from a BFD. Set *ERRORPTR if an error occurred.
190 Return EOF on error or end of file. */
193 ihex_get_byte (bfd *abfd, bfd_boolean *errorptr)
197 if (bfd_bread (&c, (bfd_size_type) 1, abfd) != 1)
199 if (bfd_get_error () != bfd_error_file_truncated)
204 return (int) (c & 0xff);
207 /* Report a problem in an Intel Hex file. */
210 ihex_bad_byte (bfd *abfd, unsigned int lineno, int c, bfd_boolean error)
215 bfd_set_error (bfd_error_file_truncated);
222 sprintf (buf, "\\%03o", (unsigned int) c);
228 (*_bfd_error_handler)
229 (_("%B:%d: unexpected character `%s' in Intel Hex file"),
231 bfd_set_error (bfd_error_bad_value);
235 /* Read an Intel hex file and turn it into sections. We create a new
236 section for each contiguous set of bytes. */
239 ihex_scan (bfd *abfd)
246 bfd_byte *buf = NULL;
250 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
253 abfd->start_address = 0;
262 while ((c = ihex_get_byte (abfd, &error)) != EOF)
273 ihex_bad_byte (abfd, lineno, c, error);
287 /* This is a data record. */
288 pos = bfd_tell (abfd) - 1;
290 /* Read the header bytes. */
291 if (bfd_bread (hdr, (bfd_size_type) 8, abfd) != 8)
294 for (i = 0; i < 8; i++)
296 if (! ISHEX (hdr[i]))
298 ihex_bad_byte (abfd, lineno, hdr[i], error);
304 addr = HEX4 (hdr + 2);
305 type = HEX2 (hdr + 6);
307 /* Read the data bytes. */
309 if (chars >= bufsize)
311 buf = (bfd_byte *) bfd_realloc (buf, (bfd_size_type) chars);
317 if (bfd_bread (buf, (bfd_size_type) chars, abfd) != chars)
320 for (i = 0; i < chars; i++)
322 if (! ISHEX (buf[i]))
324 ihex_bad_byte (abfd, lineno, hdr[i], error);
329 /* Check the checksum. */
330 chksum = len + addr + (addr >> 8) + type;
331 for (i = 0; i < len; i++)
332 chksum += HEX2 (buf + 2 * i);
333 if (((- chksum) & 0xff) != (unsigned int) HEX2 (buf + 2 * i))
335 (*_bfd_error_handler)
336 (_("%B:%u: bad checksum in Intel Hex file (expected %u, found %u)"),
338 (- chksum) & 0xff, (unsigned int) HEX2 (buf + 2 * i));
339 bfd_set_error (bfd_error_bad_value);
346 /* This is a data record. */
348 && sec->vma + sec->size == extbase + segbase + addr)
350 /* This data goes at the end of the section we are
351 currently building. */
361 sprintf (secbuf, ".sec%d", bfd_count_sections (abfd) + 1);
362 amt = strlen (secbuf) + 1;
363 secname = (char *) bfd_alloc (abfd, amt);
366 strcpy (secname, secbuf);
367 flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
368 sec = bfd_make_section_with_flags (abfd, secname, flags);
371 sec->vma = extbase + segbase + addr;
372 sec->lma = extbase + segbase + addr;
380 if (abfd->start_address == 0)
381 abfd->start_address = addr;
387 /* An extended address record. */
390 (*_bfd_error_handler)
391 (_("%B:%u: bad extended address record length in Intel Hex file"),
393 bfd_set_error (bfd_error_bad_value);
397 segbase = HEX4 (buf) << 4;
404 /* An extended start address record. */
407 (*_bfd_error_handler)
408 (_("%B:%u: bad extended start address length in Intel Hex file"),
410 bfd_set_error (bfd_error_bad_value);
414 abfd->start_address += (HEX4 (buf) << 4) + HEX4 (buf + 4);
421 /* An extended linear address record. */
424 (*_bfd_error_handler)
425 (_("%B:%u: bad extended linear address record length in Intel Hex file"),
427 bfd_set_error (bfd_error_bad_value);
431 extbase = HEX4 (buf) << 16;
438 /* An extended linear start address record. */
439 if (len != 2 && len != 4)
441 (*_bfd_error_handler)
442 (_("%B:%u: bad extended linear start address length in Intel Hex file"),
444 bfd_set_error (bfd_error_bad_value);
449 abfd->start_address += HEX4 (buf) << 16;
451 abfd->start_address = (HEX4 (buf) << 16) + HEX4 (buf + 4);
458 (*_bfd_error_handler)
459 (_("%B:%u: unrecognized ihex type %u in Intel Hex file"),
461 bfd_set_error (bfd_error_bad_value);
481 /* Try to recognize an Intel Hex file. */
483 static const bfd_target *
484 ihex_object_p (bfd *abfd)
493 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
495 if (bfd_bread (b, (bfd_size_type) 9, abfd) != 9)
497 if (bfd_get_error () == bfd_error_file_truncated)
498 bfd_set_error (bfd_error_wrong_format);
504 bfd_set_error (bfd_error_wrong_format);
508 for (i = 1; i < 9; i++)
512 bfd_set_error (bfd_error_wrong_format);
520 bfd_set_error (bfd_error_wrong_format);
524 /* OK, it looks like it really is an Intel Hex file. */
525 tdata_save = abfd->tdata.any;
526 if (! ihex_mkobject (abfd) || ! ihex_scan (abfd))
528 if (abfd->tdata.any != tdata_save && abfd->tdata.any != NULL)
529 bfd_release (abfd, abfd->tdata.any);
530 abfd->tdata.any = tdata_save;
537 /* Read the contents of a section in an Intel Hex file. */
540 ihex_read_section (bfd *abfd, asection *section, bfd_byte *contents)
544 bfd_byte *buf = NULL;
548 if (bfd_seek (abfd, section->filepos, SEEK_SET) != 0)
554 while ((c = ihex_get_byte (abfd, &error)) != EOF)
561 if (c == '\r' || c == '\n')
564 /* This is called after ihex_scan has succeeded, so we ought to
565 know the exact format. */
566 BFD_ASSERT (c == ':');
568 if (bfd_bread (hdr, (bfd_size_type) 8, abfd) != 8)
572 type = HEX2 (hdr + 6);
574 /* We should only see type 0 records here. */
577 (*_bfd_error_handler)
578 (_("%B: internal error in ihex_read_section"), abfd);
579 bfd_set_error (bfd_error_bad_value);
583 if (len * 2 > bufsize)
585 buf = (bfd_byte *) bfd_realloc (buf, (bfd_size_type) len * 2);
591 if (bfd_bread (buf, (bfd_size_type) len * 2, abfd) != len * 2)
594 for (i = 0; i < len; i++)
595 *p++ = HEX2 (buf + 2 * i);
596 if ((bfd_size_type) (p - contents) >= section->size)
598 /* We've read everything in the section. */
604 /* Skip the checksum. */
605 if (bfd_bread (buf, (bfd_size_type) 2, abfd) != 2)
609 if ((bfd_size_type) (p - contents) < section->size)
611 (*_bfd_error_handler)
612 (_("%B: bad section length in ihex_read_section"), abfd);
613 bfd_set_error (bfd_error_bad_value);
628 /* Get the contents of a section in an Intel Hex file. */
631 ihex_get_section_contents (bfd *abfd,
637 if (section->used_by_bfd == NULL)
639 section->used_by_bfd = bfd_alloc (abfd, section->size);
640 if (section->used_by_bfd == NULL)
642 if (! ihex_read_section (abfd, section,
643 (bfd_byte *) section->used_by_bfd))
647 memcpy (location, (bfd_byte *) section->used_by_bfd + offset,
653 /* Set the contents of a section in an Intel Hex file. */
656 ihex_set_section_contents (bfd *abfd,
658 const void * location,
662 struct ihex_data_list *n;
664 struct ihex_data_struct *tdata;
667 || (section->flags & SEC_ALLOC) == 0
668 || (section->flags & SEC_LOAD) == 0)
671 n = (struct ihex_data_list *) bfd_alloc (abfd, sizeof (* n));
675 data = (bfd_byte *) bfd_alloc (abfd, count);
678 memcpy (data, location, (size_t) count);
681 n->where = section->lma + offset;
684 /* Sort the records by address. Optimize for the common case of
685 adding a record to the end of the list. */
686 tdata = abfd->tdata.ihex_data;
687 if (tdata->tail != NULL
688 && n->where >= tdata->tail->where)
690 tdata->tail->next = n;
696 struct ihex_data_list **pp;
698 for (pp = &tdata->head;
699 *pp != NULL && (*pp)->where < n->where;
711 /* Write a record out to an Intel Hex file. */
714 ihex_write_record (bfd *abfd,
720 static const char digs[] = "0123456789ABCDEF";
721 char buf[9 + CHUNK * 2 + 4];
727 #define TOHEX(buf, v) \
728 ((buf)[0] = digs[((v) >> 4) & 0xf], (buf)[1] = digs[(v) & 0xf])
731 TOHEX (buf + 1, count);
732 TOHEX (buf + 3, (addr >> 8) & 0xff);
733 TOHEX (buf + 5, addr & 0xff);
734 TOHEX (buf + 7, type);
736 chksum = count + addr + (addr >> 8) + type;
738 for (i = 0, p = buf + 9; i < count; i++, p += 2, data++)
744 TOHEX (p, (- chksum) & 0xff);
748 total = 9 + count * 2 + 4;
749 if (bfd_bwrite (buf, (bfd_size_type) total, abfd) != total)
755 /* Write out an Intel Hex file. */
758 ihex_write_object_contents (bfd *abfd)
762 struct ihex_data_list *l;
766 for (l = abfd->tdata.ihex_data->head; l != NULL; l = l->next)
779 unsigned int rec_addr;
785 if (where > segbase + extbase + 0xffff)
789 /* We need a new base address. */
790 if (where <= 0xfffff)
792 /* The addresses should be sorted. */
793 BFD_ASSERT (extbase == 0);
795 segbase = where & 0xf0000;
796 addr[0] = (bfd_byte)(segbase >> 12) & 0xff;
797 addr[1] = (bfd_byte)(segbase >> 4) & 0xff;
798 if (! ihex_write_record (abfd, 2, 0, 2, addr))
803 /* The extended address record and the extended
804 linear address record are combined, at least by
805 some readers. We need an extended linear address
806 record here, so if we've already written out an
807 extended address record, zero it out to avoid
813 if (! ihex_write_record (abfd, 2, 0, 2, addr))
818 extbase = where & 0xffff0000;
819 if (where > extbase + 0xffff)
823 sprintf_vma (buf, where);
824 (*_bfd_error_handler)
825 (_("%s: address 0x%s out of range for Intel Hex file"),
826 bfd_get_filename (abfd), buf);
827 bfd_set_error (bfd_error_bad_value);
830 addr[0] = (bfd_byte)(extbase >> 24) & 0xff;
831 addr[1] = (bfd_byte)(extbase >> 16) & 0xff;
832 if (! ihex_write_record (abfd, 2, 0, 4, addr))
837 rec_addr = where - (extbase + segbase);
839 /* Output records shouldn't cross 64K boundaries. */
840 if (rec_addr + now > 0xffff)
841 now = 0x10000 - rec_addr;
843 if (! ihex_write_record (abfd, now, rec_addr, 0, p))
852 if (abfd->start_address != 0)
855 bfd_byte startbuf[4];
857 start = abfd->start_address;
859 if (start <= 0xfffff)
861 startbuf[0] = (bfd_byte)((start & 0xf0000) >> 12) & 0xff;
863 startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
864 startbuf[3] = (bfd_byte)start & 0xff;
865 if (! ihex_write_record (abfd, 4, 0, 3, startbuf))
870 startbuf[0] = (bfd_byte)(start >> 24) & 0xff;
871 startbuf[1] = (bfd_byte)(start >> 16) & 0xff;
872 startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
873 startbuf[3] = (bfd_byte)start & 0xff;
874 if (! ihex_write_record (abfd, 4, 0, 5, startbuf))
879 if (! ihex_write_record (abfd, 0, 0, 1, NULL))
885 /* Set the architecture for the output file. The architecture is
886 irrelevant, so we ignore errors about unknown architectures. */
889 ihex_set_arch_mach (bfd *abfd,
890 enum bfd_architecture arch,
893 if (! bfd_default_set_arch_mach (abfd, arch, mach))
895 if (arch != bfd_arch_unknown)
901 /* Get the size of the headers, for the linker. */
904 ihex_sizeof_headers (bfd *abfd ATTRIBUTE_UNUSED,
905 struct bfd_link_info *info ATTRIBUTE_UNUSED)
910 /* Some random definitions for the target vector. */
912 #define ihex_close_and_cleanup _bfd_generic_close_and_cleanup
913 #define ihex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
914 #define ihex_new_section_hook _bfd_generic_new_section_hook
915 #define ihex_get_section_contents_in_window _bfd_generic_get_section_contents_in_window
916 #define ihex_get_symtab_upper_bound bfd_0l
917 #define ihex_canonicalize_symtab ((long (*) (bfd *, asymbol **)) bfd_0l)
918 #define ihex_make_empty_symbol _bfd_generic_make_empty_symbol
919 #define ihex_print_symbol _bfd_nosymbols_print_symbol
920 #define ihex_get_symbol_info _bfd_nosymbols_get_symbol_info
921 #define ihex_bfd_is_target_special_symbol ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
922 #define ihex_bfd_is_local_label_name _bfd_nosymbols_bfd_is_local_label_name
923 #define ihex_get_lineno _bfd_nosymbols_get_lineno
924 #define ihex_find_nearest_line _bfd_nosymbols_find_nearest_line
925 #define ihex_find_line _bfd_nosymbols_find_line
926 #define ihex_find_inliner_info _bfd_nosymbols_find_inliner_info
927 #define ihex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
928 #define ihex_read_minisymbols _bfd_nosymbols_read_minisymbols
929 #define ihex_minisymbol_to_symbol _bfd_nosymbols_minisymbol_to_symbol
930 #define ihex_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
931 #define ihex_bfd_relax_section bfd_generic_relax_section
932 #define ihex_bfd_gc_sections bfd_generic_gc_sections
933 #define ihex_bfd_lookup_section_flags bfd_generic_lookup_section_flags
934 #define ihex_bfd_merge_sections bfd_generic_merge_sections
935 #define ihex_bfd_is_group_section bfd_generic_is_group_section
936 #define ihex_bfd_discard_group bfd_generic_discard_group
937 #define ihex_section_already_linked _bfd_generic_section_already_linked
938 #define ihex_bfd_define_common_symbol bfd_generic_define_common_symbol
939 #define ihex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
940 #define ihex_bfd_link_add_symbols _bfd_generic_link_add_symbols
941 #define ihex_bfd_link_just_syms _bfd_generic_link_just_syms
942 #define ihex_bfd_copy_link_hash_symbol_type \
943 _bfd_generic_copy_link_hash_symbol_type
944 #define ihex_bfd_final_link _bfd_generic_final_link
945 #define ihex_bfd_link_split_section _bfd_generic_link_split_section
947 /* The Intel Hex target vector. */
949 const bfd_target ihex_vec =
952 bfd_target_ihex_flavour,
953 BFD_ENDIAN_UNKNOWN, /* Target byte order. */
954 BFD_ENDIAN_UNKNOWN, /* Target headers byte order. */
955 0, /* Object flags. */
956 (SEC_HAS_CONTENTS | SEC_ALLOC | SEC_LOAD), /* Section flags. */
957 0, /* Leading underscore. */
958 ' ', /* AR_pad_char. */
959 16, /* AR_max_namelen. */
960 0, /* match priority. */
961 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
962 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
963 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Data. */
964 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
965 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
966 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Headers. */
970 ihex_object_p, /* bfd_check_format. */
977 _bfd_generic_mkarchive,
980 { /* bfd_write_contents. */
982 ihex_write_object_contents,
983 _bfd_write_archive_contents,
987 BFD_JUMP_TABLE_GENERIC (ihex),
988 BFD_JUMP_TABLE_COPY (_bfd_generic),
989 BFD_JUMP_TABLE_CORE (_bfd_nocore),
990 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
991 BFD_JUMP_TABLE_SYMBOLS (ihex),
992 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
993 BFD_JUMP_TABLE_WRITE (ihex),
994 BFD_JUMP_TABLE_LINK (ihex),
995 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),