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 (char *args, int fromtty)
122 dcache_invd (gr_get_dcache ());
124 abfd = bfd_openr (args, 0);
127 printf_filtered ("Unable to open file %s\n", args);
131 if (bfd_check_format (abfd, bfd_object) == 0)
133 printf_filtered ("File is not an object file\n");
138 while (s != (asection *) NULL)
140 srec_frame = SREC_SIZE;
141 if (s->flags & SEC_LOAD)
145 char *buffer = xmalloc (srec_frame);
147 printf_filtered ("%s\t: 0x%4x .. 0x%4x ", s->name, s->vma, s->vma + s->_raw_size);
148 gdb_flush (gdb_stdout);
149 for (i = 0; i < s->_raw_size; i += srec_frame)
151 if (srec_frame > s->_raw_size - i)
152 srec_frame = s->_raw_size - i;
154 bfd_get_section_contents (abfd, s, buffer, i, srec_frame);
155 bug_write_memory (s->vma + i, buffer, srec_frame);
156 printf_filtered ("*");
157 gdb_flush (gdb_stdout);
159 printf_filtered ("\n");
164 sprintf (buffer, "rs ip %lx", (unsigned long) abfd->start_address);
165 sr_write_cr (buffer);
185 while (*s && !isspace (*s))
191 copy = xmalloc (len + 1);
192 memcpy (copy, word, len);
199 static struct gr_settings bug_settings =
204 bug_clear_breakpoints, /* clear_all_breakpoints */
205 bug_read_memory, /* readfunc */
206 bug_write_memory, /* writefunc */
207 gr_generic_checkin, /* checkin */
210 static char *cpu_check_strings[] =
217 bug_open (char *args, int from_tty)
222 gr_open (args, from_tty, &bug_settings);
223 /* decide *now* whether we are on an 88100 or an 88110 */
224 sr_write_cr ("rs cr06");
225 sr_expect ("rs cr06");
227 switch (gr_multi_scan (cpu_check_strings, 0))
229 case 0: /* this is an m88100 */
230 target_is_m88110 = 0;
232 case 1: /* this is an m88110 */
233 target_is_m88110 = 1;
240 /* Tell the remote machine to resume. */
243 bug_resume (int pid, int step, enum target_signal sig)
245 dcache_invd (gr_get_dcache ());
251 /* Force the next bug_wait to return a trap. Not doing anything
252 about I/O from the target means that the user has to type
253 "continue" to see any. FIXME, this should be fixed. */
254 need_artificial_trap = 1;
262 /* Wait until the remote machine stops, then return,
263 storing status in STATUS just as `wait' would. */
265 static char *wait_strings[] =
268 "Exception: Data Access Fault (Local Bus Timeout)",
269 "\r8??\?-Bug>", /* The '\?' avoids creating a trigraph */
275 bug_wait (int pid, struct target_waitstatus *status)
277 int old_timeout = sr_get_timeout ();
278 int old_immediate_quit = immediate_quit;
280 status->kind = TARGET_WAITKIND_EXITED;
281 status->value.integer = 0;
283 /* read off leftovers from resume so that the rest can be passed
284 back out as stdout. */
285 if (need_artificial_trap == 0)
287 sr_expect ("Effective address: ");
288 (void) sr_get_hex_word ();
292 sr_set_timeout (-1); /* Don't time out -- user program is running. */
293 immediate_quit = 1; /* Helps ability to QUIT */
295 switch (gr_multi_scan (wait_strings, need_artificial_trap == 0))
297 case 0: /* breakpoint case */
298 status->kind = TARGET_WAITKIND_STOPPED;
299 status->value.sig = TARGET_SIGNAL_TRAP;
300 /* user output from the target can be discarded here. (?) */
304 case 1: /* bus error */
305 status->kind = TARGET_WAITKIND_STOPPED;
306 status->value.sig = TARGET_SIGNAL_BUS;
307 /* user output from the target can be discarded here. (?) */
311 case 2: /* normal case */
313 if (need_artificial_trap != 0)
316 status->kind = TARGET_WAITKIND_STOPPED;
317 status->value.sig = TARGET_SIGNAL_TRAP;
318 need_artificial_trap--;
324 status->kind = TARGET_WAITKIND_EXITED;
325 status->value.integer = 0;
329 case -1: /* trouble */
331 fprintf_filtered (gdb_stderr,
332 "Trouble reading target during wait\n");
336 sr_set_timeout (old_timeout);
337 immediate_quit = old_immediate_quit;
341 /* Return the name of register number REGNO
342 in the form input and output by bug.
344 Returns a pointer to a static buffer containing the answer. */
346 get_reg_name (int regno)
350 "r00", "r01", "r02", "r03", "r04", "r05", "r06", "r07",
351 "r08", "r09", "r10", "r11", "r12", "r13", "r14", "r15",
352 "r16", "r17", "r18", "r19", "r20", "r21", "r22", "r23",
353 "r24", "r25", "r26", "r27", "r28", "r29", "r30", "r31",
355 /* these get confusing because we omit a few and switch some ordering around. */
357 "cr01", /* 32 = psr */
358 "fcr62", /* 33 = fpsr */
359 "fcr63", /* 34 = fpcr */
360 "ip", /* this is something of a cheat. */
362 "cr05", /* 36 = snip */
363 "cr06", /* 37 = sfip */
365 "x00", "x01", "x02", "x03", "x04", "x05", "x06", "x07",
366 "x08", "x09", "x10", "x11", "x12", "x13", "x14", "x15",
367 "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
368 "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
374 #if 0 /* not currently used */
375 /* Read from remote while the input matches STRING. Return zero on
376 success, -1 on failure. */
389 printf ("\nNext character is '%c' - %d and s is \"%s\".\n", c, c, --s);
399 bug_srec_write_cr (char *s)
406 if (sr_get_debug () > 0)
410 SERIAL_WRITE (sr_get_desc (), p, 1);
411 while (sr_pollchar () != *p);
416 /* return(bug_scan (s) || bug_scan ("\n")); */
422 /* Store register REGNO, or all if REGNO == -1. */
425 bug_fetch_register (int regno)
433 for (i = 0; i < NUM_REGS; ++i)
434 bug_fetch_register (i);
436 else if (target_is_m88110 && regno == SFIP_REGNUM)
438 /* m88110 has no sfip. */
440 supply_register (regno, (char *) &l);
442 else if (regno < XFP_REGNUM)
444 char buffer[MAX_REGISTER_RAW_SIZE];
447 sr_write_cr (get_reg_name (regno));
449 store_unsigned_integer (buffer, REGISTER_RAW_SIZE (regno),
452 supply_register (regno, buffer);
456 /* Float register so we need to parse a strange data format. */
458 unsigned char fpreg_buf[10];
461 sr_write (get_reg_name (regno), strlen (get_reg_name (regno)));
464 sr_expect (get_reg_name (regno));
469 p = sr_get_hex_digit (1);
470 fpreg_buf[0] = p << 7;
474 p = sr_get_hex_digit (1);
475 fpreg_buf[0] += (p << 4);
476 fpreg_buf[0] += sr_get_hex_digit (1);
478 fpreg_buf[1] = sr_get_hex_digit (1) << 4;
482 fpreg_buf[1] += sr_get_hex_digit (1);
484 fpreg_buf[2] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
485 fpreg_buf[3] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
486 fpreg_buf[4] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
487 fpreg_buf[5] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
488 fpreg_buf[6] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
489 fpreg_buf[7] = (sr_get_hex_digit (1) << 4) + sr_get_hex_digit (1);
494 supply_register (regno, fpreg_buf);
500 /* Store register REGNO, or all if REGNO == -1. */
503 bug_store_register (int regno)
512 for (i = 0; i < NUM_REGS; ++i)
513 bug_store_register (i);
519 regname = get_reg_name (regno);
521 if (target_is_m88110 && regno == SFIP_REGNUM)
523 else if (regno < XFP_REGNUM)
524 sprintf (buffer, "rs %s %08x",
526 read_register (regno));
529 unsigned char *fpreg_buf =
530 (unsigned char *) ®isters[REGISTER_BYTE (regno)];
532 sprintf (buffer, "rs %s %1x_%02x%1x_%1x%02x%02x%02x%02x%02x%02x;d",
535 (fpreg_buf[0] >> 7) & 0xf,
538 (fpreg_buf[1] >> 8) & 0xf,
549 sr_write_cr (buffer);
556 /* Transfer LEN bytes between GDB address MYADDR and target address
557 MEMADDR. If WRITE is non-zero, transfer them to the target,
558 otherwise transfer them from the target. TARGET is unused.
560 Returns the number of bytes transferred. */
563 bug_xfer_memory (CORE_ADDR memaddr, char *myaddr, int len, int write,
564 struct target_ops *target)
569 return dcache_xfer_memory (gr_get_dcache (), memaddr, myaddr, len, write);
577 command = (srec_echo_pace ? "lo 0 ;x" : "lo 0");
579 sr_write_cr (command);
582 bug_srec_write_cr ("S0030000FC");
586 /* This is an extremely vulnerable and fragile function. I've made
587 considerable attempts to make this deterministic, but I've
588 certainly forgotten something. The trouble is that S-records are
589 only a partial file format, not a protocol. Worse, apparently the
590 m88k bug monitor does not run in real time while receiving
591 S-records. Hence, we must pay excruciating attention to when and
592 where error messages are returned, and what has actually been sent.
594 Each call represents a chunk of memory to be sent to the target.
595 We break that chunk into an S0 header record, some number of S3
596 data records each containing srec_bytes, and an S7 termination
599 static char *srecord_strings[] =
607 bug_write_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len)
613 char *buffer = alloca ((srec_bytes + 8) << 1);
621 if (retries > srec_max_retries)
626 if (sr_get_debug () > 0)
627 printf ("\n<retrying...>\n");
629 /* This gr_expect_prompt call is extremely important. Without
630 it, we will tend to resend our packet so fast that it
631 will arrive before the bug monitor is ready to receive
632 it. This would lead to a very ugly resend loop. */
648 if (thisgo > srec_bytes)
651 address = memaddr + done;
652 sprintf (buf, "S3%02X%08X", thisgo + 4 + 1, address);
655 checksum += (thisgo + 4 + 1
657 + ((address >> 8) & 0xff)
658 + ((address >> 16) & 0xff)
659 + ((address >> 24) & 0xff));
661 for (idx = 0; idx < thisgo; idx++)
663 sprintf (buf, "%02X", myaddr[idx + done]);
664 checksum += myaddr[idx + done];
670 /* FIXME-NOW: insert a deliberate error every now and then.
671 This is intended for testing/debugging the error handling
673 static int counter = 0;
674 if (++counter > srec_noise)
681 sprintf (buf, "%02X", ~checksum & 0xff);
682 bug_srec_write_cr (buffer);
687 /* This pollchar is probably redundant to the gr_multi_scan
688 below. Trouble is, we can't be sure when or where an
689 error message will appear. Apparently, when running at
690 full speed from a typical sun4, error messages tend to
691 appear to arrive only *after* the s7 record. */
693 if ((x = sr_pollchar ()) != 0)
695 if (sr_get_debug () > 0)
696 printf ("\n<retrying...>\n");
700 /* flush any remaining input and verify that we are back
701 at the prompt level. */
703 /* start all over again. */
712 bug_srec_write_cr ("S7060000000000F9");
715 /* Having finished the load, we need to figure out whether we
718 while (gr_multi_scan (srecord_strings, 0) == 0);;
723 /* Copy LEN bytes of data from debugger memory at MYADDR
724 to inferior's memory at MEMADDR. Returns errno value.
725 * sb/sh instructions don't work on unaligned addresses, when TU=1.
728 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
729 at debugger address MYADDR. Returns errno value. */
731 bug_read_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len)
740 unsigned int checksum;
742 sprintf (request, "du 0 %x:&%d", memaddr, len);
743 sr_write_cr (request);
745 p = buffer = alloca (len);
747 /* scan up through the header */
748 sr_expect ("S0030000FC");
750 while (p < buffer + len)
752 /* scan off any white space. */
753 while (sr_readchar () != 'S');;
755 /* what kind of s-rec? */
756 type = sr_readchar ();
758 /* scan record size */
759 sr_get_hex_byte (&size);
772 sr_get_hex_byte (&c);
773 inaddr = (inaddr << 8) + c;
776 /* intentional fall through */
778 sr_get_hex_byte (&c);
779 inaddr = (inaddr << 8) + c;
782 /* intentional fall through */
784 sr_get_hex_byte (&c);
785 inaddr = (inaddr << 8) + c;
788 sr_get_hex_byte (&c);
789 inaddr = (inaddr << 8) + c;
796 error ("reading s-records.");
800 || (memaddr + len) < (inaddr + size))
801 error ("srec out of memory range.");
803 if (p != buffer + inaddr - memaddr)
804 error ("srec out of sequence.");
806 for (; size; --size, ++p)
812 sr_get_hex_byte (&c);
813 if (c != (~checksum & 0xff))
814 error ("bad s-rec checksum");
819 if (p != buffer + len)
822 memcpy (myaddr, buffer, len);
826 #define MAX_BREAKS 16
827 static int num_brkpts = 0;
829 /* Insert a breakpoint at ADDR. SAVE is normally the address of the
830 pattern buffer where the instruction that the breakpoint overwrites
831 is saved. It is unused here since the bug is responsible for
832 saving/restoring the original instruction. */
835 bug_insert_breakpoint (CORE_ADDR addr, char *save)
839 if (num_brkpts < MAX_BREAKS)
844 sprintf (buffer, "br %x", addr);
845 sr_write_cr (buffer);
851 fprintf_filtered (gdb_stderr,
852 "Too many break points, break point not installed\n");
858 /* Remove a breakpoint at ADDR. SAVE is normally the previously
859 saved pattern, but is unused here since the bug is responsible
860 for saving/restoring instructions. */
863 bug_remove_breakpoint (CORE_ADDR addr, char *save)
870 sprintf (buffer, "nobr %x", addr);
871 sr_write_cr (buffer);
878 /* Clear the bugs notion of what the break points are */
880 bug_clear_breakpoints (void)
885 sr_write_cr ("nobr");
893 struct target_ops bug_ops;
898 bug_ops.to_shortname = "bug";
899 "Remote BUG monitor",
900 bug_ops.to_longname = "Use the mvme187 board running the BUG monitor connected by a serial line.";
901 bug_ops.to_doc = " ";
902 bug_ops.to_open = bug_open;
903 bug_ops.to_close = gr_close;
904 bug_ops.to_attach = 0;
905 bug_ops.to_post_attach = NULL;
906 bug_ops.to_require_attach = NULL;
907 bug_ops.to_detach = gr_detach;
908 bug_ops.to_require_detach = NULL;
909 bug_ops.to_resume = bug_resume;
910 bug_ops.to_wait = bug_wait;
911 bug_ops.to_post_wait = NULL;
912 bug_ops.to_fetch_registers = bug_fetch_register;
913 bug_ops.to_store_registers = bug_store_register;
914 bug_ops.to_prepare_to_store = gr_prepare_to_store;
915 bug_ops.to_xfer_memory = bug_xfer_memory;
916 bug_ops.to_files_info = gr_files_info;
917 bug_ops.to_insert_breakpoint = bug_insert_breakpoint;
918 bug_ops.to_remove_breakpoint = bug_remove_breakpoint;
919 bug_ops.to_terminal_init = 0;
920 bug_ops.to_terminal_inferior = 0;
921 bug_ops.to_terminal_ours_for_output = 0;
922 bug_ops.to_terminal_ours = 0;
923 bug_ops.to_terminal_info = 0;
924 bug_ops.to_kill = gr_kill;
925 bug_ops.to_load = bug_load;
926 bug_ops.to_lookup_symbol = 0;
927 bug_ops.to_create_inferior = gr_create_inferior;
928 bug_ops.to_post_startup_inferior = NULL;
929 bug_ops.to_acknowledge_created_inferior = NULL;
930 bug_ops.to_clone_and_follow_inferior = NULL;
931 bug_ops.to_post_follow_inferior_by_clone = NULL;
932 bug_ops.to_insert_fork_catchpoint = NULL;
933 bug_ops.to_remove_fork_catchpoint = NULL;
934 bug_ops.to_insert_vfork_catchpoint = NULL;
935 bug_ops.to_remove_vfork_catchpoint = NULL;
936 bug_ops.to_has_forked = NULL;
937 bug_ops.to_has_vforked = NULL;
938 bug_ops.to_can_follow_vfork_prior_to_exec = NULL;
939 bug_ops.to_post_follow_vfork = NULL;
940 bug_ops.to_insert_exec_catchpoint = NULL;
941 bug_ops.to_remove_exec_catchpoint = NULL;
942 bug_ops.to_has_execd = NULL;
943 bug_ops.to_reported_exec_events_per_exec_call = NULL;
944 bug_ops.to_has_exited = NULL;
945 bug_ops.to_mourn_inferior = gr_mourn;
946 bug_ops.to_can_run = 0;
947 bug_ops.to_notice_signals = 0;
948 bug_ops.to_thread_alive = 0;
950 bug_ops.to_pid_to_exec_file = NULL;
951 bug_ops.to_core_file_to_sym_file = NULL;
952 bug_ops.to_stratum = process_stratum;
953 bug_ops.DONT_USE = 0;
954 bug_ops.to_has_all_memory = 1;
955 bug_ops.to_has_memory = 1;
956 bug_ops.to_has_stack = 1;
957 bug_ops.to_has_registers = 0;
958 bug_ops.to_has_execution = 0;
959 bug_ops.to_sections = 0;
960 bug_ops.to_sections_end = 0;
961 bug_ops.to_magic = OPS_MAGIC; /* Always the last thing */
965 _initialize_remote_bug (void)
968 add_target (&bug_ops);
971 (add_set_cmd ("srec-bytes", class_support, var_uinteger,
972 (char *) &srec_bytes,
974 Set the number of bytes represented in each S-record.\n\
975 This affects the communication protocol with the remote target.",
980 (add_set_cmd ("srec-max-retries", class_support, var_uinteger,
981 (char *) &srec_max_retries,
983 Set the number of retries for shipping S-records.\n\
984 This affects the communication protocol with the remote target.",
989 /* This needs to set SREC_SIZE, not srec_frame which gets changed at the
990 end of a download. But do we need the option at all? */
992 (add_set_cmd ("srec-frame", class_support, var_uinteger,
993 (char *) &srec_frame,
995 Set the number of bytes in an S-record frame.\n\
996 This affects the communication protocol with the remote target.",
1002 (add_set_cmd ("srec-noise", class_support, var_zinteger,
1003 (char *) &srec_noise,
1005 Set number of S-record to send before deliberately flubbing a checksum.\n\
1006 Zero means flub none at all. This affects the communication protocol\n\
1007 with the remote target.",
1012 (add_set_cmd ("srec-sleep", class_support, var_zinteger,
1013 (char *) &srec_sleep,
1015 Set number of seconds to sleep after an S-record for a possible error message to arrive.\n\
1016 This affects the communication protocol with the remote target.",
1021 (add_set_cmd ("srec-echo-pace", class_support, var_boolean,
1022 (char *) &srec_echo_pace,
1024 Set echo-verification.\n\
1025 When on, use verification by echo when downloading S-records. This is\n\
1026 much slower, but generally more reliable.",