1 /* BFD back-end for Intel Hex objects.
2 Copyright 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3 2006, 2007 Free Software Foundation, Inc.
4 Written by Ian Lance Taylor of Cygnus Support <ian@cygnus.com>.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
24 /* This is what Intel Hex files look like:
30 16-bit address-field format, for files 64k bytes in length or less.
33 Byte 1 Header = colon(:)
34 2..3 The number of data bytes in hex notation
35 4..5 High byte of the record load address
36 6..7 Low byte of the record load address
37 8..9 Record type, must be "00"
38 10..x Data bytes in hex notation:
39 x = (number of bytes - 1) * 2 + 11
40 x+1..x+2 Checksum in hex notation
41 x+3..x+4 Carriage return, line feed
44 Byte 1 Header = colon (:)
45 2..3 The byte count, must be "00"
46 4..7 Transfer-address (usually "0000")
47 the jump-to address, execution start address
48 8..9 Record type, must be "01"
49 10..11 Checksum, in hex notation
50 12..13 Carriage return, line feed
54 MCS-86 format, using a 20-bit address for files larger than 64K bytes.
57 Byte 1 Header = colon (:)
58 2..3 The byte count of this record, hex notation
59 4..5 High byte of the record load address
60 6..7 Low byte of the record load address
61 8..9 Record type, must be "00"
62 10..x The data bytes in hex notation:
63 x = (number of data bytes - 1) * 2 + 11
64 x+1..x+2 Checksum in hex notation
65 x+3..x+4 Carriage return, line feed
67 EXTENDED ADDRESS RECORD
68 Byte 1 Header = colon(:)
69 2..3 The byte count, must be "02"
70 4..7 Load address, must be "0000"
71 8..9 Record type, must be "02"
72 10..11 High byte of the offset address
73 12..13 Low byte of the offset address
74 14..15 Checksum in hex notation
75 16..17 Carriage return, line feed
77 The checksums are the two's complement of the 8-bit sum
78 without carry of the byte count, offset address, and the
82 Byte 1 Header = colon (:)
83 2..3 The byte count, must be "04"
84 4..7 Load address, must be "0000"
85 8..9 Record type, must be "03"
88 18..19 Checksum in hex notation
89 20..21 Carriage return, line feed
91 Another document reports these additional types:
93 EXTENDED LINEAR ADDRESS RECORD
94 Byte 1 Header = colon (:)
95 2..3 The byte count, must be "02"
96 4..7 Load address, must be "0000"
97 8..9 Record type, must be "04"
98 10..13 Upper 16 bits of address of subsequent records
99 14..15 Checksum in hex notation
100 16..17 Carriage return, line feed
102 START LINEAR ADDRESS RECORD
103 Byte 1 Header = colon (:)
104 2..3 The byte count, must be "02"
105 4..7 Load address, must be "0000"
106 8..9 Record type, must be "05"
107 10..13 Upper 16 bits of start address
108 14..15 Checksum in hex notation
109 16..17 Carriage return, line feed
111 The MRI compiler uses this, which is a repeat of type 5:
113 EXTENDED START RECORD
114 Byte 1 Header = colon (:)
115 2..3 The byte count, must be "04"
116 4..7 Load address, must be "0000"
117 8..9 Record type, must be "05"
118 10..13 Upper 16 bits of start address
119 14..17 Lower 16 bits of start address
120 18..19 Checksum in hex notation
121 20..21 Carriage return, line feed. */
126 #include "libiberty.h"
127 #include "safe-ctype.h"
129 /* The number of bytes we put on one line during output. */
133 /* Macros for converting between hex and binary. */
135 #define NIBBLE(x) (hex_value (x))
136 #define HEX2(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
137 #define HEX4(buffer) ((HEX2 (buffer) << 8) + HEX2 ((buffer) + 2))
138 #define ISHEX(x) (hex_p (x))
140 /* When we write out an ihex value, the values can not be output as
141 they are seen. Instead, we hold them in memory in this structure. */
143 struct ihex_data_list
145 struct ihex_data_list
*next
;
151 /* The ihex tdata information. */
153 struct ihex_data_struct
155 struct ihex_data_list
*head
;
156 struct ihex_data_list
*tail
;
159 /* Initialize by filling in the hex conversion array. */
164 static bfd_boolean inited
;
173 /* Create an ihex object. */
176 ihex_mkobject (bfd
*abfd
)
178 struct ihex_data_struct
*tdata
;
180 tdata
= bfd_alloc (abfd
, sizeof (* tdata
));
184 abfd
->tdata
.ihex_data
= tdata
;
190 /* Read a byte from a BFD. Set *ERRORPTR if an error occurred.
191 Return EOF on error or end of file. */
194 ihex_get_byte (bfd
*abfd
, bfd_boolean
*errorptr
)
198 if (bfd_bread (&c
, (bfd_size_type
) 1, abfd
) != 1)
200 if (bfd_get_error () != bfd_error_file_truncated
)
205 return (int) (c
& 0xff);
208 /* Report a problem in an Intel Hex file. */
211 ihex_bad_byte (bfd
*abfd
, unsigned int lineno
, int c
, bfd_boolean error
)
216 bfd_set_error (bfd_error_file_truncated
);
223 sprintf (buf
, "\\%03o", (unsigned int) c
);
229 (*_bfd_error_handler
)
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
);
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_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
, hdr
[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
))
336 (*_bfd_error_handler
)
337 (_("%B:%u: bad checksum in Intel Hex file (expected %u, found %u)"),
339 (- chksum
) & 0xff, (unsigned int) HEX2 (buf
+ 2 * i
));
340 bfd_set_error (bfd_error_bad_value
);
347 /* This is a data record. */
349 && sec
->vma
+ sec
->size
== extbase
+ segbase
+ addr
)
351 /* This data goes at the end of the section we are
352 currently building. */
362 sprintf (secbuf
, ".sec%d", bfd_count_sections (abfd
) + 1);
363 amt
= strlen (secbuf
) + 1;
364 secname
= bfd_alloc (abfd
, amt
);
367 strcpy (secname
, secbuf
);
368 flags
= SEC_HAS_CONTENTS
| SEC_LOAD
| SEC_ALLOC
;
369 sec
= bfd_make_section_with_flags (abfd
, secname
, flags
);
372 sec
->vma
= extbase
+ segbase
+ addr
;
373 sec
->lma
= extbase
+ segbase
+ addr
;
381 if (abfd
->start_address
== 0)
382 abfd
->start_address
= addr
;
388 /* An extended address record. */
391 (*_bfd_error_handler
)
392 (_("%B:%u: bad extended address record length in Intel Hex file"),
394 bfd_set_error (bfd_error_bad_value
);
398 segbase
= HEX4 (buf
) << 4;
405 /* An extended start address record. */
408 (*_bfd_error_handler
)
409 (_("%B:%u: bad extended start address length in Intel Hex file"),
411 bfd_set_error (bfd_error_bad_value
);
415 abfd
->start_address
+= (HEX4 (buf
) << 4) + HEX4 (buf
+ 4);
422 /* An extended linear address record. */
425 (*_bfd_error_handler
)
426 (_("%B:%u: bad extended linear address record length in Intel Hex file"),
428 bfd_set_error (bfd_error_bad_value
);
432 extbase
= HEX4 (buf
) << 16;
439 /* An extended linear start address record. */
440 if (len
!= 2 && len
!= 4)
442 (*_bfd_error_handler
)
443 (_("%B:%u: bad extended linear start address length in Intel Hex file"),
445 bfd_set_error (bfd_error_bad_value
);
450 abfd
->start_address
+= HEX4 (buf
) << 16;
452 abfd
->start_address
= (HEX4 (buf
) << 16) + HEX4 (buf
+ 4);
459 (*_bfd_error_handler
)
460 (_("%B:%u: unrecognized ihex type %u in Intel Hex file"),
462 bfd_set_error (bfd_error_bad_value
);
482 /* Try to recognize an Intel Hex file. */
484 static const bfd_target
*
485 ihex_object_p (bfd
*abfd
)
494 if (bfd_seek (abfd
, (file_ptr
) 0, SEEK_SET
) != 0)
496 if (bfd_bread (b
, (bfd_size_type
) 9, abfd
) != 9)
498 if (bfd_get_error () == bfd_error_file_truncated
)
499 bfd_set_error (bfd_error_wrong_format
);
505 bfd_set_error (bfd_error_wrong_format
);
509 for (i
= 1; i
< 9; i
++)
513 bfd_set_error (bfd_error_wrong_format
);
521 bfd_set_error (bfd_error_wrong_format
);
525 /* OK, it looks like it really is an Intel Hex file. */
526 tdata_save
= abfd
->tdata
.any
;
527 if (! ihex_mkobject (abfd
) || ! ihex_scan (abfd
))
529 if (abfd
->tdata
.any
!= tdata_save
&& abfd
->tdata
.any
!= NULL
)
530 bfd_release (abfd
, abfd
->tdata
.any
);
531 abfd
->tdata
.any
= tdata_save
;
538 /* Read the contents of a section in an Intel Hex file. */
541 ihex_read_section (bfd
*abfd
, asection
*section
, bfd_byte
*contents
)
545 bfd_byte
*buf
= NULL
;
549 if (bfd_seek (abfd
, section
->filepos
, SEEK_SET
) != 0)
555 while ((c
= ihex_get_byte (abfd
, &error
)) != EOF
)
562 if (c
== '\r' || c
== '\n')
565 /* This is called after ihex_scan has succeeded, so we ought to
566 know the exact format. */
567 BFD_ASSERT (c
== ':');
569 if (bfd_bread (hdr
, (bfd_size_type
) 8, abfd
) != 8)
573 type
= HEX2 (hdr
+ 6);
575 /* We should only see type 0 records here. */
578 (*_bfd_error_handler
)
579 (_("%B: internal error in ihex_read_section"), abfd
);
580 bfd_set_error (bfd_error_bad_value
);
584 if (len
* 2 > bufsize
)
586 buf
= bfd_realloc (buf
, (bfd_size_type
) len
* 2);
592 if (bfd_bread (buf
, (bfd_size_type
) len
* 2, abfd
) != len
* 2)
595 for (i
= 0; i
< len
; i
++)
596 *p
++ = HEX2 (buf
+ 2 * i
);
597 if ((bfd_size_type
) (p
- contents
) >= section
->size
)
599 /* We've read everything in the section. */
605 /* Skip the checksum. */
606 if (bfd_bread (buf
, (bfd_size_type
) 2, abfd
) != 2)
610 if ((bfd_size_type
) (p
- contents
) < section
->size
)
612 (*_bfd_error_handler
)
613 (_("%B: bad section length in ihex_read_section"), abfd
);
614 bfd_set_error (bfd_error_bad_value
);
629 /* Get the contents of a section in an Intel Hex file. */
632 ihex_get_section_contents (bfd
*abfd
,
638 if (section
->used_by_bfd
== NULL
)
640 section
->used_by_bfd
= bfd_alloc (abfd
, section
->size
);
641 if (section
->used_by_bfd
== NULL
)
643 if (! ihex_read_section (abfd
, section
, 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
= bfd_alloc (abfd
, sizeof (* n
));
675 data
= 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_inliner_info _bfd_nosymbols_find_inliner_info
926 #define ihex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
927 #define ihex_read_minisymbols _bfd_nosymbols_read_minisymbols
928 #define ihex_minisymbol_to_symbol _bfd_nosymbols_minisymbol_to_symbol
929 #define ihex_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
930 #define ihex_bfd_relax_section bfd_generic_relax_section
931 #define ihex_bfd_gc_sections bfd_generic_gc_sections
932 #define ihex_bfd_merge_sections bfd_generic_merge_sections
933 #define ihex_bfd_is_group_section bfd_generic_is_group_section
934 #define ihex_bfd_discard_group bfd_generic_discard_group
935 #define ihex_section_already_linked _bfd_generic_section_already_linked
936 #define ihex_bfd_define_common_symbol bfd_generic_define_common_symbol
937 #define ihex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
938 #define ihex_bfd_link_hash_table_free _bfd_generic_link_hash_table_free
939 #define ihex_bfd_link_add_symbols _bfd_generic_link_add_symbols
940 #define ihex_bfd_link_just_syms _bfd_generic_link_just_syms
941 #define ihex_bfd_final_link _bfd_generic_final_link
942 #define ihex_bfd_link_split_section _bfd_generic_link_split_section
944 /* The Intel Hex target vector. */
946 const bfd_target ihex_vec
=
949 bfd_target_ihex_flavour
,
950 BFD_ENDIAN_UNKNOWN
, /* Target byte order. */
951 BFD_ENDIAN_UNKNOWN
, /* Target headers byte order. */
952 0, /* Object flags. */
953 (SEC_HAS_CONTENTS
| SEC_ALLOC
| SEC_LOAD
), /* Section flags. */
954 0, /* Leading underscore. */
955 ' ', /* AR_pad_char. */
956 16, /* AR_max_namelen. */
957 bfd_getb64
, bfd_getb_signed_64
, bfd_putb64
,
958 bfd_getb32
, bfd_getb_signed_32
, bfd_putb32
,
959 bfd_getb16
, bfd_getb_signed_16
, bfd_putb16
, /* Data. */
960 bfd_getb64
, bfd_getb_signed_64
, bfd_putb64
,
961 bfd_getb32
, bfd_getb_signed_32
, bfd_putb32
,
962 bfd_getb16
, bfd_getb_signed_16
, bfd_putb16
, /* Headers. */
966 ihex_object_p
, /* bfd_check_format. */
973 _bfd_generic_mkarchive
,
976 { /* bfd_write_contents. */
978 ihex_write_object_contents
,
979 _bfd_write_archive_contents
,
983 BFD_JUMP_TABLE_GENERIC (ihex
),
984 BFD_JUMP_TABLE_COPY (_bfd_generic
),
985 BFD_JUMP_TABLE_CORE (_bfd_nocore
),
986 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive
),
987 BFD_JUMP_TABLE_SYMBOLS (ihex
),
988 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs
),
989 BFD_JUMP_TABLE_WRITE (ihex
),
990 BFD_JUMP_TABLE_LINK (ihex
),
991 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic
),