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