2003-02-19 Andrew Cagney <ac131313@redhat.com>

[deliverable/binutils-gdb.git] / gdb / serial.c

diff --git a/gdb/serial.c b/gdb/serial.c
index e33e2ef72d24db16f229c0beaca381909e371710..ada5631dce939fc0bb2e5f2c40215716afc68660 100644 (file)
--- a/gdb/serial.c
+++ b/gdb/serial.c
@@ -1,5 +1,7 @@
 /* Generic serial interface routines
 /* Generic serial interface routines

-   Copyright 1992, 1993, 1996, 1997, 1999 Free Software Foundation, Inc.
+
+   Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
+   2001, 2002 Free Software Foundation, Inc.

 
    This file is part of GDB.
 
 
    This file is part of GDB.
 


@@ -36,29 +38,28 @@ static struct serial_ops *serial_ops_list = NULL;
 
 /* This is the last serial stream opened.  Used by connect command. */
 
 
 /* This is the last serial stream opened.  Used by connect command. */
 

-static serial_t last_serial_opened = NULL;
+static struct serial *last_serial_opened = NULL;

 
 /* Pointer to list of scb's. */
 
 
 /* Pointer to list of scb's. */
 

-static serial_t scb_base;
+static struct serial *scb_base;

 
 /* Non-NULL gives filename which contains a recording of the remote session,
    suitable for playback by gdbserver. */
 
 static char *serial_logfile = NULL;
 
 /* Non-NULL gives filename which contains a recording of the remote session,
    suitable for playback by gdbserver. */
 
 static char *serial_logfile = NULL;

-static GDB_FILE *serial_logfp = NULL;
+static struct ui_file *serial_logfp = NULL;

 
 static struct serial_ops *serial_interface_lookup (char *);
 
 static struct serial_ops *serial_interface_lookup (char *);

-static void serial_logchar (struct gdb_file *stream, int ch_type, int ch, int timeout);
-static char logbase_hex[] = "hex";
-static char logbase_octal[] = "octal";
-static char logbase_ascii[] = "ascii";
-static char *logbase_enums[] =
+static void serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout);
+static const char logbase_hex[] = "hex";
+static const char logbase_octal[] = "octal";
+static const char logbase_ascii[] = "ascii";
+static const char *logbase_enums[] =

 {logbase_hex, logbase_octal, logbase_ascii, NULL};
 {logbase_hex, logbase_octal, logbase_ascii, NULL};

-static char *serial_logbase = logbase_ascii;
+static const char *serial_logbase = logbase_ascii;

 \f
 
 \f
 

-

 static int serial_current_type = 0;
 
 /* Log char CH of type CHTYPE, with TIMEOUT */
 static int serial_current_type = 0;
 
 /* Log char CH of type CHTYPE, with TIMEOUT */


@@ -68,7 +69,7 @@ static int serial_current_type = 0;
 #define SERIAL_BREAK 1235
 
 static void
 #define SERIAL_BREAK 1235
 
 static void

-serial_logchar (struct gdb_file *stream, int ch_type, int ch, int timeout)
+serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout)

 {
   if (ch_type != serial_current_type)
     {
 {
   if (ch_type != serial_current_type)
     {


@@ -167,10 +168,10 @@ serial_add_interface (struct serial_ops *optable)
 
 /* Open up a device or a network socket, depending upon the syntax of NAME. */
 
 
 /* Open up a device or a network socket, depending upon the syntax of NAME. */
 

-serial_t
+struct serial *

 serial_open (const char *name)
 {
 serial_open (const char *name)
 {

-  serial_t scb;
+  struct serial *scb;

   struct serial_ops *ops;
   const char *open_name = name;
 
   struct serial_ops *ops;
   const char *open_name = name;
 


@@ -181,9 +182,7 @@ serial_open (const char *name)
        return scb;
       }
 
        return scb;
       }
 

-  if (strcmp (name, "ocd") == 0)
-    ops = serial_interface_lookup ("ocd");
-  else if (strcmp (name, "pc") == 0)
+  if (strcmp (name, "pc") == 0)

     ops = serial_interface_lookup ("pc");
   else if (strchr (name, ':'))
     ops = serial_interface_lookup ("tcp");
     ops = serial_interface_lookup ("pc");
   else if (strchr (name, ':'))
     ops = serial_interface_lookup ("tcp");


@@ -200,7 +199,7 @@ serial_open (const char *name)
   if (!ops)
     return NULL;
 
   if (!ops)
     return NULL;
 

-  scb = (serial_t) xmalloc (sizeof (struct _serial_t));
+  scb = XMALLOC (struct serial);

 
   scb->ops = ops;
 
 
   scb->ops = ops;
 


@@ -209,11 +208,11 @@ serial_open (const char *name)
 
   if (scb->ops->open (scb, open_name))
     {
 
   if (scb->ops->open (scb, open_name))
     {

-      free (scb);
+      xfree (scb);

       return NULL;
     }
 
       return NULL;
     }
 

-  scb->name = strsave (name);
+  scb->name = xstrdup (name);

   scb->next = scb_base;
   scb->refcnt = 1;
   scb->debug_p = 0;
   scb->next = scb_base;
   scb->refcnt = 1;
   scb->debug_p = 0;


@@ -234,10 +233,10 @@ serial_open (const char *name)
   return scb;
 }
 
   return scb;
 }
 

-serial_t
+struct serial *

 serial_fdopen (const int fd)
 {
 serial_fdopen (const int fd)
 {

-  serial_t scb;
+  struct serial *scb;

   struct serial_ops *ops;
 
   for (scb = scb_base; scb; scb = scb->next)
   struct serial_ops *ops;
 
   for (scb = scb_base; scb; scb = scb->next)


@@ -252,7 +251,7 @@ serial_fdopen (const int fd)
   if (!ops)
     return NULL;
 
   if (!ops)
     return NULL;
 

-  scb = (serial_t) xmalloc (sizeof (struct _serial_t));
+  scb = XMALLOC (struct serial);

 
   scb->ops = ops;
 
 
   scb->ops = ops;
 


@@ -276,9 +275,9 @@ serial_fdopen (const int fd)
 }
 
 static void
 }
 
 static void

-do_serial_close (serial_t scb, int really_close)
+do_serial_close (struct serial *scb, int really_close)

 {
 {

-  serial_t tmp_scb;
+  struct serial *tmp_scb;

 
   last_serial_opened = NULL;
 
 
   last_serial_opened = NULL;
 


@@ -288,7 +287,7 @@ do_serial_close (serial_t scb, int really_close)
       serial_current_type = 0;
 
       /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */
       serial_current_type = 0;
 
       /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */

-      gdb_file_delete (serial_logfp);
+      ui_file_delete (serial_logfp);

       serial_logfp = NULL;
     }
 
       serial_logfp = NULL;
     }
 


@@ -310,7 +309,7 @@ do_serial_close (serial_t scb, int really_close)
     scb->ops->close (scb);
 
   if (scb->name)
     scb->ops->close (scb);
 
   if (scb->name)

-    free (scb->name);
+    xfree (scb->name);

 
   if (scb_base == scb)
     scb_base = scb_base->next;
 
   if (scb_base == scb)
     scb_base = scb_base->next;


@@ -324,30 +323,31 @@ do_serial_close (serial_t scb, int really_close)
        break;
       }
 
        break;
       }
 

-  free (scb);
+  xfree (scb);

 }
 
 void
 }
 
 void

-serial_close (serial_t scb)
+serial_close (struct serial *scb)

 {
   do_serial_close (scb, 1);
 }
 
 void
 {
   do_serial_close (scb, 1);
 }
 
 void

-serial_un_fdopen (serial_t scb)
+serial_un_fdopen (struct serial *scb)

 {
   do_serial_close (scb, 0);
 }
 
 int
 {
   do_serial_close (scb, 0);
 }
 
 int

-serial_readchar (serial_t scb, int timeout)
+serial_readchar (struct serial *scb, int timeout)

 {
   int ch;
 
   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
      code is finished. */
 {
   int ch;
 
   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
      code is finished. */

-  if (0 && SERIAL_IS_ASYNC_P (scb) && timeout < 0)
-    internal_error ("serial_readchar: blocking read in async mode");
+  if (0 && serial_is_async_p (scb) && timeout < 0)
+    internal_error (__FILE__, __LINE__,
+                   "serial_readchar: blocking read in async mode");

 
   ch = scb->ops->readchar (scb, timeout);
   if (serial_logfp != NULL)
 
   ch = scb->ops->readchar (scb, timeout);
   if (serial_logfp != NULL)


@@ -358,7 +358,7 @@ serial_readchar (serial_t scb, int timeout)
          in case we are getting ready to dump core or something. */
       gdb_flush (serial_logfp);
     }
          in case we are getting ready to dump core or something. */
       gdb_flush (serial_logfp);
     }

-  if (SERIAL_DEBUG_P (scb))
+  if (serial_debug_p (scb))

     {
       fprintf_unfiltered (gdb_stdlog, "[");
       serial_logchar (gdb_stdlog, 'r', ch, timeout);
     {
       fprintf_unfiltered (gdb_stdlog, "[");
       serial_logchar (gdb_stdlog, 'r', ch, timeout);


@@ -370,7 +370,7 @@ serial_readchar (serial_t scb, int timeout)
 }
 
 int
 }
 
 int

-serial_write (serial_t scb, const char *str, int len)
+serial_write (struct serial *scb, const char *str, int len)

 {
   if (serial_logfp != NULL)
     {
 {
   if (serial_logfp != NULL)
     {


@@ -388,39 +388,39 @@ serial_write (serial_t scb, const char *str, int len)
 }
 
 void
 }
 
 void

-serial_printf (serial_t desc, const char *format,...)
+serial_printf (struct serial *desc, const char *format,...)

 {
   va_list args;
   char *buf;
   va_start (args, format);
 
 {
   va_list args;
   char *buf;
   va_start (args, format);
 

-  vasprintf (&buf, format, args);
-  SERIAL_WRITE (desc, buf, strlen (buf));
+  xvasprintf (&buf, format, args);
+  serial_write (desc, buf, strlen (buf));

 
 

-  free (buf);
+  xfree (buf);

   va_end (args);
 }
 
 int
   va_end (args);
 }
 
 int

-serial_drain_output (serial_t scb)
+serial_drain_output (struct serial *scb)

 {
   return scb->ops->drain_output (scb);
 }
 
 int
 {
   return scb->ops->drain_output (scb);
 }
 
 int

-serial_flush_output (serial_t scb)
+serial_flush_output (struct serial *scb)

 {
   return scb->ops->flush_output (scb);
 }
 
 int
 {
   return scb->ops->flush_output (scb);
 }
 
 int

-serial_flush_input (serial_t scb)
+serial_flush_input (struct serial *scb)

 {
   return scb->ops->flush_input (scb);
 }
 
 int
 {
   return scb->ops->flush_input (scb);
 }
 
 int

-serial_send_break (serial_t scb)
+serial_send_break (struct serial *scb)

 {
   if (serial_logfp != NULL)
     serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);
 {
   if (serial_logfp != NULL)
     serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);


@@ -429,33 +429,33 @@ serial_send_break (serial_t scb)
 }
 
 void
 }
 
 void

-serial_raw (serial_t scb)
+serial_raw (struct serial *scb)

 {
   scb->ops->go_raw (scb);
 }
 
 serial_ttystate
 {
   scb->ops->go_raw (scb);
 }
 
 serial_ttystate

-serial_get_tty_state (serial_t scb)
+serial_get_tty_state (struct serial *scb)

 {
   return scb->ops->get_tty_state (scb);
 }
 
 int
 {
   return scb->ops->get_tty_state (scb);
 }
 
 int

-serial_set_tty_state (serial_t scb, serial_ttystate ttystate)
+serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)

 {
   return scb->ops->set_tty_state (scb, ttystate);
 }
 
 void
 {
   return scb->ops->set_tty_state (scb, ttystate);
 }
 
 void

-serial_print_tty_state (serial_t scb,
+serial_print_tty_state (struct serial *scb,

                        serial_ttystate ttystate,
                        serial_ttystate ttystate,

-                       struct gdb_file *stream)
+                       struct ui_file *stream)

 {
   scb->ops->print_tty_state (scb, ttystate, stream);
 }
 
 int
 {
   scb->ops->print_tty_state (scb, ttystate, stream);
 }
 
 int

-serial_noflush_set_tty_state (serial_t scb,
+serial_noflush_set_tty_state (struct serial *scb,

                              serial_ttystate new_ttystate,
                              serial_ttystate old_ttystate)
 {
                              serial_ttystate new_ttystate,
                              serial_ttystate old_ttystate)
 {


@@ -463,31 +463,31 @@ serial_noflush_set_tty_state (serial_t scb,
 }
 
 int
 }
 
 int

-serial_setbaudrate (serial_t scb, int rate)
+serial_setbaudrate (struct serial *scb, int rate)

 {
   return scb->ops->setbaudrate (scb, rate);
 }
 
 int
 {
   return scb->ops->setbaudrate (scb, rate);
 }
 
 int

-serial_setstopbits (serial_t scb, int num)
+serial_setstopbits (struct serial *scb, int num)

 {
   return scb->ops->setstopbits (scb, num);
 }
 
 int
 {
   return scb->ops->setstopbits (scb, num);
 }
 
 int

-serial_can_async_p (serial_t scb)
+serial_can_async_p (struct serial *scb)

 {
   return (scb->ops->async != NULL);
 }
 
 int
 {
   return (scb->ops->async != NULL);
 }
 
 int

-serial_is_async_p (serial_t scb)
+serial_is_async_p (struct serial *scb)

 {
   return (scb->ops->async != NULL) && (scb->async_handler != NULL);
 }
 
 void
 {
   return (scb->ops->async != NULL) && (scb->async_handler != NULL);
 }
 
 void

-serial_async (serial_t scb,
+serial_async (struct serial *scb,

              serial_event_ftype *handler,
              void *context)
 {
              serial_event_ftype *handler,
              void *context)
 {


@@ -500,35 +500,35 @@ serial_async (serial_t scb,
 }
 
 int
 }
 
 int

-deprecated_serial_fd (serial_t scb)
+deprecated_serial_fd (struct serial *scb)

 {
   /* FIXME: should this output a warning that deprecated code is being
      called? */
   if (scb->fd < 0)
     {
 {
   /* FIXME: should this output a warning that deprecated code is being
      called? */
   if (scb->fd < 0)
     {

-      internal_error ("serial: FD not valid");
+      internal_error (__FILE__, __LINE__,
+                     "serial: FD not valid");

     }
   return scb->fd; /* sigh */
 }
 
 void
     }
   return scb->fd; /* sigh */
 }
 
 void

-serial_debug (serial_t scb, int debug_p)
+serial_debug (struct serial *scb, int debug_p)

 {
   scb->debug_p = debug_p;
 }
 
 int
 {
   scb->debug_p = debug_p;
 }
 
 int

-serial_debug_p (serial_t scb)
+serial_debug_p (struct serial *scb)

 {
   return scb->debug_p || global_serial_debug_p;
 }
 
 
 #if 0
 {
   return scb->debug_p || global_serial_debug_p;
 }
 
 
 #if 0

-/*
-   The connect command is #if 0 because I hadn't thought of an elegant
-   way to wait for I/O on two serial_t's simultaneously.  Two solutions
-   came to mind:
+/* The connect command is #if 0 because I hadn't thought of an elegant
+   way to wait for I/O on two `struct serial *'s simultaneously.  Two
+   solutions came to mind:

 
    1) Fork, and have have one fork handle the to user direction,
    and have the other hand the to target direction.  This
 
    1) Fork, and have have one fork handle the to user direction,
    and have the other hand the to target direction.  This


@@ -538,21 +538,20 @@ serial_debug_p (serial_t scb)
    the target side can both be waited on via the same
    mechanism.  This may not be true for DOS, if GDB is
    talking to the target via a TCP socket.
    the target side can both be waited on via the same
    mechanism.  This may not be true for DOS, if GDB is
    talking to the target via a TCP socket.

-   -grossman, 8 Jun 93
- */
+   -grossman, 8 Jun 93 */

 
 /* Connect the user directly to the remote system.  This command acts just like
    the 'cu' or 'tip' command.  Use <CR>~. or <CR>~^D to break out.  */
 
 
 /* Connect the user directly to the remote system.  This command acts just like
    the 'cu' or 'tip' command.  Use <CR>~. or <CR>~^D to break out.  */
 

-static serial_t tty_desc;      /* Controlling terminal */
+static struct serial *tty_desc;        /* Controlling terminal */

 
 static void
 cleanup_tty (serial_ttystate ttystate)
 {
   printf_unfiltered ("\r\n[Exiting connect mode]\r\n");
 
 static void
 cleanup_tty (serial_ttystate ttystate)
 {
   printf_unfiltered ("\r\n[Exiting connect mode]\r\n");

-  SERIAL_SET_TTY_STATE (tty_desc, ttystate);
-  free (ttystate);
-  SERIAL_CLOSE (tty_desc);
+  serial_set_tty_state (tty_desc, ttystate);
+  xfree (ttystate);
+  serial_close (tty_desc);

 }
 
 static void
 }
 
 static void


@@ -561,7 +560,7 @@ connect_command (char *args, int fromtty)
   int c;
   char cur_esc = 0;
   serial_ttystate ttystate;
   int c;
   char cur_esc = 0;
   serial_ttystate ttystate;

-  serial_t port_desc;          /* TTY port */
+  struct serial *port_desc;            /* TTY port */

 
   dont_repeat ();
 
 
   dont_repeat ();
 


@@ -570,13 +569,13 @@ connect_command (char *args, int fromtty)
 
   printf_unfiltered ("[Entering connect mode.  Use ~. or ~^D to escape]\n");
 
 
   printf_unfiltered ("[Entering connect mode.  Use ~. or ~^D to escape]\n");
 

-  tty_desc = SERIAL_FDOPEN (0);
+  tty_desc = serial_fdopen (0);

   port_desc = last_serial_opened;
 
   port_desc = last_serial_opened;
 

-  ttystate = SERIAL_GET_TTY_STATE (tty_desc);
+  ttystate = serial_get_tty_state (tty_desc);

 
 

-  SERIAL_RAW (tty_desc);
-  SERIAL_RAW (port_desc);
+  serial_raw (tty_desc);
+  serial_raw (port_desc);

 
   make_cleanup (cleanup_tty, ttystate);
 
 
   make_cleanup (cleanup_tty, ttystate);
 


@@ -584,7 +583,7 @@ connect_command (char *args, int fromtty)
     {
       int mask;
 
     {
       int mask;
 

-      mask = SERIAL_WAIT_2 (tty_desc, port_desc, -1);
+      mask = serial_wait_2 (tty_desc, port_desc, -1);

 
       if (mask & 2)
        {                       /* tty input */
 
       if (mask & 2)
        {                       /* tty input */


@@ -592,7 +591,7 @@ connect_command (char *args, int fromtty)
 
          while (1)
            {
 
          while (1)
            {

-             c = SERIAL_READCHAR (tty_desc, 0);
+             c = serial_readchar (tty_desc, 0);

 
              if (c == SERIAL_TIMEOUT)
                break;
 
              if (c == SERIAL_TIMEOUT)
                break;


@@ -601,7 +600,7 @@ connect_command (char *args, int fromtty)
                perror_with_name ("connect");
 
              cx = c;
                perror_with_name ("connect");
 
              cx = c;

-             SERIAL_WRITE (port_desc, &cx, 1);
+             serial_write (port_desc, &cx, 1);

 
              switch (cur_esc)
                {
 
              switch (cur_esc)
                {


@@ -630,7 +629,7 @@ connect_command (char *args, int fromtty)
 
          while (1)
            {
 
          while (1)
            {

-             c = SERIAL_READCHAR (port_desc, 0);
+             c = serial_readchar (port_desc, 0);

 
              if (c == SERIAL_TIMEOUT)
                break;
 
              if (c == SERIAL_TIMEOUT)
                break;


@@ -640,13 +639,32 @@ connect_command (char *args, int fromtty)
 
              cx = c;
 
 
              cx = c;
 

-             SERIAL_WRITE (tty_desc, &cx, 1);
+             serial_write (tty_desc, &cx, 1);

            }
        }
     }
 }
 #endif /* 0 */
 
            }
        }
     }
 }
 #endif /* 0 */
 

+/* Serial set/show framework.  */
+
+static struct cmd_list_element *serial_set_cmdlist;
+static struct cmd_list_element *serial_show_cmdlist;
+
+static void
+serial_set_cmd (char *args, int from_tty)
+{
+  printf_unfiltered ("\"set serial\" must be followed by the name of a command.\n");
+  help_list (serial_set_cmdlist, "set serial ", -1, gdb_stdout);
+}
+
+static void
+serial_show_cmd (char *args, int from_tty)
+{
+  cmd_show_list (serial_show_cmdlist, from_tty, "");
+}
+
+

 void
 _initialize_serial (void)
 {
 void
 _initialize_serial (void)
 {


@@ -656,6 +674,18 @@ _initialize_serial (void)
 Use <CR>~. or <CR>~^D to break out.");
 #endif /* 0 */
 
 Use <CR>~. or <CR>~^D to break out.");
 #endif /* 0 */
 

+  add_prefix_cmd ("serial", class_maintenance, serial_set_cmd, "\
+Set default serial/parallel port configuration.",
+                 &serial_set_cmdlist, "set serial ",
+                 0/*allow-unknown*/,
+                 &setlist);
+
+  add_prefix_cmd ("serial", class_maintenance, serial_show_cmd, "\
+Show default serial/parallel port configuration.",
+                 &serial_show_cmdlist, "show serial ",
+                 0/*allow-unknown*/,
+                 &showlist);
+

   add_show_from_set
     (add_set_cmd ("remotelogfile", no_class,
                  var_filename, (char *) &serial_logfile,
   add_show_from_set
     (add_set_cmd ("remotelogfile", no_class,
                  var_filename, (char *) &serial_logfile,


@@ -667,16 +697,16 @@ by gdbserver.",
 
   add_show_from_set
     (add_set_enum_cmd ("remotelogbase", no_class,
 
   add_show_from_set
     (add_set_enum_cmd ("remotelogbase", no_class,

-                      logbase_enums, (char *) &serial_logbase,
+                      logbase_enums, &serial_logbase,

                       "Set numerical base for remote session logging",
                       &setlist),
      &showlist);
 
                       "Set numerical base for remote session logging",
                       &setlist),
      &showlist);
 

-  add_show_from_set (add_set_cmd ("serialdebug",
+  add_show_from_set (add_set_cmd ("serial",

                                  class_maintenance,
                                  var_zinteger,
                                  (char *)&global_serial_debug_p,
                                  "Set serial debugging.\n\
                                  class_maintenance,
                                  var_zinteger,
                                  (char *)&global_serial_debug_p,
                                  "Set serial debugging.\n\

-When non-zero, serial port debugging is enabled.", &setlist),
-                    &showlist);
+When non-zero, serial port debugging is enabled.", &setdebuglist),
+                    &showdebuglist);

 }
 }