1 /* Generic serial interface routines
3 Copyright (C) 1992-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "cli/cli-utils.h"
26 extern void _initialize_serial (void);
28 /* Is serial being debugged? */
30 static unsigned int global_serial_debug_p
;
32 typedef const struct serial_ops
*serial_ops_p
;
33 DEF_VEC_P (serial_ops_p
);
35 /* Serial I/O handlers. */
37 VEC (serial_ops_p
) *serial_ops_list
= NULL
;
39 /* Pointer to list of scb's. */
41 static struct serial
*scb_base
;
43 /* Non-NULL gives filename which contains a recording of the remote session,
44 suitable for playback by gdbserver. */
46 static char *serial_logfile
= NULL
;
47 static struct ui_file
*serial_logfp
= NULL
;
49 static const struct serial_ops
*serial_interface_lookup (const char *);
50 static void serial_logchar (struct ui_file
*stream
,
51 int ch_type
, int ch
, int timeout
);
52 static const char logbase_hex
[] = "hex";
53 static const char logbase_octal
[] = "octal";
54 static const char logbase_ascii
[] = "ascii";
55 static const char *const logbase_enums
[] =
56 {logbase_hex
, logbase_octal
, logbase_ascii
, NULL
};
57 static const char *serial_logbase
= logbase_ascii
;
60 static int serial_current_type
= 0;
62 /* Log char CH of type CHTYPE, with TIMEOUT. */
64 /* Define bogus char to represent a BREAK. Should be careful to choose a value
65 that can't be confused with a normal char, or an error code. */
66 #define SERIAL_BREAK 1235
69 serial_logchar (struct ui_file
*stream
, int ch_type
, int ch
, int timeout
)
71 if (ch_type
!= serial_current_type
)
73 fprintf_unfiltered (stream
, "\n%c ", ch_type
);
74 serial_current_type
= ch_type
;
77 if (serial_logbase
!= logbase_ascii
)
78 fputc_unfiltered (' ', stream
);
83 fprintf_unfiltered (stream
, "<Timeout: %d seconds>", timeout
);
86 fprintf_unfiltered (stream
, "<Error: %s>", safe_strerror (errno
));
89 fputs_unfiltered ("<Eof>", stream
);
92 fputs_unfiltered ("<Break>", stream
);
95 if (serial_logbase
== logbase_hex
)
96 fprintf_unfiltered (stream
, "%02x", ch
& 0xff);
97 else if (serial_logbase
== logbase_octal
)
98 fprintf_unfiltered (stream
, "%03o", ch
& 0xff);
103 fputs_unfiltered ("\\\\", stream
);
106 fputs_unfiltered ("\\b", stream
);
109 fputs_unfiltered ("\\f", stream
);
112 fputs_unfiltered ("\\n", stream
);
115 fputs_unfiltered ("\\r", stream
);
118 fputs_unfiltered ("\\t", stream
);
121 fputs_unfiltered ("\\v", stream
);
124 fprintf_unfiltered (stream
,
125 isprint (ch
) ? "%c" : "\\x%02x", ch
& 0xFF);
132 serial_log_command (struct target_ops
*self
, const char *cmd
)
137 serial_current_type
= 'c';
139 fputs_unfiltered ("\nc ", serial_logfp
);
140 fputs_unfiltered (cmd
, serial_logfp
);
142 /* Make sure that the log file is as up-to-date as possible,
143 in case we are getting ready to dump core or something. */
144 gdb_flush (serial_logfp
);
148 static const struct serial_ops
*
149 serial_interface_lookup (const char *name
)
151 const struct serial_ops
*ops
;
154 for (i
= 0; VEC_iterate (serial_ops_p
, serial_ops_list
, i
, ops
); ++i
)
155 if (strcmp (name
, ops
->name
) == 0)
162 serial_add_interface (const struct serial_ops
*optable
)
164 VEC_safe_push (serial_ops_p
, serial_ops_list
, optable
);
167 /* Return the open serial device for FD, if found, or NULL if FD is
168 not already opened. */
171 serial_for_fd (int fd
)
175 for (scb
= scb_base
; scb
; scb
= scb
->next
)
182 /* Create a new serial for OPS. */
184 static struct serial
*
185 new_serial (const struct serial_ops
*ops
)
189 scb
= XCNEW (struct serial
);
193 scb
->bufp
= scb
->buf
;
200 static struct serial
*serial_open_ops_1 (const struct serial_ops
*ops
,
201 const char *open_name
);
203 /* Open up a device or a network socket, depending upon the syntax of NAME. */
206 serial_open (const char *name
)
209 const struct serial_ops
*ops
;
210 const char *open_name
= name
;
212 if (startswith (name
, "|"))
214 ops
= serial_interface_lookup ("pipe");
215 /* Discard ``|'' and any space before the command itself. */
217 open_name
= skip_spaces_const (open_name
);
219 /* Check for a colon, suggesting an IP address/port pair.
220 Do this *after* checking for all the interesting prefixes. We
221 don't want to constrain the syntax of what can follow them. */
222 else if (strchr (name
, ':'))
223 ops
= serial_interface_lookup ("tcp");
225 ops
= serial_interface_lookup ("hardwire");
230 return serial_open_ops_1 (ops
, open_name
);
233 /* Open up a serial for OPS, passing OPEN_NAME to the open method. */
235 static struct serial
*
236 serial_open_ops_1 (const struct serial_ops
*ops
, const char *open_name
)
240 scb
= new_serial (ops
);
242 /* `...->open (...)' would get expanded by the open(2) syscall macro. */
243 if ((*scb
->ops
->open
) (scb
, open_name
))
249 scb
->next
= scb_base
;
252 if (serial_logfile
!= NULL
)
254 stdio_file_up
file (new stdio_file ());
256 if (!file
->open (serial_logfile
, "w"))
257 perror_with_name (serial_logfile
);
259 serial_logfp
= file
.release ();
268 serial_open_ops (const struct serial_ops
*ops
)
270 return serial_open_ops_1 (ops
, NULL
);
273 /* Open a new serial stream using a file handle, using serial
274 interface ops OPS. */
276 static struct serial
*
277 serial_fdopen_ops (const int fd
, const struct serial_ops
*ops
)
283 ops
= serial_interface_lookup ("terminal");
285 ops
= serial_interface_lookup ("hardwire");
291 scb
= new_serial (ops
);
293 scb
->next
= scb_base
;
296 if ((ops
->fdopen
) != NULL
)
297 (*ops
->fdopen
) (scb
, fd
);
305 serial_fdopen (const int fd
)
307 return serial_fdopen_ops (fd
, NULL
);
311 do_serial_close (struct serial
*scb
, int really_close
)
313 struct serial
*tmp_scb
;
317 fputs_unfiltered ("\nEnd of log\n", serial_logfp
);
318 serial_current_type
= 0;
320 /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */
325 /* ensure that the FD has been taken out of async mode. */
326 if (scb
->async_handler
!= NULL
)
327 serial_async (scb
, NULL
, NULL
);
330 scb
->ops
->close (scb
);
332 /* For serial_is_open. */
336 scb_base
= scb_base
->next
;
338 for (tmp_scb
= scb_base
; tmp_scb
; tmp_scb
= tmp_scb
->next
)
340 if (tmp_scb
->next
!= scb
)
343 tmp_scb
->next
= tmp_scb
->next
->next
;
351 serial_close (struct serial
*scb
)
353 do_serial_close (scb
, 1);
357 serial_un_fdopen (struct serial
*scb
)
359 do_serial_close (scb
, 0);
363 serial_is_open (struct serial
*scb
)
365 return scb
->bufp
!= NULL
;
369 serial_ref (struct serial
*scb
)
375 serial_unref (struct serial
*scb
)
378 if (scb
->refcnt
== 0)
383 serial_readchar (struct serial
*scb
, int timeout
)
387 /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
389 if (0 && serial_is_async_p (scb
) && timeout
< 0)
390 internal_error (__FILE__
, __LINE__
,
391 _("serial_readchar: blocking read in async mode"));
393 ch
= scb
->ops
->readchar (scb
, timeout
);
394 if (serial_logfp
!= NULL
)
396 serial_logchar (serial_logfp
, 'r', ch
, timeout
);
398 /* Make sure that the log file is as up-to-date as possible,
399 in case we are getting ready to dump core or something. */
400 gdb_flush (serial_logfp
);
402 if (serial_debug_p (scb
))
404 fprintf_unfiltered (gdb_stdlog
, "[");
405 serial_logchar (gdb_stdlog
, 'r', ch
, timeout
);
406 fprintf_unfiltered (gdb_stdlog
, "]");
407 gdb_flush (gdb_stdlog
);
414 serial_write (struct serial
*scb
, const void *buf
, size_t count
)
416 if (serial_logfp
!= NULL
)
418 const char *str
= (const char *) buf
;
421 for (c
= 0; c
< count
; c
++)
422 serial_logchar (serial_logfp
, 'w', str
[c
] & 0xff, 0);
424 /* Make sure that the log file is as up-to-date as possible,
425 in case we are getting ready to dump core or something. */
426 gdb_flush (serial_logfp
);
428 if (serial_debug_p (scb
))
430 const char *str
= (const char *) buf
;
433 for (c
= 0; c
< count
; c
++)
435 fprintf_unfiltered (gdb_stdlog
, "[");
436 serial_logchar (gdb_stdlog
, 'w', str
[c
] & 0xff, 0);
437 fprintf_unfiltered (gdb_stdlog
, "]");
439 gdb_flush (gdb_stdlog
);
442 return (scb
->ops
->write (scb
, buf
, count
));
446 serial_printf (struct serial
*desc
, const char *format
,...)
450 va_start (args
, format
);
452 buf
= xstrvprintf (format
, args
);
453 serial_write (desc
, buf
, strlen (buf
));
460 serial_drain_output (struct serial
*scb
)
462 return scb
->ops
->drain_output (scb
);
466 serial_flush_output (struct serial
*scb
)
468 return scb
->ops
->flush_output (scb
);
472 serial_flush_input (struct serial
*scb
)
474 return scb
->ops
->flush_input (scb
);
478 serial_send_break (struct serial
*scb
)
480 if (serial_logfp
!= NULL
)
481 serial_logchar (serial_logfp
, 'w', SERIAL_BREAK
, 0);
483 return (scb
->ops
->send_break (scb
));
487 serial_raw (struct serial
*scb
)
489 scb
->ops
->go_raw (scb
);
493 serial_get_tty_state (struct serial
*scb
)
495 return scb
->ops
->get_tty_state (scb
);
499 serial_copy_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
501 return scb
->ops
->copy_tty_state (scb
, ttystate
);
505 serial_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
507 return scb
->ops
->set_tty_state (scb
, ttystate
);
511 serial_print_tty_state (struct serial
*scb
,
512 serial_ttystate ttystate
,
513 struct ui_file
*stream
)
515 scb
->ops
->print_tty_state (scb
, ttystate
, stream
);
519 serial_noflush_set_tty_state (struct serial
*scb
,
520 serial_ttystate new_ttystate
,
521 serial_ttystate old_ttystate
)
523 return scb
->ops
->noflush_set_tty_state (scb
, new_ttystate
, old_ttystate
);
527 serial_setbaudrate (struct serial
*scb
, int rate
)
529 return scb
->ops
->setbaudrate (scb
, rate
);
533 serial_setstopbits (struct serial
*scb
, int num
)
535 return scb
->ops
->setstopbits (scb
, num
);
541 serial_setparity (struct serial
*scb
, int parity
)
543 return scb
->ops
->setparity (scb
, parity
);
547 serial_can_async_p (struct serial
*scb
)
549 return (scb
->ops
->async
!= NULL
);
553 serial_is_async_p (struct serial
*scb
)
555 return (scb
->ops
->async
!= NULL
) && (scb
->async_handler
!= NULL
);
559 serial_async (struct serial
*scb
,
560 serial_event_ftype
*handler
,
563 int changed
= ((scb
->async_handler
== NULL
) != (handler
== NULL
));
565 scb
->async_handler
= handler
;
566 scb
->async_context
= context
;
567 /* Only change mode if there is a need. */
569 scb
->ops
->async (scb
, handler
!= NULL
);
573 serial_debug (struct serial
*scb
, int debug_p
)
575 scb
->debug_p
= debug_p
;
579 serial_debug_p (struct serial
*scb
)
581 return scb
->debug_p
|| global_serial_debug_p
;
586 serial_wait_handle (struct serial
*scb
, HANDLE
*read
, HANDLE
*except
)
588 if (scb
->ops
->wait_handle
)
589 scb
->ops
->wait_handle (scb
, read
, except
);
592 *read
= (HANDLE
) _get_osfhandle (scb
->fd
);
598 serial_done_wait_handle (struct serial
*scb
)
600 if (scb
->ops
->done_wait_handle
)
601 scb
->ops
->done_wait_handle (scb
);
606 serial_pipe (struct serial
*scbs
[2])
608 const struct serial_ops
*ops
;
611 ops
= serial_interface_lookup ("pipe");
618 if (gdb_pipe (fildes
) == -1)
621 scbs
[0] = serial_fdopen_ops (fildes
[0], ops
);
622 scbs
[1] = serial_fdopen_ops (fildes
[1], ops
);
626 /* Serial set/show framework. */
628 static struct cmd_list_element
*serial_set_cmdlist
;
629 static struct cmd_list_element
*serial_show_cmdlist
;
632 serial_set_cmd (char *args
, int from_tty
)
634 printf_unfiltered ("\"set serial\" must be followed "
635 "by the name of a command.\n");
636 help_list (serial_set_cmdlist
, "set serial ", all_commands
, gdb_stdout
);
640 serial_show_cmd (char *args
, int from_tty
)
642 cmd_show_list (serial_show_cmdlist
, from_tty
, "");
645 /* Baud rate specified for talking to serial target systems. Default
646 is left as -1, so targets can choose their own defaults. */
647 /* FIXME: This means that "show serial baud" and gr_files_info can
648 print -1 or (unsigned int)-1. This is a Bad User Interface. */
653 serial_baud_show_cmd (struct ui_file
*file
, int from_tty
,
654 struct cmd_list_element
*c
, const char *value
)
656 fprintf_filtered (file
, _("Baud rate for remote serial I/O is %s.\n"),
660 /* Parity for serial port. */
662 int serial_parity
= GDBPARITY_NONE
;
664 static const char parity_none
[] = "none";
665 static const char parity_odd
[] = "odd";
666 static const char parity_even
[] = "even";
667 static const char *const parity_enums
[] =
668 {parity_none
, parity_odd
, parity_even
, NULL
};
669 static const char *parity
= parity_none
;
671 /* Set serial_parity value. */
674 set_parity (char *ignore_args
, int from_tty
, struct cmd_list_element
*c
)
676 if (parity
== parity_odd
)
677 serial_parity
= GDBPARITY_ODD
;
678 else if (parity
== parity_even
)
679 serial_parity
= GDBPARITY_EVEN
;
681 serial_parity
= GDBPARITY_NONE
;
685 _initialize_serial (void)
688 add_com ("connect", class_obscure
, connect_command
, _("\
689 Connect the terminal directly up to the command monitor.\n\
690 Use <CR>~. or <CR>~^D to break out."));
693 add_prefix_cmd ("serial", class_maintenance
, serial_set_cmd
, _("\
694 Set default serial/parallel port configuration."),
695 &serial_set_cmdlist
, "set serial ",
699 add_prefix_cmd ("serial", class_maintenance
, serial_show_cmd
, _("\
700 Show default serial/parallel port configuration."),
701 &serial_show_cmdlist
, "show serial ",
705 /* If target is open when baud changes, it doesn't take effect until
706 the next open (I think, not sure). */
707 add_setshow_zinteger_cmd ("baud", no_class
, &baud_rate
, _("\
708 Set baud rate for remote serial I/O."), _("\
709 Show baud rate for remote serial I/O."), _("\
710 This value is used to set the speed of the serial port when debugging\n\
711 using remote targets."),
713 serial_baud_show_cmd
,
714 &serial_set_cmdlist
, &serial_show_cmdlist
);
716 add_setshow_enum_cmd ("parity", no_class
, parity_enums
,
718 Set parity for remote serial I/O"), _("\
719 Show parity for remote serial I/O"), NULL
,
721 NULL
, /* FIXME: i18n: */
722 &serial_set_cmdlist
, &serial_show_cmdlist
);
724 add_setshow_filename_cmd ("remotelogfile", no_class
, &serial_logfile
, _("\
725 Set filename for remote session recording."), _("\
726 Show filename for remote session recording."), _("\
727 This file is used to record the remote session for future playback\n\
730 NULL
, /* FIXME: i18n: */
731 &setlist
, &showlist
);
733 add_setshow_enum_cmd ("remotelogbase", no_class
, logbase_enums
,
734 &serial_logbase
, _("\
735 Set numerical base for remote session logging"), _("\
736 Show numerical base for remote session logging"), NULL
,
738 NULL
, /* FIXME: i18n: */
739 &setlist
, &showlist
);
741 add_setshow_zuinteger_cmd ("serial", class_maintenance
,
742 &global_serial_debug_p
, _("\
743 Set serial debugging."), _("\
744 Show serial debugging."), _("\
745 When non-zero, serial port debugging is enabled."),
747 NULL
, /* FIXME: i18n: */
748 &setdebuglist
, &showdebuglist
);