1 /* Definitions for remote debugging interface for ROM monitors. 2 Copyright 1990, 1991, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000 3 Free Software Foundation, Inc. 4 Contributed by Cygnus Support. Written by Rob Savoye for Cygnus. 5 6 This file is part of GDB. 7 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. 12 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. 17 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 20 Foundation, Inc., 59 Temple Place - Suite 330, 21 Boston, MA 02111-1307, USA. 22 */ 23 24 #ifndef MONITOR_H 25 #define MONITOR_H 26 27 struct target_waitstatus; 28 struct serial; 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 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 }; 70 71 struct regrw_cmd 72 { 73 char *cmd; /* Command to send for reg read/write */ 74 char *resp_delim; /* String (actually a regexp if getmem) just 75 prior to the desired value */ 76 char *term; /* Terminating string to search for */ 77 char *term_cmd; /* String to get out of sub-mode (if necessary) */ 78 }; 79 80 struct monitor_ops 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 88 sets its own 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 from reg dump */ 103 void (*supply_register) (char *name, int namelen, char *val, int vallen); 104 void (*load_routine) (struct serial *desc, char *file, 105 int hashmark); /* Download routine */ 106 int (*dumpregs) (void); /* routine to dump all registers */ 107 int (*continue_hook) (void); /* Emit the continue command */ 108 int (*wait_filter) (char *buf, /* Maybe contains registers */ 109 int bufmax, 110 int *response_length, 111 struct target_waitstatus * status); 112 char *load; /* load command */ 113 char *loadresp; /* Response to load command */ 114 char *prompt; /* monitor command prompt */ 115 char *line_term; /* end-of-command delimitor */ 116 char *cmd_end; /* optional command terminator */ 117 struct target_ops *target; /* target operations */ 118 int stopbits; /* number of stop bits */ 119 char **regnames; /* array of register names in ascii */ 120 /* deprecated: use regname instead */ 121 const char *(*regname) (int index); 122 /* function for dynamic regname array */ 123 int num_breakpoints; /* If set_break != NULL, number of supported 124 breakpoints */ 125 int magic; /* Check value */ 126 }; 127 128 /* The monitor ops magic number, used to detect if an ops structure doesn't 129 have the right number of entries filled in. */ 130 131 #define MONITOR_OPS_MAGIC 600925 132 133 /* Flag definitions. */ 134 135 /* If set, then clear breakpoint command uses address, otherwise it 136 uses an index returned by the monitor. */ 137 138 #define MO_CLR_BREAK_USES_ADDR 0x1 139 140 /* If set, then memory fill command uses STARTADDR, ENDADDR+1, VALUE 141 as args, else it uses STARTADDR, LENGTH, VALUE as args. */ 142 143 #define MO_FILL_USES_ADDR 0x2 144 145 /* If set, then monitor doesn't automatically supply register dump 146 when coming back after a continue. */ 147 148 #define MO_NEED_REGDUMP_AFTER_CONT 0x4 149 150 /* getmem needs start addr and end addr */ 151 152 #define MO_GETMEM_NEEDS_RANGE 0x8 153 154 /* getmem can only read one loc at a time */ 155 156 #define MO_GETMEM_READ_SINGLE 0x10 157 158 /* handle \r\n combinations */ 159 160 #define MO_HANDLE_NL 0x20 161 162 /* don't expect echos in monitor_open */ 163 164 #define MO_NO_ECHO_ON_OPEN 0x40 165 166 /* If set, send break to stop monitor */ 167 168 #define MO_SEND_BREAK_ON_STOP 0x80 169 170 /* If set, target sends an ACK after each S-record */ 171 172 #define MO_SREC_ACK 0x100 173 174 /* Allow 0x prefix on addresses retured from monitor */ 175 176 #define MO_HEX_PREFIX 0x200 177 178 /* Some monitors require a different command when starting a program */ 179 180 #define MO_RUN_FIRST_TIME 0x400 181 182 /* Don't expect echos when getting memory */ 183 184 #define MO_NO_ECHO_ON_SETMEM 0x800 185 186 /* If set, then register store command expects value BEFORE regname */ 187 188 #define MO_REGISTER_VALUE_FIRST 0x1000 189 190 /* If set, then the monitor displays registers as pairs. */ 191 192 #define MO_32_REGS_PAIRED 0x2000 193 194 /* If set, then register setting happens interactively. */ 195 196 #define MO_SETREG_INTERACTIVE 0x4000 197 198 /* If set, then memory setting happens interactively. */ 199 200 #define MO_SETMEM_INTERACTIVE 0x8000 201 202 /* If set, then memory dumps are always on 16-byte boundaries, even 203 when less is desired. */ 204 205 #define MO_GETMEM_16_BOUNDARY 0x10000 206 207 /* If set, then the monitor numbers its breakpoints starting from 1. */ 208 209 #define MO_CLR_BREAK_1_BASED 0x20000 210 211 /* If set, then the monitor acks srecords with a plus sign. */ 212 213 #define MO_SREC_ACK_PLUS 0x40000 214 215 /* If set, then the monitor "acks" srecords with rotating lines. */ 216 217 #define MO_SREC_ACK_ROTATE 0x80000 218 219 /* If set, then remove useless address bits from memory addresses. */ 220 221 #define MO_ADDR_BITS_REMOVE 0x100000 222 223 /* If set, then display target program output if prefixed by ^O. */ 224 225 #define MO_PRINT_PROGRAM_OUTPUT 0x200000 226 227 /* Some dump bytes commands align the first data with the preceeding 228 16 byte boundary. Some print blanks and start at the exactly the 229 requested boundary. */ 230 231 #define MO_EXACT_DUMPADDR 0x400000 232 233 /* Rather entering and exiting the write memory dialog for each word byte, 234 we can save time by transferring the whole block without exiting 235 the memory editing mode. You only need to worry about this 236 if you are doing memory downloading. 237 This engages a new write function registered with dcache. 238 */ 239 #define MO_HAS_BLOCKWRITES 0x800000 240 241 #define SREC_SIZE 160 242 243 extern void monitor_open (char *args, struct monitor_ops *ops, int from_tty); 244 extern void monitor_close (int quitting); 245 extern char *monitor_supply_register (int regno, char *valstr); 246 extern int monitor_expect (char *prompt, char *buf, int buflen); 247 extern int monitor_expect_prompt (char *buf, int buflen); 248 /* Note: The variable argument functions monitor_printf and 249 monitor_printf_noecho vararg do not take take standard format style 250 arguments. Instead they take custom formats interpretered directly 251 by monitor_vsprintf. */ 252 extern void monitor_printf (char *, ...); 253 extern void monitor_printf_noecho (char *, ...); 254 extern void monitor_write (char *buf, int buflen); 255 extern int monitor_readchar (void); 256 extern char *monitor_get_dev_name (void); 257 extern void init_monitor_ops (struct target_ops *); 258 extern int monitor_dump_reg_block (char *dump_cmd); 259 260 #endif 261