diff options
Diffstat (limited to 'contrib/gdb/gdb/serial.h')
| -rw-r--r-- | contrib/gdb/gdb/serial.h | 320 |
1 files changed, 185 insertions, 135 deletions
diff --git a/contrib/gdb/gdb/serial.h b/contrib/gdb/gdb/serial.h index 04332bc..97d68f3 100644 --- a/contrib/gdb/gdb/serial.h +++ b/contrib/gdb/gdb/serial.h @@ -1,191 +1,241 @@ /* Remote serial support interface definitions for GDB, the GNU Debugger. - Copyright 1992, 1993 Free Software Foundation, Inc. + Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000 + Free Software Foundation, Inc. -This file is part of GDB. + This file is part of GDB. -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. -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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ + 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., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. */ #ifndef SERIAL_H #define SERIAL_H -/* Terminal state pointer. This is specific to each type of interface. */ - -typedef PTR serial_ttystate; - -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 */ - /* 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 */ -}; +/* For most routines, if a failure is indicated, then errno should be + examined. */ -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)); -}; +/* Terminal state pointer. This is specific to each type of + interface. */ -/* Add a new serial interface to the interface list */ +typedef void *serial_ttystate; +struct serial; -void serial_add_interface PARAMS ((struct serial_ops *optable)); +/* Try to open NAME. Returns a new `struct serial *' on success, NULL + on failure. Note that some open calls can block and, if possible, + should be written to be non-blocking, with calls to ui_look_hook + so they can be cancelled. An async interface for open could be + added to GDB if necessary. */ -serial_t serial_open PARAMS ((const char *name)); +extern struct serial *serial_open (const char *name); -serial_t serial_fdopen PARAMS ((const int fd)); +/* Open a new serial stream using a file handle. */ -/* For most routines, if a failure is indicated, then errno should be - examined. */ +extern struct serial *serial_fdopen (const int fd); -/* Try to open NAME. Returns a new serial_t on success, NULL on failure. - */ +/* Push out all buffers, close the device and destroy SCB. */ -#define SERIAL_OPEN(NAME) serial_open(NAME) +extern void serial_close (struct serial *scb); -/* Open a new serial stream using a file handle. */ +/* Push out all buffers and destroy SCB without closing the device. */ + +extern void serial_un_fdopen (struct serial *scb); + +/* 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. + Infinite waits are not permitted. Returns unsigned char if ok, else + one of the following codes. Note that all error return-codes are + guaranteed to be < 0. */ + +enum serial_rc { + SERIAL_ERROR = -1, /* General error. */ + SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read. + Unfortunately, through ui_loop_hook(), this + can also be a QUIT indication. */ + SERIAL_EOF = -3 /* General end-of-file or remote target + connection closed, indication. Includes + things like the line dropping dead. */ +}; + +extern int serial_readchar (struct serial *scb, int timeout); + +/* Write LEN chars from STRING to the port SCB. Returns 0 for + success, non-zero for failure. */ + +extern int serial_write (struct serial *scb, const char *str, int len); + +/* Write a printf style string onto the serial port. */ -#define SERIAL_FDOPEN(FD) serial_fdopen(FD) +extern void serial_printf (struct serial *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))) - -/* Flush (discard) pending output. Might also flush input (if this system can't flush - only output). */ +extern int serial_drain_output (struct serial *); -#define SERIAL_FLUSH_OUTPUT(SERIAL_T) \ - ((SERIAL_T)->ops->flush_output((SERIAL_T))) +/* Flush (discard) pending output. Might also flush input (if this + system can't flush only output). */ -/* Flush pending input. Might also flush output (if this system can't flush - only input). */ +extern int serial_flush_output (struct serial *); -#define SERIAL_FLUSH_INPUT(SERIAL_T)\ - ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T))) +/* Flush pending input. Might also flush output (if this system can't + flush only input). */ -/* Send a break between 0.25 and 0.5 seconds long. */ +extern int serial_flush_input (struct serial *); -extern int serial_send_break PARAMS ((serial_t scb)); +/* Send a break between 0.25 and 0.5 seconds long. */ -#define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T) +extern int serial_send_break (struct serial *scb); /* Turn the port into raw mode. */ -#define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T)) +extern void serial_raw (struct serial *scb); /* 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 (struct serial *scb); /* 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). */ -/* 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))) +extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate); -/* 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. */ -#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))) +/* printf_filtered a user-comprehensible description of ttystate on + the specified STREAM. FIXME: At present this sends output to the + default stream - GDB_STDOUT. */ -/* 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_ERROR -1 /* General error, see errno for details */ -#define SERIAL_TIMEOUT -2 -#define SERIAL_EOF -3 +extern void serial_print_tty_state (struct serial *scb, serial_ttystate ttystate, struct ui_file *); -extern int serial_readchar PARAMS ((serial_t scb, int timeout)); +/* 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. */ -#define SERIAL_READCHAR(SERIAL_T, TIMEOUT) serial_readchar (SERIAL_T, TIMEOUT) +extern int serial_noflush_set_tty_state (struct serial *scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate); -/* Set the baudrate to the decimal value supplied. Returns 0 for success, - -1 for failure. */ +/* 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)) +extern int serial_setbaudrate (struct serial *scb, int rate); -/* Set the number of stop bits to the value specified. Returns 0 for success, - -1 for failure. */ +/* Set the number of stop bits to the value specified. Returns 0 for + success, -1 for failure. */ #define SERIAL_1_STOPBITS 1 -#define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */ +#define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */ #define SERIAL_2_STOPBITS 3 -#define SERIAL_SETSTOPBITS(SERIAL_T, NUM) ((SERIAL_T)->ops->setstopbits((SERIAL_T), NUM)) +extern int serial_setstopbits (struct serial *scb, int num); + +/* Asynchronous serial interface: */ + +/* Can the serial device support asynchronous mode? */ + +extern int serial_can_async_p (struct serial *scb); + +/* Has the serial device been put in asynchronous mode? */ + +extern int serial_is_async_p (struct serial *scb); + +/* For ASYNC enabled devices, register a callback and enable + asynchronous mode. To disable asynchronous mode, register a NULL + callback. */ + +typedef void (serial_event_ftype) (struct serial *scb, void *context); +extern void serial_async (struct serial *scb, serial_event_ftype *handler, void *context); + +/* 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 int deprecated_serial_fd (struct serial *scb); + +/* Trace/debug mechanism. + + serial_debug() enables/disables internal debugging. + serial_debug_p() indicates the current debug state. */ + +extern void serial_debug (struct serial *scb, int debug_p); + +extern int serial_debug_p (struct serial *scb); + + +/* Details of an instance of a serial object */ + +struct serial + { + 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 remaining in receive + buffer. -ve for sticky errors. */ + unsigned char *bufp; /* Current byte */ + unsigned char buf[BUFSIZ]; /* Da buffer itself */ + int current_timeout; /* (ser-unix.c termio{,s} only), last + value of VTIME */ + int timeout_remaining; /* (ser-unix.c termio{,s} only), we + still need to wait for this many + more seconds. */ + char *name; /* The name of the device or host */ + struct serial *next; /* Pointer to the next `struct serial *' */ + int refcnt; /* Number of pointers to this block */ + int debug_p; /* Trace this serial devices operation. */ + int async_state; /* Async internal state. */ + 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) (struct serial *, const char *name); + void (*close) (struct serial *); + int (*readchar) (struct serial *, int timeout); + int (*write) (struct serial *, const char *str, int len); + /* Discard pending output */ + int (*flush_output) (struct serial *); + /* Discard pending input */ + int (*flush_input) (struct serial *); + int (*send_break) (struct serial *); + void (*go_raw) (struct serial *); + serial_ttystate (*get_tty_state) (struct serial *); + int (*set_tty_state) (struct serial *, serial_ttystate); + void (*print_tty_state) (struct serial *, serial_ttystate, + struct ui_file *); + int (*noflush_set_tty_state) (struct serial *, serial_ttystate, + serial_ttystate); + int (*setbaudrate) (struct serial *, int rate); + int (*setstopbits) (struct serial *, int num); + /* Wait for output to drain */ + int (*drain_output) (struct serial *); + /* Change the serial device into/out of asynchronous mode, call + the specified function when ever there is something + interesting. */ + void (*async) (struct serial *scb, int async_p); + }; -/* Write LEN chars from STRING to the port SERIAL_T. Returns 0 for - success, non-zero for failure. */ - -extern int serial_write PARAMS ((serial_t scb, const char *str, int len)); - -#define SERIAL_WRITE(SERIAL_T, STRING,LEN) serial_write (SERIAL_T, STRING, LEN) - -/* Push out all buffers, close the device and destroy SERIAL_T. */ - -extern void serial_close PARAMS ((serial_t, int)); - -#define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T, 1) - -/* Push out all buffers and destroy SERIAL_T without closing the device. */ - -#define SERIAL_UN_FDOPEN(SERIAL_T) serial_close(SERIAL_T, 0) +/* 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 */ |
