[deliverable/binutils-gdb.git] / gdb / dsrec.c

/* S-record download support for GDB, the GNU debugger.
   Copyright 1995, 1996, 1997 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#include "defs.h"
#include "serial.h"
#include "srec.h"
#include <time.h>

extern void report_transfer_performance (unsigned long, time_t, time_t);

extern int remote_debug;

static int make_srec (char *srec, CORE_ADDR targ_addr, bfd * abfd,
		      asection * sect, int sectoff, int *maxrecsize,
		      int flags);

/* Download an executable by converting it to S records.  DESC is a
   serial_t to send the data to.  FILE is the name of the file to be
   loaded.  LOAD_OFFSET is the offset into memory to load data into.
   It is usually specified by the user and is useful with the a.out
   file format.  MAXRECSIZE is the length in chars of the largest
   S-record the host can accomodate.  This is measured from the
   starting `S' to the last char of the checksum.  FLAGS is various
   random flags, and HASHMARK is non-zero to cause a `#' to be
   printed out for each record loaded.  WAITACK, if non-NULL, is a
   function that waits for an acknowledgement after each S-record,
   and returns non-zero if the ack is read correctly.  */

void
load_srec (desc, file, load_offset, maxrecsize, flags, hashmark, waitack)
     serial_t desc;
     const char *file;
     bfd_vma load_offset;
     int maxrecsize;
     int flags;
     int hashmark;
     int (*waitack) (void);
{
  bfd *abfd;
  asection *s;
  char *srec;
  int i;
  int reclen;
  time_t start_time, end_time;
  unsigned long data_count = 0;

  srec = (char *) alloca (maxrecsize + 1);

  abfd = bfd_openr (file, 0);
  if (!abfd)
    {
      printf_filtered ("Unable to open file %s\n", file);
      return;
    }

  if (bfd_check_format (abfd, bfd_object) == 0)
    {
      printf_filtered ("File is not an object file\n");
      return;
    }

  start_time = time (NULL);

  /* Write a type 0 header record. no data for a type 0, and there
     is no data, so len is 0.  */

  reclen = maxrecsize;
  make_srec (srec, 0, NULL, (asection *) 1, 0, &reclen, flags);
  if (remote_debug)
    {
      srec[reclen] = '\0';
      puts_debug ("sent -->", srec, "<--");
    }
  SERIAL_WRITE (desc, srec, reclen);

  for (s = abfd->sections; s; s = s->next)
    if (s->flags & SEC_LOAD)
      {
	int numbytes;
	bfd_vma addr = bfd_get_section_vma (abfd, s) + load_offset;
	bfd_size_type size = bfd_get_section_size_before_reloc (s);
	char *section_name = (char *) bfd_get_section_name (abfd, s);
	/* Both GDB and BFD have mechanisms for printing addresses.
           In the below, GDB's is used so that the address is
           consistent with the rest of GDB.  BFD's printf_vma() could
           have also been used. cagney 1999-09-01 */
	printf_filtered ("%s\t: 0x%s .. 0x%s  ",
			 section_name,
			 paddr (addr),
			 paddr (addr + size));
	gdb_flush (gdb_stdout);

	data_count += size;

	for (i = 0; i < size; i += numbytes)
	  {
	    reclen = maxrecsize;
	    numbytes = make_srec (srec, (CORE_ADDR) (addr + i), abfd, s,
				  i, &reclen, flags);

	    if (remote_debug)
	      {
		srec[reclen] = '\0';
		puts_debug ("sent -->", srec, "<--");
	      }

	    /* Repeatedly send the S-record until a good
	       acknowledgement is sent back.  */
	    do
	      {
		SERIAL_WRITE (desc, srec, reclen);
		if (ui_load_progress_hook)
		  if (ui_load_progress_hook (section_name, (unsigned long) i))
		    error ("Canceled the download");
	      }
	    while (waitack != NULL && !waitack ());

	    if (hashmark)
	      {
		putchar_unfiltered ('#');
		gdb_flush (gdb_stdout);
	      }
	  }			/* Per-packet (or S-record) loop */

	if (ui_load_progress_hook)
	  if (ui_load_progress_hook (section_name, (unsigned long) i))
	    error ("Canceled the download");
	putchar_unfiltered ('\n');
      }

  if (hashmark)
    putchar_unfiltered ('\n');

  end_time = time (NULL);

  /* Write a terminator record.  */

  reclen = maxrecsize;
  make_srec (srec, abfd->start_address, NULL, NULL, 0, &reclen, flags);

  if (remote_debug)
    {
      srec[reclen] = '\0';
      puts_debug ("sent -->", srec, "<--");
    }

  SERIAL_WRITE (desc, srec, reclen);

  /* Some monitors need these to wake up properly.  (Which ones? -sts)  */
  SERIAL_WRITE (desc, "\r\r", 2);
  if (remote_debug)
    puts_debug ("sent -->", "\r\r", "<---");

  SERIAL_FLUSH_INPUT (desc);

  report_transfer_performance (data_count, start_time, end_time);
}

/*
 * make_srec -- make an srecord. This writes each line, one at a
 *      time, each with it's own header and trailer line.
 *      An srecord looks like this:
 *
 * byte count-+     address
 * start ---+ |        |       data        +- checksum
 *          | |        |                   |
 *        S01000006F6B692D746573742E73726563E4
 *        S315000448600000000000000000FC00005900000000E9
 *        S31A0004000023C1400037DE00F023604000377B009020825000348D
 *        S30B0004485A0000000000004E
 *        S70500040000F6
 *
 *      S<type><length><address><data><checksum>
 *
 *      Where
 *      - length
 *        is the number of bytes following upto the checksum. Note that
 *        this is not the number of chars following, since it takes two
 *        chars to represent a byte.
 *      - type
 *        is one of:
 *        0) header record
 *        1) two byte address data record
 *        2) three byte address data record
 *        3) four byte address data record
 *        7) four byte address termination record
 *        8) three byte address termination record
 *        9) two byte address termination record
 *       
 *      - address
 *        is the start address of the data following, or in the case of
 *        a termination record, the start address of the image
 *      - data
 *        is the data.
 *      - checksum
 *        is the sum of all the raw byte data in the record, from the length
 *        upwards, modulo 256 and subtracted from 255.
 *
 * This routine returns the length of the S-record.
 *
 */

static int
make_srec (char *srec, CORE_ADDR targ_addr, bfd *abfd, asection *sect,
	   int sectoff, int *maxrecsize, int flags)
{
  unsigned char checksum;
  int tmp;
  const static char hextab[] = "0123456789ABCDEF";
  const static char data_code_table[] = "123";
  const static char term_code_table[] = "987";
  const static char header_code_table[] = "000";
  const static char *formats[] =
  {"S%c%02X%04X",
   "S%c%02X%06X",
   "S%c%02X%08X"};
  char const *code_table;
  int addr_size;
  int payload_size;
  char *binbuf;
  char *p;

  if (sect)
    {
      tmp = flags;		/* Data or header record */
      code_table = abfd ? data_code_table : header_code_table;
      binbuf = alloca (*maxrecsize / 2);
    }
  else
    {
      tmp = flags >> SREC_TERM_SHIFT;	/* Term record */
      code_table = term_code_table;
    }

  if ((tmp & SREC_2_BYTE_ADDR) && (targ_addr <= 0xffff))
    addr_size = 2;
  else if ((tmp & SREC_3_BYTE_ADDR) && (targ_addr <= 0xffffff))
    addr_size = 3;
  else if (tmp & SREC_4_BYTE_ADDR)
    addr_size = 4;
  else
    internal_error ("make_srec:  Bad address (0x%x), or bad flags (0x%x).",
		    targ_addr, flags);

  /* Now that we know the address size, we can figure out how much
     data this record can hold.  */

  if (sect && abfd)
    {
      payload_size = (*maxrecsize - (1 + 1 + 2 + addr_size * 2 + 2)) / 2;
      payload_size = min (payload_size, sect->_raw_size - sectoff);

      bfd_get_section_contents (abfd, sect, binbuf, sectoff, payload_size);
    }
  else
    payload_size = 0;		/* Term or header packets have no payload */

  /* Output the header.  */

  sprintf (srec, formats[addr_size - 2], code_table[addr_size - 2],
	   addr_size + payload_size + 1, (int) targ_addr);

  /* Note that the checksum is calculated on the raw data, not the
     hexified data.  It includes the length, address and the data
     portions of the packet.  */

  checksum = 0;

  checksum += (payload_size + addr_size + 1	/* Packet length */
	       + (targ_addr & 0xff)	/* Address... */
	       + ((targ_addr >> 8) & 0xff)
	       + ((targ_addr >> 16) & 0xff)
	       + ((targ_addr >> 24) & 0xff));

  p = srec + 1 + 1 + 2 + addr_size * 2;

  /* Build the Srecord.  */
  for (tmp = 0; tmp < payload_size; tmp++)
    {
      unsigned char k;

      k = binbuf[tmp];
      *p++ = hextab[k >> 4];
      *p++ = hextab[k & 0xf];
      checksum += k;
    }

  checksum = ~checksum;

  *p++ = hextab[checksum >> 4];
  *p++ = hextab[checksum & 0xf];
  *p++ = '\r';

  *maxrecsize = p - srec;
  return payload_size;
}
Commit	Line	Data
c906108c SS	1	/* S-record download support for GDB, the GNU debugger.
	2	Copyright 1995, 1996, 1997 Free Software Foundation, Inc.
	3
c5aa993b	4	This file is part of GDB.
c906108c	5
c5aa993b JM	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 2 of the License, or
	9	(at your option) any later version.
c906108c	10
c5aa993b JM	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
c906108c	15
c5aa993b JM	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the Free Software
	18	Foundation, Inc., 59 Temple Place - Suite 330,
	19	Boston, MA 02111-1307, USA. */
c906108c SS	20
	21	#include "defs.h"
	22	#include "serial.h"
	23	#include "srec.h"
	24	#include <time.h>
	25
a14ed312	26	extern void report_transfer_performance (unsigned long, time_t, time_t);
c906108c SS	27
	28	extern int remote_debug;
	29
a14ed312 KB	30	static int make_srec (char srec, CORE_ADDR targ_addr, bfd abfd,
	31	asection * sect, int sectoff, int *maxrecsize,
	32	int flags);
c906108c SS	33
c906108c SS	34	/* Download an executable by converting it to S records. DESC is a
c5aa993b JM	35	serial_t to send the data to. FILE is the name of the file to be
	36	loaded. LOAD_OFFSET is the offset into memory to load data into.
	37	It is usually specified by the user and is useful with the a.out
	38	file format. MAXRECSIZE is the length in chars of the largest
	39	S-record the host can accomodate. This is measured from the
	40	starting `S' to the last char of the checksum. FLAGS is various
	41	random flags, and HASHMARK is non-zero to cause a `#' to be
	42	printed out for each record loaded. WAITACK, if non-NULL, is a
	43	function that waits for an acknowledgement after each S-record,
	44	and returns non-zero if the ack is read correctly. */
c906108c SS	45
	46	void
	47	load_srec (desc, file, load_offset, maxrecsize, flags, hashmark, waitack)
	48	serial_t desc;
	49	const char *file;
	50	bfd_vma load_offset;
	51	int maxrecsize;
	52	int flags;
	53	int hashmark;
507f3c78	54	int (*waitack) (void);
c906108c SS	55	{
	56	bfd *abfd;
	57	asection *s;
	58	char *srec;
	59	int i;
	60	int reclen;
	61	time_t start_time, end_time;
	62	unsigned long data_count = 0;
	63
	64	srec = (char *) alloca (maxrecsize + 1);
	65
	66	abfd = bfd_openr (file, 0);
	67	if (!abfd)
	68	{
	69	printf_filtered ("Unable to open file %s\n", file);
	70	return;
	71	}
	72
	73	if (bfd_check_format (abfd, bfd_object) == 0)
	74	{
	75	printf_filtered ("File is not an object file\n");
	76	return;
	77	}
	78
	79	start_time = time (NULL);
	80
	81	/* Write a type 0 header record. no data for a type 0, and there
	82	is no data, so len is 0. */
	83
	84	reclen = maxrecsize;
c5aa993b	85	make_srec (srec, 0, NULL, (asection *) 1, 0, &reclen, flags);
c906108c SS	86	if (remote_debug)
	87	{
	88	srec[reclen] = '\0';
	89	puts_debug ("sent -->", srec, "<--");
	90	}
	91	SERIAL_WRITE (desc, srec, reclen);
	92
	93	for (s = abfd->sections; s; s = s->next)
	94	if (s->flags & SEC_LOAD)
	95	{
	96	int numbytes;
	97	bfd_vma addr = bfd_get_section_vma (abfd, s) + load_offset;
	98	bfd_size_type size = bfd_get_section_size_before_reloc (s);
c5aa993b	99	char section_name = (char ) bfd_get_section_name (abfd, s);
d4f3574e SS	100	/* Both GDB and BFD have mechanisms for printing addresses.
	101	In the below, GDB's is used so that the address is
	102	consistent with the rest of GDB. BFD's printf_vma() could
	103	have also been used. cagney 1999-09-01 */
	104	printf_filtered ("%s\t: 0x%s .. 0x%s ",
	105	section_name,
	106	paddr (addr),
	107	paddr (addr + size));
c906108c SS	108	gdb_flush (gdb_stdout);
	109
	110	data_count += size;
	111
	112	for (i = 0; i < size; i += numbytes)
	113	{
	114	reclen = maxrecsize;
	115	numbytes = make_srec (srec, (CORE_ADDR) (addr + i), abfd, s,
	116	i, &reclen, flags);
	117
	118	if (remote_debug)
	119	{
	120	srec[reclen] = '\0';
	121	puts_debug ("sent -->", srec, "<--");
	122	}
	123
	124	/* Repeatedly send the S-record until a good
	125	acknowledgement is sent back. */
	126	do
	127	{
c5aa993b	128	SERIAL_WRITE (desc, srec, reclen);
c906108c SS	129	if (ui_load_progress_hook)
	130	if (ui_load_progress_hook (section_name, (unsigned long) i))
	131	error ("Canceled the download");
	132	}
	133	while (waitack != NULL && !waitack ());
	134
	135	if (hashmark)
	136	{
	137	putchar_unfiltered ('#');
	138	gdb_flush (gdb_stdout);
	139	}
	140	} /* Per-packet (or S-record) loop */
	141
	142	if (ui_load_progress_hook)
	143	if (ui_load_progress_hook (section_name, (unsigned long) i))
	144	error ("Canceled the download");
	145	putchar_unfiltered ('\n');
	146	}
	147
c5aa993b	148	if (hashmark)
c906108c SS	149	putchar_unfiltered ('\n');
	150
	151	end_time = time (NULL);
c5aa993b	152
c906108c SS	153	/* Write a terminator record. */
	154
	155	reclen = maxrecsize;
	156	make_srec (srec, abfd->start_address, NULL, NULL, 0, &reclen, flags);
	157
	158	if (remote_debug)
	159	{
	160	srec[reclen] = '\0';
	161	puts_debug ("sent -->", srec, "<--");
	162	}
	163
	164	SERIAL_WRITE (desc, srec, reclen);
	165
	166	/* Some monitors need these to wake up properly. (Which ones? -sts) */
	167	SERIAL_WRITE (desc, "\r\r", 2);
	168	if (remote_debug)
	169	puts_debug ("sent -->", "\r\r", "<---");
	170
	171	SERIAL_FLUSH_INPUT (desc);
	172
	173	report_transfer_performance (data_count, start_time, end_time);
	174	}
	175
	176	/*
	177	* make_srec -- make an srecord. This writes each line, one at a
c5aa993b JM	178	* time, each with it's own header and trailer line.
c5aa993b JM	179	* An srecord looks like this:
c906108c SS	180	*
	181	* byte count-+ address
	182	* start ---+ \| \| data +- checksum
c5aa993b JM	183	* \| \| \| \|
	184	* S01000006F6B692D746573742E73726563E4
	185	* S315000448600000000000000000FC00005900000000E9
	186	* S31A0004000023C1400037DE00F023604000377B009020825000348D
	187	* S30B0004485A0000000000004E
	188	* S70500040000F6
c906108c	189	*
c5aa993b	190	* S<type><length><address><data><checksum>
c906108c SS	191	*
	192	* Where
	193	* - length
	194	* is the number of bytes following upto the checksum. Note that
	195	* this is not the number of chars following, since it takes two
	196	* chars to represent a byte.
	197	* - type
	198	* is one of:
	199	* 0) header record
	200	* 1) two byte address data record
	201	* 2) three byte address data record
	202	* 3) four byte address data record
	203	* 7) four byte address termination record
	204	* 8) three byte address termination record
	205	* 9) two byte address termination record
	206	*
	207	* - address
	208	* is the start address of the data following, or in the case of
	209	* a termination record, the start address of the image
	210	* - data
	211	* is the data.
	212	* - checksum
c5aa993b	213	* is the sum of all the raw byte data in the record, from the length
c906108c SS	214	* upwards, modulo 256 and subtracted from 255.
	215	*
	216	* This routine returns the length of the S-record.
	217	*
	218	*/
	219
	220	static int
fba45db2 KB	221	make_srec (char srec, CORE_ADDR targ_addr, bfd abfd, asection *sect,
fba45db2 KB	222	int sectoff, int *maxrecsize, int flags)
c906108c SS	223	{
	224	unsigned char checksum;
	225	int tmp;
	226	const static char hextab[] = "0123456789ABCDEF";
	227	const static char data_code_table[] = "123";
	228	const static char term_code_table[] = "987";
	229	const static char header_code_table[] = "000";
c5aa993b JM	230	const static char *formats[] =
	231	{"S%c%02X%04X",
	232	"S%c%02X%06X",
	233	"S%c%02X%08X"};
c906108c SS	234	char const *code_table;
	235	int addr_size;
	236	int payload_size;
	237	char *binbuf;
	238	char *p;
	239
	240	if (sect)
	241	{
	242	tmp = flags; /* Data or header record */
	243	code_table = abfd ? data_code_table : header_code_table;
c5aa993b	244	binbuf = alloca (*maxrecsize / 2);
c906108c SS	245	}
	246	else
	247	{
c5aa993b	248	tmp = flags >> SREC_TERM_SHIFT; /* Term record */
c906108c SS	249	code_table = term_code_table;
	250	}
	251
	252	if ((tmp & SREC_2_BYTE_ADDR) && (targ_addr <= 0xffff))
	253	addr_size = 2;
	254	else if ((tmp & SREC_3_BYTE_ADDR) && (targ_addr <= 0xffffff))
	255	addr_size = 3;
	256	else if (tmp & SREC_4_BYTE_ADDR)
	257	addr_size = 4;
	258	else
96baa820 JM	259	internal_error ("make_srec: Bad address (0x%x), or bad flags (0x%x).",
96baa820 JM	260	targ_addr, flags);
c906108c SS	261
	262	/* Now that we know the address size, we can figure out how much
	263	data this record can hold. */
	264
	265	if (sect && abfd)
	266	{
	267	payload_size = (maxrecsize - (1 + 1 + 2 + addr_size 2 + 2)) / 2;
	268	payload_size = min (payload_size, sect->_raw_size - sectoff);
	269
	270	bfd_get_section_contents (abfd, sect, binbuf, sectoff, payload_size);
	271	}
	272	else
	273	payload_size = 0; /* Term or header packets have no payload */
	274
	275	/* Output the header. */
	276
	277	sprintf (srec, formats[addr_size - 2], code_table[addr_size - 2],
c5aa993b	278	addr_size + payload_size + 1, (int) targ_addr);
c906108c SS	279
	280	/* Note that the checksum is calculated on the raw data, not the
	281	hexified data. It includes the length, address and the data
	282	portions of the packet. */
	283
	284	checksum = 0;
c5aa993b	285
c906108c	286	checksum += (payload_size + addr_size + 1 /* Packet length */
c5aa993b JM	287	+ (targ_addr & 0xff) /* Address... */
c5aa993b JM	288	+ ((targ_addr >> 8) & 0xff)
c906108c SS	289	+ ((targ_addr >> 16) & 0xff)
c906108c SS	290	+ ((targ_addr >> 24) & 0xff));
c5aa993b	291
c906108c SS	292	p = srec + 1 + 1 + 2 + addr_size * 2;
	293
	294	/* Build the Srecord. */
	295	for (tmp = 0; tmp < payload_size; tmp++)
	296	{
	297	unsigned char k;
	298
	299	k = binbuf[tmp];
c5aa993b JM	300	*p++ = hextab[k >> 4];
c5aa993b JM	301	*p++ = hextab[k & 0xf];
c906108c SS	302	checksum += k;
	303	}
	304
	305	checksum = ~checksum;
	306
	307	*p++ = hextab[checksum >> 4];
	308	*p++ = hextab[checksum & 0xf];
	309	*p++ = '\r';
	310
	311	*maxrecsize = p - srec;
	312	return payload_size;
	313	}