Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Remote serial support interface definitions for GDB, the GNU Debugger. |
d9fcf2fb | 2 | Copyright 1992, 1993, 1999, 2000 Free Software Foundation, Inc. |
c906108c | 3 | |
c5aa993b | 4 | This file is part of GDB. |
c906108c | 5 | |
c5aa993b JM |
6 | This program is free software; you can redistribute it and/or modify |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2 of the License, or | |
9 | (at your option) any later version. | |
c906108c | 10 | |
c5aa993b JM |
11 | This program is distributed in the hope that it will be useful, |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
c906108c | 15 | |
c5aa993b JM |
16 | You should have received a copy of the GNU General Public License |
17 | along with this program; if not, write to the Free Software | |
18 | Foundation, Inc., 59 Temple Place - Suite 330, | |
19 | Boston, MA 02111-1307, USA. */ | |
c906108c SS |
20 | |
21 | #ifndef SERIAL_H | |
22 | #define SERIAL_H | |
23 | ||
c2c6d25f JM |
24 | /* For most routines, if a failure is indicated, then errno should be |
25 | examined. */ | |
c906108c | 26 | |
c2c6d25f JM |
27 | /* Terminal state pointer. This is specific to each type of |
28 | interface. */ | |
c906108c | 29 | |
c2c6d25f JM |
30 | typedef void *serial_ttystate; |
31 | struct _serial_t; | |
c906108c SS |
32 | typedef struct _serial_t *serial_t; |
33 | ||
c2c6d25f JM |
34 | /* Try to open NAME. Returns a new serial_t on success, NULL on |
35 | failure. */ | |
c906108c | 36 | |
c2c6d25f JM |
37 | extern serial_t serial_open (const char *name); |
38 | #define SERIAL_OPEN(NAME) serial_open(NAME) | |
c906108c | 39 | |
c2c6d25f | 40 | /* Open a new serial stream using a file handle. */ |
c906108c | 41 | |
c2c6d25f JM |
42 | extern serial_t serial_fdopen (const int fd); |
43 | #define SERIAL_FDOPEN(FD) serial_fdopen(FD) | |
c906108c | 44 | |
c2c6d25f | 45 | /* Push out all buffers, close the device and destroy SERIAL_T. */ |
c906108c | 46 | |
c2c6d25f JM |
47 | extern void serial_close (serial_t); |
48 | #define SERIAL_CLOSE(SERIAL_T) serial_close ((SERIAL_T)) | |
c906108c | 49 | |
c2c6d25f JM |
50 | /* Push out all buffers and destroy SERIAL_T without closing the |
51 | device. */ | |
c906108c | 52 | |
c2c6d25f JM |
53 | extern void serial_un_fdopen (serial_t scb); |
54 | #define SERIAL_UN_FDOPEN(SERIAL_T) serial_un_fdopen ((SERIAL_T)) | |
c906108c | 55 | |
c2c6d25f | 56 | /* Read one char from the serial device with TIMEOUT seconds to wait |
2df3850c JM |
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. */ | |
2acceee2 JM |
61 | |
62 | enum serial_rc { | |
63 | SERIAL_ERROR = -1, /* General error. */ | |
2df3850c JM |
64 | SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read. |
65 | Unfortunatly, through ui_loop_hook(), this | |
66 | can also be a QUIT indication. */ | |
2acceee2 JM |
67 | SERIAL_EOF = -3 /* General end-of-file or remote target |
68 | connection closed, indication. Includes | |
69 | things like the line dropping dead. */ | |
70 | }; | |
c2c6d25f JM |
71 | |
72 | extern int serial_readchar (serial_t scb, int timeout); | |
73 | #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) serial_readchar ((SERIAL_T), (TIMEOUT)) | |
74 | ||
75 | /* Write LEN chars from STRING to the port SERIAL_T. Returns 0 for | |
76 | success, non-zero for failure. */ | |
77 | ||
78 | extern int serial_write (serial_t scb, const char *str, int len); | |
79 | #define SERIAL_WRITE(SERIAL_T, STRING,LEN) serial_write (SERIAL_T, STRING, LEN) | |
80 | ||
81 | /* Write a printf style string onto the serial port. */ | |
82 | ||
83 | extern void serial_printf (serial_t desc, const char *,...) ATTR_FORMAT (printf, 2, 3); | |
c906108c SS |
84 | |
85 | /* Allow pending output to drain. */ | |
86 | ||
c2c6d25f JM |
87 | extern int serial_drain_output (serial_t); |
88 | #define SERIAL_DRAIN_OUTPUT(SERIAL_T) serial_drain_output ((SERIAL_T)) | |
c5aa993b | 89 | |
c2c6d25f JM |
90 | /* Flush (discard) pending output. Might also flush input (if this |
91 | system can't flush only output). */ | |
c906108c | 92 | |
c2c6d25f JM |
93 | extern int serial_flush_output (serial_t); |
94 | #define SERIAL_FLUSH_OUTPUT(SERIAL_T) serial_flush_output ((SERIAL_T)) | |
c906108c | 95 | |
c2c6d25f JM |
96 | /* Flush pending input. Might also flush output (if this system can't |
97 | flush only input). */ | |
c906108c | 98 | |
c2c6d25f JM |
99 | extern int serial_flush_input (serial_t); |
100 | #define SERIAL_FLUSH_INPUT(SERIAL_T) serial_flush_input ((SERIAL_T)) | |
c906108c SS |
101 | |
102 | /* Send a break between 0.25 and 0.5 seconds long. */ | |
103 | ||
c2c6d25f | 104 | extern int serial_send_break (serial_t scb); |
c906108c SS |
105 | #define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T) |
106 | ||
107 | /* Turn the port into raw mode. */ | |
108 | ||
c2c6d25f JM |
109 | extern void serial_raw (serial_t scb); |
110 | #define SERIAL_RAW(SERIAL_T) serial_raw ((SERIAL_T)) | |
c906108c SS |
111 | |
112 | /* Return a pointer to a newly malloc'd ttystate containing the state | |
113 | of the tty. */ | |
c2c6d25f JM |
114 | |
115 | extern serial_ttystate serial_get_tty_state (serial_t scb); | |
116 | #define SERIAL_GET_TTY_STATE(SERIAL_T) serial_get_tty_state ((SERIAL_T)) | |
c906108c SS |
117 | |
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. | |
c2c6d25f JM |
120 | Returns 0 for success, negative value for error (in which case |
121 | errno contains the error). */ | |
122 | ||
123 | extern int serial_set_tty_state (serial_t scb, serial_ttystate ttystate); | |
124 | #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) serial_set_tty_state ((SERIAL_T), (TTYSTATE)) | |
c906108c | 125 | |
c2c6d25f JM |
126 | /* printf_filtered a user-comprehensible description of ttystate on |
127 | the specified STREAM. FIXME: At present this sends output to the | |
128 | default stream - GDB_STDOUT. */ | |
129 | ||
d9fcf2fb | 130 | extern void serial_print_tty_state (serial_t scb, serial_ttystate ttystate, struct ui_file *); |
c2c6d25f | 131 | #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE, STREAM) serial_print_tty_state ((SERIAL_T), (TTYSTATE), (STREAM)) |
c906108c SS |
132 | |
133 | /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the | |
134 | current state (generally obtained from a recent call to | |
135 | SERIAL_GET_TTY_STATE), but be careful not to discard any input. | |
c2c6d25f JM |
136 | This means that we never switch in or out of raw mode, even if |
137 | NEW_TTYSTATE specifies a switch. */ | |
138 | ||
139 | extern int serial_noflush_set_tty_state (serial_t scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate); | |
c906108c | 140 | #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \ |
c2c6d25f | 141 | serial_noflush_set_tty_state ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)) |
c906108c | 142 | |
c2c6d25f JM |
143 | /* Set the baudrate to the decimal value supplied. Returns 0 for |
144 | success, -1 for failure. */ | |
c906108c | 145 | |
c2c6d25f JM |
146 | extern int serial_setbaudrate (serial_t scb, int rate); |
147 | #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) serial_setbaudrate ((SERIAL_T), (RATE)) | |
c906108c | 148 | |
c2c6d25f JM |
149 | /* Set the number of stop bits to the value specified. Returns 0 for |
150 | success, -1 for failure. */ | |
c906108c | 151 | |
c2c6d25f JM |
152 | #define SERIAL_1_STOPBITS 1 |
153 | #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */ | |
154 | #define SERIAL_2_STOPBITS 3 | |
c906108c | 155 | |
c2c6d25f JM |
156 | extern int serial_setstopbits (serial_t scb, int num); |
157 | #define SERIAL_SETSTOPBITS(SERIAL_T, NUM) serial_setstopbits ((SERIAL_T), (NUM)) | |
c906108c | 158 | |
c2c6d25f | 159 | /* Asynchronous serial interface: */ |
c906108c | 160 | |
c2c6d25f | 161 | /* Can the serial device support asynchronous mode? */ |
c906108c | 162 | |
c2c6d25f JM |
163 | extern int serial_can_async_p (serial_t scb); |
164 | #define SERIAL_CAN_ASYNC_P(SERIAL_T) serial_can_async_p ((SERIAL_T)) | |
c906108c | 165 | |
c2c6d25f | 166 | /* Has the serial device been put in asynchronous mode? */ |
c906108c | 167 | |
c2c6d25f JM |
168 | extern int serial_is_async_p (serial_t scb); |
169 | #define SERIAL_IS_ASYNC_P(SERIAL_T) serial_is_async_p ((SERIAL_T)) | |
c906108c | 170 | |
c2c6d25f JM |
171 | /* For ASYNC enabled devices, register a callback and enable |
172 | asynchronous mode. To disable asynchronous mode, register a NULL | |
173 | callback. */ | |
c906108c | 174 | |
2acceee2 | 175 | typedef void (serial_event_ftype) (serial_t scb, void *context); |
c2c6d25f JM |
176 | extern void serial_async (serial_t scb, serial_event_ftype *handler, void *context); |
177 | #define SERIAL_ASYNC(SERIAL_T, HANDLER, CONTEXT) serial_async ((SERIAL_T), (HANDLER), (CONTEXT)) | |
c906108c | 178 | |
c2c6d25f JM |
179 | /* Provide direct access to the underlying FD (if any) used to |
180 | implement the serial device. This interface is clearly | |
181 | deprecated. Will call internal_error() if the operation isn't | |
182 | applicable to the current serial device. */ | |
c906108c | 183 | |
c2c6d25f JM |
184 | extern int deprecated_serial_fd (serial_t scb); |
185 | #define DEPRECATED_SERIAL_FD(SERIAL_T) deprecated_serial_fd ((SERIAL_T)) | |
c906108c | 186 | |
2acceee2 JM |
187 | /* Trace/debug mechanism. |
188 | ||
189 | SERIAL_DEBUG() enables/disables internal debugging. | |
190 | SERIAL_DEBUG_P() indicates the current debug state. */ | |
191 | ||
192 | extern void serial_debug (serial_t scb, int debug_p); | |
193 | #define SERIAL_DEBUG(SERIAL_T, DEBUG_P) serial_debug ((SERIAL_T), (DEBUG_P)) | |
194 | ||
195 | extern int serial_debug_p (serial_t scb); | |
196 | #define SERIAL_DEBUG_P(SERIAL_T) serial_debug_p ((SERIAL_T)) | |
197 | ||
c906108c | 198 | |
c2c6d25f | 199 | /* Details of an instance of a serial object */ |
c906108c | 200 | |
c2c6d25f JM |
201 | struct _serial_t |
202 | { | |
203 | int fd; /* File descriptor */ | |
204 | struct serial_ops *ops; /* Function vector */ | |
205 | void *state; /* Local context info for open FD */ | |
206 | serial_ttystate ttystate; /* Not used (yet) */ | |
2acceee2 JM |
207 | int bufcnt; /* Amount of data remaining in receive |
208 | buffer. -ve for sticky errors. */ | |
c2c6d25f JM |
209 | unsigned char *bufp; /* Current byte */ |
210 | unsigned char buf[BUFSIZ]; /* Da buffer itself */ | |
2acceee2 JM |
211 | int current_timeout; /* (ser-unix.c termio{,s} only), last |
212 | value of VTIME */ | |
213 | int timeout_remaining; /* (ser-unix.c termio{,s} only), we | |
214 | still need to wait for this many | |
215 | more seconds. */ | |
c2c6d25f JM |
216 | char *name; /* The name of the device or host */ |
217 | struct _serial_t *next; /* Pointer to the next serial_t */ | |
218 | int refcnt; /* Number of pointers to this block */ | |
2acceee2 JM |
219 | int debug_p; /* Trace this serial devices operation. */ |
220 | int async_state; /* Async internal state. */ | |
c2c6d25f JM |
221 | void *async_context; /* Async event thread's context */ |
222 | serial_event_ftype *async_handler;/* Async event handler */ | |
223 | }; | |
224 | ||
225 | struct serial_ops | |
226 | { | |
227 | char *name; | |
228 | struct serial_ops *next; | |
229 | int (*open) (serial_t, const char *name); | |
230 | void (*close) (serial_t); | |
231 | int (*readchar) (serial_t, int timeout); | |
232 | int (*write) (serial_t, const char *str, int len); | |
233 | /* Discard pending output */ | |
234 | int (*flush_output) (serial_t); | |
235 | /* Discard pending input */ | |
236 | int (*flush_input) (serial_t); | |
237 | int (*send_break) (serial_t); | |
238 | void (*go_raw) (serial_t); | |
239 | serial_ttystate (*get_tty_state) (serial_t); | |
240 | int (*set_tty_state) (serial_t, serial_ttystate); | |
d9fcf2fb | 241 | void (*print_tty_state) (serial_t, serial_ttystate, struct ui_file *); |
c2c6d25f JM |
242 | int (*noflush_set_tty_state) (serial_t, serial_ttystate, serial_ttystate); |
243 | int (*setbaudrate) (serial_t, int rate); | |
244 | int (*setstopbits) (serial_t, int num); | |
245 | /* Wait for output to drain */ | |
246 | int (*drain_output) (serial_t); | |
247 | /* Change the serial device into/out of asynchronous mode, call | |
248 | the specified function when ever there is something | |
249 | interesting. */ | |
250 | void (*async) (serial_t scb, int async_p); | |
251 | }; | |
252 | ||
253 | /* Add a new serial interface to the interface list */ | |
c906108c | 254 | |
c2c6d25f | 255 | extern void serial_add_interface (struct serial_ops * optable); |
c906108c SS |
256 | |
257 | /* File in which to record the remote debugging session */ | |
258 | ||
c2c6d25f | 259 | extern void serial_log_command (const char *); |
c906108c SS |
260 | |
261 | #endif /* SERIAL_H */ |