-/***************************************************************************\r
- * Copyright (C) 2005 by Dominic Rath *\r
- * Dominic.Rath@gmx.de *\r
- * *\r
- * part of this file is taken from libcli (libcli.sourceforge.net) *\r
- * Copyright (C) David Parrish (david@dparrish.com) *\r
- * *\r
- * This program is free software; you can redistribute it and/or modify *\r
- * it under the terms of the GNU General Public License as published by *\r
- * the Free Software Foundation; either version 2 of the License, or *\r
- * (at your option) any later version. *\r
- * *\r
- * This program is distributed in the hope that it will be useful, *\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *\r
- * GNU General Public License for more details. *\r
- * *\r
- * You should have received a copy of the GNU General Public License *\r
- * along with this program; if not, write to the *\r
- * Free Software Foundation, Inc., *\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *\r
- ***************************************************************************/\r
-#ifdef HAVE_CONFIG_H\r
-#include "config.h"\r
-#endif\r
-\r
-#include "replacements.h"\r
-\r
-#include "command.h"\r
-\r
-#include "log.h"\r
-#include "time_support.h"\r
-\r
-#include <stdlib.h>\r
-#include <string.h>\r
-#include <ctype.h>\r
-#include <stdarg.h>\r
-#include <stdio.h>\r
-#include <unistd.h>\r
-\r
-void command_print_help_line(command_context_t* context, struct command_s *command, int indent);\r
-\r
-int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);\r
-int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);\r
-\r
-int build_unique_lengths(command_context_t *context, command_t *commands)\r
-{\r
- command_t *c, *p;\r
-\r
- /* iterate through all commands */\r
- for (c = commands; c; c = c->next)\r
- {\r
- /* find out how many characters are required to uniquely identify a command */\r
- for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)\r
- {\r
- int foundmatch = 0;\r
- \r
- /* for every command, see if the current length is enough */\r
- for (p = commands; p; p = p->next)\r
- {\r
- /* ignore the command itself */\r
- if (c == p)\r
- continue;\r
- \r
- /* compare commands up to the current length */\r
- if (strncmp(p->name, c->name, c->unique_len) == 0)\r
- foundmatch++;\r
- }\r
- \r
- /* when none of the commands matched, we've found the minimum length required */\r
- if (!foundmatch)\r
- break;\r
- }\r
- \r
- /* if the current command has children, build the unique lengths for them */\r
- if (c->children)\r
- build_unique_lengths(context, c->children);\r
- }\r
- \r
- return ERROR_OK;\r
-}\r
-\r
-/* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n). \r
- * Makes a difference on ARM7 types machines and is not observable on GHz machines.\r
- */\r
-static int unique_length_dirty = 1; \r
-\r
-command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)\r
-{\r
- command_t *c, *p;\r
- unique_length_dirty = 1;\r
- \r
- if (!context || !name)\r
- return NULL;\r
- \r
- c = malloc(sizeof(command_t));\r
- \r
- c->name = strdup(name);\r
- c->parent = parent;\r
- c->children = NULL;\r
- c->handler = handler;\r
- c->mode = mode;\r
- if (help)\r
- c->help = strdup(help);\r
- else\r
- c->help = NULL;\r
- c->unique_len = 0;\r
- c->next = NULL;\r
- \r
- /* place command in tree */\r
- if (parent)\r
- {\r
- if (parent->children)\r
- {\r
- /* find last child */\r
- for (p = parent->children; p && p->next; p = p->next);\r
- if (p)\r
- p->next = c;\r
- }\r
- else\r
- {\r
- parent->children = c;\r
- }\r
- }\r
- else\r
- {\r
- if (context->commands)\r
- {\r
- /* find last command */\r
- for (p = context->commands; p && p->next; p = p->next);\r
- if (p)\r
- p->next = c;\r
- }\r
- else\r
- {\r
- context->commands = c;\r
- }\r
- }\r
- \r
- return c;\r
-}\r
-\r
-int unregister_command(command_context_t *context, char *name)\r
-{\r
- unique_length_dirty = 1;\r
- \r
- command_t *c, *p = NULL, *c2;\r
- \r
- if ((!context) || (!name))\r
- return ERROR_INVALID_ARGUMENTS;\r
- \r
- /* find command */\r
- for (c = context->commands; c; c = c->next)\r
- {\r
- if (strcmp(name, c->name) == 0)\r
- {\r
- /* unlink command */\r
- if (p)\r
- {\r
- p->next = c->next;\r
- }\r
- else\r
- {\r
- context->commands = c->next;\r
- }\r
- \r
- /* unregister children */\r
- if (c->children)\r
- {\r
- for (c2 = c->children; c2; c2 = c2->next)\r
- {\r
- free(c2->name);\r
- if (c2->help)\r
- free(c2->help);\r
- free(c2);\r
- }\r
- }\r
- \r
- /* delete command */\r
- free(c->name);\r
- if (c->help)\r
- free(c->help);\r
- free(c);\r
- }\r
- \r
- /* remember the last command for unlinking */\r
- p = c;\r
- }\r
- \r
- return ERROR_OK;\r
-}\r
-\r
-int parse_line(char *line, char *words[], int max_words)\r
-{\r
- int nwords = 0;\r
- char *p = line;\r
- char *word_start = line;\r
- int inquote = 0;\r
-\r
- while (nwords < max_words - 1)\r
- {\r
- /* check if we reached\r
- * a terminating NUL\r
- * a matching closing quote character " or '\r
- * we're inside a word but not a quote, and the current character is whitespace\r
- */\r
- if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))\r
- {\r
- /* we're inside a word or quote, and reached its end*/\r
- if (word_start)\r
- {\r
- int len;\r
- char *word_end=p;\r
- \r
- /* This will handle extra whitespace within quotes */\r
- while (isspace(*word_start)&&(word_start<word_end))\r
- word_start++;\r
- while (isspace(*(word_end-1))&&(word_start<word_end))\r
- word_end--;\r
- len = word_end - word_start;\r
- \r
- if (len>0)\r
- {\r
- /* copy the word */\r
- memcpy(words[nwords] = malloc(len + 1), word_start, len);\r
- /* add terminating NUL */\r
- words[nwords++][len] = 0;\r
- }\r
- }\r
- /* we're done parsing the line */\r
- if (!*p)\r
- break;\r
-\r
- /* skip over trailing quote or whitespace*/\r
- if (inquote || isspace(*p))\r
- p++;\r
- while (isspace(*p))\r
- p++;\r
- \r
- inquote = 0;\r
- word_start = 0;\r
- }\r
- else if (*p == '"' || *p == '\'')\r
- {\r
- /* we've reached the beginning of a quote */\r
- inquote = *p++;\r
- word_start = p;\r
- }\r
- else\r
- {\r
- /* we've reached the beginning of a new word */\r
- if (!word_start)\r
- word_start = p;\r
- \r
- /* normal character, skip */\r
- p++;\r
- }\r
- }\r
- \r
- return nwords;\r
-}\r
-\r
-void command_print(command_context_t *context, char *format, ...)\r
-{\r
- char *buffer = NULL;\r
- int n, size = 0;\r
- char *p;\r
-\r
- /* process format string */\r
- for (;;)\r
- {\r
- va_list ap;\r
- va_start(ap, format);\r
- if (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size)\r
- {\r
- /* increase buffer until it fits the whole string */\r
- if (!(p = realloc(buffer, size += 4096)))\r
- {\r
- /* gotta free up */\r
- if (buffer)\r
- free(buffer);\r
- va_end(ap);\r
- return;\r
- }\r
- \r
- buffer = p;\r
- \r
- va_end(ap);\r
- continue;\r
- }\r
- va_end(ap);\r
- break;\r
- }\r
- \r
- /* vsnprintf failed */\r
- if (n < 0)\r
- {\r
- if (buffer)\r
- free(buffer);\r
- return;\r
- }\r
-\r
- p = buffer;\r
- \r
- /* process lines in buffer */\r
- do {\r
- char *next = strchr(p, '\n');\r
- \r
- if (next)\r
- *next++ = 0;\r
-\r
- if (context->output_handler)\r
- context->output_handler(context, p);\r
-\r
- p = next;\r
- } while (p);\r
- \r
- if (buffer)\r
- free(buffer);\r
-}\r
-\r
-int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)\r
-{\r
- command_t *c;\r
- \r
- if (unique_length_dirty)\r
- {\r
- unique_length_dirty = 0;\r
- /* update unique lengths */\r
- build_unique_lengths(context, context->commands);\r
- }\r
- \r
- for (c = commands; c; c = c->next)\r
- {\r
- if (strncasecmp(c->name, words[start_word], c->unique_len))\r
- continue;\r
-\r
- if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))\r
- continue;\r
- \r
- if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )\r
- {\r
- if (!c->children)\r
- {\r
- if (!c->handler)\r
- {\r
- command_print(context, "No handler for command");\r
- break;\r
- }\r
- else\r
- {\r
- int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);\r
- if (retval == ERROR_COMMAND_SYNTAX_ERROR)\r
- {\r
- command_print(context, "Syntax error:");\r
- command_print_help_line(context, c, 0);\r
- }\r
- return retval; \r
- }\r
- }\r
- else\r
- {\r
- if (start_word == num_words - 1)\r
- {\r
- command_print(context, "Incomplete command");\r
- break;\r
- }\r
- return find_and_run_command(context, c->children, words, num_words, start_word + 1);\r
- }\r
- }\r
- }\r
- \r
- command_print(context, "Command %s not found", words[start_word]);\r
- return ERROR_OK;\r
-}\r
-\r
-int command_run_line(command_context_t *context, char *line)\r
-{\r
- int nwords;\r
- char *words[128] = {0};\r
- int retval;\r
- int i;\r
- \r
- if ((!context) || (!line))\r
- return ERROR_INVALID_ARGUMENTS;\r
- \r
- /* skip preceding whitespace */\r
- while (isspace(*line))\r
- line++;\r
- \r
- /* empty line, ignore */\r
- if (!*line)\r
- return ERROR_OK;\r
- \r
- /* ignore comments */\r
- if (*line && (line[0] == '#'))\r
- return ERROR_OK;\r
- \r
- if (context->echo)\r
- {\r
- command_print(context, "%s", line);\r
- }\r
-\r
- nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));\r
- \r
- if (nwords > 0)\r
- retval = find_and_run_command(context, context->commands, words, nwords, 0);\r
- else\r
- return ERROR_INVALID_ARGUMENTS;\r
- \r
- for (i = 0; i < nwords; i++)\r
- free(words[i]);\r
- \r
- return retval;\r
-}\r
-\r
-int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)\r
-{\r
- int retval = ERROR_OK;\r
- int old_command_mode;\r
- char *buffer=malloc(4096);\r
- if (buffer==NULL)\r
- {\r
- return ERROR_INVALID_ARGUMENTS;\r
- }\r
- \r
- old_command_mode = context->mode;\r
- context->mode = mode;\r
- \r
- while (fgets(buffer, 4096, file))\r
- {\r
- char *p;\r
- char *cmd, *end;\r
- \r
- /* stop processing line after a comment (#, !) or a LF, CR were encountered */\r
- if ((p = strpbrk(buffer, "#!\r\n")))\r
- *p = 0;\r
-\r
- /* skip over leading whitespace */\r
- cmd = buffer;\r
- while (isspace(*cmd))\r
- cmd++;\r
-\r
- /* empty (all whitespace) line? */\r
- if (!*cmd)\r
- continue;\r
- \r
- /* search the end of the current line, ignore trailing whitespace */\r
- for (p = end = cmd; *p; p++)\r
- if (!isspace(*p))\r
- end = p;\r
- \r
- /* terminate end */\r
- *++end = 0;\r
- if (strcasecmp(cmd, "quit") == 0)\r
- break;\r
-\r
- /* run line */\r
- if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)\r
- break;\r
- }\r
- \r
- context->mode = old_command_mode;\r
-\r
- \r
- free(buffer);\r
- \r
- return retval;\r
-}\r
-\r
-void command_print_help_line(command_context_t* context, struct command_s *command, int indent)\r
-{\r
- command_t *c;\r
- char indents[32] = {0};\r
- char *help = "no help available";\r
- char name_buf[64];\r
- int i;\r
- \r
- for (i = 0; i < indent; i+=2)\r
- {\r
- indents[i*2] = ' ';\r
- indents[i*2+1] = '-';\r
- }\r
- indents[i*2] = 0;\r
- \r
- if (command->help)\r
- help = command->help;\r
- \r
- snprintf(name_buf, 64, command->name);\r
- strncat(name_buf, indents, 64);\r
- command_print(context, "%20s\t%s", name_buf, help);\r
- \r
- if (command->children)\r
- {\r
- for (c = command->children; c; c = c->next)\r
- {\r
- command_print_help_line(context, c, indent + 1);\r
- }\r
- }\r
-}\r
-\r
-int command_print_help(command_context_t* context, char* name, char** args, int argc)\r
-{\r
- command_t *c;\r
-\r
- for (c = context->commands; c; c = c->next)\r
- {\r
- if (argc == 1)\r
- {\r
- if (strncasecmp(c->name, args[0], c->unique_len))\r
- continue;\r
-\r
- if (strncasecmp(c->name, args[0], strlen(args[0])))\r
- continue;\r
- } \r
-\r
- command_print_help_line(context, c, 0);\r
- }\r
- \r
- return ERROR_OK;\r
-}\r
-\r
-void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)\r
-{\r
- context->output_handler = output_handler;\r
- context->output_handler_priv = priv;\r
-}\r
-\r
-command_context_t* copy_command_context(command_context_t* context)\r
-{\r
- command_context_t* copy_context = malloc(sizeof(command_context_t));\r
-\r
- *copy_context = *context;\r
- \r
- return copy_context;\r
-}\r
-\r
-int command_done(command_context_t *context)\r
-{\r
- free(context);\r
- context = NULL;\r
- \r
- return ERROR_OK;\r
-}\r
-\r
-command_context_t* command_init()\r
-{\r
- command_context_t* context = malloc(sizeof(command_context_t));\r
- \r
- context->mode = COMMAND_EXEC;\r
- context->commands = NULL;\r
- context->current_target = 0;\r
- context->echo = 0;\r
- context->output_handler = NULL;\r
- context->output_handler_priv = NULL;\r
- \r
- register_command(context, NULL, "help", command_print_help,\r
- COMMAND_EXEC, "display this help");\r
- \r
- register_command(context, NULL, "sleep", handle_sleep_command,\r
- COMMAND_ANY, "sleep for <n> milliseconds");\r
- \r
- register_command(context, NULL, "time", handle_time_command,\r
- COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");\r
- \r
- return context;\r
-}\r
-\r
-/* sleep command sleeps for <n> miliseconds\r
- * this is useful in target startup scripts\r
- */\r
-int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)\r
-{\r
- unsigned long duration = 0;\r
- \r
- if (argc == 1)\r
- {\r
- duration = strtoul(args[0], NULL, 0);\r
- usleep(duration * 1000);\r
- }\r
-\r
- return ERROR_OK;\r
-}\r
-\r
-int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)\r
-{\r
- if (argc<1)\r
- return ERROR_COMMAND_SYNTAX_ERROR;\r
- \r
- duration_t duration;\r
- char *duration_text;\r
- int retval;\r
- \r
- duration_start_measure(&duration);\r
- \r
- retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc, 0);\r
- \r
- duration_stop_measure(&duration, &duration_text);\r
- \r
- float t=duration.duration.tv_sec;\r
- t+=((float)duration.duration.tv_usec / 1000000.0);\r
- command_print(cmd_ctx, "%s took %fs", args[0], t);\r
- \r
- free(duration_text);\r
-\r
- return retval;\r
-}\r
+/***************************************************************************
+ * Copyright (C) 2005 by Dominic Rath *
+ * Dominic.Rath@gmx.de *
+ * *
+ * part of this file is taken from libcli (libcli.sourceforge.net) *
+ * Copyright (C) David Parrish (david@dparrish.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 *
+ * the Free Software Foundation; either version 2 of the License, or *
+ * (at your option) any later version. *
+ * *
+ * This program is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
+ * GNU General Public License for more details. *
+ * *
+ * 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. *
+ ***************************************************************************/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "replacements.h"
+#include "target.h"
+#include "command.h"
+#include "configuration.h"
+
+#include "log.h"
+#include "time_support.h"
+
+#include <stdlib.h>
+#include <string.h>
+#include <ctype.h>
+#include <stdarg.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <errno.h>
+
+int fast_and_dangerous = 0;
+Jim_Interp *interp = NULL;
+
+int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+
+int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
+
+static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
+{
+ Jim_Obj *tclOutput=(Jim_Obj *)privData;
+
+ Jim_AppendString(interp, tclOutput, string, strlen(string));
+}
+
+static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+ /* the private data is stashed in the interp structure */
+ command_t *c;
+ command_context_t *context;
+ int *retval;
+ int i;
+ int nwords;
+ char **words;
+
+ target_call_timer_callbacks_now();
+ LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
+
+ c = interp->cmdPrivData;
+ LOG_DEBUG("script_command - %s", c->name);
+
+ nwords = argc;
+ words = malloc(sizeof(char *) * nwords);
+ for (i = 0; i < nwords; i++)
+ {
+ int len;
+
+ words[i] = strdup(Jim_GetString(argv[i], &len));
+ if (words[i] == NULL)
+ {
+ return JIM_ERR;
+ }
+ LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
+ }
+
+ /* grab the command context from the associated data */
+ context = Jim_GetAssocData(interp, "context");
+ retval = Jim_GetAssocData(interp, "retval");
+ if (context != NULL && retval != NULL)
+ {
+ /* capture log output and return it */
+ Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
+ log_add_callback(tcl_output, tclOutput);
+
+ *retval = run_command(context, c, words, nwords);
+
+ log_remove_callback(tcl_output, tclOutput);
+
+ /* We dump output into this local variable */
+ Jim_SetVariableStr(interp, "ocd_output", tclOutput);
+ }
+
+ for (i = 0; i < nwords; i++)
+ free(words[i]);
+ free(words);
+
+ return (*retval==ERROR_OK)?JIM_OK:JIM_ERR;
+}
+
+command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
+{
+ command_t *c, *p;
+
+ if (!context || !name)
+ return NULL;
+
+ c = malloc(sizeof(command_t));
+
+ c->name = strdup(name);
+ c->parent = parent;
+ c->children = NULL;
+ c->handler = handler;
+ c->mode = mode;
+ if (!help)
+ help="";
+ c->next = NULL;
+
+ /* place command in tree */
+ if (parent)
+ {
+ if (parent->children)
+ {
+ /* find last child */
+ for (p = parent->children; p && p->next; p = p->next);
+ if (p)
+ p->next = c;
+ }
+ else
+ {
+ parent->children = c;
+ }
+ }
+ else
+ {
+ if (context->commands)
+ {
+ /* find last command */
+ for (p = context->commands; p && p->next; p = p->next);
+ if (p)
+ p->next = c;
+ }
+ else
+ {
+ context->commands = c;
+ }
+ }
+
+ /* just a placeholder, no handler */
+ if (c->handler==NULL)
+ return c;
+
+ /* If this is a two level command, e.g. "flash banks", then the
+ * "unknown" proc in startup.tcl must redirect to this command.
+ *
+ * "flash banks" is translated by "unknown" to "flash_banks"
+ * if such a proc exists
+ */
+ /* Print help for command */
+ const char *t1="";
+ const char *t2="";
+ const char *t3="";
+ /* maximum of two levels :-) */
+ if (c->parent!=NULL)
+ {
+ t1=c->parent->name;
+ t2="_";
+ }
+ t3=c->name;
+ const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3);
+ Jim_CreateCommand(interp, full_name, script_command, c, NULL);
+ free((void *)full_name);
+
+ /* we now need to add an overrideable proc */
+ const char *override_name=alloc_printf("proc %s%s%s {args} {return [eval \"ocd_%s%s%s $args\"]}", t1, t2, t3, t1, t2, t3);
+ Jim_Eval(interp, override_name);
+ free((void *)override_name);
+
+ /* accumulate help text in Tcl helptext list. */
+ Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
+ if (Jim_IsShared(helptext))
+ helptext = Jim_DuplicateObj(interp, helptext);
+ Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
+
+ Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
+
+ /* maximum of two levels :-) */
+ if (c->parent!=NULL)
+ {
+ Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
+ }
+ Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
+
+ Jim_ListAppendElement(interp, cmd_entry, cmd_list);
+ Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
+ Jim_ListAppendElement(interp, helptext, cmd_entry);
+ return c;
+}
+
+int unregister_all_commands(command_context_t *context)
+{
+ command_t *c, *c2;
+
+ if (context == NULL)
+ return ERROR_OK;
+
+ while(NULL != context->commands)
+ {
+ c = context->commands;
+
+ while(NULL != c->children)
+ {
+ c2 = c->children;
+ c->children = c->children->next;
+ free(c2->name);
+ c2->name = NULL;
+ free(c2);
+ c2 = NULL;
+ }
+
+ context->commands = context->commands->next;
+
+ free(c->name);
+ c->name = NULL;
+ free(c);
+ c = NULL;
+ }
+
+ return ERROR_OK;
+}
+
+int unregister_command(command_context_t *context, char *name)
+{
+ command_t *c, *p = NULL, *c2;
+
+ if ((!context) || (!name))
+ return ERROR_INVALID_ARGUMENTS;
+
+ /* find command */
+ for (c = context->commands; c; c = c->next)
+ {
+ if (strcmp(name, c->name) == 0)
+ {
+ /* unlink command */
+ if (p)
+ {
+ p->next = c->next;
+ }
+ else
+ {
+ context->commands = c->next;
+ }
+
+ /* unregister children */
+ if (c->children)
+ {
+ for (c2 = c->children; c2; c2 = c2->next)
+ {
+ free(c2->name);
+ free(c2);
+ }
+ }
+
+ /* delete command */
+ free(c->name);
+ free(c);
+ }
+
+ /* remember the last command for unlinking */
+ p = c;
+ }
+
+ return ERROR_OK;
+}
+
+void command_output_text(command_context_t *context, const char *data)
+{
+ if( context && context->output_handler && data ){
+ context->output_handler( context, data );
+ }
+}
+
+void command_print_n(command_context_t *context, char *format, ...)
+{
+ char *string;
+
+ va_list ap;
+ va_start(ap, format);
+
+ string = alloc_vprintf(format, ap);
+ if (string != NULL)
+ {
+ /* we want this collected in the log + we also want to pick it up as a tcl return
+ * value.
+ *
+ * The latter bit isn't precisely neat, but will do for now.
+ */
+ LOG_USER_N("%s", string);
+ // We already printed it above
+ //command_output_text(context, string);
+ free(string);
+ }
+
+ va_end(ap);
+}
+
+void command_print(command_context_t *context, char *format, ...)
+{
+ char *string;
+
+ va_list ap;
+ va_start(ap, format);
+
+ string = alloc_vprintf(format, ap);
+ if (string != NULL)
+ {
+ strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
+ /* we want this collected in the log + we also want to pick it up as a tcl return
+ * value.
+ *
+ * The latter bit isn't precisely neat, but will do for now.
+ */
+ LOG_USER_N("%s", string);
+ // We already printed it above
+ //command_output_text(context, string);
+ free(string);
+ }
+
+ va_end(ap);
+}
+
+int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
+{
+ int start_word=0;
+ if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
+ {
+ /* Config commands can not run after the config stage */
+ LOG_ERROR("Illegal mode for command");
+ return ERROR_FAIL;
+ }
+
+ int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
+ if (retval == ERROR_COMMAND_SYNTAX_ERROR)
+ {
+ /* Print help for command */
+ const char *t1="";
+ const char *t2="";
+ const char *t3="";
+ /* maximum of two levels :-) */
+ if (c->parent!=NULL)
+ {
+ t1=c->parent->name;
+ t2=" ";
+ }
+ t3=c->name;
+ command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
+ }
+ else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
+ {
+ /* just fall through for a shutdown request */
+ }
+ else if (retval != ERROR_OK)
+ {
+ /* we do not print out an error message because the command *should*
+ * have printed out an error
+ */
+ LOG_DEBUG("Command failed with error code %d", retval);
+ }
+
+ return retval;
+}
+
+int command_run_line(command_context_t *context, char *line)
+{
+ /* all the parent commands have been registered with the interpreter
+ * so, can just evaluate the line as a script and check for
+ * results
+ */
+ /* run the line thru a script engine */
+ int retval;
+ int retcode;
+ Jim_DeleteAssocData(interp, "context"); /* remove existing */
+ retcode = Jim_SetAssocData(interp, "context", NULL, context);
+ if (retcode != JIM_OK)
+ return ERROR_FAIL;
+
+ /* associated the return value */
+ retval = ERROR_OK;
+ Jim_DeleteAssocData(interp, "retval"); /* remove existing */
+ retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
+ if (retcode != JIM_OK)
+ return ERROR_FAIL;
+
+ retcode = Jim_Eval(interp, line);
+ if (retcode == JIM_ERR) {
+ if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
+ {
+ /* We do not print the connection closed error message */
+ Jim_PrintErrorMessage(interp);
+ }
+ if (retval==ERROR_OK)
+ {
+ /* It wasn't a low level OpenOCD command that failed */
+ return ERROR_FAIL;
+ }
+ return retval;
+ } else if (retcode == JIM_EXIT) {
+ /* ignore. */
+ /* exit(Jim_GetExitCode(interp)); */
+ } else {
+ const char *result;
+ int reslen;
+
+ result = Jim_GetString(Jim_GetResult(interp), &reslen);
+ if (reslen) {
+ int i;
+ char buff[256+1];
+ for (i = 0; i < reslen; i += 256)
+ {
+ int chunk;
+ chunk = reslen - i;
+ if (chunk > 256)
+ chunk = 256;
+ strncpy(buff, result+i, chunk);
+ buff[chunk] = 0;
+ LOG_USER_N("%s", buff);
+ }
+ LOG_USER_N("%s", "\n");
+ }
+ }
+ return retval;
+}
+
+int command_run_linef(command_context_t *context, char *format, ...)
+{
+ int retval=ERROR_FAIL;
+ char *string;
+ va_list ap;
+ va_start(ap, format);
+ string = alloc_vprintf(format, ap);
+ if (string!=NULL)
+ {
+ retval=command_run_line(context, string);
+ }
+ va_end(ap);
+ return retval;
+}
+
+void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
+{
+ context->output_handler = output_handler;
+ context->output_handler_priv = priv;
+}
+
+command_context_t* copy_command_context(command_context_t* context)
+{
+ command_context_t* copy_context = malloc(sizeof(command_context_t));
+
+ *copy_context = *context;
+
+ return copy_context;
+}
+
+int command_done(command_context_t *context)
+{
+ free(context);
+ context = NULL;
+
+ return ERROR_OK;
+}
+
+/* find full path to file */
+static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+ if (argc != 2)
+ return JIM_ERR;
+ const char *file = Jim_GetString(argv[1], NULL);
+ char *full_path = find_file(file);
+ if (full_path == NULL)
+ return JIM_ERR;
+ Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
+ free(full_path);
+
+ Jim_SetResult(interp, result);
+ return JIM_OK;
+}
+
+static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+ if (argc != 2)
+ return JIM_ERR;
+ const char *str = Jim_GetString(argv[1], NULL);
+ LOG_USER("%s", str);
+ return JIM_OK;
+}
+
+static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
+{
+ size_t nbytes;
+ const char *ptr;
+ Jim_Interp *interp;
+ command_context_t *context;
+
+ /* make it a char easier to read code */
+ ptr = _ptr;
+ interp = cookie;
+ nbytes = size * n;
+ if (ptr == NULL || interp == NULL || nbytes == 0) {
+ return 0;
+ }
+
+ context = Jim_GetAssocData(interp, "context");
+ if (context == NULL)
+ {
+ LOG_ERROR("openocd_jim_fwrite: no command context");
+ /* TODO: Where should this go? */
+ return n;
+ }
+
+ /* do we have to chunk it? */
+ if (ptr[nbytes] == 0)
+ {
+ /* no it is a C style string */
+ command_output_text(context, ptr);
+ return strlen(ptr);
+ }
+ /* GRR we must chunk - not null terminated */
+ while (nbytes) {
+ char chunk[128+1];
+ int x;
+
+ x = nbytes;
+ if (x > 128) {
+ x = 128;
+ }
+ /* copy it */
+ memcpy(chunk, ptr, x);
+ /* terminate it */
+ chunk[n] = 0;
+ /* output it */
+ command_output_text(context, chunk);
+ ptr += x;
+ nbytes -= x;
+ }
+
+ return n;
+}
+
+static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
+{
+ /* TCL wants to read... tell him no */
+ return 0;
+}
+
+static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
+{
+ char *cp;
+ int n;
+ Jim_Interp *interp;
+ command_context_t *context;
+
+ n = -1;
+ interp = cookie;
+ if (interp == NULL)
+ return n;
+
+ context = Jim_GetAssocData(interp, "context");
+ if (context == NULL)
+ {
+ LOG_ERROR("openocd_jim_vfprintf: no command context");
+ return n;
+ }
+
+ cp = alloc_vprintf(fmt, ap);
+ if (cp)
+ {
+ command_output_text(context, cp);
+ n = strlen(cp);
+ free(cp);
+ }
+ return n;
+}
+
+static int openocd_jim_fflush(void *cookie)
+{
+ /* nothing to flush */
+ return 0;
+}
+
+static char* openocd_jim_fgets(char *s, int size, void *cookie)
+{
+ /* not supported */
+ errno = ENOTSUP;
+ return NULL;
+}
+
+command_context_t* command_init()
+{
+ command_context_t* context = malloc(sizeof(command_context_t));
+ extern unsigned const char startup_tcl[];
+
+ context->mode = COMMAND_EXEC;
+ context->commands = NULL;
+ context->current_target = 0;
+ context->output_handler = NULL;
+ context->output_handler_priv = NULL;
+
+#ifdef JIM_EMBEDDED
+ Jim_InitEmbedded();
+ /* Create an interpreter */
+ interp = Jim_CreateInterp();
+ /* Add all the Jim core commands */
+ Jim_RegisterCoreCommands(interp);
+#endif
+
+ Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
+ Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
+
+ /* Set Jim's STDIO */
+ interp->cookie_stdin = interp;
+ interp->cookie_stdout = interp;
+ interp->cookie_stderr = interp;
+ interp->cb_fwrite = openocd_jim_fwrite;
+ interp->cb_fread = openocd_jim_fread ;
+ interp->cb_vfprintf = openocd_jim_vfprintf;
+ interp->cb_fflush = openocd_jim_fflush;
+ interp->cb_fgets = openocd_jim_fgets;
+
+ add_default_dirs();
+
+ if (Jim_Eval(interp, startup_tcl)==JIM_ERR)
+ {
+ LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
+ Jim_PrintErrorMessage(interp);
+ exit(-1);
+ }
+
+ register_command(context, NULL, "sleep", handle_sleep_command,
+ COMMAND_ANY, "sleep for <n> milliseconds");
+
+ register_command(context, NULL, "fast", handle_fast_command,
+ COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
+
+ return context;
+}
+
+int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
+{
+ if (!cmd_ctx)
+ return ERROR_INVALID_ARGUMENTS;
+
+ cmd_ctx->mode = mode;
+ return ERROR_OK;
+}
+
+/* sleep command sleeps for <n> miliseconds
+ * this is useful in target startup scripts
+ */
+int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+{
+ unsigned long duration = 0;
+
+ if (argc == 1)
+ {
+ duration = strtoul(args[0], NULL, 0);
+ usleep(duration * 1000);
+ }
+
+ return ERROR_OK;
+}
+
+int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+{
+ if (argc!=1)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ fast_and_dangerous = strcmp("enable", args[0])==0;
+
+ return ERROR_OK;
+}
+
+void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
+{
+ Jim_CreateCommand(interp, name, cmd, NULL, NULL);
+
+ /* FIX!!! it would be prettier to invoke add_help_text...
+ accumulate help text in Tcl helptext list. */
+ Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
+ if (Jim_IsShared(helptext))
+ helptext = Jim_DuplicateObj(interp, helptext);
+
+ Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
+
+ Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
+ Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
+
+ Jim_ListAppendElement(interp, cmd_entry, cmd_list);
+ Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
+ Jim_ListAppendElement(interp, helptext, cmd_entry);
+}
Code Review / openocd.git / blobdiff