1 /* Remote debugging interface for Motorola's MVME187BUG monitor, an embedded
4 Copyright 1992, 1993 Free Software Foundation, Inc.
5 Contributed by Cygnus Support. Written by K. Richard Pixley.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
28 #include "gdb_string.h"
39 #include "remote-utils.h"
44 /* External data declarations */
45 extern int stop_soon_quietly; /* for wait_for_inferior */
47 /* Forward data declarations */
48 extern struct target_ops bug_ops; /* Forward declaration */
50 /* Forward function declarations */
51 static int bug_clear_breakpoints (void);
53 static int bug_read_memory (CORE_ADDR memaddr,
54 unsigned char *myaddr, int len);
56 static int bug_write_memory (CORE_ADDR memaddr,
57 unsigned char *myaddr, int len);
59 /* This variable is somewhat arbitrary. It's here so that it can be
60 set from within a running gdb. */
62 static int srec_max_retries = 3;
64 /* Each S-record download to the target consists of an S0 header
65 record, some number of S3 data records, and one S7 termination
66 record. I call this download a "frame". Srec_frame says how many
67 bytes will be represented in each frame. */
70 static int srec_frame = SREC_SIZE;
72 /* This variable determines how many bytes will be represented in each
75 static int srec_bytes = 40;
77 /* At one point it appeared to me as though the bug monitor could not
78 really be expected to receive two sequential characters at 9600
79 baud reliably. Echo-pacing is an attempt to force data across the
80 line even in this condition. Specifically, in echo-pace mode, each
81 character is sent one at a time and we look for the echo before
82 sending the next. This is excruciatingly slow. */
84 static int srec_echo_pace = 0;
86 /* How long to wait after an srec for a possible error message.
87 Similar to the above, I tried sleeping after sending each S3 record
88 in hopes that I might actually see error messages from the bug
89 monitor. This might actually work if we were to use sleep
90 intervals smaller than 1 second. */
92 static int srec_sleep = 0;
94 /* Every srec_noise records, flub the checksum. This is a debugging
95 feature. Set the variable to something other than 1 in order to
96 inject *deliberate* checksum errors. One might do this if one
97 wanted to test error handling and recovery. */
99 static int srec_noise = 0;
101 /* Called when SIGALRM signal sent due to alarm() timeout. */
103 /* Number of SIGTRAPs we need to simulate. That is, the next
104 NEED_ARTIFICIAL_TRAP calls to bug_wait should just return
105 SIGTRAP without actually waiting for anything. */
107 static int need_artificial_trap = 0;
110 * Download a file specified in 'args', to the bug.
114 bug_load (args, fromtty)
124 dcache_flush (gr_get_dcache ());
126 abfd = bfd_openr (args, 0);
129 printf_filtered ("Unable to open file %s\n", args);
133 if (bfd_check_format (abfd, bfd_object) == 0)
135 printf_filtered ("File is not an object file\n");
140 while (s != (asection *) NULL)
142 srec_frame = SREC_SIZE;
143 if (s->flags & SEC_LOAD)
147 char *buffer = xmalloc (srec_frame);
149 printf_filtered ("%s\t: 0x%4x .. 0x%4x ", s->name, s->vma, s->vma + s->_raw_size);
150 gdb_flush (gdb_stdout);
151 for (i = 0; i < s->_raw_size; i += srec_frame)
153 if (srec_frame > s->_raw_size - i)
154 srec_frame = s->_raw_size - i;
156 bfd_get_section_contents (abfd, s, buffer, i, srec_frame);
157 bug_write_memory (s->vma + i, buffer, srec_frame);
158 printf_filtered ("*");
159 gdb_flush (gdb_stdout);
161 printf_filtered ("\n");
166 sprintf (buffer, "rs ip %lx", (unsigned long) abfd->start_address);
167 sr_write_cr (buffer);
188 while (*s && !isspace (*s))
194 copy = xmalloc (len + 1);
195 memcpy (copy, word, len);
202 static struct gr_settings bug_settings =
207 bug_clear_breakpoints, /* clear_all_breakpoints */
208 bug_read_memory, /* readfunc */
209 bug_write_memory, /* writefunc */
210 gr_generic_checkin, /* checkin */
213 static char *cpu_check_strings[] =
220 bug_open (args, from_tty)
227 gr_open (args, from_tty, &bug_settings);
228 /* decide *now* whether we are on an 88100 or an 88110 */
229 sr_write_cr ("rs cr06");
230 sr_expect ("rs cr06");
232 switch (gr_multi_scan (cpu_check_strings, 0))
234 case 0: /* this is an m88100 */
235 target_is_m88110 = 0;
237 case 1: /* this is an m88110 */
238 target_is_m88110 = 1;
245 /* Tell the remote machine to resume. */
248 bug_resume (pid, step, sig)
250 enum target_signal sig;
252 dcache_flush (gr_get_dcache ());
258 /* Force the next bug_wait to return a trap. Not doing anything
259 about I/O from the target means that the user has to type
260 "continue" to see any. FIXME, this should be fixed. */
261 need_artificial_trap = 1;
269 /* Wait until the remote machine stops, then return,
270 storing status in STATUS just as `wait' would. */
272 static char *wait_strings[] =
275 "Exception: Data Access Fault (Local Bus Timeout)",
276 "\r8??\?-Bug>", /* The '\?' avoids creating a trigraph */
282 bug_wait (pid, status)
284 struct target_waitstatus *status;
286 int old_timeout = sr_get_timeout ();
287 int old_immediate_quit = immediate_quit;
289 status->kind = TARGET_WAITKIND_EXITED;
290 status->value.integer = 0;
292 /* read off leftovers from resume so that the rest can be passed
293 back out as stdout. */
294 if (need_artificial_trap == 0)
296 sr_expect ("Effective address: ");
297 (void) sr_get_hex_word ();
301 sr_set_timeout (-1); /* Don't time out -- user program is running. */
302 immediate_quit = 1; /* Helps ability to QUIT */
304 switch (gr_multi_scan (wait_strings, need_artificial_trap == 0))
306 case 0: /* breakpoint case */
307 status->kind = TARGET_WAITKIND_STOPPED;
308 status->value.sig = TARGET_SIGNAL_TRAP;
309 /* user output from the target can be discarded here. (?) */
313 case 1: /* bus error */
314 status->kind = TARGET_WAITKIND_STOPPED;
315 status->value.sig = TARGET_SIGNAL_BUS;
316 /* user output from the target can be discarded here. (?) */
320 case 2: /* normal case */
322 if (need_artificial_trap != 0)
325 status->kind = TARGET_WAITKIND_STOPPED;
326 status->value.sig = TARGET_SIGNAL_TRAP;
327 need_artificial_trap--;
333 status->kind = TARGET_WAITKIND_EXITED;
334 status->value.integer = 0;
338 case -1: /* trouble */
340 fprintf_filtered (gdb_stderr,
341 "Trouble reading target during wait\n");
345 sr_set_timeout (old_timeout);
346 immediate_quit = old_immediate_quit;
350 /* Return the name of register number REGNO
351 in the form input and output by bug.
353 Returns a pointer to a static buffer containing the answer. */
360 "r00", "r01", "r02", "r03", "r04", "r05", "r06", "r07",
361 "r08", "r09", "r10", "r11", "r12", "r13", "r14", "r15",
362 "r16", "r17", "r18", "r19", "r20", "r21", "r22", "r23",
363 "r24", "r25", "r26", "r27", "r28", "r29", "r30", "r31",
365 /* these get confusing because we omit a few and switch some ordering around. */
367 "cr01", /* 32 = psr */
368 "fcr62", /* 33 = fpsr */
369 "fcr63", /* 34 = fpcr */
370 "ip", /* this is something of a cheat. */
372 "cr05", /* 36 = snip */
373 "cr06", /* 37 = sfip */
375 "x00", "x01", "x02", "x03", "x04", "x05", "x06", "x07",
376 "x08", "x09", "x10", "x11", "x12", "x13", "x14", "x15",
377 "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
378 "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
384 #if 0 /* not currently used */
385 /* Read from remote while the input matches STRING. Return zero on
386 success, -1 on failure. */
400 printf ("\nNext character is '%c' - %d and s is \"%s\".\n", c, c, --s);
410 bug_srec_write_cr (s)
418 if (sr_get_debug () > 0)
422 SERIAL_WRITE (sr_get_desc (), p, 1);
423 while (sr_pollchar () != *p);
428 /* return(bug_scan (s) || bug_scan ("\n")); */
434 /* Store register REGNO, or all if REGNO == -1. */
437 bug_fetch_register (regno)
446 for (i = 0; i < NUM_REGS; ++i)
447 bug_fetch_register (i);
449 else if (target_is_m88110 && regno == SFIP_REGNUM)
451 /* m88110 has no sfip. */
453 supply_register (regno, (char *) &l);
455 else if (regno < XFP_REGNUM)
457 char buffer[MAX_REGISTER_RAW_SIZE];
460 sr_write_cr (get_reg_name (regno));
462 store_unsigned_integer (buffer, REGISTER_RAW_SIZE (regno),
465 supply_register (regno, buffer);
469 /* Float register so we need to parse a strange data format. */
471 unsigned char fpreg_buf[10];
474 sr_write (get_reg_name (regno), strlen (get_reg_name (regno)));
477 sr_expect (get_reg_name (regno));
482 p = sr_get_hex_digit (1);
483 fpreg_buf[0] = p << 7;
487 p = sr_get_hex_digit (1);
488 fpreg_buf[0] += (p << 4);
489 fpreg_buf[0] += sr_get_hex_digit (1);
491 fpreg_buf[1] = sr_get_hex_digit (1) << 4;
495 fpreg_buf[1] += sr_get_hex_digit (1);
497 fpreg_buf[2] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
498 fpreg_buf[3] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
499 fpreg_buf[4] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
500 fpreg_buf[5] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
501 fpreg_buf[6] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
502 fpreg_buf[7] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
507 supply_register (regno, fpreg_buf);
513 /* Store register REGNO, or all if REGNO == -1. */
516 bug_store_register (regno)
526 for (i = 0; i < NUM_REGS; ++i)
527 bug_store_register (i);
533 regname = get_reg_name (regno);
535 if (target_is_m88110 && regno == SFIP_REGNUM)
537 else if (regno < XFP_REGNUM)
538 sprintf (buffer, "rs %s %08x",
540 read_register (regno));
543 unsigned char *fpreg_buf =
544 (unsigned char *) ®isters[REGISTER_BYTE (regno)];
546 sprintf (buffer, "rs %s %1x_%02x%1x_%1x%02x%02x%02x%02x%02x%02x;d",
549 (fpreg_buf[0] >> 7) & 0xf,
552 (fpreg_buf[1] >> 8) & 0xf,
563 sr_write_cr (buffer);
571 bug_xfer_memory (memaddr, myaddr, len, write, target)
576 struct target_ops *target; /* ignored */
580 /* Round starting address down to longword boundary. */
581 register CORE_ADDR addr;
583 /* Round ending address up; get number of longwords that makes. */
586 /* Allocate buffer of that many longwords. */
587 register int *buffer;
589 addr = memaddr & -sizeof (int);
590 count = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
592 buffer = (int *) alloca (count * sizeof (int));
596 /* Fill start and end extra bytes of buffer with existing memory data. */
598 if (addr != memaddr || len < (int) sizeof (int))
600 /* Need part of initial word -- fetch it. */
601 buffer[0] = gr_fetch_word (addr);
604 if (count > 1) /* FIXME, avoid if even boundary */
607 = gr_fetch_word (addr + (count - 1) * sizeof (int));
610 /* Copy data to be written over corresponding part of buffer */
612 memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
614 /* Write the entire buffer. */
616 for (i = 0; i < count; i++, addr += sizeof (int))
619 gr_store_word (addr, buffer[i]);
630 /* Read all the longwords */
631 for (i = 0; i < count; i++, addr += sizeof (int))
634 buffer[i] = gr_fetch_word (addr);
642 /* Copy appropriate bytes out of the buffer. */
643 memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
654 command = (srec_echo_pace ? "lo 0 ;x" : "lo 0");
656 sr_write_cr (command);
659 bug_srec_write_cr ("S0030000FC");
663 /* This is an extremely vulnerable and fragile function. I've made
664 considerable attempts to make this deterministic, but I've
665 certainly forgotten something. The trouble is that S-records are
666 only a partial file format, not a protocol. Worse, apparently the
667 m88k bug monitor does not run in real time while receiving
668 S-records. Hence, we must pay excruciating attention to when and
669 where error messages are returned, and what has actually been sent.
671 Each call represents a chunk of memory to be sent to the target.
672 We break that chunk into an S0 header record, some number of S3
673 data records each containing srec_bytes, and an S7 termination
676 static char *srecord_strings[] =
684 bug_write_memory (memaddr, myaddr, len)
686 unsigned char *myaddr;
693 char *buffer = alloca ((srec_bytes + 8) << 1);
701 if (retries > srec_max_retries)
706 if (sr_get_debug () > 0)
707 printf ("\n<retrying...>\n");
709 /* This gr_expect_prompt call is extremely important. Without
710 it, we will tend to resend our packet so fast that it
711 will arrive before the bug monitor is ready to receive
712 it. This would lead to a very ugly resend loop. */
728 if (thisgo > srec_bytes)
731 address = memaddr + done;
732 sprintf (buf, "S3%02X%08X", thisgo + 4 + 1, address);
735 checksum += (thisgo + 4 + 1
737 + ((address >> 8) & 0xff)
738 + ((address >> 16) & 0xff)
739 + ((address >> 24) & 0xff));
741 for (idx = 0; idx < thisgo; idx++)
743 sprintf (buf, "%02X", myaddr[idx + done]);
744 checksum += myaddr[idx + done];
750 /* FIXME-NOW: insert a deliberate error every now and then.
751 This is intended for testing/debugging the error handling
753 static int counter = 0;
754 if (++counter > srec_noise)
761 sprintf (buf, "%02X", ~checksum & 0xff);
762 bug_srec_write_cr (buffer);
767 /* This pollchar is probably redundant to the gr_multi_scan
768 below. Trouble is, we can't be sure when or where an
769 error message will appear. Apparently, when running at
770 full speed from a typical sun4, error messages tend to
771 appear to arrive only *after* the s7 record. */
773 if ((x = sr_pollchar ()) != 0)
775 if (sr_get_debug () > 0)
776 printf ("\n<retrying...>\n");
780 /* flush any remaining input and verify that we are back
781 at the prompt level. */
783 /* start all over again. */
792 bug_srec_write_cr ("S7060000000000F9");
795 /* Having finished the load, we need to figure out whether we
798 while (gr_multi_scan (srecord_strings, 0) == 0);;
803 /* Copy LEN bytes of data from debugger memory at MYADDR
804 to inferior's memory at MEMADDR. Returns errno value.
805 * sb/sh instructions don't work on unaligned addresses, when TU=1.
808 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
809 at debugger address MYADDR. Returns errno value. */
811 bug_read_memory (memaddr, myaddr, len)
813 unsigned char *myaddr;
823 unsigned int checksum;
825 sprintf (request, "du 0 %x:&%d", memaddr, len);
826 sr_write_cr (request);
828 p = buffer = alloca (len);
830 /* scan up through the header */
831 sr_expect ("S0030000FC");
833 while (p < buffer + len)
835 /* scan off any white space. */
836 while (sr_readchar () != 'S');;
838 /* what kind of s-rec? */
839 type = sr_readchar ();
841 /* scan record size */
842 sr_get_hex_byte (&size);
855 sr_get_hex_byte (&c);
856 inaddr = (inaddr << 8) + c;
859 /* intentional fall through */
861 sr_get_hex_byte (&c);
862 inaddr = (inaddr << 8) + c;
865 /* intentional fall through */
867 sr_get_hex_byte (&c);
868 inaddr = (inaddr << 8) + c;
871 sr_get_hex_byte (&c);
872 inaddr = (inaddr << 8) + c;
879 error ("reading s-records.");
883 || (memaddr + len) < (inaddr + size))
884 error ("srec out of memory range.");
886 if (p != buffer + inaddr - memaddr)
887 error ("srec out of sequence.");
889 for (; size; --size, ++p)
895 sr_get_hex_byte (&c);
896 if (c != (~checksum & 0xff))
897 error ("bad s-rec checksum");
902 if (p != buffer + len)
905 memcpy (myaddr, buffer, len);
909 #define MAX_BREAKS 16
910 static int num_brkpts = 0;
912 bug_insert_breakpoint (addr, save)
914 char *save; /* Throw away, let bug save instructions */
918 if (num_brkpts < MAX_BREAKS)
923 sprintf (buffer, "br %x", addr);
924 sr_write_cr (buffer);
930 fprintf_filtered (gdb_stderr,
931 "Too many break points, break point not installed\n");
937 bug_remove_breakpoint (addr, save)
939 char *save; /* Throw away, let bug save instructions */
946 sprintf (buffer, "nobr %x", addr);
947 sr_write_cr (buffer);
954 /* Clear the bugs notion of what the break points are */
956 bug_clear_breakpoints ()
961 sr_write_cr ("nobr");
969 struct target_ops bug_ops;
974 bug_ops.to_shortname = "bug";
975 "Remote BUG monitor",
976 bug_ops.to_longname = "Use the mvme187 board running the BUG monitor connected by a serial line.";
977 bug_ops.to_doc = " ";
978 bug_ops.to_open = bug_open;
979 bug_ops.to_close = gr_close;
980 bug_ops.to_attach = 0;
981 bug_ops.to_post_attach = NULL;
982 bug_ops.to_require_attach = NULL;
983 bug_ops.to_detach = gr_detach;
984 bug_ops.to_require_detach = NULL;
985 bug_ops.to_resume = bug_resume;
986 bug_ops.to_wait = bug_wait;
987 bug_ops.to_post_wait = NULL;
988 bug_ops.to_fetch_registers = bug_fetch_register;
989 bug_ops.to_store_registers = bug_store_register;
990 bug_ops.to_prepare_to_store = gr_prepare_to_store;
991 bug_ops.to_xfer_memory = bug_xfer_memory;
992 bug_ops.to_files_info = gr_files_info;
993 bug_ops.to_insert_breakpoint = bug_insert_breakpoint;
994 bug_ops.to_remove_breakpoint = bug_remove_breakpoint;
995 bug_ops.to_terminal_init = 0;
996 bug_ops.to_terminal_inferior = 0;
997 bug_ops.to_terminal_ours_for_output = 0;
998 bug_ops.to_terminal_ours = 0;
999 bug_ops.to_terminal_info = 0;
1000 bug_ops.to_kill = gr_kill;
1001 bug_ops.to_load = bug_load;
1002 bug_ops.to_lookup_symbol = 0;
1003 bug_ops.to_create_inferior = gr_create_inferior;
1004 bug_ops.to_post_startup_inferior = NULL;
1005 bug_ops.to_acknowledge_created_inferior = NULL;
1006 bug_ops.to_clone_and_follow_inferior = NULL;
1007 bug_ops.to_post_follow_inferior_by_clone = NULL;
1008 bug_ops.to_insert_fork_catchpoint = NULL;
1009 bug_ops.to_remove_fork_catchpoint = NULL;
1010 bug_ops.to_insert_vfork_catchpoint = NULL;
1011 bug_ops.to_remove_vfork_catchpoint = NULL;
1012 bug_ops.to_has_forked = NULL;
1013 bug_ops.to_has_vforked = NULL;
1014 bug_ops.to_can_follow_vfork_prior_to_exec = NULL;
1015 bug_ops.to_post_follow_vfork = NULL;
1016 bug_ops.to_insert_exec_catchpoint = NULL;
1017 bug_ops.to_remove_exec_catchpoint = NULL;
1018 bug_ops.to_has_execd = NULL;
1019 bug_ops.to_reported_exec_events_per_exec_call = NULL;
1020 bug_ops.to_has_exited = NULL;
1021 bug_ops.to_mourn_inferior = gr_mourn;
1022 bug_ops.to_can_run = 0;
1023 bug_ops.to_notice_signals = 0;
1024 bug_ops.to_thread_alive = 0;
1025 bug_ops.to_stop = 0;
1026 bug_ops.to_pid_to_exec_file = NULL;
1027 bug_ops.to_core_file_to_sym_file = NULL;
1028 bug_ops.to_stratum = process_stratum;
1029 bug_ops.DONT_USE = 0;
1030 bug_ops.to_has_all_memory = 1;
1031 bug_ops.to_has_memory = 1;
1032 bug_ops.to_has_stack = 1;
1033 bug_ops.to_has_registers = 0;
1034 bug_ops.to_has_execution = 0;
1035 bug_ops.to_sections = 0;
1036 bug_ops.to_sections_end = 0;
1037 bug_ops.to_magic = OPS_MAGIC; /* Always the last thing */
1038 } /* init_bug_ops */
1041 _initialize_remote_bug ()
1044 add_target (&bug_ops);
1047 (add_set_cmd ("srec-bytes", class_support, var_uinteger,
1048 (char *) &srec_bytes,
1050 Set the number of bytes represented in each S-record.\n\
1051 This affects the communication protocol with the remote target.",
1056 (add_set_cmd ("srec-max-retries", class_support, var_uinteger,
1057 (char *) &srec_max_retries,
1059 Set the number of retries for shipping S-records.\n\
1060 This affects the communication protocol with the remote target.",
1065 /* This needs to set SREC_SIZE, not srec_frame which gets changed at the
1066 end of a download. But do we need the option at all? */
1068 (add_set_cmd ("srec-frame", class_support, var_uinteger,
1069 (char *) &srec_frame,
1071 Set the number of bytes in an S-record frame.\n\
1072 This affects the communication protocol with the remote target.",
1078 (add_set_cmd ("srec-noise", class_support, var_zinteger,
1079 (char *) &srec_noise,
1081 Set number of S-record to send before deliberately flubbing a checksum.\n\
1082 Zero means flub none at all. This affects the communication protocol\n\
1083 with the remote target.",
1088 (add_set_cmd ("srec-sleep", class_support, var_zinteger,
1089 (char *) &srec_sleep,
1091 Set number of seconds to sleep after an S-record for a possible error message to arrive.\n\
1092 This affects the communication protocol with the remote target.",
1097 (add_set_cmd ("srec-echo-pace", class_support, var_boolean,
1098 (char *) &srec_echo_pace,
1100 Set echo-verification.\n\
1101 When on, use verification by echo when downloading S-records. This is\n\
1102 much slower, but generally more reliable.",