X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fserial.h;h=8d67c4bf537a94e46d0dc2267baf0682d1980add;hb=21af24c8371a3e040f6f548ddfafb20114442c28;hp=89b66b452cf38052815c62a7dd5621fcefd05272;hpb=b450502905875e85aab17371f78bb6befe5a3059;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/serial.h b/gdb/serial.h index 89b66b452c..8d67c4bf53 100644 --- a/gdb/serial.h +++ b/gdb/serial.h @@ -1,12 +1,11 @@ /* Remote serial support interface definitions for GDB, the GNU Debugger. - Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000 - Free Software Foundation, Inc. + Copyright (C) 1992-2020 Free Software Foundation, Inc. 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 + the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -15,13 +14,16 @@ 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. */ + along with this program. If not, see . */ #ifndef SERIAL_H #define SERIAL_H +#ifdef USE_WIN32API +#include +#include +#endif + struct ui_file; /* For most routines, if a failure is indicated, then errno should be @@ -32,30 +34,67 @@ struct ui_file; typedef void *serial_ttystate; struct serial; +struct serial_ops; + +/* Create a new serial for OPS. The new serial is not opened. */ /* 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. */ + on failure. The new serial object has a reference count of 1. + 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. */ extern struct serial *serial_open (const char *name); +/* Open a new serial stream using OPS. */ + +extern struct serial *serial_open_ops (const struct serial_ops *ops); + +/* Returns true if SCB is open. */ + +extern int serial_is_open (struct serial *scb); + +/* Find an already opened serial stream using a file handle. */ + +extern struct serial *serial_for_fd (int fd); + /* Open a new serial stream using a file handle. */ extern struct serial *serial_fdopen (const int fd); -/* Push out all buffers, close the device and destroy SCB. */ +/* Push out all buffers, close the device and unref SCB. */ extern void serial_close (struct serial *scb); +/* Increment reference count of SCB. */ + +extern void serial_ref (struct serial *scb); + +/* Decrement reference count of SCB. */ + +extern void serial_unref (struct serial *scb); + +/* Create a pipe, and put the read end in FILDES[0], and the write end + in FILDES[1]. Returns 0 for success, negative value for error (in + which case errno contains the error). */ + +extern int gdb_pipe (int fildes[2]); + +/* Create a pipe with each end wrapped in a `struct serial' interface. + Put the read end in scbs[0], and the write end in scbs[1]. Returns + 0 for success, negative value for error (in which case errno + contains the error). */ + +extern int serial_pipe (struct serial *scbs[2]); + /* 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 + 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. */ @@ -72,15 +111,15 @@ enum serial_rc { extern int serial_readchar (struct serial *scb, int timeout); -/* Write LEN chars from STRING to the port SCB. Returns 0 for +/* Write COUNT bytes from BUF to the port SCB. Returns 0 for success, non-zero for failure. */ -extern int serial_write (struct serial *scb, const char *str, int len); +extern int serial_write (struct serial *scb, const void *buf, size_t count); /* Write a printf style string onto the serial port. */ extern void serial_printf (struct serial *desc, - const char *,...) ATTR_FORMAT (printf, 2, 3); + const char *,...) ATTRIBUTE_PRINTF (2, 3); /* Allow pending output to drain. */ @@ -109,6 +148,12 @@ extern void serial_raw (struct serial *scb); extern serial_ttystate serial_get_tty_state (struct serial *scb); +/* Return a pointer to a newly malloc'd ttystate containing a copy + of the state in TTYSTATE. */ + +extern serial_ttystate serial_copy_tty_state (struct serial *scb, + serial_ttystate ttystate); + /* 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 @@ -117,18 +162,12 @@ extern serial_ttystate serial_get_tty_state (struct serial *scb); extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate); /* printf_filtered a user-comprehensible description of ttystate on - the specified STREAM. FIXME: At present this sends output to the + the specified STREAM. FIXME: At present this sends output to the default stream - GDB_STDOUT. */ -extern void serial_print_tty_state (struct serial *scb, serial_ttystate ttystate, struct ui_file *); - -/* 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. */ - -extern int serial_noflush_set_tty_state (struct serial *scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate); +extern void serial_print_tty_state (struct serial *scb, + serial_ttystate ttystate, + struct ui_file *); /* Set the baudrate to the decimal value supplied. Returns 0 for success, -1 for failure. */ @@ -144,13 +183,21 @@ extern int serial_setbaudrate (struct serial *scb, int rate); extern int serial_setstopbits (struct serial *scb, int num); +#define GDBPARITY_NONE 0 +#define GDBPARITY_ODD 1 +#define GDBPARITY_EVEN 2 + +/* Set parity for serial port. Returns 0 for success, -1 for failure. */ + +extern int serial_setparity (struct serial *scb, int parity); + /* Asynchronous serial interface: */ -/* Can the serial device support asynchronous mode? */ +/* 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? */ +/* Has the serial device been put in asynchronous mode? */ extern int serial_is_async_p (struct serial *scb); @@ -159,14 +206,8 @@ extern int serial_is_async_p (struct serial *scb); 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); +extern void serial_async (struct serial *scb, + serial_event_ftype *handler, void *context); /* Trace/debug mechanism. @@ -178,26 +219,29 @@ 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 */ +/* Details of an instance of a serial object. */ struct serial { + /* serial objects are ref counted (but not the underlying + connection, just the object's lifetime in memory). */ + int refcnt; + int fd; /* File descriptor */ - struct serial_ops *ops; /* Function vector */ + /* File descriptor for a separate error stream that should be + immediately forwarded to gdb_stderr. This may be -1. + If != -1, this descriptor should be non-blocking or + ops->avail should be non-NULL. */ + int error_fd; + const 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 */ @@ -206,12 +250,12 @@ struct serial struct serial_ops { - char *name; - struct serial_ops *next; + const char *name; int (*open) (struct serial *, const char *name); void (*close) (struct serial *); + int (*fdopen) (struct serial *, int fd); int (*readchar) (struct serial *, int timeout); - int (*write) (struct serial *, const char *str, int len); + int (*write) (struct serial *, const void *buf, size_t count); /* Discard pending output */ int (*flush_output) (struct serial *); /* Discard pending input */ @@ -219,33 +263,59 @@ struct serial_ops int (*send_break) (struct serial *); void (*go_raw) (struct serial *); serial_ttystate (*get_tty_state) (struct serial *); + serial_ttystate (*copy_tty_state) (struct serial *, serial_ttystate); 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 */ + /* Set the value PARITY as parity setting for serial object. + Return 0 in the case of success. */ + int (*setparity) (struct serial *, int parity); + /* 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); /* Perform a low-level read operation, reading (at most) COUNT - bytes into SCB->BUF. */ + bytes into SCB->BUF. Return zero at end of file. */ int (*read_prim)(struct serial *scb, size_t count); /* Perform a low-level write operation, writing (at most) COUNT bytes from BUF. */ int (*write_prim)(struct serial *scb, const void *buf, size_t count); + /* Return that number of bytes that can be read from FD + without blocking. Return value of -1 means that the + read will not block even if less that requested bytes + are available. */ + int (*avail)(struct serial *scb, int fd); + +#ifdef USE_WIN32API + /* Return a handle to wait on, indicating available data from SCB + when signaled, in *READ. Return a handle indicating errors + in *EXCEPT. */ + void (*wait_handle) (struct serial *scb, HANDLE *read, HANDLE *except); + void (*done_wait_handle) (struct serial *scb); +#endif /* USE_WIN32API */ }; -/* Add a new serial interface to the interface list */ +/* Add a new serial interface to the interface list. */ + +extern void serial_add_interface (const struct serial_ops * optable); + +/* File in which to record the remote debugging session. */ + +extern void serial_log_command (struct target_ops *self, const char *); + +#ifdef USE_WIN32API -extern void serial_add_interface (struct serial_ops * optable); +/* Windows-only: find or create handles that we can wait on for this + serial device. */ +extern void serial_wait_handle (struct serial *, HANDLE *, HANDLE *); -/* File in which to record the remote debugging session */ +/* Windows-only: signal that we are done with the wait handles. */ +extern void serial_done_wait_handle (struct serial *); -extern void serial_log_command (const char *); +#endif /* USE_WIN32API */ #endif /* SERIAL_H */