gdb/serial.h - gdb

Data types defined

Macros defined

Source code

  1. /* Remote serial support interface definitions for GDB, the GNU Debugger.
  2.    Copyright (C) 1992-2015 Free Software Foundation, Inc.

  4.    This file is part of GDB.

  6.    This program is free software; you can redistribute it and/or modify
  7.    it under the terms of the GNU General Public License as published by
  8.    the Free Software Foundation; either version 3 of the License, or
  9.    (at your option) any later version.

  11.    This program is distributed in the hope that it will be useful,
  12.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.    GNU General Public License for more details.

  16.    You should have received a copy of the GNU General Public License
  17.    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

  19. #ifndef SERIAL_H
  20. ‌#define SERIAL_H

  22. #ifdef USE_WIN32API
  23. #include <winsock2.h>
  24. #include <windows.h>
  25. #endif

  27. struct ui_file;

  29. /* For most routines, if a failure is indicated, then errno should be
  30.    examined.  */

  32. /* Terminal state pointer.  This is specific to each type of
  33.    interface.  */

  35. ‌typedef void *serial_ttystate;
  36. struct serial;

  38. /* Try to open NAME.  Returns a new `struct serial *' on success, NULL
  39.    on failure.  The new serial object has a reference count of 1.
  40.    Note that some open calls can block and, if possible, should be
  41.    written to be non-blocking, with calls to ui_look_hook so they can
  42.    be cancelled.  An async interface for open could be added to GDB if
  43.    necessary.  */

  45. extern struct serial *serial_open (const char *name);

  47. /* Returns true if SCB is open.  */

  49. extern int serial_is_open (struct serial *scb);

  51. /* Find an already opened serial stream using a file handle.  */

  53. extern struct serial *serial_for_fd (int fd);

  55. /* Open a new serial stream using a file handle.  */

  57. extern struct serial *serial_fdopen (const int fd);

  59. /* Push out all buffers, close the device and unref SCB.  */

  61. extern void serial_close (struct serial *scb);

  63. /* Increment reference count of SCB.  */

  65. extern void serial_ref (struct serial *scb);

  67. /* Decrement reference count of SCB.  */

  69. extern void serial_unref (struct serial *scb);

  71. /* Create a pipe, and put the read end in files[0], and the write end
  72.    in filde[1].  Returns 0 for success, negative value for error (in
  73.    which case errno contains the error).  */

  75. extern int gdb_pipe (int fildes[2]);

  77. /* Create a pipe with each end wrapped in a `struct serial' interface.
  78.    Put the read end in scbs[0], and the write end in scbs[1].  Returns
  79.    0 for success, negative value for error (in which case errno
  80.    contains the error).  */

  82. extern int serial_pipe (struct serial *scbs[2]);

  84. /* Push out all buffers and destroy SCB without closing the device.  */

  86. extern void serial_un_fdopen (struct serial *scb);

  88. /* Read one char from the serial device with TIMEOUT seconds to wait
  89.    or -1 to wait forever.  Use timeout of 0 to effect a poll.
  90.    Infinite waits are not permitted.  Returns unsigned char if ok, else
  91.    one of the following codes.  Note that all error return-codes are
  92.    guaranteed to be < 0.  */

  94. ‌enum serial_rc {
  95.   SERIAL_ERROR = -1,        /* General error.  */
  96.   SERIAL_TIMEOUT = -2,        /* Timeout or data-not-ready during read.
  97.                            Unfortunately, through
  98.                            deprecated_ui_loop_hook (), this can also
  99.                            be a QUIT indication.  */
  100.   SERIAL_EOF = -3        /* General end-of-file or remote target
  101.                            connection closed, indication.  Includes
  102.                            things like the line dropping dead.  */
  103. };

  105. extern int serial_readchar (struct serial *scb, int timeout);

  107. /* Write COUNT bytes from BUF to the port SCB.  Returns 0 for
  108.    success, non-zero for failure.  */

  110. extern int serial_write (struct serial *scb, const void *buf, size_t count);

  112. /* Write a printf style string onto the serial port.  */

  114. extern void serial_printf (struct serial *desc,
  115.                            const char *,...) ATTRIBUTE_PRINTF (2, 3);

  117. /* Allow pending output to drain.  */

  119. extern int serial_drain_output (struct serial *);

  121. /* Flush (discard) pending output.  Might also flush input (if this
  122.    system can't flush only output).  */

  124. extern int serial_flush_output (struct serial *);

  126. /* Flush pending input.  Might also flush output (if this system can't
  127.    flush only input).  */

  129. extern int serial_flush_input (struct serial *);

  131. /* Send a break between 0.25 and 0.5 seconds long.  */

  133. extern int serial_send_break (struct serial *scb);

  135. /* Turn the port into raw mode.  */

  137. extern void serial_raw (struct serial *scb);

  139. /* Return a pointer to a newly malloc'd ttystate containing the state
  140.    of the tty.  */

  142. extern serial_ttystate serial_get_tty_state (struct serial *scb);

  144. /* Return a pointer to a newly malloc'd ttystate containing a copy
  145.    of the state in TTYSTATE.  */

  147. extern serial_ttystate serial_copy_tty_state (struct serial *scb,
  148.                                               serial_ttystate ttystate);

  150. /* Set the state of the tty to TTYSTATE.  The change is immediate.
  151.    When changing to or from raw mode, input might be discarded.
  152.    Returns 0 for success, negative value for error (in which case
  153.    errno contains the error).  */

  155. extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate);

  157. /* printf_filtered a user-comprehensible description of ttystate on
  158.    the specified STREAM.  FIXME: At present this sends output to the
  159.    default stream - GDB_STDOUT.  */

  161. extern void serial_print_tty_state (struct serial *scb,
  162.                                     serial_ttystate ttystate,
  163.                                     struct ui_file *);

  165. /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
  166.    current state (generally obtained from a recent call to
  167.    serial_get_tty_state()), but be careful not to discard any input.
  168.    This means that we never switch in or out of raw mode, even if
  169.    NEW_TTYSTATE specifies a switch.  */

  171. extern int serial_noflush_set_tty_state (struct serial *scb,
  172.                                          serial_ttystate new_ttystate,
  173.                                          serial_ttystate old_ttystate);

  175. /* Set the baudrate to the decimal value supplied.  Returns 0 for
  176.    success, -1 for failure.  */

  178. extern int serial_setbaudrate (struct serial *scb, int rate);

  180. /* Set the number of stop bits to the value specified.  Returns 0 for
  181.    success, -1 for failure.  */

  183. ‌#define SERIAL_1_STOPBITS 1
  184. ‌#define SERIAL_1_AND_A_HALF_STOPBITS 2        /* 1.5 bits, snicker...  */
  185. ‌#define SERIAL_2_STOPBITS 3

  187. extern int serial_setstopbits (struct serial *scb, int num);

  189. /* Asynchronous serial interface: */

  191. /* Can the serial device support asynchronous mode?  */

  193. extern int serial_can_async_p (struct serial *scb);

  195. /* Has the serial device been put in asynchronous mode?  */

  197. extern int serial_is_async_p (struct serial *scb);

  199. /* For ASYNC enabled devices, register a callback and enable
  200.    asynchronous mode.  To disable asynchronous mode, register a NULL
  201.    callback.  */

  203. ‌typedef void (serial_event_ftype) (struct serial *scb, void *context);
  204. extern void serial_async (struct serial *scb,
  205.                           serial_event_ftype *handler, void *context);

  207. /* Trace/debug mechanism.

  209.    serial_debug() enables/disables internal debugging.
  210.    serial_debug_p() indicates the current debug state.  */

  212. extern void serial_debug (struct serial *scb, int debug_p);

  214. extern int serial_debug_p (struct serial *scb);


  217. /* Details of an instance of a serial object.  */

  219. ‌struct serial
  220.   {
  221.     /* serial objects are ref counted (but not the underlying
  222.        connection, just the object's lifetime in memory).  */
  223.     int refcnt;

  225.     int fd;                        /* File descriptor */
  226.     /* File descriptor for a separate error stream that should be
  227.        immediately forwarded to gdb_stderr.  This may be -1.
  228.        If != -1, this descriptor should be non-blocking or
  229.        ops->avail should be non-NULL.  */
  230.     int error_fd;
  231.     const struct serial_ops *ops; /* Function vector */
  232.     void *state;                       /* Local context info for open FD */
  233.     serial_ttystate ttystate;        /* Not used (yet) */
  234.     int bufcnt;                        /* Amount of data remaining in receive
  235.                                    buffer.  -ve for sticky errors.  */
  236.     unsigned char *bufp;        /* Current byte */
  237.     unsigned char buf[BUFSIZ];        /* Da buffer itself */
  238.     int current_timeout;        /* (ser-unix.c termio{,s} only), last
  239.                                    value of VTIME */
  240.     int timeout_remaining;        /* (ser-unix.c termio{,s} only), we
  241.                                    still need to wait for this many
  242.                                    more seconds.  */
  243.     char *name;                        /* The name of the device or host */
  244.     struct serial *next;        /* Pointer to the next `struct serial *' */
  245.     int debug_p;                /* Trace this serial devices operation.  */
  246.     int async_state;                /* Async internal state.  */
  247.     void *async_context;        /* Async event thread's context */
  248.     serial_event_ftype *async_handler;/* Async event handler */
  249.   };

  251. ‌struct serial_ops
  252.   {
  253.     char *name;
  254.     int (*open) (struct serial *, const char *name);
  255.     void (*close) (struct serial *);
  256.     int (*fdopen) (struct serial *, int fd);
  257.     int (*readchar) (struct serial *, int timeout);
  258.     int (*write) (struct serial *, const void *buf, size_t count);
  259.     /* Discard pending output */
  260.     int (*flush_output) (struct serial *);
  261.     /* Discard pending input */
  262.     int (*flush_input) (struct serial *);
  263.     int (*send_break) (struct serial *);
  264.     void (*go_raw) (struct serial *);
  265.     serial_ttystate (*get_tty_state) (struct serial *);
  266.     serial_ttystate (*copy_tty_state) (struct serial *, serial_ttystate);
  267.     int (*set_tty_state) (struct serial *, serial_ttystate);
  268.     void (*print_tty_state) (struct serial *, serial_ttystate,
  269.                              struct ui_file *);
  270.     int (*noflush_set_tty_state) (struct serial *, serial_ttystate,
  271.                                   serial_ttystate);
  272.     int (*setbaudrate) (struct serial *, int rate);
  273.     int (*setstopbits) (struct serial *, int num);
  274.     /* Wait for output to drain.  */
  275.     int (*drain_output) (struct serial *);
  276.     /* Change the serial device into/out of asynchronous mode, call
  277.        the specified function when ever there is something
  278.        interesting.  */
  279.     void (*async) (struct serial *scb, int async_p);
  280.     /* Perform a low-level read operation, reading (at most) COUNT
  281.        bytes into SCB->BUF.  Return zero at end of file.  */
  282.     int (*read_prim)(struct serial *scb, size_t count);
  283.     /* Perform a low-level write operation, writing (at most) COUNT
  284.        bytes from BUF.  */
  285.     int (*write_prim)(struct serial *scb, const void *buf, size_t count);
  286.     /* Return that number of bytes that can be read from FD
  287.        without blocking.  Return value of -1 means that the
  288.        read will not block even if less that requested bytes
  289.        are available.  */
  290.     int (*avail)(struct serial *scb, int fd);

  292. #ifdef USE_WIN32API
  293.     /* Return a handle to wait on, indicating available data from SCB
  294.        when signaled, in *READ.  Return a handle indicating errors
  295.        in *EXCEPT.  */
  296.     void (*wait_handle) (struct serial *scb, HANDLE *read, HANDLE *except);
  297.     void (*done_wait_handle) (struct serial *scb);
  298. #endif /* USE_WIN32API */
  299.   };

  301. /* Add a new serial interface to the interface list.  */

  303. extern void serial_add_interface (const struct serial_ops * optable);

  305. /* File in which to record the remote debugging session.  */

  307. extern void serial_log_command (struct target_ops *self, const char *);

  309. #ifdef USE_WIN32API

  311. /* Windows-only: find or create handles that we can wait on for this
  312.    serial device.  */
  313. extern void serial_wait_handle (struct serial *, HANDLE *, HANDLE *);

  315. /* Windows-only: signal that we are done with the wait handles.  */
  316. extern void serial_done_wait_handle (struct serial *);

  318. #endif /* USE_WIN32API */

  320. #endif /* SERIAL_H */