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