1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
2 Copyright 1992, 1993, 1999 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 2 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, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
24 /* For most routines, if a failure is indicated, then errno should be
27 /* Terminal state pointer. This is specific to each type of
30 typedef void *serial_ttystate
;
32 typedef struct _serial_t
*serial_t
;
34 /* Try to open NAME. Returns a new serial_t on success, NULL on
37 extern serial_t
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 serial_t
serial_fdopen (const int fd
);
43 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
45 /* Push out all buffers, close the device and destroy SERIAL_T. */
47 extern void serial_close (serial_t
);
48 #define SERIAL_CLOSE(SERIAL_T) serial_close ((SERIAL_T))
50 /* Push out all buffers and destroy SERIAL_T without closing the
53 extern void serial_un_fdopen (serial_t scb
);
54 #define SERIAL_UN_FDOPEN(SERIAL_T) serial_un_fdopen ((SERIAL_T))
56 /* Read one char from the serial device with TIMEOUT seconds to wait
57 or -1 to wait forever. Use timeout of 0 to effect a poll. Returns
58 unsigned char if ok, else one of the following codes. Note that
59 all error return-codes are guaranteed to be < 0. */
62 SERIAL_ERROR
= -1, /* General error. */
63 SERIAL_TIMEOUT
= -2, /* Timeout during read. ui_loop_hook() can,
64 unfortunatly, force this to be returned. */
65 SERIAL_EOF
= -3 /* General end-of-file or remote target
66 connection closed, indication. Includes
67 things like the line dropping dead. */
70 extern int serial_readchar (serial_t scb
, int timeout
);
71 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) serial_readchar ((SERIAL_T), (TIMEOUT))
73 /* Write LEN chars from STRING to the port SERIAL_T. Returns 0 for
74 success, non-zero for failure. */
76 extern int serial_write (serial_t scb
, const char *str
, int len
);
77 #define SERIAL_WRITE(SERIAL_T, STRING,LEN) serial_write (SERIAL_T, STRING, LEN)
79 /* Write a printf style string onto the serial port. */
81 extern void serial_printf (serial_t desc
, const char *,...) ATTR_FORMAT (printf
, 2, 3);
83 /* Allow pending output to drain. */
85 extern int serial_drain_output (serial_t
);
86 #define SERIAL_DRAIN_OUTPUT(SERIAL_T) serial_drain_output ((SERIAL_T))
88 /* Flush (discard) pending output. Might also flush input (if this
89 system can't flush only output). */
91 extern int serial_flush_output (serial_t
);
92 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) serial_flush_output ((SERIAL_T))
94 /* Flush pending input. Might also flush output (if this system can't
97 extern int serial_flush_input (serial_t
);
98 #define SERIAL_FLUSH_INPUT(SERIAL_T) serial_flush_input ((SERIAL_T))
100 /* Send a break between 0.25 and 0.5 seconds long. */
102 extern int serial_send_break (serial_t scb
);
103 #define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T)
105 /* Turn the port into raw mode. */
107 extern void serial_raw (serial_t scb
);
108 #define SERIAL_RAW(SERIAL_T) serial_raw ((SERIAL_T))
110 /* Return a pointer to a newly malloc'd ttystate containing the state
113 extern serial_ttystate
serial_get_tty_state (serial_t scb
);
114 #define SERIAL_GET_TTY_STATE(SERIAL_T) serial_get_tty_state ((SERIAL_T))
116 /* Set the state of the tty to TTYSTATE. The change is immediate.
117 When changing to or from raw mode, input might be discarded.
118 Returns 0 for success, negative value for error (in which case
119 errno contains the error). */
121 extern int serial_set_tty_state (serial_t scb
, serial_ttystate ttystate
);
122 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) serial_set_tty_state ((SERIAL_T), (TTYSTATE))
124 /* printf_filtered a user-comprehensible description of ttystate on
125 the specified STREAM. FIXME: At present this sends output to the
126 default stream - GDB_STDOUT. */
128 extern void serial_print_tty_state (serial_t scb
, serial_ttystate ttystate
, struct gdb_file
*);
129 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE, STREAM) serial_print_tty_state ((SERIAL_T), (TTYSTATE), (STREAM))
131 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
132 current state (generally obtained from a recent call to
133 SERIAL_GET_TTY_STATE), but be careful not to discard any input.
134 This means that we never switch in or out of raw mode, even if
135 NEW_TTYSTATE specifies a switch. */
137 extern int serial_noflush_set_tty_state (serial_t scb
, serial_ttystate new_ttystate
, serial_ttystate old_ttystate
);
138 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
139 serial_noflush_set_tty_state ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE))
141 /* Set the baudrate to the decimal value supplied. Returns 0 for
142 success, -1 for failure. */
144 extern int serial_setbaudrate (serial_t scb
, int rate
);
145 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) serial_setbaudrate ((SERIAL_T), (RATE))
147 /* Set the number of stop bits to the value specified. Returns 0 for
148 success, -1 for failure. */
150 #define SERIAL_1_STOPBITS 1
151 #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */
152 #define SERIAL_2_STOPBITS 3
154 extern int serial_setstopbits (serial_t scb
, int num
);
155 #define SERIAL_SETSTOPBITS(SERIAL_T, NUM) serial_setstopbits ((SERIAL_T), (NUM))
157 /* Asynchronous serial interface: */
159 /* Can the serial device support asynchronous mode? */
161 extern int serial_can_async_p (serial_t scb
);
162 #define SERIAL_CAN_ASYNC_P(SERIAL_T) serial_can_async_p ((SERIAL_T))
164 /* Has the serial device been put in asynchronous mode? */
166 extern int serial_is_async_p (serial_t scb
);
167 #define SERIAL_IS_ASYNC_P(SERIAL_T) serial_is_async_p ((SERIAL_T))
169 /* For ASYNC enabled devices, register a callback and enable
170 asynchronous mode. To disable asynchronous mode, register a NULL
173 typedef void (serial_event_ftype
) (serial_t scb
, void *context
);
174 extern void serial_async (serial_t scb
, serial_event_ftype
*handler
, void *context
);
175 #define SERIAL_ASYNC(SERIAL_T, HANDLER, CONTEXT) serial_async ((SERIAL_T), (HANDLER), (CONTEXT))
177 /* Provide direct access to the underlying FD (if any) used to
178 implement the serial device. This interface is clearly
179 deprecated. Will call internal_error() if the operation isn't
180 applicable to the current serial device. */
182 extern int deprecated_serial_fd (serial_t scb
);
183 #define DEPRECATED_SERIAL_FD(SERIAL_T) deprecated_serial_fd ((SERIAL_T))
185 /* Trace/debug mechanism.
187 SERIAL_DEBUG() enables/disables internal debugging.
188 SERIAL_DEBUG_P() indicates the current debug state. */
190 extern void serial_debug (serial_t scb
, int debug_p
);
191 #define SERIAL_DEBUG(SERIAL_T, DEBUG_P) serial_debug ((SERIAL_T), (DEBUG_P))
193 extern int serial_debug_p (serial_t scb
);
194 #define SERIAL_DEBUG_P(SERIAL_T) serial_debug_p ((SERIAL_T))
197 /* Details of an instance of a serial object */
201 int fd
; /* File descriptor */
202 struct serial_ops
*ops
; /* Function vector */
203 void *state
; /* Local context info for open FD */
204 serial_ttystate ttystate
; /* Not used (yet) */
205 int bufcnt
; /* Amount of data remaining in receive
206 buffer. -ve for sticky errors. */
207 unsigned char *bufp
; /* Current byte */
208 unsigned char buf
[BUFSIZ
]; /* Da buffer itself */
209 int current_timeout
; /* (ser-unix.c termio{,s} only), last
211 int timeout_remaining
; /* (ser-unix.c termio{,s} only), we
212 still need to wait for this many
214 char *name
; /* The name of the device or host */
215 struct _serial_t
*next
; /* Pointer to the next serial_t */
216 int refcnt
; /* Number of pointers to this block */
217 int debug_p
; /* Trace this serial devices operation. */
218 int async_state
; /* Async internal state. */
219 void *async_context
; /* Async event thread's context */
220 serial_event_ftype
*async_handler
;/* Async event handler */
226 struct serial_ops
*next
;
227 int (*open
) (serial_t
, const char *name
);
228 void (*close
) (serial_t
);
229 int (*readchar
) (serial_t
, int timeout
);
230 int (*write
) (serial_t
, const char *str
, int len
);
231 /* Discard pending output */
232 int (*flush_output
) (serial_t
);
233 /* Discard pending input */
234 int (*flush_input
) (serial_t
);
235 int (*send_break
) (serial_t
);
236 void (*go_raw
) (serial_t
);
237 serial_ttystate (*get_tty_state
) (serial_t
);
238 int (*set_tty_state
) (serial_t
, serial_ttystate
);
239 void (*print_tty_state
) (serial_t
, serial_ttystate
, struct gdb_file
*);
240 int (*noflush_set_tty_state
) (serial_t
, serial_ttystate
, serial_ttystate
);
241 int (*setbaudrate
) (serial_t
, int rate
);
242 int (*setstopbits
) (serial_t
, int num
);
243 /* Wait for output to drain */
244 int (*drain_output
) (serial_t
);
245 /* Change the serial device into/out of asynchronous mode, call
246 the specified function when ever there is something
248 void (*async
) (serial_t scb
, int async_p
);
251 /* Add a new serial interface to the interface list */
253 extern void serial_add_interface (struct serial_ops
* optable
);
255 /* File in which to record the remote debugging session */
257 extern void serial_log_command (const char *);
259 #endif /* SERIAL_H */