1 /* Definitions for remote debugging interface for ROM monitors. 2 Copyright 1990, 1991, 1992, 1996 Free Software Foundation, Inc. 3 Contributed by Cygnus Support. Written by Rob Savoye for Cygnus. 4 5 This file is part of GDB. 6 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. 11 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. 16 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 19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 20 */ 21 22 #include "serial.h" 23 24 /* This structure describes the strings necessary to give small command 25 sequences to the monitor, and parse the response. 26 27 CMD is the actual command typed at the monitor. Usually this has 28 embedded sequences ala printf, which are substituted with the 29 arguments appropriate to that type of command. Ie: to examine a 30 register, we substitute the register name for the first arg. To 31 modify memory, we substitute the memory location and the new 32 contents for the first and second args, etc... 33 34 RESP_DELIM used to home in on the response string, and is used to 35 disambiguate the answer within the pile of text returned by the 36 monitor. This should be a unique string that immediately precedes 37 the answer. Ie: if your monitor prints out `PC: 00000001= ' in 38 response to asking for the PC, you should use `: ' as the 39 RESP_DELIM. RESP_DELIM may be NULL if the res- ponse is going to 40 be ignored, or has no particular leading text. 41 42 TERM is the string that the monitor outputs to indicate that it is 43 idle, and waiting for input. This is usually a prompt of some 44 sort. In the previous example, it would be `= '. It is important 45 that TERM really means that the monitor is idle, otherwise GDB may 46 try to type at it when it isn't ready for input. This is a problem 47 because many monitors cannot deal with type-ahead. TERM may be 48 NULL if the normal prompt is output. 49 50 TERM_CMD is used to quit out of the subcommand mode and get back to 51 the main prompt. TERM_CMD may be NULL if it isn't necessary. It 52 will also be ignored if TERM is NULL. */ 53 54 struct memrw_cmd 55 { 56 char *cmdb; /* Command to send for byte read/write */ 57 char *cmdw; /* Command for word (16 bit) read/write */ 58 char *cmdl; /* Command for long (32 bit) read/write */ 59 char *cmdll; /* Command for long long (64 bit) read/write */ 60 char *resp_delim; /* String just prior to the desired value */ 61 char *term; /* Terminating string to search for */ 62 char *term_cmd; /* String to get out of sub-mode (if necessary) */ 63 }; 64 65 struct regrw_cmd 66 { 67 char *cmd; /* Command to send for reg read/write */ 68 char *resp_delim; /* String (actually a regexp if getmem) just 69 prior to the desired value */ 70 char *term; /* Terminating string to search for */ 71 char *term_cmd; /* String to get out of sub-mode (if necessary) */ 72 }; 73 74 struct monitor_ops 75 { 76 int flags; /* See below */ 77 char **init; /* List of init commands. NULL terminated. */ 78 char *cont; /* continue command */ 79 char *step; /* single step */ 80 char *stop; /* Interrupt program string */ 81 char *set_break; /* set a breakpoint */ 82 char *clr_break; /* clear a breakpoint */ 83 char *clr_all_break; /* Clear all breakpoints */ 84 char *fill; /* Memory fill cmd (addr len val) */ 85 struct memrw_cmd setmem; /* set memory to a value */ 86 struct memrw_cmd getmem; /* display memory */ 87 struct regrw_cmd setreg; /* set a register */ 88 struct regrw_cmd getreg; /* get a register */ 89 /* Some commands can dump a bunch of registers 90 at once. This comes as a set of REG=VAL 91 pairs. This should be called for each pair 92 of registers that we can parse to supply 93 GDB with the value of a register. */ 94 char *dump_registers; /* Command to dump all regs at once */ 95 char *register_pattern; /* Pattern that picks out register from reg dump */ 96 void (*supply_register) PARAMS ((char *name, int namelen, char *val, int vallen)); 97 void (*load_routine) PARAMS ((serial_t desc, char *file, int hashmark)); /* Download routine */ 98 char *load; /* load command */ 99 char *loadresp; /* Response to load command */ 100 char *prompt; /* monitor command prompt */ 101 char *line_term; /* end-of-command delimitor */ 102 char *cmd_end; /* optional command terminator */ 103 struct target_ops *target; /* target operations */ 104 int stopbits; /* number of stop bits */ 105 char **regnames; /* array of register names in ascii */ 106 int magic; /* Check value */ 107 }; 108 109 /* The monitor ops magic number, used to detect if an ops structure doesn't 110 have the right number of entries filled in. */ 111 112 #define MONITOR_OPS_MAGIC 600925 113 114 /* Flag definitions. */ 115 116 /* If set, then clear breakpoint command uses address, otherwise it 117 uses an index returned by the monitor. */ 118 119 #define MO_CLR_BREAK_USES_ADDR 0x1 120 121 /* If set, then memory fill command uses STARTADDR, ENDADDR+1, VALUE 122 as args, else it uses STARTADDR, LENGTH, VALUE as args. */ 123 124 #define MO_FILL_USES_ADDR 0x2 125 126 /* If set, then monitor doesn't automatically supply register dump 127 when coming back after a continue. */ 128 129 #define MO_NEED_REGDUMP_AFTER_CONT 0x4 130 131 /* getmem needs start addr and end addr */ 132 133 #define MO_GETMEM_NEEDS_RANGE 0x8 134 135 /* getmem can only read one loc at a time */ 136 137 #define MO_GETMEM_READ_SINGLE 0x10 138 139 /* handle \r\n combinations */ 140 141 #define MO_HANDLE_NL 0x20 142 143 /* don't expect echos in monitor_open */ 144 145 #define MO_NO_ECHO_ON_OPEN 0x40 146 147 /* If set, send break to stop monitor */ 148 149 #define MO_SEND_BREAK_ON_STOP 0x80 150 151 /* If set, target sends an ACK after each S-record */ 152 153 #define MO_SREC_ACK 0x100 154 155 /* Allow 0x prefix on addresses retured from monitor */ 156 157 #define MO_HEX_PREFIX 0x200 158 159 /* Some monitors require a different command when starting a program */ 160 161 #define MO_RUN_FIRST_TIME 0x400 162 163 /* Don't expect echos when getting memory */ 164 165 #define MO_NO_ECHO_ON_SETMEM 0x800 166 167 /* If set, then register store command expects value BEFORE regname */ 168 169 #define MO_REGISTER_VALUE_FIRST 0x1000 170 171 #define SREC_SIZE 160 172 173 extern void monitor_open PARAMS ((char *args, struct monitor_ops *ops, 174 int from_tty)); 175 extern void monitor_close PARAMS ((int quitting)); 176 extern char *monitor_supply_register PARAMS ((int regno, char *valstr)); 177 extern int monitor_expect PARAMS ((char *prompt, char *buf, int buflen)); 178 extern int monitor_expect_prompt PARAMS ((char *buf, int buflen)); 179 extern void monitor_printf PARAMS ((char *, ...)) 180 ATTR_FORMAT(printf, 1, 2); 181 extern void monitor_printf_noecho PARAMS ((char *, ...)) 182 ATTR_FORMAT(printf, 1, 2); 183 extern void init_monitor_ops PARAMS ((struct target_ops *)); 184