[thirdparty/binutils-gdb.git] / gdb / monitor.h

/* Definitions for remote debugging interface for ROM monitors.
    Copyright 1990, 1991, 1992, 1996 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#include "serial.h"

/* 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 (actually a regexp if getmem) 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 */
  int (*dumpregs) PARAMS((void)) ;    /* routine to dump all registers */
  int (*continue_hook) PARAMS((void)) ; /* Emit the continue command */
  int (*wait_filter) PARAMS((char * buf, /* Maybe contains registers */
			    int bufmax ,
			    int * response_length,
			    struct target_waitstatus * status)) ;
  char *load;			/* load command */
  char *loadresp;		/* Response to load command */
  char *prompt;			/* monitor command prompt */
  char *line_term;		/* 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 */
};

/* The monitor ops magic number, used to detect if an ops structure doesn't
   have the right number of entries filled in. */

#define MONITOR_OPS_MAGIC 600925

/* Flag definitions. */

/* If set, then clear breakpoint command uses address, otherwise it
   uses an index returned by the monitor.  */

#define MO_CLR_BREAK_USES_ADDR 0x1

/* If set, then memory fill command uses STARTADDR, ENDADDR+1, VALUE
   as args, else it uses STARTADDR, LENGTH, VALUE as args. */

#define MO_FILL_USES_ADDR 0x2

/* If set, then monitor doesn't automatically supply register dump
   when coming back after a continue.  */

#define MO_NEED_REGDUMP_AFTER_CONT 0x4

/* getmem needs start addr and end addr */

#define MO_GETMEM_NEEDS_RANGE 0x8

/* getmem can only read one loc at a time */

#define MO_GETMEM_READ_SINGLE 0x10

/* handle \r\n combinations */

#define MO_HANDLE_NL 0x20

/* don't expect echos in monitor_open */

#define MO_NO_ECHO_ON_OPEN 0x40

/* If set, send break to stop monitor */

#define MO_SEND_BREAK_ON_STOP 0x80

/* If set, target sends an ACK after each S-record */

#define MO_SREC_ACK 0x100

/* Allow 0x prefix on addresses retured from monitor */

#define MO_HEX_PREFIX 0x200

/* Some monitors require a different command when starting a program */

#define MO_RUN_FIRST_TIME 0x400

/* Don't expect echos when getting memory */

#define MO_NO_ECHO_ON_SETMEM 0x800

/* If set, then register store command expects value BEFORE regname */

#define MO_REGISTER_VALUE_FIRST 0x1000

/* If set, then the monitor displays registers as pairs.  */

#define MO_32_REGS_PAIRED 0x2000

/* If set, then register setting happens interactively.  */

#define MO_SETREG_INTERACTIVE 0x4000

/* If set, then memory setting happens interactively.  */

#define MO_SETMEM_INTERACTIVE 0x8000

/* If set, then memory dumps are always on 16-byte boundaries, even
   when less is desired.  */

#define MO_GETMEM_16_BOUNDARY 0x10000

/* If set, then the monitor numbers its breakpoints starting from 1.  */

#define MO_CLR_BREAK_1_BASED 0x20000

/* If set, then the monitor acks srecords with a plus sign.  */

#define MO_SREC_ACK_PLUS 0x40000

/* If set, then the monitor "acks" srecords with rotating lines.  */

#define MO_SREC_ACK_ROTATE 0x80000

/* If set, then remove useless address bits from memory addresses.  */

#define MO_ADDR_BITS_REMOVE 0x100000

/* If set, then display target program output if prefixed by ^O.  */

#define MO_PRINT_PROGRAM_OUTPUT 0x200000

/* Some dump bytes commands align the first data with the preceeding
16 byte boundary. Some print blanks and start at the exactly the
requested boundary. */

#define MO_EXACT_DUMPADDR 0x400000

/* Rather entering and exiting the write memory dialog for each word byte,
   we can save time by transferring the whole block without exiting
   the memory editing mode. You only need to worry about this
   if you are doing memory downloading.
   This engages a new write function registered with dcache.
   */
#define MO_HAS_BLOCKWRITES 0x800000

#define SREC_SIZE 160

extern void monitor_open PARAMS ((char *args, struct monitor_ops *ops,
				  int from_tty));
extern void monitor_close PARAMS ((int quitting));
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 PARAMS ((char *, ...))
     ATTR_FORMAT(printf, 1, 2);
extern void monitor_printf_noecho PARAMS ((char *, ...))
     ATTR_FORMAT(printf, 1, 2);
extern void monitor_write PARAMS ((char *buf, int buflen));
extern int monitor_readchar PARAMS ((void));
extern char *monitor_get_dev_name PARAMS ((void));
extern void init_monitor_ops PARAMS ((struct target_ops *));
extern int monitor_dump_reg_block PARAMS((char * dump_cmd)) ;
extern void flush_monitor_dcache PARAMS ((void));
Commit	Line	Data
178ed338 SS	1	/* Definitions for remote debugging interface for ROM monitors.
	2	Copyright 1990, 1991, 1992, 1996 Free Software Foundation, Inc.
	3	Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
	4
	5	This file is part of GDB.
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 2 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program; if not, write to the Free Software
	19	Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	20	*/
054240ec	21
5de0c648 SG	22	#include "serial.h"
5de0c648 SG	23
1265e2d8 SG	24	/* This structure describes the strings necessary to give small command
	25	sequences to the monitor, and parse the response.
	26
178ed338 SS	27	CMD is the actual command typed at the monitor. Usually this has
	28	embedded sequences ala printf, which are substituted with the
	29	arguments appropriate to that type of command. Ie: to examine a
	30	register, we substitute the register name for the first arg. To
	31	modify memory, we substitute the memory location and the new
	32	contents for the first and second args, etc...
1265e2d8 SG	33
1265e2d8 SG	34	RESP_DELIM used to home in on the response string, and is used to
178ed338 SS	35	disambiguate the answer within the pile of text returned by the
	36	monitor. This should be a unique string that immediately precedes
	37	the answer. Ie: if your monitor prints out `PC: 00000001= ' in
	38	response to asking for the PC, you should use `: ' as the
	39	RESP_DELIM. RESP_DELIM may be NULL if the res- ponse is going to
	40	be ignored, or has no particular leading text.
	41
	42	TERM is the string that the monitor outputs to indicate that it is
	43	idle, and waiting for input. This is usually a prompt of some
	44	sort. In the previous example, it would be `= '. It is important
	45	that TERM really means that the monitor is idle, otherwise GDB may
	46	try to type at it when it isn't ready for input. This is a problem
	47	because many monitors cannot deal with type-ahead. TERM may be
	48	NULL if the normal prompt is output.
	49
	50	TERM_CMD is used to quit out of the subcommand mode and get back to
	51	the main prompt. TERM_CMD may be NULL if it isn't necessary. It
	52	will also be ignored if TERM is NULL. */
1265e2d8	53
a25a9f49 SG	54	struct memrw_cmd
	55	{
	56	char cmdb; / Command to send for byte read/write */
	57	char cmdw; / Command for word (16 bit) read/write */
	58	char cmdl; / Command for long (32 bit) read/write */
	59	char cmdll; / Command for long long (64 bit) read/write */
1265e2d8 SG	60	char resp_delim; / String just prior to the desired value */
	61	char term; / Terminating string to search for */
	62	char term_cmd; / String to get out of sub-mode (if necessary) */
	63	};
	64
a25a9f49 SG	65	struct regrw_cmd
	66	{
	67	char cmd; / Command to send for reg read/write */
fe5cfadd SG	68	char resp_delim; / String (actually a regexp if getmem) just
fe5cfadd SG	69	prior to the desired value */
a25a9f49 SG	70	char term; / Terminating string to search for */
	71	char term_cmd; / String to get out of sub-mode (if necessary) */
	72	};
	73
	74	struct monitor_ops
	75	{
	76	int flags; /* See below */
	77	char *init; / List of init commands. NULL terminated. */
	78	char cont; / continue command */
	79	char step; / single step */
a706069f	80	char stop; / Interrupt program string */
a25a9f49 SG	81	char set_break; / set a breakpoint */
	82	char clr_break; / clear a breakpoint */
	83	char clr_all_break; / Clear all breakpoints */
	84	char fill; / Memory fill cmd (addr len val) */
	85	struct memrw_cmd setmem; /* set memory to a value */
	86	struct memrw_cmd getmem; /* display memory */
	87	struct regrw_cmd setreg; /* set a register */
	88	struct regrw_cmd getreg; /* get a register */
2081365f SG	89	/* Some commands can dump a bunch of registers
	90	at once. This comes as a set of REG=VAL
	91	pairs. This should be called for each pair
	92	of registers that we can parse to supply
	93	GDB with the value of a register. */
a25a9f49	94	char dump_registers; / Command to dump all regs at once */
2081365f	95	char register_pattern; / Pattern that picks out register from reg dump */
2a8b1fab JM	96	void (supply_register) PARAMS ((char name, int namelen,
	97	char *val, int vallen));
	98	void (load_routine) PARAMS ((serial_t desc, char file,
	99	int hashmark)); /* Download routine */
	100	int (dumpregs) PARAMS((void)) ; / routine to dump all registers */
	101	int (continue_hook) PARAMS((void)) ; / Emit the continue command */
	102	int (wait_filter) PARAMS((char buf, /* Maybe contains registers */
	103	int bufmax ,
	104	int * response_length,
	105	struct target_waitstatus * status)) ;
a25a9f49 SG	106	char load; / load command */
	107	char loadresp; / Response to load command */
	108	char prompt; / monitor command prompt */
d8afcce9	109	char line_term; / end-of-command delimitor */
a25a9f49	110	char cmd_end; / optional command terminator */
51d6a954	111	struct target_ops target; / target operations */
a25a9f49 SG	112	int stopbits; /* number of stop bits */
	113	char *regnames; / array of register names in ascii */
	114	int magic; /* Check value */
054240ec RS	115	};
054240ec RS	116
178ed338 SS	117	/* The monitor ops magic number, used to detect if an ops structure doesn't
	118	have the right number of entries filled in. */
	119
a25a9f49 SG	120	#define MONITOR_OPS_MAGIC 600925
a25a9f49 SG	121
178ed338 SS	122	/* Flag definitions. */
	123
	124	/* If set, then clear breakpoint command uses address, otherwise it
	125	uses an index returned by the monitor. */
	126
	127	#define MO_CLR_BREAK_USES_ADDR 0x1
	128
	129	/* If set, then memory fill command uses STARTADDR, ENDADDR+1, VALUE
	130	as args, else it uses STARTADDR, LENGTH, VALUE as args. */
	131
	132	#define MO_FILL_USES_ADDR 0x2
	133
	134	/* If set, then monitor doesn't automatically supply register dump
	135	when coming back after a continue. */
	136
	137	#define MO_NEED_REGDUMP_AFTER_CONT 0x4
	138
	139	/* getmem needs start addr and end addr */
	140
	141	#define MO_GETMEM_NEEDS_RANGE 0x8
	142
	143	/* getmem can only read one loc at a time */
	144
	145	#define MO_GETMEM_READ_SINGLE 0x10
	146
	147	/* handle \r\n combinations */
	148
	149	#define MO_HANDLE_NL 0x20
	150
	151	/* don't expect echos in monitor_open */
	152
	153	#define MO_NO_ECHO_ON_OPEN 0x40
	154
	155	/* If set, send break to stop monitor */
	156
	157	#define MO_SEND_BREAK_ON_STOP 0x80
51d6a954	158
c92f31c6 MA	159	/* If set, target sends an ACK after each S-record */
	160
	161	#define MO_SREC_ACK 0x100
	162
012be3ce DP	163	/* Allow 0x prefix on addresses retured from monitor */
	164
	165	#define MO_HEX_PREFIX 0x200
	166
	167	/* Some monitors require a different command when starting a program */
	168
	169	#define MO_RUN_FIRST_TIME 0x400
	170
	171	/* Don't expect echos when getting memory */
	172
	173	#define MO_NO_ECHO_ON_SETMEM 0x800
	174
8665f3dc MS	175	/* If set, then register store command expects value BEFORE regname */
	176
	177	#define MO_REGISTER_VALUE_FIRST 0x1000
	178
339cddf7 SS	179	/* If set, then the monitor displays registers as pairs. */
	180
	181	#define MO_32_REGS_PAIRED 0x2000
	182
	183	/* If set, then register setting happens interactively. */
	184
	185	#define MO_SETREG_INTERACTIVE 0x4000
	186
	187	/* If set, then memory setting happens interactively. */
	188
	189	#define MO_SETMEM_INTERACTIVE 0x8000
	190
	191	/* If set, then memory dumps are always on 16-byte boundaries, even
	192	when less is desired. */
	193
	194	#define MO_GETMEM_16_BOUNDARY 0x10000
	195
	196	/* If set, then the monitor numbers its breakpoints starting from 1. */
	197
	198	#define MO_CLR_BREAK_1_BASED 0x20000
	199
c77bcbc2 SS	200	/* If set, then the monitor acks srecords with a plus sign. */
	201
	202	#define MO_SREC_ACK_PLUS 0x40000
	203
	204	/* If set, then the monitor "acks" srecords with rotating lines. */
	205
	206	#define MO_SREC_ACK_ROTATE 0x80000
	207
7e9576e0 MA	208	/* If set, then remove useless address bits from memory addresses. */
	209
	210	#define MO_ADDR_BITS_REMOVE 0x100000
	211
352f9e9d MA	212	/* If set, then display target program output if prefixed by ^O. */
	213
	214	#define MO_PRINT_PROGRAM_OUTPUT 0x200000
	215
2a8b1fab JM	216	/* Some dump bytes commands align the first data with the preceeding
	217	16 byte boundary. Some print blanks and start at the exactly the
	218	requested boundary. */
	219
	220	#define MO_EXACT_DUMPADDR 0x400000
	221
	222	/* Rather entering and exiting the write memory dialog for each word byte,
	223	we can save time by transferring the whole block without exiting
	224	the memory editing mode. You only need to worry about this
	225	if you are doing memory downloading.
	226	This engages a new write function registered with dcache.
	227	*/
	228	#define MO_HAS_BLOCKWRITES 0x800000
	229
df3cf84a RS	230	#define SREC_SIZE 160
df3cf84a RS	231
178ed338 SS	232	extern void monitor_open PARAMS ((char args, struct monitor_ops ops,
178ed338 SS	233	int from_tty));
c84e5000	234	extern void monitor_close PARAMS ((int quitting));
5de0c648 SG	235	extern char monitor_supply_register PARAMS ((int regno, char valstr));
	236	extern int monitor_expect PARAMS ((char prompt, char buf, int buflen));
	237	extern int monitor_expect_prompt PARAMS ((char *buf, int buflen));
e3033bb0 C	238	extern void monitor_printf PARAMS ((char *, ...))
	239	ATTR_FORMAT(printf, 1, 2);
	240	extern void monitor_printf_noecho PARAMS ((char *, ...))
	241	ATTR_FORMAT(printf, 1, 2);
1a31a33a MA	242	extern void monitor_write PARAMS ((char *buf, int buflen));
1a31a33a MA	243	extern int monitor_readchar PARAMS ((void));
0649bb3d	244	extern char *monitor_get_dev_name PARAMS ((void));
d108166f	245	extern void init_monitor_ops PARAMS ((struct target_ops *));
2a8b1fab	246	extern int monitor_dump_reg_block PARAMS((char * dump_cmd)) ;
1c3cd1b0	247	extern void flush_monitor_dcache PARAMS ((void));