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