1 /* Remote serial support interface definitions for GDB, the GNU Debugger. 2 Copyright (C) 1992-2017 Free Software Foundation, Inc. 3 4 This file is part of GDB. 5 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. 10 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. 15 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/>. */ 18 19 #ifndef SERIAL_H 20 #define SERIAL_H 21 22 #ifdef USE_WIN32API 23 #include <winsock2.h> 24 #include <windows.h> 25 #endif 26 27 struct ui_file; 28 29 /* For most routines, if a failure is indicated, then errno should be 30 examined. */ 31 32 /* Terminal state pointer. This is specific to each type of 33 interface. */ 34 35 typedef void *serial_ttystate; 36 struct serial; 37 struct serial_ops; 38 39 /* Create a new serial for OPS. The new serial is not opened. */ 40 41 /* Try to open NAME. Returns a new `struct serial *' on success, NULL 42 on failure. The new serial object has a reference count of 1. 43 Note that some open calls can block and, if possible, should be 44 written to be non-blocking, with calls to ui_look_hook so they can 45 be cancelled. An async interface for open could be added to GDB if 46 necessary. */ 47 48 extern struct serial *serial_open (const char *name); 49 50 /* Open a new serial stream using OPS. */ 51 52 extern struct serial *serial_open_ops (const struct serial_ops *ops); 53 54 /* Returns true if SCB is open. */ 55 56 extern int serial_is_open (struct serial *scb); 57 58 /* Find an already opened serial stream using a file handle. */ 59 60 extern struct serial *serial_for_fd (int fd); 61 62 /* Open a new serial stream using a file handle. */ 63 64 extern struct serial *serial_fdopen (const int fd); 65 66 /* Push out all buffers, close the device and unref SCB. */ 67 68 extern void serial_close (struct serial *scb); 69 70 /* Increment reference count of SCB. */ 71 72 extern void serial_ref (struct serial *scb); 73 74 /* Decrement reference count of SCB. */ 75 76 extern void serial_unref (struct serial *scb); 77 78 /* Create a pipe, and put the read end in FILDES[0], and the write end 79 in FILDES[1]. Returns 0 for success, negative value for error (in 80 which case errno contains the error). */ 81 82 extern int gdb_pipe (int fildes[2]); 83 84 /* Create a pipe with each end wrapped in a `struct serial' interface. 85 Put the read end in scbs[0], and the write end in scbs[1]. Returns 86 0 for success, negative value for error (in which case errno 87 contains the error). */ 88 89 extern int serial_pipe (struct serial *scbs[2]); 90 91 /* Push out all buffers and destroy SCB without closing the device. */ 92 93 extern void serial_un_fdopen (struct serial *scb); 94 95 /* Read one char from the serial device with TIMEOUT seconds to wait 96 or -1 to wait forever. Use timeout of 0 to effect a poll. 97 Infinite waits are not permitted. Returns unsigned char if ok, else 98 one of the following codes. Note that all error return-codes are 99 guaranteed to be < 0. */ 100 101 enum serial_rc { 102 SERIAL_ERROR = -1, /* General error. */ 103 SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read. 104 Unfortunately, through 105 deprecated_ui_loop_hook (), this can also 106 be a QUIT indication. */ 107 SERIAL_EOF = -3 /* General end-of-file or remote target 108 connection closed, indication. Includes 109 things like the line dropping dead. */ 110 }; 111 112 extern int serial_readchar (struct serial *scb, int timeout); 113 114 /* Write COUNT bytes from BUF to the port SCB. Returns 0 for 115 success, non-zero for failure. */ 116 117 extern int serial_write (struct serial *scb, const void *buf, size_t count); 118 119 /* Write a printf style string onto the serial port. */ 120 121 extern void serial_printf (struct serial *desc, 122 const char *,...) ATTRIBUTE_PRINTF (2, 3); 123 124 /* Allow pending output to drain. */ 125 126 extern int serial_drain_output (struct serial *); 127 128 /* Flush (discard) pending output. Might also flush input (if this 129 system can't flush only output). */ 130 131 extern int serial_flush_output (struct serial *); 132 133 /* Flush pending input. Might also flush output (if this system can't 134 flush only input). */ 135 136 extern int serial_flush_input (struct serial *); 137 138 /* Send a break between 0.25 and 0.5 seconds long. */ 139 140 extern int serial_send_break (struct serial *scb); 141 142 /* Turn the port into raw mode. */ 143 144 extern void serial_raw (struct serial *scb); 145 146 /* Return a pointer to a newly malloc'd ttystate containing the state 147 of the tty. */ 148 149 extern serial_ttystate serial_get_tty_state (struct serial *scb); 150 151 /* Return a pointer to a newly malloc'd ttystate containing a copy 152 of the state in TTYSTATE. */ 153 154 extern serial_ttystate serial_copy_tty_state (struct serial *scb, 155 serial_ttystate ttystate); 156 157 /* Set the state of the tty to TTYSTATE. The change is immediate. 158 When changing to or from raw mode, input might be discarded. 159 Returns 0 for success, negative value for error (in which case 160 errno contains the error). */ 161 162 extern int serial_set_tty_state (struct serial *scb, serial_ttystate ttystate); 163 164 /* printf_filtered a user-comprehensible description of ttystate on 165 the specified STREAM. FIXME: At present this sends output to the 166 default stream - GDB_STDOUT. */ 167 168 extern void serial_print_tty_state (struct serial *scb, 169 serial_ttystate ttystate, 170 struct ui_file *); 171 172 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the 173 current state (generally obtained from a recent call to 174 serial_get_tty_state()), but be careful not to discard any input. 175 This means that we never switch in or out of raw mode, even if 176 NEW_TTYSTATE specifies a switch. */ 177 178 extern int serial_noflush_set_tty_state (struct serial *scb, 179 serial_ttystate new_ttystate, 180 serial_ttystate old_ttystate); 181 182 /* Set the baudrate to the decimal value supplied. Returns 0 for 183 success, -1 for failure. */ 184 185 extern int serial_setbaudrate (struct serial *scb, int rate); 186 187 /* Set the number of stop bits to the value specified. Returns 0 for 188 success, -1 for failure. */ 189 190 #define SERIAL_1_STOPBITS 1 191 #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */ 192 #define SERIAL_2_STOPBITS 3 193 194 extern int serial_setstopbits (struct serial *scb, int num); 195 196 #define GDBPARITY_NONE 0 197 #define GDBPARITY_ODD 1 198 #define GDBPARITY_EVEN 2 199 200 /* Set parity for serial port. Returns 0 for success, -1 for failure. */ 201 202 extern int serial_setparity (struct serial *scb, int parity); 203 204 /* Asynchronous serial interface: */ 205 206 /* Can the serial device support asynchronous mode? */ 207 208 extern int serial_can_async_p (struct serial *scb); 209 210 /* Has the serial device been put in asynchronous mode? */ 211 212 extern int serial_is_async_p (struct serial *scb); 213 214 /* For ASYNC enabled devices, register a callback and enable 215 asynchronous mode. To disable asynchronous mode, register a NULL 216 callback. */ 217 218 typedef void (serial_event_ftype) (struct serial *scb, void *context); 219 extern void serial_async (struct serial *scb, 220 serial_event_ftype *handler, void *context); 221 222 /* Trace/debug mechanism. 223 224 serial_debug() enables/disables internal debugging. 225 serial_debug_p() indicates the current debug state. */ 226 227 extern void serial_debug (struct serial *scb, int debug_p); 228 229 extern int serial_debug_p (struct serial *scb); 230 231 232 /* Details of an instance of a serial object. */ 233 234 struct serial 235 { 236 /* serial objects are ref counted (but not the underlying 237 connection, just the object's lifetime in memory). */ 238 int refcnt; 239 240 int fd; /* File descriptor */ 241 /* File descriptor for a separate error stream that should be 242 immediately forwarded to gdb_stderr. This may be -1. 243 If != -1, this descriptor should be non-blocking or 244 ops->avail should be non-NULL. */ 245 int error_fd; 246 const struct serial_ops *ops; /* Function vector */ 247 void *state; /* Local context info for open FD */ 248 serial_ttystate ttystate; /* Not used (yet) */ 249 int bufcnt; /* Amount of data remaining in receive 250 buffer. -ve for sticky errors. */ 251 unsigned char *bufp; /* Current byte */ 252 unsigned char buf[BUFSIZ]; /* Da buffer itself */ 253 struct serial *next; /* Pointer to the next `struct serial *' */ 254 int debug_p; /* Trace this serial devices operation. */ 255 int async_state; /* Async internal state. */ 256 void *async_context; /* Async event thread's context */ 257 serial_event_ftype *async_handler;/* Async event handler */ 258 }; 259 260 struct serial_ops 261 { 262 const char *name; 263 int (*open) (struct serial *, const char *name); 264 void (*close) (struct serial *); 265 int (*fdopen) (struct serial *, int fd); 266 int (*readchar) (struct serial *, int timeout); 267 int (*write) (struct serial *, const void *buf, size_t count); 268 /* Discard pending output */ 269 int (*flush_output) (struct serial *); 270 /* Discard pending input */ 271 int (*flush_input) (struct serial *); 272 int (*send_break) (struct serial *); 273 void (*go_raw) (struct serial *); 274 serial_ttystate (*get_tty_state) (struct serial *); 275 serial_ttystate (*copy_tty_state) (struct serial *, serial_ttystate); 276 int (*set_tty_state) (struct serial *, serial_ttystate); 277 void (*print_tty_state) (struct serial *, serial_ttystate, 278 struct ui_file *); 279 int (*noflush_set_tty_state) (struct serial *, serial_ttystate, 280 serial_ttystate); 281 int (*setbaudrate) (struct serial *, int rate); 282 int (*setstopbits) (struct serial *, int num); 283 /* Set the value PARITY as parity setting for serial object. 284 Return 0 in the case of success. */ 285 int (*setparity) (struct serial *, int parity); 286 /* Wait for output to drain. */ 287 int (*drain_output) (struct serial *); 288 /* Change the serial device into/out of asynchronous mode, call 289 the specified function when ever there is something 290 interesting. */ 291 void (*async) (struct serial *scb, int async_p); 292 /* Perform a low-level read operation, reading (at most) COUNT 293 bytes into SCB->BUF. Return zero at end of file. */ 294 int (*read_prim)(struct serial *scb, size_t count); 295 /* Perform a low-level write operation, writing (at most) COUNT 296 bytes from BUF. */ 297 int (*write_prim)(struct serial *scb, const void *buf, size_t count); 298 /* Return that number of bytes that can be read from FD 299 without blocking. Return value of -1 means that the 300 read will not block even if less that requested bytes 301 are available. */ 302 int (*avail)(struct serial *scb, int fd); 303 304 #ifdef USE_WIN32API 305 /* Return a handle to wait on, indicating available data from SCB 306 when signaled, in *READ. Return a handle indicating errors 307 in *EXCEPT. */ 308 void (*wait_handle) (struct serial *scb, HANDLE *read, HANDLE *except); 309 void (*done_wait_handle) (struct serial *scb); 310 #endif /* USE_WIN32API */ 311 }; 312 313 /* Add a new serial interface to the interface list. */ 314 315 extern void serial_add_interface (const struct serial_ops * optable); 316 317 /* File in which to record the remote debugging session. */ 318 319 extern void serial_log_command (struct target_ops *self, const char *); 320 321 #ifdef USE_WIN32API 322 323 /* Windows-only: find or create handles that we can wait on for this 324 serial device. */ 325 extern void serial_wait_handle (struct serial *, HANDLE *, HANDLE *); 326 327 /* Windows-only: signal that we are done with the wait handles. */ 328 extern void serial_done_wait_handle (struct serial *); 329 330 #endif /* USE_WIN32API */ 331 332 #endif /* SERIAL_H */ 333