gdb/remote-utils.h

   1 /* Generic support for remote debugging interfaces.
   2
   3    Copyright 1993 Free Software Foundation, Inc.
   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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 #ifndef REMOTE_UTILS_H
  22 #define REMOTE_UTILS_H
  23
  24 #include "serial.h"
  25 #include "target.h"
  26 #include "dcache.h"
  27
  28 /* Stuff that should be shared (and handled consistently) among the various
  29    remote targets.  */
  30
  31 struct _sr_settings {
  32   unsigned int timeout;
  33
  34   int retries;
  35
  36   char *device;
  37   serial_t desc;
  38
  39 };
  40
  41 extern struct _sr_settings sr_settings;
  42
  43 /* get and set debug value. */
  44 #define sr_get_debug()                  (remote_debug)
  45 #define sr_set_debug(newval)            (remote_debug = (newval))
  46
  47 /* get and set baud rate. */
  48 #define sr_get_baud_rate()              (baud_rate)
  49 #define sr_set_baud_rate(newval)        (baud_rate = (newval))
  50
  51 /* get and set timeout. */
  52 #define sr_get_timeout()                (sr_settings.timeout)
  53 #define sr_set_timeout(newval)          (sr_settings.timeout = (newval))
  54
  55 /* get and set device. */
  56 #define sr_get_device()                 (sr_settings.device)
  57 #define sr_set_device(newval) \
  58 { \
  59     if (sr_settings.device) free(sr_settings.device); \
  60     sr_settings.device = (newval); \
  61 }
  62
  63 /* get and set descriptor value. */
  64 #define sr_get_desc()                   (sr_settings.desc)
  65 #define sr_set_desc(newval)             (sr_settings.desc = (newval))
  66
  67 /* get and set retries. */
  68 #define sr_get_retries()                (sr_settings.retries)
  69 #define sr_set_retries(newval)          (sr_settings.retries = (newval))
  70
  71 #define sr_is_open()                    (sr_settings.desc != NULL)
  72
  73 #define sr_check_open()         { if (!sr_is_open()) \
  74                                     error ("Remote device not open"); }
  75
  76 struct gr_settings {
  77   /* This is our data cache. */
  78   DCACHE *dcache;
  79   char *prompt;
  80   struct target_ops *ops;
  81   int (*clear_all_breakpoints)PARAMS((void));
  82   memxferfunc readfunc;
  83   memxferfunc writefunc;
  84   void (*checkin)PARAMS((void));
  85 };
  86
  87 extern struct gr_settings *gr_settings;
  88
  89 /* get and set dcache. */
  90 #define gr_get_dcache()                 (gr_settings->dcache)
  91 #define gr_set_dcache(newval)           (gr_settings->dcache = (newval))
  92
  93 /* get and set prompt. */
  94 #define gr_get_prompt()                 (gr_settings->prompt)
  95 #define gr_set_prompt(newval)           (gr_settings->prompt = (newval))
  96
  97 /* get and set ops. */
  98 #define gr_get_ops()                    (gr_settings->ops)
  99 #define gr_set_ops(newval)              (gr_settings->ops = (newval))
 100
 101 #define gr_clear_all_breakpoints()      ((gr_settings->clear_all_breakpoints)())
 102 #define gr_checkin()                    ((gr_settings->checkin)())
 103
 104 /* Keep discarding input until we see the prompt.
 105
 106    The convention for dealing with the prompt is that you
 107    o give your command
 108    o *then* wait for the prompt.
 109
 110    Thus the last thing that a procedure does with the serial line
 111    will be an gr_expect_prompt().  Exception:  resume does not
 112    wait for the prompt, because the terminal is being handed over
 113    to the inferior.  However, the next thing which happens after that
 114    is a bug_wait which does wait for the prompt.
 115    Note that this includes abnormal exit, e.g. error().  This is
 116    necessary to prevent getting into states from which we can't
 117    recover.  */
 118
 119 #define gr_expect_prompt()      sr_expect(gr_get_prompt())
 120
 121 int gr_fetch_word PARAMS((CORE_ADDR addr));
 122 int gr_multi_scan PARAMS((char *list[], int passthrough));
 123 int sr_get_hex_digit PARAMS((int ignore_space));
 124 int sr_pollchar PARAMS((void));
 125 int sr_readchar PARAMS((void));
 126 int sr_timed_read PARAMS((char *buf, int n));
 127 long sr_get_hex_word PARAMS((void));
 128 void gr_close PARAMS((int quitting));
 129 void gr_create_inferior PARAMS((char *execfile, char *args, char **env));
 130 void gr_detach PARAMS((char *args, int from_tty));
 131 void gr_files_info PARAMS((struct target_ops *ops));
 132 void gr_generic_checkin PARAMS((void));
 133 void gr_kill PARAMS((void));
 134 void gr_mourn PARAMS((void));
 135 void gr_prepare_to_store PARAMS((void));
 136 void gr_store_word PARAMS((CORE_ADDR addr, int word));
 137 void sr_expect PARAMS((char *string));
 138 void sr_get_hex_byte PARAMS((char *byt));
 139 void sr_scan_args PARAMS((char *proto, char *args));
 140 void sr_write PARAMS((char *a, int l));
 141 void sr_write_cr PARAMS((char *s));
 142
 143 void gr_open PARAMS((char *args, int from_tty,
 144                      struct gr_settings *gr_settings));
 145
 146
 147 #endif /* REMOTE_UTILS_H */