Coverage Report

Created: 2026-07-25 10:20

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/binutils-gdb/bfd/ihex.c
Line
Count
Source
1
/* BFD back-end for Intel Hex objects.
2
   Copyright (C) 1995-2026 Free Software Foundation, Inc.
3
   Written by Ian Lance Taylor of Cygnus Support <ian@cygnus.com>.
4
5
   This file is part of BFD, the Binary File Descriptor library.
6
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 3 of the License, or
10
   (at your option) any later version.
11
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.
16
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., 51 Franklin Street - Fifth Floor, Boston,
20
   MA 02110-1301, USA.  */
21
22
23
/* This is what Intel Hex files look like:
24
25
1. INTEL FORMATS
26
27
A. Intel 1
28
29
   16-bit address-field format, for files 64k bytes in length or less.
30
31
   DATA RECORD
32
   Byte 1 Header = colon(:)
33
   2..3   The number of data bytes in hex notation
34
   4..5   High byte of the record load address
35
   6..7   Low byte of the record load address
36
   8..9   Record type, must be "00"
37
   10..x  Data bytes in hex notation:
38
  x = (number of bytes - 1) * 2 + 11
39
   x+1..x+2 Checksum in hex notation
40
   x+3..x+4 Carriage return, line feed
41
42
   END RECORD
43
   Byte 1 Header = colon (:)
44
   2..3   The byte count, must be "00"
45
   4..7   Transfer-address (usually "0000")
46
    the jump-to address, execution start address
47
   8..9   Record type, must be "01"
48
   10..11 Checksum, in hex notation
49
   12..13 Carriage return, line feed
50
51
B. INTEL 2
52
53
   MCS-86 format, using a 20-bit address for files larger than 64K bytes.
54
55
   DATA RECORD
56
   Byte 1 Header = colon (:)
57
   2..3   The byte count of this record, hex notation
58
   4..5   High byte of the record load address
59
   6..7   Low byte of the record load address
60
   8..9   Record type, must be "00"
61
   10..x  The data bytes in hex notation:
62
  x = (number of data bytes - 1) * 2 + 11
63
   x+1..x+2 Checksum in hex notation
64
   x+3..x+4 Carriage return, line feed
65
66
   EXTENDED ADDRESS RECORD
67
   Byte 1 Header = colon(:)
68
   2..3   The byte count, must be "02"
69
   4..7   Load address, must be "0000"
70
   8..9   Record type, must be "02"
71
   10..11 High byte of the offset address
72
   12..13 Low byte of the offset address
73
   14..15 Checksum in hex notation
74
   16..17 Carriage return, line feed
75
76
   The checksums are the two's complement of the 8-bit sum
77
   without carry of the byte count, offset address, and the
78
   record type.
79
80
   START ADDRESS RECORD
81
   Byte 1 Header = colon (:)
82
   2..3   The byte count, must be "04"
83
   4..7   Load address, must be "0000"
84
   8..9   Record type, must be "03"
85
   10..13 8086 CS value
86
   14..17 8086 IP value
87
   18..19 Checksum in hex notation
88
   20..21 Carriage return, line feed
89
90
Another document reports these additional types:
91
92
   EXTENDED LINEAR ADDRESS RECORD
93
   Byte 1 Header = colon (:)
94
   2..3   The byte count, must be "02"
95
   4..7   Load address, must be "0000"
96
   8..9   Record type, must be "04"
97
   10..13 Upper 16 bits of address of subsequent records
98
   14..15 Checksum in hex notation
99
   16..17 Carriage return, line feed
100
101
   START LINEAR ADDRESS RECORD
102
   Byte 1 Header = colon (:)
103
   2..3   The byte count, must be "02"
104
   4..7   Load address, must be "0000"
105
   8..9   Record type, must be "05"
106
   10..13 Upper 16 bits of start address
107
   14..15 Checksum in hex notation
108
   16..17 Carriage return, line feed
109
110
The MRI compiler uses this, which is a repeat of type 5:
111
112
  EXTENDED START RECORD
113
   Byte 1 Header = colon (:)
114
   2..3   The byte count, must be "04"
115
   4..7   Load address, must be "0000"
116
   8..9   Record type, must be "05"
117
   10..13 Upper 16 bits of start address
118
   14..17 Lower 16 bits of start address
119
   18..19 Checksum in hex notation
120
   20..21 Carriage return, line feed.  */
121
122
#include "sysdep.h"
123
#include "bfd.h"
124
#include "libbfd.h"
125
#include "libiberty.h"
126
#include "safe-ctype.h"
127
128
/* The number of bytes we put on one line during output.  */
129
130
4
#define CHUNK 16
131
132
/* Macros for converting between hex and binary.  */
133
134
51.6k
#define NIBBLE(x)    (hex_value (x))
135
29.5k
#define HEX2(buffer) ((NIBBLE ((buffer)[0]) << 4) + NIBBLE ((buffer)[1]))
136
4.80k
#define HEX4(buffer) ((HEX2 (buffer) << 8) + HEX2 ((buffer) + 2))
137
49.7k
#define ISHEX(x)     (hex_p (x))
138
139
/* When we write out an ihex value, the values can not be output as
140
   they are seen.  Instead, we hold them in memory in this structure.  */
141
142
struct ihex_data_list
143
{
144
  struct ihex_data_list *next;
145
  bfd_byte *data;
146
  bfd_vma where;
147
  bfd_size_type size;
148
};
149
150
/* The ihex tdata information.  */
151
152
struct ihex_data_struct
153
{
154
  struct ihex_data_list *head;
155
  struct ihex_data_list *tail;
156
};
157
158
/* Initialize by filling in the hex conversion array.  */
159
160
static void
161
ihex_init (void)
162
161k
{
163
161k
  static bool inited;
164
165
161k
  if (! inited)
166
9
    {
167
9
      inited = true;
168
9
      hex_init ();
169
9
    }
170
161k
}
171
172
/* Create an ihex object.  */
173
174
static bool
175
ihex_mkobject (bfd *abfd)
176
341
{
177
341
  struct ihex_data_struct *tdata;
178
179
341
  tdata = (struct ihex_data_struct *) bfd_alloc (abfd, sizeof (* tdata));
180
341
  if (tdata == NULL)
181
0
    return false;
182
183
341
  abfd->tdata.ihex_data = tdata;
184
341
  tdata->head = NULL;
185
341
  tdata->tail = NULL;
186
341
  return true;
187
341
}
188
189
/* Read a byte from a BFD.  Set *ERRORPTR if an error occurred.
190
   Return EOF on error or end of file.  */
191
192
static inline int
193
ihex_get_byte (bfd *abfd, bool *errorptr)
194
7.86k
{
195
7.86k
  bfd_byte c;
196
197
7.86k
  if (bfd_read (&c, 1, abfd) != 1)
198
50
    {
199
50
      if (bfd_get_error () != bfd_error_file_truncated)
200
1
  *errorptr = true;
201
50
      return EOF;
202
50
    }
203
204
7.81k
  return c & 0xff;
205
7.86k
}
206
207
/* Report a problem in an Intel Hex file.  */
208
209
static void
210
ihex_bad_byte (bfd *abfd, unsigned int lineno, int c, bool error)
211
129
{
212
129
  if (c == EOF)
213
0
    {
214
0
      if (! error)
215
0
  bfd_set_error (bfd_error_file_truncated);
216
0
    }
217
129
  else
218
129
    {
219
129
      char buf[10];
220
221
129
      if (! ISPRINT (c))
222
60
  sprintf (buf, "\\%03o", (unsigned int) c & 0xff);
223
69
      else
224
69
  {
225
69
    buf[0] = c;
226
69
    buf[1] = '\0';
227
69
  }
228
129
      _bfd_error_handler
229
  /* xgettext:c-format */
230
129
  (_("%pB:%d: unexpected character `%s' in Intel Hex file"),
231
129
   abfd, lineno, buf);
232
129
      bfd_set_error (bfd_error_bad_value);
233
129
    }
234
129
}
235
236
/* Read an Intel hex file and turn it into sections.  We create a new
237
   section for each contiguous set of bytes.  */
238
239
static bool
240
ihex_scan (bfd *abfd)
241
326
{
242
326
  bfd_vma segbase;
243
326
  bfd_vma extbase;
244
326
  asection *sec;
245
326
  unsigned int lineno;
246
326
  bool error;
247
326
  bfd_byte *buf = NULL;
248
326
  size_t bufsize;
249
326
  int c;
250
251
326
  if (bfd_seek (abfd, 0, SEEK_SET) != 0)
252
0
    goto error_return;
253
254
326
  abfd->start_address = 0;
255
256
326
  segbase = 0;
257
326
  extbase = 0;
258
326
  sec = NULL;
259
326
  lineno = 1;
260
326
  error = false;
261
326
  bufsize = 0;
262
263
7.85k
  while ((c = ihex_get_byte (abfd, &error)) != EOF)
264
7.80k
    {
265
7.80k
      if (c == '\r')
266
1.29k
  continue;
267
6.51k
      else if (c == '\n')
268
2.56k
  {
269
2.56k
    ++lineno;
270
2.56k
    continue;
271
2.56k
  }
272
3.95k
      else if (c != ':')
273
68
  {
274
68
    ihex_bad_byte (abfd, lineno, c, error);
275
68
    goto error_return;
276
68
  }
277
3.88k
      else
278
3.88k
  {
279
3.88k
    file_ptr pos;
280
3.88k
    unsigned char hdr[8];
281
3.88k
    unsigned int i;
282
3.88k
    unsigned int len;
283
3.88k
    bfd_vma addr;
284
3.88k
    unsigned int type;
285
3.88k
    unsigned int chars;
286
3.88k
    unsigned int chksum;
287
288
    /* This is a data record.  */
289
3.88k
    pos = bfd_tell (abfd) - 1;
290
291
    /* Read the header bytes.  */
292
3.88k
    if (bfd_read (hdr, 8, abfd) != 8)
293
52
      goto error_return;
294
295
34.3k
    for (i = 0; i < 8; i++)
296
30.5k
      {
297
30.5k
        if (! ISHEX (hdr[i]))
298
32
    {
299
32
      ihex_bad_byte (abfd, lineno, hdr[i], error);
300
32
      goto error_return;
301
32
    }
302
30.5k
      }
303
304
3.79k
    len = HEX2 (hdr);
305
3.79k
    addr = HEX4 (hdr + 2);
306
3.79k
    type = HEX2 (hdr + 6);
307
308
    /* Read the data bytes.  */
309
3.79k
    chars = len * 2 + 2;
310
3.79k
    if (chars >= bufsize)
311
3.63k
      {
312
3.63k
        buf = bfd_realloc (buf, chars);
313
3.63k
        if (buf == NULL)
314
0
    goto error_return;
315
3.63k
        bufsize = chars;
316
3.63k
      }
317
318
3.79k
    if (bfd_read (buf, chars, abfd) != chars)
319
30
      goto error_return;
320
321
20.1k
    for (i = 0; i < chars; i++)
322
16.4k
      {
323
16.4k
        if (! ISHEX (buf[i]))
324
29
    {
325
29
      ihex_bad_byte (abfd, lineno, buf[i], error);
326
29
      goto error_return;
327
29
    }
328
16.4k
      }
329
330
    /* Check the checksum.  */
331
3.74k
    chksum = len + addr + (addr >> 8) + type;
332
8.18k
    for (i = 0; i < len; i++)
333
4.44k
      chksum += HEX2 (buf + 2 * i);
334
3.74k
    if (((- chksum) & 0xff) != (unsigned int) HEX2 (buf + 2 * i))
335
46
      {
336
46
        _bfd_error_handler
337
    /* xgettext:c-format */
338
46
    (_("%pB:%u: bad checksum in Intel Hex file (expected %u, found %u)"),
339
46
     abfd, lineno,
340
46
     (- chksum) & 0xff, (unsigned int) HEX2 (buf + 2 * i));
341
46
        bfd_set_error (bfd_error_bad_value);
342
46
        goto error_return;
343
46
      }
344
345
3.69k
    switch (type)
346
3.69k
      {
347
2.93k
      case 0:
348
        /* This is a data record.  */
349
2.93k
        if (sec != NULL
350
2.26k
      && sec->vma + sec->size == extbase + segbase + addr)
351
126
    {
352
      /* This data goes at the end of the section we are
353
         currently building.  */
354
126
      sec->size += len;
355
126
    }
356
2.80k
        else if (len > 0)
357
2.18k
    {
358
2.18k
      char secbuf[20];
359
2.18k
      char *secname;
360
2.18k
      size_t amt;
361
2.18k
      flagword flags;
362
363
2.18k
      sprintf (secbuf, ".sec%d", bfd_count_sections (abfd) + 1);
364
2.18k
      amt = strlen (secbuf) + 1;
365
2.18k
      secname = (char *) bfd_alloc (abfd, amt);
366
2.18k
      if (secname == NULL)
367
0
        goto error_return;
368
2.18k
      strcpy (secname, secbuf);
369
2.18k
      flags = SEC_HAS_CONTENTS | SEC_LOAD | SEC_ALLOC;
370
2.18k
      sec = bfd_make_section_with_flags (abfd, secname, flags);
371
2.18k
      if (sec == NULL)
372
0
        goto error_return;
373
2.18k
      sec->vma = extbase + segbase + addr;
374
2.18k
      sec->lma = extbase + segbase + addr;
375
2.18k
      sec->size = len;
376
2.18k
      sec->filepos = pos;
377
2.18k
    }
378
2.93k
        break;
379
380
2.93k
      case 1:
381
        /* An end record.  */
382
6
        if (abfd->start_address == 0)
383
5
    abfd->start_address = addr;
384
6
        free (buf);
385
6
        return true;
386
387
50
      case 2:
388
        /* An extended address record.  */
389
50
        if (len != 2)
390
2
    {
391
2
      _bfd_error_handler
392
        /* xgettext:c-format */
393
2
        (_("%pB:%u: bad extended address record length in Intel Hex file"),
394
2
         abfd, lineno);
395
2
      bfd_set_error (bfd_error_bad_value);
396
2
      goto error_return;
397
2
    }
398
399
48
        segbase = HEX4 (buf) << 4;
400
401
48
        sec = NULL;
402
403
48
        break;
404
405
232
      case 3:
406
        /* An extended start address record.  */
407
232
        if (len != 4)
408
3
    {
409
3
      _bfd_error_handler
410
        /* xgettext:c-format */
411
3
        (_("%pB:%u: bad extended start address length in Intel Hex file"),
412
3
         abfd, lineno);
413
3
      bfd_set_error (bfd_error_bad_value);
414
3
      goto error_return;
415
3
    }
416
417
229
        abfd->start_address += (HEX4 (buf) << 4) + HEX4 (buf + 4);
418
419
229
        sec = NULL;
420
421
229
        break;
422
423
390
      case 4:
424
        /* An extended linear address record.  */
425
390
        if (len != 2)
426
2
    {
427
2
      _bfd_error_handler
428
        /* xgettext:c-format */
429
2
        (_("%pB:%u: bad extended linear address record length in Intel Hex file"),
430
2
         abfd, lineno);
431
2
      bfd_set_error (bfd_error_bad_value);
432
2
      goto error_return;
433
2
    }
434
435
388
        extbase = HEX4 (buf) << 16;
436
437
388
        sec = NULL;
438
439
388
        break;
440
441
80
      case 5:
442
        /* An extended linear start address record.  */
443
80
        if (len != 2 && len != 4)
444
2
    {
445
2
      _bfd_error_handler
446
        /* xgettext:c-format */
447
2
        (_("%pB:%u: bad extended linear start address length in Intel Hex file"),
448
2
         abfd, lineno);
449
2
      bfd_set_error (bfd_error_bad_value);
450
2
      goto error_return;
451
2
    }
452
453
78
        if (len == 2)
454
43
    abfd->start_address += HEX4 (buf) << 16;
455
35
        else
456
35
    abfd->start_address = (HEX4 (buf) << 16) + HEX4 (buf + 4);
457
458
78
        sec = NULL;
459
460
78
        break;
461
462
4
      default:
463
4
        _bfd_error_handler
464
    /* xgettext:c-format */
465
4
    (_("%pB:%u: unrecognized ihex type %u in Intel Hex file"),
466
4
     abfd, lineno, type);
467
4
        bfd_set_error (bfd_error_bad_value);
468
4
        goto error_return;
469
3.69k
      }
470
3.69k
  }
471
7.80k
    }
472
473
50
  if (error)
474
1
    goto error_return;
475
476
49
  free (buf);
477
49
  return true;
478
479
271
 error_return:
480
271
  free (buf);
481
271
  return false;
482
50
}
483
484
/* Try to recognize an Intel Hex file.  */
485
486
static bfd_cleanup
487
ihex_object_p (bfd *abfd)
488
161k
{
489
161k
  bfd_byte b[9];
490
161k
  unsigned int i;
491
161k
  unsigned int type;
492
493
161k
  ihex_init ();
494
495
161k
  if (bfd_seek (abfd, 0, SEEK_SET) != 0)
496
0
    return NULL;
497
161k
  if (bfd_read (b, 9, abfd) != 9)
498
2.03k
    {
499
2.03k
      if (bfd_get_error () == bfd_error_file_truncated)
500
1.58k
  bfd_set_error (bfd_error_wrong_format);
501
2.03k
      return NULL;
502
2.03k
    }
503
504
159k
  if (b[0] != ':')
505
158k
    {
506
158k
      bfd_set_error (bfd_error_wrong_format);
507
158k
      return NULL;
508
158k
    }
509
510
3.05k
  for (i = 1; i < 9; i++)
511
2.72k
    {
512
2.72k
      if (! ISHEX (b[i]))
513
21
  {
514
21
    bfd_set_error (bfd_error_wrong_format);
515
21
    return NULL;
516
21
  }
517
2.72k
    }
518
519
332
  type = HEX2 (b + 7);
520
332
  if (type > 5)
521
6
    {
522
6
      bfd_set_error (bfd_error_wrong_format);
523
6
      return NULL;
524
6
    }
525
526
  /* OK, it looks like it really is an Intel Hex file.  */
527
326
  if (!ihex_mkobject (abfd))
528
0
    return NULL;
529
530
326
  if (!ihex_scan (abfd))
531
271
    {
532
271
      bfd_release (abfd, abfd->tdata.any);
533
271
      return NULL;
534
271
    }
535
536
55
  return _bfd_no_cleanup;
537
326
}
538
539
/* Read the contents of a section in an Intel Hex file.  */
540
541
static bool
542
ihex_read_section (bfd *abfd, asection *section, bfd_byte *contents)
543
12
{
544
12
  int c;
545
12
  bfd_byte *p;
546
12
  bfd_byte *buf = NULL;
547
12
  size_t bufsize;
548
12
  bool error;
549
550
12
  if (bfd_seek (abfd, section->filepos, SEEK_SET) != 0)
551
0
    goto error_return;
552
553
12
  p = contents;
554
12
  bufsize = 0;
555
12
  error = false;
556
12
  while ((c = ihex_get_byte (abfd, &error)) != EOF)
557
12
    {
558
12
      unsigned char hdr[8];
559
12
      unsigned int len;
560
12
      unsigned int type;
561
12
      unsigned int i;
562
563
12
      if (c == '\r' || c == '\n')
564
0
  continue;
565
566
      /* This is called after ihex_scan has succeeded, so we ought to
567
   know the exact format.  */
568
12
      BFD_ASSERT (c == ':');
569
570
12
      if (bfd_read (hdr, 8, abfd) != 8)
571
0
  goto error_return;
572
573
12
      len = HEX2 (hdr);
574
12
      type = HEX2 (hdr + 6);
575
576
      /* We should only see type 0 records here.  */
577
12
      if (type != 0)
578
0
  {
579
0
    _bfd_error_handler
580
0
      (_("%pB: internal error in ihex_read_section"), abfd);
581
0
    bfd_set_error (bfd_error_bad_value);
582
0
    goto error_return;
583
0
  }
584
585
12
      if (len * 2 > bufsize)
586
12
  {
587
12
    buf = bfd_realloc (buf, len * 2);
588
12
    if (buf == NULL)
589
0
      goto error_return;
590
12
    bufsize = len * 2;
591
12
  }
592
593
12
      if (bfd_read (buf, len * 2, abfd) != len * 2)
594
0
  goto error_return;
595
596
25
      for (i = 0; i < len; i++)
597
13
  *p++ = HEX2 (buf + 2 * i);
598
12
      if ((bfd_size_type) (p - contents) >= section->size)
599
12
  {
600
    /* We've read everything in the section.  */
601
12
    free (buf);
602
12
    return true;
603
12
  }
604
605
      /* Skip the checksum.  */
606
0
      if (bfd_read (buf, 2, abfd) != 2)
607
0
  goto error_return;
608
0
    }
609
610
0
  if ((bfd_size_type) (p - contents) < section->size)
611
0
    {
612
0
      _bfd_error_handler
613
0
  (_("%pB: bad section length in ihex_read_section"), abfd);
614
0
      bfd_set_error (bfd_error_bad_value);
615
0
      goto error_return;
616
0
    }
617
618
0
  free (buf);
619
0
  return true;
620
621
0
 error_return:
622
0
  free (buf);
623
0
  return false;
624
0
}
625
626
/* Get the contents of a section in an Intel Hex file.  */
627
628
static bool
629
ihex_get_section_contents (bfd *abfd,
630
         asection *section,
631
         void * location,
632
         file_ptr offset,
633
         bfd_size_type count)
634
12
{
635
12
  if (section->used_by_bfd == NULL)
636
12
    {
637
12
      section->used_by_bfd = bfd_alloc (abfd, section->size);
638
12
      if (section->used_by_bfd == NULL)
639
0
  return false;
640
12
      if (! ihex_read_section (abfd, section,
641
12
             (bfd_byte *) section->used_by_bfd))
642
0
  return false;
643
12
    }
644
645
12
  memcpy (location, (bfd_byte *) section->used_by_bfd + offset,
646
12
    (size_t) count);
647
648
12
  return true;
649
12
}
650
651
/* Set the contents of a section in an Intel Hex file.  */
652
653
static bool
654
ihex_set_section_contents (bfd *abfd,
655
         asection *section,
656
         const void * location,
657
         file_ptr offset,
658
         bfd_size_type count)
659
4
{
660
4
  struct ihex_data_list *n;
661
4
  bfd_byte *data;
662
4
  struct ihex_data_struct *tdata;
663
664
4
  if (count == 0
665
4
      || (section->flags & SEC_ALLOC) == 0
666
4
      || (section->flags & SEC_LOAD) == 0)
667
0
    return true;
668
669
4
  n = (struct ihex_data_list *) bfd_alloc (abfd, sizeof (* n));
670
4
  if (n == NULL)
671
0
    return false;
672
673
4
  data = (bfd_byte *) bfd_alloc (abfd, count);
674
4
  if (data == NULL)
675
0
    return false;
676
4
  memcpy (data, location, (size_t) count);
677
678
4
  n->data = data;
679
4
  n->where = section->lma + offset;
680
4
  n->size = count;
681
682
  /* Sort the records by address.  Optimize for the common case of
683
     adding a record to the end of the list.  */
684
4
  tdata = abfd->tdata.ihex_data;
685
4
  if (tdata->tail != NULL
686
2
      && n->where >= tdata->tail->where)
687
2
    {
688
2
      tdata->tail->next = n;
689
2
      n->next = NULL;
690
2
      tdata->tail = n;
691
2
    }
692
2
  else
693
2
    {
694
2
      struct ihex_data_list **pp;
695
696
2
      for (pp = &tdata->head;
697
2
     *pp != NULL && (*pp)->where < n->where;
698
2
     pp = &(*pp)->next)
699
0
  ;
700
2
      n->next = *pp;
701
2
      *pp = n;
702
2
      if (n->next == NULL)
703
2
  tdata->tail = n;
704
2
    }
705
706
4
  return true;
707
4
}
708
709
/* Write a record out to an Intel Hex file.  */
710
711
static bool
712
ihex_write_record (bfd *abfd,
713
       size_t count,
714
       unsigned int addr,
715
       unsigned int type,
716
       bfd_byte *data)
717
6
{
718
6
  static const char digs[] = "0123456789ABCDEF";
719
6
  char buf[9 + CHUNK * 2 + 4];
720
6
  char *p;
721
6
  unsigned int chksum;
722
6
  unsigned int i;
723
6
  size_t total;
724
725
6
#define TOHEX(buf, v) \
726
34
  ((buf)[0] = digs[((v) >> 4) & 0xf], (buf)[1] = digs[(v) & 0xf])
727
728
6
  buf[0] = ':';
729
6
  TOHEX (buf + 1, count);
730
6
  TOHEX (buf + 3, (addr >> 8) & 0xff);
731
6
  TOHEX (buf + 5, addr & 0xff);
732
6
  TOHEX (buf + 7, type);
733
734
6
  chksum = count + addr + (addr >> 8) + type;
735
736
10
  for (i = 0, p = buf + 9; i < count; i++, p += 2, data++)
737
4
    {
738
4
      TOHEX (p, *data);
739
4
      chksum += *data;
740
4
    }
741
742
6
  TOHEX (p, (- chksum) & 0xff);
743
6
  p[2] = '\r';
744
6
  p[3] = '\n';
745
746
6
  total = 9 + count * 2 + 4;
747
6
  if (bfd_write (buf, total, abfd) != total)
748
0
    return false;
749
750
6
  return true;
751
6
}
752
753
/* Write out an Intel Hex file.  */
754
755
static bool
756
ihex_write_object_contents (bfd *abfd)
757
2
{
758
2
  bfd_vma segbase;
759
2
  bfd_vma extbase;
760
2
  struct ihex_data_list *l;
761
762
2
  segbase = 0;
763
2
  extbase = 0;
764
6
  for (l = abfd->tdata.ihex_data->head; l != NULL; l = l->next)
765
4
    {
766
4
      bfd_vma where;
767
4
      bfd_byte *p;
768
4
      bfd_size_type count;
769
770
4
      where = l->where;
771
772
4
#ifdef BFD64
773
      /* IHex only supports 32-bit addresses, and we want to check
774
   that 64-bit addresses are in range.  This isn't quite as
775
   obvious as it may seem, since some targets have 32-bit
776
   addresses that are sign extended to 64 bits.  So complain
777
   only if addresses overflow both unsigned and signed 32-bit
778
   integers.  */
779
4
      if (where > 0xffffffff
780
0
    && where + 0x80000000 > 0xffffffff)
781
0
  {
782
0
    _bfd_error_handler
783
      /* xgettext:c-format */
784
0
      (_("%pB 64-bit address %#" PRIx64
785
0
         " out of range for Intel Hex file"),
786
0
       abfd, (uint64_t) where);
787
0
    bfd_set_error (bfd_error_bad_value);
788
0
    return false;
789
0
  }
790
4
      where &= 0xffffffff;
791
4
#endif
792
793
4
      p = l->data;
794
4
      count = l->size;
795
796
8
      while (count > 0)
797
4
  {
798
4
    size_t now;
799
4
    unsigned int rec_addr;
800
801
4
    now = count;
802
4
    if (count > CHUNK)
803
0
      now = CHUNK;
804
805
4
    if (where < extbase
806
4
        || where - extbase < segbase
807
4
        || where - extbase - segbase > 0xffff)
808
0
      {
809
0
        bfd_byte addr[2];
810
811
        /* We need a new base address.  */
812
0
        if (extbase == 0 && where <= 0xfffff)
813
0
    {
814
0
      segbase = where & 0xf0000;
815
0
      addr[0] = (bfd_byte)(segbase >> 12) & 0xff;
816
0
      addr[1] = (bfd_byte)(segbase >> 4) & 0xff;
817
0
      if (! ihex_write_record (abfd, 2, 0, 2, addr))
818
0
        return false;
819
0
    }
820
0
        else
821
0
    {
822
      /* The extended address record and the extended
823
         linear address record are combined, at least by
824
         some readers.  We need an extended linear address
825
         record here, so if we've already written out an
826
         extended address record, zero it out to avoid
827
         confusion.  */
828
0
      if (segbase != 0)
829
0
        {
830
0
          addr[0] = 0;
831
0
          addr[1] = 0;
832
0
          if (! ihex_write_record (abfd, 2, 0, 2, addr))
833
0
      return false;
834
0
          segbase = 0;
835
0
        }
836
837
0
      extbase = where & 0xffff0000;
838
0
      if (where > extbase + 0xffff)
839
0
        {
840
0
          _bfd_error_handler
841
      /* xgettext:c-format */
842
0
      (_("%pB: address %#" PRIx64
843
0
         " out of range for Intel Hex file"),
844
0
       abfd, (uint64_t) where);
845
0
          bfd_set_error (bfd_error_bad_value);
846
0
          return false;
847
0
        }
848
0
      addr[0] = (bfd_byte)(extbase >> 24) & 0xff;
849
0
      addr[1] = (bfd_byte)(extbase >> 16) & 0xff;
850
0
      if (! ihex_write_record (abfd, 2, 0, 4, addr))
851
0
        return false;
852
0
    }
853
0
      }
854
855
4
    rec_addr = where - (extbase + segbase);
856
857
    /* Output records shouldn't cross 64K boundaries.  */
858
4
    if (rec_addr + now > 0xffff)
859
0
      now = 0x10000 - rec_addr;
860
861
4
    if (! ihex_write_record (abfd, now, rec_addr, 0, p))
862
0
      return false;
863
864
4
    where += now;
865
4
    p += now;
866
4
    count -= now;
867
4
  }
868
4
    }
869
870
2
  if (abfd->start_address != 0)
871
0
    {
872
0
      bfd_vma start;
873
0
      bfd_byte startbuf[4];
874
875
0
      start = abfd->start_address;
876
877
0
      if (start <= 0xfffff)
878
0
  {
879
0
    startbuf[0] = (bfd_byte)((start & 0xf0000) >> 12) & 0xff;
880
0
    startbuf[1] = 0;
881
0
    startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
882
0
    startbuf[3] = (bfd_byte)start & 0xff;
883
0
    if (! ihex_write_record (abfd, 4, 0, 3, startbuf))
884
0
      return false;
885
0
  }
886
0
      else
887
0
  {
888
0
    startbuf[0] = (bfd_byte)(start >> 24) & 0xff;
889
0
    startbuf[1] = (bfd_byte)(start >> 16) & 0xff;
890
0
    startbuf[2] = (bfd_byte)(start >> 8) & 0xff;
891
0
    startbuf[3] = (bfd_byte)start & 0xff;
892
0
    if (! ihex_write_record (abfd, 4, 0, 5, startbuf))
893
0
      return false;
894
0
  }
895
0
    }
896
897
2
  if (! ihex_write_record (abfd, 0, 0, 1, NULL))
898
0
    return false;
899
900
2
  return true;
901
2
}
902
903
/* Set the architecture for the output file.  The architecture is
904
   irrelevant, so we ignore errors about unknown architectures.  */
905
906
static bool
907
ihex_set_arch_mach (bfd *abfd,
908
        enum bfd_architecture arch,
909
        unsigned long mach)
910
2
{
911
2
  if (! bfd_default_set_arch_mach (abfd, arch, mach))
912
2
    {
913
2
      if (arch != bfd_arch_unknown)
914
0
  return false;
915
2
    }
916
2
  return true;
917
2
}
918
919
/* Some random definitions for the target vector.  */
920
921
#define ihex_close_and_cleanup        _bfd_generic_close_and_cleanup
922
#define ihex_bfd_free_cached_info     _bfd_generic_bfd_free_cached_info
923
#define ihex_new_section_hook       _bfd_generic_new_section_hook
924
#define ihex_sizeof_headers       _bfd_nolink_sizeof_headers
925
#define ihex_bfd_get_relocated_section_contents   bfd_generic_get_relocated_section_contents
926
#define ihex_bfd_relax_section        bfd_generic_relax_section
927
#define ihex_bfd_gc_sections        bfd_generic_gc_sections
928
#define ihex_bfd_lookup_section_flags     bfd_generic_lookup_section_flags
929
#define ihex_bfd_is_group_section     bfd_generic_is_group_section
930
#define ihex_bfd_group_name       bfd_generic_group_name
931
#define ihex_bfd_discard_group        bfd_generic_discard_group
932
#define ihex_section_already_linked     _bfd_generic_section_already_linked
933
#define ihex_bfd_define_common_symbol     bfd_generic_define_common_symbol
934
#define ihex_bfd_link_hide_symbol     _bfd_generic_link_hide_symbol
935
#define ihex_bfd_define_start_stop      bfd_generic_define_start_stop
936
#define ihex_bfd_link_hash_table_create     _bfd_generic_link_hash_table_create
937
#define ihex_bfd_link_add_symbols     _bfd_generic_link_add_symbols
938
#define ihex_bfd_link_just_syms       _bfd_generic_link_just_syms
939
#define ihex_bfd_copy_link_hash_symbol_type   _bfd_generic_copy_link_hash_symbol_type
940
#define ihex_bfd_final_link       _bfd_generic_final_link
941
#define ihex_bfd_link_split_section     _bfd_generic_link_split_section
942
#define ihex_bfd_link_check_relocs      _bfd_generic_link_check_relocs
943
944
/* The Intel Hex target vector.  */
945
946
const bfd_target ihex_vec =
947
{
948
  "ihex",     /* Name.  */
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
  0,        /* match priority.  */
958
  TARGET_KEEP_UNUSED_SECTION_SYMBOLS, /* keep unused section symbols.  */
959
  TARGET_MERGE_SECTIONS,
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, /* Data.  */
963
  bfd_getb64, bfd_getb_signed_64, bfd_putb64,
964
  bfd_getb32, bfd_getb_signed_32, bfd_putb32,
965
  bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* Headers. */
966
967
  {
968
    _bfd_dummy_target,
969
    ihex_object_p,    /* bfd_check_format.  */
970
    _bfd_dummy_target,
971
    _bfd_dummy_target,
972
  },
973
  {
974
    _bfd_bool_bfd_false_error,
975
    ihex_mkobject,
976
    _bfd_bool_bfd_false_error,
977
    _bfd_bool_bfd_false_error,
978
  },
979
  {       /* bfd_write_contents.  */
980
    _bfd_bool_bfd_false_error,
981
    ihex_write_object_contents,
982
    _bfd_bool_bfd_false_error,
983
    _bfd_bool_bfd_false_error,
984
  },
985
986
  BFD_JUMP_TABLE_GENERIC (ihex),
987
  BFD_JUMP_TABLE_COPY (_bfd_generic),
988
  BFD_JUMP_TABLE_CORE (_bfd_nocore),
989
  BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
990
  BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols),
991
  BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
992
  BFD_JUMP_TABLE_WRITE (ihex),
993
  BFD_JUMP_TABLE_LINK (ihex),
994
  BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
995
996
  NULL,
997
998
  NULL
999
};