1 /* Remote debugging interface for Tandem ST2000 phone switch, for GDB.
2 Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
3 Contributed by Cygnus Support. Written by Jim Kingdon 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 remote-eb.c, which did a similar job, but for
22 an AMD-29K running EBMON. That file was in turn derived from remote.c
23 as mentioned in the following comment (left in for comic relief):
25 "This is like remote.c but is for an esoteric situation--
26 having an a29k board in a PC hooked up to a unix machine with
27 a serial line, and running ctty com1 on the PC, through which
28 the unix machine can run ebmon. Not to mention that the PC
29 has PC/NFS, so it can access the same executables that gdb can,
30 over the net in real time."
32 In reality, this module talks to a debug monitor called 'STDEBUG', which
33 runs in a phone switch. We communicate with STDEBUG via either a direct
34 serial line, or a TCP (or possibly TELNET) stream to a terminal multiplexor,
35 which in turn talks to the phone switch. */
44 #include <sys/types.h>
47 extern struct target_ops st2000_ops; /* Forward declaration */
49 static void st2000_close();
50 static void st2000_fetch_register();
51 static void st2000_store_register();
53 #define LOG_FILE "st2000.log"
54 #if defined (LOG_FILE)
58 static int timeout = 24;
60 /* Descriptor for I/O to remote machine. Initialize it to -1 so that
61 st2000_open knows that we don't have a file open when the program
64 static serial_t st2000_desc;
66 /* Send data to stdebug. Works just like printf. */
69 printf_stdebug(va_alist)
78 pattern = va_arg(args, char *);
80 vsprintf(buf, pattern, args);
81 if (SERIAL_WRITE(st2000_desc, buf, strlen(buf)))
82 fprintf(stderr, "SERIAL_WRITE failed: %s\n", safe_strerror(errno));
85 /* Read a character from the remote system, doing all the fancy timeout
94 c = SERIAL_READCHAR(st2000_desc, timeout);
97 putc(c & 0x7f, log_file);
103 if (c == SERIAL_TIMEOUT)
106 return c; /* Polls shouldn't generate timeout errors */
108 error("Timeout reading from remote system.");
111 perror_with_name("remote-st2000");
114 /* Scan input from the remote system, until STRING is found. If DISCARD is
115 non-zero, then discard non-matching input, else print it out.
116 Let the user break out immediately. */
118 expect(string, discard)
128 c = readchar(timeout);
141 fwrite(string, 1, (p - 1) - string, stdout);
150 /* Keep discarding input until we see the STDEBUG prompt.
152 The convention for dealing with the prompt is that you
154 o *then* wait for the prompt.
156 Thus the last thing that a procedure does with the serial line
157 will be an expect_prompt(). Exception: st2000_resume does not
158 wait for the prompt, because the terminal is being handed over
159 to the inferior. However, the next thing which happens after that
160 is a st2000_wait which does wait for the prompt.
161 Note that this includes abnormal exit, e.g. error(). This is
162 necessary to prevent getting into states from which we can't
165 expect_prompt(discard)
168 #if defined (LOG_FILE)
169 /* This is a convenient place to do this. The idea is to do it often
170 enough that we never lose much data if we terminate abnormally. */
173 expect ("dbug> ", discard);
176 /* Get a hex digit from the remote system & return its value.
177 If ignore_space is nonzero, ignore spaces (not newline, tab, etc). */
179 get_hex_digit(ignore_space)
185 ch = readchar(timeout);
186 if (ch >= '0' && ch <= '9')
188 else if (ch >= 'A' && ch <= 'F')
189 return ch - 'A' + 10;
190 else if (ch >= 'a' && ch <= 'f')
191 return ch - 'a' + 10;
192 else if (ch == ' ' && ignore_space)
197 error("Invalid hex digit from remote system.");
202 /* Get a byte from stdebug and put it in *BYT. Accept any number
210 val = get_hex_digit (1) << 4;
211 val |= get_hex_digit (0);
215 /* Get N 32-bit words from remote, each preceded by a space,
216 and put them in registers starting at REGNO. */
218 get_hex_regs (n, regno)
225 for (i = 0; i < n; i++)
230 for (j = 0; j < 8; j++)
231 val = (val << 4) + get_hex_digit (j == 0);
232 supply_register (regno++, (char *) &val);
236 /* This is called not only when we first attach, but also when the
237 user types "run" after having attached. */
239 st2000_create_inferior (execfile, args, env)
247 error("Can't pass arguments to remote STDEBUG process");
249 if (execfile == 0 || exec_bfd == 0)
250 error("No exec file specified");
252 entry_pt = (int) bfd_get_start_address (exec_bfd);
254 #ifdef CREATE_INFERIOR_HOOK
255 CREATE_INFERIOR_HOOK (0); /* No process-ID */
258 /* The "process" (board) is already stopped awaiting our commands, and
259 the program is already downloaded. We just set its PC and go. */
261 clear_proceed_status ();
263 /* Tell wait_for_inferior that we've started a new process. */
264 init_wait_for_inferior ();
266 /* Set up the "saved terminal modes" of the inferior
267 based on what modes we are starting it with. */
268 target_terminal_init ();
270 /* Install inferior's terminal modes. */
271 target_terminal_inferior ();
273 /* insert_step_breakpoint (); FIXME, do we need this? */
274 proceed ((CORE_ADDR)entry_pt, -1, 0); /* Let 'er rip... */
277 /* Open a connection to a remote debugger.
278 NAME is the filename used for communication. */
280 static int baudrate = 9600;
281 static char dev_name[100];
284 st2000_open(args, from_tty)
291 target_preopen(from_tty);
293 n = sscanf(args, " %s %d %s", dev_name, &baudrate, junk);
296 error("Bad arguments. Usage: target st2000 <device> <speed>\n\
297 or target st2000 <host> <port>\n");
301 st2000_desc = SERIAL_OPEN(dev_name);
304 perror_with_name(dev_name);
306 SERIAL_SETBAUDRATE(st2000_desc, baudrate);
308 SERIAL_RAW(st2000_desc);
310 push_target(&st2000_ops);
312 #if defined (LOG_FILE)
313 log_file = fopen (LOG_FILE, "w");
314 if (log_file == NULL)
315 perror_with_name (LOG_FILE);
318 /* Hello? Are you there? */
319 printf_stdebug("\003"); /* ^C wakes up dbug */
324 printf("Remote %s connected to %s\n", target_shortname,
328 /* Close out all files and local state before this target loses control. */
331 st2000_close (quitting)
334 SERIAL_CLOSE(st2000_desc);
336 #if defined (LOG_FILE)
338 if (ferror(log_file))
339 fprintf(stderr, "Error writing log file.\n");
340 if (fclose(log_file) != 0)
341 fprintf(stderr, "Error closing log file.\n");
346 /* Terminate the open connection to the remote debugger.
347 Use this when you want to detach and do something else
350 st2000_detach (from_tty)
353 pop_target(); /* calls st2000_close to do the real work */
355 printf ("Ending remote %s debugging\n", target_shortname);
358 /* Tell the remote machine to resume. */
361 st2000_resume (step, sig)
366 printf_stdebug ("ST\r");
367 /* Wait for the echo. */
372 printf_stdebug ("GO\r");
373 /* Swallow the echo. */
378 /* Wait until the remote machine stops, then return,
379 storing status in STATUS just as `wait' would. */
385 int old_timeout = timeout;
387 WSETEXIT ((*status), 0);
389 timeout = 0; /* Don't time out -- user program is running. */
391 expect_prompt(0); /* Wait for prompt, outputting extraneous text */
393 WSETSTOP ((*status), SIGTRAP);
395 timeout = old_timeout;
400 /* Return the name of register number REGNO in the form input and output by
401 STDEBUG. Currently, REGISTER_NAMES just happens to contain exactly what
402 STDEBUG wants. Lets take advantage of that just as long as possible! */
414 for (p = reg_names[regno]; *p; p++)
421 /* Read the remote registers into the block REGS. */
424 st2000_fetch_registers ()
428 /* Yeah yeah, I know this is horribly inefficient. But it isn't done
429 very often... I'll clean it up later. */
431 for (regno = 0; regno <= PC_REGNUM; regno++)
432 st2000_fetch_register(regno);
435 /* Fetch register REGNO, or all registers if REGNO is -1.
436 Returns errno value. */
438 st2000_fetch_register (regno)
442 st2000_fetch_registers ();
445 char *name = get_reg_name (regno);
446 printf_stdebug ("DR %s\r", name);
449 get_hex_regs (1, regno);
455 /* Store the remote registers from the contents of the block REGS. */
458 st2000_store_registers ()
462 for (regno = 0; regno <= PC_REGNUM; regno++)
463 st2000_store_register(regno);
465 registers_changed ();
468 /* Store register REGNO, or all if REGNO == 0.
469 Return errno value. */
471 st2000_store_register (regno)
475 st2000_store_registers ();
478 printf_stdebug ("PR %s %x\r", get_reg_name (regno),
479 read_register (regno));
485 /* Get ready to modify the registers array. On machines which store
486 individual registers, this doesn't need to do anything. On machines
487 which store all the registers in one fell swoop, this makes sure
488 that registers contains all the registers from the program being
492 st2000_prepare_to_store ()
494 /* Do nothing, since we can store individual regs */
500 printf ("\tAttached to %s at %d baud.\n",
504 /* Copy LEN bytes of data from debugger memory at MYADDR
505 to inferior's memory at MEMADDR. Returns length moved. */
507 st2000_write_inferior_memory (memaddr, myaddr, len)
509 unsigned char *myaddr;
514 for (i = 0; i < len; i++)
516 printf_stdebug ("PM.B %x %x\r", memaddr + i, myaddr[i]);
522 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
523 at debugger address MYADDR. Returns length moved. */
525 st2000_read_inferior_memory(memaddr, myaddr, len)
532 /* Number of bytes read so far. */
535 /* Starting address of this pass. */
536 unsigned long startaddr;
538 /* Number of bytes to read in this pass. */
541 /* Note that this code works correctly if startaddr is just less
542 than UINT_MAX (well, really CORE_ADDR_MAX if there was such a
543 thing). That is, something like
544 st2000_read_bytes (CORE_ADDR_MAX - 4, foo, 4)
545 works--it never adds len to memaddr and gets 0. */
546 /* However, something like
547 st2000_read_bytes (CORE_ADDR_MAX - 3, foo, 4)
548 doesn't need to work. Detect it and give up if there's an attempt
550 if (((memaddr - 1) + len) < memaddr) {
560 if ((startaddr % 16) != 0)
561 len_this_pass -= startaddr % 16;
562 if (len_this_pass > (len - count))
563 len_this_pass = (len - count);
565 printf_stdebug ("DI.L %x %x\r", startaddr, len_this_pass);
568 for (i = 0; i < len_this_pass; i++)
569 get_hex_byte (&myaddr[count++]);
573 startaddr += len_this_pass;
578 /* FIXME-someday! Merge these two. */
580 st2000_xfer_inferior_memory (memaddr, myaddr, len, write, target)
585 struct target_ops *target; /* ignored */
588 return st2000_write_inferior_memory (memaddr, myaddr, len);
590 return st2000_read_inferior_memory (memaddr, myaddr, len);
594 st2000_kill (args, from_tty)
598 return; /* Ignore attempts to kill target system */
601 /* Clean up when a program exits.
603 The program actually lives on in the remote processor's RAM, and may be
604 run again without a download. Don't leave it full of breakpoint
608 st2000_mourn_inferior ()
610 remove_breakpoints ();
611 unpush_target (&st2000_ops);
612 generic_mourn_inferior (); /* Do all the proper things now */
615 #define MAX_STDEBUG_BREAKPOINTS 16
617 extern int memory_breakpoint_size;
618 static CORE_ADDR breakaddr[MAX_STDEBUG_BREAKPOINTS] = {0};
621 st2000_insert_breakpoint (addr, shadow)
627 for (i = 0; i <= MAX_STDEBUG_BREAKPOINTS; i++)
628 if (breakaddr[i] == 0)
632 st2000_read_inferior_memory(addr, shadow, memory_breakpoint_size);
633 printf_stdebug("BR %x H\r", addr);
638 fprintf(stderr, "Too many breakpoints (> 16) for STDBUG\n");
643 st2000_remove_breakpoint (addr, shadow)
649 for (i = 0; i < MAX_STDEBUG_BREAKPOINTS; i++)
650 if (breakaddr[i] == addr)
654 printf_stdebug("CB %d\r", i);
659 fprintf(stderr, "Can't find breakpoint associated with 0x%x\n", addr);
664 /* Put a command string, in args, out to STDBUG. Output from STDBUG is placed
665 on the users terminal until the prompt is seen. */
668 st2000_command (args, fromtty)
673 error("st2000 target not open.");
676 error("Missing command.");
678 printf_stdebug("%s\r", args);
682 /* Connect the user directly to STDBUG. This command acts just like the
683 'cu' or 'tip' command. Use <CR>~. or <CR>~^D to break out. */
685 /*static struct ttystate ttystate;*/
690 printf("\r\n[Exiting connect mode]\r\n");
691 /* SERIAL_RESTORE(0, &ttystate);*/
695 /* This all should now be in serial.c */
698 connect_command (args, fromtty)
710 error("st2000 target not open.");
713 fprintf("This command takes no args. They have been ignored.\n");
715 printf("[Entering connect mode. Use ~. or ~^D to escape]\n");
717 serial_raw(0, &ttystate);
719 make_cleanup(cleanup_tty, 0);
728 FD_SET(st2000_desc, &readfds);
729 numfds = select(sizeof(readfds)*8, &readfds, 0, 0, 0);
734 perror_with_name("select");
736 if (FD_ISSET(0, &readfds))
737 { /* tty input, send to stdebug */
740 perror_with_name("connect");
742 printf_stdebug("%c", c);
756 if (c == '.' || c == '\004')
763 if (FD_ISSET(st2000_desc, &readfds))
778 /* Define the target subroutine names */
780 struct target_ops st2000_ops = {
782 "Remote serial Tandem ST2000 target",
783 "Use a remote computer running STDEBUG connected by a serial line,\n\
784 or a network connection.\n\
785 Arguments are the name of the device for the serial line,\n\
786 the speed to connect at in bits per second.",
793 st2000_fetch_register,
794 st2000_store_register,
795 st2000_prepare_to_store,
796 st2000_xfer_inferior_memory,
798 st2000_insert_breakpoint,
799 st2000_remove_breakpoint, /* Breakpoints */
804 0, /* Terminal handling */
807 0, /* lookup_symbol */
808 st2000_create_inferior,
809 st2000_mourn_inferior,
811 0, /* notice_signals */
818 1, /* all mem, mem, stack, regs, exec */
820 0, /* Section pointers */
821 OPS_MAGIC, /* Always the last thing */
825 _initialize_remote_st2000 ()
827 add_target (&st2000_ops);
828 add_com ("st2000 <command>", class_obscure, st2000_command,
829 "Send a command to the STDBUG monitor.");
830 add_com ("connect", class_obscure, connect_command,
831 "Connect the terminal directly up to the STDBUG command monitor.\n\
832 Use <CR>~. or <CR>~^D to break out.");