binutils-gdb/gdb/serial.h

239 lines
8.4 KiB
C
Raw Normal View History

/* Remote serial support interface definitions for GDB, the GNU Debugger.
2001-03-06 09:22:02 +01:00
Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000
Free Software Foundation, Inc.
1999-07-07 22:19:36 +02:00
This file is part of GDB.
1999-07-07 22:19:36 +02:00
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.
1999-07-07 22:19:36 +02:00
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.
1999-07-07 22:19:36 +02:00
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
1999-09-22 05:28:34 +02:00
/* For most routines, if a failure is indicated, then errno should be
examined. */
1999-09-22 05:28:34 +02:00
/* Terminal state pointer. This is specific to each type of
interface. */
1999-09-22 05:28:34 +02:00
typedef void *serial_ttystate;
2001-07-09 16:38:49 +02:00
struct serial;
2001-07-11 19:52:32 +02:00
/* Try to open NAME. Returns a new `struct serial *' on success, NULL
on failure. */
2001-07-11 19:52:32 +02:00
extern struct serial *serial_open (const char *name);
1999-09-22 05:28:34 +02:00
/* Open a new serial stream using a file handle. */
2001-07-11 19:52:32 +02:00
extern struct serial *serial_fdopen (const int fd);
2001-07-11 19:52:32 +02:00
/* Push out all buffers, close the device and destroy SCB. */
2001-07-11 19:52:32 +02:00
extern void serial_close (struct serial *scb);
2001-07-11 19:52:32 +02:00
/* Push out all buffers and destroy SCB without closing the device. */
2001-07-11 19:52:32 +02:00
extern void serial_un_fdopen (struct serial *scb);
1999-09-22 05:28:34 +02:00
/* Read one char from the serial device with TIMEOUT seconds to wait
1999-10-12 06:37:53 +02:00
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. */
1999-10-06 01:13:56 +02:00
enum serial_rc {
SERIAL_ERROR = -1, /* General error. */
1999-10-12 06:37:53 +02:00
SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read.
2000-10-24 00:49:29 +02:00
Unfortunately, through ui_loop_hook(), this
1999-10-12 06:37:53 +02:00
can also be a QUIT indication. */
1999-10-06 01:13:56 +02:00
SERIAL_EOF = -3 /* General end-of-file or remote target
connection closed, indication. Includes
things like the line dropping dead. */
};
1999-09-22 05:28:34 +02:00
2001-07-11 19:52:32 +02:00
extern int serial_readchar (struct serial *scb, int timeout);
1999-09-22 05:28:34 +02:00
2001-07-11 19:52:32 +02:00
/* Write LEN chars from STRING to the port SCB. Returns 0 for
1999-09-22 05:28:34 +02:00
success, non-zero for failure. */
2001-07-11 19:52:32 +02:00
extern int serial_write (struct serial *scb, const char *str, int len);
1999-09-22 05:28:34 +02:00
/* Write a printf style string onto the serial port. */
2001-07-11 19:52:32 +02:00
extern void serial_printf (struct serial *desc, const char *,...) ATTR_FORMAT (printf, 2, 3);
/* Allow pending output to drain. */
2001-07-11 19:52:32 +02:00
extern int serial_drain_output (struct serial *);
1999-07-07 22:19:36 +02:00
1999-09-22 05:28:34 +02:00
/* Flush (discard) pending output. Might also flush input (if this
system can't flush only output). */
2001-07-11 19:52:32 +02:00
extern int serial_flush_output (struct serial *);
1999-09-22 05:28:34 +02:00
/* Flush pending input. Might also flush output (if this system can't
flush only input). */
2001-07-11 19:52:32 +02:00
extern int serial_flush_input (struct serial *);
/* Send a break between 0.25 and 0.5 seconds long. */
2001-07-11 19:52:32 +02:00
extern int serial_send_break (struct serial *scb);
/* Turn the port into raw mode. */
2001-07-11 19:52:32 +02:00
extern void serial_raw (struct serial *scb);
/* Return a pointer to a newly malloc'd ttystate containing the state
of the tty. */
1999-09-22 05:28:34 +02:00
2001-07-11 19:52:32 +02:00
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.
1999-09-22 05:28:34 +02:00
Returns 0 for success, negative value for error (in which case
errno contains the error). */
2001-07-11 19:52:32 +02:00
extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate);
1999-09-22 05:28:34 +02:00
/* printf_filtered a user-comprehensible description of ttystate on
the specified STREAM. FIXME: At present this sends output to the
default stream - GDB_STDOUT. */
2001-07-11 19:52:32 +02:00
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.
1999-09-22 05:28:34 +02:00
This means that we never switch in or out of raw mode, even if
NEW_TTYSTATE specifies a switch. */
2001-07-11 19:52:32 +02:00
extern int serial_noflush_set_tty_state (struct serial *scb, serial_ttystate new_ttystate, serial_ttystate old_ttystate);
1999-09-22 05:28:34 +02:00
/* Set the baudrate to the decimal value supplied. Returns 0 for
success, -1 for failure. */
2001-07-11 19:52:32 +02:00
extern int serial_setbaudrate (struct serial *scb, int rate);
1999-09-22 05:28:34 +02:00
/* Set the number of stop bits to the value specified. Returns 0 for
success, -1 for failure. */
1999-09-22 05:28:34 +02:00
#define SERIAL_1_STOPBITS 1
#define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */
#define SERIAL_2_STOPBITS 3
2001-07-11 19:52:32 +02:00
extern int serial_setstopbits (struct serial *scb, int num);
1999-09-22 05:28:34 +02:00
/* Asynchronous serial interface: */
1999-09-22 05:28:34 +02:00
/* Can the serial device support asynchronous mode? */
2001-07-11 19:52:32 +02:00
extern int serial_can_async_p (struct serial *scb);
1999-09-22 05:28:34 +02:00
/* Has the serial device been put in asynchronous mode? */
2001-07-11 19:52:32 +02:00
extern int serial_is_async_p (struct serial *scb);
1999-09-22 05:28:34 +02:00
/* For ASYNC enabled devices, register a callback and enable
asynchronous mode. To disable asynchronous mode, register a NULL
callback. */
2001-07-11 19:52:32 +02:00
typedef void (serial_event_ftype) (struct serial *scb, void *context);
extern void serial_async (struct serial *scb, serial_event_ftype *handler, void *context);
1999-09-22 05:28:34 +02:00
/* 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. */
2001-07-11 19:52:32 +02:00
extern int deprecated_serial_fd (struct serial *scb);
1999-10-06 01:13:56 +02:00
/* Trace/debug mechanism.
serial_debug() enables/disables internal debugging.
serial_debug_p() indicates the current debug state. */
1999-10-06 01:13:56 +02:00
2001-07-11 19:52:32 +02:00
extern void serial_debug (struct serial *scb, int debug_p);
1999-10-06 01:13:56 +02:00
2001-07-11 19:52:32 +02:00
extern int serial_debug_p (struct serial *scb);
1999-10-06 01:13:56 +02:00
1999-09-22 05:28:34 +02:00
/* Details of an instance of a serial object */
2001-07-09 16:38:49 +02:00
struct serial
1999-09-22 05:28:34 +02:00
{
int fd; /* File descriptor */
struct serial_ops *ops; /* Function vector */
void *state; /* Local context info for open FD */
serial_ttystate ttystate; /* Not used (yet) */
1999-10-06 01:13:56 +02:00
int bufcnt; /* Amount of data remaining in receive
buffer. -ve for sticky errors. */
1999-09-22 05:28:34 +02:00
unsigned char *bufp; /* Current byte */
unsigned char buf[BUFSIZ]; /* Da buffer itself */
1999-10-06 01:13:56 +02:00
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. */
1999-09-22 05:28:34 +02:00
char *name; /* The name of the device or host */
2001-07-11 19:52:32 +02:00
struct serial *next; /* Pointer to the next `struct serial *' */
1999-09-22 05:28:34 +02:00
int refcnt; /* Number of pointers to this block */
1999-10-06 01:13:56 +02:00
int debug_p; /* Trace this serial devices operation. */
int async_state; /* Async internal state. */
1999-09-22 05:28:34 +02:00
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;
2001-07-11 19:52:32 +02:00
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);
1999-09-22 05:28:34 +02:00
/* Discard pending output */
2001-07-11 19:52:32 +02:00
int (*flush_output) (struct serial *);
1999-09-22 05:28:34 +02:00
/* Discard pending input */
2001-07-11 19:52:32 +02:00
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);
1999-09-22 05:28:34 +02:00
/* Wait for output to drain */
2001-07-11 19:52:32 +02:00
int (*drain_output) (struct serial *);
1999-09-22 05:28:34 +02:00
/* Change the serial device into/out of asynchronous mode, call
the specified function when ever there is something
interesting. */
2001-07-11 19:52:32 +02:00
void (*async) (struct serial *scb, int async_p);
1999-09-22 05:28:34 +02:00
};
/* Add a new serial interface to the interface list */
1999-09-22 05:28:34 +02:00
extern void serial_add_interface (struct serial_ops * optable);
/* File in which to record the remote debugging session */
1999-09-22 05:28:34 +02:00
extern void serial_log_command (const char *);
#endif /* SERIAL_H */