* Rename remote-es1800.c to remote-es.c

[deliverable/binutils-gdb.git] / gdb / serial.h

diff --git a/gdb/serial.h b/gdb/serial.h
index 767a91b31610cba3840df60b8265367230933ca7..f83fda7045f42141331fc7377916cdbd649ee430 100644 (file)
--- a/gdb/serial.h
+++ b/gdb/serial.h
@@ -19,16 +19,17 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 
 /* Terminal state pointer.  This is specific to each type of interface. */
 
-typedef PTR ttystate;
+typedef PTR serial_ttystate;
 
 struct _serial_t
 {
-  int fd;
-  struct serial_ops *ops;
-  ttystate ttystate;
-  int bufcnt;
-  unsigned char *bufp;
-  unsigned char buf[BUFSIZ];
+  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 */
 };
 
 typedef struct _serial_t *serial_t;
@@ -41,7 +42,8 @@ struct serial_ops {
   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));
+  serial_ttystate (*get_tty_state) PARAMS ((serial_t));
+  int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
   int (*setbaudrate) PARAMS ((serial_t, int rate));
 };
 
@@ -49,38 +51,53 @@ struct serial_ops {
 
 void serial_add_interface PARAMS ((struct serial_ops *optable));
 
-/* Try to open the serial device "name", returns a serial_t if ok, NULL if not.
+serial_t serial_open PARAMS ((const char *name));
+
+serial_t serial_fdopen PARAMS ((int fd));
+
+/* For most routines, if a failure is indicated, then errno should be
+   examined.  */
+
+/* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
  */
 
-serial_t serial_open PARAMS ((const char *name));
+#define SERIAL_OPEN(NAME) serial_open(NAME)
 
-/* Internal open routine for specific I/O interface */
+/* Open a new serial stream using a file handle.  */
 
-#define SERIAL_OPEN(SERIAL_T, NAME) (SERIAL_T)->ops->open((SERIAL_T), NAME)
+#define SERIAL_FDOPEN(FD) serial_fdopen(FD)
 
-/* Turn the port into raw mode.  */
+/* Turn the port into raw mode. */
 
 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
 
-/* 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_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
+
+#define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
+
+/* 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
 
 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
 
-/* Set the baudrate to the decimal value supplied.  Return 1 on failure,
-   0 otherwise.  */
+/* 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 some chars to the device, returns 0 for failure.  See errno for
-   details. */
+/* 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))
 
-/* Close the serial port */
+/* Push out all buffers, close the device and destroy SERIAL_T. */
 
-#define SERIAL_CLOSE(SERIAL_T) (SERIAL_T)->ops->close((SERIAL_T))
+void serial_close PARAMS ((serial_t));
 
-/* Restore the serial port to the state saved in oldstate */
+#define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
 
-#define SERIAL_RESTORE(SERIAL_T) (SERIAL_T)->ops->restore((SERIAL_T))