X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fserver%2Ftcl_server.c;h=d6828f12aab7da54076666ffb38d43cfad1d6d6f;hp=40a0428d7a8dbac2eabd87b96a0899757caabcc2;hb=1d0cf0df37a4e831ca3121ba8987d5848cad3e42;hpb=98723c4ecdbe06f90c66f3abec27b792c3b38e34 diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c index 40a0428d7a..d6828f12aa 100644 --- 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 @@ -22,19 +23,21 @@ #endif #include "tcl_server.h" +#include - -#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 */ + enum target_state tc_laststate; + bool tc_notify; }; -static unsigned short tcl_port = 6666; +static char *tcl_port; /* handlers */ static int tcl_new_connection(struct connection *connection); @@ -42,6 +45,48 @@ static int tcl_input(struct connection *connection); static int tcl_output(struct connection *connection, const void *buf, ssize_t len); static int tcl_closed(struct connection *connection); +static int tcl_target_callback_event_handler(struct target *target, + enum target_event event, void *priv) +{ + struct connection *connection = priv; + struct tcl_connection *tclc; + char buf[256]; + + tclc = connection->priv; + + if (tclc->tc_notify) { + snprintf(buf, sizeof(buf), "type target_event event %s\r\n\x1a", target_event_name(event)); + tcl_output(connection, buf, strlen(buf)); + } + + if (tclc->tc_laststate != target->state) { + tclc->tc_laststate = target->state; + if (tclc->tc_notify) { + snprintf(buf, sizeof(buf), "type target_state state %s\r\n\x1a", target_state_name(target)); + tcl_output(connection, buf, strlen(buf)); + } + } + + return ERROR_OK; +} + +static int tcl_target_callback_reset_handler(struct target *target, + enum target_reset_mode reset_mode, void *priv) +{ + struct connection *connection = priv; + struct tcl_connection *tclc; + char buf[256]; + + tclc = connection->priv; + + if (tclc->tc_notify) { + snprintf(buf, sizeof(buf), "type target_reset mode %s\r\n\x1a", target_reset_mode_name(reset_mode)); + tcl_output(connection, buf, strlen(buf)); + } + + return ERROR_OK; +} + /* write data out to a socket. * * this is a blocking write, so the return value must equal the length, if @@ -56,7 +101,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; @@ -76,20 +122,32 @@ static int tcl_new_connection(struct connection *connection) memset(tclc, 0, sizeof(struct tcl_connection)); connection->priv = tclc; + + struct target *target = get_current_target(connection->cmd_ctx); + if (target != NULL) + tclc->tc_laststate = target->state; + + /* store the connection object on cmd_ctx so we can access it from command handlers */ + connection->cmd_ctx->output_handler_priv = connection; + + target_register_event_callback(tcl_target_callback_event_handler, connection); + target_register_reset_callback(tcl_target_callback_reset_handler, connection); + return ERROR_OK; } 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 +159,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 +167,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 +181,15 @@ 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); + retval = command_run_line(connection->cmd_ctx, tclc->tc_line); result = Jim_GetString(Jim_GetResult(interp), &reslen); 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; @@ -153,32 +206,69 @@ static int tcl_closed(struct connection *connection) free(connection->priv); connection->priv = NULL; } + + target_unregister_event_callback(tcl_target_callback_event_handler, connection); + target_unregister_reset_callback(tcl_target_callback_reset_handler, connection); + return ERROR_OK; } 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); +} + +COMMAND_HANDLER(handle_tcl_notifications_command) +{ + struct connection *connection = NULL; + struct tcl_connection *tclc = NULL; + + if (CMD_CTX->output_handler_priv != NULL) + connection = CMD_CTX->output_handler_priv; + + if (connection != NULL && !strcmp(connection->service->name, "tcl")) { + tclc = connection->priv; + return CALL_COMMAND_HANDLER(handle_command_parse_bool, &tclc->tc_notify, "Target Notification output is"); + } else { + LOG_ERROR("%s: can only be called from the tcl server", CMD_NAME); + return ERROR_COMMAND_SYNTAX_ERROR; + } } +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]", + }, + { + .name = "tcl_notifications", + .handler = handle_tcl_notifications_command, + .mode = COMMAND_EXEC, + .help = "Target Notification output", + .usage = "[on|off]", + }, + COMMAND_REGISTRATION_DONE +}; + int tcl_register_commands(struct command_context *cmd_ctx) { - register_command(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); }