#endif
// @todo the inclusion of target.h here is a layering violation
+#include <jtag/jtag.h>
#include <target/target.h>
#include "command.h"
#include "configuration.h"
return state;
}
+/* Classic openocd commands provide progress output which we
+ * will capture and return as a Tcl return value.
+ *
+ * However, if a non-openocd command has been invoked, then it
+ * makes sense to return the tcl return value from that command.
+ *
+ * The tcl return value is empty for openocd commands that provide
+ * progress output.
+ *
+ * Therefore we set the tcl return value only if we actually
+ * captured output.
+ */
static void command_log_capture_finish(struct log_capture_state *state)
{
if (NULL == state)
log_remove_callback(tcl_output, state);
- Jim_SetResult(state->interp, state->output);
+ int length;
+ Jim_GetString(state->output, &length);
+
+ if (length > 0)
+ {
+ Jim_SetResult(state->interp, state->output);
+ } else
+ {
+ /* No output captured, use tcl return value (which could
+ * be empty too). */
+ }
Jim_DecrRefCount(state->interp, state->output);
free(state);
{
int len;
const char *w = Jim_GetString(argv[i], &len);
-
- /* end of line comment? */
- if (*w == '#')
- break;
-
char * t = alloc_printf("%s %s", dbg, w);
free (dbg);
dbg = t;
{
int len;
const char *w = Jim_GetString(argv[i], &len);
- /* a comment may end the line early */
- if (*w == '#')
- break;
-
words[i] = strdup(w);
if (words[i] == NULL)
{
}
if (c->name)
- free(c->name);
+ free((void *)c->name);
if (c->help)
free((void*)c->help);
if (c->usage)
{
assert(cr->name);
+ /*
+ If it is a non-jim command with no .usage specified,
+ log an error.
+
+ strlen(.usage) == 0 means that the command takes no
+ arguments.
+ */
+ if ((cr->jim_handler == NULL) &&
+ (cr->usage == NULL)) {
+ LOG_DEBUG("BUG: command '%s%s%s' does not have the "
+ "'.usage' field filled out",
+ parent && parent->name ? parent->name : "",
+ parent && parent->name ? " " : "",
+ cr->name);
+ }
+
struct command *c = calloc(1, sizeof(struct command));
if (NULL == c)
return NULL;
struct command *parent, const char *name)
{
if ((!context) || (!name))
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
struct command *p = NULL;
struct command **head = command_list_for_parent(context, parent);
if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
{
/* We do not print the connection closed error message */
- Jim_PrintErrorMessage(interp);
+ Jim_MakeErrorMessage(interp);
+ LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
}
if (retval == ERROR_OK)
{
buff[chunk] = 0;
LOG_USER_N("%s", buff);
}
- LOG_USER_N("%s", "\n");
+ LOG_USER_N("\n");
}
retval = ERROR_OK;
}
if (string != NULL)
{
retval = command_run_line(context, string);
+ free(string);
}
va_end(ap);
return retval;
return JIM_OK;
}
-static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+COMMAND_HANDLER(jim_echo)
{
- 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;
-
- /* make it a char easier to read code */
- ptr = _ptr;
- interp = cookie;
- nbytes = size * n;
- if (ptr == NULL || interp == NULL || nbytes == 0) {
- return 0;
- }
-
- /* do we have to chunk it? */
- if (ptr[nbytes] == 0)
- {
- /* no it is a C style string */
- LOG_USER_N("%s", 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 */
- LOG_USER_N("%s", 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;
-
- n = -1;
- interp = cookie;
- if (interp == NULL)
- return n;
-
- cp = alloc_vprintf(fmt, ap);
- if (cp)
+ if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n"))
{
- LOG_USER_N("%s", cp);
- n = strlen(cp);
- free(cp);
+ LOG_USER_N("%s", CMD_ARGV[1]);
+ return JIM_OK;
}
- 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;
+ if (CMD_ARGC != 1)
+ return JIM_ERR;
+ LOG_USER("%s", CMD_ARGV[0]);
+ return JIM_OK;
}
+/* Capture progress output and return as tcl return value. If the
+ * progress output was empty, return tcl return value.
+ */
static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
if (argc != 2)
struct log_capture_state *state = command_log_capture_start(interp);
+ /* disable polling during capture. This avoids capturing output
+ * from polling.
+ *
+ * This is necessary in order to avoid accidentially getting a non-empty
+ * string for tcl fn's.
+ */
+ bool save_poll = jtag_poll_get_enabled();
+
+ jtag_poll_set_enabled(false);
+
const char *str = Jim_GetString(argv[1], NULL);
int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
+ jtag_poll_set_enabled(save_poll);
+
command_log_capture_finish(state);
return retcode;
struct command **out)
{
if (0 == CMD_ARGC)
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
*out = command_find(head, CMD_ARGV[0]);
if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
*out = command_find(head, CMD_ARGV[0] + 4);
if (NULL == *out)
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
if (--CMD_ARGC == 0)
return ERROR_OK;
CMD_ARGV++;
if (next - last < HELP_LINE_WIDTH(n))
cp = next;
command_help_show_indent(n);
- LOG_USER_N("%.*s", (int)(cp - last), last);
- LOG_USER_N("\n");
+ LOG_USER("%.*s", (int)(cp - last), last);
last = cp + 1;
n = n2;
}
static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
bool show_help, const char *match)
{
- if (!command_can_run(CMD_CTX, c))
- return ERROR_OK;
-
char *cmd_name = command_name(c, ' ');
if (NULL == cmd_name)
return -ENOMEM;
return -ENOMEM;
}
- if (++n >= 2)
- return ERROR_OK;
+ if (++n > 5) {
+ LOG_ERROR("command recursion exceeded");
+ return ERROR_FAIL;
+ }
return CALL_COMMAND_HANDLER(command_help_show_list,
c->children, n, show_help, match);
if (CMD_ARGC < 2)
{
LOG_ERROR("%s: insufficient arguments", CMD_NAME);
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
// save help text and remove it from argument list
if (!help && !usage)
{
LOG_ERROR("command name '%s' is unknown", CMD_NAME);
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
// likewise for the leaf command name
const char *cmd_name = CMD_ARGV[--CMD_ARGC];
};
static const struct command_registration command_builtin_handlers[] = {
+ {
+ .name = "echo",
+ .handler = jim_echo,
+ .mode = COMMAND_ANY,
+ .help = "Logs a message at \"user\" priority. "
+ "Output message to stdout. "
+ "Option \"-n\" suppresses trailing newline",
+ .usage = "[-n] string",
+ },
{
.name = "add_help_text",
.handler = handle_help_add_command,
/* Create a jim interpreter if we were not handed one */
if (interp == NULL)
{
- Jim_InitEmbedded();
/* Create an interpreter */
interp = Jim_CreateInterp();
/* Add all the Jim core commands */
Jim_RegisterCoreCommands(interp);
+ Jim_InitStaticExtensions(interp);
}
#endif
context->interp = interp;
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->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;
-
register_commands(context, NULL, command_builtin_handlers);
-#if !BUILD_ECOSBOARD
- Jim_EventLoopOnLoad(interp);
-#endif
Jim_SetAssocData(interp, "context", NULL, context);
if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
{
LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
- Jim_PrintErrorMessage(interp);
+ Jim_MakeErrorMessage(interp);
+ LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
exit(-1);
}
Jim_DeleteAssocData(interp, "context");
int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
{
if (!cmd_ctx)
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
cmd_ctx->mode = mode;
return ERROR_OK;
return ERROR_OK;
if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
return ERROR_OK;
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
if (command_parse_bool_arg(in, out) != ERROR_OK)
{
LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
// fall through
}
LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
break;
default:
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
return ERROR_OK;
}
Code Review / openocd.git / blobdiff