1 /* Remote debugging interface for boot monitors, for GDB.
2 Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
3 Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
5 This file is part of GDB.
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 2 of the License, or
10 (at your option) any later version.
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.
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., 675 Mass Ave, Cambridge, MA 02139, USA. */
21 /* This file was derived from various remote-* modules. It is a collection
22 of generic support functions so GDB can talk directly to a ROM based
23 monitor. This saves use from having to hack an exception based handler
24 into existance, and makes for quick porting.
26 This module talks to a debug monitor called 'MONITOR', which
27 We communicate with MONITOR via either a direct serial line, or a TCP
28 (or possibly TELNET) stream to a terminal multiplexor,
29 which in turn talks to the target board.
39 #include <sys/types.h>
43 #include "remote-utils.h"
46 # define TERMINAL struct termios
48 # define TERMINAL struct sgttyb
51 extern void make_xmodem_packet();
52 extern void print_xmodem_packet();
54 struct monitor_ops *current_monitor;
55 extern struct cmd_list_element *setlist;
56 extern struct cmd_list_element *unsetlist;
57 struct cmd_list_element *showlist;
59 extern char *host_name;
60 extern char *target_name;
62 static int hashmark; /* flag set by "set hash" */
64 #define LOG_FILE "monitor.log"
65 #if defined (LOG_FILE)
69 static int timeout = 24;
72 * Descriptor for I/O to remote machine. Initialize it to NULL so that
73 * monitor_open knows that we don't have a file open when the program starts.
75 static serial_t monitor_desc = NULL;
77 /* sets the download protocol, choices are srec, generic, boot */
79 static char *loadtype_str;
80 static void set_loadtype_command();
81 static void monitor_load_srec();
82 static int monitor_write_srec();
85 * these definitions are for xmodem protocol
92 #define GETACK getacknak(ACK)
93 #define GETNAK getacknak(NAK)
94 #define XMODEM_DATASIZE 128 /* the data size is ALWAYS 128 */
95 #define XMODEM_PACKETSIZE 131 /* the packet size is ALWAYS 132 (zero based) */
99 * set_loadtype_command -- set the type for downloading. Check to make
100 * sure you have a support protocol for this target.
103 set_loadtype_command (ignore, from_tty, c)
106 struct cmd_list_element *c;
110 if (STREQ (LOADTYPES, "")) {
111 error ("No loadtype set");
115 tmp = savestring (LOADTYPES, strlen(LOADTYPES));
116 type = strtok(tmp, ",");
117 if (STREQ (type, (*(char **) c->var))) {
118 loadtype_str = savestring (*(char **) c->var, strlen (*(char **) c->var));
122 while ((type = strtok (NULL, ",")) != (char *)NULL) {
123 if (STREQ (type, (*(char **) c->var)))
124 loadtype_str = savestring (*(char **) c->var, strlen (*(char **) c->var));
128 error ("Loadtype \"%s\" does not exist.", (*(char **) c->var));
132 * printf_monitor -- send data to monitor. Works just like printf.
135 printf_monitor(va_alist)
145 pattern = va_arg(args, char *);
147 vsprintf(buf, pattern, args);
149 debuglogs (1, "printf_monitor(), Sending: \"%s\".", buf);
151 if (SERIAL_WRITE(monitor_desc, buf, strlen(buf)))
152 fprintf(stderr, "SERIAL_WRITE failed: %s\n", safe_strerror(errno));
155 * write_monitor -- send raw data to monitor.
158 write_monitor(data, len)
162 if (SERIAL_WRITE(monitor_desc, data, len))
163 fprintf(stderr, "SERIAL_WRITE failed: %s\n", safe_strerror(errno));
165 *(data + len+1) = '\0';
166 debuglogs (1, "write_monitor(), Sending: \"%s\".", data);
171 * debuglogs -- deal with debugging info to multiple sources. This takes
172 * two real args, the first one is the level to be compared against
173 * the sr_get_debug() value, the second arg is a printf buffer and args
174 * to be formatted and printed. A CR is added after each string is printed.
188 level = va_arg(args, int); /* get the debug level */
189 if ((level <0) || (level > 100)) {
190 error ("Bad argument passed to debuglogs(), needs debug level");
194 pattern = va_arg(args, char *); /* get the printf style pattern */
196 vsprintf(buf, pattern, args); /* format the string */
198 /* convert some characters so it'll look right in the log */
200 for (i=0 ; buf[i] != '\0'; i++) {
202 case '\n': /* newlines */
206 case '\r': /* carriage returns */
210 case '\033': /* escape */
218 case '\b': /* backspace */
222 default: /* no change */
226 if (buf[i] < 26) { /* modify control characters */
232 *p = '\0'; /* terminate the string */
234 if (sr_get_debug() > level)
237 #ifdef LOG_FILE /* write to the monitor log */
238 if (log_file != 0x0) {
239 fputs (newbuf, log_file);
240 fputc ('\n', log_file);
246 /* readchar -- read a character from the remote system, doing all the fancy
255 c = SERIAL_READCHAR(monitor_desc, timeout);
257 if (sr_get_debug() > 5)
262 putc(c & 0x7f, log_file);
268 if (c == SERIAL_TIMEOUT) {
270 return c; /* Polls shouldn't generate timeout errors */
271 error("Timeout reading from remote system.");
273 fputs ("ERROR: Timeout reading from remote system", log_file);
276 perror_with_name("remote-monitor");
280 * expect -- scan input from the remote system, until STRING is found.
281 * If DISCARD is non-zero, then discard non-matching input, else print
282 * it out. Let the user break out immediately.
285 expect (string, discard)
293 debuglogs (1, "Expecting \"%s\".", string);
297 c = readchar(timeout);
303 debuglogs (4, "Matched");
308 fwrite(string, 1, (p - 1) - string, stdout);
317 /* Keep discarding input until we see the MONITOR prompt.
319 The convention for dealing with the prompt is that you
321 o *then* wait for the prompt.
323 Thus the last thing that a procedure does with the serial line
324 will be an expect_prompt(). Exception: monitor_resume does not
325 wait for the prompt, because the terminal is being handed over
326 to the inferior. However, the next thing which happens after that
327 is a monitor_wait which does wait for the prompt.
328 Note that this includes abnormal exit, e.g. error(). This is
329 necessary to prevent getting into states from which we can't
332 expect_prompt(discard)
335 expect (PROMPT, discard);
339 * junk -- ignore junk characters. Returns a 1 if junk, 0 otherwise
352 if (sr_get_debug() > 5)
353 debuglogs (5, "Ignoring \'%c\'.", ch);
356 if (sr_get_debug() > 5)
357 debuglogs (5, "Accepting \'%c\'.", ch);
363 * get_hex_digit -- Get a hex digit from the remote system & return its value.
364 * If ignore is nonzero, ignore spaces, newline & tabs.
367 get_hex_digit(ignore)
372 ch = readchar(timeout);
375 if (sr_get_debug() > 4)
376 debuglogs (4, "get_hex_digit() got a 0x%x(%c)", ch, ch);
378 if (ch >= '0' && ch <= '9')
380 else if (ch >= 'A' && ch <= 'F')
381 return ch - 'A' + 10;
382 else if (ch >= 'a' && ch <= 'f')
383 return ch - 'a' + 10;
384 else if (ch == ' ' && ignore)
388 error("Invalid hex digit from remote system. (0x%x)", ch);
393 /* get_hex_byte -- Get a byte from monitor and put it in *BYT.
394 * Accept any number leading spaces.
402 val = get_hex_digit (1) << 4;
403 debuglogs (4, "get_hex_digit() -- Read first nibble 0x%x", val);
405 val |= get_hex_digit (0);
406 debuglogs (4, "get_hex_digit() -- Read second nibble 0x%x", val);
409 debuglogs (4, "get_hex_digit() -- Read a 0x%x", val);
413 * get_hex_word -- Get N 32-bit words from remote, each preceded by a space,
414 * and put them in registers starting at REGNO.
423 for (i = 0; i < 8; i++)
424 val = (val << 4) + get_hex_digit (i == 0);
426 debuglogs (4, "get_hex_word() got a 0x%x.", val);
431 /* This is called not only when we first attach, but also when the
432 user types "run" after having attached. */
434 monitor_create_inferior (execfile, args, env)
442 error("Can't pass arguments to remote MONITOR process");
444 if (execfile == 0 || exec_bfd == 0)
445 error("No exec file specified");
447 entry_pt = (int) bfd_get_start_address (exec_bfd);
449 debuglogs (1, "create_inferior(exexfile=%s, args=%s, env=%s)", execfile, args, env);
451 /* The "process" (board) is already stopped awaiting our commands, and
452 the program is already downloaded. We just set its PC and go. */
454 clear_proceed_status ();
456 /* Tell wait_for_inferior that we've started a new process. */
457 init_wait_for_inferior ();
459 /* Set up the "saved terminal modes" of the inferior
460 based on what modes we are starting it with. */
461 target_terminal_init ();
463 /* Install inferior's terminal modes. */
464 target_terminal_inferior ();
466 /* insert_step_breakpoint (); FIXME, do we need this? */
469 proceed ((CORE_ADDR)entry_pt, TARGET_SIGNAL_DEFAULT, 0);
473 * monitor_open -- open a connection to a remote debugger.
474 * NAME is the filename used for communication.
476 static int baudrate = 9600;
477 static char dev_name[100];
480 monitor_open(args, name, from_tty)
487 error ("Use `target %s DEVICE-NAME' to use a serial port, or \n\
488 `target %s HOST-NAME:PORT-NUMBER' to use a network connection.", name, name);
493 strcpy(dev_name, args);
494 monitor_desc = SERIAL_OPEN(dev_name);
496 if (monitor_desc == NULL)
497 perror_with_name(dev_name);
499 if (baud_rate != -1) {
500 if (SERIAL_SETBAUDRATE (monitor_desc, baud_rate)) {
501 SERIAL_CLOSE (monitor_desc);
502 perror_with_name (name);
506 SERIAL_RAW(monitor_desc);
508 #if defined (LOG_FILE)
509 log_file = fopen (LOG_FILE, "w");
510 if (log_file == NULL)
511 perror_with_name (LOG_FILE);
512 fprintf_filtered (log_file, "GDB %s (%s", version, host_name);
513 fprintf_filtered (log_file, " --target %s)\n", target_name);
514 fprintf_filtered (log_file, "Remote target %s connected to %s\n\n", TARGET_NAME, dev_name);
517 /* wake up the monitor and see if it's alive */
518 printf_monitor(INIT_CMD);
519 expect_prompt(1); /* See if we get a prompt */
521 /* try again to be sure */
522 printf_monitor(INIT_CMD);
523 expect_prompt(1); /* See if we get a prompt */
526 printf("Remote target %s connected to %s\n", TARGET_NAME, dev_name);
530 * monitor_close -- Close out all files and local state before this
531 * target loses control.
535 monitor_close (quitting)
538 SERIAL_CLOSE(monitor_desc);
541 debuglogs (1, "monitor_close (quitting=%d)", quitting);
543 #if defined (LOG_FILE)
545 if (ferror(log_file))
546 fprintf(stderr, "Error writing log file.\n");
547 if (fclose(log_file) != 0)
548 fprintf(stderr, "Error closing log file.\n");
554 * monitor_detach -- terminate the open connection to the remote
555 * debugger. Use this when you want to detach and do something
556 * else with your gdb.
559 monitor_detach (from_tty)
563 debuglogs (1, "monitor_detach ()");
565 pop_target(); /* calls monitor_close to do the real work */
567 printf ("Ending remote %s debugging\n", target_shortname);
571 * monitor_attach -- attach GDB to the target.
574 monitor_attach (args, from_tty)
579 printf ("Starting remote %s debugging\n", target_shortname);
581 debuglogs (1, "monitor_attach (args=%s)", args);
583 printf_monitor (GO_CMD);
584 /* swallow the echo. */
589 * monitor_resume -- Tell the remote machine to resume.
592 monitor_resume (pid, step, sig)
594 enum target_signal sig;
596 debuglogs (1, "monitor_resume (step=%d, sig=%d)", step, sig);
599 printf_monitor (STEP_CMD);
601 printf_monitor (CONT_CMD);
606 * monitor_wait -- Wait until the remote machine stops, then return,
607 * storing status in status just as `wait' would.
610 monitor_wait (pid, status)
612 struct target_waitstatus *status;
614 int old_timeout = timeout;
616 debuglogs(1, "monitor_wait (), printing extraneous text.");
618 status->kind = TARGET_WAITKIND_EXITED;
619 status->value.integer = 0;
621 timeout = 0; /* Don't time out -- user program is running. */
623 expect_prompt(0); /* Wait for prompt, outputting extraneous text */
624 debuglogs (4, "monitor_wait(), got the prompt.");
626 status->kind = TARGET_WAITKIND_STOPPED;
627 status->value.sig = TARGET_SIGNAL_TRAP;
629 timeout = old_timeout;
634 /* Return the name of register number regno in the form input and output by
635 monitor. Currently, register_names just happens to contain exactly what
636 monitor wants. Lets take advantage of that just as long as possible! */
651 for (p = REGNAMES(regno); *p; p++)
656 debuglogs (5, "Got name \"%s\" from regno #%d.", buf, regno);
662 * monitor_fetch_registers -- read the remote registers into the
666 monitor_fetch_registers ()
670 /* yeah yeah, i know this is horribly inefficient. but it isn't done
671 very often... i'll clean it up later. */
673 for (regno = 0; regno <= PC_REGNUM; regno++)
674 monitor_fetch_register(regno);
678 * monitor_fetch_register -- fetch register REGNO, or all registers if REGNO
679 * is -1. Returns errno value.
682 monitor_fetch_register (regno)
687 debuglogs (1, "monitor_fetch_register (reg=%s)", get_reg_name (regno));
690 monitor_fetch_registers ();
692 char *name = get_reg_name (regno);
695 printf_monitor (ROMCMD(GET_REG), name); /* send the command */
696 expect (name, 1); /* then strip the leading garbage */
697 if (*ROMDELIM(GET_REG) != 0) { /* if there's a delimiter */
698 expect (ROMDELIM(GET_REG), 1);
701 val = get_hex_word(); /* get the value, ignore junk */
702 supply_register (regno, (char *) &val);
704 if (*ROMDELIM(GET_REG) != 0) {
705 /*** expect (ROMRES(GET_REG)); ***/
706 printf_monitor (CMD_END);
713 /* Store the remote registers from the contents of the block REGS. */
716 monitor_store_registers ()
720 debuglogs (1, "monitor_store_registers()");
722 for (regno = 0; regno <= PC_REGNUM; regno++)
723 monitor_store_register(regno);
725 registers_changed ();
729 * monitor_store_register -- store register REGNO, or all if REGNO == 0.
730 * return errno value.
733 monitor_store_register (regno)
739 i = read_register(regno);
741 debuglogs (1, "monitor_store_register (regno=%d)", regno);
744 monitor_store_registers ();
746 debuglogs (3, "Setting register %s to 0x%x", get_reg_name (regno), read_register (regno));
748 name = get_reg_name (regno);
751 printf_monitor (ROMCMD(SET_REG), name, read_register(regno));
752 expect (name, 1); /* strip the leading garbage */
753 if (*ROMDELIM(SET_REG) != 0) { /* if there's a delimiter */
754 expect (ROMDELIM(SET_REG), 1);
756 printf_monitor ("%d%s\n", i, CMD_END);
763 printf_monitor (SET_REG, get_reg_name (regno),
764 read_register (regno));
770 /* Get ready to modify the registers array. On machines which store
771 individual registers, this doesn't need to do anything. On machines
772 which store all the registers in one fell swoop, this makes sure
773 that registers contains all the registers from the program being
777 monitor_prepare_to_store ()
779 /* Do nothing, since we can store individual regs */
783 monitor_files_info ()
785 printf ("\tAttached to %s at %d baud.\n",
790 * monitor_write_inferior_memory -- Copy LEN bytes of data from debugger
791 * memory at MYADDR to inferior's memory at MEMADDR. Returns length moved.
794 monitor_write_inferior_memory (memaddr, myaddr, len)
796 unsigned char *myaddr;
802 debuglogs (1, "monitor_write_inferior_memory (memaddr=0x%x, myaddr=0x%x, len=%d)", memaddr, myaddr, len);
804 for (i = 0; i < len; i++) {
805 printf_monitor (ROMCMD(SET_MEM), memaddr + i, myaddr[i] );
806 if (*ROMDELIM(SET_MEM) != 0) { /* if there's a delimiter */
807 expect (ROMDELIM(SET_MEM), 1);
809 printf_monitor ("%x", myaddr[i]);
811 /*** printf_monitor ("%x", myaddr[i]); ***/
812 if (sr_get_debug() > 1)
813 printf ("\nSet 0x%x to 0x%x\n", memaddr + i, myaddr[i]);
814 if (*ROMDELIM(SET_MEM) != 0) {
816 printf_monitor (CMD_END);
824 * monitor_read_inferior_memory -- read LEN bytes from inferior memory
825 * at MEMADDR. Put the result at debugger address MYADDR. Returns
829 monitor_read_inferior_memory(memaddr, myaddr, len)
837 /* Number of bytes read so far. */
840 /* Starting address of this pass. */
841 unsigned long startaddr;
843 /* Number of bytes to read in this pass. */
846 debuglogs (1, "monitor_read_inferior_memory (memaddr=0x%x, myaddr=0x%x, len=%d)", memaddr, myaddr, len);
848 /* Note that this code works correctly if startaddr is just less
849 than UINT_MAX (well, really CORE_ADDR_MAX if there was such a
850 thing). That is, something like
851 monitor_read_bytes (CORE_ADDR_MAX - 4, foo, 4)
852 works--it never adds len To memaddr and gets 0. */
853 /* However, something like
854 monitor_read_bytes (CORE_ADDR_MAX - 3, foo, 4)
855 doesn't need to work. Detect it and give up if there's an attempt
857 if (((memaddr - 1) + len) < memaddr) {
864 while (count < len) {
866 if ((startaddr % 16) != 0)
867 len_this_pass -= startaddr % 16;
868 if (len_this_pass > (len - count))
869 len_this_pass = (len - count);
871 debuglogs (3, "Display %d bytes at %x", len_this_pass, startaddr);
873 for (i = 0; i < len_this_pass; i++) {
874 printf_monitor (ROMCMD(GET_MEM), startaddr, startaddr);
875 sprintf (buf, ROMCMD(GET_MEM), startaddr, startaddr);
876 if (*ROMDELIM(GET_MEM) != 0) { /* if there's a delimiter */
877 expect (ROMDELIM(GET_MEM), 1);
879 sprintf (buf, ROMCMD(GET_MEM), startaddr, startaddr);
880 expect (buf,1); /* get the command echo */
881 get_hex_word(1); /* strip away the address */
883 get_hex_byte (&myaddr[count++]); /* get the value at this address */
885 if (*ROMDELIM(GET_MEM) != 0) {
886 printf_monitor (CMD_END);
895 /* FIXME-someday! merge these two. */
897 monitor_xfer_inferior_memory (memaddr, myaddr, len, write, target)
902 struct target_ops *target; /* ignored */
905 return monitor_write_inferior_memory (memaddr, myaddr, len);
907 return monitor_read_inferior_memory (memaddr, myaddr, len);
911 monitor_kill (args, from_tty)
915 return; /* ignore attempts to kill target system */
918 /* Clean up when a program exits.
919 The program actually lives on in the remote processor's RAM, and may be
920 run again without a download. Don't leave it full of breakpoint
924 monitor_mourn_inferior ()
926 remove_breakpoints ();
927 generic_mourn_inferior (); /* Do all the proper things now */
930 #define MAX_MONITOR_BREAKPOINTS 16
932 extern int memory_breakpoint_size;
933 static CORE_ADDR breakaddr[MAX_MONITOR_BREAKPOINTS] = {0};
936 * monitor_insert_breakpoint -- add a breakpoint
939 monitor_insert_breakpoint (addr, shadow)
945 debuglogs (1, "monitor_insert_breakpoint() addr = 0x%x", addr);
947 for (i = 0; i <= MAX_MONITOR_BREAKPOINTS; i++) {
948 if (breakaddr[i] == 0) {
950 if (sr_get_debug() > 4)
951 printf ("Breakpoint at %x\n", addr);
952 monitor_read_inferior_memory(addr, shadow, memory_breakpoint_size);
953 printf_monitor(SET_BREAK_CMD, addr);
959 fprintf(stderr, "Too many breakpoints (> 16) for monitor\n");
964 * _remove_breakpoint -- Tell the monitor to remove a breakpoint
967 monitor_remove_breakpoint (addr, shadow)
973 debuglogs (1, "monitor_remove_breakpoint() addr = 0x%x", addr);
975 for (i = 0; i < MAX_MONITOR_BREAKPOINTS; i++) {
976 if (breakaddr[i] == addr) {
978 /* some monitors remove breakpoints based on the address */
980 printf_monitor(CLR_BREAK_CMD, addr);
982 printf_monitor(CLR_BREAK_CMD, i);
987 fprintf(stderr, "Can't find breakpoint associated with 0x%x\n", addr);
991 /* monitor_load -- load a file. This file determines which of the
992 * supported formats to use. The current types are:
993 * FIXME: not all types supported yet.
994 * default - reads any file using bfd and writes it to memory. This
996 * srec - reads binary file using bfd and writes it as an
998 * xmodem-bin - reads a binary file using bfd, and downloads it
999 * using xmodem protocol.
1000 * xmodem-srec - reads a binary file using bfd, and after converting
1001 * it downloads it as an srecord using xmodem protocol.
1002 * ascii-srec - reads a ascii srecord file and downloads it
1004 * ascii-xmodem - reads a ascii file and downloads using xmodem
1008 monitor_load (file, fromtty)
1015 debuglogs (1, "Loading %s to monitor", file);
1017 if (STREQ (loadtype_str, "default")) { /* default, load a binary */
1018 gr_load_image (file, fromtty); /* by writing it into memory */
1021 if (STREQ (loadtype_str, "srec")) { /* load an srecord by converting */
1022 monitor_load_srec(file, 0); /* if from a binary */
1025 if (STREQ (loadtype_str, "ascii-srec")) { /* load an srecord file */
1026 monitor_load_ascii_srec(file, fromtty); /* if from a binary */
1029 if (STREQ (loadtype_str, "xmodem-srec")) { /* load an srecord using the */
1030 monitor_load_srec(file, XMODEM);
1035 * monitor_load_ascii_srec -- download an ASCII srecord file.
1037 #define DOWNLOAD_LINE_SIZE 100
1039 monitor_load_ascii_srec (file, fromtty)
1044 char buf[DOWNLOAD_LINE_SIZE];
1047 debuglogs (1, "Loading an ASCII srecord file, %s.", file);
1049 download = fopen (file, "r");
1050 if (download == NULL) {
1051 error ("%s Does not exist", file);
1055 printf_monitor (LOAD_CMD);
1057 while (!feof (download)) {
1058 bytes_read = fread (buf, sizeof (char), DOWNLOAD_LINE_SIZE, download);
1063 if (SERIAL_WRITE(monitor_desc, buf, bytes_read)) {
1064 fprintf(stderr, "SERIAL_WRITE failed: (while downloading) %s\n", safe_strerror(errno));
1068 while (i++ <=200) {} ; /* Ugly HACK, probably needs flow control */
1069 if (bytes_read < DOWNLOAD_LINE_SIZE) {
1070 if (!feof (download))
1071 error ("Only read %d bytes\n", bytes_read);
1079 if (!feof (download))
1080 error ("Never got EOF while downloading");
1086 * monitor_command -- put a command string, in args, out to MONITOR.
1087 * Output from MONITOR is placed on the users terminal until the
1088 * prompt is seen. FIXME: We read the charcters ourseleves here
1089 * cause of a nasty echo.
1092 monitor_command (args, fromtty)
1101 debuglogs (1, "monitor_command (args=%s)", args);
1103 if (monitor_desc == NULL)
1104 error("monitor target not open.");
1107 error("Missing command.");
1109 printf_monitor ("%s\n", args);
1115 * monitor_load_srec -- download a binary file by converting it to srecords. This
1116 * will also use xmodem to download the resulting file.
1118 * A download goes like this when using xmodem:
1121 * <-------- (packet) [SOH|1|1|data|SUM]
1123 * <-------- (packet) [SOH|2|2|data|SUM]
1134 monitor_load_srec (args, protocol)
1142 char packet[XMODEM_PACKETSIZE];
1145 int type = 0; /* default to a type 0, header record */
1146 int srec_frame = 57; /* FIXME: this must be 57 There is 12 bytes
1147 of header, and 2 bytes of checksum at the end.
1148 The problem is an xmodem packet holds exactly
1151 abfd = bfd_openr (args, 0);
1153 printf_filtered ("Unable to open file %s\n", args);
1157 if (bfd_check_format (abfd, bfd_object) == 0) {
1158 printf_filtered ("File is not an object file\n");
1162 printf_monitor (LOAD_CMD); /* tell the monitor to load */
1163 if (protocol == XMODEM) { /* get the NAK from the target */
1165 debuglogs (3, "Got the NAK to start loading");
1167 printf_monitor ("%c", EOT);
1168 debuglogs (3, "Never got the NAK to start loading");
1169 error ("Never got the NAK to start loading");
1174 while (s != (asection *) NULL) {
1175 if (s->flags & SEC_LOAD) {
1176 char *buffer = xmalloc (srec_frame);
1177 printf_filtered ("%s\t: 0x%4x .. 0x%4x ", s->name, s->vma, s->vma + s->_raw_size);
1179 for (i = 0; i < s->_raw_size; i += srec_frame) {
1180 if (srec_frame > s->_raw_size - i)
1181 srec_frame = s->_raw_size - i;
1183 bfd_get_section_contents (abfd, s, buffer, i, srec_frame);
1184 monitor_make_srec (srec, type, s->vma + i, buffer, srec_frame);
1185 if (protocol == XMODEM) { /* send a packet using xmodem */
1186 make_xmodem_packet (packet, srec, XMODEM_DATASIZE);
1187 write_monitor (packet, XMODEM_PACKETSIZE+1);
1189 while (retries++ <= 3) {
1190 if (GETNAK) { /* Resend packet */
1191 debuglogs (3, "Got a NAK, resending packet");
1193 write_monitor (packet, XMODEM_PACKETSIZE+1); /* send it again */
1194 if (GETACK) /* ACKnowledged, get next data chunk */
1198 if (retries >= 4) { /* too many tries, must be hosed */
1199 printf_monitor ("%c", EOT);
1200 error ("Never got a ACK after sending an xmodem packet");
1202 } else { /* no protocols at all */
1203 printf_monitor ("%s\n", srec);
1206 printf_filtered ("#");
1207 type = 3; /* switch to a 4 byte address record */
1210 printf_filtered ("\n");
1213 debuglogs (3, "%s doesn't need to be loaded", s->name);
1219 write a type 7 terminator record. no data for a type 7,
1220 and there is no data, so len is 0.
1222 monitor_make_srec (srec, 7, abfd->start_address, "", 0);
1223 printf_monitor ("%s\n", srec);
1224 if (protocol == XMODEM) {
1225 printf_monitor ("%c", EOT);
1227 error ("Never got ACK after sending EOT");
1237 * getacknak -- get an ACK or a NAK from the target.
1238 * returns 1 (true) or 0 (false) This is
1239 * for xmodem. ANy string starting with "***"
1240 * is an error message from the target.
1241 * Here's a few from the WinBond w89k "Cougar" PA board.
1242 * *** Too many errors found.
1244 * *** Command syntax error
1255 character = (char)readchar (0);
1256 if (character == 0xfffffffe) { /* empty uart */
1257 if (sr_get_debug() > 3)
1263 if (character == CANCEL) { /* target aborted load */
1265 error ("Got a CANCEL from the target.");
1267 if (character == '*') { /* look for missed error message */
1269 error ("Got an error message from the target");
1271 debuglogs (3, "Got a %s (0x%x or \'%c\'), expecting a %s.\n",
1272 (character == ACK) ? "ACK" : (character == NAK) ? "NAK" : "BOGUS",
1273 character, character, (byte == ACK) ? "ACK" : "NAK");
1274 if (character == byte) /* got what we wanted */
1276 if (character == ((byte == ACK) ? NAK : ACK)) { /* got the opposite */
1277 debuglogs (3, "Got the opposite, wanted 0x%x, got a 0x%x", byte, character);
1286 * monitor_make_srec -- make an srecord. This writes each line, one at a
1287 * time, each with it's own header and trailer line.
1288 * An srecord looks like this:
1290 * byte count-+ address
1291 * start ---+ | | data +- checksum
1293 * S01000006F6B692D746573742E73726563E4
1294 * S315000448600000000000000000FC00005900000000E9
1295 * S31A0004000023C1400037DE00F023604000377B009020825000348D
1296 * S30B0004485A0000000000004E
1299 * S<type><length><address><data><checksum>
1303 * is the number of bytes following upto the checksum. Note that
1304 * this is not the number of chars following, since it takes two
1305 * chars to represent a byte.
1309 * 1) two byte address data record
1310 * 2) three byte address data record
1311 * 3) four byte address data record
1312 * 7) four byte address termination record
1313 * 8) three byte address termination record
1314 * 9) two byte address termination record
1317 * is the start address of the data following, or in the case of
1318 * a termination record, the start address of the image
1322 * is the sum of all the raw byte data in the record, from the length
1323 * upwards, modulo 256 and subtracted from 255.
1326 monitor_make_srec (buffer, type, memaddr, myaddr, len)
1330 unsigned char *myaddr;
1338 debuglogs (4, "monitor_make_srec (buffer=0x%x, type=%d, memaddr=0x%x, len=%d",
1339 buffer, type, memaddr, len);
1343 create the header for the srec. 4 is the number of bytes in the address,
1344 and 1 is the number of bytes in the count.
1346 if (type == 0) /* FIXME: type 0 is optional */
1347 type = 3; /* so use data as it works */
1348 sprintf (buf, "S%d%02X%08X", type, len + 4 + 1, memaddr);
1351 checksum += (len + 4 + 1 /* calculate the checksum */
1353 + ((memaddr >> 8) & 0xff)
1354 + ((memaddr >> 16) & 0xff)
1355 + ((memaddr >> 24) & 0xff));
1357 for (i = 0; i < len; i++) { /* build the srecord */
1358 sprintf (buf, "%02X", myaddr[i]);
1359 checksum += myaddr[i];
1363 sprintf(buf, "%02X", ~checksum & 0xff); /* add the checksum */
1364 debuglogs (3, "srec is \"%s\"", buffer);
1370 * make_xmodem_packet -- this takes a 128 bytes of data and makes a packet
1373 * Each packet looks like this:
1374 * +-----+-------+-------+------+-----+
1375 * | SOH | Seq1. | Seq2. | data | SUM |
1376 * +-----+-------+-------+------+-----+
1378 * Seq1 = The sequence number.
1379 * Seq2 = The complement of the sequence number.
1380 * Data = A 128 bytes of data.
1381 * SUM = Add the contents of the 128 bytes and use the low-order
1382 * 8 bits of the result.
1385 make_xmodem_packet (packet, data, len)
1386 unsigned char packet[];
1387 unsigned char *data;
1390 static int sequence = 1;
1395 /* build the packet header */
1397 packet[1] = sequence;
1398 packet[2] = 255 - sequence;
1401 packet[2] = ~sequence++; /* the complement is the sequence checksum */
1404 sum = 0; /* calculate the data checksum */
1405 for (i = 3; i <= len + 2; i++) {
1411 for (i = len+1 ; i <= XMODEM_DATASIZE ; i++) { /* add padding for the rest of the packet */
1415 packet[XMODEM_PACKETSIZE] = sum & 0xff; /* add the checksum */
1417 if (sr_get_debug() > 4)
1418 debuglogs (4, "The xmodem checksum is %d (0x%x)\n", sum & 0xff, sum & 0xff);
1419 print_xmodem_packet (packet);
1423 * print_xmodem_packet -- print the packet as a debug check
1426 print_xmodem_packet(packet)
1433 /* take apart the packet header the packet header */
1434 if (packet[0] == SOH) {
1437 error ("xmodem: SOH is wrong");
1440 /* check the sequence */
1441 if (packet[1] != 0) {
1442 lastseq = packet[1];
1443 if (packet[2] != ~lastseq)
1444 error ("xmodem: Sequence checksum is wrong");
1446 printf_filtered (" %d %d", lastseq, ~lastseq);
1449 /* check the data checksum */
1451 for (i = 3; i <= XMODEM_DATASIZE; i++) {
1455 /* ignore the data */
1457 printf (" [128 bytes of data] %d\n", sum & 0xff);
1459 printf_filtered (" [%s] %d\n", packet, sum & 0xff);
1461 if ((packet[XMODEM_PACKETSIZE] & 0xff) != (sum & 0xff)) {
1462 debuglogs (4, "xmodem: data checksum wrong, got a %d", packet[XMODEM_PACKETSIZE] & 0xff);
1468 * _initialize_remote_monitors -- setup a few addtitional commands that
1469 * are usually only used by monitors.
1472 _initialize_remote_monitors ()
1474 struct cmd_list_element *c;
1476 /* this sets the type of download protocol */
1477 c = add_set_cmd ("loadtype", no_class, var_string, (char *)&loadtype_str,
1478 "Set the type of the remote load protocol.\n", &setlist);
1479 c->function.sfunc = set_loadtype_command;
1480 add_show_from_set (c, &showlist);
1481 loadtype_str = savestring ("default", 8);
1483 add_show_from_set (add_set_cmd ("hash", no_class, var_boolean,
1485 "Set display of activity while downloading a file.\n\
1486 When enabled, a period \'.\' is displayed.",
1490 /* generic monitor command */
1491 add_com ("monitor", class_obscure, monitor_command,
1492 "Send a command to the debug monitor.");