-/* Remote Serial support interface definitions for GDB, the GNU Debugger.
- Copyright 1992 Free Software Foundation, Inc.
+/* Remote serial support interface definitions for GDB, the GNU Debugger.
+ Copyright 1992, 1993 Free Software Foundation, Inc.
This file is part of GDB.
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
-/* Return a sensible default name for a serial device, something which
- can be used as an argument to serial_open */
-
-CONST char *EXFUN(serial_default_name,(void));
+/* Terminal state pointer. This is specific to each type of interface. */
-/* Try to open the serial device "name", return 1 if ok, 0 if not. */
+typedef PTR serial_ttystate;
-int EXFUN(serial_open,(CONST char *name));
+struct _serial_t
+{
+ int fd; /* File descriptor */
+ struct serial_ops *ops; /* Function vector */
+ serial_ttystate ttystate; /* Not used (yet) */
+ int bufcnt; /* Amount of data in receive buffer */
+ unsigned char *bufp; /* Current byte */
+ unsigned char buf[BUFSIZ]; /* Da buffer itself */
+ int current_timeout; /* (termio{s} only), last value of VTIME */
+};
-/* Turn the port into raw mode */
+typedef struct _serial_t *serial_t;
-void EXFUN(serial_raw,(void));
+struct serial_ops {
+ char *name;
+ struct serial_ops *next;
+ int (*open) PARAMS ((serial_t, const char *name));
+ void (*close) PARAMS ((serial_t));
+ int (*readchar) PARAMS ((serial_t, int timeout));
+ int (*write) PARAMS ((serial_t, const char *str, int len));
+ void (*go_raw) PARAMS ((serial_t));
+ serial_ttystate (*get_tty_state) PARAMS ((serial_t));
+ int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
+ int (*setbaudrate) PARAMS ((serial_t, int rate));
+};
+/* Add a new serial interface to the interface list */
-/* Turn the port into normal mode */
+void serial_add_interface PARAMS ((struct serial_ops *optable));
-void EXFUN(serial_normal,(void));
+serial_t serial_open PARAMS ((const char *name));
+serial_t serial_fdopen PARAMS ((int fd));
-/* Read one char from the serial device with timeout, return char, and
- set ok if ok */
+/* For most routines, if a failure is indicated, then errno should be
+ examined. */
-int EXFUN(serial_timedreadchar,(int to , int *ok));
+/* Try to open NAME. Returns a new serial_t on success, NULL on failure.
+ */
+#define SERIAL_OPEN(NAME) serial_open(NAME)
-/* Set the baudrate to the value supplied, and return 1, or fail and
- return 0 */
+/* Open a new serial stream using a file handle. */
-int EXFUN(serial_setbaudrate,(int to));
+#define SERIAL_FDOPEN(FD) serial_fdopen(FD)
-/* Return the next rate in the sequence, or return 0 for a fail*/
+/* Turn the port into raw mode. */
-int EXFUN(serial_nextbaudrate,(int rate));
+#define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
+#define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
-/* Write some chars to the device, return 1 if ok, 0 if not */
+#define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
-int EXFUN(serial_write,( CONST char *str , int len));
+/* Read one char from the serial device with TIMEOUT seconds timeout.
+ Returns char if ok, else one of the following codes. Note that all
+ error codes are guaranteed to be < 0. */
+#define SERIAL_ERROR -1 /* General error, see errno for details */
+#define SERIAL_TIMEOUT -2
+#define SERIAL_EOF -3
-/* Close the serial port */
+#define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
+
+/* Set the baudrate to the decimal value supplied. Returns 0 for success,
+ -1 for failure. */
+
+#define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
+
+/* Write LEN chars from STRING to the port SERIAL_T. Returns 0 for success,
+ -1 for failure. */
+
+#define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
+
+/* Push out all buffers, close the device and destroy SERIAL_T. */
+
+void serial_close PARAMS ((serial_t));
+
+#define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
-int EXFUN(serial_close,(void));