contrib/gdb/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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 timeout. */
  48 #define sr_get_timeout()                (sr_settings.timeout)
  49 #define sr_set_timeout(newval)          (sr_settings.timeout = (newval))
  50
  51 /* get and set device. */
  52 #define sr_get_device()                 (sr_settings.device)
  53 #define sr_set_device(newval) \
  54 { \
  55     if (sr_settings.device) free(sr_settings.device); \
  56     sr_settings.device = (newval); \
  57 }
  58
  59 /* get and set descriptor value. */
  60 #define sr_get_desc()                   (sr_settings.desc)
  61 #define sr_set_desc(newval)             (sr_settings.desc = (newval))
  62
  63 /* get and set retries. */
  64 #define sr_get_retries()                (sr_settings.retries)
  65 #define sr_set_retries(newval)          (sr_settings.retries = (newval))
  66
  67 #define sr_is_open()                    (sr_settings.desc != NULL)
  68
  69 #define sr_check_open()         { if (!sr_is_open()) \
  70                                     error ("Remote device not open"); }
  71
  72 struct gr_settings {
  73   /* This is our data cache. */
  74   DCACHE *dcache;
  75   char *prompt;
  76   struct target_ops *ops;
  77   int (*clear_all_breakpoints)PARAMS((void));
  78   memxferfunc readfunc;
  79   memxferfunc writefunc;
  80   void (*checkin)PARAMS((void));
  81 };
  82
  83 extern struct gr_settings *gr_settings;
  84
  85 /* get and set dcache. */
  86 #define gr_get_dcache()                 (gr_settings->dcache)
  87 #define gr_set_dcache(newval)           (gr_settings->dcache = (newval))
  88
  89 /* get and set prompt. */
  90 #define gr_get_prompt()                 (gr_settings->prompt)
  91 #define gr_set_prompt(newval)           (gr_settings->prompt = (newval))
  92
  93 /* get and set ops. */
  94 #define gr_get_ops()                    (gr_settings->ops)
  95 #define gr_set_ops(newval)              (gr_settings->ops = (newval))
  96
  97 #define gr_clear_all_breakpoints()      ((gr_settings->clear_all_breakpoints)())
  98 #define gr_checkin()                    ((gr_settings->checkin)())
  99
 100 /* Keep discarding input until we see the prompt.
 101
 102    The convention for dealing with the prompt is that you
 103    o give your command
 104    o *then* wait for the prompt.
 105
 106    Thus the last thing that a procedure does with the serial line
 107    will be an gr_expect_prompt().  Exception:  resume does not
 108    wait for the prompt, because the terminal is being handed over
 109    to the inferior.  However, the next thing which happens after that
 110    is a bug_wait which does wait for the prompt.
 111    Note that this includes abnormal exit, e.g. error().  This is
 112    necessary to prevent getting into states from which we can't
 113    recover.  */
 114
 115 #define gr_expect_prompt()      sr_expect(gr_get_prompt())
 116
 117 int gr_fetch_word PARAMS((CORE_ADDR addr));
 118 int gr_multi_scan PARAMS((char *list[], int passthrough));
 119 int sr_get_hex_digit PARAMS((int ignore_space));
 120 int sr_pollchar PARAMS((void));
 121 int sr_readchar PARAMS((void));
 122 int sr_timed_read PARAMS((char *buf, int n));
 123 long sr_get_hex_word PARAMS((void));
 124 void gr_close PARAMS((int quitting));
 125 void gr_create_inferior PARAMS((char *execfile, char *args, char **env));
 126 void gr_detach PARAMS((char *args, int from_tty));
 127 void gr_files_info PARAMS((struct target_ops *ops));
 128 void gr_generic_checkin PARAMS((void));
 129 void gr_kill PARAMS((void));
 130 void gr_mourn PARAMS((void));
 131 void gr_prepare_to_store PARAMS((void));
 132 void gr_store_word PARAMS((CORE_ADDR addr, int word));
 133 void sr_expect PARAMS((char *string));
 134 void sr_get_hex_byte PARAMS((char *byt));
 135 void sr_scan_args PARAMS((char *proto, char *args));
 136 void sr_write PARAMS((char *a, int l));
 137 void sr_write_cr PARAMS((char *s));
 138
 139 void gr_open PARAMS((char *args, int from_tty,
 140                      struct gr_settings *gr_settings));
 141 void gr_load_image PARAMS((char*, int from_tty));
 142 #endif /* REMOTE_UTILS_H */