gdb/serial.h

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