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

/* Definitions for remote debugging interface for ROM monitors.
   Copyright (C) 1990, 1991, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   2007, 2008, 2009, 2010, 2011 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef MONITOR_H
#define MONITOR_H

struct target_waitstatus;
struct serial;

/* 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) (struct regcache *regcache, char *name,
			     int namelen, char *val, int vallen);
    void (*load_routine) (struct serial *desc, char *file,
			  int hashmark);	/* Download routine */
    int (*dumpregs) (struct regcache *);	/* 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 */
                                /* deprecated: use regname instead */
    const char *(*regname) (int index); 
                                /* function for dynamic regname array */
    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 (struct regcache *regcache,
				      int regno, char *valstr);
extern int monitor_expect (char *prompt, char *buf, int buflen);
extern int monitor_expect_prompt (char *buf, int buflen);
/* Note: The variable argument functions monitor_printf and
   monitor_printf_noecho vararg do not take take standard format style
   arguments.  Instead they take custom formats interpretered directly
   by monitor_vsprintf.  */
extern void monitor_printf (char *, ...);
extern void monitor_printf_noecho (char *, ...);
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 (struct regcache *regcache, char *dump_cmd);

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