1 /* Memory-access and commands for remote NINDY process, for GDB.
2 Copyright 1990, 1991, 1992, 1993 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 "ieee-float.h"
113 #include <sys/file.h>
116 #include "nindy-share/env.h"
117 #include "nindy-share/stop.h"
120 extern char *getenv();
121 extern char *mktemp();
123 extern void generic_mourn_inferior ();
125 extern struct target_ops nindy_ops;
126 extern FILE *instream;
127 extern struct ext_format ext_format_i960; /* i960-tdep.c */
129 extern char ninStopWhy ();
131 int nindy_initial_brk; /* nonzero if want to send an initial BREAK to nindy */
132 int nindy_old_protocol; /* nonzero if want to use old protocol */
133 char *nindy_ttyname; /* name of tty to talk to nindy on, or null */
135 #define DLE '\020' /* Character NINDY sends to indicate user program has
140 /* From nindy-share/nindy.c. */
141 extern serial_t nindy_serial;
143 static int have_regs = 0; /* 1 iff regs read since i960 last halted */
144 static int regs_changed = 0; /* 1 iff regs were modified since last read */
146 extern char *exists();
149 dcache_flush (), dcache_poke (), dcache_init();
155 nindy_fetch_registers PARAMS ((int));
158 nindy_store_registers PARAMS ((int));
160 static char *savename;
163 nindy_close (quitting)
166 if (nindy_serial != NULL)
167 SERIAL_CLOSE (nindy_serial);
175 /* Open a connection to a remote debugger.
176 FIXME, there should be a way to specify the various options that are
177 now specified with gdb command-line options. (baud_rate, old_protocol,
180 nindy_open (name, from_tty)
181 char *name; /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
186 error_no_arg ("serial port device name");
188 target_preopen (from_tty);
192 have_regs = regs_changed = 0;
195 /* Allow user to interrupt the following -- we could hang if there's
196 no NINDY at the other end of the remote tty. */
198 ninConnect(name, baud_rate ? baud_rate : "9600",
199 nindy_initial_brk, !from_tty, nindy_old_protocol);
202 if (nindy_serial == NULL)
204 perror_with_name (name);
207 savename = savestring (name, strlen (name));
208 push_target (&nindy_ops);
209 target_fetch_registers(-1);
212 /* User-initiated quit of nindy operations. */
215 nindy_detach (name, from_tty)
220 error ("Too many arguments");
227 printf("\tAttached to %s at %s bps%s%s.\n", savename,
228 baud_rate? baud_rate: "9600",
229 nindy_old_protocol? " in old protocol": "",
230 nindy_initial_brk? " with initial break": "");
233 /* Return the number of characters in the buffer before
234 the first DLE character. */
239 char *buf; /* Character buffer; NOT '\0'-terminated */
240 int n; /* Number of characters in buffer */
244 for ( i = 0; i < n; i++ ){
245 if ( buf[i] == DLE ){
252 /* Tell the remote machine to resume. */
255 nindy_resume (pid, step, siggnal)
256 int pid, step, siggnal;
258 if (siggnal != 0 && siggnal != stop_signal)
259 error ("Can't send signals to remote NINDY targets.");
263 nindy_store_registers (-1);
270 /* FIXME, we can probably use the normal terminal_inferior stuff here.
271 We have to do terminal_inferior and then set up the passthrough
272 settings initially. Thereafter, terminal_ours and terminal_inferior
273 will automatically swap the settings around for us. */
275 struct clean_up_tty_args {
276 serial_ttystate state;
281 clean_up_tty (ptrarg)
284 struct clean_up_tty_args *args = (struct clean_up_tty_args *) ptrarg;
285 SERIAL_SET_TTY_STATE (args->serial, args->state);
288 You may need to reset the 80960 and/or reload your program.\n");
291 /* Wait until the remote machine stops. While waiting, operate in passthrough
292 * mode; i.e., pass everything NINDY sends to stdout, and everything from
295 * Return to caller, storing status in 'status' just as `wait' would.
303 char buf[500]; /* FIXME, what is "500" here? */
305 unsigned char stop_exit;
306 unsigned char stop_code;
307 struct clean_up_tty_args tty_args;
308 struct cleanup *old_cleanups;
309 long ip_value, fp_value, sp_value; /* Reg values from stop */
311 WSETEXIT( (*status), 0 );
313 /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */
315 /* Save current tty attributes, and restore them when done. */
316 tty_args.serial = SERIAL_FDOPEN (0);
317 tty_args.state = SERIAL_GET_TTY_STATE (tty_args.serial);
318 old_cleanups = make_cleanup (clean_up_tty, &tty_args);
320 /* Pass input from keyboard to NINDY as it arrives. NINDY will interpret
321 <CR> and perform echo. */
322 /* This used to set CBREAK and clear ECHO and CRMOD. I hope this is close
324 SERIAL_RAW (tty_args.serial);
328 /* Wait for input on either the remote port or stdin. */
331 FD_SET (nindy_serial->fd, &fds);
332 if (select (nindy_serial->fd + 1, &fds, 0, 0, 0) <= 0)
335 /* Pass input through to correct place */
336 if (FD_ISSET (0, &fds))
339 n = read (0, buf, sizeof (buf));
342 SERIAL_WRITE (nindy_serial, buf, n );
346 if (FD_ISSET (nindy_serial->fd, &fds))
348 /* Input on remote */
349 n = read (nindy_serial->fd, buf, sizeof (buf));
352 /* Write out any characters in buffer preceding DLE */
353 i = non_dle( buf, n );
361 /* There *was* a DLE in the buffer */
362 stop_exit = ninStopWhy(&stop_code,
363 &ip_value, &fp_value, &sp_value);
364 if (!stop_exit && (stop_code == STOP_SRQ))
372 /* Get out of loop */
373 supply_register (IP_REGNUM,
375 supply_register (FP_REGNUM,
377 supply_register (SP_REGNUM,
386 do_cleanups (old_cleanups);
390 /* User program exited */
391 WSETEXIT ((*status), stop_code);
400 /* Breakpoint or single stepping. */
404 /* The target is not running Unix, and its faults/traces do
405 not map nicely into Unix signals. Make sure they do not
406 get confused with Unix signals by numbering them with
407 values higher than the highest legal Unix signal. code
408 in i960_print_fault(), called via PRINT_RANDOM_SIGNAL,
409 will interpret the value. */
413 WSETSTOP ((*status), stop_code);
418 /* Read the remote registers into the block REGS. */
420 /* This is the block that ninRegsGet and ninRegsPut handles. */
422 char local_regs[16 * 4];
423 char global_regs[16 * 4];
427 char fp_as_double[4 * 8];
431 nindy_fetch_registers(regno)
434 struct nindy_regs nindy_regs;
439 ninRegsGet( (char *) &nindy_regs );
442 memcpy (®isters[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16*4);
443 memcpy (®isters[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16*4);
444 memcpy (®isters[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2*4);
445 memcpy (®isters[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1*4);
446 memcpy (®isters[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1*4);
447 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
448 dub = unpack_double (builtin_type_double,
449 &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
451 /* dub now in host byte order */
452 double_to_ieee_extended (&ext_format_i960, &dub,
453 ®isters[REGISTER_BYTE (regnum)]);
456 registers_fetched ();
460 nindy_prepare_to_store()
462 /* Fetch all regs if they aren't already here. */
463 read_register_bytes (0, NULL, REGISTER_BYTES);
467 nindy_store_registers(regno)
470 struct nindy_regs nindy_regs;
474 memcpy (nindy_regs.local_regs, ®isters[REGISTER_BYTE (R0_REGNUM)], 16*4);
475 memcpy (nindy_regs.global_regs, ®isters[REGISTER_BYTE (G0_REGNUM)], 16*4);
476 memcpy (nindy_regs.pcw_acw, ®isters[REGISTER_BYTE (PCW_REGNUM)], 2*4);
477 memcpy (nindy_regs.ip, ®isters[REGISTER_BYTE (IP_REGNUM)], 1*4);
478 memcpy (nindy_regs.tcw, ®isters[REGISTER_BYTE (TCW_REGNUM)], 1*4);
479 /* Float regs. Only works on IEEE_FLOAT hosts. FIXME! */
480 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
481 ieee_extended_to_double (&ext_format_i960,
482 ®isters[REGISTER_BYTE (regnum)], &dub);
483 /* dub now in host byte order */
484 /* FIXME-someday, the arguments to unpack_double are backward.
485 It expects a target double and returns a host; we pass the opposite.
486 This mostly works but not quite. */
487 dub = unpack_double (builtin_type_double, (char *)&dub, &inv);
488 /* dub now in target byte order */
489 memcpy (&nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)], &dub, 8);
493 ninRegsPut( (char *) &nindy_regs );
497 /* Read a word from remote address ADDR and return it.
498 * This goes through the data cache.
501 nindy_fetch_word (addr)
504 return dcache_fetch (addr);
507 /* Write a word WORD into remote address ADDR.
508 This goes through the data cache. */
511 nindy_store_word (addr, word)
515 dcache_poke (addr, word);
518 /* Copy LEN bytes to or from inferior's memory starting at MEMADDR
519 to debugger memory starting at MYADDR. Copy to inferior if
520 WRITE is nonzero. Returns the length copied.
522 This is stolen almost directly from infptrace.c's child_xfer_memory,
523 which also deals with a word-oriented memory interface. Sometime,
524 FIXME, rewrite this to not use the word-oriented routines. */
527 nindy_xfer_inferior_memory(memaddr, myaddr, len, write, target)
532 struct target_ops *target; /* ignored */
535 /* Round starting address down to longword boundary. */
536 register CORE_ADDR addr = memaddr & - sizeof (int);
537 /* Round ending address up; get number of longwords that makes. */
539 = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
540 /* Allocate buffer of that many longwords. */
541 register int *buffer = (int *) alloca (count * sizeof (int));
545 /* Fill start and end extra bytes of buffer with existing memory data. */
547 if (addr != memaddr || len < (int)sizeof (int)) {
548 /* Need part of initial word -- fetch it. */
549 buffer[0] = nindy_fetch_word (addr);
552 if (count > 1) /* FIXME, avoid if even boundary */
555 = nindy_fetch_word (addr + (count - 1) * sizeof (int));
558 /* Copy data to be written over corresponding part of buffer */
560 memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
562 /* Write the entire buffer. */
564 for (i = 0; i < count; i++, addr += sizeof (int))
567 nindy_store_word (addr, buffer[i]);
574 /* Read all the longwords */
575 for (i = 0; i < count; i++, addr += sizeof (int))
578 buffer[i] = nindy_fetch_word (addr);
584 /* Copy appropriate bytes out of the buffer. */
585 memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
590 /* The data cache records all the data read from the remote machine
591 since the last time it stopped.
593 Each cache block holds 16 bytes of data
594 starting at a multiple-of-16 address. */
596 #define DCACHE_SIZE 64 /* Number of cache blocks */
598 struct dcache_block {
599 struct dcache_block *next, *last;
600 unsigned int addr; /* Address for which data is recorded. */
604 struct dcache_block dcache_free, dcache_valid;
606 /* Free all the data cache blocks, thus discarding all cached data. */
611 register struct dcache_block *db;
613 while ((db = dcache_valid.next) != &dcache_valid)
616 insque (db, &dcache_free);
621 * If addr is present in the dcache, return the address of the block
625 struct dcache_block *
629 register struct dcache_block *db;
634 /* Search all cache blocks for one that is at this address. */
635 db = dcache_valid.next;
636 while (db != &dcache_valid)
638 if ((addr & 0xfffffff0) == db->addr)
645 /* Return the int data at address ADDR in dcache block DC. */
648 dcache_value (db, addr)
649 struct dcache_block *db;
654 return (db->data[(addr>>2)&3]);
657 /* Get a free cache block, put or keep it on the valid list,
658 and return its address. The caller should store into the block
659 the address and data that it describes, then remque it from the
660 free list and insert it into the valid list. This procedure
661 prevents errors from creeping in if a ninMemGet is interrupted
662 (which used to put garbage blocks in the valid list...). */
664 struct dcache_block *
667 register struct dcache_block *db;
669 if ((db = dcache_free.next) == &dcache_free)
671 /* If we can't get one from the free list, take last valid and put
672 it on the free list. */
673 db = dcache_valid.last;
675 insque (db, &dcache_free);
679 insque (db, &dcache_valid);
683 /* Return the contents of the word at address ADDR in the remote machine,
684 using the data cache. */
690 register struct dcache_block *db;
692 db = dcache_hit (addr);
695 db = dcache_alloc ();
697 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
699 db->addr = addr & ~0xf;
700 remque (db); /* Off the free list */
701 insque (db, &dcache_valid); /* On the valid list */
703 return (dcache_value (db, addr));
706 /* Write the word at ADDR both in the data cache and in the remote machine. */
708 dcache_poke (addr, data)
712 register struct dcache_block *db;
714 /* First make sure the word is IN the cache. DB is its cache block. */
715 db = dcache_hit (addr);
718 db = dcache_alloc ();
720 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
722 db->addr = addr & ~0xf;
723 remque (db); /* Off the free list */
724 insque (db, &dcache_valid); /* On the valid list */
727 /* Modify the word in the cache. */
728 db->data[(addr>>2)&3] = data;
730 /* Send the changed word. */
732 ninMemPut(addr, (unsigned char *)&data, 4);
736 /* The cache itself. */
737 struct dcache_block the_cache[DCACHE_SIZE];
739 /* Initialize the data cache. */
744 register struct dcache_block *db;
747 dcache_free.next = dcache_free.last = &dcache_free;
748 dcache_valid.next = dcache_valid.last = &dcache_valid;
749 for (i=0;i<DCACHE_SIZE;i++,db++)
750 insque (db, &dcache_free);
755 nindy_create_inferior (execfile, args, env)
764 error ("Can't pass arguments to remote NINDY process");
766 if (execfile == 0 || exec_bfd == 0)
767 error ("No exec file specified");
769 entry_pt = (int) bfd_get_start_address (exec_bfd);
773 #ifdef CREATE_INFERIOR_HOOK
774 CREATE_INFERIOR_HOOK (pid);
777 /* The "process" (board) is already stopped awaiting our commands, and
778 the program is already downloaded. We just set its PC and go. */
780 inferior_pid = pid; /* Needed for wait_for_inferior below */
782 clear_proceed_status ();
784 /* Tell wait_for_inferior that we've started a new process. */
785 init_wait_for_inferior ();
787 /* Set up the "saved terminal modes" of the inferior
788 based on what modes we are starting it with. */
789 target_terminal_init ();
791 /* Install inferior's terminal modes. */
792 target_terminal_inferior ();
794 /* insert_step_breakpoint (); FIXME, do we need this? */
795 proceed ((CORE_ADDR)entry_pt, -1, 0); /* Let 'er rip... */
799 reset_command(args, from_tty)
803 if (nindy_serial == NULL)
805 error( "No target system to reset -- use 'target nindy' command.");
807 if ( query("Really reset the target system?",0,0) )
809 SERIAL_SEND_BREAK (nindy_serial);
810 tty_flush (nindy_serial);
815 nindy_kill (args, from_tty)
819 return; /* Ignore attempts to kill target system */
822 /* Clean up when a program exits.
824 The program actually lives on in the remote processor's RAM, and may be
825 run again without a download. Don't leave it full of breakpoint
829 nindy_mourn_inferior ()
831 remove_breakpoints ();
832 unpush_target (&nindy_ops);
833 generic_mourn_inferior (); /* Do all the proper things now */
836 /* Pass the args the way catch_errors wants them. */
838 nindy_open_stub (arg)
849 target_load (arg, 1);
853 /* This routine is run as a hook, just before the main command loop is
854 entered. If gdb is configured for the i960, but has not had its
855 nindy target specified yet, this will loop prompting the user to do so.
857 Unlike the loop provided by Intel, we actually let the user get out
858 of this with a RETURN. This is useful when e.g. simply examining
859 an i960 object file on the host system. */
862 nindy_before_main_loop ()
867 while (current_target != &nindy_ops) { /* remote tty not specified yet */
868 if ( instream == stdin ){
869 printf("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit: ");
872 fgets( ttyname, sizeof(ttyname)-1, stdin );
874 /* Strip leading and trailing whitespace */
875 for ( p = ttyname; isspace(*p); p++ ){
879 return; /* User just hit spaces or return, wants out */
881 for ( p2= p; !isspace(*p2) && (*p2 != '\0'); p2++ ){
885 if ( STREQ("quit",p) ){
889 if (catch_errors (nindy_open_stub, p, "", RETURN_MASK_ALL))
891 /* Now that we have a tty open for talking to the remote machine,
892 download the executable file if one was specified. */
895 catch_errors (load_stub, bfd_get_filename (exec_bfd), "",
902 /* Define the target subroutine names */
904 struct target_ops nindy_ops = {
905 "nindy", "Remote serial target in i960 NINDY-specific protocol",
906 "Use a remote i960 system running NINDY connected by a serial line.\n\
907 Specify the name of the device the serial line is connected to.\n\
908 The speed (baud rate), whether to use the old NINDY protocol,\n\
909 and whether to send a break on startup, are controlled by options\n\
910 specified when you started GDB.",
911 nindy_open, nindy_close,
916 nindy_fetch_registers, nindy_store_registers,
917 nindy_prepare_to_store,
918 nindy_xfer_inferior_memory, nindy_files_info,
919 0, 0, /* insert_breakpoint, remove_breakpoint, */
920 0, 0, 0, 0, 0, /* Terminal crud */
923 0, /* lookup_symbol */
924 nindy_create_inferior,
925 nindy_mourn_inferior,
927 0, /* notice_signals */
928 process_stratum, 0, /* next */
929 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
930 0, 0, /* Section pointers */
931 OPS_MAGIC, /* Always the last thing */
937 add_target (&nindy_ops);
938 add_com ("reset", class_obscure, reset_command,
939 "Send a 'break' to the remote target system.\n\
940 Only useful if the target has been equipped with a circuit\n\
941 to perform a hard reset when a break is detected.");