1 /* BFD backend for Extended Tektronix Hex Format objects.
2 Copyright (C) 1992 Free Software Foundation, Inc.
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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA. */
24 Tektronix Hex Format handling
28 Tek Hex records can hold symbols and data, but not
29 relocations. Their main application is communication with
30 devices like PROM programmers and ICE equipment.
32 It seems that the sections are descibed as being really big,
33 the example I have says that the text section is 0..ffffffff.
34 BFD would barf with this, many apps would try to alloc 4GB to
37 Tex Hex may contain many sections, but the data which comes in
38 has no tag saying which section it belongs to, so we create
39 one section for each block of data, called "blknnnn" which we
40 stick all the data into.
42 TekHex may come out of order and there is no header, so an
43 initial scan is required to discover the minimum and maximum
44 addresses used to create the vma and size of the sections we
46 We read in the data into pages of CHUNK_MASK+1 size and read
47 them out from that whenever we need to.
49 Any number of sections may be created for output, we save them
50 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.
68 The data can come out of order, and may be discontigous. This is a
69 serial protocol, so big files are unlikely, so we keep a list of 8k chunks
81 typedef struct tekhex_symbol_struct {
84 struct tekhex_symbol_struct *prev;
88 static char digs[] = "0123456789ABCDEF";
90 static char sum_block[256];
91 /* Horrible ascii dependent macros for converting between hex and
94 #define CHARS_IN_SET 256
95 static char hex_value[CHARS_IN_SET];
97 #define NIBBLE(x) hex_value[x]
98 #define HEX(buffer) ((NIBBLE((buffer)[0])<<4) + NIBBLE((buffer)[1]))
100 (d)[1] = digs[(x) & 0xf]; \
101 (d)[0] = digs[((x)>>4)&0xf];
102 #define ISHEX(x) (hex_value[x] != NOT_HEX)
106 %3A6C6480004E56FFFC4E717063B0AEFFFC6D0652AEFFFC60F24E5E4E75
107 %1B3709T_SEGMENT1108FFFFFFFF
108 %2B3AB9T_SEGMENT7Dgcc_compiled$1087hello$c10
109 %373829T_SEGMENT80int$t1$r1$$214741080char$t2$r2$0$12710
110 %373769T_SEGMENT80long$int$t3$r1$$1080unsigned$int$t4$10
111 %373CA9T_SEGMENT80long$unsigned$in1080short$int$t6$r1$10
112 %373049T_SEGMENT80long$long$int$t71080short$unsigned$i10
113 %373A29T_SEGMENT80long$long$unsign1080signed$char$t10$10
114 %373D69T_SEGMENT80unsigned$char$t11080float$t12$r1$4$010
115 %373D19T_SEGMENT80double$t13$r1$8$1080long$double$t14$10
116 %2734D9T_SEGMENT8Bvoid$t15$151035_main10
117 %2F3CA9T_SEGMENT81$1081$1681$1E81$21487main$F110
118 %2832F9T_SEGMENT83i$18FFFFFFFC81$1481$214
122 %3A6C6480004E56FFFC4E717063B0AEFFFC6D0652AEFFFC60F24E5E4E75
124 | || +------ 4 char integer 0x8000
125 | |+-------- checksum
126 | +--------- type 6 (data record)
127 +----------- length 3a chars
128 <---------------------- 3a (58 chars) ------------------->
130 %1B3709T_SEGMENT1108FFFFFFFF
131 ^ ^^ ^- 8 character integer 0xffffffff
132 | |+- 1 character integer 0
133 | +-- type 1 symbol (section definition)
134 +------------ 9 char symbol T_SEGMENT
136 %2B3AB9T_SEGMENT7Dgcc_compiled$1087hello$c10
137 %373829T_SEGMENT80int$t1$r1$$214741080char$t2$r2$0$12710
138 %373769T_SEGMENT80long$int$t3$r1$$1080unsigned$int$t4$10
139 %373CA9T_SEGMENT80long$unsigned$in1080short$int$t6$r1$10
140 %373049T_SEGMENT80long$long$int$t71080short$unsigned$i10
141 %373A29T_SEGMENT80long$long$unsign1080signed$char$t10$10
142 %373D69T_SEGMENT80unsigned$char$t11080float$t12$r1$4$010
143 %373D19T_SEGMENT80double$t13$r1$8$1080long$double$t14$10
144 %2734D9T_SEGMENT8Bvoid$t15$151035_main10
145 %2F3CA9T_SEGMENT81$1081$1681$1E81$21487main$F110
146 %2832F9T_SEGMENT83i$18FFFFFFFC81$1481$214
150 sac@thepub$ ./objdump -dx -m m68k f
152 f: file format tekhex
153 -----x--- 9/55728 -134219416 Sep 29 15:13 1995 f
154 architecture: UNKNOWN!, flags 0x00000010:
156 start address 0x00000000
157 SECTION 0 [D00000000] : size 00020000 vma 00000000 align 2**0
159 SECTION 1 [D00008000] : size 00002001 vma 00008000 align 2**0
161 SECTION 2 [T_SEGMENT] : size ffffffff vma 00000000 align 2**0
164 00000000 g T_SEGMENT gcc_compiled$
165 00000000 g T_SEGMENT hello$c
166 00000000 g T_SEGMENT int$t1$r1$$21474
167 00000000 g T_SEGMENT char$t2$r2$0$127
168 00000000 g T_SEGMENT long$int$t3$r1$$
169 00000000 g T_SEGMENT unsigned$int$t4$
170 00000000 g T_SEGMENT long$unsigned$in
171 00000000 g T_SEGMENT short$int$t6$r1$
172 00000000 g T_SEGMENT long$long$int$t7
173 00000000 g T_SEGMENT short$unsigned$i
174 00000000 g T_SEGMENT long$long$unsign
175 00000000 g T_SEGMENT signed$char$t10$
176 00000000 g T_SEGMENT unsigned$char$t1
177 00000000 g T_SEGMENT float$t12$r1$4$0
178 00000000 g T_SEGMENT double$t13$r1$8$
179 00000000 g T_SEGMENT long$double$t14$
180 00000000 g T_SEGMENT void$t15$15
181 00000000 g T_SEGMENT _main
182 00000000 g T_SEGMENT $
183 00000000 g T_SEGMENT $
184 00000000 g T_SEGMENT $
185 00000010 g T_SEGMENT $
186 00000000 g T_SEGMENT main$F1
187 fcffffff g T_SEGMENT i$1
188 00000000 g T_SEGMENT $
189 00000010 g T_SEGMENT $
192 RELOCATION RECORDS FOR [D00000000]: (none)
194 RELOCATION RECORDS FOR [D00008000]: (none)
196 RELOCATION RECORDS FOR [T_SEGMENT]: (none)
198 Disassembly of section D00000000:
200 00008000 ($+)7ff0 linkw fp,#-4
201 00008004 ($+)7ff4 nop
202 00008006 ($+)7ff6 movel #99,d0
203 00008008 ($+)7ff8 cmpl fp@(-4),d0
204 0000800c ($+)7ffc blts 00008014 ($+)8004
205 0000800e ($+)7ffe addql #1,fp@(-4)
206 00008012 ($+)8002 bras 00008006 ($+)7ff6
207 00008014 ($+)8004 unlk fp
208 00008016 ($+)8006 rts
214 DEFUN_VOID(tekhex_init)
217 static boolean inited = false;
224 for (i = 0; i < CHARS_IN_SET; i++)
226 hex_value[i] = NOT_HEX;
229 for (i = 0; i < 10; i++)
231 hex_value[i + '0'] = i;
234 for (i = 0; i < 6; i++)
236 hex_value[i + 'a'] = i+10;
237 hex_value[i + 'A'] = i+10;
240 for (i = 0; i < 10; i++) {
241 sum_block[i + '0'] = val++;
243 for (i = 'A'; i <= 'Z'; i++) {
244 sum_block[i] = val++;
246 sum_block['$'] = val++;
247 sum_block['%'] = val++;
248 sum_block['.'] = val++;
249 sum_block['_'] = val++;
250 for (i = 'a'; i <= 'z'; i++) {
251 sum_block[i] = val++;
257 /* The maximum number of bytes on a line is FF */
258 #define MAXCHUNK 0xff
259 /* The number of bytes we fit onto a line on output */
262 /* We cannot output our tekhexords as we see them, we have to glue them
263 together, this is done in this structure : */
265 struct tekhex_data_list_struct
270 struct tekhex_data_list_struct *next;
273 typedef struct tekhex_data_list_struct tekhex_data_list_type;
277 #define CHUNK_MASK 0x1fff
280 char chunk_data[CHUNK_MASK+1];
281 char chunk_init[CHUNK_MASK+1];
283 struct data_struct *next;
286 typedef struct tekhex_data_struct
288 tekhex_data_list_type *head;
290 struct tekhex_symbol_struct *symbols;
291 struct data_struct *data;
296 #define enda(x) (x->vma + x->size)
300 DEFUN(getvalue,(srcp),
305 unsigned int len = hex_value[*src++];
306 if (len == 0) len=16;
308 value = value << 4 | hex_value[*src++];
315 DEFUN(getsym,(dstp,srcp),
321 unsigned int len = hex_value[*src++];
322 if (len == 0) len=16;
323 for (i = 0; i < len; i++)
331 DEFUN(find_chunk,(abfd, vma),
335 struct data_struct *d = abfd->tdata.tekhex_data->data;
337 while (d && (d->vma) != vma)
342 char *sname = bfd_alloc(abfd, 12);
345 /* No chunk for this address, so make one up */
346 d =(struct data_struct *)
347 bfd_alloc(abfd, sizeof(struct data_struct));
348 memset(d->chunk_init, 0, CHUNK_MASK+1);
349 memset(d->chunk_data, 0, CHUNK_MASK+1);
350 d->next = abfd->tdata.tekhex_data->data ;
352 abfd->tdata.tekhex_data->data = d;
357 DEFUN(insert_byte,(abfd, value, addr),
362 /* Find the chunk that this byte needs and put it in */
363 struct data_struct *d = find_chunk(abfd, addr);
364 d->chunk_data[addr &CHUNK_MASK] = value;
365 d->chunk_init[addr &CHUNK_MASK] = 1;
368 /* The first pass is to find the names of all the sections, and see
369 how big the data is */
371 DEFUN(first_phase,(abfd, type, src),
376 asection *section = &bfd_abs_section;
378 char sym[17]; /* A symbol can only be 16chars long */
382 /* Data record - read it and store it */
384 bfd_vma addr = getvalue(&src);
386 insert_byte(abfd, HEX(src), addr);
394 /* Symbol record, read the segment */
395 len = getsym(sym, &src);
396 section = bfd_get_section_by_name(abfd, sym);
397 if (section == (asection *)NULL)
399 char *n = bfd_alloc(abfd, len+1);
400 memcpy(n, sym, len+1);
401 section = bfd_make_section(abfd, n);
407 case '1': /* section range */
409 section->vma = getvalue(&src);
410 section->_raw_size = getvalue(&src) - section->vma;
411 section->flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
420 /* Symbols, add to section */
422 tekhex_symbol_type *new =
423 (tekhex_symbol_type *)bfd_alloc(abfd,
424 sizeof(tekhex_symbol_type));
426 new->symbol.the_bfd = abfd;
429 abfd->flags |= HAS_SYMS;
430 new->prev = abfd->tdata.tekhex_data->symbols;
431 abfd->tdata.tekhex_data->symbols = new;
432 len = getsym(sym, &src);
433 new->symbol.name = bfd_alloc(abfd,len+1);
434 memcpy((char *)(new->symbol.name), sym, len+1);
435 new->symbol.section = section ;
437 new->symbol.flags = (BSF_GLOBAL|BSF_EXPORT);
439 new->symbol.flags = BSF_LOCAL;
440 new->symbol.value = getvalue(&src) - section->vma;
448 /* Pass over an tekhex, calling one of the above functions on each
452 DEFUN(pass_over,(abfd, func),
454 void (*func) PARAMS ((bfd *, char, char *)))
456 unsigned int chars_on_line;
459 /* To the front of the file */
460 bfd_seek(abfd, (file_ptr)0, SEEK_SET);
463 char buffer[MAXCHUNK];
469 eof = (boolean)(bfd_read(src, 1, 1, abfd) != 1);
470 while (*src!= '%' && !eof) {
471 eof = (boolean)(bfd_read(src, 1, 1, abfd) != 1);
477 /* Fetch the type and the length and the checksum */
478 bfd_read(src, 1, 5, abfd);
482 if (!ISHEX (src[0]) || !ISHEX (src[1]))
485 chars_on_line = HEX(src) - 5; /* Already read five char */
487 bfd_read(src, 1 , chars_on_line , abfd);
488 src[chars_on_line] = 0; /* put a null at the end */
492 func(abfd, type, src);
501 DEFUN(tekhex_get_symtab,(abfd, table),
505 tekhex_symbol_type *p = abfd->tdata.tekhex_data->symbols;
506 unsigned int c = bfd_get_symcount(abfd) ;
509 table[--c] = &(p->symbol);
513 return bfd_get_symcount(abfd);
517 DEFUN(tekhex_get_symtab_upper_bound,(abfd),
520 return (abfd->symcount+1) * (sizeof(struct tekhex_asymbol_struct *));
525 DEFUN(tekhex_mkobject, (abfd),
528 tdata_type *tdata = (tdata_type *)bfd_alloc(abfd, sizeof(tdata_type));
529 abfd->tdata.tekhex_data = tdata;
531 tdata->head = (tekhex_data_list_type *)NULL;
532 tdata->symbols = (struct tekhex_symbol_struct *)NULL;
533 tdata->data = (struct data_struct *)NULL;
539 Return true if the file looks like it's in TekHex format. Just look
540 for a percent sign and some hex digits */
544 DEFUN(tekhex_object_p, (abfd),
551 bfd_seek(abfd, (file_ptr)0, SEEK_SET);
552 bfd_read(b, 1, 4, abfd);
554 if (b[0] != '%' || !ISHEX(b[1]) || !ISHEX(b[2]) || !ISHEX(b[3]))
555 return (bfd_target*) NULL;
557 tekhex_mkobject(abfd);
559 pass_over(abfd, first_phase);
565 DEFUN(move_section_contents,(abfd, section, locationp, offset,count,
569 asection *section AND
572 bfd_size_type count AND
576 char *location = (char *)locationp;
577 bfd_vma prev_number = 1; /* Nothing can have this as a high bit*/
578 struct data_struct *d = (struct data_struct *)NULL;
579 for (addr = section->vma; count != 0; count --, addr++)
582 bfd_vma chunk_number = addr & ~ CHUNK_MASK; /* Get high bits of address */
583 bfd_vma low_bits = addr & CHUNK_MASK;
584 if (chunk_number != prev_number)
586 /* Different chunk, so move pointer */
587 d = find_chunk(abfd, chunk_number);
591 if (d->chunk_init[low_bits])
593 *location = d->chunk_data[low_bits];
601 d->chunk_data[low_bits] = *location ;
602 d->chunk_init[low_bits] = (*location != 0);
612 DEFUN(tekhex_get_section_contents,(abfd, section, locationp, offset, count),
614 asection *section AND
619 if (section->flags & (SEC_LOAD | SEC_ALLOC))
621 move_section_contents(abfd, section, locationp, offset, count, true);
630 DEFUN(tekhex_set_arch_mach,(abfd, arch, machine),
632 enum bfd_architecture arch AND
633 unsigned long machine)
635 return bfd_default_set_arch_mach(abfd, arch, machine);
639 /* we have to save up all the Tekhexords for a splurge before output,
643 DEFUN(tekhex_set_section_contents,(abfd, section, locationp, offset, bytes_to_do),
648 bfd_size_type bytes_to_do)
651 if (abfd->output_has_begun == false) {
652 /* The first time around, allocate enough sections to hold all the chunks */
653 asection *s = abfd->sections;
655 for (s = abfd->sections; s ; s = s->next) {
656 if (s->flags & SEC_LOAD) {
657 for (vma = s->vma & ~CHUNK_MASK;
658 vma < s->vma + s->_raw_size;
660 find_chunk(abfd, vma);
665 if (section->flags & (SEC_LOAD | SEC_ALLOC))
667 move_section_contents(abfd, section, locationp, offset, bytes_to_do, false);
676 DEFUN(writevalue,(dst, value),
683 for (len = 8, shift = 28; shift ; shift-=4, len--)
685 if ((value>>shift) & 0xf) {
688 *p ++ = digs[(value>>shift) &0xf];
703 DEFUN(writesym,(dst, sym),
708 int len = (sym?strlen(sym):0);
733 DEFUN(out,(abfd, type, start, end),
743 TOHEX(front+1, end - start + 5);
746 for (s = start; s < end; s++) {
747 sum += sum_block[*s];
751 sum += sum_block[front[1]];/* length */
752 sum += sum_block[front[2]];
753 sum += sum_block[front[3]];/* type */
755 bfd_write(front, 1, 6,abfd);
757 bfd_write(start, 1,end-start+1,abfd);
761 DEFUN(tekhex_write_object_contents,(abfd),
767 tdata_type *tdata = abfd->tdata.tekhex_data;
768 tekhex_data_list_type *list;
770 struct data_struct *d;
773 /* And the raw data */
774 for (d = abfd->tdata.tekhex_data->data;
775 d != (struct data_struct *)NULL;
782 /* Write it in blocks of 32 bytes */
784 for (addr = 0; addr < CHUNK_MASK + 1; addr+=span)
787 /* Check to see if necessary */
788 for (low = 0; !need && low < span; low++) {
789 if (d->chunk_init[addr + low]) need = 1;
793 writevalue(&dst, addr + d->vma);
794 for (low = 0; low <span; low++) {
795 TOHEX(dst, d->chunk_data[addr + low]);
798 out(abfd, '6', buffer, dst);
802 /* write all the section headers for the sections */
803 for (s = abfd->sections ; s != (asection *)NULL ; s = s->next)
806 writesym(&dst, s->name);
808 writevalue(&dst, s->vma);
809 writevalue(&dst, s->vma + s->_raw_size);
810 out(abfd, '3',buffer, dst);
813 /* And the symbols */
814 for (p = abfd->outsymbols; *p; p++) {
815 int section_code = bfd_decode_symclass (*p);
816 if (section_code != '?') { /* do not include debug symbols */
819 writesym(&dst, s->section->name);
821 switch(section_code) {
846 bfd_error=wrong_format;
850 writesym(&dst, s->name);
851 writevalue(&dst, s->value + s->section->vma);
852 out(abfd, '3', buffer, dst);
857 /* And the terminator */
858 bfd_write("%7081010\n", 1,9 , abfd);
864 DEFUN(tekhex_sizeof_headers,(abfd, exec),
872 DEFUN(tekhex_make_empty_symbol, (abfd),
875 tekhex_symbol_type *new=
876 (tekhex_symbol_type *)bfd_zalloc (abfd, sizeof (struct tekhex_symbol_struct));
877 new->symbol.the_bfd = abfd;
878 new->prev = (struct tekhex_symbol_struct *)NULL;
879 return &(new->symbol);
883 DEFUN(tekhex_print_symbol,(ignore_abfd, filep, symbol, how),
887 bfd_print_symbol_type how)
889 FILE *file = (FILE *)filep;
891 case bfd_print_symbol_name:
892 fprintf(file, "%s", symbol->name);
894 case bfd_print_symbol_more:
896 case bfd_print_symbol_nm:
898 int section_code = bfd_decode_symclass (symbol);
900 if (section_code == 'U')
902 fprintf_vma(file, symbol->value+symbol->section->vma);
903 if (section_code == '?')
908 fprintf(file," %c", section_code);
910 fprintf(file," %s", symbol->name);
913 case bfd_print_symbol_all:
915 CONST char *section_name = symbol->section->name;
916 bfd_print_symbol_vandf((PTR) file, symbol);
919 fprintf(file, " %-5s %s",
927 #define tekhex_new_section_hook (FOO(boolean, (*), (bfd *, asection *)))bfd_true
928 #define tekhex_get_reloc_upper_bound (FOO(unsigned int, (*),(bfd*, asection *)))bfd_false
929 #define tekhex_canonicalize_reloc (FOO(unsigned int, (*),(bfd*,asection *, arelent **, asymbol **))) bfd_0
932 #define tekhex_openr_next_archived_file (FOO(bfd *, (*), (bfd*,bfd*))) bfd_nullvoidptr
933 #define tekhex_find_nearest_line (FOO(boolean, (*),(bfd*,asection*,asymbol**,bfd_vma, CONST char**, CONST char**, unsigned int *))) bfd_false
934 #define tekhex_generic_stat_arch_elt (FOO(int, (*), (bfd *,struct stat *))) bfd_0
937 #define tekhex_core_file_failing_command (char *(*)())(bfd_nullvoidptr)
938 #define tekhex_core_file_failing_signal (int (*)())bfd_0
939 #define tekhex_core_file_matches_executable_p (FOO(boolean, (*),(bfd*, bfd*)))bfd_false
940 #define tekhex_slurp_armap bfd_true
941 #define tekhex_slurp_extended_name_table bfd_true
942 #define tekhex_truncate_arname (void (*)())bfd_nullvoidptr
943 #define tekhex_write_armap (FOO( boolean, (*),(bfd *, unsigned int, struct orl *, unsigned int, int))) bfd_nullvoidptr
944 #define tekhex_get_lineno (struct lineno_cache_entry *(*)())bfd_nullvoidptr
945 #define tekhex_close_and_cleanup bfd_generic_close_and_cleanup
946 #define tekhex_bfd_debug_info_start bfd_void
947 #define tekhex_bfd_debug_info_end bfd_void
948 #define tekhex_bfd_debug_info_accumulate (FOO(void, (*), (bfd *, asection *))) bfd_void
949 #define tekhex_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
950 #define tekhex_bfd_relax_section bfd_generic_relax_section
951 bfd_target tekhex_vec =
954 bfd_target_tekhex_flavour,
955 true, /* target byte order */
956 true, /* target headers byte order */
957 ( EXEC_P | /* object flags */
958 HAS_SYMS | HAS_LOCALS | DYNAMIC | WP_TEXT | D_PAGED),
959 (SEC_CODE|SEC_DATA|SEC_ROM|SEC_HAS_CONTENTS
960 |SEC_ALLOC | SEC_LOAD | SEC_RELOC), /* section flags */
961 0, /* leading underscore */
962 ' ', /* ar_pad_char */
963 16, /* ar_max_namelen */
964 1, /* minimum alignment */
965 _do_getb64, _do_putb64, _do_getb32,
966 _do_putb32, _do_getb16, _do_putb16, /* data */
967 _do_getb64, _do_putb64, _do_getb32,
968 _do_putb32, _do_getb16, _do_putb16, /* hdrs */
972 tekhex_object_p, /* bfd_check_format */
973 (struct bfd_target *(*)()) bfd_nullvoidptr,
974 (struct bfd_target *(*)()) bfd_nullvoidptr,
979 _bfd_generic_mkarchive,
982 { /* bfd_write_contents */
984 tekhex_write_object_contents,
985 _bfd_write_archive_contents,