/* Remote serial support interface definitions for GDB, the GNU Debugger.
|
/* Remote serial support interface definitions for GDB, the GNU Debugger.
|
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2004,
|
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2004,
|
2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
|
2005, 2006, 2007, 2008, 2009, 2010 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
|
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
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 3 of the License, or
|
the Free Software Foundation; either version 3 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
#ifndef SERIAL_H
|
#ifndef SERIAL_H
|
#define SERIAL_H
|
#define SERIAL_H
|
|
|
#ifdef USE_WIN32API
|
#ifdef USE_WIN32API
|
#include <windows.h>
|
#include <windows.h>
|
#endif
|
#endif
|
|
|
struct ui_file;
|
struct ui_file;
|
|
|
/* For most routines, if a failure is indicated, then errno should be
|
/* For most routines, if a failure is indicated, then errno should be
|
examined. */
|
examined. */
|
|
|
/* Terminal state pointer. This is specific to each type of
|
/* Terminal state pointer. This is specific to each type of
|
interface. */
|
interface. */
|
|
|
typedef void *serial_ttystate;
|
typedef void *serial_ttystate;
|
struct serial;
|
struct serial;
|
|
|
/* Try to open NAME. Returns a new `struct serial *' on success, NULL
|
/* Try to open NAME. Returns a new `struct serial *' on success, NULL
|
on failure. Note that some open calls can block and, if possible,
|
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
|
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
|
so they can be cancelled. An async interface for open could be
|
added to GDB if necessary. */
|
added to GDB if necessary. */
|
|
|
extern struct serial *serial_open (const char *name);
|
extern struct serial *serial_open (const char *name);
|
|
|
/* Find an already opened serial stream using a file handle. */
|
/* Find an already opened serial stream using a file handle. */
|
|
|
extern struct serial *serial_for_fd (int fd);
|
extern struct serial *serial_for_fd (int fd);
|
|
|
/* Open a new serial stream using a file handle. */
|
/* Open a new serial stream using a file handle. */
|
|
|
extern struct serial *serial_fdopen (const int fd);
|
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 destroy SCB. */
|
|
|
extern void serial_close (struct serial *scb);
|
extern void serial_close (struct serial *scb);
|
|
|
/* Push out all buffers and destroy SCB without closing the device. */
|
/* Push out all buffers and destroy SCB without closing the device. */
|
|
|
extern void serial_un_fdopen (struct serial *scb);
|
extern void serial_un_fdopen (struct serial *scb);
|
|
|
/* Read one char from the serial device with TIMEOUT seconds to wait
|
/* 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.
|
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
|
one of the following codes. Note that all error return-codes are
|
guaranteed to be < 0. */
|
guaranteed to be < 0. */
|
|
|
enum serial_rc {
|
enum serial_rc {
|
SERIAL_ERROR = -1, /* General error. */
|
SERIAL_ERROR = -1, /* General error. */
|
SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read.
|
SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read.
|
Unfortunately, through
|
Unfortunately, through
|
deprecated_ui_loop_hook (), this can also
|
deprecated_ui_loop_hook (), this can also
|
be a QUIT indication. */
|
be a QUIT indication. */
|
SERIAL_EOF = -3 /* General end-of-file or remote target
|
SERIAL_EOF = -3 /* General end-of-file or remote target
|
connection closed, indication. Includes
|
connection closed, indication. Includes
|
things like the line dropping dead. */
|
things like the line dropping dead. */
|
};
|
};
|
|
|
extern int serial_readchar (struct serial *scb, int timeout);
|
extern int serial_readchar (struct serial *scb, int timeout);
|
|
|
/* Write LEN chars from STRING to the port SCB. Returns 0 for
|
/* Write LEN chars from STRING to the port SCB. Returns 0 for
|
success, non-zero for failure. */
|
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 char *str, int len);
|
|
|
/* Write a printf style string onto the serial port. */
|
/* Write a printf style string onto the serial port. */
|
|
|
extern void serial_printf (struct serial *desc,
|
extern void serial_printf (struct serial *desc,
|
const char *,...) ATTR_FORMAT (printf, 2, 3);
|
const char *,...) ATTR_FORMAT (printf, 2, 3);
|
|
|
/* Allow pending output to drain. */
|
/* Allow pending output to drain. */
|
|
|
extern int serial_drain_output (struct serial *);
|
extern int serial_drain_output (struct serial *);
|
|
|
/* Flush (discard) pending output. Might also flush input (if this
|
/* Flush (discard) pending output. Might also flush input (if this
|
system can't flush only output). */
|
system can't flush only output). */
|
|
|
extern int serial_flush_output (struct serial *);
|
extern int serial_flush_output (struct serial *);
|
|
|
/* Flush pending input. Might also flush output (if this system can't
|
/* Flush pending input. Might also flush output (if this system can't
|
flush only input). */
|
flush only input). */
|
|
|
extern int serial_flush_input (struct serial *);
|
extern int serial_flush_input (struct serial *);
|
|
|
/* Send a break between 0.25 and 0.5 seconds long. */
|
/* Send a break between 0.25 and 0.5 seconds long. */
|
|
|
extern int serial_send_break (struct serial *scb);
|
extern int serial_send_break (struct serial *scb);
|
|
|
/* Turn the port into raw mode. */
|
/* Turn the port into raw mode. */
|
|
|
extern void serial_raw (struct serial *scb);
|
extern void serial_raw (struct serial *scb);
|
|
|
/* Return a pointer to a newly malloc'd ttystate containing the state
|
/* Return a pointer to a newly malloc'd ttystate containing the state
|
of the tty. */
|
of the tty. */
|
|
|
extern serial_ttystate serial_get_tty_state (struct serial *scb);
|
extern serial_ttystate serial_get_tty_state (struct serial *scb);
|
|
|
/* Set the state of the tty to TTYSTATE. The change is immediate.
|
/* Set the state of the tty to TTYSTATE. The change is immediate.
|
When changing to or from raw mode, input might be discarded.
|
When changing to or from raw mode, input might be discarded.
|
Returns 0 for success, negative value for error (in which case
|
Returns 0 for success, negative value for error (in which case
|
errno contains the error). */
|
errno contains the error). */
|
|
|
extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate);
|
extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate);
|
|
|
/* printf_filtered a user-comprehensible description of ttystate on
|
/* 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. */
|
default stream - GDB_STDOUT. */
|
|
|
extern void serial_print_tty_state (struct serial *scb, serial_ttystate ttystate, struct ui_file *);
|
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
|
/* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
|
current state (generally obtained from a recent call to
|
current state (generally obtained from a recent call to
|
serial_get_tty_state()), but be careful not to discard any input.
|
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
|
This means that we never switch in or out of raw mode, even if
|
NEW_TTYSTATE specifies a switch. */
|
NEW_TTYSTATE specifies a switch. */
|
|
|
extern int serial_noflush_set_tty_state (struct serial *scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate);
|
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
|
/* Set the baudrate to the decimal value supplied. Returns 0 for
|
success, -1 for failure. */
|
success, -1 for failure. */
|
|
|
extern int serial_setbaudrate (struct serial *scb, int rate);
|
extern int serial_setbaudrate (struct serial *scb, int rate);
|
|
|
/* Set the number of stop bits to the value specified. Returns 0 for
|
/* Set the number of stop bits to the value specified. Returns 0 for
|
success, -1 for failure. */
|
success, -1 for failure. */
|
|
|
#define SERIAL_1_STOPBITS 1
|
#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_2_STOPBITS 3
|
|
|
extern int serial_setstopbits (struct serial *scb, int num);
|
extern int serial_setstopbits (struct serial *scb, int num);
|
|
|
/* Asynchronous serial interface: */
|
/* 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);
|
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);
|
extern int serial_is_async_p (struct serial *scb);
|
|
|
/* For ASYNC enabled devices, register a callback and enable
|
/* For ASYNC enabled devices, register a callback and enable
|
asynchronous mode. To disable asynchronous mode, register a NULL
|
asynchronous mode. To disable asynchronous mode, register a NULL
|
callback. */
|
callback. */
|
|
|
typedef void (serial_event_ftype) (struct serial *scb, void *context);
|
typedef void (serial_event_ftype) (struct serial *scb, void *context);
|
extern void serial_async (struct serial *scb, serial_event_ftype *handler, 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
|
/* Provide direct access to the underlying FD (if any) used to
|
implement the serial device. This interface is clearly
|
implement the serial device. This interface is clearly
|
deprecated. Will call internal_error() if the operation isn't
|
deprecated. Will call internal_error() if the operation isn't
|
applicable to the current serial device. */
|
applicable to the current serial device. */
|
|
|
extern int deprecated_serial_fd (struct serial *scb);
|
extern int deprecated_serial_fd (struct serial *scb);
|
|
|
/* Trace/debug mechanism.
|
/* Trace/debug mechanism.
|
|
|
serial_debug() enables/disables internal debugging.
|
serial_debug() enables/disables internal debugging.
|
serial_debug_p() indicates the current debug state. */
|
serial_debug_p() indicates the current debug state. */
|
|
|
extern void serial_debug (struct serial *scb, int debug_p);
|
extern void serial_debug (struct serial *scb, int debug_p);
|
|
|
extern int serial_debug_p (struct serial *scb);
|
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
|
struct serial
|
{
|
{
|
int fd; /* File descriptor */
|
int fd; /* File descriptor */
|
/* File descriptor for a separate error stream that should be
|
/* File descriptor for a separate error stream that should be
|
immediately forwarded to gdb_stderr. This may be -1.
|
immediately forwarded to gdb_stderr. This may be -1.
|
If != -1, this descriptor should be non-blocking or
|
If != -1, this descriptor should be non-blocking or
|
ops->avail should be non-NULL. */
|
ops->avail should be non-NULL. */
|
int error_fd;
|
int error_fd;
|
struct serial_ops *ops; /* Function vector */
|
struct serial_ops *ops; /* Function vector */
|
void *state; /* Local context info for open FD */
|
void *state; /* Local context info for open FD */
|
serial_ttystate ttystate; /* Not used (yet) */
|
serial_ttystate ttystate; /* Not used (yet) */
|
int bufcnt; /* Amount of data remaining in receive
|
int bufcnt; /* Amount of data remaining in receive
|
buffer. -ve for sticky errors. */
|
buffer. -ve for sticky errors. */
|
unsigned char *bufp; /* Current byte */
|
unsigned char *bufp; /* Current byte */
|
unsigned char buf[BUFSIZ]; /* Da buffer itself */
|
unsigned char buf[BUFSIZ]; /* Da buffer itself */
|
int current_timeout; /* (ser-unix.c termio{,s} only), last
|
int current_timeout; /* (ser-unix.c termio{,s} only), last
|
value of VTIME */
|
value of VTIME */
|
int timeout_remaining; /* (ser-unix.c termio{,s} only), we
|
int timeout_remaining; /* (ser-unix.c termio{,s} only), we
|
still need to wait for this many
|
still need to wait for this many
|
more seconds. */
|
more seconds. */
|
char *name; /* The name of the device or host */
|
char *name; /* The name of the device or host */
|
struct serial *next; /* Pointer to the next `struct serial *' */
|
struct serial *next; /* Pointer to the next `struct serial *' */
|
int refcnt; /* Number of pointers to this block */
|
int refcnt; /* Number of pointers to this block */
|
int debug_p; /* Trace this serial devices operation. */
|
int debug_p; /* Trace this serial devices operation. */
|
int async_state; /* Async internal state. */
|
int async_state; /* Async internal state. */
|
void *async_context; /* Async event thread's context */
|
void *async_context; /* Async event thread's context */
|
serial_event_ftype *async_handler;/* Async event handler */
|
serial_event_ftype *async_handler;/* Async event handler */
|
};
|
};
|
|
|
struct serial_ops
|
struct serial_ops
|
{
|
{
|
char *name;
|
char *name;
|
struct serial_ops *next;
|
struct serial_ops *next;
|
int (*open) (struct serial *, const char *name);
|
int (*open) (struct serial *, const char *name);
|
void (*close) (struct serial *);
|
void (*close) (struct serial *);
|
int (*readchar) (struct serial *, int timeout);
|
int (*readchar) (struct serial *, int timeout);
|
int (*write) (struct serial *, const char *str, int len);
|
int (*write) (struct serial *, const char *str, int len);
|
/* Discard pending output */
|
/* Discard pending output */
|
int (*flush_output) (struct serial *);
|
int (*flush_output) (struct serial *);
|
/* Discard pending input */
|
/* Discard pending input */
|
int (*flush_input) (struct serial *);
|
int (*flush_input) (struct serial *);
|
int (*send_break) (struct serial *);
|
int (*send_break) (struct serial *);
|
void (*go_raw) (struct serial *);
|
void (*go_raw) (struct serial *);
|
serial_ttystate (*get_tty_state) (struct serial *);
|
serial_ttystate (*get_tty_state) (struct serial *);
|
int (*set_tty_state) (struct serial *, serial_ttystate);
|
int (*set_tty_state) (struct serial *, serial_ttystate);
|
void (*print_tty_state) (struct serial *, serial_ttystate,
|
void (*print_tty_state) (struct serial *, serial_ttystate,
|
struct ui_file *);
|
struct ui_file *);
|
int (*noflush_set_tty_state) (struct serial *, serial_ttystate,
|
int (*noflush_set_tty_state) (struct serial *, serial_ttystate,
|
serial_ttystate);
|
serial_ttystate);
|
int (*setbaudrate) (struct serial *, int rate);
|
int (*setbaudrate) (struct serial *, int rate);
|
int (*setstopbits) (struct serial *, int num);
|
int (*setstopbits) (struct serial *, int num);
|
/* Wait for output to drain */
|
/* Wait for output to drain */
|
int (*drain_output) (struct serial *);
|
int (*drain_output) (struct serial *);
|
/* Change the serial device into/out of asynchronous mode, call
|
/* Change the serial device into/out of asynchronous mode, call
|
the specified function when ever there is something
|
the specified function when ever there is something
|
interesting. */
|
interesting. */
|
void (*async) (struct serial *scb, int async_p);
|
void (*async) (struct serial *scb, int async_p);
|
/* Perform a low-level read operation, reading (at most) COUNT
|
/* Perform a low-level read operation, reading (at most) COUNT
|
bytes into SCB->BUF. Return zero at end of file. */
|
bytes into SCB->BUF. Return zero at end of file. */
|
int (*read_prim)(struct serial *scb, size_t count);
|
int (*read_prim)(struct serial *scb, size_t count);
|
/* Perform a low-level write operation, writing (at most) COUNT
|
/* Perform a low-level write operation, writing (at most) COUNT
|
bytes from BUF. */
|
bytes from BUF. */
|
int (*write_prim)(struct serial *scb, const void *buf, size_t count);
|
int (*write_prim)(struct serial *scb, const void *buf, size_t count);
|
/* Return that number of bytes that can be read from FD
|
/* Return that number of bytes that can be read from FD
|
without blocking. Return value of -1 means that the
|
without blocking. Return value of -1 means that the
|
the read will not block even if less that requested bytes
|
the read will not block even if less that requested bytes
|
are available. */
|
are available. */
|
int (*avail)(struct serial *scb, int fd);
|
int (*avail)(struct serial *scb, int fd);
|
|
|
#ifdef USE_WIN32API
|
#ifdef USE_WIN32API
|
/* Return a handle to wait on, indicating available data from SCB
|
/* Return a handle to wait on, indicating available data from SCB
|
when signaled, in *READ. Return a handle indicating errors
|
when signaled, in *READ. Return a handle indicating errors
|
in *EXCEPT. */
|
in *EXCEPT. */
|
void (*wait_handle) (struct serial *scb, HANDLE *read, HANDLE *except);
|
void (*wait_handle) (struct serial *scb, HANDLE *read, HANDLE *except);
|
void (*done_wait_handle) (struct serial *scb);
|
void (*done_wait_handle) (struct serial *scb);
|
#endif /* USE_WIN32API */
|
#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 (struct serial_ops * optable);
|
extern void serial_add_interface (struct serial_ops * optable);
|
|
|
/* File in which to record the remote debugging session */
|
/* File in which to record the remote debugging session */
|
|
|
extern void serial_log_command (const char *);
|
extern void serial_log_command (const char *);
|
|
|
#ifdef USE_WIN32API
|
#ifdef USE_WIN32API
|
|
|
/* Windows-only: find or create handles that we can wait on for this
|
/* Windows-only: find or create handles that we can wait on for this
|
serial device. */
|
serial device. */
|
extern void serial_wait_handle (struct serial *, HANDLE *, HANDLE *);
|
extern void serial_wait_handle (struct serial *, HANDLE *, HANDLE *);
|
|
|
/* Windows-only: signal that we are done with the wait handles. */
|
/* Windows-only: signal that we are done with the wait handles. */
|
extern void serial_done_wait_handle (struct serial *);
|
extern void serial_done_wait_handle (struct serial *);
|
|
|
#endif /* USE_WIN32API */
|
#endif /* USE_WIN32API */
|
|
|
#endif /* SERIAL_H */
|
#endif /* SERIAL_H */
|
|
|
