[deliverable/binutils-gdb.git] / gdb / remote-nindy.c

/* Memory-access and commands for remote NINDY process, for GDB.
   Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   Contributed by Intel Corporation.  Modified from remote.c by Chris Benenati.

GDB is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY.  No author or distributor accepts responsibility to anyone
for the consequences of using it or for whether it serves any
particular purpose or works at all, unless he says so in writing.
Refer to the GDB General Public License for full details.

Everyone is granted permission to copy, modify and redistribute GDB,
but only under the conditions described in the GDB General Public
License.  A copy of this license is supposed to have been given to you
along with GDB so you can know your rights and responsibilities.  It
should be in a file named COPYING.  Among other things, the copyright
notice and this notice must be preserved on all copies.

In other words, go ahead and share GDB, but don't try to stop
anyone else from sharing it farther.  Help stamp out software hoarding!
*/

/*
Except for the data cache routines, this file bears little resemblence
to remote.c.  A new (although similar) protocol has been specified, and
portions of the code are entirely dependent on having an i80960 with a
NINDY ROM monitor at the other end of the line.
*/

/*****************************************************************************
 *
 * REMOTE COMMUNICATION PROTOCOL BETWEEN GDB960 AND THE NINDY ROM MONITOR.
 *
 *
 * MODES OF OPERATION
 * ----- -- ---------
 *      
 * As far as NINDY is concerned, GDB is always in one of two modes: command
 * mode or passthrough mode.
 *
 * In command mode (the default) pre-defined packets containing requests
 * are sent by GDB to NINDY.  NINDY never talks except in reponse to a request.
 *
 * Once the the user program is started, GDB enters passthrough mode, to give
 * the user program access to the terminal.  GDB remains in this mode until
 * NINDY indicates that the program has stopped.
 *
 *
 * PASSTHROUGH MODE
 * ----------- ----
 *
 * GDB writes all input received from the keyboard directly to NINDY, and writes
 * all characters received from NINDY directly to the monitor.
 *
 * Keyboard input is neither buffered nor echoed to the monitor.
 *
 * GDB remains in passthrough mode until NINDY sends a single ^P character,
 * to indicate that the user process has stopped.
 *
 * Note:
 *      GDB assumes NINDY performs a 'flushreg' when the user program stops.
 *
 *
 * COMMAND MODE
 * ------- ----
 *
 * All info (except for message ack and nak) is transferred between gdb
 * and the remote processor in messages of the following format:
 *
 *              <info>#<checksum>
 *
 * where 
 *      #       is a literal character
 *
 *      <info>  ASCII information;  all numeric information is in the
 *              form of hex digits ('0'-'9' and lowercase 'a'-'f').
 *
 *      <checksum>
 *              is a pair of ASCII hex digits representing an 8-bit
 *              checksum formed by adding together each of the
 *              characters in <info>.
 *
 * The receiver of a message always sends a single character to the sender
 * to indicate that the checksum was good ('+') or bad ('-');  the sender
 * re-transmits the entire message over until a '+' is received.
 *
 * In response to a command NINDY always sends back either data or
 * a result code of the form "Xnn", where "nn" are hex digits and "X00"
 * means no errors.  (Exceptions: the "s" and "c" commands don't respond.)
 *
 * SEE THE HEADER OF THE FILE "gdb.c" IN THE NINDY MONITOR SOURCE CODE FOR A
 * FULL DESCRIPTION OF LEGAL COMMANDS.
 *
 * SEE THE FILE "stop.h" IN THE NINDY MONITOR SOURCE CODE FOR A LIST
 * OF STOP CODES.
 *
 ***************************************************************************/

#include "defs.h"
#include <signal.h>
#include <sys/types.h>
#include <setjmp.h>

#include "frame.h"
#include "inferior.h"
#include "bfd.h"
#include "symfile.h"
#include "target.h"
#include "gdbcore.h"
#include "command.h"
#include "ieee-float.h"

#include "wait.h"
#include <sys/file.h>
#include <ctype.h>
#include "serial.h"
#include "nindy-share/env.h"
#include "nindy-share/stop.h"

#include "dcache.h"
#include "remote-utils.h"

static DCACHE *nindy_dcache;

extern int unlink();
extern char *getenv();
extern char *mktemp();

extern void generic_mourn_inferior ();

extern struct target_ops nindy_ops;
extern FILE *instream;
extern struct ext_format ext_format_i960;       /* i960-tdep.c */

extern char ninStopWhy ();

int nindy_initial_brk;  /* nonzero if want to send an initial BREAK to nindy */
int nindy_old_protocol; /* nonzero if want to use old protocol */
char *nindy_ttyname;    /* name of tty to talk to nindy on, or null */

#define DLE     '\020'  /* Character NINDY sends to indicate user program has
                         * halted.  */
#define TRUE    1
#define FALSE   0

/* From nindy-share/nindy.c.  */
extern serial_t nindy_serial;

static int have_regs = 0;       /* 1 iff regs read since i960 last halted */
static int regs_changed = 0;    /* 1 iff regs were modified since last read */

extern char *exists();

static void
nindy_fetch_registers PARAMS ((int));

static void
nindy_store_registers PARAMS ((int));
\f
static char *savename;

static void
nindy_close (quitting)
     int quitting;
{
  if (nindy_serial != NULL)
    SERIAL_CLOSE (nindy_serial);
  nindy_serial = NULL;

  if (savename)
    free (savename);
  savename = 0;
}

/* Open a connection to a remote debugger.   
   FIXME, there should be a way to specify the various options that are
   now specified with gdb command-line options.  (baud_rate, old_protocol,
   and initial_brk)  */
void
nindy_open (name, from_tty)
    char *name;         /* "/dev/ttyXX", "ttyXX", or "XX": tty to be opened */
    int from_tty;
{
  char baudrate[1024];

  if (!name)
    error_no_arg ("serial port device name");

  target_preopen (from_tty);
  
  nindy_close (0);

  have_regs = regs_changed = 0;
  nindy_dcache = dcache_init(ninMemGet, ninMemPut);

  /* Allow user to interrupt the following -- we could hang if there's
     no NINDY at the other end of the remote tty.  */
  immediate_quit++;
  sprintf(baudrate, "%d", sr_get_baud_rate());
  ninConnect(name, baudrate,
             nindy_initial_brk, !from_tty, nindy_old_protocol);
  immediate_quit--;

  if (nindy_serial == NULL)
    {
      perror_with_name (name);
    }

  savename = savestring (name, strlen (name));
  push_target (&nindy_ops);
  target_fetch_registers(-1);
}

/* User-initiated quit of nindy operations.  */

static void
nindy_detach (name, from_tty)
     char *name;
     int from_tty;
{
  if (name)
    error ("Too many arguments");
  pop_target ();
}

static void
nindy_files_info ()
{
  printf("\tAttached to %s at %d bps%s%s.\n", savename,
         sr_get_baud_rate(),
         nindy_old_protocol? " in old protocol": "",
         nindy_initial_brk? " with initial break": "");
}
\f
/* Return the number of characters in the buffer before
   the first DLE character.  */

static
int
non_dle( buf, n )
    char *buf;          /* Character buffer; NOT '\0'-terminated */
    int n;              /* Number of characters in buffer */
{
        int i;

        for ( i = 0; i < n; i++ ){
                if ( buf[i] == DLE ){
                        break;
                }
        }
        return i;
}
\f
/* Tell the remote machine to resume.  */

void
nindy_resume (pid, step, siggnal)
     int pid, step, siggnal;
{
        if (siggnal != 0 && siggnal != stop_signal)
          error ("Can't send signals to remote NINDY targets.");

        dcache_flush(nindy_dcache);
        if ( regs_changed ){
                nindy_store_registers (-1);
                regs_changed = 0;
        }
        have_regs = 0;
        ninGo( step );
}
\f
/* FIXME, we can probably use the normal terminal_inferior stuff here.
   We have to do terminal_inferior and then set up the passthrough
   settings initially.  Thereafter, terminal_ours and terminal_inferior
   will automatically swap the settings around for us.  */

struct clean_up_tty_args {
  serial_ttystate state;
  serial_t serial;
};

static void
clean_up_tty (ptrarg)
     PTR ptrarg;
{
  struct clean_up_tty_args *args = (struct clean_up_tty_args *) ptrarg;
  SERIAL_SET_TTY_STATE (args->serial, args->state);
  free (args->state);
  warning ("\n\n\
You may need to reset the 80960 and/or reload your program.\n");
}

/* Wait until the remote machine stops. While waiting, operate in passthrough
 * mode; i.e., pass everything NINDY sends to stdout, and everything from
 * stdin to NINDY.
 *
 * Return to caller, storing status in 'status' just as `wait' would.
 */

static int
nindy_wait( status )
    WAITTYPE *status;
{
  fd_set fds;
  char buf[500];        /* FIXME, what is "500" here? */
  int i, n;
  unsigned char stop_exit;
  unsigned char stop_code;
  struct clean_up_tty_args tty_args;
  struct cleanup *old_cleanups;
  long ip_value, fp_value, sp_value;    /* Reg values from stop */

  WSETEXIT( (*status), 0 );

  /* OPERATE IN PASSTHROUGH MODE UNTIL NINDY SENDS A DLE CHARACTER */

  /* Save current tty attributes, and restore them when done.  */
  tty_args.serial = SERIAL_FDOPEN (0);
  tty_args.state = SERIAL_GET_TTY_STATE (tty_args.serial);
  old_cleanups = make_cleanup (clean_up_tty, &tty_args);

  /* Pass input from keyboard to NINDY as it arrives.  NINDY will interpret
     <CR> and perform echo.  */
  /* This used to set CBREAK and clear ECHO and CRMOD.  I hope this is close
     enough.  */
  SERIAL_RAW (tty_args.serial);

  while (1)
    {
      /* Wait for input on either the remote port or stdin.  */
      FD_ZERO (&fds);
      FD_SET (0, &fds);
      FD_SET (nindy_serial->fd, &fds);
      if (select (nindy_serial->fd + 1, &fds, 0, 0, 0) <= 0)
        continue;

      /* Pass input through to correct place */
      if (FD_ISSET (0, &fds))
        {
          /* Input on stdin */
          n = read (0, buf, sizeof (buf));
          if (n)
            {
              SERIAL_WRITE (nindy_serial, buf, n );
            }
        }

      if (FD_ISSET (nindy_serial->fd, &fds))
        {
          /* Input on remote */
          n = read (nindy_serial->fd, buf, sizeof (buf));
          if (n)
            {
              /* Write out any characters in buffer preceding DLE */
              i = non_dle( buf, n );
              if ( i > 0 )
                {
                  write (1, buf, i);
                }

              if (i != n)
                {
                  /* There *was* a DLE in the buffer */
                  stop_exit = ninStopWhy(&stop_code,
                                         &ip_value, &fp_value, &sp_value);
                  if (!stop_exit && (stop_code == STOP_SRQ))
                    {
                      immediate_quit++;
                      ninSrq();
                      immediate_quit--;
                    }
                  else
                    {
                      /* Get out of loop */
                      supply_register (IP_REGNUM, 
                                       (char *)&ip_value);
                      supply_register (FP_REGNUM, 
                                       (char *)&fp_value);
                      supply_register (SP_REGNUM, 
                                       (char *)&sp_value);
                      break;
                    }
                }
            }
        }
    }

  do_cleanups (old_cleanups);

  if (stop_exit)
    {
      /* User program exited */
      WSETEXIT ((*status), stop_code);
    }
  else
    {
      /* Fault or trace */
      switch (stop_code)
        {
        case STOP_GDB_BPT:
        case TRACE_STEP:
          /* Breakpoint or single stepping.  */
          stop_code = SIGTRAP;
          break;
        default:
          /* The target is not running Unix, and its faults/traces do
             not map nicely into Unix signals.  Make sure they do not
             get confused with Unix signals by numbering them with
             values higher than the highest legal Unix signal.  code
             in i960_print_fault(), called via PRINT_RANDOM_SIGNAL,
             will interpret the value.  */
          stop_code += NSIG;
          break;
        }
      WSETSTOP ((*status), stop_code);
    }
  return inferior_pid;
}

/* Read the remote registers into the block REGS.  */

/* This is the block that ninRegsGet and ninRegsPut handles.  */
struct nindy_regs {
  char  local_regs[16 * 4];
  char  global_regs[16 * 4];
  char  pcw_acw[2 * 4];
  char  ip[4];
  char  tcw[4];
  char  fp_as_double[4 * 8];
};

static void
nindy_fetch_registers(regno)
     int regno;
{
  struct nindy_regs nindy_regs;
  int regnum, inv;
  double dub;

  immediate_quit++;
  ninRegsGet( (char *) &nindy_regs );
  immediate_quit--;

  memcpy (&registers[REGISTER_BYTE (R0_REGNUM)], nindy_regs.local_regs, 16*4);
  memcpy (&registers[REGISTER_BYTE (G0_REGNUM)], nindy_regs.global_regs, 16*4);
  memcpy (&registers[REGISTER_BYTE (PCW_REGNUM)], nindy_regs.pcw_acw, 2*4);
  memcpy (&registers[REGISTER_BYTE (IP_REGNUM)], nindy_regs.ip, 1*4);
  memcpy (&registers[REGISTER_BYTE (TCW_REGNUM)], nindy_regs.tcw, 1*4);
  for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
    dub = unpack_double (builtin_type_double,
                         &nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)],
                         &inv);
    /* dub now in host byte order */
    double_to_ieee_extended (&ext_format_i960, &dub,
                             &registers[REGISTER_BYTE (regnum)]);
  }

  registers_fetched ();
}

static void
nindy_prepare_to_store()
{
  /* Fetch all regs if they aren't already here.  */
  read_register_bytes (0, NULL, REGISTER_BYTES);
}

static void
nindy_store_registers(regno)
     int regno;
{
  struct nindy_regs nindy_regs;
  int regnum, inv;
  double dub;

  memcpy (nindy_regs.local_regs, &registers[REGISTER_BYTE (R0_REGNUM)], 16*4);
  memcpy (nindy_regs.global_regs, &registers[REGISTER_BYTE (G0_REGNUM)], 16*4);
  memcpy (nindy_regs.pcw_acw, &registers[REGISTER_BYTE (PCW_REGNUM)], 2*4);
  memcpy (nindy_regs.ip, &registers[REGISTER_BYTE (IP_REGNUM)], 1*4);
  memcpy (nindy_regs.tcw, &registers[REGISTER_BYTE (TCW_REGNUM)], 1*4);
  /* Float regs.  Only works on IEEE_FLOAT hosts.  FIXME!  */
  for (regnum = FP0_REGNUM; regnum < FP0_REGNUM + 4; regnum++) {
    ieee_extended_to_double (&ext_format_i960,
                             &registers[REGISTER_BYTE (regnum)], &dub);
    /* dub now in host byte order */
    /* FIXME-someday, the arguments to unpack_double are backward.
       It expects a target double and returns a host; we pass the opposite.
       This mostly works but not quite.  */
    dub = unpack_double (builtin_type_double, (char *)&dub, &inv);
    /* dub now in target byte order */
    memcpy (&nindy_regs.fp_as_double[8 * (regnum - FP0_REGNUM)], &dub, 8);
  }

  immediate_quit++;
  ninRegsPut( (char *) &nindy_regs );
  immediate_quit--;
}

/* Read a word from remote address ADDR and return it.
 * This goes through the data cache.
 */
int
nindy_fetch_word (addr)
     CORE_ADDR addr;
{
        return dcache_fetch (nindy_dcache, addr);
}

/* Write a word WORD into remote address ADDR.
   This goes through the data cache.  */

void
nindy_store_word (addr, word)
     CORE_ADDR addr;
     int word;
{
        dcache_poke (nindy_dcache, addr, word);
}

/* Copy LEN bytes to or from inferior's memory starting at MEMADDR
   to debugger memory starting at MYADDR.   Copy to inferior if
   WRITE is nonzero.  Returns the length copied.

   This is stolen almost directly from infptrace.c's child_xfer_memory,
   which also deals with a word-oriented memory interface.  Sometime,
   FIXME, rewrite this to not use the word-oriented routines.  */

int
nindy_xfer_inferior_memory(memaddr, myaddr, len, write, target)
     CORE_ADDR memaddr;
     char *myaddr;
     int len;
     int write;
     struct target_ops *target;                 /* ignored */
{
  register int i;
  /* Round starting address down to longword boundary.  */
  register CORE_ADDR addr = memaddr & - sizeof (int);
  /* Round ending address up; get number of longwords that makes.  */
  register int count
    = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
  /* Allocate buffer of that many longwords.  */
  register int *buffer = (int *) alloca (count * sizeof (int));

  if (write)
    {
      /* Fill start and end extra bytes of buffer with existing memory data.  */

      if (addr != memaddr || len < (int)sizeof (int)) {
        /* Need part of initial word -- fetch it.  */
        buffer[0] = nindy_fetch_word (addr);
      }

      if (count > 1)            /* FIXME, avoid if even boundary */
        {
          buffer[count - 1]
            = nindy_fetch_word (addr + (count - 1) * sizeof (int));
        }

      /* Copy data to be written over corresponding part of buffer */

      memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);

      /* Write the entire buffer.  */

      for (i = 0; i < count; i++, addr += sizeof (int))
        {
          errno = 0;
          nindy_store_word (addr, buffer[i]);
          if (errno)
            return 0;
        }
    }
  else
    {
      /* Read all the longwords */
      for (i = 0; i < count; i++, addr += sizeof (int))
        {
          errno = 0;
          buffer[i] = nindy_fetch_word (addr);
          if (errno)
            return 0;
          QUIT;
        }

      /* Copy appropriate bytes out of the buffer.  */
      memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
    }
  return len;
}
\f
static void
nindy_create_inferior (execfile, args, env)
     char *execfile;
     char *args;
     char **env;
{
  int entry_pt;
  int pid;

  if (args && *args)
    error ("Can't pass arguments to remote NINDY process");

  if (execfile == 0 || exec_bfd == 0)
    error ("No exec file specified");

  entry_pt = (int) bfd_get_start_address (exec_bfd);

  pid = 42;

#ifdef CREATE_INFERIOR_HOOK
  CREATE_INFERIOR_HOOK (pid);
#endif  

/* The "process" (board) is already stopped awaiting our commands, and
   the program is already downloaded.  We just set its PC and go.  */

  inferior_pid = pid;           /* Needed for wait_for_inferior below */

  clear_proceed_status ();

  /* Tell wait_for_inferior that we've started a new process.  */
  init_wait_for_inferior ();

  /* Set up the "saved terminal modes" of the inferior
     based on what modes we are starting it with.  */
  target_terminal_init ();

  /* Install inferior's terminal modes.  */
  target_terminal_inferior ();

  /* insert_step_breakpoint ();  FIXME, do we need this?  */
  proceed ((CORE_ADDR)entry_pt, -1, 0);         /* Let 'er rip... */
}

static void
reset_command(args, from_tty)
     char *args;
     int from_tty;
{
  if (nindy_serial == NULL)
    {
      error( "No target system to reset -- use 'target nindy' command.");
    }
  if ( query("Really reset the target system?",0,0) )
    {
      SERIAL_SEND_BREAK (nindy_serial);
      tty_flush (nindy_serial);
    }
}

void
nindy_kill (args, from_tty)
     char *args;
     int from_tty;
{
  return;               /* Ignore attempts to kill target system */
}

/* Clean up when a program exits.

   The program actually lives on in the remote processor's RAM, and may be
   run again without a download.  Don't leave it full of breakpoint
   instructions.  */

void
nindy_mourn_inferior ()
{
  remove_breakpoints ();
  unpush_target (&nindy_ops);
  generic_mourn_inferior ();    /* Do all the proper things now */
}
\f
/* Pass the args the way catch_errors wants them.  */
static int
nindy_open_stub (arg)
     char *arg;
{
  nindy_open (arg, 1);
  return 1;
}

static int
load_stub (arg)
     char *arg;
{
  target_load (arg, 1);
  return 1;
}

/* This routine is run as a hook, just before the main command loop is
   entered.  If gdb is configured for the i960, but has not had its
   nindy target specified yet, this will loop prompting the user to do so.

   Unlike the loop provided by Intel, we actually let the user get out
   of this with a RETURN.  This is useful when e.g. simply examining
   an i960 object file on the host system.  */

void
nindy_before_main_loop ()
{
  char ttyname[100];
  char *p, *p2;

  while (current_target != &nindy_ops) { /* remote tty not specified yet */
        if ( instream == stdin ){
                printf("\nAttach /dev/ttyNN -- specify NN, or \"quit\" to quit:  ");
                fflush( stdout );
        }
        fgets( ttyname, sizeof(ttyname)-1, stdin );

        /* Strip leading and trailing whitespace */
        for ( p = ttyname; isspace(*p); p++ ){
                ;
        }
        if ( *p == '\0' ){
                return;         /* User just hit spaces or return, wants out */
        }
        for ( p2= p; !isspace(*p2) && (*p2 != '\0'); p2++ ){
                ;
        }
        *p2= '\0';
        if ( STREQ("quit",p) ){
                exit(1);
        }

        if (catch_errors (nindy_open_stub, p, "", RETURN_MASK_ALL))
          {
            /* Now that we have a tty open for talking to the remote machine,
               download the executable file if one was specified.  */
            if (exec_bfd)
              {
                catch_errors (load_stub, bfd_get_filename (exec_bfd), "",
                              RETURN_MASK_ALL);
              }
          }
  }
}
\f
/* Define the target subroutine names */

struct target_ops nindy_ops = {
        "nindy", "Remote serial target in i960 NINDY-specific protocol",
        "Use a remote i960 system running NINDY connected by a serial line.\n\
Specify the name of the device the serial line is connected to.\n\
The speed (baud rate), whether to use the old NINDY protocol,\n\
and whether to send a break on startup, are controlled by options\n\
specified when you started GDB.",
        nindy_open, nindy_close,
        0,
        nindy_detach,
        nindy_resume,
        nindy_wait,
        nindy_fetch_registers, nindy_store_registers,
        nindy_prepare_to_store,
        nindy_xfer_inferior_memory, nindy_files_info,
        0, 0, /* insert_breakpoint, remove_breakpoint, */
        0, 0, 0, 0, 0,  /* Terminal crud */
        nindy_kill,
        generic_load,
        0, /* lookup_symbol */
        nindy_create_inferior,
        nindy_mourn_inferior,
        0,              /* can_run */
        0, /* notice_signals */
        process_stratum, 0, /* next */
        1, 1, 1, 1, 1,  /* all mem, mem, stack, regs, exec */
        0, 0,                   /* Section pointers */
        OPS_MAGIC,              /* Always the last thing */
};

void
_initialize_nindy ()
{
  add_target (&nindy_ops);
  add_com ("reset", class_obscure, reset_command,
           "Send a 'break' to the remote target system.\n\
Only useful if the target has been equipped with a circuit\n\
to perform a hard reset when a break is detected.");
}