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