gdb/monitor.h

   1 /* Remote debugging interface ROM monitors.
   2  *  Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
   3  *  Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
   4  *
   5  *  Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
   6  *  Contributed by Cygnus Support. Written by Rob Savoye for Cygnus.
   7  *
   8  * This file is part of GDB.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  */
  24
  25 #include "serial.h"
  26
  27 struct rom_cmd_data {
  28   char *cmd;                    /* command to send */
  29   char *delim;                  /* the delimiter */
  30   char *result;                 /* the result */
  31 };
  32
  33 /* This structure describes the strings necessary to give small command
  34    sequences to the monitor, and parse the response.
  35
  36    CMD is the actual command typed at the monitor.  Usually this has embedded
  37    sequences ala printf, which are substituted with the arguments appropriate
  38    to that type of command.  Ie: to examine a register, we substitute the
  39    register name for the first arg.  To modify memory, we substitute the memory
  40    location and the new contents for the first and second args, etc...
  41
  42    RESP_DELIM used to home in on the response string, and is used to
  43    disambiguate the answer within the pile of text returned by the monitor.
  44    This should be a unique string that immediately precedes the answer.  Ie: if
  45    your monitor prints out `PC:  00000001= ' in response to asking for the PC,
  46    you should use `:  ' as the RESP_DELIM.  RESP_DELIM may be NULL if the res-
  47    ponse is going to be ignored, or has no particular leading text.
  48
  49    TERM is the string that the monitor outputs to indicate that it is idle, and
  50    waiting for input.  This is usually a prompt of some sort.  In the previous
  51    example, it would be `= '.  It is important that TERM really means that the
  52    monitor is idle, otherwise GDB may try to type at it when it isn't ready for
  53    input.  This is a problem because many monitors cannot deal with type-ahead.
  54    TERM may be NULL if the normal prompt is output.
  55
  56    TERM_CMD is used to quit out of the subcommand mode and get back to the main
  57    prompt.  TERM_CMD may be NULL if it isn't necessary.  It will also be
  58    ignored if TERM is NULL.
  59 */
  60
  61 struct memrw_cmd
  62 {
  63   char *cmdb;                   /* Command to send for byte read/write */
  64   char *cmdw;                   /* Command for word (16 bit) read/write */
  65   char *cmdl;                   /* Command for long (32 bit) read/write */
  66   char *cmdll;                  /* Command for long long (64 bit) read/write */
  67   char *resp_delim;             /* String just prior to the desired value */
  68   char *term;                   /* Terminating string to search for */
  69   char *term_cmd;               /* String to get out of sub-mode (if necessary) */
  70 };
  71
  72 struct regrw_cmd
  73 {
  74   char *cmd;                    /* Command to send for reg read/write */
  75   char *resp_delim;             /* String just 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 */
  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) PARAMS ((char *name, int namelen, char *val, int vallen));
 103   void (*load_routine) PARAMS ((serial_t desc, char *file, int hashmark)); /* Download routine */
 104   char *load;                   /* load command */
 105   char *loadresp;               /* Response to load command */
 106   char *prompt;                 /* monitor command prompt */
 107   char *cmd_delim;              /* end-of-command delimitor */
 108   char *cmd_end;                /* optional command terminator */
 109   struct target_ops *target;    /* target operations */
 110   char **loadtypes;             /* the load types that are supported */
 111   char **loadprotos;            /* the load protocols that are supported */
 112   char *baudrates;              /* supported baud rates */
 113   int stopbits;                 /* number of stop bits */
 114   char **regnames;              /* array of register names in ascii */
 115   int magic;                    /* Check value */
 116 };
 117
 118 #define MONITOR_OPS_MAGIC 600925
 119
 120 /* Flag defintions */
 121
 122 #define MO_CLR_BREAK_USES_ADDR 0x1 /* If set, then clear breakpoint command
 123                                       uses address, otherwise it uses an index
 124                                       returned by the monitor.  */
 125 #define MO_FILL_USES_ADDR 0x2   /* If set, then memory fill command uses
 126                                    STARTADDR, ENDADDR+1, VALUE as args, else it
 127                                    uses STARTADDR, LENGTH, VALUE as args. */
 128 #define MO_NEED_REGDUMP_AFTER_CONT 0x4 /* If set, then monitor doesn't auto-
 129                                           matically supply register dump when
 130                                           coming back after a continue.  */
 131 #define MO_GETMEM_NEEDS_RANGE 0x8 /* getmem needs start addr and end addr */
 132
 133 extern struct monitor_ops        *current_monitor;
 134
 135 #define LOADTYPES               (current_monitor->loadtypes)
 136 #define LOADPROTOS              (current_monitor->loadprotos)
 137 #define INIT_CMD                (current_monitor->init)
 138 #define CONT_CMD                (current_monitor->cont)
 139 #define STEP_CMD                (current_monitor->step)
 140 #define SET_BREAK_CMD           (current_monitor->set_break)
 141 #define CLR_BREAK_CMD           (current_monitor->clr_break)
 142 #define SET_MEM                 (current_monitor->setmem)
 143 #define GET_MEM                 (current_monitor->getmem)
 144 #define LOAD_CMD                (current_monitor->load)
 145 #define GET_REG                 (current_monitor->regget)
 146 #define SET_REG                 (current_monitor->regset)
 147 #define CMD_END                 (current_monitor->cmd_end)
 148 #define CMD_DELIM               (current_monitor->cmd_delim)
 149 #define PROMPT                  (current_monitor->prompt)
 150 #define TARGET_OPS              (current_monitor->target)
 151 #define TARGET_NAME             (current_monitor->target->to_shortname)
 152 #define BAUDRATES               (current_monitor->baudrates)
 153 #define STOPBITS                (current_monitor->stopbits)
 154 #define REGNAMES(x)             (current_monitor->regnames[x])
 155 #define ROMCMD(x)               (x.cmd)
 156 #define ROMDELIM(x)             (x.delim)
 157 #define ROMRES(x)               (x.result)
 158
 159 #define push_monitor(x)         current_monitor = x;
 160
 161 #define SREC_SIZE 160
 162
 163 /*
 164  * FIXME: These are to temporarily maintain compatability with the
 165  *      old monitor structure till remote-mon.c is fixed to work
 166  *      like the *-rom.c files.
 167  */
 168 #define MEM_PROMPT              (current_monitor->loadtypes)
 169 #define MEM_SET_CMD             (current_monitor->setmem)
 170 #define MEM_DIS_CMD             (current_monitor->getmem)
 171 #define REG_DELIM               (current_monitor->regset.delim)
 172
 173 extern void monitor_open PARAMS ((char *args, struct monitor_ops *ops, int from_tty));
 174 extern char *monitor_supply_register PARAMS ((int regno, char *valstr));
 175 extern int monitor_expect PARAMS ((char *prompt, char *buf, int buflen));
 176 extern int monitor_expect_prompt PARAMS ((char *buf, int buflen));
 177 extern void monitor_printf ();
 178 extern void init_monitor_ops PARAMS ((struct target_ops *));