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>
105 #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 char *coffstrip();
126 extern void generic_mourn_inferior ();
128 extern struct target_ops nindy_ops;
129 extern jmp_buf to_top_level;
130 extern FILE *instream;
131 extern struct ext_format ext_format_i960; /* i960-tdep.c */
133 extern char ninStopWhy ();
135 int nindy_initial_brk; /* nonzero if want to send an initial BREAK to nindy */
136 int nindy_old_protocol; /* nonzero if want to use old protocol */
137 char *nindy_ttyname; /* name of tty to talk to nindy on, or null */
139 #define DLE '\020' /* Character NINDY sends to indicate user program has
144 int nindy_fd = 0; /* Descriptor for I/O to NINDY */
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();
149 static void dcache_flush (), dcache_poke (), dcache_init();
150 static int dcache_fetch ();
152 /* FIXME, we can probably use the normal terminal_inferior stuff here.
153 We have to do terminal_inferior and then set up the passthrough
154 settings initially. Thereafter, terminal_ours and terminal_inferior
155 will automatically swap the settings around for us. */
157 /* Restore TTY to normal operation */
159 static TTY_STRUCT orig_tty; /* TTY attributes before entering passthrough */
164 ioctl( 0, TIOCSETN, &orig_tty );
168 /* Recover from ^Z or ^C while remote process is running */
170 static void (*old_ctrlc)(); /* Signal handlers before entering passthrough */
173 static void (*old_ctrlz)();
183 signal(SIGINT, old_ctrlc);
185 signal(SIGTSTP, old_ctrlz);
187 error("\n\nYou may need to reset the 80960 and/or reload your program.\n");
190 /* Clean up anything that needs cleaning when losing control. */
192 static char *savename;
195 nindy_close (quitting)
207 /* Open a connection to a remote debugger.
208 FIXME, there should be a way to specify the various options that are
209 now specified with gdb command-line options. (baud_rate, old_protocol,
212 nindy_open (name, from_tty)
213 char *name; /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
218 error_no_arg ("serial port device name");
220 target_preopen (from_tty);
224 have_regs = regs_changed = 0;
227 /* Allow user to interrupt the following -- we could hang if
228 * there's no NINDY at the other end of the remote tty.
231 nindy_fd = ninConnect( name, baud_rate? baud_rate: "9600",
232 nindy_initial_brk, !from_tty, nindy_old_protocol );
237 error( "Can't open tty '%s'", name );
240 savename = savestring (name, strlen (name));
241 push_target (&nindy_ops);
242 target_fetch_registers(-1);
245 /* User-initiated quit of nindy operations. */
248 nindy_detach (name, from_tty)
253 error ("Too many arguments");
260 printf("\tAttached to %s at %s bps%s%s.\n", savename,
261 baud_rate? baud_rate: "9600",
262 nindy_old_protocol? " in old protocol": "",
263 nindy_initial_brk? " with initial break": "");
266 /******************************************************************************
268 * Download an object file to the remote system by invoking the "comm960"
269 * utility. We look for "comm960" in $G960BIN, $G960BASE/bin, and
270 * DEFAULT_BASE/bin/HOST/bin where
271 * DEFAULT_BASE is defined in env.h, and
272 * HOST must be defined on the compiler invocation line.
273 ******************************************************************************/
276 nindy_load( filename, from_tty )
281 struct cleanup *old_chain;
282 char *scratch_pathname;
286 filename = get_exec_file (1);
288 filename = tilde_expand (filename);
289 make_cleanup (free, filename);
291 scratch_chan = openp (getenv ("PATH"), 1, filename, O_RDONLY, 0,
293 if (scratch_chan < 0)
294 perror_with_name (filename);
295 close (scratch_chan); /* Slightly wasteful FIXME */
297 have_regs = regs_changed = 0;
298 mark_breakpoints_out();
302 tmpfile = coffstrip(scratch_pathname);
304 old_chain = make_cleanup(unlink,tmpfile);
306 ninDownload( tmpfile, !from_tty );
307 /* FIXME, don't we want this merged in here? */
309 do_cleanups (old_chain);
315 /* Return the number of characters in the buffer before the first DLE character.
321 char *buf; /* Character buffer; NOT '\0'-terminated */
322 int n; /* Number of characters in buffer */
326 for ( i = 0; i < n; i++ ){
327 if ( buf[i] == DLE ){
334 /* Tell the remote machine to resume. */
337 nindy_resume (step, siggnal)
340 if (siggnal != 0 && siggnal != stop_signal)
341 error ("Can't send signals to remote NINDY targets.");
345 nindy_store_registers ();
352 /* Wait until the remote machine stops. While waiting, operate in passthrough
353 * mode; i.e., pass everything NINDY sends to stdout, and everything from
356 * Return to caller, storing status in 'status' just as `wait' would.
363 DEMUX_DECL; /* OS-dependent data needed by DEMUX... macros */
364 char buf[500]; /* FIXME, what is "500" here? */
366 unsigned char stop_exit;
367 unsigned char stop_code;
369 long ip_value, fp_value, sp_value; /* Reg values from stop */
372 WSETEXIT( (*status), 0 );
374 /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */
376 /* Save current tty attributes, set up signals to restore them.
378 ioctl( 0, TIOCGETP, &orig_tty );
379 old_ctrlc = signal( SIGINT, cleanup );
381 old_ctrlz = signal( SIGTSTP, cleanup );
384 /* Pass input from keyboard to NINDY as it arrives.
385 * NINDY will interpret <CR> and perform echo.
388 TTY_NINDYTERM( tty );
389 ioctl( 0, TIOCSETN, &tty );
392 /* Go to sleep until there's something for us on either
393 * the remote port or stdin.
396 DEMUX_WAIT( nindy_fd );
398 /* Pass input through to correct place */
400 n = DEMUX_READ( 0, buf, sizeof(buf) );
401 if ( n ){ /* Input on stdin */
402 write( nindy_fd, buf, n );
405 n = DEMUX_READ( nindy_fd, buf, sizeof(buf) );
406 if ( n ){ /* Input on remote */
407 /* Write out any characters in buffer preceding DLE */
408 i = non_dle( buf, n );
414 /* There *was* a DLE in the buffer */
415 stop_exit = ninStopWhy( &stop_code,
416 &ip_value, &fp_value, &sp_value);
417 if ( !stop_exit && (stop_code==STOP_SRQ) ){
422 /* Get out of loop */
423 supply_register (IP_REGNUM, &ip_value);
424 supply_register (FP_REGNUM, &fp_value);
425 supply_register (SP_REGNUM, &sp_value);
432 signal( SIGINT, old_ctrlc );
434 signal( SIGTSTP, old_ctrlz );
438 if ( stop_exit ){ /* User program exited */
439 WSETEXIT( (*status), stop_code );
440 } else { /* Fault or trace */
444 /* Make it look like a VAX trace trap */
448 /* The target is not running Unix, and its
449 faults/traces do not map nicely into Unix signals.
450 Make sure they do not get confused with Unix signals
451 by numbering them with values higher than the highest
452 legal Unix signal. code in i960_print_fault(),
453 called via PRINT_RANDOM_SIGNAL, will interpret the
458 WSETSTOP( (*status), stop_code );
462 /* Read the remote registers into the block REGS. */
464 /* This is the block that ninRegsGet and ninRegsPut handles. */
466 char local_regs[16 * 4];
467 char global_regs[16 * 4];
471 char fp_as_double[4 * 8];
475 nindy_fetch_registers(regno)
478 struct nindy_regs nindy_regs;
483 ninRegsGet( (char *) &nindy_regs );
486 bcopy (nindy_regs.local_regs, ®isters[REGISTER_BYTE (R0_REGNUM)], 16*4);
487 bcopy (nindy_regs.global_regs, ®isters[REGISTER_BYTE (G0_REGNUM)], 16*4);
488 bcopy (nindy_regs.pcw_acw, ®isters[REGISTER_BYTE (PCW_REGNUM)], 2*4);
489 bcopy (nindy_regs.ip, ®isters[REGISTER_BYTE (IP_REGNUM)], 1*4);
490 bcopy (nindy_regs.tcw, ®isters[REGISTER_BYTE (TCW_REGNUM)], 1*4);
491 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
492 dub = unpack_double (builtin_type_double,
493 &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
495 /* dub now in host byte order */
496 double_to_ieee_extended (&ext_format_i960, &dub,
497 ®isters[REGISTER_BYTE (regnum)]);
500 registers_fetched ();
505 nindy_prepare_to_store()
507 nindy_fetch_registers(-1);
511 nindy_store_registers(regno)
514 struct nindy_regs nindy_regs;
518 bcopy (®isters[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16*4);
519 bcopy (®isters[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16*4);
520 bcopy (®isters[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2*4);
521 bcopy (®isters[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1*4);
522 bcopy (®isters[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1*4);
523 /* Float regs. Only works on IEEE_FLOAT hosts. */
524 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
525 ieee_extended_to_double (&ext_format_i960,
526 ®isters[REGISTER_BYTE (regnum)], &dub);
527 /* dub now in host byte order */
528 /* FIXME-someday, the arguments to unpack_double are backward.
529 It expects a target double and returns a host; we pass the opposite.
530 This mostly works but not quite. */
531 dub = unpack_double (builtin_type_double, &dub, &inv);
532 /* dub now in target byte order */
533 bcopy ((char *)&dub, &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
538 ninRegsPut( (char *) &nindy_regs );
543 /* Read a word from remote address ADDR and return it.
544 * This goes through the data cache.
547 nindy_fetch_word (addr)
550 return dcache_fetch (addr);
553 /* Write a word WORD into remote address ADDR.
554 This goes through the data cache. */
557 nindy_store_word (addr, word)
561 dcache_poke (addr, word);
564 /* Copy LEN bytes to or from inferior's memory starting at MEMADDR
565 to debugger memory starting at MYADDR. Copy to inferior if
566 WRITE is nonzero. Returns the length copied.
568 This is stolen almost directly from infptrace.c's child_xfer_memory,
569 which also deals with a word-oriented memory interface. Sometime,
570 FIXME, rewrite this to not use the word-oriented routines. */
573 nindy_xfer_inferior_memory(memaddr, myaddr, len, write, target)
578 struct target_ops *target; /* ignored */
581 /* Round starting address down to longword boundary. */
582 register CORE_ADDR addr = memaddr & - sizeof (int);
583 /* Round ending address up; get number of longwords that makes. */
585 = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
586 /* Allocate buffer of that many longwords. */
587 register int *buffer = (int *) alloca (count * sizeof (int));
591 /* Fill start and end extra bytes of buffer with existing memory data. */
593 if (addr != memaddr || len < (int)sizeof (int)) {
594 /* Need part of initial word -- fetch it. */
595 buffer[0] = nindy_fetch_word (addr);
598 if (count > 1) /* FIXME, avoid if even boundary */
601 = nindy_fetch_word (addr + (count - 1) * sizeof (int));
604 /* Copy data to be written over corresponding part of buffer */
606 bcopy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
608 /* Write the entire buffer. */
610 for (i = 0; i < count; i++, addr += sizeof (int))
613 nindy_store_word (addr, buffer[i]);
620 /* Read all the longwords */
621 for (i = 0; i < count; i++, addr += sizeof (int))
624 buffer[i] = nindy_fetch_word (addr);
630 /* Copy appropriate bytes out of the buffer. */
631 bcopy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
636 /* The data cache records all the data read from the remote machine
637 since the last time it stopped.
639 Each cache block holds 16 bytes of data
640 starting at a multiple-of-16 address. */
642 #define DCACHE_SIZE 64 /* Number of cache blocks */
644 struct dcache_block {
645 struct dcache_block *next, *last;
646 unsigned int addr; /* Address for which data is recorded. */
650 struct dcache_block dcache_free, dcache_valid;
652 /* Free all the data cache blocks, thus discarding all cached data. */
657 register struct dcache_block *db;
659 while ((db = dcache_valid.next) != &dcache_valid)
662 insque (db, &dcache_free);
667 * If addr is present in the dcache, return the address of the block
671 struct dcache_block *
675 register struct dcache_block *db;
680 /* Search all cache blocks for one that is at this address. */
681 db = dcache_valid.next;
682 while (db != &dcache_valid)
684 if ((addr & 0xfffffff0) == db->addr)
691 /* Return the int data at address ADDR in dcache block DC. */
694 dcache_value (db, addr)
695 struct dcache_block *db;
700 return (db->data[(addr>>2)&3]);
703 /* Get a free cache block, put or keep it on the valid list,
704 and return its address. The caller should store into the block
705 the address and data that it describes, then remque it from the
706 free list and insert it into the valid list. This procedure
707 prevents errors from creeping in if a ninMemGet is interrupted
708 (which used to put garbage blocks in the valid list...). */
710 struct dcache_block *
713 register struct dcache_block *db;
715 if ((db = dcache_free.next) == &dcache_free)
717 /* If we can't get one from the free list, take last valid and put
718 it on the free list. */
719 db = dcache_valid.last;
721 insque (db, &dcache_free);
725 insque (db, &dcache_valid);
729 /* Return the contents of the word at address ADDR in the remote machine,
730 using the data cache. */
736 register struct dcache_block *db;
738 db = dcache_hit (addr);
741 db = dcache_alloc ();
743 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
745 db->addr = addr & ~0xf;
746 remque (db); /* Off the free list */
747 insque (db, &dcache_valid); /* On the valid list */
749 return (dcache_value (db, addr));
752 /* Write the word at ADDR both in the data cache and in the remote machine. */
754 dcache_poke (addr, data)
758 register struct dcache_block *db;
760 /* First make sure the word is IN the cache. DB is its cache block. */
761 db = dcache_hit (addr);
764 db = dcache_alloc ();
766 ninMemGet(addr & ~0xf, (unsigned char *)db->data, 16);
768 db->addr = addr & ~0xf;
769 remque (db); /* Off the free list */
770 insque (db, &dcache_valid); /* On the valid list */
773 /* Modify the word in the cache. */
774 db->data[(addr>>2)&3] = data;
776 /* Send the changed word. */
778 ninMemPut(addr, (unsigned char *)&data, 4);
782 /* The cache itself. */
783 struct dcache_block the_cache[DCACHE_SIZE];
785 /* Initialize the data cache. */
790 register struct dcache_block *db;
793 dcache_free.next = dcache_free.last = &dcache_free;
794 dcache_valid.next = dcache_valid.last = &dcache_valid;
795 for (i=0;i<DCACHE_SIZE;i++,db++)
796 insque (db, &dcache_free);
801 nindy_create_inferior (execfile, args, env)
810 error ("Can't pass arguments to remote NINDY process");
812 if (execfile == 0 || exec_bfd == 0)
813 error ("No exec file specified");
815 entry_pt = (int) bfd_get_start_address (exec_bfd);
819 #ifdef CREATE_INFERIOR_HOOK
820 CREATE_INFERIOR_HOOK (pid);
823 /* The "process" (board) is already stopped awaiting our commands, and
824 the program is already downloaded. We just set its PC and go. */
826 inferior_pid = pid; /* Needed for wait_for_inferior below */
828 clear_proceed_status ();
830 /* Tell wait_for_inferior that we've started a new process. */
831 init_wait_for_inferior ();
833 /* Set up the "saved terminal modes" of the inferior
834 based on what modes we are starting it with. */
835 target_terminal_init ();
837 /* Install inferior's terminal modes. */
838 target_terminal_inferior ();
840 /* insert_step_breakpoint (); FIXME, do we need this? */
841 proceed ((CORE_ADDR)entry_pt, -1, 0); /* Let 'er rip... */
845 reset_command(args, from_tty)
850 error( "No target system to reset -- use 'target nindy' command.");
852 if ( query("Really reset the target system?",0,0) ){
853 send_break( nindy_fd );
854 tty_flush( nindy_fd );
859 nindy_kill (args, from_tty)
863 return; /* Ignore attempts to kill target system */
866 /* Clean up when a program exits.
868 The program actually lives on in the remote processor's RAM, and may be
869 run again without a download. Don't leave it full of breakpoint
873 nindy_mourn_inferior ()
875 remove_breakpoints ();
876 generic_mourn_inferior (); /* Do all the proper things now */
879 /* This routine is run as a hook, just before the main command loop is
880 entered. If gdb is configured for the i960, but has not had its
881 nindy target specified yet, this will loop prompting the user to do so.
883 Unlike the loop provided by Intel, we actually let the user get out
884 of this with a RETURN. This is useful when e.g. simply examining
885 an i960 object file on the host system. */
887 nindy_before_main_loop ()
892 setjmp(to_top_level);
893 while (current_target != &nindy_ops) { /* remote tty not specified yet */
894 if ( instream == stdin ){
895 printf("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit: ");
898 fgets( ttyname, sizeof(ttyname)-1, stdin );
900 /* Strip leading and trailing whitespace */
901 for ( p = ttyname; isspace(*p); p++ ){
905 return; /* User just hit spaces or return, wants out */
907 for ( p2= p; !isspace(*p2) && (*p2 != '\0'); p2++ ){
911 if ( !strcmp("quit",p) ){
917 /* Now that we have a tty open for talking to the remote machine,
918 download the executable file if one was specified. */
919 if ( !setjmp(to_top_level) && exec_bfd ) {
920 target_load (bfd_get_filename (exec_bfd), 1);
925 /* Define the target subroutine names */
927 struct target_ops nindy_ops = {
928 "nindy", "Remote serial target in i960 NINDY-specific protocol",
929 "Use a remote i960 system running NINDY connected by a serial line.\n\
930 Specify the name of the device the serial line is connected to.\n\
931 The speed (baud rate), whether to use the old NINDY protocol,\n\
932 and whether to send a break on startup, are controlled by options\n\
933 specified when you started GDB.",
934 nindy_open, nindy_close,
935 0, nindy_detach, nindy_resume, nindy_wait,
936 nindy_fetch_registers, nindy_store_registers,
937 nindy_prepare_to_store, 0, 0, /* conv_from, conv_to */
938 nindy_xfer_inferior_memory, nindy_files_info,
939 0, 0, /* insert_breakpoint, remove_breakpoint, */
940 0, 0, 0, 0, 0, /* Terminal crud */
943 0, /* lookup_symbol */
944 nindy_create_inferior,
945 nindy_mourn_inferior,
946 process_stratum, 0, /* next */
947 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
948 0, 0, /* Section pointers */
949 OPS_MAGIC, /* Always the last thing */
955 add_target (&nindy_ops);
956 add_com ("reset", class_obscure, reset_command,
957 "Send a 'break' to the remote target system.\n\
958 Only useful if the target has been equipped with a circuit\n\
959 to perform a hard reset when a break is detected.");