Allow "tcl_port" to be run after config to simply display the port.

[fw/openocd] / src / server / tcl_server.c

diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c
index a12176eeac647bb716b1efaa75133c33658039e9..b62f1a37e2c99e584e61020f9a13dd0d53fc9206 100644 (file)
--- a/src/server/tcl_server.c
+++ b/src/server/tcl_server.c
@@ -1,5 +1,6 @@
 /***************************************************************************
- *   Copyright (C) 2008                                                    *
+ *   Copyright (C) 2010 Øyvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
@@ -14,7 +15,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -23,18 +24,17 @@
 
 #include "tcl_server.h"
 
-
-#define TCL_SERVER_VERSION     "TCL Server 0.1"
-#define TCL_MAX_LINE           (4096)
+#define TCL_SERVER_VERSION             "TCL Server 0.1"
+#define TCL_MAX_LINE                   (4096)
 
 struct tcl_connection {
        int tc_linedrop;
        int tc_lineoffset;
        char tc_line[TCL_MAX_LINE];
-       int tc_outerror; /* flag an output error */
+       int tc_outerror;/* flag an output error */
 };
 
-static unsigned short tcl_port = 6666;
+static char *tcl_port;
 
 /* handlers */
 static int tcl_new_connection(struct connection *connection);
@@ -56,7 +56,8 @@ int tcl_output(struct connection *connection, const void *data, ssize_t len)
        if (tclc->tc_outerror)
                return ERROR_SERVER_REMOTE_CLOSED;
 
-       wlen = write_socket(connection->fd, data, len);
+       wlen = connection_write(connection, data, len);
+
        if (wlen == len)
                return ERROR_OK;
 
@@ -81,15 +82,16 @@ static int tcl_new_connection(struct connection *connection)
 
 static int tcl_input(struct connection *connection)
 {
+       Jim_Interp *interp = (Jim_Interp *)connection->cmd_ctx->interp;
        int retval;
        int i;
        ssize_t rlen;
        const char *result;
        int reslen;
        struct tcl_connection *tclc;
-       char in[256];
+       unsigned char in[256];
 
-       rlen = read_socket(connection->fd, &in, sizeof(in));
+       rlen = connection_read(connection, &in, sizeof(in));
        if (rlen <= 0) {
                if (rlen < 0)
                        LOG_ERROR("error during read: %s", strerror(errno));
@@ -101,15 +103,7 @@ static int tcl_input(struct connection *connection)
                return ERROR_CONNECTION_REJECTED;
 
        /* push as much data into the line as possible */
-       for (i = 0; i < rlen; i++)
-       {
-               if (!isprint(in[i]) && !isspace(in[i]))
-               {
-                       /* drop this line */
-                       tclc->tc_linedrop = 1;
-                       continue;
-               }
-
+       for (i = 0; i < rlen; i++) {
                /* buffer the data */
                tclc->tc_line[tclc->tc_lineoffset] = in[i];
                if (tclc->tc_lineoffset < TCL_MAX_LINE)
@@ -117,7 +111,11 @@ static int tcl_input(struct connection *connection)
                else
                        tclc->tc_linedrop = 1;
 
-               if (in[i] != '\n')
+               /* ctrl-z is end of command. When testing from telnet, just
+                * press ctrl-z a couple of times first to put telnet into the
+                * mode where it will send 0x1a in response to pressing ctrl-z
+                */
+               if (in[i] != '\x1a')
                        continue;
 
                /* process the line */
@@ -127,16 +125,17 @@ static int tcl_input(struct connection *connection)
                        if (retval != ERROR_OK)
                                return retval;
 #undef ESTR
-               }
-               else {
+               } else {
                        tclc->tc_line[tclc->tc_lineoffset-1] = '\0';
-                       retval = Jim_Eval_Named(interp, tclc->tc_line, "remote:connection",1);
+                       LOG_DEBUG("Executing script:\n %s", tclc->tc_line);
+                       retval = Jim_Eval_Named(interp, tclc->tc_line, "remote:connection", 1);
                        result = Jim_GetString(Jim_GetResult(interp), &reslen);
+                       LOG_DEBUG("Result: %d\n %s", retval, result);
                        retval = tcl_output(connection, result, reslen);
                        if (retval != ERROR_OK)
                                return retval;
-                       if (memchr(result, '\n', reslen) == NULL)
-                               tcl_output(connection, "\n", 1);
+                       /* Always output ctrl-d as end of line to allow multiline results */
+                       tcl_output(connection, "\x1a", 1);
                }
 
                tclc->tc_lineoffset = 0;
@@ -158,27 +157,36 @@ static int tcl_closed(struct connection *connection)
 
 int tcl_init(void)
 {
-       int retval;
-
-       if (tcl_port == 0)
-       {
-               LOG_INFO("tcl port disabled");
+       if (strcmp(tcl_port, "disabled") == 0) {
+               LOG_INFO("tcl server disabled");
                return ERROR_OK;
        }
 
-       retval = add_service("tcl", CONNECTION_TCP, tcl_port, 1, tcl_new_connection, tcl_input, tcl_closed, NULL);
-       return retval;
+       return add_service("tcl", tcl_port, 1,
+               &tcl_new_connection, &tcl_input,
+               &tcl_closed, NULL);
 }
 
 COMMAND_HANDLER(handle_tcl_port_command)
 {
-       return CALL_COMMAND_HANDLER(server_port_command, &tcl_port);
+       return CALL_COMMAND_HANDLER(server_pipe_command, &tcl_port);
 }
 
+static const struct command_registration tcl_command_handlers[] = {
+       {
+               .name = "tcl_port",
+               .handler = handle_tcl_port_command,
+               .mode = COMMAND_ANY,
+               .help = "Specify port on which to listen "
+                       "for incoming Tcl syntax.  "
+                       "Read help on 'gdb_port'.",
+               .usage = "[port_num]",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
 int tcl_register_commands(struct command_context *cmd_ctx)
 {
-       COMMAND_REGISTER(cmd_ctx, NULL, "tcl_port",
-                       handle_tcl_port_command, COMMAND_CONFIG,
-                       "port on which to listen for incoming TCL syntax");
-       return ERROR_OK;
+       tcl_port = strdup("6666");
+       return register_commands(cmd_ctx, NULL, tcl_command_handlers);
 }