1 /* BFD backend for Extended Tektronix Hex Format objects.
2 Copyright (C) 1992, 1993, 1994, 1995 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
75 #include "libiberty.h"
83 typedef struct tekhex_symbol_struct
87 struct tekhex_symbol_struct *prev;
91 static const char digs[] = "0123456789ABCDEF";
93 static char sum_block[256];
96 #define NIBBLE(x) hex_value(x)
97 #define HEX(buffer) ((NIBBLE((buffer)[0])<<4) + NIBBLE((buffer)[1]))
99 (d)[1] = digs[(x) & 0xf]; \
100 (d)[0] = digs[((x)>>4)&0xf];
101 #define ISHEX(x) hex_p(x)
105 %3A6C6480004E56FFFC4E717063B0AEFFFC6D0652AEFFFC60F24E5E4E75
106 %1B3709T_SEGMENT1108FFFFFFFF
107 %2B3AB9T_SEGMENT7Dgcc_compiled$1087hello$c10
108 %373829T_SEGMENT80int$t1$r1$$214741080char$t2$r2$0$12710
109 %373769T_SEGMENT80long$int$t3$r1$$1080unsigned$int$t4$10
110 %373CA9T_SEGMENT80long$unsigned$in1080short$int$t6$r1$10
111 %373049T_SEGMENT80long$long$int$t71080short$unsigned$i10
112 %373A29T_SEGMENT80long$long$unsign1080signed$char$t10$10
113 %373D69T_SEGMENT80unsigned$char$t11080float$t12$r1$4$010
114 %373D19T_SEGMENT80double$t13$r1$8$1080long$double$t14$10
115 %2734D9T_SEGMENT8Bvoid$t15$151035_main10
116 %2F3CA9T_SEGMENT81$1081$1681$1E81$21487main$F110
117 %2832F9T_SEGMENT83i$18FFFFFFFC81$1481$214
121 %3A6C6480004E56FFFC4E717063B0AEFFFC6D0652AEFFFC60F24E5E4E75
123 | || +------ 4 char integer 0x8000
124 | |+-------- checksum
125 | +--------- type 6 (data record)
126 +----------- length 3a chars
127 <---------------------- 3a (58 chars) ------------------->
129 %1B3709T_SEGMENT1108FFFFFFFF
130 ^ ^^ ^- 8 character integer 0xffffffff
131 | |+- 1 character integer 0
132 | +-- type 1 symbol (section definition)
133 +------------ 9 char symbol T_SEGMENT
135 %2B3AB9T_SEGMENT7Dgcc_compiled$1087hello$c10
136 %373829T_SEGMENT80int$t1$r1$$214741080char$t2$r2$0$12710
137 %373769T_SEGMENT80long$int$t3$r1$$1080unsigned$int$t4$10
138 %373CA9T_SEGMENT80long$unsigned$in1080short$int$t6$r1$10
139 %373049T_SEGMENT80long$long$int$t71080short$unsigned$i10
140 %373A29T_SEGMENT80long$long$unsign1080signed$char$t10$10
141 %373D69T_SEGMENT80unsigned$char$t11080float$t12$r1$4$010
142 %373D19T_SEGMENT80double$t13$r1$8$1080long$double$t14$10
143 %2734D9T_SEGMENT8Bvoid$t15$151035_main10
144 %2F3CA9T_SEGMENT81$1081$1681$1E81$21487main$F110
145 %2832F9T_SEGMENT83i$18FFFFFFFC81$1481$214
149 sac@thepub$ ./objdump -dx -m m68k f
151 f: file format tekhex
152 -----x--- 9/55728 -134219416 Sep 29 15:13 1995 f
153 architecture: UNKNOWN!, flags 0x00000010:
155 start address 0x00000000
156 SECTION 0 [D00000000] : size 00020000 vma 00000000 align 2**0
158 SECTION 1 [D00008000] : size 00002001 vma 00008000 align 2**0
160 SECTION 2 [T_SEGMENT] : size ffffffff vma 00000000 align 2**0
163 00000000 g T_SEGMENT gcc_compiled$
164 00000000 g T_SEGMENT hello$c
165 00000000 g T_SEGMENT int$t1$r1$$21474
166 00000000 g T_SEGMENT char$t2$r2$0$127
167 00000000 g T_SEGMENT long$int$t3$r1$$
168 00000000 g T_SEGMENT unsigned$int$t4$
169 00000000 g T_SEGMENT long$unsigned$in
170 00000000 g T_SEGMENT short$int$t6$r1$
171 00000000 g T_SEGMENT long$long$int$t7
172 00000000 g T_SEGMENT short$unsigned$i
173 00000000 g T_SEGMENT long$long$unsign
174 00000000 g T_SEGMENT signed$char$t10$
175 00000000 g T_SEGMENT unsigned$char$t1
176 00000000 g T_SEGMENT float$t12$r1$4$0
177 00000000 g T_SEGMENT double$t13$r1$8$
178 00000000 g T_SEGMENT long$double$t14$
179 00000000 g T_SEGMENT void$t15$15
180 00000000 g T_SEGMENT _main
181 00000000 g T_SEGMENT $
182 00000000 g T_SEGMENT $
183 00000000 g T_SEGMENT $
184 00000010 g T_SEGMENT $
185 00000000 g T_SEGMENT main$F1
186 fcffffff g T_SEGMENT i$1
187 00000000 g T_SEGMENT $
188 00000010 g T_SEGMENT $
191 RELOCATION RECORDS FOR [D00000000]: (none)
193 RELOCATION RECORDS FOR [D00008000]: (none)
195 RELOCATION RECORDS FOR [T_SEGMENT]: (none)
197 Disassembly of section D00000000:
199 00008000 ($+)7ff0 linkw fp,#-4
200 00008004 ($+)7ff4 nop
201 00008006 ($+)7ff6 movel #99,d0
202 00008008 ($+)7ff8 cmpl fp@(-4),d0
203 0000800c ($+)7ffc blts 00008014 ($+)8004
204 0000800e ($+)7ffe addql #1,fp@(-4)
205 00008012 ($+)8002 bras 00008006 ($+)7ff6
206 00008014 ($+)8004 unlk fp
207 00008016 ($+)8006 rts
216 static boolean inited = false;
224 for (i = 0; i < 10; i++)
226 sum_block[i + '0'] = val++;
228 for (i = 'A'; i <= 'Z'; i++)
230 sum_block[i] = val++;
232 sum_block['$'] = val++;
233 sum_block['%'] = val++;
234 sum_block['.'] = val++;
235 sum_block['_'] = val++;
236 for (i = 'a'; i <= 'z'; i++)
238 sum_block[i] = val++;
243 /* The maximum number of bytes on a line is FF */
244 #define MAXCHUNK 0xff
245 /* The number of bytes we fit onto a line on output */
248 /* We cannot output our tekhexords as we see them, we have to glue them
249 together, this is done in this structure : */
251 struct tekhex_data_list_struct
256 struct tekhex_data_list_struct *next;
259 typedef struct tekhex_data_list_struct tekhex_data_list_type;
261 #define CHUNK_MASK 0x1fff
265 char chunk_data[CHUNK_MASK + 1];
266 char chunk_init[CHUNK_MASK + 1];
268 struct data_struct *next;
271 typedef struct tekhex_data_struct
273 tekhex_data_list_type *head;
275 struct tekhex_symbol_struct *symbols;
276 struct data_struct *data;
279 #define enda(x) (x->vma + x->size)
287 unsigned int len = hex_value(*src++);
293 value = value << 4 | hex_value(*src++);
306 unsigned int len = hex_value(*src++);
310 for (i = 0; i < len; i++)
318 find_chunk (abfd, vma)
322 struct data_struct *d = abfd->tdata.tekhex_data->data;
325 while (d && (d->vma) != vma)
331 char *sname = bfd_alloc (abfd, 12);
333 /* No chunk for this address, so make one up */
334 d = (struct data_struct *)
335 bfd_alloc (abfd, sizeof (struct data_struct));
340 memset (d->chunk_init, 0, CHUNK_MASK + 1);
341 memset (d->chunk_data, 0, CHUNK_MASK + 1);
342 d->next = abfd->tdata.tekhex_data->data;
344 abfd->tdata.tekhex_data->data = d;
350 insert_byte (abfd, value, addr)
355 /* Find the chunk that this byte needs and put it in */
356 struct data_struct *d = find_chunk (abfd, addr);
358 d->chunk_data[addr & CHUNK_MASK] = value;
359 d->chunk_init[addr & CHUNK_MASK] = 1;
362 /* The first pass is to find the names of all the sections, and see
363 how big the data is */
365 first_phase (abfd, type, src)
370 asection *section = bfd_abs_section_ptr;
372 char sym[17]; /* A symbol can only be 16chars long */
377 /* Data record - read it and store it */
379 bfd_vma addr = getvalue (&src);
383 insert_byte (abfd, HEX (src), addr);
391 /* Symbol record, read the segment */
392 len = getsym (sym, &src);
393 section = bfd_get_section_by_name (abfd, sym);
394 if (section == (asection *) NULL)
396 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));
429 new->symbol.the_bfd = abfd;
432 abfd->flags |= HAS_SYMS;
433 new->prev = abfd->tdata.tekhex_data->symbols;
434 abfd->tdata.tekhex_data->symbols = new;
435 len = getsym (sym, &src);
436 new->symbol.name = bfd_alloc (abfd, len + 1);
437 if (!new->symbol.name)
439 memcpy ((char *) (new->symbol.name), sym, len + 1);
440 new->symbol.section = section;
442 new->symbol.flags = (BSF_GLOBAL | BSF_EXPORT);
444 new->symbol.flags = BSF_LOCAL;
445 new->symbol.value = getvalue (&src) - section->vma;
452 /* Pass over an tekhex, calling one of the above functions on each
456 pass_over (abfd, func)
460 unsigned int chars_on_line;
463 /* To the front of the file */
464 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
468 char buffer[MAXCHUNK];
473 eof = (boolean) (bfd_read (src, 1, 1, abfd) != 1);
474 while (*src != '%' && !eof)
476 eof = (boolean) (bfd_read (src, 1, 1, abfd) != 1);
482 /* Fetch the type and the length and the checksum */
483 if (bfd_read (src, 1, 5, abfd) != 5)
484 abort (); /* FIXME */
488 if (!ISHEX (src[0]) || !ISHEX (src[1]))
491 chars_on_line = HEX (src) - 5; /* Already read five char */
493 if (bfd_read (src, 1, chars_on_line, abfd) != chars_on_line)
494 abort (); /* FIXME */
495 src[chars_on_line] = 0; /* put a null at the end */
497 func (abfd, type, src);
503 tekhex_get_symtab (abfd, 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 (abfd)
525 return (abfd->symcount + 1) * (sizeof (struct tekhex_asymbol_struct *));
530 tekhex_mkobject (abfd)
533 tdata_type *tdata = (tdata_type *) bfd_alloc (abfd, sizeof (tdata_type));
537 abfd->tdata.tekhex_data = tdata;
539 tdata->head = (tekhex_data_list_type *) NULL;
540 tdata->symbols = (struct tekhex_symbol_struct *) NULL;
541 tdata->data = (struct data_struct *) NULL;
546 Return true if the file looks like it's in TekHex format. Just look
547 for a percent sign and some hex digits */
549 static const bfd_target *
550 tekhex_object_p (abfd)
557 if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0
558 || bfd_read (b, 1, 4, abfd) != 4)
561 if (b[0] != '%' || !ISHEX (b[1]) || !ISHEX (b[2]) || !ISHEX (b[3]))
562 return (const bfd_target *) NULL;
564 tekhex_mkobject (abfd);
566 pass_over (abfd, first_phase);
571 move_section_contents (abfd, section, locationp, offset, count, get)
580 char *location = (char *) locationp;
581 bfd_vma prev_number = 1; /* Nothing can have this as a high bit*/
582 struct data_struct *d = (struct data_struct *) NULL;
584 for (addr = section->vma; count != 0; count--, addr++)
587 bfd_vma chunk_number = addr & ~CHUNK_MASK; /* Get high bits of address */
588 bfd_vma low_bits = addr & CHUNK_MASK;
590 if (chunk_number != prev_number)
592 /* Different chunk, so move pointer */
593 d = find_chunk (abfd, chunk_number);
598 if (d->chunk_init[low_bits])
600 *location = d->chunk_data[low_bits];
609 d->chunk_data[low_bits] = *location;
610 d->chunk_init[low_bits] = (*location != 0);
619 tekhex_get_section_contents (abfd, section, locationp, offset, count)
626 if (section->flags & (SEC_LOAD | SEC_ALLOC))
628 move_section_contents (abfd, section, locationp, offset, count, true);
636 tekhex_set_arch_mach (abfd, arch, machine)
638 enum bfd_architecture arch;
639 unsigned long machine;
641 return bfd_default_set_arch_mach (abfd, arch, machine);
644 /* we have to save up all the Tekhexords for a splurge before output,
648 tekhex_set_section_contents (abfd, section, locationp, offset, bytes_to_do)
653 bfd_size_type bytes_to_do;
656 if (abfd->output_has_begun == false)
658 /* The first time around, allocate enough sections to hold all the chunks */
659 asection *s = abfd->sections;
662 for (s = abfd->sections; s; s = s->next)
664 if (s->flags & SEC_LOAD)
666 for (vma = s->vma & ~CHUNK_MASK;
667 vma < s->vma + s->_raw_size;
669 find_chunk (abfd, vma);
674 if (section->flags & (SEC_LOAD | SEC_ALLOC))
676 move_section_contents (abfd, section, locationp, offset, bytes_to_do, false);
685 writevalue (dst, value)
693 for (len = 8, shift = 28; shift; shift -= 4, len--)
695 if ((value >> shift) & 0xf)
700 *p++ = digs[(value >> shift) & 0xf];
720 int len = (sym ? strlen (sym) : 0);
750 out (abfd, type, start, end)
762 TOHEX (front + 1, end - start + 5);
765 for (s = start; s < end; s++)
767 sum += sum_block[(unsigned char) *s];
770 sum += sum_block[(unsigned char) front[1]]; /* length */
771 sum += sum_block[(unsigned char) front[2]];
772 sum += sum_block[(unsigned char) front[3]]; /* type */
773 TOHEX (front + 4, sum);
774 if (bfd_write (front, 1, 6, abfd) != 6)
777 wrlen = end - start + 1;
778 if (bfd_write (start, 1, wrlen, abfd) != wrlen)
783 tekhex_write_object_contents (abfd)
790 struct data_struct *d;
794 /* And the raw data */
795 for (d = abfd->tdata.tekhex_data->data;
796 d != (struct data_struct *) NULL;
804 /* Write it in blocks of 32 bytes */
806 for (addr = 0; addr < CHUNK_MASK + 1; addr += span)
810 /* Check to see if necessary */
811 for (low = 0; !need && low < span; low++)
813 if (d->chunk_init[addr + low])
820 writevalue (&dst, addr + d->vma);
821 for (low = 0; low < span; low++)
823 TOHEX (dst, d->chunk_data[addr + low]);
826 out (abfd, '6', buffer, dst);
830 /* write all the section headers for the sections */
831 for (s = abfd->sections; s != (asection *) NULL; s = s->next)
835 writesym (&dst, s->name);
837 writevalue (&dst, s->vma);
838 writevalue (&dst, s->vma + s->_raw_size);
839 out (abfd, '3', buffer, dst);
842 /* And the symbols */
843 for (p = abfd->outsymbols; *p; p++)
845 int section_code = bfd_decode_symclass (*p);
847 if (section_code != '?')
848 { /* do not include debug symbols */
852 writesym (&dst, s->section->name);
854 switch (section_code)
880 bfd_set_error (bfd_error_wrong_format);
884 writesym (&dst, s->name);
885 writevalue (&dst, s->value + s->section->vma);
886 out (abfd, '3', buffer, dst);
890 /* And the terminator */
891 if (bfd_write ("%0781010\n", 1, 9, abfd) != 9)
897 tekhex_sizeof_headers (abfd, exec)
906 tekhex_make_empty_symbol (abfd)
909 tekhex_symbol_type *new =
910 (tekhex_symbol_type *) bfd_zalloc (abfd, sizeof (struct tekhex_symbol_struct));
914 new->symbol.the_bfd = abfd;
915 new->prev = (struct tekhex_symbol_struct *) NULL;
916 return &(new->symbol);
920 tekhex_get_symbol_info (ignore_abfd, symbol, ret)
925 bfd_symbol_info (symbol, ret);
929 tekhex_print_symbol (ignore_abfd, filep, symbol, how)
933 bfd_print_symbol_type how;
935 FILE *file = (FILE *) filep;
939 case bfd_print_symbol_name:
940 fprintf (file, "%s", symbol->name);
942 case bfd_print_symbol_more:
945 case bfd_print_symbol_all:
947 CONST char *section_name = symbol->section->name;
949 bfd_print_symbol_vandf ((PTR) file, symbol);
951 fprintf (file, " %-5s %s",
958 #define tekhex_close_and_cleanup _bfd_generic_close_and_cleanup
959 #define tekhex_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
960 #define tekhex_new_section_hook _bfd_generic_new_section_hook
962 #define tekhex_bfd_is_local_label bfd_generic_is_local_label
963 #define tekhex_get_lineno _bfd_nosymbols_get_lineno
964 #define tekhex_find_nearest_line _bfd_nosymbols_find_nearest_line
965 #define tekhex_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
966 #define tekhex_read_minisymbols _bfd_generic_read_minisymbols
967 #define tekhex_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
969 #define tekhex_bfd_get_relocated_section_contents \
970 bfd_generic_get_relocated_section_contents
971 #define tekhex_bfd_relax_section bfd_generic_relax_section
972 #define tekhex_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
973 #define tekhex_bfd_link_add_symbols _bfd_generic_link_add_symbols
974 #define tekhex_bfd_final_link _bfd_generic_final_link
975 #define tekhex_bfd_link_split_section _bfd_generic_link_split_section
977 #define tekhex_get_section_contents_in_window \
978 _bfd_generic_get_section_contents_in_window
980 const bfd_target tekhex_vec =
983 bfd_target_tekhex_flavour,
984 true, /* target byte order */
985 true, /* target headers byte order */
986 (EXEC_P | /* object flags */
987 HAS_SYMS | HAS_LINENO | HAS_DEBUG | HAS_RELOC | HAS_LOCALS |
989 (SEC_CODE | SEC_DATA | SEC_ROM | SEC_HAS_CONTENTS
990 | SEC_ALLOC | SEC_LOAD | SEC_RELOC), /* section flags */
991 0, /* leading underscore */
992 ' ', /* ar_pad_char */
993 16, /* ar_max_namelen */
994 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
995 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
996 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* data */
997 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
998 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
999 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* hdrs */
1003 tekhex_object_p, /* bfd_check_format */
1010 _bfd_generic_mkarchive,
1013 { /* bfd_write_contents */
1015 tekhex_write_object_contents,
1016 _bfd_write_archive_contents,
1020 BFD_JUMP_TABLE_GENERIC (tekhex),
1021 BFD_JUMP_TABLE_COPY (_bfd_generic),
1022 BFD_JUMP_TABLE_CORE (_bfd_nocore),
1023 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
1024 BFD_JUMP_TABLE_SYMBOLS (tekhex),
1025 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
1026 BFD_JUMP_TABLE_WRITE (tekhex),
1027 BFD_JUMP_TABLE_LINK (tekhex),
1028 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),