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., 675 Mass Ave, Cambridge, MA 02139, USA. */
38 #include "remote-utils.h"
42 /* External data declarations */
43 extern int stop_soon_quietly; /* for wait_for_inferior */
45 /* Forward data declarations */
46 extern struct target_ops bug_ops; /* Forward declaration */
48 /* Forward function declarations */
49 static int bug_clear_breakpoints PARAMS((void));
51 static int bug_read_memory PARAMS((CORE_ADDR memaddr,
52 unsigned char *myaddr,
55 static int bug_write_memory PARAMS((CORE_ADDR memaddr,
56 unsigned char *myaddr,
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. */
69 static int srec_frame = 160;
71 /* This variable determines how many bytes will be represented in each
74 static int srec_bytes = 40;
76 /* At one point it appeared to me as though the bug monitor could not
77 really be expected to receive two sequential characters at 9600
78 baud reliably. Echo-pacing is an attempt to force data across the
79 line even in this condition. Specifically, in echo-pace mode, each
80 character is sent one at a time and we look for the echo before
81 sending the next. This is excruciatingly slow. */
83 static int srec_echo_pace = 0;
85 /* How long to wait after an srec for a possible error message.
86 Similar to the above, I tried sleeping after sending each S3 record
87 in hopes that I might actually see error messages from the bug
88 monitor. This might actually work if we were to use sleep
89 intervals smaller than 1 second. */
91 static int srec_sleep = 0;
93 /* Every srec_noise records, flub the checksum. This is a debugging
94 feature. Set the variable to something other than 1 in order to
95 inject *deliberate* checksum errors. One might do this if one
96 wanted to test error handling and recovery. */
98 static int srec_noise = 0;
100 /* Called when SIGALRM signal sent due to alarm() timeout. */
102 /* Number of SIGTRAPs we need to simulate. That is, the next
103 NEED_ARTIFICIAL_TRAP calls to bug_wait should just return
104 SIGTRAP without actually waiting for anything. */
106 static int need_artificial_trap = 0;
109 * Download a file specified in 'args', to the bug.
113 bug_load (args, fromtty)
123 dcache_flush (gr_get_dcache());
125 abfd = bfd_openr (args, 0);
128 printf_filtered ("Unable to open file %s\n", args);
132 if (bfd_check_format (abfd, bfd_object) == 0)
134 printf_filtered ("File is not an object file\n");
139 while (s != (asection *) NULL)
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);
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 ("*");
159 printf_filtered ("\n");
164 sprintf (buffer, "rs ip %lx", (unsigned long) abfd->start_address);
165 sr_write_cr (buffer);
186 while (*s && !isspace (*s))
192 copy = xmalloc (len + 1);
193 memcpy (copy, word, len);
200 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[] = {
216 bug_open (args, from_tty)
223 gr_open(args, from_tty, &bug_settings);
224 /* decide *now* whether we are on an 88100 or an 88110 */
225 sr_write_cr("rs cr06");
226 sr_expect("rs cr06");
228 switch (gr_multi_scan(cpu_check_strings, 0))
230 case 0: /* this is an m88100 */
231 target_is_m88110 = 0;
233 case 1: /* this is an m88110 */
234 target_is_m88110 = 1;
241 /* Tell the remote machine to resume. */
244 bug_resume (pid, step, sig)
247 dcache_flush (gr_get_dcache());
253 /* Force the next bug_wait to return a trap. Not doing anything
254 about I/O from the target means that the user has to type
255 "continue" to see any. FIXME, this should be fixed. */
256 need_artificial_trap = 1;
264 /* Wait until the remote machine stops, then return,
265 storing status in STATUS just as `wait' would. */
267 static char *wait_strings[] = {
269 "Exception: Data Access Fault (Local Bus Timeout)",
276 bug_wait (pid, status)
280 int old_timeout = sr_get_timeout();
281 int old_immediate_quit = immediate_quit;
283 WSETEXIT ((*status), 0);
285 /* read off leftovers from resume so that the rest can be passed
286 back out as stdout. */
287 if (need_artificial_trap == 0)
289 sr_expect("Effective address: ");
290 (void) sr_get_hex_word();
294 sr_set_timeout(-1); /* Don't time out -- user program is running. */
295 immediate_quit = 1; /* Helps ability to QUIT */
297 switch (gr_multi_scan(wait_strings, need_artificial_trap == 0))
299 case 0: /* breakpoint case */
300 WSETSTOP ((*status), SIGTRAP);
301 /* user output from the target can be discarded here. (?) */
305 case 1: /* bus error */
306 WSETSTOP ((*status), SIGBUS);
307 /* user output from the target can be discarded here. (?) */
311 case 2: /* normal case */
313 if (need_artificial_trap != 0)
316 WSETSTOP ((*status), SIGTRAP);
317 need_artificial_trap--;
323 WSETEXIT ((*status), 0);
327 case -1: /* trouble */
329 fprintf_filtered (stderr,
330 "Trouble reading target during wait\n");
334 sr_set_timeout(old_timeout);
335 immediate_quit = old_immediate_quit;
339 /* Return the name of register number REGNO
340 in the form input and output by bug.
342 Returns a pointer to a static buffer containing the answer. */
347 static char *rn[] = {
348 "r00", "r01", "r02", "r03", "r04", "r05", "r06", "r07",
349 "r08", "r09", "r10", "r11", "r12", "r13", "r14", "r15",
350 "r16", "r17", "r18", "r19", "r20", "r21", "r22", "r23",
351 "r24", "r25", "r26", "r27", "r28", "r29", "r30", "r31",
353 /* these get confusing because we omit a few and switch some ordering around. */
355 "cr01", /* 32 = psr */
356 "fcr62", /* 33 = fpsr*/
357 "fcr63", /* 34 = fpcr */
358 "ip", /* this is something of a cheat. */
360 "cr05", /* 36 = snip */
361 "cr06", /* 37 = sfip */
363 "x00", "x01", "x02", "x03", "x04", "x05", "x06", "x07",
364 "x08", "x09", "x10", "x11", "x12", "x13", "x14", "x15",
365 "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
366 "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
372 #if 0 /* not currently used */
373 /* Read from remote while the input matches STRING. Return zero on
374 success, -1 on failure. */
388 printf("\nNext character is '%c' - %d and s is \"%s\".\n", c, c, --s);
398 bug_srec_write_cr (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(regno)
434 for (i = 0; i < NUM_REGS; ++i)
435 bug_fetch_register(i);
437 else if (target_is_m88110 && regno == SFIP_REGNUM)
439 /* m88110 has no sfip. */
441 supply_register(regno, (char *) &l);
443 else if (regno < XFP_REGNUM)
445 char buffer[MAX_REGISTER_RAW_SIZE];
448 sr_write_cr (get_reg_name(regno));
450 store_unsigned_integer (buffer, REGISTER_RAW_SIZE (regno),
453 supply_register (regno, buffer);
457 /* Float register so we need to parse a strange data format. */
459 unsigned char value[10];
462 sr_write(get_reg_name(regno), strlen(get_reg_name(regno)));
465 sr_expect(get_reg_name(regno));
470 p = sr_get_hex_digit(1);
475 p = sr_get_hex_digit(1);
476 value[0] += (p << 4);
477 value[0] += sr_get_hex_digit(1);
479 value[1] = sr_get_hex_digit(1) << 4;
483 value[1] += sr_get_hex_digit(1);
485 value[2] = (sr_get_hex_digit(1) << 4) + sr_get_hex_digit(1);
486 value[3] = (sr_get_hex_digit(1) << 4) + sr_get_hex_digit(1);
487 value[4] = (sr_get_hex_digit(1) << 4) + sr_get_hex_digit(1);
488 value[5] = (sr_get_hex_digit(1) << 4) + sr_get_hex_digit(1);
489 value[6] = (sr_get_hex_digit(1) << 4) + sr_get_hex_digit(1);
490 value[7] = (sr_get_hex_digit(1) << 4) + sr_get_hex_digit(1);
495 supply_register(regno, value);
501 /* Store register REGNO, or all if REGNO == -1. */
504 bug_store_register (regno)
514 for (i = 0; i < NUM_REGS; ++i)
515 bug_store_register(i);
521 regname = get_reg_name(regno);
523 if (target_is_m88110 && regno == SFIP_REGNUM)
525 else if (regno < XFP_REGNUM)
526 sprintf(buffer, "rs %s %08x",
528 read_register(regno));
531 unsigned char *value = ®isters[REGISTER_BYTE(regno)];
533 sprintf(buffer, "rs %s %1x_%02x%1x_%1x%02x%02x%02x%02x%02x%02x;d",
536 (value[0] >> 7) & 0xf,
539 (value[1] >> 8) & 0xf,
558 bug_xfer_memory (memaddr, myaddr, len, write, target)
563 struct target_ops *target; /* ignored */
567 /* Round starting address down to longword boundary. */
568 register CORE_ADDR addr;
570 /* Round ending address up; get number of longwords that makes. */
573 /* Allocate buffer of that many longwords. */
574 register int *buffer;
576 addr = memaddr & -sizeof (int);
577 count = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
579 buffer = (int *) alloca (count * sizeof (int));
583 /* Fill start and end extra bytes of buffer with existing memory data. */
585 if (addr != memaddr || len < (int) sizeof (int))
587 /* Need part of initial word -- fetch it. */
588 buffer[0] = gr_fetch_word (addr);
591 if (count > 1) /* FIXME, avoid if even boundary */
594 = gr_fetch_word (addr + (count - 1) * sizeof (int));
597 /* Copy data to be written over corresponding part of buffer */
599 memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
601 /* Write the entire buffer. */
603 for (i = 0; i < count; i++, addr += sizeof (int))
606 gr_store_word (addr, buffer[i]);
617 /* Read all the longwords */
618 for (i = 0; i < count; i++, addr += sizeof (int))
621 buffer[i] = gr_fetch_word (addr);
629 /* Copy appropriate bytes out of the buffer. */
630 memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
641 command = (srec_echo_pace ? "lo 0 ;x" : "lo 0");
643 sr_write_cr (command);
646 bug_srec_write_cr ("S0030000FC");
650 /* This is an extremely vulnerable and fragile function. I've made
651 considerable attempts to make this deterministic, but I've
652 certainly forgotten something. The trouble is that S-records are
653 only a partial file format, not a protocol. Worse, apparently the
654 m88k bug monitor does not run in real time while receiving
655 S-records. Hence, we must pay excruciating attention to when and
656 where error messages are returned, and what has actually been sent.
658 Each call represents a chunk of memory to be sent to the target.
659 We break that chunk into an S0 header record, some number of S3
660 data records each containing srec_bytes, and an S7 termination
663 static char *srecord_strings[] = {
670 bug_write_memory (memaddr, myaddr, len)
672 unsigned char *myaddr;
679 char buffer[(srec_bytes + 8) << 1];
687 if (retries > srec_max_retries)
692 if (sr_get_debug() > 0)
693 printf("\n<retrying...>\n");
695 /* This gr_expect_prompt call is extremely important. Without
696 it, we will tend to resend our packet so fast that it
697 will arrive before the bug monitor is ready to receive
698 it. This would lead to a very ugly resend loop. */
714 if (thisgo > srec_bytes)
717 address = memaddr + done;
718 sprintf (buf, "S3%02X%08X", thisgo + 4 + 1, address);
721 checksum += (thisgo + 4 + 1
723 + ((address >> 8) & 0xff)
724 + ((address >> 16) & 0xff)
725 + ((address >> 24) & 0xff));
727 for (idx = 0; idx < thisgo; idx++)
729 sprintf (buf, "%02X", myaddr[idx + done]);
730 checksum += myaddr[idx + done];
736 /* FIXME-NOW: insert a deliberate error every now and then.
737 This is intended for testing/debugging the error handling
739 static int counter = 0;
740 if (++counter > srec_noise)
747 sprintf(buf, "%02X", ~checksum & 0xff);
748 bug_srec_write_cr (buffer);
753 /* This pollchar is probably redundant to the gr_multi_scan
754 below. Trouble is, we can't be sure when or where an
755 error message will appear. Apparently, when running at
756 full speed from a typical sun4, error messages tend to
757 appear to arrive only *after* the s7 record. */
759 if ((x = sr_pollchar()) != 0)
761 if (sr_get_debug() > 0)
762 printf("\n<retrying...>\n");
766 /* flush any remaining input and verify that we are back
767 at the prompt level. */
769 /* start all over again. */
778 bug_srec_write_cr("S7060000000000F9");
781 /* Having finished the load, we need to figure out whether we
783 } while (gr_multi_scan(srecord_strings, 0) == 0);;
788 /* Copy LEN bytes of data from debugger memory at MYADDR
789 to inferior's memory at MEMADDR. Returns errno value.
790 * sb/sh instructions don't work on unaligned addresses, when TU=1.
793 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
794 at debugger address MYADDR. Returns errno value. */
796 bug_read_memory (memaddr, myaddr, len)
798 unsigned char *myaddr;
808 unsigned int checksum;
810 sprintf(request, "du 0 %x:&%d", memaddr, len);
811 sr_write_cr(request);
813 p = buffer = alloca(len);
815 /* scan up through the header */
816 sr_expect("S0030000FC");
818 while (p < buffer + len)
820 /* scan off any white space. */
821 while (sr_readchar() != 'S') ;;
823 /* what kind of s-rec? */
824 type = sr_readchar();
826 /* scan record size */
827 sr_get_hex_byte(&size);
841 inaddr = (inaddr << 8) + c;
844 /* intentional fall through */
847 inaddr = (inaddr << 8) + c;
850 /* intentional fall through */
853 inaddr = (inaddr << 8) + c;
857 inaddr = (inaddr << 8) + c;
864 error("reading s-records.");
868 || (memaddr + len) < (inaddr + size))
869 error("srec out of memory range.");
871 if (p != buffer + inaddr - memaddr)
872 error("srec out of sequence.");
874 for (; size; --size, ++p)
881 if (c != (~checksum & 0xff))
882 error("bad s-rec checksum");
887 if (p != buffer + len)
890 memcpy(myaddr, buffer, len);
894 #define MAX_BREAKS 16
895 static int num_brkpts = 0;
897 bug_insert_breakpoint (addr, save)
899 char *save; /* Throw away, let bug save instructions */
903 if (num_brkpts < MAX_BREAKS)
908 sprintf (buffer, "br %x", addr);
909 sr_write_cr (buffer);
915 fprintf_filtered (stderr,
916 "Too many break points, break point not installed\n");
922 bug_remove_breakpoint (addr, save)
924 char *save; /* Throw away, let bug save instructions */
931 sprintf (buffer, "nobr %x", addr);
932 sr_write_cr (buffer);
939 /* Clear the bugs notion of what the break points are */
941 bug_clear_breakpoints ()
946 sr_write_cr ("nobr");
954 struct target_ops bug_ops =
956 "bug", "Remote BUG monitor",
957 "Use the mvme187 board running the BUG monitor connected\n\
961 0, gr_detach, bug_resume, bug_wait, /* attach */
962 bug_fetch_register, bug_store_register,
966 bug_insert_breakpoint, bug_remove_breakpoint, /* Breakpoints */
967 0, 0, 0, 0, 0, /* Terminal handling */
968 gr_kill, /* FIXME, kill */
970 0, /* lookup_symbol */
971 gr_create_inferior, /* create_inferior */
972 gr_mourn, /* mourn_inferior FIXME */
974 0, /* notice_signals */
975 process_stratum, 0, /* next */
976 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
977 0, 0, /* Section pointers */
978 OPS_MAGIC, /* Always the last thing */
982 _initialize_remote_bug ()
984 add_target (&bug_ops);
987 (add_set_cmd ("srec-bytes", class_support, var_uinteger,
988 (char *) &srec_bytes,
990 Set the number of bytes represented in each S-record.\n\
991 This affects the communication protocol with the remote target.",
996 (add_set_cmd ("srec-max-retries", class_support, var_uinteger,
997 (char *) &srec_max_retries,
999 Set the number of retries for shipping S-records.\n\
1000 This affects the communication protocol with the remote target.",
1005 (add_set_cmd ("srec-frame", class_support, var_uinteger,
1006 (char *) &srec_frame,
1008 Set the number of bytes in an S-record frame.\n\
1009 This affects the communication protocol with the remote target.",
1014 (add_set_cmd ("srec-noise", class_support, var_zinteger,
1015 (char *) &srec_noise,
1017 Set number of S-record to send before deliberately flubbing a checksum.\n\
1018 Zero means flub none at all. This affects the communication protocol\n\
1019 with the remote target.",
1024 (add_set_cmd ("srec-sleep", class_support, var_zinteger,
1025 (char *) &srec_sleep,
1027 Set number of seconds to sleep after an S-record for a possible error message to arrive.\n\
1028 This affects the communication protocol with the remote target.",
1033 (add_set_cmd ("srec-echo-pace", class_support, var_boolean,
1034 (char *) &srec_echo_pace,
1036 Set echo-verification.\n\
1037 When on, use verification by echo when downloading S-records. This is\n\
1038 much slower, but generally more reliable.",