gdb/monitor.h

   1 /* Definitions for remote debugging interface for ROM monitors.
   2    Copyright (C) 1990-2015 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 3 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, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef MONITOR_H
  21 #define MONITOR_H
  22
  23 struct target_waitstatus;
  24 struct serial;
  25
  26 /* This structure describes the strings necessary to give small command
  27    sequences to the monitor, and parse the response.
  28
  29    CMD is the actual command typed at the monitor.  Usually this has
  30    embedded sequences ala printf, which are substituted with the
  31    arguments appropriate to that type of command.  Ie: to examine a
  32    register, we substitute the register name for the first arg.  To
  33    modify memory, we substitute the memory location and the new
  34    contents for the first and second args, etc...
  35
  36    RESP_DELIM used to home in on the response string, and is used to
  37    disambiguate the answer within the pile of text returned by the
  38    monitor.  This should be a unique string that immediately precedes
  39    the answer.  Ie: if your monitor prints out `PC: 00000001= ' in
  40    response to asking for the PC, you should use `: ' as the
  41    RESP_DELIM.  RESP_DELIM may be NULL if the res- ponse is going to
  42    be ignored, or has no particular leading text.
  43
  44    TERM is the string that the monitor outputs to indicate that it is
  45    idle, and waiting for input.  This is usually a prompt of some
  46    sort.  In the previous example, it would be `= '.  It is important
  47    that TERM really means that the monitor is idle, otherwise GDB may
  48    try to type at it when it isn't ready for input.  This is a problem
  49    because many monitors cannot deal with type-ahead.  TERM may be
  50    NULL if the normal prompt is output.
  51
  52    TERM_CMD is used to quit out of the subcommand mode and get back to
  53    the main prompt.  TERM_CMD may be NULL if it isn't necessary.  It
  54    will also be ignored if TERM is NULL.  */
  55
  56 struct memrw_cmd
  57   {
  58     char *cmdb;                 /* Command to send for byte read/write */
  59     char *cmdw;                 /* Command for word (16 bit) read/write */
  60     char *cmdl;                 /* Command for long (32 bit) read/write */
  61     char *cmdll;                /* Command for long long (64 bit) read/write */
  62     char *resp_delim;           /* String just prior to the desired value */
  63     char *term;                 /* Terminating string to search for */
  64     char *term_cmd;             /* String to get out of sub-mode (if
  65                                    necessary) */
  66   };
  67
  68 struct regrw_cmd
  69   {
  70     char *cmd;                  /* Command to send for reg read/write */
  71     char *resp_delim;           /* String (actually a regexp if getmem) just
  72                                    prior to the desired value */
  73     char *term;                 /* Terminating string to search for */
  74     char *term_cmd;             /* String to get out of sub-mode (if
  75                                    necessary) */
  76   };
  77
  78 struct monitor_ops
  79   {
  80     int flags;                  /* See below */
  81     char **init;                /* List of init commands.  NULL terminated.  */
  82     char *cont;                 /* continue command */
  83     char *step;                 /* single step */
  84     char *stop;                 /* Interrupt program string */
  85     char *set_break;            /* set a breakpoint.  If NULL, monitor
  86                                    implementation sets its own
  87                                    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
 102                                    from reg dump */
 103     void (*supply_register) (struct regcache *regcache, char *name,
 104                              int namelen, char *val, int vallen);
 105     int (*dumpregs) (struct regcache *);        /* 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                                 /* deprecated: use regname instead */
 120     const char *(*regname) (int index);
 121                                 /* function for dynamic regname array */
 122     int num_breakpoints;        /* If set_break != NULL, number of supported
 123                                    breakpoints */
 124     int magic;                  /* Check value */
 125   };
 126
 127 /* The monitor ops magic number, used to detect if an ops structure doesn't
 128    have the right number of entries filled in.  */
 129
 130 #define MONITOR_OPS_MAGIC 600925
 131
 132 /* Flag definitions.  */
 133
 134 /* If set, then clear breakpoint command uses address, otherwise it
 135    uses an index returned by the monitor.  */
 136
 137 #define MO_CLR_BREAK_USES_ADDR 0x1
 138
 139 /* If set, then memory fill command uses STARTADDR, ENDADDR+1, VALUE
 140    as args, else it uses STARTADDR, LENGTH, VALUE as args.  */
 141
 142 #define MO_FILL_USES_ADDR 0x2
 143
 144 /* If set, then monitor doesn't automatically supply register dump
 145    when coming back after a continue.  */
 146
 147 #define MO_NEED_REGDUMP_AFTER_CONT 0x4
 148
 149 /* getmem needs start addr and end addr.  */
 150
 151 #define MO_GETMEM_NEEDS_RANGE 0x8
 152
 153 /* getmem can only read one loc at a time.  */
 154
 155 #define MO_GETMEM_READ_SINGLE 0x10
 156
 157 /* handle \r\n combinations.  */
 158
 159 #define MO_HANDLE_NL 0x20
 160
 161 /* don't expect echos in monitor_open.  */
 162
 163 #define MO_NO_ECHO_ON_OPEN 0x40
 164
 165 /* If set, send break to stop monitor.  */
 166
 167 #define MO_SEND_BREAK_ON_STOP 0x80
 168
 169 /* If set, target sends an ACK after each S-record.  */
 170
 171 #define MO_SREC_ACK 0x100
 172
 173 /* Allow 0x prefix on addresses retured from monitor.  */
 174
 175 #define MO_HEX_PREFIX 0x200
 176
 177 /* Some monitors require a different command when starting a program.  */
 178
 179 #define MO_RUN_FIRST_TIME 0x400
 180
 181 /* Don't expect echos when getting memory */
 182
 183 #define MO_NO_ECHO_ON_SETMEM 0x800
 184
 185 /* If set, then register store command expects value BEFORE regname.  */
 186
 187 #define MO_REGISTER_VALUE_FIRST 0x1000
 188
 189 /* If set, then the monitor displays registers as pairs.  */
 190
 191 #define MO_32_REGS_PAIRED 0x2000
 192
 193 /* If set, then register setting happens interactively.  */
 194
 195 #define MO_SETREG_INTERACTIVE 0x4000
 196
 197 /* If set, then memory setting happens interactively.  */
 198
 199 #define MO_SETMEM_INTERACTIVE 0x8000
 200
 201 /* If set, then memory dumps are always on 16-byte boundaries, even
 202    when less is desired.  */
 203
 204 #define MO_GETMEM_16_BOUNDARY 0x10000
 205
 206 /* If set, then the monitor numbers its breakpoints starting from 1.  */
 207
 208 #define MO_CLR_BREAK_1_BASED 0x20000
 209
 210 /* If set, then the monitor acks srecords with a plus sign.  */
 211
 212 #define MO_SREC_ACK_PLUS 0x40000
 213
 214 /* If set, then the monitor "acks" srecords with rotating lines.  */
 215
 216 #define MO_SREC_ACK_ROTATE 0x80000
 217
 218 /* If set, then remove useless address bits from memory addresses.  */
 219
 220 #define MO_ADDR_BITS_REMOVE 0x100000
 221
 222 /* If set, then display target program output if prefixed by ^O.  */
 223
 224 #define MO_PRINT_PROGRAM_OUTPUT 0x200000
 225
 226 /* Some dump bytes commands align the first data with the preceding
 227    16 byte boundary.  Some print blanks and start at the exactly the
 228    requested boundary.  */
 229
 230 #define MO_EXACT_DUMPADDR 0x400000
 231
 232 /* Rather entering and exiting the write memory dialog for each word byte,
 233    we can save time by transferring the whole block without exiting
 234    the memory editing mode.  You only need to worry about this
 235    if you are doing memory downloading.
 236    This engages a new write function registered with dcache.  */
 237
 238 #define MO_HAS_BLOCKWRITES 0x800000
 239
 240 #define SREC_SIZE 160
 241
 242 extern void monitor_open (const char *args, struct monitor_ops *ops,
 243                           int from_tty);
 244 extern void monitor_close (struct target_ops *self);
 245 extern char *monitor_supply_register (struct regcache *regcache,
 246                                       int regno, char *valstr);
 247 extern int monitor_expect (char *prompt, char *buf, int buflen);
 248 extern int monitor_expect_prompt (char *buf, int buflen);
 249 /* Note: The variable argument functions monitor_printf and
 250    monitor_printf_noecho vararg do not take take standard format style
 251    arguments.  Instead they take custom formats interpretered directly
 252    by monitor_vsprintf.  */
 253 extern void monitor_printf (char *, ...);
 254 extern void monitor_printf_noecho (char *, ...);
 255 extern void monitor_write (char *buf, int buflen);
 256 extern int monitor_readchar (void);
 257 extern char *monitor_get_dev_name (void);
 258 extern void init_monitor_ops (struct target_ops *);
 259 extern int monitor_dump_reg_block (struct regcache *regcache, char *dump_cmd);
 260
 261 #endif