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