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