[binutils.git] / gdb / monitor.h

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