1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
2 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 /* For most routines, if a failure is indicated, then errno should be
33 /* Terminal state pointer. This is specific to each type of
36 typedef void *serial_ttystate
;
39 /* Try to open NAME. Returns a new `struct serial *' on success, NULL
40 on failure. Note that some open calls can block and, if possible,
41 should be written to be non-blocking, with calls to ui_look_hook
42 so they can be cancelled. An async interface for open could be
43 added to GDB if necessary. */
45 extern struct serial
*serial_open (const char *name
);
47 /* Find an already opened serial stream using a file handle. */
49 extern struct serial
*serial_for_fd (int fd
);
51 /* Open a new serial stream using a file handle. */
53 extern struct serial
*serial_fdopen (const int fd
);
55 /* Push out all buffers, close the device and destroy SCB. */
57 extern void serial_close (struct serial
*scb
);
59 /* Push out all buffers and destroy SCB without closing the device. */
61 extern void serial_un_fdopen (struct serial
*scb
);
63 /* Read one char from the serial device with TIMEOUT seconds to wait
64 or -1 to wait forever. Use timeout of 0 to effect a poll.
65 Infinite waits are not permitted. Returns unsigned char if ok, else
66 one of the following codes. Note that all error return-codes are
67 guaranteed to be < 0. */
70 SERIAL_ERROR
= -1, /* General error. */
71 SERIAL_TIMEOUT
= -2, /* Timeout or data-not-ready during read.
72 Unfortunately, through
73 deprecated_ui_loop_hook (), this can also
74 be a QUIT indication. */
75 SERIAL_EOF
= -3 /* General end-of-file or remote target
76 connection closed, indication. Includes
77 things like the line dropping dead. */
80 extern int serial_readchar (struct serial
*scb
, int timeout
);
82 /* Write LEN chars from STRING to the port SCB. Returns 0 for
83 success, non-zero for failure. */
85 extern int serial_write (struct serial
*scb
, const char *str
, int len
);
87 /* Write a printf style string onto the serial port. */
89 extern void serial_printf (struct serial
*desc
,
90 const char *,...) ATTR_FORMAT (printf
, 2, 3);
92 /* Allow pending output to drain. */
94 extern int serial_drain_output (struct serial
*);
96 /* Flush (discard) pending output. Might also flush input (if this
97 system can't flush only output). */
99 extern int serial_flush_output (struct serial
*);
101 /* Flush pending input. Might also flush output (if this system can't
102 flush only input). */
104 extern int serial_flush_input (struct serial
*);
106 /* Send a break between 0.25 and 0.5 seconds long. */
108 extern int serial_send_break (struct serial
*scb
);
110 /* Turn the port into raw mode. */
112 extern void serial_raw (struct serial
*scb
);
114 /* Return a pointer to a newly malloc'd ttystate containing the state
117 extern serial_ttystate
serial_get_tty_state (struct serial
*scb
);
119 /* Set the state of the tty to TTYSTATE. The change is immediate.
120 When changing to or from raw mode, input might be discarded.
121 Returns 0 for success, negative value for error (in which case
122 errno contains the error). */
124 extern int serial_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
);
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. */
130 extern void serial_print_tty_state (struct serial
*scb
, serial_ttystate ttystate
, struct ui_file
*);
132 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
133 current state (generally obtained from a recent call to
134 serial_get_tty_state()), but be careful not to discard any input.
135 This means that we never switch in or out of raw mode, even if
136 NEW_TTYSTATE specifies a switch. */
138 extern int serial_noflush_set_tty_state (struct serial
*scb
, serial_ttystate new_ttystate
, serial_ttystate old_ttystate
);
140 /* Set the baudrate to the decimal value supplied. Returns 0 for
141 success, -1 for failure. */
143 extern int serial_setbaudrate (struct serial
*scb
, int rate
);
145 /* Set the number of stop bits to the value specified. Returns 0 for
146 success, -1 for failure. */
148 #define SERIAL_1_STOPBITS 1
149 #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */
150 #define SERIAL_2_STOPBITS 3
152 extern int serial_setstopbits (struct serial
*scb
, int num
);
154 /* Asynchronous serial interface: */
156 /* Can the serial device support asynchronous mode? */
158 extern int serial_can_async_p (struct serial
*scb
);
160 /* Has the serial device been put in asynchronous mode? */
162 extern int serial_is_async_p (struct serial
*scb
);
164 /* For ASYNC enabled devices, register a callback and enable
165 asynchronous mode. To disable asynchronous mode, register a NULL
168 typedef void (serial_event_ftype
) (struct serial
*scb
, void *context
);
169 extern void serial_async (struct serial
*scb
, serial_event_ftype
*handler
, void *context
);
171 /* Provide direct access to the underlying FD (if any) used to
172 implement the serial device. This interface is clearly
173 deprecated. Will call internal_error() if the operation isn't
174 applicable to the current serial device. */
176 extern int deprecated_serial_fd (struct serial
*scb
);
178 /* Trace/debug mechanism.
180 serial_debug() enables/disables internal debugging.
181 serial_debug_p() indicates the current debug state. */
183 extern void serial_debug (struct serial
*scb
, int debug_p
);
185 extern int serial_debug_p (struct serial
*scb
);
188 /* Details of an instance of a serial object */
192 int fd
; /* File descriptor */
193 /* File descriptor for a separate error stream that should be
194 immediately forwarded to gdb_stderr. This may be -1.
195 If != -1, this descriptor should be non-blocking or
196 ops->avail should be non-NULL. */
198 struct serial_ops
*ops
; /* Function vector */
199 void *state
; /* Local context info for open FD */
200 serial_ttystate ttystate
; /* Not used (yet) */
201 int bufcnt
; /* Amount of data remaining in receive
202 buffer. -ve for sticky errors. */
203 unsigned char *bufp
; /* Current byte */
204 unsigned char buf
[BUFSIZ
]; /* Da buffer itself */
205 int current_timeout
; /* (ser-unix.c termio{,s} only), last
207 int timeout_remaining
; /* (ser-unix.c termio{,s} only), we
208 still need to wait for this many
210 char *name
; /* The name of the device or host */
211 struct serial
*next
; /* Pointer to the next `struct serial *' */
212 int refcnt
; /* Number of pointers to this block */
213 int debug_p
; /* Trace this serial devices operation. */
214 int async_state
; /* Async internal state. */
215 void *async_context
; /* Async event thread's context */
216 serial_event_ftype
*async_handler
;/* Async event handler */
222 struct serial_ops
*next
;
223 int (*open
) (struct serial
*, const char *name
);
224 void (*close
) (struct serial
*);
225 int (*readchar
) (struct serial
*, int timeout
);
226 int (*write
) (struct serial
*, const char *str
, int len
);
227 /* Discard pending output */
228 int (*flush_output
) (struct serial
*);
229 /* Discard pending input */
230 int (*flush_input
) (struct serial
*);
231 int (*send_break
) (struct serial
*);
232 void (*go_raw
) (struct serial
*);
233 serial_ttystate (*get_tty_state
) (struct serial
*);
234 int (*set_tty_state
) (struct serial
*, serial_ttystate
);
235 void (*print_tty_state
) (struct serial
*, serial_ttystate
,
237 int (*noflush_set_tty_state
) (struct serial
*, serial_ttystate
,
239 int (*setbaudrate
) (struct serial
*, int rate
);
240 int (*setstopbits
) (struct serial
*, int num
);
241 /* Wait for output to drain */
242 int (*drain_output
) (struct serial
*);
243 /* Change the serial device into/out of asynchronous mode, call
244 the specified function when ever there is something
246 void (*async
) (struct serial
*scb
, int async_p
);
247 /* Perform a low-level read operation, reading (at most) COUNT
248 bytes into SCB->BUF. Return zero at end of file. */
249 int (*read_prim
)(struct serial
*scb
, size_t count
);
250 /* Perform a low-level write operation, writing (at most) COUNT
252 int (*write_prim
)(struct serial
*scb
, const void *buf
, size_t count
);
253 /* Return that number of bytes that can be read from FD
254 without blocking. Return value of -1 means that the
255 the read will not block even if less that requested bytes
257 int (*avail
)(struct serial
*scb
, int fd
);
260 /* Return a handle to wait on, indicating available data from SCB
261 when signaled, in *READ. Return a handle indicating errors
263 void (*wait_handle
) (struct serial
*scb
, HANDLE
*read
, HANDLE
*except
);
264 void (*done_wait_handle
) (struct serial
*scb
);
265 #endif /* USE_WIN32API */
268 /* Add a new serial interface to the interface list */
270 extern void serial_add_interface (struct serial_ops
* optable
);
272 /* File in which to record the remote debugging session */
274 extern void serial_log_command (const char *);
278 /* Windows-only: find or create handles that we can wait on for this
280 extern void serial_wait_handle (struct serial
*, HANDLE
*, HANDLE
*);
282 /* Windows-only: signal that we are done with the wait handles. */
283 extern void serial_done_wait_handle (struct serial
*);
285 #endif /* USE_WIN32API */
287 #endif /* SERIAL_H */