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