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

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