gdb/monitor.h

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