1 /* Memory-access and commands for remote NINDY process, for GDB.
2 Copyright 1990, 1991, 1992 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"
109 #include "ieee-float.h"
112 #include <sys/ioctl.h>
113 #include <sys/file.h>
115 #include "nindy-share/ttycntl.h"
116 #include "nindy-share/demux.h"
117 #include "nindy-share/env.h"
118 #include "nindy-share/stop.h"
121 extern char *getenv();
122 extern char *mktemp();
124 extern char *coffstrip();
125 extern void generic_mourn_inferior ();
127 extern struct target_ops nindy_ops;
128 extern jmp_buf to_top_level;
129 extern FILE *instream;
130 extern struct ext_format ext_format_i960; /* i960-tdep.c */
132 extern char ninStopWhy ();
134 int nindy_initial_brk; /* nonzero if want to send an initial BREAK to nindy */
135 int nindy_old_protocol; /* nonzero if want to use old protocol */
136 char *nindy_ttyname; /* name of tty to talk to nindy on, or null */
138 #define DLE '\020' /* Character NINDY sends to indicate user program has
143 int nindy_fd = 0; /* Descriptor for I/O to NINDY */
144 static int have_regs = 0; /* 1 iff regs read since i960 last halted */
145 static int regs_changed = 0; /* 1 iff regs were modified since last read */
147 extern char *exists();
148 static void dcache_flush (), dcache_poke (), dcache_init();
149 static int dcache_fetch ();
151 /* FIXME, we can probably use the normal terminal_inferior stuff here.
152 We have to do terminal_inferior and then set up the passthrough
153 settings initially. Thereafter, terminal_ours and terminal_inferior
154 will automatically swap the settings around for us. */
156 /* Restore TTY to normal operation */
158 static TTY_STRUCT orig_tty; /* TTY attributes before entering passthrough */
163 ioctl( 0, TIOCSETN, &orig_tty );
167 /* Recover from ^Z or ^C while remote process is running */
169 static void (*old_ctrlc)(); /* Signal handlers before entering passthrough */
172 static void (*old_ctrlz)();
182 signal(SIGINT, old_ctrlc);
184 signal(SIGTSTP, old_ctrlz);
186 error("\n\nYou may need to reset the 80960 and/or reload your program.\n");
189 /* Clean up anything that needs cleaning when losing control. */
191 static char *savename;
194 nindy_close (quitting)
206 /* Open a connection to a remote debugger.
207 FIXME, there should be a way to specify the various options that are
208 now specified with gdb command-line options. (baud_rate, old_protocol,
211 nindy_open (name, from_tty)
212 char *name; /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
217 error_no_arg ("serial port device name");
219 target_preopen (from_tty);
223 have_regs = regs_changed = 0;
226 /* Allow user to interrupt the following -- we could hang if
227 * there's no NINDY at the other end of the remote tty.
230 nindy_fd = ninConnect( name, baud_rate? baud_rate: "9600",
231 nindy_initial_brk, !from_tty, nindy_old_protocol );
236 error( "Can't open tty '%s'", name );
239 savename = savestring (name, strlen (name));
240 push_target (&nindy_ops);
241 target_fetch_registers(-1);
244 /* User-initiated quit of nindy operations. */
247 nindy_detach (name, from_tty)
252 error ("Too many arguments");
259 printf("\tAttached to %s at %s bps%s%s.\n", savename,
260 baud_rate? baud_rate: "9600",
261 nindy_old_protocol? " in old protocol": "",
262 nindy_initial_brk? " with initial break": "");
265 /******************************************************************************
267 * Download an object file to the remote system by invoking the "comm960"
268 * utility. We look for "comm960" in $G960BIN, $G960BASE/bin, and
269 * DEFAULT_BASE/bin/HOST/bin where
270 * DEFAULT_BASE is defined in env.h, and
271 * HOST must be defined on the compiler invocation line.
272 ******************************************************************************/
275 nindy_load( filename, from_tty )
280 struct cleanup *old_chain;
281 char *scratch_pathname;
285 filename = get_exec_file (1);
287 filename = tilde_expand (filename);
288 make_cleanup (free, filename);
290 scratch_chan = openp (getenv ("PATH"), 1, filename, O_RDONLY, 0,
292 if (scratch_chan < 0)
293 perror_with_name (filename);
294 close (scratch_chan); /* Slightly wasteful FIXME */
296 have_regs = regs_changed = 0;
297 mark_breakpoints_out();
301 tmpfile = coffstrip(scratch_pathname);
303 old_chain = make_cleanup (unlink,tmpfile);
305 ninDownload( tmpfile, !from_tty );
306 /* FIXME, don't we want this merged in here? */
308 do_cleanups (old_chain);
314 /* Return the number of characters in the buffer before the first DLE character.
320 char *buf; /* Character buffer; NOT '\0'-terminated */
321 int n; /* Number of characters in buffer */
325 for ( i = 0; i < n; i++ ){
326 if ( buf[i] == DLE ){
333 /* Tell the remote machine to resume. */
336 nindy_resume (step, siggnal)
339 if (siggnal != 0 && siggnal != stop_signal)
340 error ("Can't send signals to remote NINDY targets.");
344 nindy_store_registers ();
351 /* Wait until the remote machine stops. While waiting, operate in passthrough
352 * mode; i.e., pass everything NINDY sends to stdout, and everything from
355 * Return to caller, storing status in 'status' just as `wait' would.
362 DEMUX_DECL; /* OS-dependent data needed by DEMUX... macros */
363 char buf[500]; /* FIXME, what is "500" here? */
365 unsigned char stop_exit;
366 unsigned char stop_code;
368 long ip_value, fp_value, sp_value; /* Reg values from stop */
371 WSETEXIT( (*status), 0 );
373 /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */
375 /* Save current tty attributes, set up signals to restore them.
377 ioctl( 0, TIOCGETP, &orig_tty );
378 old_ctrlc = signal( SIGINT, cleanup );
380 old_ctrlz = signal( SIGTSTP, cleanup );
383 /* Pass input from keyboard to NINDY as it arrives.
384 * NINDY will interpret <CR> and perform echo.
387 TTY_NINDYTERM( tty );
388 ioctl( 0, TIOCSETN, &tty );
391 /* Go to sleep until there's something for us on either
392 * the remote port or stdin.
395 DEMUX_WAIT( nindy_fd );
397 /* Pass input through to correct place */
399 n = DEMUX_READ( 0, buf, sizeof(buf) );
400 if ( n ){ /* Input on stdin */
401 write( nindy_fd, buf, n );
404 n = DEMUX_READ( nindy_fd, buf, sizeof(buf) );
405 if ( n ){ /* Input on remote */
406 /* Write out any characters in buffer preceding DLE */
407 i = non_dle( buf, n );
413 /* There *was* a DLE in the buffer */
414 stop_exit = ninStopWhy( &stop_code,
415 &ip_value, &fp_value, &sp_value);
416 if ( !stop_exit && (stop_code==STOP_SRQ) ){
421 /* Get out of loop */
422 supply_register (IP_REGNUM, &ip_value);
423 supply_register (FP_REGNUM, &fp_value);
424 supply_register (SP_REGNUM, &sp_value);
431 signal( SIGINT, old_ctrlc );
433 signal( SIGTSTP, old_ctrlz );
437 if ( stop_exit ){ /* User program exited */
438 WSETEXIT( (*status), stop_code );
439 } else { /* Fault or trace */
443 /* Make it look like a VAX trace trap */
447 /* The target is not running Unix, and its
448 faults/traces do not map nicely into Unix signals.
449 Make sure they do not get confused with Unix signals
450 by numbering them with values higher than the highest
451 legal Unix signal. code in i960_print_fault(),
452 called via PRINT_RANDOM_SIGNAL, will interpret the
457 WSETSTOP( (*status), stop_code );
461 /* Read the remote registers into the block REGS. */
463 /* This is the block that ninRegsGet and ninRegsPut handles. */
465 char local_regs[16 * 4];
466 char global_regs[16 * 4];
470 char fp_as_double[4 * 8];
474 nindy_fetch_registers(regno)
477 struct nindy_regs nindy_regs;
482 ninRegsGet( (char *) &nindy_regs );
485 bcopy (nindy_regs.local_regs, ®isters[REGISTER_BYTE (R0_REGNUM)], 16*4);
486 bcopy (nindy_regs.global_regs, ®isters[REGISTER_BYTE (G0_REGNUM)], 16*4);
487 bcopy (nindy_regs.pcw_acw, ®isters[REGISTER_BYTE (PCW_REGNUM)], 2*4);
488 bcopy (nindy_regs.ip, ®isters[REGISTER_BYTE (IP_REGNUM)], 1*4);
489 bcopy (nindy_regs.tcw, ®isters[REGISTER_BYTE (TCW_REGNUM)], 1*4);
490 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
491 dub = unpack_double (builtin_type_double,
492 &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
494 /* dub now in host byte order */
495 double_to_ieee_extended (&ext_format_i960, &dub,
496 ®isters[REGISTER_BYTE (regnum)]);
499 registers_fetched ();
503 nindy_prepare_to_store()
505 nindy_fetch_registers(-1);
509 nindy_store_registers(regno)
512 struct nindy_regs nindy_regs;
516 bcopy (®isters[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16*4);
517 bcopy (®isters[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16*4);
518 bcopy (®isters[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2*4);
519 bcopy (®isters[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1*4);
520 bcopy (®isters[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1*4);
521 /* Float regs. Only works on IEEE_FLOAT hosts. */
522 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
523 ieee_extended_to_double (&ext_format_i960,
524 ®isters[REGISTER_BYTE (regnum)], &dub);
525 /* dub now in host byte order */
526 /* FIXME-someday, the arguments to unpack_double are backward.
527 It expects a target double and returns a host; we pass the opposite.
528 This mostly works but not quite. */
529 dub = unpack_double (builtin_type_double, &dub, &inv);
530 /* dub now in target byte order */
531 bcopy ((char *)&dub, &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
536 ninRegsPut( (char *) &nindy_regs );
540 /* Read a word from remote address ADDR and return it.
541 * This goes through the data cache.
544 nindy_fetch_word (addr)
547 return dcache_fetch (addr);
550 /* Write a word WORD into remote address ADDR.
551 This goes through the data cache. */
554 nindy_store_word (addr, word)
558 dcache_poke (addr, word);
561 /* Copy LEN bytes to or from inferior's memory starting at MEMADDR
562 to debugger memory starting at MYADDR. Copy to inferior if
563 WRITE is nonzero. Returns the length copied.
565 This is stolen almost directly from infptrace.c's child_xfer_memory,
566 which also deals with a word-oriented memory interface. Sometime,
567 FIXME, rewrite this to not use the word-oriented routines. */
570 nindy_xfer_inferior_memory(memaddr, myaddr, len, write, target)
575 struct target_ops *target; /* ignored */
578 /* Round starting address down to longword boundary. */
579 register CORE_ADDR addr = memaddr & - sizeof (int);
580 /* Round ending address up; get number of longwords that makes. */
582 = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
583 /* Allocate buffer of that many longwords. */
584 register int *buffer = (int *) alloca (count * sizeof (int));
588 /* Fill start and end extra bytes of buffer with existing memory data. */
590 if (addr != memaddr || len < (int)sizeof (int)) {
591 /* Need part of initial word -- fetch it. */
592 buffer[0] = nindy_fetch_word (addr);
595 if (count > 1) /* FIXME, avoid if even boundary */
598 = nindy_fetch_word (addr + (count - 1) * sizeof (int));
601 /* Copy data to be written over corresponding part of buffer */
603 bcopy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
605 /* Write the entire buffer. */
607 for (i = 0; i < count; i++, addr += sizeof (int))
610 nindy_store_word (addr, buffer[i]);
617 /* Read all the longwords */
618 for (i = 0; i < count; i++, addr += sizeof (int))
621 buffer[i] = nindy_fetch_word (addr);
627 /* Copy appropriate bytes out of the buffer. */
628 bcopy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
633 /* The data cache records all the data read from the remote machine
634 since the last time it stopped.
636 Each cache block holds 16 bytes of data
637 starting at a multiple-of-16 address. */
639 #define DCACHE_SIZE 64 /* Number of cache blocks */
641 struct dcache_block {
642 struct dcache_block *next, *last;
643 unsigned int addr; /* Address for which data is recorded. */
647 struct dcache_block dcache_free, dcache_valid;
649 /* Free all the data cache blocks, thus discarding all cached data. */
654 register struct dcache_block *db;
656 while ((db = dcache_valid.next) != &dcache_valid)
659 insque (db, &dcache_free);
664 * If addr is present in the dcache, return the address of the block
668 struct dcache_block *
672 register struct dcache_block *db;
677 /* Search all cache blocks for one that is at this address. */
678 db = dcache_valid.next;
679 while (db != &dcache_valid)
681 if ((addr & 0xfffffff0) == db->addr)
688 /* Return the int data at address ADDR in dcache block DC. */
691 dcache_value (db, addr)
692 struct dcache_block *db;
697 return (db->data[(addr>>2)&3]);
700 /* Get a free cache block, put or keep it on the valid list,
701 and return its address. The caller should store into the block
702 the address and data that it describes, then remque it from the
703 free list and insert it into the valid list. This procedure
704 prevents errors from creeping in if a ninMemGet is interrupted
705 (which used to put garbage blocks in the valid list...). */
707 struct dcache_block *
710 register struct dcache_block *db;
712 if ((db = dcache_free.next) == &dcache_free)
714 /* If we can't get one from the free list, take last valid and put
715 it on the free list. */
716 db = dcache_valid.last;
718 insque (db, &dcache_free);
722 insque (db, &dcache_valid);
726 /* Return the contents of the word at address ADDR in the remote machine,
727 using the data cache. */
733 register struct dcache_block *db;
735 db = dcache_hit (addr);
738 db = dcache_alloc ();
740 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
742 db->addr = addr & ~0xf;
743 remque (db); /* Off the free list */
744 insque (db, &dcache_valid); /* On the valid list */
746 return (dcache_value (db, addr));
749 /* Write the word at ADDR both in the data cache and in the remote machine. */
751 dcache_poke (addr, data)
755 register struct dcache_block *db;
757 /* First make sure the word is IN the cache. DB is its cache block. */
758 db = dcache_hit (addr);
761 db = dcache_alloc ();
763 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
765 db->addr = addr & ~0xf;
766 remque (db); /* Off the free list */
767 insque (db, &dcache_valid); /* On the valid list */
770 /* Modify the word in the cache. */
771 db->data[(addr>>2)&3] = data;
773 /* Send the changed word. */
775 ninMemPut(addr, (unsigned char *)&data, 4);
779 /* The cache itself. */
780 struct dcache_block the_cache[DCACHE_SIZE];
782 /* Initialize the data cache. */
787 register struct dcache_block *db;
790 dcache_free.next = dcache_free.last = &dcache_free;
791 dcache_valid.next = dcache_valid.last = &dcache_valid;
792 for (i=0;i<DCACHE_SIZE;i++,db++)
793 insque (db, &dcache_free);
798 nindy_create_inferior (execfile, args, env)
807 error ("Can't pass arguments to remote NINDY process");
809 if (execfile == 0 || exec_bfd == 0)
810 error ("No exec file specified");
812 entry_pt = (int) bfd_get_start_address (exec_bfd);
816 #ifdef CREATE_INFERIOR_HOOK
817 CREATE_INFERIOR_HOOK (pid);
820 /* The "process" (board) is already stopped awaiting our commands, and
821 the program is already downloaded. We just set its PC and go. */
823 inferior_pid = pid; /* Needed for wait_for_inferior below */
825 clear_proceed_status ();
827 /* Tell wait_for_inferior that we've started a new process. */
828 init_wait_for_inferior ();
830 /* Set up the "saved terminal modes" of the inferior
831 based on what modes we are starting it with. */
832 target_terminal_init ();
834 /* Install inferior's terminal modes. */
835 target_terminal_inferior ();
837 /* insert_step_breakpoint (); FIXME, do we need this? */
838 proceed ((CORE_ADDR)entry_pt, -1, 0); /* Let 'er rip... */
842 reset_command(args, from_tty)
847 error( "No target system to reset -- use 'target nindy' command.");
849 if ( query("Really reset the target system?",0,0) ){
850 send_break( nindy_fd );
851 tty_flush( nindy_fd );
856 nindy_kill (args, from_tty)
860 return; /* Ignore attempts to kill target system */
863 /* Clean up when a program exits.
865 The program actually lives on in the remote processor's RAM, and may be
866 run again without a download. Don't leave it full of breakpoint
870 nindy_mourn_inferior ()
872 remove_breakpoints ();
873 generic_mourn_inferior (); /* Do all the proper things now */
876 /* This routine is run as a hook, just before the main command loop is
877 entered. If gdb is configured for the i960, but has not had its
878 nindy target specified yet, this will loop prompting the user to do so.
880 Unlike the loop provided by Intel, we actually let the user get out
881 of this with a RETURN. This is useful when e.g. simply examining
882 an i960 object file on the host system. */
884 nindy_before_main_loop ()
889 setjmp(to_top_level);
890 while (current_target != &nindy_ops) { /* remote tty not specified yet */
891 if ( instream == stdin ){
892 printf("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit: ");
895 fgets( ttyname, sizeof(ttyname)-1, stdin );
897 /* Strip leading and trailing whitespace */
898 for ( p = ttyname; isspace(*p); p++ ){
902 return; /* User just hit spaces or return, wants out */
904 for ( p2= p; !isspace(*p2) && (*p2 != '\0'); p2++ ){
908 if ( !strcmp("quit",p) ){
914 /* Now that we have a tty open for talking to the remote machine,
915 download the executable file if one was specified. */
916 if ( !setjmp(to_top_level) && exec_bfd ) {
917 target_load (bfd_get_filename (exec_bfd), 1);
922 /* Define the target subroutine names */
924 struct target_ops nindy_ops = {
925 "nindy", "Remote serial target in i960 NINDY-specific protocol",
926 "Use a remote i960 system running NINDY connected by a serial line.\n\
927 Specify the name of the device the serial line is connected to.\n\
928 The speed (baud rate), whether to use the old NINDY protocol,\n\
929 and whether to send a break on startup, are controlled by options\n\
930 specified when you started GDB.",
931 nindy_open, nindy_close,
932 0, nindy_detach, nindy_resume, nindy_wait,
933 nindy_fetch_registers, nindy_store_registers,
934 nindy_prepare_to_store, 0, 0, /* conv_from, conv_to */
935 nindy_xfer_inferior_memory, nindy_files_info,
936 0, 0, /* insert_breakpoint, remove_breakpoint, */
937 0, 0, 0, 0, 0, /* Terminal crud */
940 0, /* lookup_symbol */
941 nindy_create_inferior,
942 nindy_mourn_inferior,
943 process_stratum, 0, /* next */
944 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
945 0, 0, /* Section pointers */
946 OPS_MAGIC, /* Always the last thing */
952 add_target (&nindy_ops);
953 add_com ("reset", class_obscure, reset_command,
954 "Send a 'break' to the remote target system.\n\
955 Only useful if the target has been equipped with a circuit\n\
956 to perform a hard reset when a break is detected.");