1 /* BFD back-end for Intel Hex objects.
2 Copyright 1995 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
93 #include "libiberty.h"
97 static void ihex_init
PARAMS ((void));
98 static boolean ihex_mkobject
PARAMS ((bfd
*));
99 static INLINE
int ihex_get_byte
PARAMS ((bfd
*, boolean
*));
100 static void ihex_bad_byte
PARAMS ((bfd
*, unsigned int, int, boolean
));
101 static boolean ihex_scan
PARAMS ((bfd
*));
102 static const bfd_target
*ihex_object_p
PARAMS ((bfd
*));
103 static boolean ihex_read_section
PARAMS ((bfd
*, asection
*, bfd_byte
*));
104 static boolean ihex_get_section_contents
105 PARAMS ((bfd
*, asection
*, PTR
, file_ptr
, bfd_size_type
));
106 static boolean ihex_set_section_contents
107 PARAMS ((bfd
*, asection
*, PTR
, file_ptr
, bfd_size_type
));
108 static boolean ihex_write_record
109 PARAMS ((bfd
*, bfd_size_type
, bfd_vma
, unsigned int, bfd_byte
*));
110 static boolean ihex_write_object_contents
PARAMS ((bfd
*));
111 static asymbol
*ihex_make_empty_symbol
PARAMS ((bfd
*));
112 static boolean ihex_set_arch_mach
113 PARAMS ((bfd
*, enum bfd_architecture
, unsigned long));
115 /* The number of bytes we put on one line during output. */
119 /* Macros for converting between hex and binary. */
121 #define NIBBLE(x) (hex_value (x))
122 #define HEX2(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
123 #define HEX4(buffer) ((HEX2 (buffer) << 8) + HEX2 ((buffer) + 2))
124 #define ISHEX(x) (hex_p (x))
126 /* When we write out an ihex value, the values can not be output as
127 they are seen. Instead, we hold them in memory in this structure. */
129 struct ihex_data_list
131 struct ihex_data_list
*next
;
137 /* The ihex tdata information. */
139 struct ihex_data_struct
141 struct ihex_data_list
*head
;
142 struct ihex_data_list
*tail
;
145 /* Initialize by filling in the hex conversion array. */
150 static boolean inited
;
159 /* Create an ihex object. */
165 if (abfd
->tdata
.ihex_data
== NULL
)
167 struct ihex_data_struct
*tdata
;
169 tdata
= ((struct ihex_data_struct
*)
170 bfd_alloc (abfd
, sizeof (struct ihex_data_struct
)));
173 abfd
->tdata
.ihex_data
= tdata
;
181 /* Read a byte from a BFD. Set *ERRORPTR if an error occurred.
182 Return EOF on error or end of file. */
185 ihex_get_byte (abfd
, errorptr
)
191 if (bfd_read (&c
, 1, 1, abfd
) != 1)
193 if (bfd_get_error () != bfd_error_file_truncated
)
198 return (int) (c
& 0xff);
201 /* Report a problem in an Intel Hex file. */
204 ihex_bad_byte (abfd
, lineno
, c
, error
)
213 bfd_set_error (bfd_error_file_truncated
);
220 sprintf (buf
, "\\%03o", (unsigned int) c
);
226 (*_bfd_error_handler
)
227 ("%s:%d: unexpected character `%s' in Intel Hex file\n",
228 bfd_get_filename (abfd
), lineno
, buf
);
229 bfd_set_error (bfd_error_bad_value
);
233 /* Read an Intel hex file and turn it into sections. We create a new
234 section for each contiguous set of bytes. */
248 if (bfd_seek (abfd
, (file_ptr
) 0, SEEK_SET
) != 0)
257 while ((c
= ihex_get_byte (abfd
, &error
)) != EOF
)
268 ihex_bad_byte (abfd
, lineno
, c
, error
);
282 /* This is a data record. */
284 pos
= bfd_tell (abfd
) - 1;
286 /* Read the header bytes. */
288 if (bfd_read (hdr
, 1, 8, abfd
) != 8)
291 for (i
= 0; i
< 8; i
++)
293 if (! ISHEX (hdr
[i
]))
295 ihex_bad_byte (abfd
, lineno
, hdr
[i
], error
);
301 addr
= HEX4 (hdr
+ 2);
302 type
= HEX2 (hdr
+ 6);
304 /* Read the data bytes. */
307 if (chars
>= bufsize
)
309 buf
= (bfd_byte
*) bfd_realloc (buf
, chars
);
315 if (bfd_read (buf
, 1, chars
, abfd
) != chars
)
318 for (i
= 0; i
< chars
; i
++)
320 if (! ISHEX (buf
[i
]))
322 ihex_bad_byte (abfd
, lineno
, hdr
[i
], error
);
327 /* Check the checksum. */
328 chksum
= len
+ addr
+ (addr
>> 8) + type
;
329 for (i
= 0; i
< len
; i
++)
330 chksum
+= HEX2 (buf
+ 2 * i
);
331 if (((- chksum
) & 0xff) != (unsigned int) HEX2 (buf
+ 2 * i
))
333 (*_bfd_error_handler
)
334 ("%s:%d: bad checksum in Intel Hex file (expected %u, found %u)",
335 bfd_get_filename (abfd
), lineno
,
336 (- chksum
) & 0xff, (unsigned int) HEX2 (buf
+ 2 * i
));
337 bfd_set_error (bfd_error_bad_value
);
344 /* This is a data record. */
346 && sec
->vma
+ sec
->_raw_size
== base
+ addr
)
348 /* This data goes at the end of the section we are
349 currently building. */
350 sec
->_raw_size
+= len
;
357 sprintf (secbuf
, ".sec%d", bfd_count_sections (abfd
) + 1);
358 secname
= (char *) bfd_alloc (abfd
, strlen (secbuf
) + 1);
361 strcpy (secname
, secbuf
);
362 sec
= bfd_make_section (abfd
, secname
);
365 sec
->flags
= SEC_HAS_CONTENTS
| SEC_LOAD
| SEC_ALLOC
;
366 sec
->vma
= base
+ addr
;
367 sec
->lma
= base
+ addr
;
368 sec
->_raw_size
= len
;
375 if (abfd
->start_address
== 0)
376 abfd
->start_address
= addr
;
382 /* An extended address record. */
385 (*_bfd_error_handler
)
386 ("%s:%d: bad extended address record length in Intel Hex file",
387 bfd_get_filename (abfd
), lineno
);
388 bfd_set_error (bfd_error_bad_value
);
392 base
= HEX4 (buf
) << 4;
399 /* An extended start address record. */
402 (*_bfd_error_handler
)
403 ("%s:%d: bad extended start address length in Intel Hex file",
404 bfd_get_filename (abfd
), lineno
);
405 bfd_set_error (bfd_error_bad_value
);
409 abfd
->start_address
= (HEX4 (buf
) << 4) + HEX4 (buf
+ 4);
416 (*_bfd_error_handler
)
417 ("%s:%d: unrecognized ihex type %u in Intel Hex file\n",
418 bfd_get_filename (abfd
), lineno
, type
);
419 bfd_set_error (bfd_error_bad_value
);
439 /* Try to recognize an Intel Hex file. */
441 static const bfd_target
*
451 if (bfd_seek (abfd
, (file_ptr
) 0, SEEK_SET
) != 0)
453 if (bfd_read (b
, 1, 9, abfd
) != 9)
455 if (bfd_get_error () == bfd_error_file_truncated
)
456 bfd_set_error (bfd_error_wrong_format
);
462 bfd_set_error (bfd_error_wrong_format
);
466 for (i
= 1; i
< 9; i
++)
470 bfd_set_error (bfd_error_wrong_format
);
478 bfd_set_error (bfd_error_wrong_format
);
482 /* OK, it looks like it really is an Intel Hex file. */
484 if (! ihex_mkobject (abfd
)
485 || ! ihex_scan (abfd
))
491 /* Read the contents of a section in an Intel Hex file. */
494 ihex_read_section (abfd
, section
, contents
)
505 if (bfd_seek (abfd
, section
->filepos
, SEEK_SET
) != 0)
512 while ((c
= ihex_get_byte (abfd
, &error
)) != EOF
)
520 if (c
== '\r' || c
== '\n')
523 /* This is called after ihex_scan has succeeded, so we ought to
524 know the exact format. */
525 BFD_ASSERT (c
== ':');
527 if (bfd_read (hdr
, 1, 8, abfd
) != 8)
531 addr
= HEX4 (hdr
+ 2);
532 type
= HEX2 (hdr
+ 6);
534 /* We should only see type 0 records here. */
537 (*_bfd_error_handler
)
538 ("%s: internal error in ihex_read_section",
539 bfd_get_filename (abfd
));
540 bfd_set_error (bfd_error_bad_value
);
544 if (len
* 2 > bufsize
)
546 buf
= (bfd_byte
*) bfd_realloc (buf
, len
* 2);
552 if (bfd_read (buf
, 1, len
* 2, abfd
) != len
* 2)
555 for (i
= 0; i
< len
; i
++)
556 *p
++ = HEX2 (buf
+ 2 * i
);
557 if ((bfd_size_type
) (p
- contents
) >= section
->_raw_size
)
559 /* We've read everything in the section. */
565 /* Skip the checksum. */
566 if (bfd_read (buf
, 1, 2, abfd
) != 2)
570 if ((bfd_size_type
) (p
- contents
) < section
->_raw_size
)
572 (*_bfd_error_handler
)
573 ("%s: bad section length in ihex_read_section",
574 bfd_get_filename (abfd
));
575 bfd_set_error (bfd_error_bad_value
);
590 /* Get the contents of a section in an Intel Hex file. */
593 ihex_get_section_contents (abfd
, section
, location
, offset
, count
)
600 if (section
->used_by_bfd
== NULL
)
602 section
->used_by_bfd
= bfd_alloc (abfd
, section
->_raw_size
);
603 if (section
->used_by_bfd
== NULL
)
605 if (! ihex_read_section (abfd
, section
, section
->used_by_bfd
))
609 memcpy (location
, (bfd_byte
*) section
->used_by_bfd
+ offset
,
615 /* Set the contents of a section in an Intel Hex file. */
618 ihex_set_section_contents (abfd
, section
, location
, offset
, count
)
625 struct ihex_data_list
*n
;
627 struct ihex_data_struct
*tdata
;
630 || (section
->flags
& SEC_ALLOC
) == 0
631 || (section
->flags
& SEC_LOAD
) == 0)
634 /* Intel Hex files can only represent a limited number of addresses. */
635 if (section
->lma
+ offset
+ count
>= ((0xffff) << 4) + 0xffff)
639 sprintf_vma (buf
, section
->lma
+ offset
+ count
);
640 (*_bfd_error_handler
)
641 ("%s: address 0x%s out of range for Intel Hex file",
642 bfd_get_filename (abfd
), buf
);
643 bfd_set_error (bfd_error_invalid_operation
);
647 n
= ((struct ihex_data_list
*)
648 bfd_alloc (abfd
, sizeof (struct ihex_data_list
)));
652 data
= (bfd_byte
*) bfd_alloc (abfd
, count
);
655 memcpy (data
, location
, (size_t) count
);
658 n
->where
= section
->lma
+ offset
;
661 /* Sort the records by address. Optimize for the common case of
662 adding a record to the end of the list. */
663 tdata
= abfd
->tdata
.ihex_data
;
664 if (tdata
->tail
!= NULL
665 && n
->where
>= tdata
->tail
->where
)
667 tdata
->tail
->next
= n
;
673 register struct ihex_data_list
**pp
;
675 for (pp
= &tdata
->head
;
676 *pp
!= NULL
&& (*pp
)->where
< n
->where
;
688 /* Write a record out to an Intel Hex file. */
691 ihex_write_record (abfd
, count
, addr
, type
, data
)
698 static const char digs
[] = "0123456789ABCDEF";
699 char buf
[9 + CHUNK
* 2 + 4];
704 #define TOHEX(buf, v) \
705 ((buf)[0] = digs[((v) >> 4) & 0xf], (buf)[1] = digs[(v) & 0xf])
708 TOHEX (buf
+ 1, count
);
709 TOHEX (buf
+ 3, (addr
>> 8) & 0xff);
710 TOHEX (buf
+ 5, addr
& 0xff);
711 TOHEX (buf
+ 7, type
);
713 chksum
= count
+ addr
+ (addr
>> 8) + type
;
715 for (i
= 0, p
= buf
+ 9; i
< count
; i
++, p
+= 2, data
++)
721 TOHEX (p
, (- chksum
) & 0xff);
725 if (bfd_write (buf
, 1, 9 + count
* 2 + 4, abfd
) != 9 + count
* 2 + 4)
731 /* Write out an Intel Hex file. */
734 ihex_write_object_contents (abfd
)
738 struct ihex_data_list
*l
;
741 for (l
= abfd
->tdata
.ihex_data
->head
; l
!= NULL
; l
= l
->next
)
758 if (where
> base
+ 0xffff)
762 /* We need a new base address. We've already checked in
763 set_section_contents to make sure that we can
764 represent the address. */
765 base
= where
& 0xf0000;
766 addr
[0] = (base
>> 12) & 0xff;
767 addr
[1] = (base
>> 4) & 0xff;
768 if (! ihex_write_record (abfd
, 2, 0, 2, addr
))
772 if (! ihex_write_record (abfd
, now
, where
- base
, 0, p
))
781 if (abfd
->start_address
!= 0)
785 start
[0] = ((abfd
->start_address
& 0xf0000) >> 12) & 0xff;
787 start
[2] = (abfd
->start_address
>> 8) & 0xff;
788 start
[3] = abfd
->start_address
& 0xff;
789 if (! ihex_write_record (abfd
, 4, 0, 3, start
))
793 if (! ihex_write_record (abfd
, 0, 0, 1, NULL
))
799 /* Make an empty symbol. This is required only because
800 bfd_make_section_anyway wants to create a symbol for the section. */
803 ihex_make_empty_symbol (abfd
)
808 new = (asymbol
*) bfd_zalloc (abfd
, sizeof (asymbol
));
814 /* Set the architecture for the output file. The architecture is
815 irrelevant, so we ignore errors about unknown architectures. */
818 ihex_set_arch_mach (abfd
, arch
, mach
)
820 enum bfd_architecture arch
;
823 bfd_default_set_arch_mach (abfd
, arch
, mach
);
827 /* Get the size of the headers, for the linker. */
831 ihex_sizeof_headers (abfd
, exec
)
838 /* Some random definitions for the target vector. */
840 #define ihex_close_and_cleanup _bfd_generic_close_and_cleanup
841 #define ihex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
842 #define ihex_new_section_hook _bfd_generic_new_section_hook
843 #define ihex_get_section_contents_in_window \
844 _bfd_generic_get_section_contents_in_window
846 #define ihex_get_symtab_upper_bound _bfd_nosymbols_get_symtab_upper_bound
847 #define ihex_get_symtab _bfd_nosymbols_get_symtab
848 #define ihex_print_symbol _bfd_nosymbols_print_symbol
849 #define ihex_get_symbol_info _bfd_nosymbols_get_symbol_info
850 #define ihex_bfd_is_local_label _bfd_nosymbols_bfd_is_local_label
851 #define ihex_get_lineno _bfd_nosymbols_get_lineno
852 #define ihex_find_nearest_line _bfd_nosymbols_find_nearest_line
853 #define ihex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
854 #define ihex_read_minisymbols _bfd_nosymbols_read_minisymbols
855 #define ihex_minisymbol_to_symbol _bfd_nosymbols_minisymbol_to_symbol
857 #define ihex_get_reloc_upper_bound \
858 ((long (*) PARAMS ((bfd *, asection *))) bfd_0l)
859 #define ihex_canonicalize_reloc \
860 ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) bfd_0l)
861 #define ihex_bfd_reloc_type_lookup _bfd_norelocs_bfd_reloc_type_lookup
863 #define ihex_bfd_get_relocated_section_contents \
864 bfd_generic_get_relocated_section_contents
865 #define ihex_bfd_relax_section bfd_generic_relax_section
866 #define ihex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
867 #define ihex_bfd_link_add_symbols _bfd_generic_link_add_symbols
868 #define ihex_bfd_final_link _bfd_generic_final_link
869 #define ihex_bfd_link_split_section _bfd_generic_link_split_section
871 /* The Intel Hex target vector. */
873 const bfd_target ihex_vec
=
876 bfd_target_ihex_flavour
,
877 true, /* target byte order */
878 true, /* target headers byte order */
879 0, /* object flags */
880 (SEC_HAS_CONTENTS
| SEC_ALLOC
| SEC_LOAD
), /* section flags */
881 0, /* leading underscore */
882 ' ', /* ar_pad_char */
883 16, /* ar_max_namelen */
884 bfd_getb64
, bfd_getb_signed_64
, bfd_putb64
,
885 bfd_getb32
, bfd_getb_signed_32
, bfd_putb32
,
886 bfd_getb16
, bfd_getb_signed_16
, bfd_putb16
, /* data */
887 bfd_getb64
, bfd_getb_signed_64
, bfd_putb64
,
888 bfd_getb32
, bfd_getb_signed_32
, bfd_putb32
,
889 bfd_getb16
, bfd_getb_signed_16
, bfd_putb16
, /* hdrs */
893 ihex_object_p
, /* bfd_check_format */
900 _bfd_generic_mkarchive
,
903 { /* bfd_write_contents */
905 ihex_write_object_contents
,
906 _bfd_write_archive_contents
,
910 BFD_JUMP_TABLE_GENERIC (ihex
),
911 BFD_JUMP_TABLE_COPY (_bfd_generic
),
912 BFD_JUMP_TABLE_CORE (_bfd_nocore
),
913 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive
),
914 BFD_JUMP_TABLE_SYMBOLS (ihex
),
915 BFD_JUMP_TABLE_RELOCS (ihex
),
916 BFD_JUMP_TABLE_WRITE (ihex
),
917 BFD_JUMP_TABLE_LINK (ihex
),
918 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic
),