Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Remote serial support interface definitions for GDB, the GNU Debugger. |
0ea3f30e DJ |
2 | Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, |
3 | 2004, 2005, 2006 | |
b6ba6518 | 4 | Free Software Foundation, Inc. |
c906108c | 5 | |
c5aa993b | 6 | This file is part of GDB. |
c906108c | 7 | |
c5aa993b JM |
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. | |
c906108c | 12 | |
c5aa993b JM |
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. | |
c906108c | 17 | |
c5aa993b JM |
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 | |
197e01b6 EZ |
20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
21 | Boston, MA 02110-1301, USA. */ | |
c906108c SS |
22 | |
23 | #ifndef SERIAL_H | |
24 | #define SERIAL_H | |
25 | ||
0ea3f30e DJ |
26 | #ifdef USE_WIN32API |
27 | #include <windows.h> | |
28 | #endif | |
29 | ||
da3331ec AC |
30 | struct ui_file; |
31 | ||
c2c6d25f JM |
32 | /* For most routines, if a failure is indicated, then errno should be |
33 | examined. */ | |
c906108c | 34 | |
c2c6d25f | 35 | /* Terminal state pointer. This is specific to each type of |
2c1ab592 | 36 | interface. */ |
c906108c | 37 | |
c2c6d25f | 38 | typedef void *serial_ttystate; |
65e2f740 | 39 | struct serial; |
c906108c | 40 | |
819cc324 | 41 | /* Try to open NAME. Returns a new `struct serial *' on success, NULL |
63b5bc2f MH |
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 | |
2c1ab592 | 45 | added to GDB if necessary. */ |
c906108c | 46 | |
819cc324 | 47 | extern struct serial *serial_open (const char *name); |
c906108c | 48 | |
0ea3f30e DJ |
49 | /* Find an already opened serial stream using a file handle. */ |
50 | ||
51 | extern struct serial *serial_for_fd (int fd); | |
52 | ||
c2c6d25f | 53 | /* Open a new serial stream using a file handle. */ |
c906108c | 54 | |
819cc324 | 55 | extern struct serial *serial_fdopen (const int fd); |
c906108c | 56 | |
2c1ab592 | 57 | /* Push out all buffers, close the device and destroy SCB. */ |
c906108c | 58 | |
819cc324 | 59 | extern void serial_close (struct serial *scb); |
c906108c | 60 | |
819cc324 | 61 | /* Push out all buffers and destroy SCB without closing the device. */ |
c906108c | 62 | |
819cc324 | 63 | extern void serial_un_fdopen (struct serial *scb); |
c906108c | 64 | |
c2c6d25f | 65 | /* Read one char from the serial device with TIMEOUT seconds to wait |
2df3850c JM |
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 | |
2c1ab592 | 69 | guaranteed to be < 0. */ |
2acceee2 JM |
70 | |
71 | enum serial_rc { | |
2c1ab592 | 72 | SERIAL_ERROR = -1, /* General error. */ |
2df3850c | 73 | SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read. |
98bbd631 | 74 | Unfortunately, through |
2c1ab592 MS |
75 | deprecated_ui_loop_hook (), this can also |
76 | be a QUIT indication. */ | |
2acceee2 JM |
77 | SERIAL_EOF = -3 /* General end-of-file or remote target |
78 | connection closed, indication. Includes | |
2c1ab592 | 79 | things like the line dropping dead. */ |
2acceee2 | 80 | }; |
c2c6d25f | 81 | |
819cc324 | 82 | extern int serial_readchar (struct serial *scb, int timeout); |
c2c6d25f | 83 | |
819cc324 | 84 | /* Write LEN chars from STRING to the port SCB. Returns 0 for |
c2c6d25f JM |
85 | success, non-zero for failure. */ |
86 | ||
819cc324 | 87 | extern int serial_write (struct serial *scb, const char *str, int len); |
c2c6d25f | 88 | |
2c1ab592 | 89 | /* Write a printf style string onto the serial port. */ |
c2c6d25f | 90 | |
2c1ab592 MS |
91 | extern void serial_printf (struct serial *desc, |
92 | const char *,...) ATTR_FORMAT (printf, 2, 3); | |
c906108c | 93 | |
2c1ab592 | 94 | /* Allow pending output to drain. */ |
c906108c | 95 | |
819cc324 | 96 | extern int serial_drain_output (struct serial *); |
c5aa993b | 97 | |
c2c6d25f JM |
98 | /* Flush (discard) pending output. Might also flush input (if this |
99 | system can't flush only output). */ | |
c906108c | 100 | |
819cc324 | 101 | extern int serial_flush_output (struct serial *); |
c906108c | 102 | |
c2c6d25f JM |
103 | /* Flush pending input. Might also flush output (if this system can't |
104 | flush only input). */ | |
c906108c | 105 | |
819cc324 | 106 | extern int serial_flush_input (struct serial *); |
c906108c SS |
107 | |
108 | /* Send a break between 0.25 and 0.5 seconds long. */ | |
109 | ||
819cc324 | 110 | extern int serial_send_break (struct serial *scb); |
c906108c | 111 | |
2c1ab592 | 112 | /* Turn the port into raw mode. */ |
c906108c | 113 | |
819cc324 | 114 | extern void serial_raw (struct serial *scb); |
c906108c SS |
115 | |
116 | /* Return a pointer to a newly malloc'd ttystate containing the state | |
117 | of the tty. */ | |
c2c6d25f | 118 | |
819cc324 | 119 | extern serial_ttystate serial_get_tty_state (struct serial *scb); |
c906108c SS |
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. | |
c2c6d25f JM |
123 | Returns 0 for success, negative value for error (in which case |
124 | errno contains the error). */ | |
125 | ||
819cc324 | 126 | extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate); |
c906108c | 127 | |
c2c6d25f JM |
128 | /* printf_filtered a user-comprehensible description of ttystate on |
129 | the specified STREAM. FIXME: At present this sends output to the | |
2c1ab592 | 130 | default stream - GDB_STDOUT. */ |
c2c6d25f | 131 | |
819cc324 | 132 | extern void serial_print_tty_state (struct serial *scb, serial_ttystate ttystate, struct ui_file *); |
c906108c SS |
133 | |
134 | /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the | |
135 | current state (generally obtained from a recent call to | |
2cd58942 | 136 | serial_get_tty_state()), but be careful not to discard any input. |
c2c6d25f JM |
137 | This means that we never switch in or out of raw mode, even if |
138 | NEW_TTYSTATE specifies a switch. */ | |
139 | ||
819cc324 | 140 | extern int serial_noflush_set_tty_state (struct serial *scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate); |
c906108c | 141 | |
c2c6d25f JM |
142 | /* Set the baudrate to the decimal value supplied. Returns 0 for |
143 | success, -1 for failure. */ | |
c906108c | 144 | |
819cc324 | 145 | extern int serial_setbaudrate (struct serial *scb, int rate); |
c906108c | 146 | |
c2c6d25f JM |
147 | /* Set the number of stop bits to the value specified. Returns 0 for |
148 | success, -1 for failure. */ | |
c906108c | 149 | |
c2c6d25f | 150 | #define SERIAL_1_STOPBITS 1 |
2c1ab592 | 151 | #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */ |
c2c6d25f | 152 | #define SERIAL_2_STOPBITS 3 |
c906108c | 153 | |
819cc324 | 154 | extern int serial_setstopbits (struct serial *scb, int num); |
c906108c | 155 | |
c2c6d25f | 156 | /* Asynchronous serial interface: */ |
c906108c | 157 | |
c2c6d25f | 158 | /* Can the serial device support asynchronous mode? */ |
c906108c | 159 | |
819cc324 | 160 | extern int serial_can_async_p (struct serial *scb); |
c906108c | 161 | |
c2c6d25f | 162 | /* Has the serial device been put in asynchronous mode? */ |
c906108c | 163 | |
819cc324 | 164 | extern int serial_is_async_p (struct serial *scb); |
c906108c | 165 | |
c2c6d25f JM |
166 | /* For ASYNC enabled devices, register a callback and enable |
167 | asynchronous mode. To disable asynchronous mode, register a NULL | |
2c1ab592 | 168 | callback. */ |
c906108c | 169 | |
819cc324 AC |
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); | |
c906108c | 172 | |
c2c6d25f JM |
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 | |
2c1ab592 | 176 | applicable to the current serial device. */ |
c906108c | 177 | |
819cc324 | 178 | extern int deprecated_serial_fd (struct serial *scb); |
c906108c | 179 | |
2acceee2 JM |
180 | /* Trace/debug mechanism. |
181 | ||
2cd58942 | 182 | serial_debug() enables/disables internal debugging. |
2c1ab592 | 183 | serial_debug_p() indicates the current debug state. */ |
2acceee2 | 184 | |
819cc324 | 185 | extern void serial_debug (struct serial *scb, int debug_p); |
2acceee2 | 186 | |
819cc324 | 187 | extern int serial_debug_p (struct serial *scb); |
2acceee2 | 188 | |
c906108c | 189 | |
c2c6d25f | 190 | /* Details of an instance of a serial object */ |
c906108c | 191 | |
65e2f740 | 192 | struct serial |
c2c6d25f JM |
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) */ | |
2acceee2 | 198 | int bufcnt; /* Amount of data remaining in receive |
2c1ab592 | 199 | buffer. -ve for sticky errors. */ |
c2c6d25f JM |
200 | unsigned char *bufp; /* Current byte */ |
201 | unsigned char buf[BUFSIZ]; /* Da buffer itself */ | |
2acceee2 JM |
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. */ | |
c2c6d25f | 207 | char *name; /* The name of the device or host */ |
819cc324 | 208 | struct serial *next; /* Pointer to the next `struct serial *' */ |
c2c6d25f | 209 | int refcnt; /* Number of pointers to this block */ |
2c1ab592 MS |
210 | int debug_p; /* Trace this serial devices operation. */ |
211 | int async_state; /* Async internal state. */ | |
c2c6d25f JM |
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; | |
819cc324 AC |
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); | |
c2c6d25f | 224 | /* Discard pending output */ |
819cc324 | 225 | int (*flush_output) (struct serial *); |
c2c6d25f | 226 | /* Discard pending input */ |
819cc324 AC |
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); | |
c2c6d25f | 238 | /* Wait for output to drain */ |
819cc324 | 239 | int (*drain_output) (struct serial *); |
c2c6d25f JM |
240 | /* Change the serial device into/out of asynchronous mode, call |
241 | the specified function when ever there is something | |
2c1ab592 | 242 | interesting. */ |
819cc324 | 243 | void (*async) (struct serial *scb, int async_p); |
b4505029 MM |
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); | |
0ea3f30e DJ |
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); | |
c3e2b812 | 256 | void (*done_wait_handle) (struct serial *scb); |
0ea3f30e | 257 | #endif /* USE_WIN32API */ |
c2c6d25f JM |
258 | }; |
259 | ||
260 | /* Add a new serial interface to the interface list */ | |
c906108c | 261 | |
c2c6d25f | 262 | extern void serial_add_interface (struct serial_ops * optable); |
c906108c SS |
263 | |
264 | /* File in which to record the remote debugging session */ | |
265 | ||
c2c6d25f | 266 | extern void serial_log_command (const char *); |
c906108c | 267 | |
0ea3f30e DJ |
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 | ||
c3e2b812 DJ |
274 | /* Windows-only: signal that we are done with the wait handles. */ |
275 | extern void serial_done_wait_handle (struct serial *); | |
276 | ||
0ea3f30e DJ |
277 | #endif /* USE_WIN32API */ |
278 | ||
c906108c | 279 | #endif /* SERIAL_H */ |