1999-04-16 03:35:26 +02:00
|
|
|
/* Remote serial support interface definitions for GDB, the GNU Debugger.
|
2016-01-01 05:33:14 +01:00
|
|
|
Copyright (C) 1992-2016 Free Software Foundation, Inc.
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-07-07 22:19:36 +02:00
|
|
|
This file is part of GDB.
|
1999-04-16 03:35:26 +02:00
|
|
|
|
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
|
2007-08-23 20:08:50 +02:00
|
|
|
the Free Software Foundation; either version 3 of the License, or
|
1999-07-07 22:19:36 +02:00
|
|
|
(at your option) any later version.
|
1999-04-16 03:35:26 +02:00
|
|
|
|
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-04-16 03:35:26 +02:00
|
|
|
|
1999-07-07 22:19:36 +02:00
|
|
|
You should have received a copy of the GNU General Public License
|
2007-08-23 20:08:50 +02:00
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
#ifndef SERIAL_H
|
|
|
|
#define SERIAL_H
|
|
|
|
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
#ifdef USE_WIN32API
|
2010-03-30 20:08:04 +02:00
|
|
|
#include <winsock2.h>
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
#include <windows.h>
|
|
|
|
#endif
|
|
|
|
|
2003-04-12 Andrew Cagney <cagney@redhat.com>
* gdbarch.sh: Add missing opaque declarations.
* gdbarch.h: Regnerate.
* symtab.h: Add missing opaque declarations.
* value.h, target.h, symfile.h, stabsread.h: Ditto.
* x86-64-tdep.h, xmodem.h, monitor.h, typeprint.h: Ditto.
* srec.h, solib-svr4.h, source.h, inferior.h: Ditto.
* ser-unix.h, serial.h, remote-utils.h, gdbcore.h: Ditto.
* ppc-tdep.h, ocd.h, mips-tdep.h, gdbtypes.h: Ditto.
* buildsym.h, builtin-regs.h, linespec.h, language.h: Ditto.
* i387-tdep.h, gdbthread.h, event-top.h, gdb.h: Ditto.
* dwarf2cfi.h, doublest.h, disasm.h, cp-abi.h: Ditto.
* cli-out.h, c-lang.h, ax-gdb.h, arch-utils.h: Ditto.
* ada-lang.h, config/nm-lynx.h, config/nm-linux.h: Ditto.
* config/sparc/tm-sp64.h, config/rs6000/tm-rs6000.h: Ditto.
* config/pa/tm-hppah.h, config/m68k/tm-delta68.h: Ditto.
* cli/cli-setshow.h, cli/cli-script.h: Ditto.
2003-04-12 19:41:26 +02:00
|
|
|
struct ui_file;
|
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* For most routines, if a failure is indicated, then errno should be
|
|
|
|
examined. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* Terminal state pointer. This is specific to each type of
|
2005-01-14 02:59:20 +01:00
|
|
|
interface. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
typedef void *serial_ttystate;
|
2001-07-09 16:38:49 +02:00
|
|
|
struct serial;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
/* Try to open NAME. Returns a new `struct serial *' on success, NULL
|
2012-06-11 22:36:53 +02:00
|
|
|
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. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern struct serial *serial_open (const char *name);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2012-06-11 22:36:53 +02:00
|
|
|
/* Returns true if SCB is open. */
|
|
|
|
|
|
|
|
extern int serial_is_open (struct serial *scb);
|
|
|
|
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
/* Find an already opened serial stream using a file handle. */
|
|
|
|
|
|
|
|
extern struct serial *serial_for_fd (int fd);
|
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* Open a new serial stream using a file handle. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern struct serial *serial_fdopen (const int fd);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2012-06-11 22:36:53 +02:00
|
|
|
/* Push out all buffers, close the device and unref SCB. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern void serial_close (struct serial *scb);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2012-06-11 22:36:53 +02:00
|
|
|
/* Increment reference count of SCB. */
|
|
|
|
|
|
|
|
extern void serial_ref (struct serial *scb);
|
|
|
|
|
|
|
|
/* Decrement reference count of SCB. */
|
|
|
|
|
|
|
|
extern void serial_unref (struct serial *scb);
|
|
|
|
|
2010-08-20 20:49:20 +02:00
|
|
|
/* Create a pipe, and put the read end in files[0], and the write end
|
|
|
|
in filde[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]);
|
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
/* Push out all buffers and destroy SCB without closing the device. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern void serial_un_fdopen (struct serial *scb);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
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.
|
2011-01-11 22:53:25 +01:00
|
|
|
Infinite waits are not permitted. Returns unsigned char if ok, else
|
1999-10-12 06:37:53 +02:00
|
|
|
one of the following codes. Note that all error return-codes are
|
2005-01-14 02:59:20 +01:00
|
|
|
guaranteed to be < 0. */
|
1999-10-06 01:13:56 +02:00
|
|
|
|
|
|
|
enum serial_rc {
|
2005-01-14 02:59:20 +01:00
|
|
|
SERIAL_ERROR = -1, /* General error. */
|
1999-10-12 06:37:53 +02:00
|
|
|
SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read.
|
2004-06-25 21:46:08 +02:00
|
|
|
Unfortunately, through
|
2005-01-14 02:59:20 +01:00
|
|
|
deprecated_ui_loop_hook (), this 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
|
2005-01-14 02:59:20 +01:00
|
|
|
things like the line dropping dead. */
|
1999-10-06 01:13:56 +02:00
|
|
|
};
|
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
|
|
|
|
serial_write: change prototype to take a void-pointer buffer.
While remote.c works with "char *" buffers most of the time, other
remote targets have binary-ish-er protocols, and choose to use
"unsigned char" throughout, like e.g., remote-mips.c or
remote-m32r-sdi.c. That results in -Wpointer-sign warnings in those
targets, unless we add casts in calls to serial_write. Since
serial_write is only concerned about sending raw host bytes out, and
serial_ops->write_prim already works with "void *"/"size_t", a similar
interface to the "write" or "send" system calls, I find it natural to
change serial_write's prototype accordingly, avoiding the need for
casts.
Tested on x86_64 Fedora 17, and also by building x86_64-mingw32
and DJGPP/go32 -hosted gdbs.
gdb/
2013-04-19 Pedro Alves <palves@redhat.com>
* ser-base.c (ser_base_write): Change prototype -- take 'void *'
buffer and size_t size. Adjust.
* ser-base.h (ser_base_write): Adjust.
* ser-go32.c (cnts): Change type to size_t.
(dos_write): Change prototype -- take 'void *'
buffer and size_t size. Adjust.
(dos_info): Print elements of 'cnts' as unsigned long.
* serial.c (serial_write): Likewise.
* serial.h (serial_write): Adjust.
(struct serial_ops) <write>: Change prototype -- take 'void *'
buffer and size_t size. Adjust.
2013-04-19 17:26:17 +02:00
|
|
|
/* Write COUNT bytes from BUF to the port SCB. Returns 0 for
|
1999-09-22 05:28:34 +02:00
|
|
|
success, non-zero for failure. */
|
|
|
|
|
serial_write: change prototype to take a void-pointer buffer.
While remote.c works with "char *" buffers most of the time, other
remote targets have binary-ish-er protocols, and choose to use
"unsigned char" throughout, like e.g., remote-mips.c or
remote-m32r-sdi.c. That results in -Wpointer-sign warnings in those
targets, unless we add casts in calls to serial_write. Since
serial_write is only concerned about sending raw host bytes out, and
serial_ops->write_prim already works with "void *"/"size_t", a similar
interface to the "write" or "send" system calls, I find it natural to
change serial_write's prototype accordingly, avoiding the need for
casts.
Tested on x86_64 Fedora 17, and also by building x86_64-mingw32
and DJGPP/go32 -hosted gdbs.
gdb/
2013-04-19 Pedro Alves <palves@redhat.com>
* ser-base.c (ser_base_write): Change prototype -- take 'void *'
buffer and size_t size. Adjust.
* ser-base.h (ser_base_write): Adjust.
* ser-go32.c (cnts): Change type to size_t.
(dos_write): Change prototype -- take 'void *'
buffer and size_t size. Adjust.
(dos_info): Print elements of 'cnts' as unsigned long.
* serial.c (serial_write): Likewise.
* serial.h (serial_write): Adjust.
(struct serial_ops) <write>: Change prototype -- take 'void *'
buffer and size_t size. Adjust.
2013-04-19 17:26:17 +02:00
|
|
|
extern int serial_write (struct serial *scb, const void *buf, size_t count);
|
1999-09-22 05:28:34 +02:00
|
|
|
|
2005-01-14 02:59:20 +01:00
|
|
|
/* Write a printf style string onto the serial port. */
|
1999-09-22 05:28:34 +02:00
|
|
|
|
2005-01-14 02:59:20 +01:00
|
|
|
extern void serial_printf (struct serial *desc,
|
gdb/
* ada-lang.c (lim_warning): Change ATTR_FORMAT to ATTRIBUTE_PRINTF.
* amd64-tdep.c (amd64_insn_length_fprintf): Likewise.
* cli-out.c (cli_field_fmt): New ATTRIBUTE_PRINTF.
(cli_message, out_field_fmt): Change ATTR_FORMAT to ATTRIBUTE_PRINTF.
* complaints.c (find_complaint): New ATTRIBUTE_PRINTF.
(vcomplaint): Change ATTR_FORMAT to ATTRIBUTE_PRINTF.
* complaints.h (complaint, internal_complaint): Likewise.
* defs.h: Change ATTR_FORMAT to ATTRIBUTE_PRINTF in the top comment.
(ATTR_FORMAT): Remove.
(query, nquery, yquery, vprintf_filtered, vfprintf_filtered)
(fprintf_filtered, fprintfi_filtered, printf_filtered, printfi_filtered)
(vprintf_unfiltered, vfprintf_unfiltered, fprintf_unfiltered)
(printf_unfiltered, xasprintf, xvasprintf, xstrprintf, xstrvprintf)
(xsnprintf, verror, error, vfatal, fatal, internal_verror)
(internal_error, internal_vwarning, internal_warning, warning)
(vwarning): Change ATTR_FORMAT to ATTRIBUTE_PRINTF.
* disasm.c (fprintf_disasm): Likewise.
* exceptions.c (throw_it): Likewise.
* exceptions.h (exception_fprintf, throw_verror, throw_vfatal)
(throw_error): Likewise.
* language.h (type_error, range_error): Likewise.
* linespec.c (cplusplus_error): Likewise.
* mi/mi-interp.c (mi_interp_query_hook): Likewise.
* mi/mi-out.c (mi_field_fmt, mi_message): Likewise.
* monitor.c (monitor_debug): Likewise.
* parser-defs.h (parser_fprintf): Likewise.
* serial.h (serial_printf): Likewise.
* tui/tui-hooks.c (tui_query_hook): Likewise.
* ui-out.c (default_field_fmt, default_message, uo_field_fmt)
(uo_message): Likewise.
* ui-out.h (ui_out_field_fmt, ui_out_message): Likewise.
* utils.c (vfprintf_maybe_filtered, internal_vproblem, defaulted_query):
Likewise.
* xml-support.h (gdb_xml_debug, gdb_xml_error): Likewise.
2010-05-02 23:14:59 +02:00
|
|
|
const char *,...) ATTRIBUTE_PRINTF (2, 3);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2005-01-14 02:59:20 +01:00
|
|
|
/* Allow pending output to drain. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
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). */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern int serial_flush_output (struct serial *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* Flush pending input. Might also flush output (if this system can't
|
|
|
|
flush only input). */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern int serial_flush_input (struct serial *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* 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);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2005-01-14 02:59:20 +01:00
|
|
|
/* Turn the port into raw mode. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern void serial_raw (struct serial *scb);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* 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);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2011-03-04 20:23:42 +01:00
|
|
|
/* 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);
|
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
/* 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-04-16 03:35:26 +02:00
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* printf_filtered a user-comprehensible description of ttystate on
|
2011-01-11 22:53:25 +01:00
|
|
|
the specified STREAM. FIXME: At present this sends output to the
|
2005-01-14 02:59:20 +01:00
|
|
|
default stream - GDB_STDOUT. */
|
1999-09-22 05:28:34 +02:00
|
|
|
|
2011-01-05 23:22:53 +01:00
|
|
|
extern void serial_print_tty_state (struct serial *scb,
|
|
|
|
serial_ttystate ttystate,
|
|
|
|
struct ui_file *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
|
|
|
|
current state (generally obtained from a recent call to
|
2001-07-15 22:34:14 +02:00
|
|
|
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. */
|
|
|
|
|
2011-01-05 23:22:53 +01:00
|
|
|
extern int serial_noflush_set_tty_state (struct serial *scb,
|
|
|
|
serial_ttystate new_ttystate,
|
|
|
|
serial_ttystate old_ttystate);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* Set the baudrate to the decimal value supplied. Returns 0 for
|
|
|
|
success, -1 for failure. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern int serial_setbaudrate (struct serial *scb, int rate);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
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-04-16 03:35:26 +02:00
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
#define SERIAL_1_STOPBITS 1
|
2005-01-14 02:59:20 +01:00
|
|
|
#define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */
|
1999-09-22 05:28:34 +02:00
|
|
|
#define SERIAL_2_STOPBITS 3
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern int serial_setstopbits (struct serial *scb, int num);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2015-03-23 22:15:42 +01:00
|
|
|
#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);
|
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* Asynchronous serial interface: */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2011-01-11 22:53:25 +01:00
|
|
|
/* Can the serial device support asynchronous mode? */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern int serial_can_async_p (struct serial *scb);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2011-01-11 22:53:25 +01:00
|
|
|
/* Has the serial device been put in asynchronous mode? */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
extern int serial_is_async_p (struct serial *scb);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
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
|
2005-01-14 02:59:20 +01:00
|
|
|
callback. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-11 19:52:32 +02:00
|
|
|
typedef void (serial_event_ftype) (struct serial *scb, void *context);
|
2011-01-05 23:22:53 +01:00
|
|
|
extern void serial_async (struct serial *scb,
|
|
|
|
serial_event_ftype *handler, void *context);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-10-06 01:13:56 +02:00
|
|
|
/* Trace/debug mechanism.
|
|
|
|
|
2001-07-15 22:34:14 +02:00
|
|
|
serial_debug() enables/disables internal debugging.
|
2005-01-14 02:59:20 +01:00
|
|
|
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-04-16 03:35:26 +02:00
|
|
|
|
2011-01-11 22:53:25 +01:00
|
|
|
/* Details of an instance of a serial object. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-07-09 16:38:49 +02:00
|
|
|
struct serial
|
1999-09-22 05:28:34 +02:00
|
|
|
{
|
2012-06-11 22:36:53 +02:00
|
|
|
/* serial objects are ref counted (but not the underlying
|
|
|
|
connection, just the object's lifetime in memory). */
|
|
|
|
int refcnt;
|
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
int fd; /* File descriptor */
|
2007-04-08 17:20:07 +02:00
|
|
|
/* 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;
|
2013-12-06 18:58:50 +01:00
|
|
|
const struct serial_ops *ops; /* Function vector */
|
1999-09-22 05:28:34 +02:00
|
|
|
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
|
2005-01-14 02:59:20 +01:00
|
|
|
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. */
|
2012-06-13 13:06:52 +02:00
|
|
|
struct serial *next; /* Pointer to the next `struct serial *' */
|
2005-01-14 02:59:20 +01: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;
|
2001-07-11 19:52:32 +02:00
|
|
|
int (*open) (struct serial *, const char *name);
|
|
|
|
void (*close) (struct serial *);
|
2010-08-20 20:49:20 +02:00
|
|
|
int (*fdopen) (struct serial *, int fd);
|
2001-07-11 19:52:32 +02:00
|
|
|
int (*readchar) (struct serial *, int timeout);
|
serial_write: change prototype to take a void-pointer buffer.
While remote.c works with "char *" buffers most of the time, other
remote targets have binary-ish-er protocols, and choose to use
"unsigned char" throughout, like e.g., remote-mips.c or
remote-m32r-sdi.c. That results in -Wpointer-sign warnings in those
targets, unless we add casts in calls to serial_write. Since
serial_write is only concerned about sending raw host bytes out, and
serial_ops->write_prim already works with "void *"/"size_t", a similar
interface to the "write" or "send" system calls, I find it natural to
change serial_write's prototype accordingly, avoiding the need for
casts.
Tested on x86_64 Fedora 17, and also by building x86_64-mingw32
and DJGPP/go32 -hosted gdbs.
gdb/
2013-04-19 Pedro Alves <palves@redhat.com>
* ser-base.c (ser_base_write): Change prototype -- take 'void *'
buffer and size_t size. Adjust.
* ser-base.h (ser_base_write): Adjust.
* ser-go32.c (cnts): Change type to size_t.
(dos_write): Change prototype -- take 'void *'
buffer and size_t size. Adjust.
(dos_info): Print elements of 'cnts' as unsigned long.
* serial.c (serial_write): Likewise.
* serial.h (serial_write): Adjust.
(struct serial_ops) <write>: Change prototype -- take 'void *'
buffer and size_t size. Adjust.
2013-04-19 17:26:17 +02:00
|
|
|
int (*write) (struct serial *, const void *buf, size_t count);
|
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 *);
|
2011-03-04 20:23:42 +01:00
|
|
|
serial_ttystate (*copy_tty_state) (struct serial *, serial_ttystate);
|
2001-07-11 19:52:32 +02:00
|
|
|
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);
|
2015-03-23 22:15:42 +01:00
|
|
|
/* Set the value PARITY as parity setting for serial object.
|
|
|
|
Return 0 in the case of success. */
|
|
|
|
int (*setparity) (struct serial *, int parity);
|
2011-01-11 22:53:25 +01: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
|
2005-01-14 02:59:20 +01:00
|
|
|
interesting. */
|
2001-07-11 19:52:32 +02:00
|
|
|
void (*async) (struct serial *scb, int async_p);
|
2005-04-21 07:34:33 +02:00
|
|
|
/* Perform a low-level read operation, reading (at most) COUNT
|
2007-10-12 22:14:57 +02:00
|
|
|
bytes into SCB->BUF. Return zero at end of file. */
|
2005-04-21 07:34:33 +02:00
|
|
|
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);
|
2007-04-08 17:20:07 +02:00
|
|
|
/* Return that number of bytes that can be read from FD
|
|
|
|
without blocking. Return value of -1 means that the
|
2011-04-19 20:04:11 +02:00
|
|
|
read will not block even if less that requested bytes
|
2007-04-08 17:20:07 +02:00
|
|
|
are available. */
|
|
|
|
int (*avail)(struct serial *scb, int fd);
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
|
|
|
|
#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);
|
2006-04-24 23:00:13 +02:00
|
|
|
void (*done_wait_handle) (struct serial *scb);
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
#endif /* USE_WIN32API */
|
1999-09-22 05:28:34 +02:00
|
|
|
};
|
|
|
|
|
2011-01-11 22:53:25 +01:00
|
|
|
/* Add a new serial interface to the interface list. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2013-12-06 18:58:50 +01:00
|
|
|
extern void serial_add_interface (const struct serial_ops * optable);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2011-01-11 22:53:25 +01:00
|
|
|
/* File in which to record the remote debugging session. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2013-12-18 05:35:13 +01:00
|
|
|
extern void serial_log_command (struct target_ops *self, const char *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
#ifdef USE_WIN32API
|
|
|
|
|
|
|
|
/* Windows-only: find or create handles that we can wait on for this
|
|
|
|
serial device. */
|
|
|
|
extern void serial_wait_handle (struct serial *, HANDLE *, HANDLE *);
|
|
|
|
|
2006-04-24 23:00:13 +02:00
|
|
|
/* Windows-only: signal that we are done with the wait handles. */
|
|
|
|
extern void serial_done_wait_handle (struct serial *);
|
|
|
|
|
* NEWS: Mention native Windows support.
* Makefile.in (gdb_select_h, ser_tcp_h): New.
(ALLDEPFILES): Add ser-mingw.c.
(event-loop.o, inflow.o, mingw-hdep.o, posix-hdep.o, ser-base.o)
(ser-tcp.o, ser-unix.o): Update.
(ser-mingw.o): New rule.
* configure: Regenerated.
* configure.ac: Add ser-mingw.o for mingw32.
* ser-mingw.c: New file.
* event-loop.c: Include "gdb_select.h".
(gdb_select): Remove, moved to mingw-hdep.c and posix-hdep.c.
* ser-base.c: Include "gdb_select.h".
(ser_base_wait_for): Use gdb_select.
* serial.c (serial_for_fd): New function.
(serial_fdopen): Try "terminal" before "hardwire". Initialize
the allocated struct serial.
(serial_wait_handle): New function.
* serial.h (serial_for_fd, serial_wait_handle): New prototypes.
(struct serial_ops) [USE_WIN32API]: Add wait_handle.
* gdb_select.h: New file.
* ser-tcp.c: Include "ser-tcp.h". Remove unused "ser-unix.h" include.
(net_close, net_read_prim, net_write_prim): Make global.
(net_open): Likewise. Pass an exception set to select. Whitespace fix.
Document why we can not use gdb_select.
(_initialize_ser_tcp) [USE_WIN32API]: Do not register TCP support here.
* ser-tcp.h: New file.
* inflow.c (gdb_has_a_terminal): Don't initialize stdin_serial here.
(handle_sigio): Use gdb_select.
(initialize_stdin_serial): New function.
* terminal.h (initialize_stdin_serial): New prototype.
* top.c (gdb_init): Call initialize_stdin_serial.
* mingw-hdep.c (gdb_select): New function, moved from gdb_select in
event-loop.c. Add exception condition support. Use serial_for_fd
and serial_wait_handle. Fix timeout handling.
* posix-hdep.c: Include "gdb_select.h".
(gdb_select): New function.
* remote-st.c (connect_command): Use gdb_select.
* ser-unix.c: Include "gdb_select.h".
(hardwire_send_break, wait_for): Use gdb_select.
2006-02-10 23:01:43 +01:00
|
|
|
#endif /* USE_WIN32API */
|
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
#endif /* SERIAL_H */
|