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