1 /* Memory-access and commands for remote NINDY process, for GDB.
2 Copyright 1990, 1991, 1992, 1993, 2001 Free Software Foundation, Inc.
3 Contributed by Intel Corporation. Modified from remote.c by Chris Benenati.
5 GDB is distributed in the hope that it will be useful, but WITHOUT ANY
6 WARRANTY. No author or distributor accepts responsibility to anyone
7 for the consequences of using it or for whether it serves any
8 particular purpose or works at all, unless he says so in writing.
9 Refer to the GDB General Public License for full details.
11 Everyone is granted permission to copy, modify and redistribute GDB,
12 but only under the conditions described in the GDB General Public
13 License. A copy of this license is supposed to have been given to you
14 along with GDB so you can know your rights and responsibilities. It
15 should be in a file named COPYING. Among other things, the copyright
16 notice and this notice must be preserved on all copies.
18 In other words, go ahead and share GDB, but don't try to stop
19 anyone else from sharing it farther. Help stamp out software hoarding!
23 Except for the data cache routines, this file bears little resemblence
24 to remote.c. A new (although similar) protocol has been specified, and
25 portions of the code are entirely dependent on having an i80960 with a
26 NINDY ROM monitor at the other end of the line.
29 /*****************************************************************************
31 * REMOTE COMMUNICATION PROTOCOL BETWEEN GDB960 AND THE NINDY ROM MONITOR.
37 * As far as NINDY is concerned, GDB is always in one of two modes: command
38 * mode or passthrough mode.
40 * In command mode (the default) pre-defined packets containing requests
41 * are sent by GDB to NINDY. NINDY never talks except in reponse to a request.
43 * Once the the user program is started, GDB enters passthrough mode, to give
44 * the user program access to the terminal. GDB remains in this mode until
45 * NINDY indicates that the program has stopped.
51 * GDB writes all input received from the keyboard directly to NINDY, and writes
52 * all characters received from NINDY directly to the monitor.
54 * Keyboard input is neither buffered nor echoed to the monitor.
56 * GDB remains in passthrough mode until NINDY sends a single ^P character,
57 * to indicate that the user process has stopped.
60 * GDB assumes NINDY performs a 'flushreg' when the user program stops.
66 * All info (except for message ack and nak) is transferred between gdb
67 * and the remote processor in messages of the following format:
72 * # is a literal character
74 * <info> ASCII information; all numeric information is in the
75 * form of hex digits ('0'-'9' and lowercase 'a'-'f').
78 * is a pair of ASCII hex digits representing an 8-bit
79 * checksum formed by adding together each of the
80 * characters in <info>.
82 * The receiver of a message always sends a single character to the sender
83 * to indicate that the checksum was good ('+') or bad ('-'); the sender
84 * re-transmits the entire message over until a '+' is received.
86 * In response to a command NINDY always sends back either data or
87 * a result code of the form "Xnn", where "nn" are hex digits and "X00"
88 * means no errors. (Exceptions: the "s" and "c" commands don't respond.)
90 * SEE THE HEADER OF THE FILE "gdb.c" IN THE NINDY MONITOR SOURCE CODE FOR A
91 * FULL DESCRIPTION OF LEGAL COMMANDS.
93 * SEE THE FILE "stop.h" IN THE NINDY MONITOR SOURCE CODE FOR A LIST
96 ***************************************************************************/
100 #include <sys/types.h>
104 #include "inferior.h"
110 #include "floatformat.h"
112 #include "gdb_wait.h"
113 #include <sys/file.h>
116 #include "nindy-share/env.h"
117 #include "nindy-share/stop.h"
118 #include "remote-utils.h"
120 extern int unlink ();
121 extern char *getenv ();
122 extern char *mktemp ();
124 extern void generic_mourn_inferior ();
126 extern struct target_ops nindy_ops;
127 extern FILE *instream;
129 extern char ninStopWhy ();
130 extern int ninMemGet ();
131 extern int ninMemPut ();
133 int nindy_initial_brk; /* nonzero if want to send an initial BREAK to nindy */
134 int nindy_old_protocol; /* nonzero if want to use old protocol */
135 char *nindy_ttyname; /* name of tty to talk to nindy on, or null */
137 #define DLE '\020' /* Character NINDY sends to indicate user program has
142 /* From nindy-share/nindy.c. */
143 extern serial_t nindy_serial;
145 static int have_regs = 0; /* 1 iff regs read since i960 last halted */
146 static int regs_changed = 0; /* 1 iff regs were modified since last read */
148 extern char *exists ();
150 static void nindy_fetch_registers (int);
152 static void nindy_store_registers (int);
154 static char *savename;
157 nindy_close (int quitting)
159 if (nindy_serial != NULL)
160 SERIAL_CLOSE (nindy_serial);
168 /* Open a connection to a remote debugger.
169 FIXME, there should be "set" commands for the options that are
170 now specified with gdb command-line options (old_protocol,
173 nindy_open (char *name, /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
179 error_no_arg ("serial port device name");
181 target_preopen (from_tty);
185 have_regs = regs_changed = 0;
187 /* Allow user to interrupt the following -- we could hang if there's
188 no NINDY at the other end of the remote tty. */
190 /* If baud_rate is -1, then ninConnect will not recognize the baud rate
191 and will deal with the situation in a (more or less) reasonable
193 sprintf (baudrate, "%d", baud_rate);
194 ninConnect (name, baudrate,
195 nindy_initial_brk, !from_tty, nindy_old_protocol);
198 if (nindy_serial == NULL)
200 perror_with_name (name);
203 savename = savestring (name, strlen (name));
204 push_target (&nindy_ops);
206 target_fetch_registers (-1);
209 init_wait_for_inferior ();
210 clear_proceed_status ();
214 /* User-initiated quit of nindy operations. */
217 nindy_detach (char *name, int from_tty)
220 error ("Too many arguments");
225 nindy_files_info (void)
227 /* FIXME: this lies about the baud rate if we autobauded. */
228 printf_unfiltered ("\tAttached to %s at %d bits per second%s%s.\n", savename,
230 nindy_old_protocol ? " in old protocol" : "",
231 nindy_initial_brk ? " with initial break" : "");
234 /* Return the number of characters in the buffer BUF before
235 the first DLE character. N is maximum number of characters to
240 non_dle (char *buf, int n)
244 for (i = 0; i < n; i++)
254 /* Tell the remote machine to resume. */
257 nindy_resume (int pid, int step, enum target_signal siggnal)
259 if (siggnal != TARGET_SIGNAL_0 && siggnal != stop_signal)
260 warning ("Can't send signals to remote NINDY targets.");
264 nindy_store_registers (-1);
271 /* FIXME, we can probably use the normal terminal_inferior stuff here.
272 We have to do terminal_inferior and then set up the passthrough
273 settings initially. Thereafter, terminal_ours and terminal_inferior
274 will automatically swap the settings around for us. */
276 struct clean_up_tty_args
278 serial_ttystate state;
281 static struct clean_up_tty_args tty_args;
284 clean_up_tty (PTR ptrarg)
286 struct clean_up_tty_args *args = (struct clean_up_tty_args *) ptrarg;
287 SERIAL_SET_TTY_STATE (args->serial, args->state);
289 warning ("\n\nYou may need to reset the 80960 and/or reload your program.\n");
292 /* Recover from ^Z or ^C while remote process is running */
293 static void (*old_ctrlc) ();
295 static void (*old_ctrlz) ();
301 SERIAL_SET_TTY_STATE (tty_args.serial, tty_args.state);
302 xfree (tty_args.state);
304 signal (SIGINT, old_ctrlc);
306 signal (SIGTSTP, old_ctrlz);
308 error ("\n\nYou may need to reset the 80960 and/or reload your program.\n");
311 /* Wait until the remote machine stops. While waiting, operate in passthrough
312 * mode; i.e., pass everything NINDY sends to gdb_stdout, and everything from
315 * Return to caller, storing status in 'status' just as `wait' would.
319 nindy_wait (int pid, struct target_waitstatus *status)
325 unsigned char stop_exit;
326 unsigned char stop_code;
327 struct cleanup *old_cleanups;
328 long ip_value, fp_value, sp_value; /* Reg values from stop */
330 status->kind = TARGET_WAITKIND_EXITED;
331 status->value.integer = 0;
333 /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */
335 /* Save current tty attributes, and restore them when done. */
336 tty_args.serial = SERIAL_FDOPEN (0);
337 tty_args.state = SERIAL_GET_TTY_STATE (tty_args.serial);
338 old_ctrlc = signal (SIGINT, clean_up_int);
340 old_ctrlz = signal (SIGTSTP, clean_up_int);
343 old_cleanups = make_cleanup (clean_up_tty, &tty_args);
345 /* Pass input from keyboard to NINDY as it arrives. NINDY will interpret
346 <CR> and perform echo. */
347 /* This used to set CBREAK and clear ECHO and CRMOD. I hope this is close
349 SERIAL_RAW (tty_args.serial);
353 /* Input on remote */
354 c = SERIAL_READCHAR (nindy_serial, -1);
355 if (c == SERIAL_ERROR)
357 error ("Cannot read from serial line");
359 else if (c == 0x1b) /* ESC */
361 c = SERIAL_READCHAR (nindy_serial, -1);
364 else if (c != 0x10) /* DLE */
365 /* Write out any characters preceding DLE */
372 stop_exit = ninStopWhy (&stop_code,
373 &ip_value, &fp_value, &sp_value);
374 if (!stop_exit && (stop_code == STOP_SRQ))
382 /* Get out of loop */
383 supply_register (IP_REGNUM,
385 supply_register (FP_REGNUM,
387 supply_register (SP_REGNUM,
394 SERIAL_SET_TTY_STATE (tty_args.serial, tty_args.state);
395 xfree (tty_args.state);
396 discard_cleanups (old_cleanups);
400 status->kind = TARGET_WAITKIND_EXITED;
401 status->value.integer = stop_code;
405 /* nindy has some special stop code need to be handled */
406 if (stop_code == STOP_GDB_BPT)
407 stop_code = TRACE_STEP;
408 status->kind = TARGET_WAITKIND_STOPPED;
409 status->value.sig = i960_fault_to_signal (stop_code);
414 /* Read the remote registers into the block REGS. */
416 /* This is the block that ninRegsGet and ninRegsPut handles. */
419 char local_regs[16 * 4];
420 char global_regs[16 * 4];
424 char fp_as_double[4 * 8];
428 nindy_fetch_registers (int regno)
430 struct nindy_regs nindy_regs;
434 ninRegsGet ((char *) &nindy_regs);
437 memcpy (®isters[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16 * 4);
438 memcpy (®isters[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16 * 4);
439 memcpy (®isters[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2 * 4);
440 memcpy (®isters[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1 * 4);
441 memcpy (®isters[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1 * 4);
442 memcpy (®isters[REGISTER_BYTE (FP0_REGNUM)], nindy_regs.fp_as_double, 4 * 8);
444 registers_fetched ();
448 nindy_prepare_to_store (void)
450 /* Fetch all regs if they aren't already here. */
451 read_register_bytes (0, NULL, REGISTER_BYTES);
455 nindy_store_registers (int regno)
457 struct nindy_regs nindy_regs;
460 memcpy (nindy_regs.local_regs, ®isters[REGISTER_BYTE (R0_REGNUM)], 16 * 4);
461 memcpy (nindy_regs.global_regs, ®isters[REGISTER_BYTE (G0_REGNUM)], 16 * 4);
462 memcpy (nindy_regs.pcw_acw, ®isters[REGISTER_BYTE (PCW_REGNUM)], 2 * 4);
463 memcpy (nindy_regs.ip, ®isters[REGISTER_BYTE (IP_REGNUM)], 1 * 4);
464 memcpy (nindy_regs.tcw, ®isters[REGISTER_BYTE (TCW_REGNUM)], 1 * 4);
465 memcpy (nindy_regs.fp_as_double, ®isters[REGISTER_BYTE (FP0_REGNUM)], 8 * 4);
468 ninRegsPut ((char *) &nindy_regs);
472 /* Copy LEN bytes to or from inferior's memory starting at MEMADDR
473 to debugger memory starting at MYADDR. Copy to inferior if
474 SHOULD_WRITE is nonzero. Returns the length copied. TARGET is
478 nindy_xfer_inferior_memory (CORE_ADDR memaddr, char *myaddr, int len,
480 struct mem_attrib *attrib ATTRIBUTE_UNUSED,
481 struct target_ops *target ATTRIBUTE_UNUSED)
489 res = ninMemPut (memaddr, myaddr, len);
491 res = ninMemGet (memaddr, myaddr, len);
497 nindy_create_inferior (char *execfile, char *args, char **env)
503 error ("Can't pass arguments to remote NINDY process");
505 if (execfile == 0 || exec_bfd == 0)
506 error ("No executable file specified");
508 entry_pt = (int) bfd_get_start_address (exec_bfd);
512 /* The "process" (board) is already stopped awaiting our commands, and
513 the program is already downloaded. We just set its PC and go. */
515 inferior_pid = pid; /* Needed for wait_for_inferior below */
517 clear_proceed_status ();
519 /* Tell wait_for_inferior that we've started a new process. */
520 init_wait_for_inferior ();
522 /* Set up the "saved terminal modes" of the inferior
523 based on what modes we are starting it with. */
524 target_terminal_init ();
526 /* Install inferior's terminal modes. */
527 target_terminal_inferior ();
529 /* insert_step_breakpoint (); FIXME, do we need this? */
531 proceed ((CORE_ADDR) entry_pt, TARGET_SIGNAL_DEFAULT, 0);
535 reset_command (char *args, int from_tty)
537 if (nindy_serial == NULL)
539 error ("No target system to reset -- use 'target nindy' command.");
541 if (query ("Really reset the target system?", 0, 0))
543 SERIAL_SEND_BREAK (nindy_serial);
544 tty_flush (nindy_serial);
549 nindy_kill (char *args, int from_tty)
551 return; /* Ignore attempts to kill target system */
554 /* Clean up when a program exits.
556 The program actually lives on in the remote processor's RAM, and may be
557 run again without a download. Don't leave it full of breakpoint
561 nindy_mourn_inferior (void)
563 remove_breakpoints ();
564 unpush_target (&nindy_ops);
565 generic_mourn_inferior (); /* Do all the proper things now */
568 /* Pass the args the way catch_errors wants them. */
570 nindy_open_stub (char *arg)
577 nindy_load (char *filename, int from_tty)
580 /* Can't do unix style forking on a VMS system, so we'll use bfd to do
584 bfd *file = bfd_openr (filename, 0);
587 perror_with_name (filename);
591 if (!bfd_check_format (file, bfd_object))
593 error ("can't prove it's an object file\n");
597 for (s = file->sections; s; s = s->next)
599 if (s->flags & SEC_LOAD)
601 char *buffer = xmalloc (s->_raw_size);
602 bfd_get_section_contents (file, s, buffer, 0, s->_raw_size);
603 printf ("Loading section %s, size %x vma %x\n",
607 ninMemPut (s->vma, buffer, s->_raw_size);
615 load_stub (char *arg)
617 target_load (arg, 1);
621 /* This routine is run as a hook, just before the main command loop is
622 entered. If gdb is configured for the i960, but has not had its
623 nindy target specified yet, this will loop prompting the user to do so.
625 Unlike the loop provided by Intel, we actually let the user get out
626 of this with a RETURN. This is useful when e.g. simply examining
627 an i960 object file on the host system. */
630 nindy_before_main_loop (void)
635 while (target_stack->target_ops != &nindy_ops) /* What is this crap??? */
636 { /* remote tty not specified yet */
637 if (instream == stdin)
639 printf_unfiltered ("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit: ");
640 gdb_flush (gdb_stdout);
642 fgets (ttyname, sizeof (ttyname) - 1, stdin);
644 /* Strip leading and trailing whitespace */
645 for (p = ttyname; isspace (*p); p++)
651 return; /* User just hit spaces or return, wants out */
653 for (p2 = p; !isspace (*p2) && (*p2 != '\0'); p2++)
658 if (STREQ ("quit", p))
663 if (catch_errors (nindy_open_stub, p, "", RETURN_MASK_ALL))
665 /* Now that we have a tty open for talking to the remote machine,
666 download the executable file if one was specified. */
669 catch_errors (load_stub, bfd_get_filename (exec_bfd), "",
676 /* Define the target subroutine names */
678 struct target_ops nindy_ops;
681 init_nindy_ops (void)
683 nindy_ops.to_shortname = "nindy";
684 "Remote serial target in i960 NINDY-specific protocol",
685 nindy_ops.to_longname = "Use a remote i960 system running NINDY connected by a serial line.\n\
686 Specify the name of the device the serial line is connected to.\n\
687 The speed (baud rate), whether to use the old NINDY protocol,\n\
688 and whether to send a break on startup, are controlled by options\n\
689 specified when you started GDB.";
690 nindy_ops.to_doc = "";
691 nindy_ops.to_open = nindy_open;
692 nindy_ops.to_close = nindy_close;
693 nindy_ops.to_attach = 0;
694 nindy_ops.to_post_attach = NULL;
695 nindy_ops.to_require_attach = NULL;
696 nindy_ops.to_detach = nindy_detach;
697 nindy_ops.to_require_detach = NULL;
698 nindy_ops.to_resume = nindy_resume;
699 nindy_ops.to_wait = nindy_wait;
700 nindy_ops.to_post_wait = NULL;
701 nindy_ops.to_fetch_registers = nindy_fetch_registers;
702 nindy_ops.to_store_registers = nindy_store_registers;
703 nindy_ops.to_prepare_to_store = nindy_prepare_to_store;
704 nindy_ops.to_xfer_memory = nindy_xfer_inferior_memory;
705 nindy_ops.to_files_info = nindy_files_info;
706 nindy_ops.to_insert_breakpoint = memory_insert_breakpoint;
707 nindy_ops.to_remove_breakpoint = memory_remove_breakpoint;
708 nindy_ops.to_terminal_init = 0;
709 nindy_ops.to_terminal_inferior = 0;
710 nindy_ops.to_terminal_ours_for_output = 0;
711 nindy_ops.to_terminal_ours = 0;
712 nindy_ops.to_terminal_info = 0; /* Terminal crud */
713 nindy_ops.to_kill = nindy_kill;
714 nindy_ops.to_load = nindy_load;
715 nindy_ops.to_lookup_symbol = 0; /* lookup_symbol */
716 nindy_ops.to_create_inferior = nindy_create_inferior;
717 nindy_ops.to_post_startup_inferior = NULL;
718 nindy_ops.to_acknowledge_created_inferior = NULL;
719 nindy_ops.to_clone_and_follow_inferior = NULL;
720 nindy_ops.to_post_follow_inferior_by_clone = NULL;
721 nindy_ops.to_insert_fork_catchpoint = NULL;
722 nindy_ops.to_remove_fork_catchpoint = NULL;
723 nindy_ops.to_insert_vfork_catchpoint = NULL;
724 nindy_ops.to_remove_vfork_catchpoint = NULL;
725 nindy_ops.to_has_forked = NULL;
726 nindy_ops.to_has_vforked = NULL;
727 nindy_ops.to_can_follow_vfork_prior_to_exec = NULL;
728 nindy_ops.to_post_follow_vfork = NULL;
729 nindy_ops.to_insert_exec_catchpoint = NULL;
730 nindy_ops.to_remove_exec_catchpoint = NULL;
731 nindy_ops.to_has_execd = NULL;
732 nindy_ops.to_reported_exec_events_per_exec_call = NULL;
733 nindy_ops.to_has_exited = NULL;
734 nindy_ops.to_mourn_inferior = nindy_mourn_inferior;
735 nindy_ops.to_can_run = 0; /* can_run */
736 nindy_ops.to_notice_signals = 0; /* notice_signals */
737 nindy_ops.to_thread_alive = 0; /* to_thread_alive */
738 nindy_ops.to_stop = 0; /* to_stop */
739 nindy_ops.to_pid_to_exec_file = NULL;
740 nindy_ops.to_core_file_to_sym_file = NULL;
741 nindy_ops.to_stratum = process_stratum;
742 nindy_ops.DONT_USE = 0; /* next */
743 nindy_ops.to_has_all_memory = 1;
744 nindy_ops.to_has_memory = 1;
745 nindy_ops.to_has_stack = 1;
746 nindy_ops.to_has_registers = 1;
747 nindy_ops.to_has_execution = 1; /* all mem, mem, stack, regs, exec */
748 nindy_ops.to_sections = 0;
749 nindy_ops.to_sections_end = 0; /* Section pointers */
750 nindy_ops.to_magic = OPS_MAGIC; /* Always the last thing */
754 _initialize_nindy (void)
757 add_target (&nindy_ops);
758 add_com ("reset", class_obscure, reset_command,
759 "Send a 'break' to the remote target system.\n\
760 Only useful if the target has been equipped with a circuit\n\
761 to perform a hard reset when a break is detected.");