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