import gdb-1999-09-21

1 files changed, 155 insertions, 111 deletions

diff --git a/gdb/serial.h b/gdb/serial.h
index 09916fe8387..e3a1bf271f3 100644
--- a/gdb/serial.h
+++ b/gdb/serial.h
@@ -1,5 +1,5 @@
 /* Remote serial support interface definitions for GDB, the GNU Debugger.
-   Copyright 1992, 1993 Free Software Foundation, Inc.
+   Copyright 1992, 1993, 1999 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -21,175 +21,219 @@
 #ifndef SERIAL_H
 #define SERIAL_H
 
-/* Terminal state pointer.  This is specific to each type of interface. */
-
-typedef PTR serial_ttystate;
+/* For most routines, if a failure is indicated, then errno should be
+   examined.  */
 
-struct _serial_t
-  {
-    int fd;			/* File descriptor */
-    struct serial_ops *ops;	/* Function vector */
-    void *state;       		/* Local context info for open FD */
-    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 */
-    /* ser-unix.c termio{,s} only, we still need to wait for this many more
-       seconds.  */
-    int timeout_remaining;
-    char *name;			/* The name of the device or host */
-    struct _serial_t *next;	/* Pointer to the next serial_t */
-    int refcnt;			/* Number of pointers to this block */
-  };
+/* Terminal state pointer.  This is specific to each type of
+   interface. */
 
+typedef void *serial_ttystate;
+struct _serial_t;
 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));
-    /* Discard pending output */
-    int (*flush_output) PARAMS ((serial_t));
-    /* Discard pending input */
-    int (*flush_input) PARAMS ((serial_t));
-    int (*send_break) PARAMS ((serial_t));
-    void (*go_raw) PARAMS ((serial_t));
-      serial_ttystate (*get_tty_state) PARAMS ((serial_t));
-    int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
-    void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
-    int (*noflush_set_tty_state)
-      PARAMS ((serial_t, serial_ttystate, serial_ttystate));
-    int (*setbaudrate) PARAMS ((serial_t, int rate));
-    int (*setstopbits) PARAMS ((serial_t, int num));
-    /* Wait for output to drain */
-    int (*drain_output) PARAMS ((serial_t));
-  };
+/* Try to open NAME.  Returns a new serial_t on success, NULL on
+   failure. */
 
-/* Add a new serial interface to the interface list */
+extern serial_t serial_open (const char *name);
+#define SERIAL_OPEN(NAME) serial_open(NAME)
 
-void serial_add_interface PARAMS ((struct serial_ops * optable));
+/* Open a new serial stream using a file handle.  */
 
-serial_t serial_open PARAMS ((const char *name));
+extern serial_t serial_fdopen (const int fd);
+#define SERIAL_FDOPEN(FD) serial_fdopen(FD)
 
-serial_t serial_fdopen PARAMS ((const int fd));
+/* Push out all buffers, close the device and destroy SERIAL_T. */
 
-/* For most routines, if a failure is indicated, then errno should be
-   examined.  */
+extern void serial_close (serial_t);
+#define SERIAL_CLOSE(SERIAL_T) serial_close ((SERIAL_T))
 
-/* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
- */
+/* Push out all buffers and destroy SERIAL_T without closing the
+   device.  */
 
-#define SERIAL_OPEN(NAME) serial_open(NAME)
+extern void serial_un_fdopen (serial_t scb);
+#define SERIAL_UN_FDOPEN(SERIAL_T) serial_un_fdopen ((SERIAL_T))
 
-/* Open a new serial stream using a file handle.  */
+/* Read one char from the serial device with TIMEOUT seconds to wait
+   or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
+   char if ok, else one of the following codes.  Note that all error
+   codes are guaranteed to be < 0.  */
 
-#define SERIAL_FDOPEN(FD) serial_fdopen(FD)
+#define SERIAL_ERROR -1		/* General error, see errno for details */
+#define SERIAL_TIMEOUT -2
+#define SERIAL_EOF -3
+
+extern int serial_readchar (serial_t scb, int timeout);
+#define SERIAL_READCHAR(SERIAL_T, TIMEOUT) serial_readchar ((SERIAL_T), (TIMEOUT))
+
+/* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
+   success, non-zero for failure.  */
+
+extern int serial_write (serial_t scb, const char *str, int len);
+#define SERIAL_WRITE(SERIAL_T, STRING,LEN)  serial_write (SERIAL_T, STRING, LEN)
+
+/* Write a printf style string onto the serial port. */
+
+extern void serial_printf (serial_t desc, const char *,...) ATTR_FORMAT (printf, 2, 3);
 
 /* Allow pending output to drain. */
 
-#define SERIAL_DRAIN_OUTPUT(SERIAL_T) \
-  ((SERIAL_T)->ops->drain_output((SERIAL_T)))
+extern int serial_drain_output (serial_t);
+#define SERIAL_DRAIN_OUTPUT(SERIAL_T) serial_drain_output ((SERIAL_T))
 
-/* Flush (discard) pending output.  Might also flush input (if this system can't flush
-   only output).  */
+/* Flush (discard) pending output.  Might also flush input (if this
+   system can't flush only output).  */
 
-#define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
-  ((SERIAL_T)->ops->flush_output((SERIAL_T)))
+extern int serial_flush_output (serial_t);
+#define SERIAL_FLUSH_OUTPUT(SERIAL_T) serial_flush_output ((SERIAL_T))
 
-/* Flush pending input.  Might also flush output (if this system can't flush
-   only input).  */
+/* Flush pending input.  Might also flush output (if this system can't
+   flush only input).  */
 
-#define SERIAL_FLUSH_INPUT(SERIAL_T)\
-  ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
+extern int serial_flush_input (serial_t);
+#define SERIAL_FLUSH_INPUT(SERIAL_T) serial_flush_input ((SERIAL_T))
 
 /* Send a break between 0.25 and 0.5 seconds long.  */
 
-extern int serial_send_break PARAMS ((serial_t scb));
-
+extern int serial_send_break (serial_t scb);
 #define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T)
 
 /* Turn the port into raw mode. */
 
-#define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
+extern void serial_raw (serial_t scb);
+#define SERIAL_RAW(SERIAL_T) serial_raw ((SERIAL_T))
 
 /* Return a pointer to a newly malloc'd ttystate containing the state
    of the tty.  */
-#define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
+
+extern serial_ttystate serial_get_tty_state (serial_t scb);
+#define SERIAL_GET_TTY_STATE(SERIAL_T) serial_get_tty_state ((SERIAL_T))
 
 /* Set the state of the tty to TTYSTATE.  The change is immediate.
    When changing to or from raw mode, input might be discarded.
-   Returns 0 for success, negative value for error (in which case errno
-   contains the error).  */
-#define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
+   Returns 0 for success, negative value for error (in which case
+   errno contains the error).  */
+
+extern int serial_set_tty_state (serial_t scb, serial_ttystate ttystate);
+#define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) serial_set_tty_state ((SERIAL_T), (TTYSTATE))
 
-/* printf_filtered a user-comprehensible description of ttystate.  */
-#define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
-  ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
+/* printf_filtered a user-comprehensible description of ttystate on
+   the specified STREAM. FIXME: At present this sends output to the
+   default stream - GDB_STDOUT. */
+
+extern void serial_print_tty_state (serial_t scb, serial_ttystate ttystate, struct gdb_file *);
+#define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE, STREAM) serial_print_tty_state ((SERIAL_T), (TTYSTATE), (STREAM))
 
 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
    current state (generally obtained from a recent call to
    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
-   This means that we never switch in or out of raw mode, even
-   if NEW_TTYSTATE specifies a switch.  */
+   This means that we never switch in or out of raw mode, even if
+   NEW_TTYSTATE specifies a switch.  */
+
+extern int serial_noflush_set_tty_state (serial_t scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate);
 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
-  ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
-    ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
+serial_noflush_set_tty_state ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE))
 
-/* Read one char from the serial device with TIMEOUT seconds to wait
-   or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
-   char if ok, else one of the following codes.  Note that all error
-   codes are guaranteed to be < 0.  */
+/* Set the baudrate to the decimal value supplied.  Returns 0 for
+   success, -1 for failure.  */
 
-#define SERIAL_ERROR -1		/* General error, see errno for details */
-#define SERIAL_TIMEOUT -2
-#define SERIAL_EOF -3
+extern int serial_setbaudrate (serial_t scb, int rate);
+#define SERIAL_SETBAUDRATE(SERIAL_T, RATE) serial_setbaudrate ((SERIAL_T), (RATE))
 
-extern int serial_readchar PARAMS ((serial_t scb, int timeout));
+/* Set the number of stop bits to the value specified.  Returns 0 for
+   success, -1 for failure.  */
 
-#define SERIAL_READCHAR(SERIAL_T, TIMEOUT)  serial_readchar (SERIAL_T, TIMEOUT)
+#define SERIAL_1_STOPBITS 1
+#define SERIAL_1_AND_A_HALF_STOPBITS 2	/* 1.5 bits, snicker... */
+#define SERIAL_2_STOPBITS 3
 
-/* Set the baudrate to the decimal value supplied.  Returns 0 for success,
-   -1 for failure.  */
+extern int serial_setstopbits (serial_t scb, int num);
+#define SERIAL_SETSTOPBITS(SERIAL_T, NUM) serial_setstopbits ((SERIAL_T), (NUM))
 
-#define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
+/* Asynchronous serial interface: */
 
-/* Set the number of stop bits to the value specified.  Returns 0 for success,
-   -1 for failure.  */
+/* Can the serial device support asynchronous mode? */
 
-#define SERIAL_1_STOPBITS 1
-#define SERIAL_1_AND_A_HALF_STOPBITS 2	/* 1.5 bits, snicker... */
-#define SERIAL_2_STOPBITS 3
+extern int serial_can_async_p (serial_t scb);
+#define SERIAL_CAN_ASYNC_P(SERIAL_T) serial_can_async_p ((SERIAL_T))
 
-#define SERIAL_SETSTOPBITS(SERIAL_T, NUM) ((SERIAL_T)->ops->setstopbits((SERIAL_T), NUM))
+/* Has the serial device been put in asynchronous mode? */
 
-/* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
-   success, non-zero for failure.  */
+extern int serial_is_async_p (serial_t scb);
+#define SERIAL_IS_ASYNC_P(SERIAL_T) serial_is_async_p ((SERIAL_T))
 
-extern int serial_write PARAMS ((serial_t scb, const char *str, int len));
+/* For ASYNC enabled devices, register a callback and enable
+   asynchronous mode.  To disable asynchronous mode, register a NULL
+   callback. */
 
-#define SERIAL_WRITE(SERIAL_T, STRING,LEN)  serial_write (SERIAL_T, STRING, LEN)
+typedef void (serial_event_ftype) (int error, void *context, int fd);
+extern void serial_async (serial_t scb, serial_event_ftype *handler, void *context);
+#define SERIAL_ASYNC(SERIAL_T, HANDLER, CONTEXT) serial_async ((SERIAL_T), (HANDLER), (CONTEXT)) 
 
-/* Push out all buffers, close the device and destroy SERIAL_T. */
+/* Provide direct access to the underlying FD (if any) used to
+   implement the serial device.  This interface is clearly
+   deprecated. Will call internal_error() if the operation isn't
+   applicable to the current serial device. */
 
-extern void serial_close PARAMS ((serial_t, int));
+extern int deprecated_serial_fd (serial_t scb);
+#define DEPRECATED_SERIAL_FD(SERIAL_T) deprecated_serial_fd ((SERIAL_T))
 
-#define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T, 1)
 
-/* Push out all buffers and destroy SERIAL_T without closing the device.  */
+/* Details of an instance of a serial object */
 
-#define SERIAL_UN_FDOPEN(SERIAL_T) serial_close(SERIAL_T, 0)
+struct _serial_t
+  {
+    int fd;			/* File descriptor */
+    struct serial_ops *ops;	/* Function vector */
+    void *state;       		/* Local context info for open FD */
+    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 */
+    /* ser-unix.c termio{,s} only, we still need to wait for this many more
+       seconds.  */
+    int timeout_remaining;
+    char *name;			/* The name of the device or host */
+    struct _serial_t *next;	/* Pointer to the next serial_t */
+    int refcnt;			/* Number of pointers to this block */
+    void *async_context;	/* Async event thread's context */
+    serial_event_ftype *async_handler;/* Async event handler */
+  };
+
+struct serial_ops
+  {
+    char *name;
+    struct serial_ops *next;
+    int (*open) (serial_t, const char *name);
+    void (*close) (serial_t);
+    int (*readchar) (serial_t, int timeout);
+    int (*write) (serial_t, const char *str, int len);
+    /* Discard pending output */
+    int (*flush_output) (serial_t);
+    /* Discard pending input */
+    int (*flush_input) (serial_t);
+    int (*send_break) (serial_t);
+    void (*go_raw) (serial_t);
+    serial_ttystate (*get_tty_state) (serial_t);
+    int (*set_tty_state) (serial_t, serial_ttystate);
+    void (*print_tty_state) (serial_t, serial_ttystate, struct gdb_file *);
+    int (*noflush_set_tty_state) (serial_t, serial_ttystate, serial_ttystate);
+    int (*setbaudrate) (serial_t, int rate);
+    int (*setstopbits) (serial_t, int num);
+    /* Wait for output to drain */
+    int (*drain_output) (serial_t);
+    /* Change the serial device into/out of asynchronous mode, call
+       the specified function when ever there is something
+       interesting. */
+    void (*async) (serial_t scb, int async_p);
+  };
+
+/* Add a new serial interface to the interface list */
 
-extern void serial_printf
-PARAMS ((serial_t desc, const char *,...))
-ATTR_FORMAT (printf, 2, 3);
+extern void serial_add_interface (struct serial_ops * optable);
 
 /* File in which to record the remote debugging session */
 
-     extern void serial_log_command PARAMS ((const char *));
+extern void serial_log_command (const char *);
 
 #endif /* SERIAL_H */