gdb/serial.h

   1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
   2    Copyright 1992, 1993 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef SERIAL_H
  22 #define SERIAL_H
  23
  24 /* Terminal state pointer.  This is specific to each type of interface. */
  25
  26 typedef PTR serial_ttystate;
  27
  28 struct _serial_t
  29   {
  30     int fd;                     /* File descriptor */
  31     struct serial_ops *ops;     /* Function vector */
  32     void *state;                /* Local context info for open FD */
  33     serial_ttystate ttystate;   /* Not used (yet) */
  34     int bufcnt;                 /* Amount of data in receive buffer */
  35     unsigned char *bufp;        /* Current byte */
  36     unsigned char buf[BUFSIZ];  /* Da buffer itself */
  37     int current_timeout;        /* (termio{s} only), last value of VTIME */
  38     /* ser-unix.c termio{,s} only, we still need to wait for this many more
  39        seconds.  */
  40     int timeout_remaining;
  41     char *name;                 /* The name of the device or host */
  42     struct _serial_t *next;     /* Pointer to the next serial_t */
  43     int refcnt;                 /* Number of pointers to this block */
  44   };
  45
  46 typedef struct _serial_t *serial_t;
  47
  48 struct serial_ops
  49   {
  50     char *name;
  51     struct serial_ops *next;
  52     int (*open) PARAMS ((serial_t, const char *name));
  53     void (*close) PARAMS ((serial_t));
  54     int (*readchar) PARAMS ((serial_t, int timeout));
  55     int (*write) PARAMS ((serial_t, const char *str, int len));
  56     /* Discard pending output */
  57     int (*flush_output) PARAMS ((serial_t));
  58     /* Discard pending input */
  59     int (*flush_input) PARAMS ((serial_t));
  60     int (*send_break) PARAMS ((serial_t));
  61     void (*go_raw) PARAMS ((serial_t));
  62       serial_ttystate (*get_tty_state) PARAMS ((serial_t));
  63     int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
  64     void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
  65     int (*noflush_set_tty_state)
  66       PARAMS ((serial_t, serial_ttystate, serial_ttystate));
  67     int (*setbaudrate) PARAMS ((serial_t, int rate));
  68     int (*setstopbits) PARAMS ((serial_t, int num));
  69     /* Wait for output to drain */
  70     int (*drain_output) PARAMS ((serial_t));
  71   };
  72
  73 /* Add a new serial interface to the interface list */
  74
  75 void serial_add_interface PARAMS ((struct serial_ops * optable));
  76
  77 serial_t serial_open PARAMS ((const char *name));
  78
  79 serial_t serial_fdopen PARAMS ((const int fd));
  80
  81 /* For most routines, if a failure is indicated, then errno should be
  82    examined.  */
  83
  84 /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
  85  */
  86
  87 #define SERIAL_OPEN(NAME) serial_open(NAME)
  88
  89 /* Open a new serial stream using a file handle.  */
  90
  91 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
  92
  93 /* Allow pending output to drain. */
  94
  95 #define SERIAL_DRAIN_OUTPUT(SERIAL_T) \
  96   ((SERIAL_T)->ops->drain_output((SERIAL_T)))
  97
  98 /* Flush (discard) pending output.  Might also flush input (if this system can't flush
  99    only output).  */
 100
 101 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
 102   ((SERIAL_T)->ops->flush_output((SERIAL_T)))
 103
 104 /* Flush pending input.  Might also flush output (if this system can't flush
 105    only input).  */
 106
 107 #define SERIAL_FLUSH_INPUT(SERIAL_T)\
 108   ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
 109
 110 /* Send a break between 0.25 and 0.5 seconds long.  */
 111
 112 extern int serial_send_break PARAMS ((serial_t scb));
 113
 114 #define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T)
 115
 116 /* Turn the port into raw mode. */
 117
 118 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
 119
 120 /* Return a pointer to a newly malloc'd ttystate containing the state
 121    of the tty.  */
 122 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
 123
 124 /* Set the state of the tty to TTYSTATE.  The change is immediate.
 125    When changing to or from raw mode, input might be discarded.
 126    Returns 0 for success, negative value for error (in which case errno
 127    contains the error).  */
 128 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
 129
 130 /* printf_filtered a user-comprehensible description of ttystate.  */
 131 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
 132   ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
 133
 134 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
 135    current state (generally obtained from a recent call to
 136    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
 137    This means that we never switch in or out of raw mode, even
 138    if NEW_TTYSTATE specifies a switch.  */
 139 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
 140   ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
 141     ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
 142
 143 /* Read one char from the serial device with TIMEOUT seconds to wait
 144    or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
 145    char if ok, else one of the following codes.  Note that all error
 146    codes are guaranteed to be < 0.  */
 147
 148 #define SERIAL_ERROR -1         /* General error, see errno for details */
 149 #define SERIAL_TIMEOUT -2
 150 #define SERIAL_EOF -3
 151
 152 extern int serial_readchar PARAMS ((serial_t scb, int timeout));
 153
 154 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT)  serial_readchar (SERIAL_T, TIMEOUT)
 155
 156 /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
 157    -1 for failure.  */
 158
 159 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
 160
 161 /* Set the number of stop bits to the value specified.  Returns 0 for success,
 162    -1 for failure.  */
 163
 164 #define SERIAL_1_STOPBITS 1
 165 #define SERIAL_1_AND_A_HALF_STOPBITS 2  /* 1.5 bits, snicker... */
 166 #define SERIAL_2_STOPBITS 3
 167
 168 #define SERIAL_SETSTOPBITS(SERIAL_T, NUM) ((SERIAL_T)->ops->setstopbits((SERIAL_T), NUM))
 169
 170 /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
 171    success, non-zero for failure.  */
 172
 173 extern int serial_write PARAMS ((serial_t scb, const char *str, int len));
 174
 175 #define SERIAL_WRITE(SERIAL_T, STRING,LEN)  serial_write (SERIAL_T, STRING, LEN)
 176
 177 /* Push out all buffers, close the device and destroy SERIAL_T. */
 178
 179 extern void serial_close PARAMS ((serial_t, int));
 180
 181 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T, 1)
 182
 183 /* Push out all buffers and destroy SERIAL_T without closing the device.  */
 184
 185 #define SERIAL_UN_FDOPEN(SERIAL_T) serial_close(SERIAL_T, 0)
 186
 187 extern void serial_printf
 188 PARAMS ((serial_t desc, const char *,...))
 189 ATTR_FORMAT (printf, 2, 3);
 190
 191 /* File in which to record the remote debugging session */
 192
 193      extern void serial_log_command PARAMS ((const char *));
 194
 195 #endif /* SERIAL_H */