1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
2 Copyright (C) 1992-2018 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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/>. */
29 /* For most routines, if a failure is indicated, then errno should be
32 /* Terminal state pointer. This is specific to each type of
35 typedef void *serial_ttystate
;
39 /* Create a new serial for OPS. The new serial is not opened. */
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
48 extern struct serial
*serial_open (const char *name
);
50 /* Open a new serial stream using OPS. */
52 extern struct serial
*serial_open_ops (const struct serial_ops
*ops
);
54 /* Returns true if SCB is open. */
56 extern int serial_is_open (struct serial
*scb
);
58 /* Find an already opened serial stream using a file handle. */
60 extern struct serial
*serial_for_fd (int fd
);
62 /* Open a new serial stream using a file handle. */
64 extern struct serial
*serial_fdopen (const int fd
);
66 /* Push out all buffers, close the device and unref SCB. */
68 extern void serial_close (struct serial
*scb
);
70 /* Increment reference count of SCB. */
72 extern void serial_ref (struct serial
*scb
);
74 /* Decrement reference count of SCB. */
76 extern void serial_unref (struct serial
*scb
);
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). */
82 extern int gdb_pipe (int fildes
[2]);
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). */
89 extern int serial_pipe (struct serial
*scbs
[2]);
91 /* Push out all buffers and destroy SCB without closing the device. */
93 extern void serial_un_fdopen (struct serial
*scb
);
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. */
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. */
112 extern int serial_readchar (struct serial
*scb
, int timeout
);
114 /* Write COUNT bytes from BUF to the port SCB. Returns 0 for
115 success, non-zero for failure. */
117 extern int serial_write (struct serial
*scb
, const void *buf
, size_t count
);
119 /* Write a printf style string onto the serial port. */
121 extern void serial_printf (struct serial
*desc
,
122 const char *,...) ATTRIBUTE_PRINTF (2, 3);
124 /* Allow pending output to drain. */
126 extern int serial_drain_output (struct serial
*);
128 /* Flush (discard) pending output. Might also flush input (if this
129 system can't flush only output). */
131 extern int serial_flush_output (struct serial
*);
133 /* Flush pending input. Might also flush output (if this system can't
134 flush only input). */
136 extern int serial_flush_input (struct serial
*);
138 /* Send a break between 0.25 and 0.5 seconds long. */
140 extern int serial_send_break (struct serial
*scb
);
142 /* Turn the port into raw mode. */
144 extern void serial_raw (struct serial
*scb
);
146 /* Return a pointer to a newly malloc'd ttystate containing the state
149 extern serial_ttystate
serial_get_tty_state (struct serial
*scb
);
151 /* Return a pointer to a newly malloc'd ttystate containing a copy
152 of the state in TTYSTATE. */
154 extern serial_ttystate
serial_copy_tty_state (struct serial
*scb
,
155 serial_ttystate ttystate
);
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). */
162 extern int serial_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
);
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. */
168 extern void serial_print_tty_state (struct serial
*scb
,
169 serial_ttystate ttystate
,
172 /* Set the baudrate to the decimal value supplied. Returns 0 for
173 success, -1 for failure. */
175 extern int serial_setbaudrate (struct serial
*scb
, int rate
);
177 /* Set the number of stop bits to the value specified. Returns 0 for
178 success, -1 for failure. */
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
184 extern int serial_setstopbits (struct serial
*scb
, int num
);
186 #define GDBPARITY_NONE 0
187 #define GDBPARITY_ODD 1
188 #define GDBPARITY_EVEN 2
190 /* Set parity for serial port. Returns 0 for success, -1 for failure. */
192 extern int serial_setparity (struct serial
*scb
, int parity
);
194 /* Asynchronous serial interface: */
196 /* Can the serial device support asynchronous mode? */
198 extern int serial_can_async_p (struct serial
*scb
);
200 /* Has the serial device been put in asynchronous mode? */
202 extern int serial_is_async_p (struct serial
*scb
);
204 /* For ASYNC enabled devices, register a callback and enable
205 asynchronous mode. To disable asynchronous mode, register a NULL
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
);
212 /* Trace/debug mechanism.
214 serial_debug() enables/disables internal debugging.
215 serial_debug_p() indicates the current debug state. */
217 extern void serial_debug (struct serial
*scb
, int debug_p
);
219 extern int serial_debug_p (struct serial
*scb
);
222 /* Details of an instance of a serial object. */
226 /* serial objects are ref counted (but not the underlying
227 connection, just the object's lifetime in memory). */
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. */
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 */
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
,
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
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
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
290 int (*avail
)(struct serial
*scb
, int fd
);
293 /* Return a handle to wait on, indicating available data from SCB
294 when signaled, in *READ. Return a handle indicating errors
296 void (*wait_handle
) (struct serial
*scb
, HANDLE
*read
, HANDLE
*except
);
297 void (*done_wait_handle
) (struct serial
*scb
);
298 #endif /* USE_WIN32API */
301 /* Add a new serial interface to the interface list. */
303 extern void serial_add_interface (const struct serial_ops
* optable
);
305 /* File in which to record the remote debugging session. */
307 extern void serial_log_command (struct target_ops
*self
, const char *);
311 /* Windows-only: find or create handles that we can wait on for this
313 extern void serial_wait_handle (struct serial
*, HANDLE
*, HANDLE
*);
315 /* Windows-only: signal that we are done with the wait handles. */
316 extern void serial_done_wait_handle (struct serial
*);
318 #endif /* USE_WIN32API */
320 #endif /* SERIAL_H */
This page took 0.035015 seconds and 4 git commands to generate.