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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifndef SERIAL_H
  21 #define SERIAL_H
  22
  23 /* Terminal state pointer.  This is specific to each type of interface. */
  24
  25 typedef PTR serial_ttystate;
  26
  27 struct _serial_t
  28 {
  29   int fd;                       /* File descriptor */
  30   struct serial_ops *ops;       /* Function vector */
  31   serial_ttystate ttystate;     /* Not used (yet) */
  32   int bufcnt;                   /* Amount of data in receive buffer */
  33   unsigned char *bufp;          /* Current byte */
  34   unsigned char buf[BUFSIZ];    /* Da buffer itself */
  35   int current_timeout;          /* (termio{s} only), last value of VTIME */
  36 };
  37
  38 typedef struct _serial_t *serial_t;
  39
  40 struct serial_ops {
  41   char *name;
  42   struct serial_ops *next;
  43   int (*open) PARAMS ((serial_t, const char *name));
  44   void (*close) PARAMS ((serial_t));
  45   int (*readchar) PARAMS ((serial_t, int timeout));
  46   int (*write) PARAMS ((serial_t, const char *str, int len));
  47   int (*flush_output) PARAMS ((serial_t));
  48   int (*flush_input) PARAMS ((serial_t));
  49   int (*send_break) PARAMS ((serial_t));
  50   void (*go_raw) PARAMS ((serial_t));
  51   serial_ttystate (*get_tty_state) PARAMS ((serial_t));
  52   int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
  53   void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
  54   int (*noflush_set_tty_state)
  55     PARAMS ((serial_t, serial_ttystate, serial_ttystate));
  56   int (*setbaudrate) PARAMS ((serial_t, int rate));
  57 };
  58
  59 /* Add a new serial interface to the interface list */
  60
  61 void serial_add_interface PARAMS ((struct serial_ops *optable));
  62
  63 serial_t serial_open PARAMS ((const char *name));
  64
  65 serial_t serial_fdopen PARAMS ((int fd));
  66
  67 /* For most routines, if a failure is indicated, then errno should be
  68    examined.  */
  69
  70 /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
  71  */
  72
  73 #define SERIAL_OPEN(NAME) serial_open(NAME)
  74
  75 /* Open a new serial stream using a file handle.  */
  76
  77 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
  78
  79 /* Flush pending output.  Might also flush input (if this system can't flush
  80    only output).  */
  81
  82 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
  83   ((SERIAL_T)->ops->flush_output((SERIAL_T)))
  84
  85 /* Flush pending input.  Might also flush output (if this system can't flush
  86    only input).  */
  87
  88 #define SERIAL_FLUSH_INPUT(SERIAL_T)\
  89   ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
  90
  91 /* Send a break between 0.25 and 0.5 seconds long.  */
  92
  93 #define SERIAL_SEND_BREAK(SERIAL_T) \
  94   ((*(SERIAL_T)->ops->send_break) (SERIAL_T))
  95
  96 /* Turn the port into raw mode. */
  97
  98 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
  99
 100 /* Return a pointer to a newly malloc'd ttystate containing the state
 101    of the tty.  */
 102 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
 103
 104 /* Set the state of the tty to TTYSTATE.  The change is immediate.
 105    When changing to or from raw mode, input might be discarded.  */
 106 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
 107
 108 /* printf_filtered a user-comprehensible description of ttystate.  */
 109 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
 110   ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
 111
 112 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
 113    current state (generally obtained from a recent call to
 114    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
 115    This means that we never switch in or out of raw mode, even
 116    if NEW_TTYSTATE specifies a switch.  */
 117 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
 118   ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
 119     ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
 120
 121 /* Read one char from the serial device with TIMEOUT seconds to wait
 122    or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
 123    char if ok, else one of the following codes.  Note that all error
 124    codes are guaranteed to be < 0.  */
 125
 126 #define SERIAL_ERROR -1         /* General error, see errno for details */
 127 #define SERIAL_TIMEOUT -2
 128 #define SERIAL_EOF -3
 129
 130 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
 131
 132 /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
 133    -1 for failure.  */
 134
 135 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
 136
 137 /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
 138    success, non-zero for failure.  */
 139
 140 #define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
 141
 142 /* Push out all buffers, close the device and destroy SERIAL_T. */
 143
 144 void serial_close PARAMS ((serial_t));
 145
 146 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
 147
 148 /* Destroy SERIAL_T without doing the rest of the stuff that SERIAL_CLOSE
 149    does.  */
 150
 151 #define SERIAL_UN_FDOPEN(SERIAL_T) (free (SERIAL_T))
 152
 153 #endif /* SERIAL_H */