gdb/serial.h

   1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
   2    Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000
   3    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,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef SERIAL_H
  23 #define SERIAL_H
  24
  25 /* For most routines, if a failure is indicated, then errno should be
  26    examined.  */
  27
  28 /* Terminal state pointer.  This is specific to each type of
  29    interface. */
  30
  31 typedef void *serial_ttystate;
  32 struct serial;
  33
  34 /* Try to open NAME.  Returns a new `struct serial *' on success, NULL
  35    on failure. Note that some open calls can block and, if possible,
  36    should be  written to be non-blocking, with calls to ui_look_hook
  37    so they can be cancelled. An async interface for open could be
  38    added to GDB if necessary. */
  39
  40 extern struct serial *serial_open (const char *name);
  41
  42 /* Open a new serial stream using a file handle.  */
  43
  44 extern struct serial *serial_fdopen (const int fd);
  45
  46 /* Push out all buffers, close the device and destroy SCB. */
  47
  48 extern void serial_close (struct serial *scb);
  49
  50 /* Push out all buffers and destroy SCB without closing the device.  */
  51
  52 extern void serial_un_fdopen (struct serial *scb);
  53
  54 /* Read one char from the serial device with TIMEOUT seconds to wait
  55    or -1 to wait forever.  Use timeout of 0 to effect a poll.
  56    Infinite waits are not permitted. Returns unsigned char if ok, else
  57    one of the following codes.  Note that all error return-codes are
  58    guaranteed to be < 0. */
  59
  60 enum serial_rc {
  61   SERIAL_ERROR = -1,    /* General error. */
  62   SERIAL_TIMEOUT = -2,  /* Timeout or data-not-ready during read.
  63                            Unfortunately, through ui_loop_hook(), this
  64                            can also be a QUIT indication.  */
  65   SERIAL_EOF = -3       /* General end-of-file or remote target
  66                            connection closed, indication.  Includes
  67                            things like the line dropping dead. */
  68 };
  69
  70 extern int serial_readchar (struct serial *scb, int timeout);
  71
  72 /* Write LEN chars from STRING to the port SCB.  Returns 0 for
  73    success, non-zero for failure.  */
  74
  75 extern int serial_write (struct serial *scb, const char *str, int len);
  76
  77 /* Write a printf style string onto the serial port. */
  78
  79 extern void serial_printf (struct serial *desc, const char *,...) ATTR_FORMAT (printf, 2, 3);
  80
  81 /* Allow pending output to drain. */
  82
  83 extern int serial_drain_output (struct serial *);
  84
  85 /* Flush (discard) pending output.  Might also flush input (if this
  86    system can't flush only output).  */
  87
  88 extern int serial_flush_output (struct serial *);
  89
  90 /* Flush pending input.  Might also flush output (if this system can't
  91    flush only input).  */
  92
  93 extern int serial_flush_input (struct serial *);
  94
  95 /* Send a break between 0.25 and 0.5 seconds long.  */
  96
  97 extern int serial_send_break (struct serial *scb);
  98
  99 /* Turn the port into raw mode. */
 100
 101 extern void serial_raw (struct serial *scb);
 102
 103 /* Return a pointer to a newly malloc'd ttystate containing the state
 104    of the tty.  */
 105
 106 extern serial_ttystate serial_get_tty_state (struct serial *scb);
 107
 108 /* Set the state of the tty to TTYSTATE.  The change is immediate.
 109    When changing to or from raw mode, input might be discarded.
 110    Returns 0 for success, negative value for error (in which case
 111    errno contains the error).  */
 112
 113 extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate);
 114
 115 /* printf_filtered a user-comprehensible description of ttystate on
 116    the specified STREAM. FIXME: At present this sends output to the
 117    default stream - GDB_STDOUT. */
 118
 119 extern void serial_print_tty_state (struct serial *scb, serial_ttystate ttystate, struct ui_file *);
 120
 121 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
 122    current state (generally obtained from a recent call to
 123    serial_get_tty_state()), but be careful not to discard any input.
 124    This means that we never switch in or out of raw mode, even if
 125    NEW_TTYSTATE specifies a switch.  */
 126
 127 extern int serial_noflush_set_tty_state (struct serial *scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate);
 128
 129 /* Set the baudrate to the decimal value supplied.  Returns 0 for
 130    success, -1 for failure.  */
 131
 132 extern int serial_setbaudrate (struct serial *scb, int rate);
 133
 134 /* Set the number of stop bits to the value specified.  Returns 0 for
 135    success, -1 for failure.  */
 136
 137 #define SERIAL_1_STOPBITS 1
 138 #define SERIAL_1_AND_A_HALF_STOPBITS 2  /* 1.5 bits, snicker... */
 139 #define SERIAL_2_STOPBITS 3
 140
 141 extern int serial_setstopbits (struct serial *scb, int num);
 142
 143 /* Asynchronous serial interface: */
 144
 145 /* Can the serial device support asynchronous mode? */
 146
 147 extern int serial_can_async_p (struct serial *scb);
 148
 149 /* Has the serial device been put in asynchronous mode? */
 150
 151 extern int serial_is_async_p (struct serial *scb);
 152
 153 /* For ASYNC enabled devices, register a callback and enable
 154    asynchronous mode.  To disable asynchronous mode, register a NULL
 155    callback. */
 156
 157 typedef void (serial_event_ftype) (struct serial *scb, void *context);
 158 extern void serial_async (struct serial *scb, serial_event_ftype *handler, void *context);
 159
 160 /* Provide direct access to the underlying FD (if any) used to
 161    implement the serial device.  This interface is clearly
 162    deprecated. Will call internal_error() if the operation isn't
 163    applicable to the current serial device. */
 164
 165 extern int deprecated_serial_fd (struct serial *scb);
 166
 167 /* Trace/debug mechanism.
 168
 169    serial_debug() enables/disables internal debugging.
 170    serial_debug_p() indicates the current debug state. */
 171
 172 extern void serial_debug (struct serial *scb, int debug_p);
 173
 174 extern int serial_debug_p (struct serial *scb);
 175
 176
 177 /* Details of an instance of a serial object */
 178
 179 struct serial
 180   {
 181     int fd;                     /* File descriptor */
 182     struct serial_ops *ops;     /* Function vector */
 183     void *state;                /* Local context info for open FD */
 184     serial_ttystate ttystate;   /* Not used (yet) */
 185     int bufcnt;                 /* Amount of data remaining in receive
 186                                    buffer.  -ve for sticky errors. */
 187     unsigned char *bufp;        /* Current byte */
 188     unsigned char buf[BUFSIZ];  /* Da buffer itself */
 189     int current_timeout;        /* (ser-unix.c termio{,s} only), last
 190                                    value of VTIME */
 191     int timeout_remaining;      /* (ser-unix.c termio{,s} only), we
 192                                    still need to wait for this many
 193                                    more seconds.  */
 194     char *name;                 /* The name of the device or host */
 195     struct serial *next;        /* Pointer to the next `struct serial *' */
 196     int refcnt;                 /* Number of pointers to this block */
 197     int debug_p;                /* Trace this serial devices operation. */
 198     int async_state;            /* Async internal state. */
 199     void *async_context;        /* Async event thread's context */
 200     serial_event_ftype *async_handler;/* Async event handler */
 201   };
 202
 203 struct serial_ops
 204   {
 205     char *name;
 206     struct serial_ops *next;
 207     int (*open) (struct serial *, const char *name);
 208     void (*close) (struct serial *);
 209     int (*readchar) (struct serial *, int timeout);
 210     int (*write) (struct serial *, const char *str, int len);
 211     /* Discard pending output */
 212     int (*flush_output) (struct serial *);
 213     /* Discard pending input */
 214     int (*flush_input) (struct serial *);
 215     int (*send_break) (struct serial *);
 216     void (*go_raw) (struct serial *);
 217     serial_ttystate (*get_tty_state) (struct serial *);
 218     int (*set_tty_state) (struct serial *, serial_ttystate);
 219     void (*print_tty_state) (struct serial *, serial_ttystate,
 220                              struct ui_file *);
 221     int (*noflush_set_tty_state) (struct serial *, serial_ttystate,
 222                                   serial_ttystate);
 223     int (*setbaudrate) (struct serial *, int rate);
 224     int (*setstopbits) (struct serial *, int num);
 225     /* Wait for output to drain */
 226     int (*drain_output) (struct serial *);
 227     /* Change the serial device into/out of asynchronous mode, call
 228        the specified function when ever there is something
 229        interesting. */
 230     void (*async) (struct serial *scb, int async_p);
 231   };
 232
 233 /* Add a new serial interface to the interface list */
 234
 235 extern void serial_add_interface (struct serial_ops * optable);
 236
 237 /* File in which to record the remote debugging session */
 238
 239 extern void serial_log_command (const char *);
 240
 241 #endif /* SERIAL_H */