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