binutils-gdb/gdb/monitor.h

/* Remote debugging interface ROM monitors.
 *  Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
 *  Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
 *
 *  Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
 *  Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
 *
 * This file is part of GDB.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include "serial.h"

struct rom_cmd_data {
  char *cmd;			/* command to send */
  char *delim;			/* the delimiter */
  char *result;			/* the result */
};

/* This structure describes the strings necessary to give small command
   sequences to the monitor, and parse the response.

   CMD is the actual command typed at the monitor.  Usually this has embedded
   sequences ala printf, which are substituted with the arguments appropriate
   to that type of command.  Ie: to examine a register, we substitute the
   register name for the first arg.  To modify memory, we substitute the memory
   location and the new contents for the first and second args, etc...

   RESP_DELIM used to home in on the response string, and is used to
   disambiguate the answer within the pile of text returned by the monitor.
   This should be a unique string that immediately precedes the answer.  Ie: if
   your monitor prints out `PC:  00000001= ' in response to asking for the PC,
   you should use `:  ' as the RESP_DELIM.  RESP_DELIM may be NULL if the res-
   ponse is going to be ignored, or has no particular leading text.

   TERM is the string that the monitor outputs to indicate that it is idle, and
   waiting for input.  This is usually a prompt of some sort.  In the previous
   example, it would be `= '.  It is important that TERM really means that the
   monitor is idle, otherwise GDB may try to type at it when it isn't ready for
   input.  This is a problem because many monitors cannot deal with type-ahead.
   TERM may be NULL if the normal prompt is output.

   TERM_CMD is used to quit out of the subcommand mode and get back to the main
   prompt.  TERM_CMD may be NULL if it isn't necessary.  It will also be
   ignored if TERM is NULL.
*/

struct memrw_cmd
{
  char *cmdb;			/* Command to send for byte read/write */
  char *cmdw;			/* Command for word (16 bit) read/write */
  char *cmdl;			/* Command for long (32 bit) read/write */
  char *cmdll;			/* Command for long long (64 bit) read/write */
  char *resp_delim;		/* String just prior to the desired value */
  char *term;			/* Terminating string to search for */
  char *term_cmd;		/* String to get out of sub-mode (if necessary) */
};

struct regrw_cmd
{
  char *cmd;			/* Command to send for reg read/write */
  char *resp_delim;		/* String just prior to the desired value */
  char *term;			/* Terminating string to search for */
  char *term_cmd;		/* String to get out of sub-mode (if necessary) */
};

struct monitor_ops
{
  int flags;			/* See below */
  char **init;			/* List of init commands.  NULL terminated. */
  char *cont;			/* continue command */
  char *step;			/* single step */
  char *stop;			/* Interrupt program string */
  char *set_break;		/* set a breakpoint */
  char *clr_break;		/* clear a breakpoint */
  char *clr_all_break;		/* Clear all breakpoints */
  char *fill;			/* Memory fill cmd (addr len val) */
  struct memrw_cmd setmem;	/* set memory to a value */
  struct memrw_cmd getmem;	/* display memory */
  struct regrw_cmd setreg;	/* set a register */
  struct regrw_cmd getreg;	/* get a register */
				/* Some commands can dump a bunch of registers
				   at once.  This comes as a set of REG=VAL
				   pairs.  This should be called for each pair
				   of registers that we can parse to supply
				   GDB with the value of a register.  */
  char *dump_registers;		/* Command to dump all regs at once */
  char *register_pattern;	/* Pattern that picks out register from reg dump */
  void (*supply_register) PARAMS ((char *name, int namelen, char *val, int vallen));
  void (*load_routine) PARAMS ((serial_t desc, char *file, int hashmark)); /* Download routine */
  char *load;			/* load command */
  char *loadresp;		/* Response to load command */
  char *prompt;			/* monitor command prompt */
  char *cmd_delim;		/* end-of-command delimitor */
  char *cmd_end;		/* optional command terminator */
  struct target_ops *target;	/* target operations */
  int stopbits;			/* number of stop bits */
  char **regnames;		/* array of register names in ascii */
  int magic;			/* Check value */
};

#define MONITOR_OPS_MAGIC 600925

/* Flag defintions */

#define MO_CLR_BREAK_USES_ADDR 0x1 /* If set, then clear breakpoint command
				      uses address, otherwise it uses an index
				      returned by the monitor.  */
#define MO_FILL_USES_ADDR 0x2	/* If set, then memory fill command uses
				   STARTADDR, ENDADDR+1, VALUE as args, else it
				   uses STARTADDR, LENGTH, VALUE as args. */
#define MO_NEED_REGDUMP_AFTER_CONT 0x4 /* If set, then monitor doesn't auto-
					  matically supply register dump when
					  coming back after a continue.  */
#define MO_GETMEM_NEEDS_RANGE 0x8 /* getmem needs start addr and end addr */

extern struct monitor_ops        *current_monitor;

#define LOADTYPES		(current_monitor->loadtypes)
#define LOADPROTOS		(current_monitor->loadprotos)
#define INIT_CMD 		(current_monitor->init)
#define CONT_CMD		(current_monitor->cont)
#define STEP_CMD		(current_monitor->step)
#define SET_BREAK_CMD		(current_monitor->set_break)
#define CLR_BREAK_CMD		(current_monitor->clr_break)
#define SET_MEM			(current_monitor->setmem)
#define GET_MEM			(current_monitor->getmem)
#define LOAD_CMD		(current_monitor->load)
#define GET_REG			(current_monitor->regget)
#define SET_REG			(current_monitor->regset)
#define CMD_END			(current_monitor->cmd_end)
#define CMD_DELIM		(current_monitor->cmd_delim)
#define PROMPT			(current_monitor->prompt)
#define TARGET_OPS		(current_monitor->target)
#define TARGET_NAME		(current_monitor->target->to_shortname)
#define BAUDRATES		(current_monitor->baudrates)
#define STOPBITS		(current_monitor->stopbits)
#define REGNAMES(x)		(current_monitor->regnames[x])
#define ROMCMD(x)		(x.cmd)
#define ROMDELIM(x)		(x.delim)
#define ROMRES(x)		(x.result)

#define push_monitor(x)		current_monitor = x;

#define SREC_SIZE 160

/*
 * FIXME: These are to temporarily maintain compatability with the
 *	old monitor structure till remote-mon.c is fixed to work
 *	like the *-rom.c files.
 */
#define MEM_PROMPT		(current_monitor->loadtypes)
#define MEM_SET_CMD		(current_monitor->setmem)
#define MEM_DIS_CMD		(current_monitor->getmem)
#define REG_DELIM               (current_monitor->regset.delim)

extern void monitor_open PARAMS ((char *args, struct monitor_ops *ops, int from_tty));
extern char *monitor_supply_register PARAMS ((int regno, char *valstr));
extern int monitor_expect PARAMS ((char *prompt, char *buf, int buflen));
extern int monitor_expect_prompt PARAMS ((char *buf, int buflen));
extern void monitor_printf ();
extern void init_monitor_ops PARAMS ((struct target_ops *));