1 /* Memory-access and commands for remote NINDY process, for GDB.
2 Copyright (C) 1990-1991 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>
106 #include "inferior.h"
111 #include "ieee-float.h"
114 #include <sys/ioctl.h>
115 #include <sys/file.h>
117 #include "nindy-share/ttycntl.h"
118 #include "nindy-share/demux.h"
119 #include "nindy-share/env.h"
120 #include "nindy-share/stop.h"
123 extern char *getenv();
124 extern char *mktemp();
126 extern char *coffstrip();
127 extern void add_syms_addr_command ();
128 extern value call_function_by_hand ();
129 extern void generic_mourn_inferior ();
131 extern struct target_ops nindy_ops;
132 extern jmp_buf to_top_level;
133 extern FILE *instream;
134 extern struct ext_format ext_format_i960[]; /* i960-tdep.c */
136 extern char ninStopWhy ();
138 int nindy_initial_brk; /* nonzero if want to send an initial BREAK to nindy */
139 int nindy_old_protocol; /* nonzero if want to use old protocol */
140 char *nindy_ttyname; /* name of tty to talk to nindy on, or null */
142 #define DLE '\020' /* Character NINDY sends to indicate user program has
147 int nindy_fd = 0; /* Descriptor for I/O to NINDY */
148 static int have_regs = 0; /* 1 iff regs read since i960 last halted */
149 static int regs_changed = 0; /* 1 iff regs were modified since last read */
151 extern char *exists();
152 static void dcache_flush (), dcache_poke (), dcache_init();
153 static int dcache_fetch ();
155 /* FIXME, we can probably use the normal terminal_inferior stuff here.
156 We have to do terminal_inferior and then set up the passthrough
157 settings initially. Thereafter, terminal_ours and terminal_inferior
158 will automatically swap the settings around for us. */
160 /* Restore TTY to normal operation */
162 static TTY_STRUCT orig_tty; /* TTY attributes before entering passthrough */
167 ioctl( 0, TIOCSETN, &orig_tty );
171 /* Recover from ^Z or ^C while remote process is running */
173 static void (*old_ctrlc)(); /* Signal handlers before entering passthrough */
176 static void (*old_ctrlz)();
186 signal(SIGINT, old_ctrlc);
188 signal(SIGTSTP, old_ctrlz);
190 error("\n\nYou may need to reset the 80960 and/or reload your program.\n");
193 /* Clean up anything that needs cleaning when losing control. */
195 static char *savename;
198 nindy_close (quitting)
210 /* Open a connection to a remote debugger.
211 FIXME, there should be a way to specify the various options that are
212 now specified with gdb command-line options. (baud_rate, old_protocol,
215 nindy_open (name, from_tty)
216 char *name; /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
221 error_no_arg ("serial port device name");
225 have_regs = regs_changed = 0;
228 /* Allow user to interrupt the following -- we could hang if
229 * there's no NINDY at the other end of the remote tty.
232 nindy_fd = ninConnect( name, baud_rate? baud_rate: "9600",
233 nindy_initial_brk, !from_tty, nindy_old_protocol );
238 error( "Can't open tty '%s'", name );
241 savename = savestring (name, strlen (name));
242 push_target (&nindy_ops);
243 target_fetch_registers(-1);
246 /* User-initiated quit of nindy operations. */
249 nindy_detach (name, from_tty)
254 error ("Too many arguments");
261 printf("\tAttached to %s at %s bps%s%s.\n", savename,
262 baud_rate? baud_rate: "9600",
263 nindy_old_protocol? " in old protocol": "",
264 nindy_initial_brk? " with initial break": "");
267 /******************************************************************************
269 * Download an object file to the remote system by invoking the "comm960"
270 * utility. We look for "comm960" in $G960BIN, $G960BASE/bin, and
271 * DEFAULT_BASE/bin/HOST/bin where
272 * DEFAULT_BASE is defined in env.h, and
273 * HOST must be defined on the compiler invocation line.
274 ******************************************************************************/
277 nindy_load( filename, from_tty )
282 struct cleanup *old_chain;
283 char *scratch_pathname;
287 filename = get_exec_file (1);
289 filename = tilde_expand (filename);
290 make_cleanup (free, filename);
292 scratch_chan = openp (getenv ("PATH"), 1, filename, O_RDONLY, 0,
294 if (scratch_chan < 0)
295 perror_with_name (filename);
296 close (scratch_chan); /* Slightly wasteful FIXME */
298 have_regs = regs_changed = 0;
299 mark_breakpoints_out();
303 tmpfile = coffstrip(scratch_pathname);
305 old_chain = make_cleanup(unlink,tmpfile);
307 ninDownload( tmpfile, !from_tty );
308 /* FIXME, don't we want this merged in here? */
310 do_cleanups (old_chain);
316 /* Return the number of characters in the buffer before the first DLE character.
322 char *buf; /* Character buffer; NOT '\0'-terminated */
323 int n; /* Number of characters in buffer */
327 for ( i = 0; i < n; i++ ){
328 if ( buf[i] == DLE ){
335 /* Tell the remote machine to resume. */
338 nindy_resume (step, siggnal)
341 if (siggnal != 0 && siggnal != stop_signal)
342 error ("Can't send signals to remote NINDY targets.");
346 nindy_store_registers ();
353 /* Wait until the remote machine stops. While waiting, operate in passthrough
354 * mode; i.e., pass everything NINDY sends to stdout, and everything from
357 * Return to caller, storing status in 'status' just as `wait' would.
364 DEMUX_DECL; /* OS-dependent data needed by DEMUX... macros */
365 char buf[500]; /* FIXME, what is "500" here? */
367 unsigned char stop_exit;
368 unsigned char stop_code;
370 long ip_value, fp_value, sp_value; /* Reg values from stop */
373 WSETEXIT( (*status), 0 );
375 /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */
377 /* Save current tty attributes, set up signals to restore them.
379 ioctl( 0, TIOCGETP, &orig_tty );
380 old_ctrlc = signal( SIGINT, cleanup );
382 old_ctrlz = signal( SIGTSTP, cleanup );
385 /* Pass input from keyboard to NINDY as it arrives.
386 * NINDY will interpret <CR> and perform echo.
389 TTY_NINDYTERM( tty );
390 ioctl( 0, TIOCSETN, &tty );
393 /* Go to sleep until there's something for us on either
394 * the remote port or stdin.
397 DEMUX_WAIT( nindy_fd );
399 /* Pass input through to correct place */
401 n = DEMUX_READ( 0, buf, sizeof(buf) );
402 if ( n ){ /* Input on stdin */
403 write( nindy_fd, buf, n );
406 n = DEMUX_READ( nindy_fd, buf, sizeof(buf) );
407 if ( n ){ /* Input on remote */
408 /* Write out any characters in buffer preceding DLE */
409 i = non_dle( buf, n );
415 /* There *was* a DLE in the buffer */
416 stop_exit = ninStopWhy( &stop_code,
417 &ip_value, &fp_value, &sp_value);
418 if ( !stop_exit && (stop_code==STOP_SRQ) ){
423 /* Get out of loop */
424 supply_register (IP_REGNUM, &ip_value);
425 supply_register (FP_REGNUM, &fp_value);
426 supply_register (SP_REGNUM, &sp_value);
433 signal( SIGINT, old_ctrlc );
435 signal( SIGTSTP, old_ctrlz );
439 if ( stop_exit ){ /* User program exited */
440 WSETEXIT( (*status), stop_code );
441 } else { /* Fault or trace */
445 /* Make it look like a VAX trace trap */
449 /* The target is not running Unix, and its
450 faults/traces do not map nicely into Unix signals.
451 Make sure they do not get confused with Unix signals
452 by numbering them with values higher than the highest
453 legal Unix signal. code in i960_print_fault(),
454 called via PRINT_RANDOM_SIGNAL, will interpret the
459 WSETSTOP( (*status), stop_code );
463 /* Read the remote registers into the block REGS. */
465 /* This is the block that ninRegsGet and ninRegsPut handles. */
467 char local_regs[16 * 4];
468 char global_regs[16 * 4];
472 char fp_as_double[4 * 8];
476 nindy_fetch_registers(regno)
479 struct nindy_regs nindy_regs;
484 ninRegsGet( (char *) &nindy_regs );
487 bcopy (nindy_regs.local_regs, ®isters[REGISTER_BYTE (R0_REGNUM)], 16*4);
488 bcopy (nindy_regs.global_regs, ®isters[REGISTER_BYTE (G0_REGNUM)], 16*4);
489 bcopy (nindy_regs.pcw_acw, ®isters[REGISTER_BYTE (PCW_REGNUM)], 2*4);
490 bcopy (nindy_regs.ip, ®isters[REGISTER_BYTE (IP_REGNUM)], 1*4);
491 bcopy (nindy_regs.tcw, ®isters[REGISTER_BYTE (TCW_REGNUM)], 1*4);
492 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
493 dub = unpack_double (builtin_type_double,
494 &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
496 /* dub now in host byte order */
497 double_to_ieee_extended (ext_format_i960, &dub,
498 ®isters[REGISTER_BYTE (regnum)]);
501 registers_fetched ();
506 nindy_prepare_to_store()
508 nindy_fetch_registers(-1);
512 nindy_store_registers(regno)
515 struct nindy_regs nindy_regs;
519 bcopy (®isters[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16*4);
520 bcopy (®isters[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16*4);
521 bcopy (®isters[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2*4);
522 bcopy (®isters[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1*4);
523 bcopy (®isters[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1*4);
524 /* Float regs. Only works on IEEE_FLOAT hosts. */
525 for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
526 ieee_extended_to_double (ext_format_i960,
527 ®isters[REGISTER_BYTE (regnum)], &dub);
528 /* dub now in host byte order */
529 /* FIXME-someday, the arguments to unpack_double are backward.
530 It expects a target double and returns a host; we pass the opposite.
531 This mostly works but not quite. */
532 dub = unpack_double (builtin_type_double, &dub, &inv);
533 /* dub now in target byte order */
534 bcopy ((char *)&dub, &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
539 ninRegsPut( (char *) &nindy_regs );
544 /* Read a word from remote address ADDR and return it.
545 * This goes through the data cache.
548 nindy_fetch_word (addr)
551 return dcache_fetch (addr);
554 /* Write a word WORD into remote address ADDR.
555 This goes through the data cache. */
558 nindy_store_word (addr, word)
562 dcache_poke (addr, word);
565 /* Copy LEN bytes to or from inferior's memory starting at MEMADDR
566 to debugger memory starting at MYADDR. Copy to inferior if
567 WRITE is nonzero. Returns the length copied.
569 This is stolen almost directly from infptrace.c's child_xfer_memory,
570 which also deals with a word-oriented memory interface. Sometime,
571 FIXME, rewrite this to not use the word-oriented routines. */
574 nindy_xfer_inferior_memory(memaddr, myaddr, len, write)
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 #if defined (START_INFERIOR_HOOK)
831 START_INFERIOR_HOOK ();
834 /* Tell wait_for_inferior that we've started a new process. */
835 init_wait_for_inferior ();
837 /* Set up the "saved terminal modes" of the inferior
838 based on what modes we are starting it with. */
839 target_terminal_init ();
841 /* Install inferior's terminal modes. */
842 target_terminal_inferior ();
844 /* remote_start(args); */
845 /* trap_expected = 0; */
846 /* insert_step_breakpoint (); FIXME, do we need this? */
847 proceed ((CORE_ADDR)entry_pt, -1, 0); /* Let 'er rip... */
851 reset_command(args, from_tty)
856 error( "No target system to reset -- use 'target nindy' command.");
858 if ( query("Really reset the target system?",0,0) ){
859 send_break( nindy_fd );
860 tty_flush( nindy_fd );
865 nindy_kill (args, from_tty)
869 return; /* Ignore attempts to kill target system */
872 /* Clean up when a program exits.
874 The program actually lives on in the remote processor's RAM, and may be
875 run again without a download. Don't leave it full of breakpoint
879 nindy_mourn_inferior ()
881 remove_breakpoints ();
882 generic_mourn_inferior (); /* Do all the proper things now */
885 /* This routine is run as a hook, just before the main command loop is
886 entered. If gdb is configured for the i960, but has not had its
887 nindy target specified yet, this will loop prompting the user to do so.
889 Unlike the loop provided by Intel, we actually let the user get out
890 of this with a RETURN. This is useful when e.g. simply examining
891 an i960 object file on the host system. */
893 nindy_before_main_loop ()
898 setjmp(to_top_level);
899 while (current_target != &nindy_ops) { /* remote tty not specified yet */
900 if ( instream == stdin ){
901 printf("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit: ");
904 fgets( ttyname, sizeof(ttyname)-1, stdin );
906 /* Strip leading and trailing whitespace */
907 for ( p = ttyname; isspace(*p); p++ ){
911 return; /* User just hit spaces or return, wants out */
913 for ( p2= p; !isspace(*p2) && (*p2 != '\0'); p2++ ){
917 if ( !strcmp("quit",p) ){
923 /* Now that we have a tty open for talking to the remote machine,
924 download the executable file if one was specified. */
925 if ( !setjmp(to_top_level) && exec_bfd ) {
926 target_load (bfd_get_filename (exec_bfd), 1);
931 /* Define the target subroutine names */
933 struct target_ops nindy_ops = {
934 "nindy", "Remote serial target in i960 NINDY-specific protocol",
935 nindy_open, nindy_close,
936 0, nindy_detach, nindy_resume, nindy_wait,
937 nindy_fetch_registers, nindy_store_registers,
938 nindy_prepare_to_store, 0, 0, /* conv_from, conv_to */
939 nindy_xfer_inferior_memory, nindy_files_info,
940 0, 0, /* insert_breakpoint, remove_breakpoint, */
941 0, 0, 0, 0, 0, /* Terminal crud */
943 nindy_load, add_syms_addr_command,
944 call_function_by_hand,
945 0, /* lookup_symbol */
946 nindy_create_inferior,
947 nindy_mourn_inferior,
948 process_stratum, 0, /* next */
949 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
950 OPS_MAGIC, /* Always the last thing */
956 add_target (&nindy_ops);
957 add_com ("reset", class_obscure, reset_command,
958 "Send a 'break' to the remote target system.\n\
959 Only useful if the target has been equipped with a circuit\n\
960 to perform a hard reset when a break is detected.");