1 /* Definitions for remote debugging interface for ROM monitors.
2 Copyright (C) 1990-1992, 1994-2000, 2007-2012 Free Software
4 Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
6 This file is part of GDB.
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 3 of the License, or
11 (at your option) any later version.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 struct target_waitstatus
;
27 /* This structure describes the strings necessary to give small command
28 sequences to the monitor, and parse the response.
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...
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.
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.
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. */
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 */
65 char *term_cmd
; /* String to get out of sub-mode (if
71 char *cmd
; /* Command to send for reg read/write */
72 char *resp_delim
; /* String (actually a regexp if getmem) just
73 prior to the desired value */
74 char *term
; /* Terminating string to search for */
75 char *term_cmd
; /* String to get out of sub-mode (if
81 int flags
; /* See below */
82 char **init
; /* List of init commands. NULL terminated. */
83 char *cont
; /* continue command */
84 char *step
; /* single step */
85 char *stop
; /* Interrupt program string */
86 char *set_break
; /* set a breakpoint. If NULL, monitor
87 implementation sets its own
88 to_insert_breakpoint method. */
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
104 void (*supply_register
) (struct regcache
*regcache
, char *name
,
105 int namelen
, char *val
, int vallen
);
106 void (*load_routine
) (struct serial
*desc
, char *file
,
107 int hashmark
); /* Download routine */
108 int (*dumpregs
) (struct regcache
*); /* Dump all registers */
109 int (*continue_hook
) (void); /* Emit the continue command */
110 int (*wait_filter
) (char *buf
, /* Maybe contains registers */
112 int *response_length
,
113 struct target_waitstatus
* status
);
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 */
122 /* deprecated: use regname instead */
123 const char *(*regname
) (int index
);
124 /* function for dynamic regname array */
125 int num_breakpoints
; /* If set_break != NULL, number of supported
127 int magic
; /* Check value */
130 /* The monitor ops magic number, used to detect if an ops structure doesn't
131 have the right number of entries filled in. */
133 #define MONITOR_OPS_MAGIC 600925
135 /* Flag definitions. */
137 /* If set, then clear breakpoint command uses address, otherwise it
138 uses an index returned by the monitor. */
140 #define MO_CLR_BREAK_USES_ADDR 0x1
142 /* If set, then memory fill command uses STARTADDR, ENDADDR+1, VALUE
143 as args, else it uses STARTADDR, LENGTH, VALUE as args. */
145 #define MO_FILL_USES_ADDR 0x2
147 /* If set, then monitor doesn't automatically supply register dump
148 when coming back after a continue. */
150 #define MO_NEED_REGDUMP_AFTER_CONT 0x4
152 /* getmem needs start addr and end addr. */
154 #define MO_GETMEM_NEEDS_RANGE 0x8
156 /* getmem can only read one loc at a time. */
158 #define MO_GETMEM_READ_SINGLE 0x10
160 /* handle \r\n combinations. */
162 #define MO_HANDLE_NL 0x20
164 /* don't expect echos in monitor_open. */
166 #define MO_NO_ECHO_ON_OPEN 0x40
168 /* If set, send break to stop monitor. */
170 #define MO_SEND_BREAK_ON_STOP 0x80
172 /* If set, target sends an ACK after each S-record. */
174 #define MO_SREC_ACK 0x100
176 /* Allow 0x prefix on addresses retured from monitor. */
178 #define MO_HEX_PREFIX 0x200
180 /* Some monitors require a different command when starting a program. */
182 #define MO_RUN_FIRST_TIME 0x400
184 /* Don't expect echos when getting memory */
186 #define MO_NO_ECHO_ON_SETMEM 0x800
188 /* If set, then register store command expects value BEFORE regname. */
190 #define MO_REGISTER_VALUE_FIRST 0x1000
192 /* If set, then the monitor displays registers as pairs. */
194 #define MO_32_REGS_PAIRED 0x2000
196 /* If set, then register setting happens interactively. */
198 #define MO_SETREG_INTERACTIVE 0x4000
200 /* If set, then memory setting happens interactively. */
202 #define MO_SETMEM_INTERACTIVE 0x8000
204 /* If set, then memory dumps are always on 16-byte boundaries, even
205 when less is desired. */
207 #define MO_GETMEM_16_BOUNDARY 0x10000
209 /* If set, then the monitor numbers its breakpoints starting from 1. */
211 #define MO_CLR_BREAK_1_BASED 0x20000
213 /* If set, then the monitor acks srecords with a plus sign. */
215 #define MO_SREC_ACK_PLUS 0x40000
217 /* If set, then the monitor "acks" srecords with rotating lines. */
219 #define MO_SREC_ACK_ROTATE 0x80000
221 /* If set, then remove useless address bits from memory addresses. */
223 #define MO_ADDR_BITS_REMOVE 0x100000
225 /* If set, then display target program output if prefixed by ^O. */
227 #define MO_PRINT_PROGRAM_OUTPUT 0x200000
229 /* Some dump bytes commands align the first data with the preceding
230 16 byte boundary. Some print blanks and start at the exactly the
231 requested boundary. */
233 #define MO_EXACT_DUMPADDR 0x400000
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
237 the memory editing mode. You only need to worry about this
238 if you are doing memory downloading.
239 This engages a new write function registered with dcache. */
241 #define MO_HAS_BLOCKWRITES 0x800000
243 #define SREC_SIZE 160
245 extern void monitor_open (char *args
, struct monitor_ops
*ops
, int from_tty
);
246 extern void monitor_close (int quitting
);
247 extern char *monitor_supply_register (struct regcache
*regcache
,
248 int regno
, char *valstr
);
249 extern int monitor_expect (char *prompt
, char *buf
, int buflen
);
250 extern int monitor_expect_prompt (char *buf
, int buflen
);
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 *, ...);
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
*);
261 extern int monitor_dump_reg_block (struct regcache
*regcache
, char *dump_cmd
);
This page took 0.03461 seconds and 4 git commands to generate.