* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
+ * Copyright (C) 2007,2008 Øyvind Harboe *
+ * oyvind.harboe@zylin.com *
+ * *
+ * Copyright (C) 2008, Duane Ellis *
+ * openocd@duaneeellis.com *
+ * *
* part of this file is taken from libcli (libcli.sourceforge.net) *
* Copyright (C) David Parrish (david@dparrish.com) *
* *
#include "config.h"
#endif
-#include "replacements.h"
+#if !BUILD_ECOSBOARD
+/* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
+#define JIM_EMBEDDED
+#endif
+
+// @todo the inclusion of target.h here is a layering violation
#include "target.h"
#include "command.h"
#include "configuration.h"
-
#include "log.h"
#include "time_support.h"
+#include "jim-eventloop.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);
+static int run_command(struct command_context *context,
+ struct command *c, const char *words[], unsigned num_words);
+
+static void tcl_output(void *privData, const char *file, unsigned line,
+ const char *function, const char *string)
+{
+ Jim_Obj *tclOutput = (Jim_Obj *)privData;
+ Jim_AppendString(interp, tclOutput, string, strlen(string));
+}
+
+extern struct command_context *global_cmd_ctx;
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
+void script_debug(Jim_Interp *interp, const char *name,
+ unsigned argc, Jim_Obj *const *argv)
+{
+ LOG_DEBUG("command - %s", name);
+ for (unsigned i = 0; i < argc; i++)
+ {
+ int len;
+ const char *w = Jim_GetString(argv[i], &len);
-static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
-{
- Jim_Obj *tclOutput=(Jim_Obj *)privData;
+ /* end of line comment? */
+ if (*w == '#')
+ break;
- Jim_AppendString(interp, tclOutput, string, strlen(string));
+ LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
+ }
}
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;
+ struct command *c;
+ struct command_context *context;
+ int retval;
int i;
int nwords;
char **words;
- target_call_timer_callbacks_now();
- LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
-
+ /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
+ * get overwritten by running other Jim commands! Treat it as an
+ * emphemeral global variable that is used in lieu of an argument
+ * to the fn and fish it out manually.
+ */
c = interp->cmdPrivData;
- LOG_DEBUG("script_command - %s", c->name);
+ if (c == NULL)
+ {
+ LOG_ERROR("BUG: interp->cmdPrivData == NULL");
+ return JIM_ERR;
+ }
+ target_call_timer_callbacks_now();
+ LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
- nwords = argc;
- words = malloc(sizeof(char *) * nwords);
- for (i = 0; i < nwords; i++)
+ script_debug(interp, c->name, argc, argv);
+
+ words = malloc(argc * sizeof(char *));
+ for (i = 0; i < argc; i++)
{
int len;
-
- words[i] = strdup(Jim_GetString(argv[i], &len));
- if (words[i] == NULL)
+ const char *w = Jim_GetString(argv[i], &len);
+ if (*w=='#')
{
+ /* hit an end of line comment */
+ break;
+ }
+ words[i] = strdup(w);
+ if (words[i] == NULL)
+ {
+ int j;
+ for (j = 0; j < i; j++)
+ free(words[j]);
+ free(words);
return JIM_ERR;
}
- LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
}
+ nwords = i;
/* grab the command context from the associated data */
context = Jim_GetAssocData(interp, "context");
- retval = Jim_GetAssocData(interp, "retval");
- if (context != NULL && retval != NULL)
+ if (context == 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, "openocd_output", tclOutput);
+ /* Tcl can invoke commands directly instead of via command_run_line(). This would
+ * happen when the Jim Tcl interpreter is provided by eCos.
+ */
+ context = global_cmd_ctx;
}
+ /* capture log output and return it */
+ Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
+ /* a garbage collect can happen, so we need a reference count to this object */
+ Jim_IncrRefCount(tclOutput);
+
+ log_add_callback(tcl_output, tclOutput);
+
+ // turn words[0] into CMD_ARGV[-1] with this cast
+ retval = run_command(context, c, (const char **)words, nwords);
+
+ log_remove_callback(tcl_output, tclOutput);
+
+ /* We dump output into this local variable */
+ Jim_SetResult(interp, tclOutput);
+ Jim_DecrRefCount(interp, tclOutput);
+
for (i = 0; i < nwords; i++)
free(words[i]);
free(words);
- return (*retval==ERROR_OK)?JIM_OK:JIM_ERR;
+ int *return_retval = Jim_GetAssocData(interp, "retval");
+ if (return_retval != NULL)
+ {
+ *return_retval = retval;
+ }
+
+ return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
+}
+
+static Jim_Obj *command_name_list(struct command *c)
+{
+ Jim_Obj *cmd_list = c->parent ?
+ command_name_list(c->parent) :
+ Jim_NewListObj(interp, NULL, 0);
+ Jim_ListAppendElement(interp, cmd_list,
+ Jim_NewStringObj(interp, c->name, -1));
+
+ return cmd_list;
+}
+
+static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
+{
+ Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
+ Jim_ListAppendElement(interp, cmd_entry, cmd_list);
+ Jim_ListAppendElement(interp, cmd_entry,
+ Jim_NewStringObj(interp, help ? : "", -1));
+
+ /* 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_ListAppendElement(interp, helptext, cmd_entry);
+}
+
+/* nice short description of source file */
+#define __THIS__FILE__ "command.c"
+
+/**
+ * Find a command by name from a list of commands.
+ * @returns The named command if found, or NULL.
+ */
+static struct command *command_find(struct command **head, const char *name)
+{
+ assert(head);
+ for (struct command *cc = *head; cc; cc = cc->next)
+ {
+ if (strcmp(cc->name, name) == 0)
+ return cc;
+ }
+ return NULL;
+}
+
+/**
+ * Add the command to the end of linked list.
+ * @returns Returns false if the named command already exists in the list.
+ * Returns true otherwise.
+ */
+static void command_add_child(struct command **head, struct command *c)
+{
+ assert(head);
+ if (NULL == *head)
+ {
+ *head = c;
+ return;
+ }
+ struct command *cc = *head;
+ while (cc->next) cc = cc->next;
+ cc->next = c;
}
-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)
+struct command* register_command(struct command_context *context,
+ struct command *parent, char *name, command_handler_t handler,
+ enum command_mode mode, char *help)
{
- command_t *c, *p;
-
if (!context || !name)
return NULL;
-
- c = malloc(sizeof(command_t));
-
+
+ struct command **head = parent ? &parent->children : &context->commands;
+ struct command *c = command_find(head, name);
+ if (NULL != c)
+ return c;
+
+ c = malloc(sizeof(struct command));
+
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;
- }
- }
-
+
+ command_add_child(head, c);
+
+ command_helptext_add(command_name_list(c), help);
+
/* just a placeholder, no handler */
- if (c->handler==NULL)
+ 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("%s%s%s", t1, t2, t3);
- Jim_CreateCommand(interp, full_name, script_command, c, NULL);
+ const char *full_name = command_name(c, '_');
+
+ const char *ocd_name = alloc_printf("ocd_%s", full_name);
+ Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
+ free((void *)ocd_name);
+
+ /* we now need to add an overrideable proc */
+ const char *override_name = alloc_printf("proc %s {args} {"
+ "if {[catch {eval ocd_%s $args}] == 0} "
+ "{return \"\"} else {return -code error}}",
+ full_name, full_name);
+ Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
+ free((void *)override_name);
+
free((void *)full_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)
+int unregister_all_commands(struct command_context *context)
{
- command_t *c, *c2;
-
+ struct command *c, *c2;
+
if (context == NULL)
return ERROR_OK;
-
- while(NULL != context->commands)
+
+ while (NULL != context->commands)
{
c = context->commands;
-
- while(NULL != c->children)
+
+ while (NULL != c->children)
{
c2 = c->children;
c->children = c->children->next;
free(c2);
c2 = NULL;
}
-
+
context->commands = context->commands->next;
-
+
free(c->name);
c->name = NULL;
free(c);
- c = NULL;
+ c = NULL;
}
-
+
return ERROR_OK;
}
-int unregister_command(command_context_t *context, char *name)
+int unregister_command(struct command_context *context, char *name)
{
- command_t *c, *p = NULL, *c2;
-
+ struct command *c, *p = NULL, *c2;
+
if ((!context) || (!name))
return ERROR_INVALID_ARGUMENTS;
-
+
/* find command */
- for (c = context->commands; c; c = c->next)
+ c = context->commands;
+
+ while (NULL != c)
{
if (strcmp(name, c->name) == 0)
{
}
else
{
+ /* first element in command list */
context->commands = c->next;
}
-
+
/* unregister children */
- if (c->children)
+ while (NULL != c->children)
{
- for (c2 = c->children; c2; c2 = c2->next)
- {
- free(c2->name);
- free(c2);
- }
+ c2 = c->children;
+ c->children = c->children->next;
+ free(c2->name);
+ c2->name = NULL;
+ free(c2);
+ c2 = NULL;
}
-
+
/* delete command */
free(c->name);
+ c->name = NULL;
free(c);
+ c = NULL;
+ return ERROR_OK;
}
-
+
/* remember the last command for unlinking */
p = c;
+ c = c->next;
}
-
+
return ERROR_OK;
}
-void command_output_text(command_context_t *context, const char *data)
+void command_output_text(struct command_context *context, const char *data)
{
- if( context && context->output_handler && data ){
- context->output_handler( context, data );
+ if (context && context->output_handler && data) {
+ context->output_handler(context, data);
}
}
-void command_print_n(command_context_t *context, char *format, ...)
+void command_print_sameline(struct command_context *context, const char *format, ...)
{
char *string;
-
+
va_list ap;
va_start(ap, format);
{
/* 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);
+ /* We already printed it above */
+ /* command_output_text(context, string); */
free(string);
}
va_end(ap);
}
-void command_print(command_context_t *context, char *format, ...)
+void command_print(struct command_context *context, const char *format, ...)
{
char *string;
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);
+ /* 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)
+static char *__command_name(struct command *c, char delim, unsigned extra)
+{
+ char *name;
+ unsigned len = strlen(c->name);
+ if (NULL == c->parent) {
+ // allocate enough for the name, child names, and '\0'
+ name = malloc(len + extra + 1);
+ strcpy(name, c->name);
+ } else {
+ // parent's extra must include both the space and name
+ name = __command_name(c->parent, delim, 1 + len + extra);
+ char dstr[2] = { delim, 0 };
+ strcat(name, dstr);
+ strcat(name, c->name);
+ }
+ return name;
+}
+char *command_name(struct command *c, char delim)
+{
+ return __command_name(c, delim, 0);
+}
+
+static int run_command(struct command_context *context,
+ struct command *c, const char *words[], unsigned num_words)
{
- int start_word=0;
- if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
+ if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
{
/* Config commands can not run after the config stage */
+ LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
return ERROR_FAIL;
}
-
- int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
+
+ struct command_invocation cmd = {
+ .ctx = context,
+ .name = c->name,
+ .argc = num_words - 1,
+ .argv = words + 1,
+ };
+ int retval = c->handler(&cmd);
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);
+ char *full_name = command_name(c, ' ');
+ if (NULL != full_name) {
+ command_run_linef(context, "help %s", full_name);
+ free(full_name);
+ } else
+ retval = -ENOMEM;
}
else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
{
/* 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);
+ LOG_DEBUG("Command failed with error code %d", retval);
}
-
- return retval;
+
+ return retval;
}
-int command_run_line(command_context_t *context, char *line)
+int command_run_line(struct command_context *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 retval = ERROR_FAIL;
int retcode;
- Jim_DeleteAssocData(interp, "context"); /* remove existing */
+ /* Beware! This code needs to be reentrant. It is also possible
+ * for OpenOCD commands to be invoked directly from Tcl. This would
+ * happen when the Jim Tcl interpreter is provided by eCos for
+ * instance.
+ */
+ Jim_DeleteAssocData(interp, "context");
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;
+ if (retcode == JIM_OK)
+ {
+ /* associated the return value */
+ Jim_DeleteAssocData(interp, "retval");
+ retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
+ if (retcode == JIM_OK)
+ {
+ retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
- retcode = Jim_Eval(interp, line);
+ Jim_DeleteAssocData(interp, "retval");
+ }
+ Jim_DeleteAssocData(interp, "context");
+ }
if (retcode == JIM_ERR) {
- if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
+ if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
{
/* We do not print the connection closed error message */
Jim_PrintErrorMessage(interp);
}
- if (retval==ERROR_OK)
+ if (retval == ERROR_OK)
{
/* It wasn't a low level OpenOCD command that failed */
- return ERROR_FAIL;
+ return ERROR_FAIL;
}
return retval;
} else if (retcode == JIM_EXIT) {
int reslen;
result = Jim_GetString(Jim_GetResult(interp), &reslen);
- if (reslen) {
+ if (reslen > 0)
+ {
int i;
- char buff[256+1];
+ 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;
+ strncpy(buff, result + i, chunk);
+ buff[chunk] = 0;
LOG_USER_N("%s", buff);
}
LOG_USER_N("%s", "\n");
}
+ retval = ERROR_OK;
}
return retval;
}
-int command_run_linef(command_context_t *context, char *format, ...)
+int command_run_linef(struct command_context *context, const char *format, ...)
{
- int retval=ERROR_FAIL;
+ int retval = ERROR_FAIL;
char *string;
va_list ap;
va_start(ap, format);
string = alloc_vprintf(format, ap);
- if (string!=NULL)
+ if (string != NULL)
{
- retval=command_run_line(context, string);
+ 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)
+void command_set_output_handler(struct command_context* context,
+ command_output_handler_t output_handler, void *priv)
{
context->output_handler = output_handler;
context->output_handler_priv = priv;
}
-command_context_t* copy_command_context(command_context_t* context)
+struct command_context* copy_command_context(struct command_context* context)
{
- command_context_t* copy_context = malloc(sizeof(command_context_t));
+ struct command_context* copy_context = malloc(sizeof(struct command_context));
*copy_context = *context;
return copy_context;
}
-int command_done(command_context_t *context)
+int command_done(struct command_context *context)
{
free(context);
context = NULL;
-
+
return ERROR_OK;
}
return JIM_ERR;
Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
free(full_path);
-
+
Jim_SetResult(interp, result);
return JIM_OK;
}
size_t nbytes;
const char *ptr;
Jim_Interp *interp;
- command_context_t *context;
/* make it a char easier to read code */
ptr = _ptr;
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);
+ LOG_USER_N("%s", ptr);
return strlen(ptr);
}
/* GRR we must chunk - not null terminated */
while (nbytes) {
- char chunk[128+1];
+ char chunk[128 + 1];
int x;
x = nbytes;
/* terminate it */
chunk[n] = 0;
/* output it */
- command_output_text(context, chunk);
+ LOG_USER_N("%s", chunk);
ptr += x;
nbytes -= x;
}
-
+
return n;
}
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);
+ LOG_USER_N("%s", cp);
n = strlen(cp);
free(cp);
}
return NULL;
}
-command_context_t* command_init()
+static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+ if (argc != 2)
+ return JIM_ERR;
+ int retcode;
+ const char *str = Jim_GetString(argv[1], NULL);
+
+ /* capture log output and return it */
+ Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
+ /* a garbage collect can happen, so we need a reference count to this object */
+ Jim_IncrRefCount(tclOutput);
+
+ log_add_callback(tcl_output, tclOutput);
+
+ retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
+
+ log_remove_callback(tcl_output, tclOutput);
+
+ /* We dump output into this local variable */
+ Jim_SetResult(interp, tclOutput);
+ Jim_DecrRefCount(interp, tclOutput);
+
+ return retcode;
+}
+
+/* sleep command sleeps for <n> miliseconds
+ * this is useful in target startup scripts
+ */
+COMMAND_HANDLER(handle_sleep_command)
+{
+ bool busy = false;
+ if (CMD_ARGC == 2)
+ {
+ if (strcmp(CMD_ARGV[1], "busy") == 0)
+ busy = true;
+ else
+ return ERROR_COMMAND_SYNTAX_ERROR;
+ }
+ else if (CMD_ARGC < 1 || CMD_ARGC > 2)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ unsigned long duration = 0;
+ int retval = parse_ulong(CMD_ARGV[0], &duration);
+ if (ERROR_OK != retval)
+ return retval;
+
+ if (!busy)
+ {
+ long long then = timeval_ms();
+ while (timeval_ms() - then < (long long)duration)
+ {
+ target_call_timer_callbacks_now();
+ usleep(1000);
+ }
+ }
+ else
+ busy_sleep(duration);
+
+ return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_fast_command)
+{
+ if (CMD_ARGC != 1)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ fast_and_dangerous = strcmp("enable", CMD_ARGV[0]) == 0;
+
+ return ERROR_OK;
+}
+
+
+struct command_context* command_init(const char *startup_tcl)
{
- command_context_t* context = malloc(sizeof(command_context_t));
- extern unsigned const char startup_tcl[];
+ struct command_context* context = malloc(sizeof(struct command_context));
+ const char *HostOs;
context->mode = COMMAND_EXEC;
context->commands = NULL;
context->output_handler = NULL;
context->output_handler_priv = NULL;
-#ifdef JIM_EMBEDDED
+#if !BUILD_ECOSBOARD
Jim_InitEmbedded();
/* Create an interpreter */
interp = Jim_CreateInterp();
Jim_RegisterCoreCommands(interp);
#endif
- Jim_CreateCommand(interp, "openocd_find", jim_find, NULL, NULL);
+#if defined(_MSC_VER)
+ /* WinXX - is generic, the forward
+ * looking problem is this:
+ *
+ * "win32" or "win64"
+ *
+ * "winxx" is generic.
+ */
+ HostOs = "winxx";
+#elif defined(__linux__)
+ HostOs = "linux";
+#elif defined(__DARWIN__)
+ HostOs = "darwin";
+#elif defined(__CYGWIN__)
+ HostOs = "cygwin";
+#elif defined(__MINGW32__)
+ HostOs = "mingw32";
+#elif defined(__ECOS)
+ HostOs = "ecos";
+#else
+#warn unrecognized host OS...
+ HostOs = "other";
+#endif
+ Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
+ Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
+
+ Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
+ Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
/* Set Jim's STDIO */
interp->cookie_stdin = interp;
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)
+#if !BUILD_ECOSBOARD
+ Jim_EventLoopOnLoad(interp);
+#endif
+ if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
{
- LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
+ LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
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.");
-
+ register_command(context, NULL, "sleep",
+ handle_sleep_command, COMMAND_ANY,
+ "<n> [busy] - sleep for n milliseconds. "
+ "\"busy\" means busy wait");
+ 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)
+int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
{
if (!cmd_ctx)
return ERROR_INVALID_ARGUMENTS;
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)
+void process_jim_events(void)
{
- unsigned long duration = 0;
-
- if (argc == 1)
+#if !BUILD_ECOSBOARD
+ static int recursion = 0;
+
+ if (!recursion)
{
- duration = strtoul(args[0], NULL, 0);
- usleep(duration * 1000);
+ recursion++;
+ Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
+ recursion--;
}
-
- return ERROR_OK;
+#endif
}
-int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+void register_jim(struct command_context *cmd_ctx, const char *name,
+ Jim_CmdProc cmd, const char *help)
{
- if (argc!=1)
- return ERROR_COMMAND_SYNTAX_ERROR;
-
- fast_and_dangerous = strcmp("enable", args[0])==0;
-
- return ERROR_OK;
+ Jim_CreateCommand(interp, name, cmd, NULL, NULL);
+
+ Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
+ Jim_ListAppendElement(interp, cmd_list,
+ Jim_NewStringObj(interp, name, -1));
+
+ command_helptext_add(cmd_list, help);
}
-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)
+/* return global variable long value or 0 upon failure */
+long jim_global_long(const char *variable)
{
- 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);
+ Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
+ long t;
+ if (Jim_GetLong(interp, objPtr, &t) == JIM_OK)
+ {
+ return t;
+ }
+ return 0;
}
+
+#define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
+ int parse##name(const char *str, type *ul) \
+ { \
+ if (!*str) \
+ { \
+ LOG_ERROR("Invalid command argument"); \
+ return ERROR_COMMAND_ARGUMENT_INVALID; \
+ } \
+ char *end; \
+ *ul = func(str, &end, 0); \
+ if (*end) \
+ { \
+ LOG_ERROR("Invalid command argument"); \
+ return ERROR_COMMAND_ARGUMENT_INVALID; \
+ } \
+ if ((max == *ul) && (ERANGE == errno)) \
+ { \
+ LOG_ERROR("Argument overflow"); \
+ return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+ } \
+ if (min && (min == *ul) && (ERANGE == errno)) \
+ { \
+ LOG_ERROR("Argument underflow"); \
+ return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
+ } \
+ return ERROR_OK; \
+ }
+DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
+
+#define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
+ int parse##name(const char *str, type *ul) \
+ { \
+ functype n; \
+ int retval = parse##funcname(str, &n); \
+ if (ERROR_OK != retval) \
+ return retval; \
+ if (n > max) \
+ return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+ if (min) \
+ return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
+ *ul = n; \
+ return ERROR_OK; \
+ }
+
+#define DEFINE_PARSE_ULONG(name, type, min, max) \
+ DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
+DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
+DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
+DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
+DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
+
+#define DEFINE_PARSE_LONG(name, type, min, max) \
+ DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
+DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
+DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
+DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
+DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
projects / openocd / blobdiff