aboutsummaryrefslogtreecommitdiff
path: root/gdb/monitor.h
blob: 30dc3a63ccf11157ca52c220ee0c21c5f4d6fc75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/* Remote debugging interface ROM monitors.
 *  Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
 *  Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
 *
 *  Copyright 1990, 1991, 1992 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

struct rom_cmd_data {
  char *cmd;			/* command to send */
  char *delim;			/* the delimiter */
  char *result;			/* the result */
};

/* 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 cmd_resp {
  char *cmd;			/* Command to send */
  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 monitor_ops {
  int	type;			/* 1 is ascii, 0 is GDB remote protocol */
  char  *init;			/* initialize to the monitor */
  char	*execute;		/* execute or usually GO command */
  char	*resume;		/* continue command */
  char	*step;			/* single step */
  char	*set_break;		/* set a breakpoint */
  char	*clr_break;		/* clear a breakpoint */
  int	clr_type;		/* number or address for clearing */
  struct cmd_resp setmem;	/* set memory to a value */
  struct cmd_resp getmem;	/* display memory */
  struct cmd_resp setreg;	/* set a register */
  struct cmd_resp getreg;	/* get a register */
  char	*load;			/* load command */
  char	*prompt;		/* monitor command prompt */
  char	*cmd_delim;		/* end-of-command delimitor */
  char	*cmd_end;		/* optional command terminator */
  struct target_ops *target;	/* target operations */
  char	**loadtypes;		/* the load types that are supported */
  char	**loadprotos;		/* the load protocols that are supported */
  char	*baudrates;		/* supported baud rates */
  int	stopbits;		/* number of stop bits */
  char  **regnames;		/* array of register names in ascii */
};

extern struct monitor_ops        *current_monitor;

#define PROTO_TYPE		(current_monitor->type)
#define LOADTYPES		(current_monitor->loadtypes)
#define LOADPROTOS		(current_monitor->loadprotos)
#define INIT_CMD 		(current_monitor->init)
#define GO_CMD 			(current_monitor->execute)
#define CONT_CMD		(current_monitor->resume)
#define STEP_CMD		(current_monitor->step)
#define SET_BREAK_CMD		(current_monitor->set_break)
#define CLR_BREAK_CMD		(current_monitor->clr_break)
#define CLR_BREAK_ADDR		(current_monitor->clr_type)
#define SET_MEM			(current_monitor->setmem)
#define GET_MEM			(current_monitor->getmem)
#define LOAD_CMD		(current_monitor->load)
#define GET_REG			(current_monitor->regget)
#define SET_REG			(current_monitor->regset)
#define CMD_END			(current_monitor->cmd_end)
#define CMD_DELIM		(current_monitor->cmd_delim)
#define PROMPT			(current_monitor->prompt)
#define TARGET_OPS		(current_monitor->target)
#define TARGET_NAME		(current_monitor->target->to_shortname)
#define BAUDRATES		(current_monitor->baudrates)
#define STOPBITS		(current_monitor->stopbits)
#define REGNAMES(x)		(current_monitor->regnames[x])
#define ROMCMD(x)		(x.cmd)
#define ROMDELIM(x)		(x.delim)
#define ROMRES(x)		(x.result)

#define push_monitor(x)		current_monitor = x;

#define SREC_SIZE 160
#define GDBPROTO		((current_monitor->type) ? 0: 1)

extern void monitor_open PARAMS ((char *args, struct monitor_ops *ops, int from_tty));
extern void monitor_close PARAMS ((int quitting));
extern void monitor_detach PARAMS ((char *args, int from_tty));
extern void monitor_resume PARAMS ((int pid, int step, enum target_signal sig));
extern int  monitor_wait PARAMS ((int pid, struct target_waitstatus *status));
extern void monitor_fetch_registers PARAMS ((int regno));
extern void monitor_store_registers PARAMS ((int regno));
extern void monitor_prepare_to_store();
extern int  monitor_xfer_memory PARAMS ((CORE_ADDR memaddr, char *myaddr, int len, int write, struct target_ops *target));
extern void monitor_files_info();
extern int  monitor_insert_breakpoint();
extern int  monitor_remove_breakpoint();
extern void monitor_kill();
extern void monitor_load();
extern void monitor_mourn_inferior PARAMS ((void));

/*
 * FIXME: These are to temporarily maintain compatability with the
 *	old monitor structure till remote-mon.c is fixed to work
 *	like the *-rom.c files.
 */
#define MEM_PROMPT		(current_monitor->loadtypes)
#define MEM_SET_CMD		(current_monitor->setmem)
#define MEM_DIS_CMD		(current_monitor->getmem)
#define REG_DELIM               (current_monitor->regset.delim)