GDB (xrefs)

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