197e01b6dc
* arm-tdep.c: * ia64-tdep.c: * i386-tdep.c: * hpread.c: * hppa-tdep.c: * hppa-hpux-tdep.c: * gnu-nat.c: * gdbtypes.c: * gdbarch.h: * gdbarch.c: * eval.c: * dwarf2read.c: * dbxread.c: * copying: * symfile.c: * stabsread.c: * sh64-tdep.c: * sh-tdep.c: * s390-tdep.c: * rs6000-tdep.c: * remote.c: * remote-mips.c: * mips-tdep.c: * mdebugread.c: * linux-nat.c: * infrun.c: * xcoffread.c: * win32-nat.c: * valops.c: * utils.c: * tracepoint.c: * target.c: * symtab.c: * c-exp.y: * ada-valprint.c: * ada-typeprint.c: * ada-lex.l: * ada-lang.h: * ada-lang.c: * ada-exp.y: * alphafbsd-tdep.c: * alphabsd-tdep.h: * alphabsd-tdep.c: * alphabsd-nat.c: * alpha-tdep.h: * alpha-tdep.c: * alpha-osf1-tdep.c: * alpha-nat.c: * alpha-mdebug-tdep.c: * alpha-linux-tdep.c: * alpha-linux-nat.c: * aix-thread.c: * abug-rom.c: * arch-utils.c: * annotate.h: * annotate.c: * amd64obsd-tdep.c: * amd64obsd-nat.c: * amd64nbsd-tdep.c: * amd64nbsd-nat.c: * amd64fbsd-tdep.c: * amd64fbsd-nat.c: * amd64bsd-nat.c: * amd64-tdep.h: * amd64-tdep.c: * amd64-sol2-tdep.c: * amd64-nat.h: * amd64-nat.c: * amd64-linux-tdep.c: * amd64-linux-nat.c: * alphanbsd-tdep.c: * block.h: * block.c: * bfd-target.h: * bfd-target.c: * bcache.h: * bcache.c: * ax.h: * ax-general.c: * ax-gdb.h: * ax-gdb.c: * avr-tdep.c: * auxv.h: * auxv.c: * armnbsd-tdep.c: * armnbsd-nat.c: * arm-tdep.h: * arm-linux-nat.c: * arch-utils.h: * charset.c: * call-cmds.h: * c-valprint.c: * c-typeprint.c: * c-lang.h: * c-lang.c: * buildsym.h: * buildsym.c: * bsd-uthread.h: * bsd-uthread.c: * bsd-kvm.h: * bsd-kvm.c: * breakpoint.h: * core-regset.c: * core-aout.c: * completer.h: * completer.c: * complaints.h: * complaints.c: * command.h: * coffread.c: * coff-solib.h: * coff-solib.c: * coff-pe-read.h: * coff-pe-read.c: * cli-out.h: * cli-out.c: * charset.h: * dink32-rom.c: * dictionary.h: * dictionary.c: * demangle.c: * defs.h: * dcache.h: * dcache.c: * d10v-tdep.c: * cpu32bug-rom.c: * cp-valprint.c: * cp-support.h: * cp-support.c: * cp-namespace.c: * cp-abi.h: * cp-abi.c: * corelow.c: * corefile.c: * environ.c: * elfread.c: * dwarfread.c: * dwarf2loc.c: * dwarf2expr.h: * dwarf2expr.c: * dwarf2-frame.h: * dwarf2-frame.c: * dve3900-rom.c: * dummy-frame.h: * dummy-frame.c: * dsrec.c: * doublest.h: * doublest.c: * disasm.h: * disasm.c: * fork-child.c: * findvar.c: * fbsd-nat.h: * fbsd-nat.c: * f-valprint.c: * f-typeprint.c: * f-lang.h: * f-lang.c: * expression.h: * expprint.c: * exec.h: * exec.c: * exceptions.h: * exceptions.c: * event-top.h: * event-top.c: * event-loop.h: * event-loop.c: * gdb.c: * gdb-stabs.h: * gdb-events.h: * gdb-events.c: * gcore.c: * frv-tdep.h: * frv-tdep.c: * frv-linux-tdep.c: * frame.h: * frame.c: * frame-unwind.h: * frame-unwind.c: * frame-base.h: * frame-base.c: * gdb_vfork.h: * gdb_thread_db.h: * gdb_string.h: * gdb_stat.h: * gdb_regex.h: * gdb_ptrace.h: * gdb_proc_service.h: * gdb_obstack.h: * gdb_locale.h: * gdb_dirent.h: * gdb_curses.h: * gdb_assert.h: * gdbarch.sh: * gdb.h: * hpux-thread.c: * hppabsd-nat.c: * hppa-tdep.h: * hpacc-abi.c: * h8300-tdep.c: * gregset.h: * go32-nat.c: * gnu-v3-abi.c: * gnu-v2-abi.h: * gnu-v2-abi.c: * gnu-nat.h: * glibc-tdep.c: * gdbtypes.h: * gdbcore.h: * gdbcmd.h: * i386nbsd-tdep.c: * i386nbsd-nat.c: * i386gnu-tdep.c: * i386gnu-nat.c: * i386fbsd-tdep.c: * i386fbsd-nat.c: * i386bsd-tdep.c: * i386bsd-nat.h: * i386bsd-nat.c: * i386-tdep.h: * i386-sol2-nat.c: * i386-nto-tdep.c: * i386-nat.c: * i386-linux-tdep.h: * i386-linux-tdep.c: * i386-linux-nat.c: * i386-cygwin-tdep.c: * inf-ttrace.c: * inf-ptrace.h: * inf-ptrace.c: * inf-loop.h: * inf-loop.c: * inf-child.h: * inf-child.c: * ia64-tdep.h: * ia64-linux-nat.c: * i387-tdep.h: * i387-tdep.c: * i386v4-nat.c: * i386v-nat.c: * i386obsd-tdep.c: * i386obsd-nat.c: * kod.c: * jv-valprint.c: * jv-typeprint.c: * jv-lang.h: * jv-lang.c: * irix5-nat.c: * iq2000-tdep.c: * interps.h: * interps.c: * inftarg.c: * inflow.h: * inflow.c: * inferior.h: * infcmd.c: * infcall.h: * infcall.c: * inf-ttrace.h: * m32r-tdep.h: * m32r-tdep.c: * m32r-rom.c: * m32r-linux-tdep.c: * m32r-linux-nat.c: * m2-valprint.c: * m2-typeprint.c: * m2-lang.h: * m2-lang.c: * lynx-nat.c: * linux-thread-db.c: * linux-nat.h: * linespec.c: * libunwind-frame.h: * libunwind-frame.c: * language.h: * language.c: * macroexp.c: * macrocmd.c: * m88kbsd-nat.c: * m88k-tdep.h: * m88k-tdep.c: * m68klinux-tdep.c: * m68klinux-nat.c: * m68kbsd-tdep.c: * m68kbsd-nat.c: * m68k-tdep.h: * m68k-tdep.c: * mips-linux-nat.c: * mips-irix-tdep.c: * minsyms.c: * memattr.h: * memattr.c: * mem-break.c: * mdebugread.h: * main.h: * main.c: * macrotab.h: * macrotab.c: * macroscope.h: * macroscope.c: * macroexp.h: * nbsd-tdep.c: * mt-tdep.c: * monitor.h: * monitor.c: * mn10300-tdep.h: * mn10300-tdep.c: * mn10300-linux-tdep.c: * mipsv4-nat.c: * mipsread.c: * mipsnbsd-tdep.h: * mipsnbsd-tdep.c: * mipsnbsd-nat.c: * mips64obsd-tdep.c: * mips64obsd-nat.c: * mips-tdep.h: * mips-mdebug-tdep.c: * mips-linux-tdep.c: * osabi.h: * osabi.c: * ocd.h: * ocd.c: * observer.c: * objfiles.h: * objfiles.c: * objc-lang.h: * objc-lang.c: * objc-exp.y: * nto-tdep.h: * nto-tdep.c: * nto-procfs.c: * nlmread.c: * nbsd-tdep.h: * ppcobsd-tdep.c: * ppcobsd-nat.c: * ppcnbsd-tdep.h: * ppcnbsd-tdep.c: * ppcnbsd-nat.c: * ppcbug-rom.c: * ppc-tdep.h: * ppc-sysv-tdep.c: * ppc-linux-tdep.c: * ppc-linux-nat.c: * ppc-bdm.c: * parser-defs.h: * parse.c: * p-valprint.c: * p-typeprint.c: * p-lang.h: * p-lang.c: * remote-fileio.h: * remote-fileio.c: * remote-est.c: * remote-e7000.c: * regset.h: * regset.c: * reggroups.h: * reggroups.c: * regcache.h: * regcache.c: * proc-why.c: * proc-service.c: * proc-events.c: * printcmd.c: * ppcobsd-tdep.h: * sentinel-frame.h: * sentinel-frame.c: * scm-valprint.c: * scm-tags.h: * scm-lang.h: * scm-lang.c: * scm-exp.c: * s390-tdep.h: * rom68k-rom.c: * remote.h: * remote-utils.c: * remote-st.c: * remote-sim.c: * remote-sds.c: * remote-rdp.c: * remote-rdi.c: * remote-hms.c: * sim-regno.h: * shnbsd-tdep.h: * shnbsd-tdep.c: * shnbsd-nat.c: * sh-tdep.h: * serial.h: * serial.c: * ser-unix.h: * ser-unix.c: * ser-tcp.c: * ser-pipe.c: * ser-go32.c: * ser-e7kpc.c: * ser-base.h: * ser-base.c: * solib.c: * solib-svr4.h: * solib-svr4.c: * solib-sunos.c: * solib-som.h: * solib-som.c: * solib-pa64.h: * solib-pa64.c: * solib-osf.c: * solib-null.c: * solib-legacy.c: * solib-irix.c: * solib-frv.c: * solib-aix5.c: * sol-thread.c: * sparc64-linux-tdep.c: * sparc64-linux-nat.c: * sparc-tdep.h: * sparc-tdep.c: * sparc-sol2-tdep.c: * sparc-sol2-nat.c: * sparc-nat.h: * sparc-nat.c: * sparc-linux-tdep.c: * sparc-linux-nat.c: * source.h: * source.c: * somread.c: * solist.h: * solib.h: * std-regs.c: * stack.h: * stack.c: * stabsread.h: * sparcobsd-tdep.c: * sparcnbsd-tdep.c: * sparcnbsd-nat.c: * sparc64obsd-tdep.c: * sparc64nbsd-tdep.c: * sparc64nbsd-nat.c: * sparc64fbsd-tdep.c: * sparc64fbsd-nat.c: * sparc64-tdep.h: * sparc64-tdep.c: * sparc64-sol2-tdep.c: * sparc64-nat.c: * ui-file.c: * typeprint.h: * typeprint.c: * tramp-frame.h: * tramp-frame.c: * trad-frame.h: * trad-frame.c: * tracepoint.h: * top.c: * tobs.inc: * thread.c: * terminal.h: * target.h: * symfile.h: * stop-gdb.c: * vaxbsd-nat.c: * vax-tdep.h: * vax-tdep.c: * vax-nat.c: * varobj.h: * varobj.c: * value.h: * value.c: * valprint.h: * valprint.c: * v850-tdep.c: * uw-thread.c: * user-regs.c: * ui-out.h: * ui-out.c: * ui-file.h: * xcoffsolib.h: * xcoffsolib.c: * wrapper.c: * wince.c: * wince-stub.h: * wince-stub.c: * vaxobsd-tdep.c: * vaxnbsd-tdep.c: * gdb_gcore.sh: * copying.c: * configure.ac: * aclocal.m4: * acinclude.m4: * reply_mig_hack.awk: * observer.sh: * gdb_mbuild.sh: * arm-linux-tdep.c: * blockframe.c: * dbug-rom.c: * environ.h: * dwarf2loc.h: * gdb-events.sh: * glibc-tdep.h: * gdb_wait.h: * gdbthread.h: * i386-sol2-tdep.c: * hppabsd-tdep.c: * hppa-linux-nat.c: * hppa-hpux-nat.c: * ia64-linux-tdep.c: * infptrace.c: * linespec.h: * maint.c: * mips-mdebug-tdep.h: * remote-m32r-sdi.c: * s390-nat.c: * rs6000-nat.c: * remote-utils.h: * sh3-rom.c: * sh-linux-tdep.c: * top.h: * symtab.h: * symmisc.c: * symfile-mem.c: * srec.h: * user-regs.h: * version.h: * valarith.c: * xstormy16-tdep.c: * wrapper.h: * Makefile.in: * f-exp.y: * cris-tdep.c: * cp-name-parser.y: * procfs.c: * proc-utils.h: * proc-flags.c: * proc-api.c: * p-exp.y: * m68hc11-tdep.c: * m2-exp.y: * kod.h: * kod-cisco.c: * jv-exp.y: * hppa-linux-tdep.c: Add (c) after Copyright. Update the FSF address.
252 lines
9.0 KiB
C
252 lines
9.0 KiB
C
/* Remote serial support interface definitions for GDB, the GNU Debugger.
|
|
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000
|
|
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
|
|
(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.
|
|
|
|
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., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA. */
|
|
|
|
#ifndef SERIAL_H
|
|
#define SERIAL_H
|
|
|
|
struct ui_file;
|
|
|
|
/* For most routines, if a failure is indicated, then errno should be
|
|
examined. */
|
|
|
|
/* Terminal state pointer. This is specific to each type of
|
|
interface. */
|
|
|
|
typedef void *serial_ttystate;
|
|
struct serial;
|
|
|
|
/* 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. */
|
|
|
|
extern struct serial *serial_open (const char *name);
|
|
|
|
/* 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. */
|
|
|
|
extern void serial_close (struct serial *scb);
|
|
|
|
/* 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
|
|
deprecated_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. */
|
|
|
|
extern void serial_printf (struct serial *desc,
|
|
const char *,...) ATTR_FORMAT (printf, 2, 3);
|
|
|
|
/* Allow pending output to drain. */
|
|
|
|
extern int serial_drain_output (struct serial *);
|
|
|
|
/* Flush (discard) pending output. Might also flush input (if this
|
|
system can't flush only output). */
|
|
|
|
extern int serial_flush_output (struct serial *);
|
|
|
|
/* Flush pending input. Might also flush output (if this system can't
|
|
flush only input). */
|
|
|
|
extern int serial_flush_input (struct serial *);
|
|
|
|
/* Send a break between 0.25 and 0.5 seconds long. */
|
|
|
|
extern int serial_send_break (struct serial *scb);
|
|
|
|
/* Turn the port into raw mode. */
|
|
|
|
extern void serial_raw (struct serial *scb);
|
|
|
|
/* Return a pointer to a newly malloc'd ttystate containing the state
|
|
of the tty. */
|
|
|
|
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). */
|
|
|
|
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
|
|
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);
|
|
|
|
/* Set the baudrate to the decimal value supplied. Returns 0 for
|
|
success, -1 for failure. */
|
|
|
|
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. */
|
|
|
|
#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_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);
|
|
/* Perform a low-level read operation, reading (at most) COUNT
|
|
bytes into SCB->BUF. */
|
|
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);
|
|
};
|
|
|
|
/* Add a new serial interface to the interface list */
|
|
|
|
extern void serial_add_interface (struct serial_ops * optable);
|
|
|
|
/* File in which to record the remote debugging session */
|
|
|
|
extern void serial_log_command (const char *);
|
|
|
|
#endif /* SERIAL_H */
|