1 /* Remote debugging interface for Tandem ST2000 phone switch, for GDB.
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000,
4 2001, 2002 Free Software Foundation, Inc.
6 Contributed by Cygnus Support. Written by Jim Kingdon for Cygnus.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
25 /* This file was derived from remote-eb.c, which did a similar job, but for
26 an AMD-29K running EBMON. That file was in turn derived from remote.c
27 as mentioned in the following comment (left in for comic relief):
29 "This is like remote.c but is for an esoteric situation--
30 having an a29k board in a PC hooked up to a unix machine with
31 a serial line, and running ctty com1 on the PC, through which
32 the unix machine can run ebmon. Not to mention that the PC
33 has PC/NFS, so it can access the same executables that gdb can,
34 over the net in real time."
36 In reality, this module talks to a debug monitor called 'STDEBUG', which
37 runs in a phone switch. We communicate with STDEBUG via either a direct
38 serial line, or a TCP (or possibly TELNET) stream to a terminal multiplexor,
39 which in turn talks to the phone switch. */
44 #include "gdb_string.h"
45 #include <sys/types.h>
49 extern struct target_ops st2000_ops; /* Forward declaration */
51 static void st2000_close ();
52 static void st2000_fetch_register ();
53 static void st2000_store_register ();
55 #define LOG_FILE "st2000.log"
56 #if defined (LOG_FILE)
60 static int timeout = 24;
62 /* Descriptor for I/O to remote machine. Initialize it to -1 so that
63 st2000_open knows that we don't have a file open when the program
66 static struct serial *st2000_desc;
68 /* Send data to stdebug. Works just like printf. */
71 printf_stdebug (char *pattern,...)
76 va_start (args, pattern);
78 vsprintf (buf, pattern, args);
81 if (serial_write (st2000_desc, buf, strlen (buf)))
82 fprintf_unfiltered (gdb_stderr, "serial_write failed: %s\n",
83 safe_strerror (errno));
86 /* Read a character from the remote system, doing all the fancy timeout
90 readchar (int 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 (char *string, int discard)
126 c = readchar (timeout);
139 fwrite (string, 1, (p - 1) - string, stdout);
148 /* Keep discarding input until we see the STDEBUG prompt.
150 The convention for dealing with the prompt is that you
152 o *then* wait for the prompt.
154 Thus the last thing that a procedure does with the serial line
155 will be an expect_prompt(). Exception: st2000_resume does not
156 wait for the prompt, because the terminal is being handed over
157 to the inferior. However, the next thing which happens after that
158 is a st2000_wait which does wait for the prompt.
159 Note that this includes abnormal exit, e.g. error(). This is
160 necessary to prevent getting into states from which we can't
163 expect_prompt (int discard)
165 #if defined (LOG_FILE)
166 /* This is a convenient place to do this. The idea is to do it often
167 enough that we never lose much data if we terminate abnormally. */
170 expect ("dbug> ", discard);
173 /* Get a hex digit from the remote system & return its value.
174 If ignore_space is nonzero, ignore spaces (not newline, tab, etc). */
176 get_hex_digit (int ignore_space)
181 ch = readchar (timeout);
182 if (ch >= '0' && ch <= '9')
184 else if (ch >= 'A' && ch <= 'F')
185 return ch - 'A' + 10;
186 else if (ch >= 'a' && ch <= 'f')
187 return ch - 'a' + 10;
188 else if (ch == ' ' && ignore_space)
193 error ("Invalid hex digit from remote system.");
198 /* Get a byte from stdebug and put it in *BYT. Accept any number
201 get_hex_byte (char *byt)
205 val = get_hex_digit (1) << 4;
206 val |= get_hex_digit (0);
210 /* Get N 32-bit words from remote, each preceded by a space,
211 and put them in registers starting at REGNO. */
213 get_hex_regs (int n, int regno)
218 for (i = 0; i < n; i++)
223 for (j = 0; j < 8; j++)
224 val = (val << 4) + get_hex_digit (j == 0);
225 regcache_raw_supply (current_regcache, regno++, (char *) &val);
229 /* This is called not only when we first attach, but also when the
230 user types "run" after having attached. */
232 st2000_create_inferior (char *execfile, char *args, char **env,
238 error ("Can't pass arguments to remote STDEBUG process");
240 if (execfile == 0 || exec_bfd == 0)
241 error ("No executable file specified");
243 entry_pt = (int) bfd_get_start_address (exec_bfd);
245 /* The "process" (board) is already stopped awaiting our commands, and
246 the program is already downloaded. We just set its PC and go. */
248 clear_proceed_status ();
250 /* Tell wait_for_inferior that we've started a new process. */
251 init_wait_for_inferior ();
253 /* Set up the "saved terminal modes" of the inferior
254 based on what modes we are starting it with. */
255 target_terminal_init ();
257 /* Install inferior's terminal modes. */
258 target_terminal_inferior ();
260 /* insert_step_breakpoint (); FIXME, do we need this? */
262 proceed ((CORE_ADDR) entry_pt, TARGET_SIGNAL_DEFAULT, 0);
265 /* Open a connection to a remote debugger.
266 NAME is the filename used for communication. */
268 static int baudrate = 9600;
269 static char dev_name[100];
272 st2000_open (char *args, int from_tty)
277 target_preopen (from_tty);
279 n = sscanf (args, " %s %d %s", dev_name, &baudrate, junk);
282 error ("Bad arguments. Usage: target st2000 <device> <speed>\n\
283 or target st2000 <host> <port>\n");
287 st2000_desc = serial_open (dev_name);
290 perror_with_name (dev_name);
292 if (serial_setbaudrate (st2000_desc, baudrate))
294 serial_close (dev_name);
295 perror_with_name (dev_name);
298 serial_raw (st2000_desc);
300 push_target (&st2000_ops);
302 #if defined (LOG_FILE)
303 log_file = fopen (LOG_FILE, "w");
304 if (log_file == NULL)
305 perror_with_name (LOG_FILE);
308 /* Hello? Are you there? */
309 printf_stdebug ("\003"); /* ^C wakes up dbug */
314 printf ("Remote %s connected to %s\n", target_shortname,
318 /* Close out all files and local state before this target loses control. */
321 st2000_close (int quitting)
323 serial_close (st2000_desc);
325 #if defined (LOG_FILE)
328 if (ferror (log_file))
329 fprintf_unfiltered (gdb_stderr, "Error writing log file.\n");
330 if (fclose (log_file) != 0)
331 fprintf_unfiltered (gdb_stderr, "Error closing log file.\n");
336 /* Terminate the open connection to the remote debugger.
337 Use this when you want to detach and do something else
340 st2000_detach (int from_tty)
342 pop_target (); /* calls st2000_close to do the real work */
344 printf ("Ending remote %s debugging\n", target_shortname);
347 /* Tell the remote machine to resume. */
350 st2000_resume (ptid_t ptid, int step, enum target_signal sig)
354 printf_stdebug ("ST\r");
355 /* Wait for the echo. */
360 printf_stdebug ("GO\r");
361 /* Swallow the echo. */
366 /* Wait until the remote machine stops, then return,
367 storing status in STATUS just as `wait' would. */
370 st2000_wait (ptid_t ptid, struct target_waitstatus *status)
372 int old_timeout = timeout;
374 status->kind = TARGET_WAITKIND_EXITED;
375 status->value.integer = 0;
377 timeout = 0; /* Don't time out -- user program is running. */
379 expect_prompt (0); /* Wait for prompt, outputting extraneous text */
381 status->kind = TARGET_WAITKIND_STOPPED;
382 status->value.sig = TARGET_SIGNAL_TRAP;
384 timeout = old_timeout;
386 return inferior_ptid;
389 /* Return the name of register number REGNO in the form input and
390 output by STDEBUG. Currently, REGISTER_NAME just happens return
391 exactly what STDEBUG wants. Lets take advantage of that just as
395 get_reg_name (int regno)
403 for (p = REGISTER_NAME (regno); *p; p++)
410 /* Read the remote registers into the block REGS. */
413 st2000_fetch_registers (void)
417 /* Yeah yeah, I know this is horribly inefficient. But it isn't done
418 very often... I'll clean it up later. */
420 for (regno = 0; regno <= PC_REGNUM; regno++)
421 st2000_fetch_register (regno);
424 /* Fetch register REGNO, or all registers if REGNO is -1.
425 Returns errno value. */
427 st2000_fetch_register (int regno)
430 st2000_fetch_registers ();
433 char *name = get_reg_name (regno);
434 printf_stdebug ("DR %s\r", name);
437 get_hex_regs (1, regno);
443 /* Store the remote registers from the contents of the block REGS. */
446 st2000_store_registers (void)
450 for (regno = 0; regno <= PC_REGNUM; regno++)
451 st2000_store_register (regno);
453 registers_changed ();
456 /* Store register REGNO, or all if REGNO == 0.
457 Return errno value. */
459 st2000_store_register (int regno)
462 st2000_store_registers ();
465 printf_stdebug ("PR %s %x\r", get_reg_name (regno),
466 read_register (regno));
472 /* Get ready to modify the registers array. On machines which store
473 individual registers, this doesn't need to do anything. On machines
474 which store all the registers in one fell swoop, this makes sure
475 that registers contains all the registers from the program being
479 st2000_prepare_to_store (void)
481 /* Do nothing, since we can store individual regs */
485 st2000_files_info (void)
487 printf ("\tAttached to %s at %d baud.\n",
491 /* Copy LEN bytes of data from debugger memory at MYADDR
492 to inferior's memory at MEMADDR. Returns length moved. */
494 st2000_write_inferior_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len)
498 for (i = 0; i < len; i++)
500 printf_stdebug ("PM.B %x %x\r", memaddr + i, myaddr[i]);
506 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
507 at debugger address MYADDR. Returns length moved. */
509 st2000_read_inferior_memory (CORE_ADDR memaddr, char *myaddr, int len)
513 /* Number of bytes read so far. */
516 /* Starting address of this pass. */
517 unsigned long startaddr;
519 /* Number of bytes to read in this pass. */
522 /* Note that this code works correctly if startaddr is just less
523 than UINT_MAX (well, really CORE_ADDR_MAX if there was such a
524 thing). That is, something like
525 st2000_read_bytes (CORE_ADDR_MAX - 4, foo, 4)
526 works--it never adds len to memaddr and gets 0. */
527 /* However, something like
528 st2000_read_bytes (CORE_ADDR_MAX - 3, foo, 4)
529 doesn't need to work. Detect it and give up if there's an attempt
531 if (((memaddr - 1) + len) < memaddr)
542 if ((startaddr % 16) != 0)
543 len_this_pass -= startaddr % 16;
544 if (len_this_pass > (len - count))
545 len_this_pass = (len - count);
547 printf_stdebug ("DI.L %x %x\r", startaddr, len_this_pass);
550 for (i = 0; i < len_this_pass; i++)
551 get_hex_byte (&myaddr[count++]);
555 startaddr += len_this_pass;
560 /* Transfer LEN bytes between GDB address MYADDR and target address
561 MEMADDR. If WRITE is non-zero, transfer them to the target,
562 otherwise transfer them from the target. TARGET is unused.
564 Returns the number of bytes transferred. */
567 st2000_xfer_inferior_memory (CORE_ADDR memaddr, char *myaddr, int len,
568 int write, struct mem_attrib *attrib,
569 struct target_ops *target)
572 return st2000_write_inferior_memory (memaddr, myaddr, len);
574 return st2000_read_inferior_memory (memaddr, myaddr, len);
578 st2000_kill (char *args, int from_tty)
580 return; /* Ignore attempts to kill target system */
583 /* Clean up when a program exits.
585 The program actually lives on in the remote processor's RAM, and may be
586 run again without a download. Don't leave it full of breakpoint
590 st2000_mourn_inferior (void)
592 remove_breakpoints ();
593 unpush_target (&st2000_ops);
594 generic_mourn_inferior (); /* Do all the proper things now */
597 #define MAX_STDEBUG_BREAKPOINTS 16
599 static CORE_ADDR breakaddr[MAX_STDEBUG_BREAKPOINTS] =
603 st2000_insert_breakpoint (CORE_ADDR addr, char *shadow)
606 CORE_ADDR bp_addr = addr;
609 BREAKPOINT_FROM_PC (&bp_addr, &bp_size);
611 for (i = 0; i <= MAX_STDEBUG_BREAKPOINTS; i++)
612 if (breakaddr[i] == 0)
616 st2000_read_inferior_memory (bp_addr, shadow, bp_size);
617 printf_stdebug ("BR %x H\r", addr);
622 fprintf_unfiltered (gdb_stderr, "Too many breakpoints (> 16) for STDBUG\n");
627 st2000_remove_breakpoint (CORE_ADDR addr, char *shadow)
631 for (i = 0; i < MAX_STDEBUG_BREAKPOINTS; i++)
632 if (breakaddr[i] == addr)
636 printf_stdebug ("CB %d\r", i);
641 fprintf_unfiltered (gdb_stderr,
642 "Can't find breakpoint associated with 0x%x\n", addr);
647 /* Put a command string, in args, out to STDBUG. Output from STDBUG is placed
648 on the users terminal until the prompt is seen. */
651 st2000_command (char *args, int fromtty)
654 error ("st2000 target not open.");
657 error ("Missing command.");
659 printf_stdebug ("%s\r", args);
663 /* Connect the user directly to STDBUG. This command acts just like the
664 'cu' or 'tip' command. Use <CR>~. or <CR>~^D to break out. */
666 /*static struct ttystate ttystate; */
671 printf ("\r\n[Exiting connect mode]\r\n");
672 /* serial_restore(0, &ttystate); */
676 /* This all should now be in serial.c */
679 connect_command (char *args, int fromtty)
689 error ("st2000 target not open.");
692 fprintf ("This command takes no args. They have been ignored.\n");
694 printf ("[Entering connect mode. Use ~. or ~^D to escape]\n");
696 serial_raw (0, &ttystate);
698 make_cleanup (cleanup_tty, 0);
706 FD_SET (0, &readfds);
707 FD_SET (deprecated_serial_fd (st2000_desc), &readfds);
708 numfds = select (sizeof (readfds) * 8, &readfds, 0, 0, 0);
713 perror_with_name ("select");
715 if (FD_ISSET (0, &readfds))
716 { /* tty input, send to stdebug */
719 perror_with_name ("connect");
721 printf_stdebug ("%c", c);
735 if (c == '.' || c == '\004')
742 if (FD_ISSET (deprecated_serial_fd (st2000_desc), &readfds))
757 /* Define the target subroutine names */
759 struct target_ops st2000_ops;
762 init_st2000_ops (void)
764 st2000_ops.to_shortname = "st2000";
765 st2000_ops.to_longname = "Remote serial Tandem ST2000 target";
766 st2000_ops.to_doc = "Use a remote computer running STDEBUG connected by a serial line;\n\
767 or a network connection.\n\
768 Arguments are the name of the device for the serial line,\n\
769 the speed to connect at in bits per second.";
770 st2000_ops.to_open = st2000_open;
771 st2000_ops.to_close = st2000_close;
772 st2000_ops.to_detach = st2000_detach;
773 st2000_ops.to_resume = st2000_resume;
774 st2000_ops.to_wait = st2000_wait;
775 st2000_ops.to_fetch_registers = st2000_fetch_register;
776 st2000_ops.to_store_registers = st2000_store_register;
777 st2000_ops.to_prepare_to_store = st2000_prepare_to_store;
778 st2000_ops.deprecated_xfer_memory = st2000_xfer_inferior_memory;
779 st2000_ops.to_files_info = st2000_files_info;
780 st2000_ops.to_insert_breakpoint = st2000_insert_breakpoint;
781 st2000_ops.to_remove_breakpoint = st2000_remove_breakpoint; /* Breakpoints */
782 st2000_ops.to_kill = st2000_kill;
783 st2000_ops.to_create_inferior = st2000_create_inferior;
784 st2000_ops.to_mourn_inferior = st2000_mourn_inferior;
785 st2000_ops.to_stratum = process_stratum;
786 st2000_ops.to_has_all_memory = 1;
787 st2000_ops.to_has_memory = 1;
788 st2000_ops.to_has_stack = 1;
789 st2000_ops.to_has_registers = 1;
790 st2000_ops.to_has_execution = 1; /* all mem, mem, stack, regs, exec */
791 st2000_ops.to_magic = OPS_MAGIC; /* Always the last thing */
795 _initialize_remote_st2000 (void)
798 add_target (&st2000_ops);
799 add_com ("st2000 <command>", class_obscure, st2000_command,
800 "Send a command to the STDBUG monitor.");
801 add_com ("connect", class_obscure, connect_command,
802 "Connect the terminal directly up to the STDBUG command monitor.\n\
803 Use <CR>~. or <CR>~^D to break out.");