1 /* BFD backend for Extended Tektronix Hex Format objects.
2 Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2007 Free Software Foundation, Inc.
4 Written by Steve Chamberlain of Cygnus Support <sac@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. */
25 Tektronix Hex Format handling
29 Tek Hex records can hold symbols and data, but not
30 relocations. Their main application is communication with
31 devices like PROM programmers and ICE equipment.
33 It seems that the sections are described as being really big,
34 the example I have says that the text section is 0..ffffffff.
35 BFD would barf with this, many apps would try to alloc 4GB to
38 Tex Hex may contain many sections, but the data which comes in
39 has no tag saying which section it belongs to, so we create
40 one section for each block of data, called "blknnnn" which we
41 stick all the data into.
43 TekHex may come out of order and there is no header, so an
44 initial scan is required to discover the minimum and maximum
45 addresses used to create the vma and size of the sections we
47 We read in the data into pages of CHUNK_MASK+1 size and read
48 them out from that whenever we need to.
50 Any number of sections may be created for output, we save them
51 up and output them when it's time to close the bfd.
53 A TekHex record looks like:
55 %<block length><type><checksum><stuff><cr>
60 is the number of bytes in the record not including the % sign.
67 The data can come out of order, and may be discontigous. This is a
68 serial protocol, so big files are unlikely, so we keep a list of 8k chunks. */
73 #include "libiberty.h"
81 typedef struct tekhex_symbol_struct
84 struct tekhex_symbol_struct *prev;
87 static const char digs[] = "0123456789ABCDEF";
89 static char sum_block[256];
92 #define NIBBLE(x) hex_value(x)
93 #define HEX(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
94 #define ISHEX(x) hex_p(x)
96 (d)[1] = digs[(x) & 0xf]; \
97 (d)[0] = digs[((x)>>4)&0xf];
100 %3A6C6480004E56FFFC4E717063B0AEFFFC6D0652AEFFFC60F24E5E4E75
101 %1B3709T_SEGMENT1108FFFFFFFF
102 %2B3AB9T_SEGMENT7Dgcc_compiled$1087hello$c10
103 %373829T_SEGMENT80int$t1$r1$$214741080char$t2$r2$0$12710
104 %373769T_SEGMENT80long$int$t3$r1$$1080unsigned$int$t4$10
105 %373CA9T_SEGMENT80long$unsigned$in1080short$int$t6$r1$10
106 %373049T_SEGMENT80long$long$int$t71080short$unsigned$i10
107 %373A29T_SEGMENT80long$long$unsign1080signed$char$t10$10
108 %373D69T_SEGMENT80unsigned$char$t11080float$t12$r1$4$010
109 %373D19T_SEGMENT80double$t13$r1$8$1080long$double$t14$10
110 %2734D9T_SEGMENT8Bvoid$t15$151035_main10
111 %2F3CA9T_SEGMENT81$1081$1681$1E81$21487main$F110
112 %2832F9T_SEGMENT83i$18FFFFFFFC81$1481$214
116 %3A6C6480004E56FFFC4E717063B0AEFFFC6D0652AEFFFC60F24E5E4E75
118 | || +------ 4 char integer 0x8000
119 | |+-------- checksum
120 | +--------- type 6 (data record)
121 +----------- length 3a chars
122 <---------------------- 3a (58 chars) ------------------->
124 %1B3709T_SEGMENT1108FFFFFFFF
125 ^ ^^ ^- 8 character integer 0xffffffff
126 | |+- 1 character integer 0
127 | +-- type 1 symbol (section definition)
128 +------------ 9 char symbol T_SEGMENT
130 %2B3AB9T_SEGMENT7Dgcc_compiled$1087hello$c10
131 %373829T_SEGMENT80int$t1$r1$$214741080char$t2$r2$0$12710
132 %373769T_SEGMENT80long$int$t3$r1$$1080unsigned$int$t4$10
133 %373CA9T_SEGMENT80long$unsigned$in1080short$int$t6$r1$10
134 %373049T_SEGMENT80long$long$int$t71080short$unsigned$i10
135 %373A29T_SEGMENT80long$long$unsign1080signed$char$t10$10
136 %373D69T_SEGMENT80unsigned$char$t11080float$t12$r1$4$010
137 %373D19T_SEGMENT80double$t13$r1$8$1080long$double$t14$10
138 %2734D9T_SEGMENT8Bvoid$t15$151035_main10
139 %2F3CA9T_SEGMENT81$1081$1681$1E81$21487main$F110
140 %2832F9T_SEGMENT83i$18FFFFFFFC81$1481$214
144 sac@thepub$ ./objdump -dx -m m68k f
146 f: file format tekhex
147 -----x--- 9/55728 -134219416 Sep 29 15:13 1995 f
148 architecture: UNKNOWN!, flags 0x00000010:
150 start address 0x00000000
151 SECTION 0 [D00000000] : size 00020000 vma 00000000 align 2**0
153 SECTION 1 [D00008000] : size 00002001 vma 00008000 align 2**0
155 SECTION 2 [T_SEGMENT] : size ffffffff vma 00000000 align 2**0
158 00000000 g T_SEGMENT gcc_compiled$
159 00000000 g T_SEGMENT hello$c
160 00000000 g T_SEGMENT int$t1$r1$$21474
161 00000000 g T_SEGMENT char$t2$r2$0$127
162 00000000 g T_SEGMENT long$int$t3$r1$$
163 00000000 g T_SEGMENT unsigned$int$t4$
164 00000000 g T_SEGMENT long$unsigned$in
165 00000000 g T_SEGMENT short$int$t6$r1$
166 00000000 g T_SEGMENT long$long$int$t7
167 00000000 g T_SEGMENT short$unsigned$i
168 00000000 g T_SEGMENT long$long$unsign
169 00000000 g T_SEGMENT signed$char$t10$
170 00000000 g T_SEGMENT unsigned$char$t1
171 00000000 g T_SEGMENT float$t12$r1$4$0
172 00000000 g T_SEGMENT double$t13$r1$8$
173 00000000 g T_SEGMENT long$double$t14$
174 00000000 g T_SEGMENT void$t15$15
175 00000000 g T_SEGMENT _main
176 00000000 g T_SEGMENT $
177 00000000 g T_SEGMENT $
178 00000000 g T_SEGMENT $
179 00000010 g T_SEGMENT $
180 00000000 g T_SEGMENT main$F1
181 fcffffff g T_SEGMENT i$1
182 00000000 g T_SEGMENT $
183 00000010 g T_SEGMENT $
185 RELOCATION RECORDS FOR [D00000000]: (none)
187 RELOCATION RECORDS FOR [D00008000]: (none)
189 RELOCATION RECORDS FOR [T_SEGMENT]: (none)
191 Disassembly of section D00000000:
193 00008000 ($+)7ff0 linkw fp,#-4
194 00008004 ($+)7ff4 nop
195 00008006 ($+)7ff6 movel #99,d0
196 00008008 ($+)7ff8 cmpl fp@(-4),d0
197 0000800c ($+)7ffc blts 00008014 ($+)8004
198 0000800e ($+)7ffe addql #1,fp@(-4)
199 00008012 ($+)8002 bras 00008006 ($+)7ff6
200 00008014 ($+)8004 unlk fp
201 00008016 ($+)8006 rts
208 static bfd_boolean inited = FALSE;
216 for (i = 0; i < 10; i++)
217 sum_block[i + '0'] = val++;
219 for (i = 'A'; i <= 'Z'; i++)
220 sum_block[i] = val++;
222 sum_block['$'] = val++;
223 sum_block['%'] = val++;
224 sum_block['.'] = val++;
225 sum_block['_'] = val++;
226 for (i = 'a'; i <= 'z'; i++)
227 sum_block[i] = val++;
231 /* The maximum number of bytes on a line is FF. */
232 #define MAXCHUNK 0xff
233 /* The number of bytes we fit onto a line on output. */
236 /* We cannot output our tekhexords as we see them, we have to glue them
237 together, this is done in this structure : */
239 struct tekhex_data_list_struct
244 struct tekhex_data_list_struct *next;
247 typedef struct tekhex_data_list_struct tekhex_data_list_type;
249 #define CHUNK_MASK 0x1fff
253 char chunk_data[CHUNK_MASK + 1];
254 char chunk_init[CHUNK_MASK + 1];
256 struct data_struct *next;
259 typedef struct tekhex_data_struct
261 tekhex_data_list_type *head;
263 struct tekhex_symbol_struct *symbols;
264 struct data_struct *data;
267 #define enda(x) (x->vma + x->size)
270 getvalue (char **srcp, bfd_vma *valuep)
279 len = hex_value (*src++);
286 value = value << 4 | hex_value (*src++);
295 getsym (char *dstp, char **srcp, unsigned int *lenp)
304 len = hex_value (*src++);
307 for (i = 0; i < len; i++)
315 static struct data_struct *
316 find_chunk (bfd *abfd, bfd_vma vma)
318 struct data_struct *d = abfd->tdata.tekhex_data->data;
321 while (d && (d->vma) != vma)
326 /* No chunk for this address, so make one up. */
327 d = bfd_zalloc (abfd, (bfd_size_type) sizeof (struct data_struct));
332 d->next = abfd->tdata.tekhex_data->data;
334 abfd->tdata.tekhex_data->data = d;
340 insert_byte (bfd *abfd, int value, bfd_vma addr)
342 /* Find the chunk that this byte needs and put it in. */
343 struct data_struct *d = find_chunk (abfd, addr);
345 d->chunk_data[addr & CHUNK_MASK] = value;
346 d->chunk_init[addr & CHUNK_MASK] = 1;
349 /* The first pass is to find the names of all the sections, and see
350 how big the data is. */
353 first_phase (bfd *abfd, int type, char *src)
355 asection *section = bfd_abs_section_ptr;
358 char sym[17]; /* A symbol can only be 16chars long. */
363 /* Data record - read it and store it. */
367 if (!getvalue (&src, &addr))
372 insert_byte (abfd, HEX (src), addr);
380 /* Symbol record, read the segment. */
381 if (!getsym (sym, &src, &len))
383 section = bfd_get_section_by_name (abfd, sym);
386 char *n = bfd_alloc (abfd, (bfd_size_type) len + 1);
390 memcpy (n, sym, len + 1);
391 section = bfd_make_section (abfd, n);
397 case '1': /* Section range. */
399 if (!getvalue (&src, §ion->vma))
401 if (!getvalue (&src, &val))
403 section->size = val - section->vma;
404 section->flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
413 /* Symbols, add to section. */
415 bfd_size_type amt = sizeof (tekhex_symbol_type);
416 tekhex_symbol_type *new = bfd_alloc (abfd, amt);
421 new->symbol.the_bfd = abfd;
424 abfd->flags |= HAS_SYMS;
425 new->prev = abfd->tdata.tekhex_data->symbols;
426 abfd->tdata.tekhex_data->symbols = new;
427 if (!getsym (sym, &src, &len))
429 new->symbol.name = bfd_alloc (abfd, (bfd_size_type) len + 1);
430 if (!new->symbol.name)
432 memcpy ((char *) (new->symbol.name), sym, len + 1);
433 new->symbol.section = section;
435 new->symbol.flags = (BSF_GLOBAL | BSF_EXPORT);
437 new->symbol.flags = BSF_LOCAL;
438 if (!getvalue (&src, &val))
440 new->symbol.value = val - section->vma;
452 /* Pass over a tekhex, calling one of the above functions on each
456 pass_over (bfd *abfd, bfd_boolean (*func) (bfd *, int, char *))
458 unsigned int chars_on_line;
459 bfd_boolean eof = FALSE;
461 /* To the front of the file. */
462 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
469 /* Find first '%'. */
470 eof = (bfd_boolean) (bfd_bread (src, (bfd_size_type) 1, abfd) != 1);
471 while (*src != '%' && !eof)
472 eof = (bfd_boolean) (bfd_bread (src, (bfd_size_type) 1, abfd) != 1);
477 /* Fetch the type and the length and the checksum. */
478 if (bfd_bread (src, (bfd_size_type) 5, abfd) != 5)
483 if (!ISHEX (src[0]) || !ISHEX (src[1]))
486 /* Already read five chars. */
487 chars_on_line = HEX (src) - 5;
489 if (chars_on_line >= MAXCHUNK)
492 if (bfd_bread (src, (bfd_size_type) chars_on_line, abfd) != chars_on_line)
495 /* Put a null at the end. */
496 src[chars_on_line] = 0;
498 if (!func (abfd, type, src))
506 tekhex_canonicalize_symtab (bfd *abfd, asymbol **table)
508 tekhex_symbol_type *p = abfd->tdata.tekhex_data->symbols;
509 unsigned int c = bfd_get_symcount (abfd);
514 table[--c] = &(p->symbol);
518 return bfd_get_symcount (abfd);
522 tekhex_get_symtab_upper_bound (bfd *abfd)
524 return (abfd->symcount + 1) * (sizeof (struct tekhex_asymbol_struct *));
529 tekhex_mkobject (bfd *abfd)
533 tdata = bfd_alloc (abfd, (bfd_size_type) sizeof (tdata_type));
536 abfd->tdata.tekhex_data = tdata;
539 tdata->symbols = NULL;
544 /* Return TRUE if the file looks like it's in TekHex format. Just look
545 for a percent sign and some hex digits. */
547 static const bfd_target *
548 tekhex_object_p (bfd *abfd)
554 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0
555 || bfd_bread (b, (bfd_size_type) 4, abfd) != 4)
558 if (b[0] != '%' || !ISHEX (b[1]) || !ISHEX (b[2]) || !ISHEX (b[3]))
561 tekhex_mkobject (abfd);
563 if (!pass_over (abfd, first_phase))
570 move_section_contents (bfd *abfd,
572 const void * locationp,
578 char *location = (char *) locationp;
579 bfd_vma prev_number = 1; /* Nothing can have this as a high bit. */
580 struct data_struct *d = NULL;
582 BFD_ASSERT (offset == 0);
583 for (addr = section->vma; count != 0; count--, addr++)
585 /* Get high bits of address. */
586 bfd_vma chunk_number = addr & ~(bfd_vma) CHUNK_MASK;
587 bfd_vma low_bits = addr & CHUNK_MASK;
589 if (chunk_number != prev_number)
590 /* Different chunk, so move pointer. */
591 d = find_chunk (abfd, chunk_number);
595 if (d->chunk_init[low_bits])
596 *location = d->chunk_data[low_bits];
602 d->chunk_data[low_bits] = *location;
603 d->chunk_init[low_bits] = (*location != 0);
611 tekhex_get_section_contents (bfd *abfd,
617 if (section->flags & (SEC_LOAD | SEC_ALLOC))
619 move_section_contents (abfd, section, locationp, offset, count, TRUE);
627 tekhex_set_arch_mach (bfd *abfd,
628 enum bfd_architecture arch,
629 unsigned long machine)
631 return bfd_default_set_arch_mach (abfd, arch, machine);
634 /* We have to save up all the Tekhexords for a splurge before output. */
637 tekhex_set_section_contents (bfd *abfd,
639 const void * locationp,
641 bfd_size_type bytes_to_do)
643 if (! abfd->output_has_begun)
645 /* The first time around, allocate enough sections to hold all the chunks. */
646 asection *s = abfd->sections;
649 for (s = abfd->sections; s; s = s->next)
651 if (s->flags & SEC_LOAD)
653 for (vma = s->vma & ~(bfd_vma) CHUNK_MASK;
654 vma < s->vma + s->size;
656 find_chunk (abfd, vma);
661 if (section->flags & (SEC_LOAD | SEC_ALLOC))
663 move_section_contents (abfd, section, locationp, offset, bytes_to_do,
672 writevalue (char **dst, bfd_vma value)
678 for (len = 8, shift = 28; shift; shift -= 4, len--)
680 if ((value >> shift) & 0xf)
685 *p++ = digs[(value >> shift) & 0xf];
700 writesym (char **dst, const char *sym)
703 int len = (sym ? strlen (sym) : 0);
729 out (bfd *abfd, int type, char *start, char *end)
737 TOHEX (front + 1, end - start + 5);
740 for (s = start; s < end; s++)
741 sum += sum_block[(unsigned char) *s];
743 sum += sum_block[(unsigned char) front[1]]; /* Length. */
744 sum += sum_block[(unsigned char) front[2]];
745 sum += sum_block[(unsigned char) front[3]]; /* Type. */
746 TOHEX (front + 4, sum);
747 if (bfd_bwrite (front, (bfd_size_type) 6, abfd) != 6)
750 wrlen = end - start + 1;
751 if (bfd_bwrite (start, wrlen, abfd) != wrlen)
756 tekhex_write_object_contents (bfd *abfd)
761 struct data_struct *d;
765 /* And the raw data. */
766 for (d = abfd->tdata.tekhex_data->data;
775 /* Write it in blocks of 32 bytes. */
776 for (addr = 0; addr < CHUNK_MASK + 1; addr += span)
780 /* Check to see if necessary. */
781 for (low = 0; !need && low < span; low++)
782 if (d->chunk_init[addr + low])
789 writevalue (&dst, addr + d->vma);
790 for (low = 0; low < span; low++)
792 TOHEX (dst, d->chunk_data[addr + low]);
795 out (abfd, '6', buffer, dst);
800 /* Write all the section headers for the sections. */
801 for (s = abfd->sections; s != NULL; s = s->next)
805 writesym (&dst, s->name);
807 writevalue (&dst, s->vma);
808 writevalue (&dst, s->vma + s->size);
809 out (abfd, '3', buffer, dst);
812 /* And the symbols. */
813 if (abfd->outsymbols)
815 for (p = abfd->outsymbols; *p; p++)
817 int section_code = bfd_decode_symclass (*p);
819 if (section_code != '?')
821 /* Do not include debug symbols. */
825 writesym (&dst, sym->section->name);
827 switch (section_code)
853 bfd_set_error (bfd_error_wrong_format);
857 writesym (&dst, sym->name);
858 writevalue (&dst, sym->value + sym->section->vma);
859 out (abfd, '3', buffer, dst);
864 /* And the terminator. */
865 if (bfd_bwrite ("%0781010\n", (bfd_size_type) 9, abfd) != 9)
871 tekhex_sizeof_headers (bfd *abfd ATTRIBUTE_UNUSED,
872 struct bfd_link_info *info ATTRIBUTE_UNUSED)
878 tekhex_make_empty_symbol (bfd *abfd)
880 bfd_size_type amt = sizeof (struct tekhex_symbol_struct);
881 tekhex_symbol_type *new = bfd_zalloc (abfd, amt);
885 new->symbol.the_bfd = abfd;
887 return &(new->symbol);
891 tekhex_get_symbol_info (bfd *abfd ATTRIBUTE_UNUSED,
895 bfd_symbol_info (symbol, ret);
899 tekhex_print_symbol (bfd *abfd,
902 bfd_print_symbol_type how)
904 FILE *file = (FILE *) filep;
908 case bfd_print_symbol_name:
909 fprintf (file, "%s", symbol->name);
911 case bfd_print_symbol_more:
914 case bfd_print_symbol_all:
916 const char *section_name = symbol->section->name;
918 bfd_print_symbol_vandf (abfd, (void *) file, symbol);
920 fprintf (file, " %-5s %s",
921 section_name, symbol->name);
926 #define tekhex_close_and_cleanup _bfd_generic_close_and_cleanup
927 #define tekhex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
928 #define tekhex_new_section_hook _bfd_generic_new_section_hook
929 #define tekhex_bfd_is_target_special_symbol ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
930 #define tekhex_bfd_is_local_label_name bfd_generic_is_local_label_name
931 #define tekhex_get_lineno _bfd_nosymbols_get_lineno
932 #define tekhex_find_nearest_line _bfd_nosymbols_find_nearest_line
933 #define tekhex_find_inliner_info _bfd_nosymbols_find_inliner_info
934 #define tekhex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
935 #define tekhex_read_minisymbols _bfd_generic_read_minisymbols
936 #define tekhex_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
937 #define tekhex_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
938 #define tekhex_bfd_relax_section bfd_generic_relax_section
939 #define tekhex_bfd_gc_sections bfd_generic_gc_sections
940 #define tekhex_bfd_merge_sections bfd_generic_merge_sections
941 #define tekhex_bfd_is_group_section bfd_generic_is_group_section
942 #define tekhex_bfd_discard_group bfd_generic_discard_group
943 #define tekhex_section_already_linked _bfd_generic_section_already_linked
944 #define tekhex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
945 #define tekhex_bfd_link_hash_table_free _bfd_generic_link_hash_table_free
946 #define tekhex_bfd_link_add_symbols _bfd_generic_link_add_symbols
947 #define tekhex_bfd_link_just_syms _bfd_generic_link_just_syms
948 #define tekhex_bfd_final_link _bfd_generic_final_link
949 #define tekhex_bfd_link_split_section _bfd_generic_link_split_section
950 #define tekhex_get_section_contents_in_window _bfd_generic_get_section_contents_in_window
952 const bfd_target tekhex_vec =
954 "tekhex", /* Name. */
955 bfd_target_tekhex_flavour,
956 BFD_ENDIAN_UNKNOWN, /* Target byte order. */
957 BFD_ENDIAN_UNKNOWN, /* Target headers byte order. */
958 (EXEC_P | /* Object flags. */
959 HAS_SYMS | HAS_LINENO | HAS_DEBUG |
960 HAS_RELOC | HAS_LOCALS | WP_TEXT | D_PAGED),
961 (SEC_CODE | SEC_DATA | SEC_ROM | SEC_HAS_CONTENTS
962 | SEC_ALLOC | SEC_LOAD | SEC_RELOC), /* Section flags. */
963 0, /* Leading underscore. */
964 ' ', /* AR_pad_char. */
965 16, /* AR_max_namelen. */
966 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
967 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
968 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Data. */
969 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
970 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
971 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Headers. */
975 tekhex_object_p, /* bfd_check_format. */
982 _bfd_generic_mkarchive,
985 { /* bfd_write_contents. */
987 tekhex_write_object_contents,
988 _bfd_write_archive_contents,
992 BFD_JUMP_TABLE_GENERIC (tekhex),
993 BFD_JUMP_TABLE_COPY (_bfd_generic),
994 BFD_JUMP_TABLE_CORE (_bfd_nocore),
995 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
996 BFD_JUMP_TABLE_SYMBOLS (tekhex),
997 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
998 BFD_JUMP_TABLE_WRITE (tekhex),
999 BFD_JUMP_TABLE_LINK (tekhex),
1000 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),