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/ioctl.h>
114 #include <sys/file.h>
116 #include "nindy-share/ttycntl.h"
117 #include "nindy-share/demux.h"
118 #include "nindy-share/env.h"
119 #include "nindy-share/stop.h"
122 extern char *getenv();
123 extern char *mktemp();
125 extern void generic_mourn_inferior ();
127 extern struct target_ops nindy_ops;
128 extern FILE *instream;
129 extern struct ext_format ext_format_i960; /* i960-tdep.c */
131 extern char ninStopWhy ();
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 int nindy_fd = 0; /* Descriptor for I/O to NINDY */
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 /* FIXME, we can probably use the normal terminal_inferior stuff here.
161 We have to do terminal_inferior and then set up the passthrough
162 settings initially. Thereafter, terminal_ours and terminal_inferior
163 will automatically swap the settings around for us. */
165 /* Restore TTY to normal operation */
167 static TTY_STRUCT orig_tty; /* TTY attributes before entering passthrough */
172 ioctl( 0, TIOCSETN, &orig_tty );
176 /* Recover from ^Z or ^C while remote process is running */
178 static void (*old_ctrlc)(); /* Signal handlers before entering passthrough */
181 static void (*old_ctrlz)();
191 signal(SIGINT, old_ctrlc);
193 signal(SIGTSTP, old_ctrlz);
195 error("\n\nYou may need to reset the 80960 and/or reload your program.\n");
198 /* Clean up anything that needs cleaning when losing control. */
200 static char *savename;
203 nindy_close (quitting)
215 /* Open a connection to a remote debugger.
216 FIXME, there should be a way to specify the various options that are
217 now specified with gdb command-line options. (baud_rate, old_protocol,
220 nindy_open (name, from_tty)
221 char *name; /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
226 error_no_arg ("serial port device name");
228 target_preopen (from_tty);
232 have_regs = regs_changed = 0;
235 /* Allow user to interrupt the following -- we could hang if
236 * there's no NINDY at the other end of the remote tty.
239 nindy_fd = ninConnect( name, baud_rate? baud_rate: "9600",
240 nindy_initial_brk, !from_tty, nindy_old_protocol );
245 error( "Can't open tty '%s'", name );
248 savename = savestring (name, strlen (name));
249 push_target (&nindy_ops);
250 target_fetch_registers(-1);
253 /* User-initiated quit of nindy operations. */
256 nindy_detach (name, from_tty)
261 error ("Too many arguments");
268 printf("\tAttached to %s at %s bps%s%s.\n", savename,
269 baud_rate? baud_rate: "9600",
270 nindy_old_protocol? " in old protocol": "",
271 nindy_initial_brk? " with initial break": "");
274 /* Return the number of characters in the buffer before
275 the first DLE character. */
280 char *buf; /* Character buffer; NOT '\0'-terminated */
281 int n; /* Number of characters in buffer */
285 for ( i = 0; i < n; i++ ){
286 if ( buf[i] == DLE ){
293 /* Tell the remote machine to resume. */
296 nindy_resume (step, siggnal)
299 if (siggnal != 0 && siggnal != stop_signal)
300 error ("Can't send signals to remote NINDY targets.");
304 nindy_store_registers (-1);
311 /* Wait until the remote machine stops. While waiting, operate in passthrough
312 * mode; i.e., pass everything NINDY sends to stdout, and everything from
315 * Return to caller, storing status in 'status' just as `wait' would.
322 DEMUX_DECL; /* OS-dependent data needed by DEMUX... macros */
323 char buf[500]; /* FIXME, what is "500" here? */
325 unsigned char stop_exit;
326 unsigned char stop_code;
328 long ip_value, fp_value, sp_value; /* Reg values from stop */
331 WSETEXIT( (*status), 0 );
333 /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */
335 /* Save current tty attributes, set up signals to restore them.
337 ioctl( 0, TIOCGETP, &orig_tty );
338 old_ctrlc = signal( SIGINT, cleanup );
340 old_ctrlz = signal( SIGTSTP, cleanup );
343 /* Pass input from keyboard to NINDY as it arrives.
344 * NINDY will interpret <CR> and perform echo.
347 TTY_NINDYTERM( tty );
348 ioctl( 0, TIOCSETN, &tty );
351 /* Go to sleep until there's something for us on either
352 * the remote port or stdin.
355 DEMUX_WAIT( nindy_fd );
357 /* Pass input through to correct place */
359 n = DEMUX_READ( 0, buf, sizeof(buf) );
360 if ( n ){ /* Input on stdin */
361 write( nindy_fd, buf, n );
364 n = DEMUX_READ( nindy_fd, buf, sizeof(buf) );
365 if ( n ){ /* Input on remote */
366 /* Write out any characters in buffer preceding DLE */
367 i = non_dle( buf, n );
373 /* There *was* a DLE in the buffer */
374 stop_exit = ninStopWhy( &stop_code,
375 &ip_value, &fp_value, &sp_value);
376 if ( !stop_exit && (stop_code==STOP_SRQ) ){
381 /* Get out of loop */
382 supply_register (IP_REGNUM,
384 supply_register (FP_REGNUM,
386 supply_register (SP_REGNUM,
394 signal( SIGINT, old_ctrlc );
396 signal( SIGTSTP, old_ctrlz );
400 if ( stop_exit ){ /* User program exited */
401 WSETEXIT( (*status), stop_code );
402 } else { /* Fault or trace */
406 /* Make it look like a VAX trace trap */
410 /* The target is not running Unix, and its
411 faults/traces do not map nicely into Unix signals.
412 Make sure they do not get confused with Unix signals
413 by numbering them with values higher than the highest
414 legal Unix signal. code in i960_print_fault(),
415 called via PRINT_RANDOM_SIGNAL, will interpret the
420 WSETSTOP( (*status), stop_code );
425 /* Read the remote registers into the block REGS. */
427 /* This is the block that ninRegsGet and ninRegsPut handles. */
429 char local_regs[16 * 4];
430 char global_regs[16 * 4];
434 char fp_as_double[4 * 8];
438 nindy_fetch_registers(regno)
441 struct nindy_regs nindy_regs;
446 ninRegsGet( (char *) &nindy_regs );
449 bcopy (nindy_regs.local_regs, ®isters[REGISTER_BYTE (R0_REGNUM)], 16*4);
450 bcopy (nindy_regs.global_regs, ®isters[REGISTER_BYTE (G0_REGNUM)], 16*4);
451 bcopy (nindy_regs.pcw_acw, ®isters[REGISTER_BYTE (PCW_REGNUM)], 2*4);
452 bcopy (nindy_regs.ip, ®isters[REGISTER_BYTE (IP_REGNUM)], 1*4);
453 bcopy (nindy_regs.tcw, ®isters[REGISTER_BYTE (TCW_REGNUM)], 1*4);
454 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
455 dub = unpack_double (builtin_type_double,
456 &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
458 /* dub now in host byte order */
459 double_to_ieee_extended (&ext_format_i960, &dub,
460 ®isters[REGISTER_BYTE (regnum)]);
463 registers_fetched ();
467 nindy_prepare_to_store()
469 /* Fetch all regs if they aren't already here. */
470 read_register_bytes (0, NULL, REGISTER_BYTES);
474 nindy_store_registers(regno)
477 struct nindy_regs nindy_regs;
481 bcopy (®isters[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16*4);
482 bcopy (®isters[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16*4);
483 bcopy (®isters[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2*4);
484 bcopy (®isters[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1*4);
485 bcopy (®isters[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1*4);
486 /* Float regs. Only works on IEEE_FLOAT hosts. FIXME! */
487 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
488 ieee_extended_to_double (&ext_format_i960,
489 ®isters[REGISTER_BYTE (regnum)], &dub);
490 /* dub now in host byte order */
491 /* FIXME-someday, the arguments to unpack_double are backward.
492 It expects a target double and returns a host; we pass the opposite.
493 This mostly works but not quite. */
494 dub = unpack_double (builtin_type_double, (char *)&dub, &inv);
495 /* dub now in target byte order */
496 bcopy ((char *)&dub, &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
501 ninRegsPut( (char *) &nindy_regs );
505 /* Read a word from remote address ADDR and return it.
506 * This goes through the data cache.
509 nindy_fetch_word (addr)
512 return dcache_fetch (addr);
515 /* Write a word WORD into remote address ADDR.
516 This goes through the data cache. */
519 nindy_store_word (addr, word)
523 dcache_poke (addr, word);
526 /* Copy LEN bytes to or from inferior's memory starting at MEMADDR
527 to debugger memory starting at MYADDR. Copy to inferior if
528 WRITE is nonzero. Returns the length copied.
530 This is stolen almost directly from infptrace.c's child_xfer_memory,
531 which also deals with a word-oriented memory interface. Sometime,
532 FIXME, rewrite this to not use the word-oriented routines. */
535 nindy_xfer_inferior_memory(memaddr, myaddr, len, write, target)
540 struct target_ops *target; /* ignored */
543 /* Round starting address down to longword boundary. */
544 register CORE_ADDR addr = memaddr & - sizeof (int);
545 /* Round ending address up; get number of longwords that makes. */
547 = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
548 /* Allocate buffer of that many longwords. */
549 register int *buffer = (int *) alloca (count * sizeof (int));
553 /* Fill start and end extra bytes of buffer with existing memory data. */
555 if (addr != memaddr || len < (int)sizeof (int)) {
556 /* Need part of initial word -- fetch it. */
557 buffer[0] = nindy_fetch_word (addr);
560 if (count > 1) /* FIXME, avoid if even boundary */
563 = nindy_fetch_word (addr + (count - 1) * sizeof (int));
566 /* Copy data to be written over corresponding part of buffer */
568 bcopy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
570 /* Write the entire buffer. */
572 for (i = 0; i < count; i++, addr += sizeof (int))
575 nindy_store_word (addr, buffer[i]);
582 /* Read all the longwords */
583 for (i = 0; i < count; i++, addr += sizeof (int))
586 buffer[i] = nindy_fetch_word (addr);
592 /* Copy appropriate bytes out of the buffer. */
593 bcopy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
598 /* The data cache records all the data read from the remote machine
599 since the last time it stopped.
601 Each cache block holds 16 bytes of data
602 starting at a multiple-of-16 address. */
604 #define DCACHE_SIZE 64 /* Number of cache blocks */
606 struct dcache_block {
607 struct dcache_block *next, *last;
608 unsigned int addr; /* Address for which data is recorded. */
612 struct dcache_block dcache_free, dcache_valid;
614 /* Free all the data cache blocks, thus discarding all cached data. */
619 register struct dcache_block *db;
621 while ((db = dcache_valid.next) != &dcache_valid)
624 insque (db, &dcache_free);
629 * If addr is present in the dcache, return the address of the block
633 struct dcache_block *
637 register struct dcache_block *db;
642 /* Search all cache blocks for one that is at this address. */
643 db = dcache_valid.next;
644 while (db != &dcache_valid)
646 if ((addr & 0xfffffff0) == db->addr)
653 /* Return the int data at address ADDR in dcache block DC. */
656 dcache_value (db, addr)
657 struct dcache_block *db;
662 return (db->data[(addr>>2)&3]);
665 /* Get a free cache block, put or keep it on the valid list,
666 and return its address. The caller should store into the block
667 the address and data that it describes, then remque it from the
668 free list and insert it into the valid list. This procedure
669 prevents errors from creeping in if a ninMemGet is interrupted
670 (which used to put garbage blocks in the valid list...). */
672 struct dcache_block *
675 register struct dcache_block *db;
677 if ((db = dcache_free.next) == &dcache_free)
679 /* If we can't get one from the free list, take last valid and put
680 it on the free list. */
681 db = dcache_valid.last;
683 insque (db, &dcache_free);
687 insque (db, &dcache_valid);
691 /* Return the contents of the word at address ADDR in the remote machine,
692 using the data cache. */
698 register struct dcache_block *db;
700 db = dcache_hit (addr);
703 db = dcache_alloc ();
705 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
707 db->addr = addr & ~0xf;
708 remque (db); /* Off the free list */
709 insque (db, &dcache_valid); /* On the valid list */
711 return (dcache_value (db, addr));
714 /* Write the word at ADDR both in the data cache and in the remote machine. */
716 dcache_poke (addr, data)
720 register struct dcache_block *db;
722 /* First make sure the word is IN the cache. DB is its cache block. */
723 db = dcache_hit (addr);
726 db = dcache_alloc ();
728 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
730 db->addr = addr & ~0xf;
731 remque (db); /* Off the free list */
732 insque (db, &dcache_valid); /* On the valid list */
735 /* Modify the word in the cache. */
736 db->data[(addr>>2)&3] = data;
738 /* Send the changed word. */
740 ninMemPut(addr, (unsigned char *)&data, 4);
744 /* The cache itself. */
745 struct dcache_block the_cache[DCACHE_SIZE];
747 /* Initialize the data cache. */
752 register struct dcache_block *db;
755 dcache_free.next = dcache_free.last = &dcache_free;
756 dcache_valid.next = dcache_valid.last = &dcache_valid;
757 for (i=0;i<DCACHE_SIZE;i++,db++)
758 insque (db, &dcache_free);
763 nindy_create_inferior (execfile, args, env)
772 error ("Can't pass arguments to remote NINDY process");
774 if (execfile == 0 || exec_bfd == 0)
775 error ("No exec file specified");
777 entry_pt = (int) bfd_get_start_address (exec_bfd);
781 #ifdef CREATE_INFERIOR_HOOK
782 CREATE_INFERIOR_HOOK (pid);
785 /* The "process" (board) is already stopped awaiting our commands, and
786 the program is already downloaded. We just set its PC and go. */
788 inferior_pid = pid; /* Needed for wait_for_inferior below */
790 clear_proceed_status ();
792 /* Tell wait_for_inferior that we've started a new process. */
793 init_wait_for_inferior ();
795 /* Set up the "saved terminal modes" of the inferior
796 based on what modes we are starting it with. */
797 target_terminal_init ();
799 /* Install inferior's terminal modes. */
800 target_terminal_inferior ();
802 /* insert_step_breakpoint (); FIXME, do we need this? */
803 proceed ((CORE_ADDR)entry_pt, -1, 0); /* Let 'er rip... */
807 reset_command(args, from_tty)
812 error( "No target system to reset -- use 'target nindy' command.");
814 if ( query("Really reset the target system?",0,0) ){
815 send_break( nindy_fd );
816 tty_flush( nindy_fd );
821 nindy_kill (args, from_tty)
825 return; /* Ignore attempts to kill target system */
828 /* Clean up when a program exits.
830 The program actually lives on in the remote processor's RAM, and may be
831 run again without a download. Don't leave it full of breakpoint
835 nindy_mourn_inferior ()
837 remove_breakpoints ();
838 unpush_target (&nindy_ops);
839 generic_mourn_inferior (); /* Do all the proper things now */
842 /* Pass the args the way catch_errors wants them. */
844 nindy_open_stub (arg)
855 target_load (arg, 1);
859 /* This routine is run as a hook, just before the main command loop is
860 entered. If gdb is configured for the i960, but has not had its
861 nindy target specified yet, this will loop prompting the user to do so.
863 Unlike the loop provided by Intel, we actually let the user get out
864 of this with a RETURN. This is useful when e.g. simply examining
865 an i960 object file on the host system. */
868 nindy_before_main_loop ()
873 while (current_target != &nindy_ops) { /* remote tty not specified yet */
874 if ( instream == stdin ){
875 printf("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit: ");
878 fgets( ttyname, sizeof(ttyname)-1, stdin );
880 /* Strip leading and trailing whitespace */
881 for ( p = ttyname; isspace(*p); p++ ){
885 return; /* User just hit spaces or return, wants out */
887 for ( p2= p; !isspace(*p2) && (*p2 != '\0'); p2++ ){
891 if ( STREQ("quit",p) ){
895 if (catch_errors (nindy_open_stub, p, "", RETURN_MASK_ALL))
897 /* Now that we have a tty open for talking to the remote machine,
898 download the executable file if one was specified. */
901 catch_errors (load_stub, bfd_get_filename (exec_bfd), "",
908 /* Define the target subroutine names */
910 struct target_ops nindy_ops = {
911 "nindy", "Remote serial target in i960 NINDY-specific protocol",
912 "Use a remote i960 system running NINDY connected by a serial line.\n\
913 Specify the name of the device the serial line is connected to.\n\
914 The speed (baud rate), whether to use the old NINDY protocol,\n\
915 and whether to send a break on startup, are controlled by options\n\
916 specified when you started GDB.",
917 nindy_open, nindy_close,
922 nindy_fetch_registers, nindy_store_registers,
923 nindy_prepare_to_store,
924 nindy_xfer_inferior_memory, nindy_files_info,
925 0, 0, /* insert_breakpoint, remove_breakpoint, */
926 0, 0, 0, 0, 0, /* Terminal crud */
929 0, /* lookup_symbol */
930 nindy_create_inferior,
931 nindy_mourn_inferior,
933 0, /* notice_signals */
934 process_stratum, 0, /* next */
935 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
936 0, 0, /* Section pointers */
937 OPS_MAGIC, /* Always the last thing */
943 add_target (&nindy_ops);
944 add_com ("reset", class_obscure, reset_command,
945 "Send a 'break' to the remote target system.\n\
946 Only useful if the target has been equipped with a circuit\n\
947 to perform a hard reset when a break is detected.");