1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
2 Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000
3 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 2 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, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
25 /* For most routines, if a failure is indicated, then errno should be
28 /* Terminal state pointer. This is specific to each type of
31 typedef void *serial_ttystate
;
34 /* Try to open NAME. Returns a new `struct serial *' on success, NULL
37 extern struct serial
*serial_open (const char *name
);
38 #define SERIAL_OPEN(NAME) serial_open(NAME)
40 /* Open a new serial stream using a file handle. */
42 extern struct serial
*serial_fdopen (const int fd
);
43 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
45 /* Push out all buffers, close the device and destroy SCB. */
47 extern void serial_close (struct serial
*scb
);
48 #define SERIAL_CLOSE(SERIAL_T) serial_close ((SERIAL_T))
50 /* Push out all buffers and destroy SCB without closing the device. */
52 extern void serial_un_fdopen (struct serial
*scb
);
53 #define SERIAL_UN_FDOPEN(SERIAL_T) serial_un_fdopen ((SERIAL_T))
55 /* Read one char from the serial device with TIMEOUT seconds to wait
56 or -1 to wait forever. Use timeout of 0 to effect a poll.
57 Infinite waits are not permitted. Returns unsigned char if ok, else
58 one of the following codes. Note that all error return-codes are
59 guaranteed to be < 0. */
62 SERIAL_ERROR
= -1, /* General error. */
63 SERIAL_TIMEOUT
= -2, /* Timeout or data-not-ready during read.
64 Unfortunately, through ui_loop_hook(), this
65 can also be a QUIT indication. */
66 SERIAL_EOF
= -3 /* General end-of-file or remote target
67 connection closed, indication. Includes
68 things like the line dropping dead. */
71 extern int serial_readchar (struct serial
*scb
, int timeout
);
72 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) serial_readchar ((SERIAL_T), (TIMEOUT))
74 /* Write LEN chars from STRING to the port SCB. Returns 0 for
75 success, non-zero for failure. */
77 extern int serial_write (struct serial
*scb
, const char *str
, int len
);
78 #define SERIAL_WRITE(SERIAL_T, STRING,LEN) serial_write (SERIAL_T, STRING, LEN)
80 /* Write a printf style string onto the serial port. */
82 extern void serial_printf (struct serial
*desc
, const char *,...) ATTR_FORMAT (printf
, 2, 3);
84 /* Allow pending output to drain. */
86 extern int serial_drain_output (struct serial
*);
87 #define SERIAL_DRAIN_OUTPUT(SERIAL_T) serial_drain_output ((SERIAL_T))
89 /* Flush (discard) pending output. Might also flush input (if this
90 system can't flush only output). */
92 extern int serial_flush_output (struct serial
*);
93 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) serial_flush_output ((SERIAL_T))
95 /* Flush pending input. Might also flush output (if this system can't
98 extern int serial_flush_input (struct serial
*);
99 #define SERIAL_FLUSH_INPUT(SERIAL_T) serial_flush_input ((SERIAL_T))
101 /* Send a break between 0.25 and 0.5 seconds long. */
103 extern int serial_send_break (struct serial
*scb
);
104 #define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T)
106 /* Turn the port into raw mode. */
108 extern void serial_raw (struct serial
*scb
);
109 #define SERIAL_RAW(SERIAL_T) serial_raw ((SERIAL_T))
111 /* Return a pointer to a newly malloc'd ttystate containing the state
114 extern serial_ttystate
serial_get_tty_state (struct serial
*scb
);
115 #define SERIAL_GET_TTY_STATE(SERIAL_T) serial_get_tty_state ((SERIAL_T))
117 /* Set the state of the tty to TTYSTATE. The change is immediate.
118 When changing to or from raw mode, input might be discarded.
119 Returns 0 for success, negative value for error (in which case
120 errno contains the error). */
122 extern int serial_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
);
123 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) serial_set_tty_state ((SERIAL_T), (TTYSTATE))
125 /* printf_filtered a user-comprehensible description of ttystate on
126 the specified STREAM. FIXME: At present this sends output to the
127 default stream - GDB_STDOUT. */
129 extern void serial_print_tty_state (struct serial
*scb
, serial_ttystate ttystate
, struct ui_file
*);
130 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE, STREAM) serial_print_tty_state ((SERIAL_T), (TTYSTATE), (STREAM))
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
);
139 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
140 serial_noflush_set_tty_state ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE))
142 /* Set the baudrate to the decimal value supplied. Returns 0 for
143 success, -1 for failure. */
145 extern int serial_setbaudrate (struct serial
*scb
, int rate
);
146 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) serial_setbaudrate ((SERIAL_T), (RATE))
148 /* Set the number of stop bits to the value specified. Returns 0 for
149 success, -1 for failure. */
151 #define SERIAL_1_STOPBITS 1
152 #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */
153 #define SERIAL_2_STOPBITS 3
155 extern int serial_setstopbits (struct serial
*scb
, int num
);
156 #define SERIAL_SETSTOPBITS(SERIAL_T, NUM) serial_setstopbits ((SERIAL_T), (NUM))
158 /* Asynchronous serial interface: */
160 /* Can the serial device support asynchronous mode? */
162 extern int serial_can_async_p (struct serial
*scb
);
163 #define SERIAL_CAN_ASYNC_P(SERIAL_T) serial_can_async_p ((SERIAL_T))
165 /* Has the serial device been put in asynchronous mode? */
167 extern int serial_is_async_p (struct serial
*scb
);
168 #define SERIAL_IS_ASYNC_P(SERIAL_T) serial_is_async_p ((SERIAL_T))
170 /* For ASYNC enabled devices, register a callback and enable
171 asynchronous mode. To disable asynchronous mode, register a NULL
174 typedef void (serial_event_ftype
) (struct serial
*scb
, void *context
);
175 extern void serial_async (struct serial
*scb
, serial_event_ftype
*handler
, void *context
);
176 #define SERIAL_ASYNC(SERIAL_T, HANDLER, CONTEXT) serial_async ((SERIAL_T), (HANDLER), (CONTEXT))
178 /* Provide direct access to the underlying FD (if any) used to
179 implement the serial device. This interface is clearly
180 deprecated. Will call internal_error() if the operation isn't
181 applicable to the current serial device. */
183 extern int deprecated_serial_fd (struct serial
*scb
);
184 #define DEPRECATED_SERIAL_FD(SERIAL_T) deprecated_serial_fd ((SERIAL_T))
186 /* Trace/debug mechanism.
188 SERIAL_DEBUG() enables/disables internal debugging.
189 SERIAL_DEBUG_P() indicates the current debug state. */
191 extern void serial_debug (struct serial
*scb
, int debug_p
);
192 #define SERIAL_DEBUG(SERIAL_T, DEBUG_P) serial_debug ((SERIAL_T), (DEBUG_P))
194 extern int serial_debug_p (struct serial
*scb
);
195 #define SERIAL_DEBUG_P(SERIAL_T) serial_debug_p ((SERIAL_T))
198 /* Details of an instance of a serial object */
202 int fd
; /* File descriptor */
203 struct serial_ops
*ops
; /* Function vector */
204 void *state
; /* Local context info for open FD */
205 serial_ttystate ttystate
; /* Not used (yet) */
206 int bufcnt
; /* Amount of data remaining in receive
207 buffer. -ve for sticky errors. */
208 unsigned char *bufp
; /* Current byte */
209 unsigned char buf
[BUFSIZ
]; /* Da buffer itself */
210 int current_timeout
; /* (ser-unix.c termio{,s} only), last
212 int timeout_remaining
; /* (ser-unix.c termio{,s} only), we
213 still need to wait for this many
215 char *name
; /* The name of the device or host */
216 struct serial
*next
; /* Pointer to the next `struct serial *' */
217 int refcnt
; /* Number of pointers to this block */
218 int debug_p
; /* Trace this serial devices operation. */
219 int async_state
; /* Async internal state. */
220 void *async_context
; /* Async event thread's context */
221 serial_event_ftype
*async_handler
;/* Async event handler */
227 struct serial_ops
*next
;
228 int (*open
) (struct serial
*, const char *name
);
229 void (*close
) (struct serial
*);
230 int (*readchar
) (struct serial
*, int timeout
);
231 int (*write
) (struct serial
*, const char *str
, int len
);
232 /* Discard pending output */
233 int (*flush_output
) (struct serial
*);
234 /* Discard pending input */
235 int (*flush_input
) (struct serial
*);
236 int (*send_break
) (struct serial
*);
237 void (*go_raw
) (struct serial
*);
238 serial_ttystate (*get_tty_state
) (struct serial
*);
239 int (*set_tty_state
) (struct serial
*, serial_ttystate
);
240 void (*print_tty_state
) (struct serial
*, serial_ttystate
,
242 int (*noflush_set_tty_state
) (struct serial
*, serial_ttystate
,
244 int (*setbaudrate
) (struct serial
*, int rate
);
245 int (*setstopbits
) (struct serial
*, int num
);
246 /* Wait for output to drain */
247 int (*drain_output
) (struct serial
*);
248 /* Change the serial device into/out of asynchronous mode, call
249 the specified function when ever there is something
251 void (*async
) (struct serial
*scb
, int async_p
);
254 /* Add a new serial interface to the interface list */
256 extern void serial_add_interface (struct serial_ops
* optable
);
258 /* File in which to record the remote debugging session */
260 extern void serial_log_command (const char *);
262 #endif /* SERIAL_H */