1 /* Serial interface for local (hardwired) serial ports on Un*x like systems
3 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2003,
4 2004, 2005, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 #include <sys/types.h>
29 #include <sys/socket.h>
32 #include "gdb_select.h"
33 #include "gdb_string.h"
38 struct hardwire_ttystate
40 struct termios termios
;
44 /* Boolean to explicitly enable or disable h/w flow control. */
45 static int serial_hwflow
;
47 show_serial_hwflow (struct ui_file
*file
, int from_tty
,
48 struct cmd_list_element
*c
, const char *value
)
50 fprintf_filtered (file
, _("Hardware flow control is %s.\n"), value
);
58 /* It is believed that all systems which have added job control to SVR3
59 (e.g. sco) have also added termios. Even if not, trying to figure out
60 all the variations (TIOCGPGRP vs. TCGETPGRP, etc.) would be pretty
61 bewildering. So we don't attempt it. */
63 struct hardwire_ttystate
70 struct hardwire_ttystate
75 /* Line discipline flags. */
80 static int hardwire_open (struct serial
*scb
, const char *name
);
81 static void hardwire_raw (struct serial
*scb
);
82 static int wait_for (struct serial
*scb
, int timeout
);
83 static int hardwire_readchar (struct serial
*scb
, int timeout
);
84 static int do_hardwire_readchar (struct serial
*scb
, int timeout
);
85 static int rate_to_code (int rate
);
86 static int hardwire_setbaudrate (struct serial
*scb
, int rate
);
87 static void hardwire_close (struct serial
*scb
);
88 static int get_tty_state (struct serial
*scb
,
89 struct hardwire_ttystate
* state
);
90 static int set_tty_state (struct serial
*scb
,
91 struct hardwire_ttystate
* state
);
92 static serial_ttystate
hardwire_get_tty_state (struct serial
*scb
);
93 static int hardwire_set_tty_state (struct serial
*scb
, serial_ttystate state
);
94 static int hardwire_noflush_set_tty_state (struct serial
*, serial_ttystate
,
96 static void hardwire_print_tty_state (struct serial
*, serial_ttystate
,
98 static int hardwire_drain_output (struct serial
*);
99 static int hardwire_flush_output (struct serial
*);
100 static int hardwire_flush_input (struct serial
*);
101 static int hardwire_send_break (struct serial
*);
102 static int hardwire_setstopbits (struct serial
*, int);
104 void _initialize_ser_hardwire (void);
106 /* Open up a real live device for serial I/O. */
109 hardwire_open (struct serial
*scb
, const char *name
)
111 scb
->fd
= open (name
, O_RDWR
);
119 get_tty_state (struct serial
*scb
, struct hardwire_ttystate
*state
)
122 if (tcgetattr (scb
->fd
, &state
->termios
) < 0)
129 if (ioctl (scb
->fd
, TCGETA
, &state
->termio
) < 0)
135 if (ioctl (scb
->fd
, TIOCGETP
, &state
->sgttyb
) < 0)
137 if (ioctl (scb
->fd
, TIOCGETC
, &state
->tc
) < 0)
139 if (ioctl (scb
->fd
, TIOCGLTC
, &state
->ltc
) < 0)
141 if (ioctl (scb
->fd
, TIOCLGET
, &state
->lmode
) < 0)
149 set_tty_state (struct serial
*scb
, struct hardwire_ttystate
*state
)
152 if (tcsetattr (scb
->fd
, TCSANOW
, &state
->termios
) < 0)
159 if (ioctl (scb
->fd
, TCSETA
, &state
->termio
) < 0)
165 if (ioctl (scb
->fd
, TIOCSETN
, &state
->sgttyb
) < 0)
167 if (ioctl (scb
->fd
, TIOCSETC
, &state
->tc
) < 0)
169 if (ioctl (scb
->fd
, TIOCSLTC
, &state
->ltc
) < 0)
171 if (ioctl (scb
->fd
, TIOCLSET
, &state
->lmode
) < 0)
178 static serial_ttystate
179 hardwire_get_tty_state (struct serial
*scb
)
181 struct hardwire_ttystate
*state
;
183 state
= (struct hardwire_ttystate
*) xmalloc (sizeof *state
);
185 if (get_tty_state (scb
, state
))
188 return (serial_ttystate
) state
;
192 hardwire_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
194 struct hardwire_ttystate
*state
;
196 state
= (struct hardwire_ttystate
*) ttystate
;
198 return set_tty_state (scb
, state
);
202 hardwire_noflush_set_tty_state (struct serial
*scb
,
203 serial_ttystate new_ttystate
,
204 serial_ttystate old_ttystate
)
206 struct hardwire_ttystate new_state
;
208 struct hardwire_ttystate
*state
= (struct hardwire_ttystate
*) old_ttystate
;
211 new_state
= *(struct hardwire_ttystate
*) new_ttystate
;
213 /* Don't change in or out of raw mode; we don't want to flush input.
214 termio and termios have no such restriction; for them flushing input
215 is separate from setting the attributes. */
218 if (state
->sgttyb
.sg_flags
& RAW
)
219 new_state
.sgttyb
.sg_flags
|= RAW
;
221 new_state
.sgttyb
.sg_flags
&= ~RAW
;
223 /* I'm not sure whether this is necessary; the manpage just mentions
225 if (state
->sgttyb
.sg_flags
& CBREAK
)
226 new_state
.sgttyb
.sg_flags
|= CBREAK
;
228 new_state
.sgttyb
.sg_flags
&= ~CBREAK
;
231 return set_tty_state (scb
, &new_state
);
235 hardwire_print_tty_state (struct serial
*scb
,
236 serial_ttystate ttystate
,
237 struct ui_file
*stream
)
239 struct hardwire_ttystate
*state
= (struct hardwire_ttystate
*) ttystate
;
243 fprintf_filtered (stream
, "c_iflag = 0x%x, c_oflag = 0x%x,\n",
244 (int) state
->termios
.c_iflag
,
245 (int) state
->termios
.c_oflag
);
246 fprintf_filtered (stream
, "c_cflag = 0x%x, c_lflag = 0x%x\n",
247 (int) state
->termios
.c_cflag
,
248 (int) state
->termios
.c_lflag
);
250 /* This not in POSIX, and is not really documented by those systems
251 which have it (at least not Sun). */
252 fprintf_filtered (stream
, "c_line = 0x%x.\n", state
->termios
.c_line
);
254 fprintf_filtered (stream
, "c_cc: ");
255 for (i
= 0; i
< NCCS
; i
+= 1)
256 fprintf_filtered (stream
, "0x%x ", state
->termios
.c_cc
[i
]);
257 fprintf_filtered (stream
, "\n");
261 fprintf_filtered (stream
, "c_iflag = 0x%x, c_oflag = 0x%x,\n",
262 state
->termio
.c_iflag
, state
->termio
.c_oflag
);
263 fprintf_filtered (stream
, "c_cflag = 0x%x, c_lflag = 0x%x, c_line = 0x%x.\n",
264 state
->termio
.c_cflag
, state
->termio
.c_lflag
,
265 state
->termio
.c_line
);
266 fprintf_filtered (stream
, "c_cc: ");
267 for (i
= 0; i
< NCC
; i
+= 1)
268 fprintf_filtered (stream
, "0x%x ", state
->termio
.c_cc
[i
]);
269 fprintf_filtered (stream
, "\n");
273 fprintf_filtered (stream
, "sgttyb.sg_flags = 0x%x.\n",
274 state
->sgttyb
.sg_flags
);
276 fprintf_filtered (stream
, "tchars: ");
277 for (i
= 0; i
< (int) sizeof (struct tchars
); i
++)
278 fprintf_filtered (stream
, "0x%x ", ((unsigned char *) &state
->tc
)[i
]);
279 fprintf_filtered (stream
, "\n");
281 fprintf_filtered (stream
, "ltchars: ");
282 for (i
= 0; i
< (int) sizeof (struct ltchars
); i
++)
283 fprintf_filtered (stream
, "0x%x ", ((unsigned char *) &state
->ltc
)[i
]);
284 fprintf_filtered (stream
, "\n");
286 fprintf_filtered (stream
, "lmode: 0x%x\n", state
->lmode
);
290 /* Wait for the output to drain away, as opposed to flushing
294 hardwire_drain_output (struct serial
*scb
)
297 return tcdrain (scb
->fd
);
301 return ioctl (scb
->fd
, TCSBRK
, 1);
305 /* Get the current state and then restore it using TIOCSETP,
306 which should cause the output to drain and pending input
309 struct hardwire_ttystate state
;
311 if (get_tty_state (scb
, &state
))
317 return (ioctl (scb
->fd
, TIOCSETP
, &state
.sgttyb
));
324 hardwire_flush_output (struct serial
*scb
)
327 return tcflush (scb
->fd
, TCOFLUSH
);
331 return ioctl (scb
->fd
, TCFLSH
, 1);
335 /* This flushes both input and output, but we can't do better. */
336 return ioctl (scb
->fd
, TIOCFLUSH
, 0);
341 hardwire_flush_input (struct serial
*scb
)
343 ser_base_flush_input (scb
);
346 return tcflush (scb
->fd
, TCIFLUSH
);
350 return ioctl (scb
->fd
, TCFLSH
, 0);
354 /* This flushes both input and output, but we can't do better. */
355 return ioctl (scb
->fd
, TIOCFLUSH
, 0);
360 hardwire_send_break (struct serial
*scb
)
363 return tcsendbreak (scb
->fd
, 0);
367 return ioctl (scb
->fd
, TCSBRK
, 0);
374 status
= ioctl (scb
->fd
, TIOCSBRK
, 0);
376 /* Can't use usleep; it doesn't exist in BSD 4.2. */
377 /* Note that if this gdb_select() is interrupted by a signal it will not
378 wait the full length of time. I think that is OK. */
380 status
= ioctl (scb
->fd
, TIOCCBRK
, 0);
387 hardwire_raw (struct serial
*scb
)
389 struct hardwire_ttystate state
;
391 if (get_tty_state (scb
, &state
))
392 fprintf_unfiltered (gdb_stderr
, "get_tty_state failed: %s\n",
393 safe_strerror (errno
));
396 state
.termios
.c_iflag
= 0;
397 state
.termios
.c_oflag
= 0;
398 state
.termios
.c_lflag
= 0;
399 state
.termios
.c_cflag
&= ~(CSIZE
| PARENB
);
400 state
.termios
.c_cflag
|= CLOCAL
| CS8
;
402 /* h/w flow control. */
404 state
.termios
.c_cflag
|= CRTSCTS
;
406 state
.termios
.c_cflag
&= ~CRTSCTS
;
409 state
.termios
.c_cflag
|= CRTS_IFLOW
;
411 state
.termios
.c_cflag
&= ~CRTS_IFLOW
;
414 state
.termios
.c_cc
[VMIN
] = 0;
415 state
.termios
.c_cc
[VTIME
] = 0;
419 state
.termio
.c_iflag
= 0;
420 state
.termio
.c_oflag
= 0;
421 state
.termio
.c_lflag
= 0;
422 state
.termio
.c_cflag
&= ~(CSIZE
| PARENB
);
423 state
.termio
.c_cflag
|= CLOCAL
| CS8
;
424 state
.termio
.c_cc
[VMIN
] = 0;
425 state
.termio
.c_cc
[VTIME
] = 0;
429 state
.sgttyb
.sg_flags
|= RAW
| ANYP
;
430 state
.sgttyb
.sg_flags
&= ~(CBREAK
| ECHO
);
433 scb
->current_timeout
= 0;
435 if (set_tty_state (scb
, &state
))
436 fprintf_unfiltered (gdb_stderr
, "set_tty_state failed: %s\n",
437 safe_strerror (errno
));
440 /* Wait for input on scb, with timeout seconds. Returns 0 on success,
441 otherwise SERIAL_TIMEOUT or SERIAL_ERROR.
443 For termio{s}, we actually just setup VTIME if necessary, and let the
444 timeout occur in the read() in hardwire_read(). */
446 /* FIXME: cagney/1999-09-16: Don't replace this with the equivalent
447 ser_base*() until the old TERMIOS/SGTTY/... timer code has been
450 /* NOTE: cagney/1999-09-30: Much of the code below is dead. The only
451 possible values of the TIMEOUT parameter are ONE and ZERO.
452 Consequently all the code that tries to handle the possability of
453 an overflowed timer is unnecessary. */
456 wait_for (struct serial
*scb
, int timeout
)
465 /* NOTE: Some OS's can scramble the READFDS when the select()
466 call fails (ex the kernel with Red Hat 5.2). Initialize all
467 arguments before each call. */
473 FD_SET (scb
->fd
, &readfds
);
476 numfds
= gdb_select (scb
->fd
+ 1, &readfds
, 0, 0, &tv
);
478 numfds
= gdb_select (scb
->fd
+ 1, &readfds
, 0, 0, 0);
482 return SERIAL_TIMEOUT
;
483 else if (errno
== EINTR
)
486 return SERIAL_ERROR
; /* Got an error from select or poll. */
490 #endif /* HAVE_SGTTY */
492 #if defined HAVE_TERMIO || defined HAVE_TERMIOS
493 if (timeout
== scb
->current_timeout
)
496 scb
->current_timeout
= timeout
;
499 struct hardwire_ttystate state
;
501 if (get_tty_state (scb
, &state
))
502 fprintf_unfiltered (gdb_stderr
, "get_tty_state failed: %s\n",
503 safe_strerror (errno
));
509 state
.termios
.c_cc
[VTIME
] = 0;
510 state
.termios
.c_cc
[VMIN
] = 1;
514 state
.termios
.c_cc
[VMIN
] = 0;
515 state
.termios
.c_cc
[VTIME
] = timeout
* 10;
516 if (state
.termios
.c_cc
[VTIME
] != timeout
* 10)
519 /* If c_cc is an 8-bit signed character, we can't go
520 bigger than this. If it is always unsigned, we could use
523 scb
->current_timeout
= 12;
524 state
.termios
.c_cc
[VTIME
] = scb
->current_timeout
* 10;
525 scb
->timeout_remaining
= timeout
- scb
->current_timeout
;
534 state
.termio
.c_cc
[VTIME
] = 0;
535 state
.termio
.c_cc
[VMIN
] = 1;
539 state
.termio
.c_cc
[VMIN
] = 0;
540 state
.termio
.c_cc
[VTIME
] = timeout
* 10;
541 if (state
.termio
.c_cc
[VTIME
] != timeout
* 10)
543 /* If c_cc is an 8-bit signed character, we can't go
544 bigger than this. If it is always unsigned, we could use
547 scb
->current_timeout
= 12;
548 state
.termio
.c_cc
[VTIME
] = scb
->current_timeout
* 10;
549 scb
->timeout_remaining
= timeout
- scb
->current_timeout
;
554 if (set_tty_state (scb
, &state
))
555 fprintf_unfiltered (gdb_stderr
, "set_tty_state failed: %s\n",
556 safe_strerror (errno
));
560 #endif /* HAVE_TERMIO || HAVE_TERMIOS */
563 /* Read a character with user-specified timeout. TIMEOUT is number of
564 seconds to wait, or -1 to wait forever. Use timeout of 0 to effect
565 a poll. Returns char if successful. Returns SERIAL_TIMEOUT if
566 timeout expired, EOF if line dropped dead, or SERIAL_ERROR for any
567 other error (see errno in that case). */
569 /* FIXME: cagney/1999-09-16: Don't replace this with the equivalent
570 ser_base*() until the old TERMIOS/SGTTY/... timer code has been
573 /* NOTE: cagney/1999-09-16: This function is not identical to
574 ser_base_readchar() as part of replacing it with ser_base*()
575 merging will be required - this code handles the case where read()
576 times out due to no data while ser_base_readchar() doesn't expect
580 do_hardwire_readchar (struct serial
*scb
, int timeout
)
588 /* We have to be able to keep the GUI alive here, so we break the
589 original timeout into steps of 1 second, running the "keep the
590 GUI alive" hook each time through the loop.
592 Also, timeout = 0 means to poll, so we just set the delta to 0,
593 so we will only go through the loop once. */
595 delta
= (timeout
== 0 ? 0 : 1);
599 /* N.B. The UI may destroy our world (for instance by calling
600 remote_stop,) in which case we want to get out of here as
601 quickly as possible. It is not safe to touch scb, since
602 someone else might have freed it. The
603 deprecated_ui_loop_hook signals that we should exit by
606 if (deprecated_ui_loop_hook
)
607 detach
= deprecated_ui_loop_hook (0);
610 return SERIAL_TIMEOUT
;
612 scb
->timeout_remaining
= (timeout
< 0 ? timeout
: timeout
- delta
);
613 status
= wait_for (scb
, delta
);
618 status
= read (scb
->fd
, scb
->buf
, BUFSIZ
);
624 /* Zero characters means timeout (it could also be EOF, but
625 we don't (yet at least) distinguish). */
626 if (scb
->timeout_remaining
> 0)
628 timeout
= scb
->timeout_remaining
;
631 else if (scb
->timeout_remaining
< 0)
634 return SERIAL_TIMEOUT
;
636 else if (errno
== EINTR
)
639 return SERIAL_ERROR
; /* Got an error from read. */
642 scb
->bufcnt
= status
;
644 scb
->bufp
= scb
->buf
;
650 hardwire_readchar (struct serial
*scb
, int timeout
)
652 return generic_readchar (scb
, timeout
, do_hardwire_readchar
);
664 /* Translate baud rates from integers to damn B_codes. Unix should
665 have outgrown this crap years ago, but even POSIX wouldn't buck it. */
765 rate_to_code (int rate
)
769 for (i
= 0; baudtab
[i
].rate
!= -1; i
++)
771 /* test for perfect macth. */
772 if (rate
== baudtab
[i
].rate
)
773 return baudtab
[i
].code
;
776 /* check if it is in between valid values. */
777 if (rate
< baudtab
[i
].rate
)
781 warning (_("Invalid baud rate %d. "
782 "Closest values are %d and %d."),
783 rate
, baudtab
[i
- 1].rate
, baudtab
[i
].rate
);
787 warning (_("Invalid baud rate %d. Minimum value is %d."),
788 rate
, baudtab
[0].rate
);
795 /* The requested speed was too large. */
796 warning (_("Invalid baud rate %d. Maximum value is %d."),
797 rate
, baudtab
[i
- 1].rate
);
802 hardwire_setbaudrate (struct serial
*scb
, int rate
)
804 struct hardwire_ttystate state
;
805 int baud_code
= rate_to_code (rate
);
809 /* The baud rate was not valid.
810 A warning has already been issued. */
815 if (get_tty_state (scb
, &state
))
819 cfsetospeed (&state
.termios
, baud_code
);
820 cfsetispeed (&state
.termios
, baud_code
);
828 state
.termio
.c_cflag
&= ~(CBAUD
| CIBAUD
);
829 state
.termio
.c_cflag
|= baud_code
;
833 state
.sgttyb
.sg_ispeed
= baud_code
;
834 state
.sgttyb
.sg_ospeed
= baud_code
;
837 return set_tty_state (scb
, &state
);
841 hardwire_setstopbits (struct serial
*scb
, int num
)
843 struct hardwire_ttystate state
;
846 if (get_tty_state (scb
, &state
))
851 case SERIAL_1_STOPBITS
:
854 case SERIAL_1_AND_A_HALF_STOPBITS
:
855 case SERIAL_2_STOPBITS
:
864 state
.termios
.c_cflag
&= ~CSTOPB
;
866 state
.termios
.c_cflag
|= CSTOPB
; /* two bits */
871 state
.termio
.c_cflag
&= ~CSTOPB
;
873 state
.termio
.c_cflag
|= CSTOPB
; /* two bits */
877 return 0; /* sgtty doesn't support this */
880 return set_tty_state (scb
, &state
);
884 hardwire_close (struct serial
*scb
)
895 _initialize_ser_hardwire (void)
897 struct serial_ops
*ops
= XMALLOC (struct serial_ops
);
899 memset (ops
, 0, sizeof (struct serial_ops
));
900 ops
->name
= "hardwire";
902 ops
->open
= hardwire_open
;
903 ops
->close
= hardwire_close
;
904 /* FIXME: Don't replace this with the equivalent ser_base*() until
905 the old TERMIOS/SGTTY/... timer code has been flushed. cagney
907 ops
->readchar
= hardwire_readchar
;
908 ops
->write
= ser_base_write
;
909 ops
->flush_output
= hardwire_flush_output
;
910 ops
->flush_input
= hardwire_flush_input
;
911 ops
->send_break
= hardwire_send_break
;
912 ops
->go_raw
= hardwire_raw
;
913 ops
->get_tty_state
= hardwire_get_tty_state
;
914 ops
->set_tty_state
= hardwire_set_tty_state
;
915 ops
->print_tty_state
= hardwire_print_tty_state
;
916 ops
->noflush_set_tty_state
= hardwire_noflush_set_tty_state
;
917 ops
->setbaudrate
= hardwire_setbaudrate
;
918 ops
->setstopbits
= hardwire_setstopbits
;
919 ops
->drain_output
= hardwire_drain_output
;
920 ops
->async
= ser_base_async
;
921 ops
->read_prim
= ser_unix_read_prim
;
922 ops
->write_prim
= ser_unix_write_prim
;
923 serial_add_interface (ops
);
927 add_setshow_boolean_cmd ("remoteflow", no_class
,
929 Set use of hardware flow control for remote serial I/O."), _("\
930 Show use of hardware flow control for remote serial I/O."), _("\
931 Enable or disable hardware flow control (RTS/CTS) on the serial port\n\
932 when debugging using remote targets."),
935 &setlist
, &showlist
);
941 ser_unix_read_prim (struct serial
*scb
, size_t count
)
947 status
= read (scb
->fd
, scb
->buf
, count
);
948 if (status
!= -1 || errno
!= EINTR
)
955 ser_unix_write_prim (struct serial
*scb
, const void *buf
, size_t len
)
957 /* ??? Historically, GDB has not retried calls to "write" that
959 return write (scb
->fd
, buf
, len
);