* gdbserver/{remote-gutils.c remote-server.c Makefile.in
[deliverable/binutils-gdb.git] / gdb / serial.h
index 6a1f2e2683718ec34ff4505cfd6123973ddf1d38..9aa94250c97b0fa89f6edfc88d227dfa90ffaefd 100644 (file)
@@ -1,5 +1,5 @@
 /* Remote serial support interface definitions for GDB, the GNU Debugger.
-   Copyright 1992 Free Software Foundation, Inc.
+   Copyright 1992, 1993 Free Software Foundation, Inc.
 
 This file is part of GDB.
 
@@ -17,65 +17,80 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 
-#ifdef HAVE_TERMIO
+/* Terminal state pointer.  This is specific to each type of interface. */
 
-#include <termios.h>
-#include <unistd.h>
+typedef PTR ttystate;
 
-struct ttystate
+struct _serial_t
 {
-  int flags;                   /* Flags from fcntl F_GETFL */
-  struct termios termios;      /* old tty driver settings */
+  int fd;                      /* File descriptor */
+  struct serial_ops *ops;      /* Function vector */
+  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 */
 };
 
-#else /* not HAVE_TERMIO */
+typedef struct _serial_t *serial_t;
+
+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));
+  void (*restore) PARAMS ((serial_t));
+  int (*setbaudrate) PARAMS ((serial_t, int rate));
+};
 
-#include <sgtty.h>
+/* Add a new serial interface to the interface list */
 
-struct ttystate {
-  int flags;                   /* Flags from fcntl F_GETFL */
-  struct sgttyb sgttyb;                /* old tty driver settings */
-};
+void serial_add_interface PARAMS ((struct serial_ops *optable));
 
-#endif /* not HAVE_TERMIO */
-/* Return a sensible default name for a serial device, something which
-   can be used as an argument to serial_open.  */
-   
-const char *serial_default_name PARAMS ((void));
+serial_t serial_open PARAMS ((const char *name));
 
-/* Try to open the serial device "name", return 1 if ok, 0 if not.  */
+/* For most routines, if a failure is indicated, then errno should be
+   examined.  */
 
-int serial_open PARAMS ((const char *name));
+/* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
+ */
 
-/* Turn the port into raw mode.  */
+#define SERIAL_OPEN(NAME) serial_open(NAME)
 
-void serial_raw PARAMS ((int fd, struct ttystate *oldstate));
+/* Turn the port into raw mode. */
 
-/* Turn the port into normal mode.  */
+#define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
 
-void serial_normal PARAMS ((void));
+/* 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.  */
 
-/* Read one char from the serial device with <TO>-second timeout.
-   Returns char if ok, else EOF, -2 for timeout, -3 for anything else  */
+#define SERIAL_ERROR -1                /* General error, see errno for details */
+#define SERIAL_TIMEOUT -2
+#define SERIAL_EOF -3
 
-int serial_readchar PARAMS ((int to));
+#define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
 
-/* Set the baudrate to the decimal value supplied, and return 1, or fail and
-   return 0.  */
+/* Set the baudrate to the decimal value supplied.  Returns 0 for success,
+   -1 for failure.  */
 
-int serial_setbaudrate PARAMS ((int rate));
+#define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
 
-/* Return the next rate in the sequence, or return 0 for failure.  */
+/* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for success,
+   -1 for failure.  */
 
-/* Write some chars to the device, returns 0 for failure.  See errno for
-   details. */
+#define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
 
-int serial_write PARAMS ((const char *str, int len));
+/* Push out all buffers, close the device and destroy SERIAL_T. */
 
-/* Close the serial port */
+void serial_close PARAMS ((serial_t));
 
-void serial_close PARAMS ((void));
+#define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
 
-/* Restore the serial port to the state saved in oldstate */
+/* Restore the serial port to the state saved in oldstate.  XXX - currently
+   unused! */
 
-void serial_restore PARAMS ((int desc, struct ttystate oldstate));
+#define SERIAL_RESTORE(SERIAL_T) (SERIAL_T)->ops->restore((SERIAL_T))
This page took 0.033708 seconds and 4 git commands to generate.