1 /* BFD back-end for Intel Hex objects.
2 Copyright (C) 1995-2018 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 & 0xff);
229 /* xgettext:c-format */
230 (_("%B:%d: unexpected character `%s' in Intel Hex file"),
232 bfd_set_error (bfd_error_bad_value);
236 /* Read an Intel hex file and turn it into sections. We create a new
237 section for each contiguous set of bytes. */
240 ihex_scan (bfd *abfd)
247 bfd_byte *buf = NULL;
251 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
254 abfd->start_address = 0;
263 while ((c = ihex_get_byte (abfd, &error)) != EOF)
274 ihex_bad_byte (abfd, lineno, c, error);
280 unsigned char hdr[8];
288 /* This is a data record. */
289 pos = bfd_tell (abfd) - 1;
291 /* Read the header bytes. */
292 if (bfd_bread (hdr, (bfd_size_type) 8, abfd) != 8)
295 for (i = 0; i < 8; i++)
297 if (! ISHEX (hdr[i]))
299 ihex_bad_byte (abfd, lineno, hdr[i], error);
305 addr = HEX4 (hdr + 2);
306 type = HEX2 (hdr + 6);
308 /* Read the data bytes. */
310 if (chars >= bufsize)
312 buf = (bfd_byte *) bfd_realloc (buf, (bfd_size_type) chars);
318 if (bfd_bread (buf, (bfd_size_type) chars, abfd) != chars)
321 for (i = 0; i < chars; i++)
323 if (! ISHEX (buf[i]))
325 ihex_bad_byte (abfd, lineno, buf[i], error);
330 /* Check the checksum. */
331 chksum = len + addr + (addr >> 8) + type;
332 for (i = 0; i < len; i++)
333 chksum += HEX2 (buf + 2 * i);
334 if (((- chksum) & 0xff) != (unsigned int) HEX2 (buf + 2 * i))
337 /* xgettext:c-format */
338 (_("%B:%u: bad checksum in Intel Hex file (expected %u, found %u)"),
340 (- chksum) & 0xff, (unsigned int) HEX2 (buf + 2 * i));
341 bfd_set_error (bfd_error_bad_value);
348 /* This is a data record. */
350 && sec->vma + sec->size == extbase + segbase + addr)
352 /* This data goes at the end of the section we are
353 currently building. */
363 sprintf (secbuf, ".sec%d", bfd_count_sections (abfd) + 1);
364 amt = strlen (secbuf) + 1;
365 secname = (char *) bfd_alloc (abfd, amt);
368 strcpy (secname, secbuf);
369 flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
370 sec = bfd_make_section_with_flags (abfd, secname, flags);
373 sec->vma = extbase + segbase + addr;
374 sec->lma = extbase + segbase + addr;
382 if (abfd->start_address == 0)
383 abfd->start_address = addr;
389 /* An extended address record. */
393 /* xgettext:c-format */
394 (_("%B:%u: bad extended address record length in Intel Hex file"),
396 bfd_set_error (bfd_error_bad_value);
400 segbase = HEX4 (buf) << 4;
407 /* An extended start address record. */
411 /* xgettext:c-format */
412 (_("%B:%u: bad extended start address length in Intel Hex file"),
414 bfd_set_error (bfd_error_bad_value);
418 abfd->start_address += (HEX4 (buf) << 4) + HEX4 (buf + 4);
425 /* An extended linear address record. */
429 /* xgettext:c-format */
430 (_("%B:%u: bad extended linear address record length in Intel Hex file"),
432 bfd_set_error (bfd_error_bad_value);
436 extbase = HEX4 (buf) << 16;
443 /* An extended linear start address record. */
444 if (len != 2 && len != 4)
447 /* xgettext:c-format */
448 (_("%B:%u: bad extended linear start address length in Intel Hex file"),
450 bfd_set_error (bfd_error_bad_value);
455 abfd->start_address += HEX4 (buf) << 16;
457 abfd->start_address = (HEX4 (buf) << 16) + HEX4 (buf + 4);
465 /* xgettext:c-format */
466 (_("%B:%u: unrecognized ihex type %u in Intel Hex file"),
468 bfd_set_error (bfd_error_bad_value);
488 /* Try to recognize an Intel Hex file. */
490 static const bfd_target *
491 ihex_object_p (bfd *abfd)
500 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
502 if (bfd_bread (b, (bfd_size_type) 9, abfd) != 9)
504 if (bfd_get_error () == bfd_error_file_truncated)
505 bfd_set_error (bfd_error_wrong_format);
511 bfd_set_error (bfd_error_wrong_format);
515 for (i = 1; i < 9; i++)
519 bfd_set_error (bfd_error_wrong_format);
527 bfd_set_error (bfd_error_wrong_format);
531 /* OK, it looks like it really is an Intel Hex file. */
532 tdata_save = abfd->tdata.any;
533 if (! ihex_mkobject (abfd) || ! ihex_scan (abfd))
535 if (abfd->tdata.any != tdata_save && abfd->tdata.any != NULL)
536 bfd_release (abfd, abfd->tdata.any);
537 abfd->tdata.any = tdata_save;
544 /* Read the contents of a section in an Intel Hex file. */
547 ihex_read_section (bfd *abfd, asection *section, bfd_byte *contents)
551 bfd_byte *buf = NULL;
555 if (bfd_seek (abfd, section->filepos, SEEK_SET) != 0)
561 while ((c = ihex_get_byte (abfd, &error)) != EOF)
563 unsigned char hdr[8];
568 if (c == '\r' || c == '\n')
571 /* This is called after ihex_scan has succeeded, so we ought to
572 know the exact format. */
573 BFD_ASSERT (c == ':');
575 if (bfd_bread (hdr, (bfd_size_type) 8, abfd) != 8)
579 type = HEX2 (hdr + 6);
581 /* We should only see type 0 records here. */
585 (_("%B: internal error in ihex_read_section"), abfd);
586 bfd_set_error (bfd_error_bad_value);
590 if (len * 2 > bufsize)
592 buf = (bfd_byte *) bfd_realloc (buf, (bfd_size_type) len * 2);
598 if (bfd_bread (buf, (bfd_size_type) len * 2, abfd) != len * 2)
601 for (i = 0; i < len; i++)
602 *p++ = HEX2 (buf + 2 * i);
603 if ((bfd_size_type) (p - contents) >= section->size)
605 /* We've read everything in the section. */
611 /* Skip the checksum. */
612 if (bfd_bread (buf, (bfd_size_type) 2, abfd) != 2)
616 if ((bfd_size_type) (p - contents) < section->size)
619 (_("%B: bad section length in ihex_read_section"), abfd);
620 bfd_set_error (bfd_error_bad_value);
635 /* Get the contents of a section in an Intel Hex file. */
638 ihex_get_section_contents (bfd *abfd,
644 if (section->used_by_bfd == NULL)
646 section->used_by_bfd = bfd_alloc (abfd, section->size);
647 if (section->used_by_bfd == NULL)
649 if (! ihex_read_section (abfd, section,
650 (bfd_byte *) section->used_by_bfd))
654 memcpy (location, (bfd_byte *) section->used_by_bfd + offset,
660 /* Set the contents of a section in an Intel Hex file. */
663 ihex_set_section_contents (bfd *abfd,
665 const void * location,
669 struct ihex_data_list *n;
671 struct ihex_data_struct *tdata;
674 || (section->flags & SEC_ALLOC) == 0
675 || (section->flags & SEC_LOAD) == 0)
678 n = (struct ihex_data_list *) bfd_alloc (abfd, sizeof (* n));
682 data = (bfd_byte *) bfd_alloc (abfd, count);
685 memcpy (data, location, (size_t) count);
688 n->where = section->lma + offset;
691 /* Sort the records by address. Optimize for the common case of
692 adding a record to the end of the list. */
693 tdata = abfd->tdata.ihex_data;
694 if (tdata->tail != NULL
695 && n->where >= tdata->tail->where)
697 tdata->tail->next = n;
703 struct ihex_data_list **pp;
705 for (pp = &tdata->head;
706 *pp != NULL && (*pp)->where < n->where;
718 /* Write a record out to an Intel Hex file. */
721 ihex_write_record (bfd *abfd,
727 static const char digs[] = "0123456789ABCDEF";
728 char buf[9 + CHUNK * 2 + 4];
734 #define TOHEX(buf, v) \
735 ((buf)[0] = digs[((v) >> 4) & 0xf], (buf)[1] = digs[(v) & 0xf])
738 TOHEX (buf + 1, count);
739 TOHEX (buf + 3, (addr >> 8) & 0xff);
740 TOHEX (buf + 5, addr & 0xff);
741 TOHEX (buf + 7, type);
743 chksum = count + addr + (addr >> 8) + type;
745 for (i = 0, p = buf + 9; i < count; i++, p += 2, data++)
751 TOHEX (p, (- chksum) & 0xff);
755 total = 9 + count * 2 + 4;
756 if (bfd_bwrite (buf, (bfd_size_type) total, abfd) != total)
762 /* Write out an Intel Hex file. */
765 ihex_write_object_contents (bfd *abfd)
769 struct ihex_data_list *l;
773 for (l = abfd->tdata.ihex_data->head; l != NULL; l = l->next)
786 unsigned int rec_addr;
792 if (where > segbase + extbase + 0xffff)
796 /* We need a new base address. */
797 if (where <= 0xfffff)
799 /* The addresses should be sorted. */
800 BFD_ASSERT (extbase == 0);
802 segbase = where & 0xf0000;
803 addr[0] = (bfd_byte)(segbase >> 12) & 0xff;
804 addr[1] = (bfd_byte)(segbase >> 4) & 0xff;
805 if (! ihex_write_record (abfd, 2, 0, 2, addr))
810 /* The extended address record and the extended
811 linear address record are combined, at least by
812 some readers. We need an extended linear address
813 record here, so if we've already written out an
814 extended address record, zero it out to avoid
820 if (! ihex_write_record (abfd, 2, 0, 2, addr))
825 extbase = where & 0xffff0000;
826 if (where > extbase + 0xffff)
829 /* xgettext:c-format */
830 (_("%B: address %#Lx out of range for Intel Hex file"),
832 bfd_set_error (bfd_error_bad_value);
835 addr[0] = (bfd_byte)(extbase >> 24) & 0xff;
836 addr[1] = (bfd_byte)(extbase >> 16) & 0xff;
837 if (! ihex_write_record (abfd, 2, 0, 4, addr))
842 rec_addr = where - (extbase + segbase);
844 /* Output records shouldn't cross 64K boundaries. */
845 if (rec_addr + now > 0xffff)
846 now = 0x10000 - rec_addr;
848 if (! ihex_write_record (abfd, now, rec_addr, 0, p))
857 if (abfd->start_address != 0)
860 bfd_byte startbuf[4];
862 start = abfd->start_address;
864 if (start <= 0xfffff)
866 startbuf[0] = (bfd_byte)((start & 0xf0000) >> 12) & 0xff;
868 startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
869 startbuf[3] = (bfd_byte)start & 0xff;
870 if (! ihex_write_record (abfd, 4, 0, 3, startbuf))
875 startbuf[0] = (bfd_byte)(start >> 24) & 0xff;
876 startbuf[1] = (bfd_byte)(start >> 16) & 0xff;
877 startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
878 startbuf[3] = (bfd_byte)start & 0xff;
879 if (! ihex_write_record (abfd, 4, 0, 5, startbuf))
884 if (! ihex_write_record (abfd, 0, 0, 1, NULL))
890 /* Set the architecture for the output file. The architecture is
891 irrelevant, so we ignore errors about unknown architectures. */
894 ihex_set_arch_mach (bfd *abfd,
895 enum bfd_architecture arch,
898 if (! bfd_default_set_arch_mach (abfd, arch, mach))
900 if (arch != bfd_arch_unknown)
906 /* Get the size of the headers, for the linker. */
909 ihex_sizeof_headers (bfd *abfd ATTRIBUTE_UNUSED,
910 struct bfd_link_info *info ATTRIBUTE_UNUSED)
915 /* Some random definitions for the target vector. */
917 #define ihex_close_and_cleanup _bfd_generic_close_and_cleanup
918 #define ihex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
919 #define ihex_new_section_hook _bfd_generic_new_section_hook
920 #define ihex_get_section_contents_in_window _bfd_generic_get_section_contents_in_window
921 #define ihex_get_symtab_upper_bound bfd_0l
922 #define ihex_canonicalize_symtab ((long (*) (bfd *, asymbol **)) bfd_0l_any)
923 #define ihex_make_empty_symbol _bfd_generic_make_empty_symbol
924 #define ihex_print_symbol _bfd_nosymbols_print_symbol
925 #define ihex_get_symbol_info _bfd_nosymbols_get_symbol_info
926 #define ihex_get_symbol_version_string _bfd_nosymbols_get_symbol_version_string
927 #define ihex_bfd_is_target_special_symbol ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false_any)
928 #define ihex_bfd_is_local_label_name _bfd_nosymbols_bfd_is_local_label_name
929 #define ihex_get_lineno _bfd_nosymbols_get_lineno
930 #define ihex_find_nearest_line _bfd_nosymbols_find_nearest_line
931 #define ihex_find_line _bfd_nosymbols_find_line
932 #define ihex_find_inliner_info _bfd_nosymbols_find_inliner_info
933 #define ihex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
934 #define ihex_read_minisymbols _bfd_nosymbols_read_minisymbols
935 #define ihex_minisymbol_to_symbol _bfd_nosymbols_minisymbol_to_symbol
936 #define ihex_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
937 #define ihex_bfd_relax_section bfd_generic_relax_section
938 #define ihex_bfd_gc_sections bfd_generic_gc_sections
939 #define ihex_bfd_lookup_section_flags bfd_generic_lookup_section_flags
940 #define ihex_bfd_merge_sections bfd_generic_merge_sections
941 #define ihex_bfd_is_group_section bfd_generic_is_group_section
942 #define ihex_bfd_discard_group bfd_generic_discard_group
943 #define ihex_section_already_linked _bfd_generic_section_already_linked
944 #define ihex_bfd_define_common_symbol bfd_generic_define_common_symbol
945 #define ihex_bfd_define_start_stop bfd_generic_define_start_stop
946 #define ihex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
947 #define ihex_bfd_link_add_symbols _bfd_generic_link_add_symbols
948 #define ihex_bfd_link_just_syms _bfd_generic_link_just_syms
949 #define ihex_bfd_copy_link_hash_symbol_type _bfd_generic_copy_link_hash_symbol_type
950 #define ihex_bfd_final_link _bfd_generic_final_link
951 #define ihex_bfd_link_split_section _bfd_generic_link_split_section
952 #define ihex_bfd_link_check_relocs _bfd_generic_link_check_relocs
954 /* The Intel Hex target vector. */
956 const bfd_target ihex_vec =
959 bfd_target_ihex_flavour,
960 BFD_ENDIAN_UNKNOWN, /* Target byte order. */
961 BFD_ENDIAN_UNKNOWN, /* Target headers byte order. */
962 0, /* Object flags. */
963 (SEC_HAS_CONTENTS | SEC_ALLOC | SEC_LOAD), /* Section flags. */
964 0, /* Leading underscore. */
965 ' ', /* AR_pad_char. */
966 16, /* AR_max_namelen. */
967 0, /* match priority. */
968 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
969 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
970 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Data. */
971 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
972 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
973 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Headers. */
977 ihex_object_p, /* bfd_check_format. */
984 _bfd_generic_mkarchive,
987 { /* bfd_write_contents. */
989 ihex_write_object_contents,
990 _bfd_write_archive_contents,
994 BFD_JUMP_TABLE_GENERIC (ihex),
995 BFD_JUMP_TABLE_COPY (_bfd_generic),
996 BFD_JUMP_TABLE_CORE (_bfd_nocore),
997 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
998 BFD_JUMP_TABLE_SYMBOLS (ihex),
999 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
1000 BFD_JUMP_TABLE_WRITE (ihex),
1001 BFD_JUMP_TABLE_LINK (ihex),
1002 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),