1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * part of this file is taken from libcli (libcli.sourceforge.net) *
12 * Copyright (C) David Parrish (david@dparrish.com) *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program; if not, write to the *
26 * Free Software Foundation, Inc., *
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
28 ***************************************************************************/
34 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
37 /* @todo the inclusion of target.h here is a layering violation */
38 #include <jtag/jtag.h>
39 #include <target/target.h>
41 #include "configuration.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
46 /* nice short description of source file */
47 #define __THIS__FILE__ "command.c"
49 static int run_command(struct command_context *context,
50 struct command *c, const char *words[], unsigned num_words);
52 struct log_capture_state {
57 static void tcl_output(void *privData, const char *file, unsigned line,
58 const char *function, const char *string)
60 struct log_capture_state *state = privData;
61 Jim_AppendString(state->interp, state->output, string, strlen(string));
64 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
66 /* capture log output and return it. A garbage collect can
67 * happen, so we need a reference count to this object */
68 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
69 if (NULL == tclOutput)
72 struct log_capture_state *state = malloc(sizeof(*state));
76 state->interp = interp;
77 Jim_IncrRefCount(tclOutput);
78 state->output = tclOutput;
80 log_add_callback(tcl_output, state);
85 /* Classic openocd commands provide progress output which we
86 * will capture and return as a Tcl return value.
88 * However, if a non-openocd command has been invoked, then it
89 * makes sense to return the tcl return value from that command.
91 * The tcl return value is empty for openocd commands that provide
94 * Therefore we set the tcl return value only if we actually
97 static void command_log_capture_finish(struct log_capture_state *state)
102 log_remove_callback(tcl_output, state);
105 Jim_GetString(state->output, &length);
108 Jim_SetResult(state->interp, state->output);
110 /* No output captured, use tcl return value (which could
113 Jim_DecrRefCount(state->interp, state->output);
118 static int command_retval_set(Jim_Interp *interp, int retval)
120 int *return_retval = Jim_GetAssocData(interp, "retval");
121 if (return_retval != NULL)
122 *return_retval = retval;
124 return (retval == ERROR_OK) ? JIM_OK : retval;
127 extern struct command_context *global_cmd_ctx;
129 /* dump a single line to the log for the command.
130 * Do nothing in case we are not at debug level 3 */
131 void script_debug(Jim_Interp *interp, const char *name,
132 unsigned argc, Jim_Obj * const *argv)
134 if (debug_level < LOG_LVL_DEBUG)
137 char *dbg = alloc_printf("command - %s", name);
138 for (unsigned i = 0; i < argc; i++) {
140 const char *w = Jim_GetString(argv[i], &len);
141 char *t = alloc_printf("%s %s", dbg, w);
145 LOG_DEBUG("%s", dbg);
149 static void script_command_args_free(char **words, unsigned nwords)
151 for (unsigned i = 0; i < nwords; i++)
156 static char **script_command_args_alloc(
157 unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
159 char **words = malloc(argc * sizeof(char *));
164 for (i = 0; i < argc; i++) {
166 const char *w = Jim_GetString(argv[i], &len);
167 words[i] = strdup(w);
168 if (words[i] == NULL) {
169 script_command_args_free(words, i);
177 struct command_context *current_command_context(Jim_Interp *interp)
179 /* grab the command context from the associated data */
180 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
181 if (NULL == cmd_ctx) {
182 /* Tcl can invoke commands directly instead of via command_run_line(). This would
183 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
184 * commands in a startup script.
186 * A telnet or gdb server would provide a non-default command context to
187 * handle piping of error output, have a separate current target, etc.
189 cmd_ctx = global_cmd_ctx;
194 static int script_command_run(Jim_Interp *interp,
195 int argc, Jim_Obj * const *argv, struct command *c, bool capture)
197 target_call_timer_callbacks_now();
198 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
201 char **words = script_command_args_alloc(argc, argv, &nwords);
205 struct log_capture_state *state = NULL;
207 state = command_log_capture_start(interp);
209 struct command_context *cmd_ctx = current_command_context(interp);
210 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
212 command_log_capture_finish(state);
214 script_command_args_free(words, nwords);
215 return command_retval_set(interp, retval);
218 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
220 /* the private data is stashed in the interp structure */
222 struct command *c = interp->cmdPrivData;
224 script_debug(interp, c->name, argc, argv);
225 return script_command_run(interp, argc, argv, c, true);
228 static struct command *command_root(struct command *c)
230 while (NULL != c->parent)
236 * Find a command by name from a list of commands.
237 * @returns Returns the named command if it exists in the list.
238 * Returns NULL otherwise.
240 static struct command *command_find(struct command *head, const char *name)
242 for (struct command *cc = head; cc; cc = cc->next) {
243 if (strcmp(cc->name, name) == 0)
249 struct command *command_find_in_context(struct command_context *cmd_ctx,
252 return command_find(cmd_ctx->commands, name);
254 struct command *command_find_in_parent(struct command *parent,
257 return command_find(parent->children, name);
261 * Add the command into the linked list, sorted by name.
262 * @param head Address to head of command list pointer, which may be
263 * updated if @c c gets inserted at the beginning of the list.
264 * @param c The command to add to the list pointed to by @c head.
266 static void command_add_child(struct command **head, struct command *c)
274 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
275 head = &(*head)->next;
277 if (strcmp(c->name, (*head)->name) > 0) {
278 c->next = (*head)->next;
286 static struct command **command_list_for_parent(
287 struct command_context *cmd_ctx, struct command *parent)
289 return parent ? &parent->children : &cmd_ctx->commands;
292 static void command_free(struct command *c)
294 /** @todo if command has a handler, unregister its jim command! */
296 while (NULL != c->children) {
297 struct command *tmp = c->children;
298 c->children = tmp->next;
308 static struct command *command_new(struct command_context *cmd_ctx,
309 struct command *parent, const struct command_registration *cr)
314 * If it is a non-jim command with no .usage specified,
317 * strlen(.usage) == 0 means that the command takes no
320 if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
321 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
322 "'.usage' field filled out",
323 parent && parent->name ? parent->name : "",
324 parent && parent->name ? " " : "",
328 struct command *c = calloc(1, sizeof(struct command));
332 c->name = strdup(cr->name);
334 c->help = strdup(cr->help);
336 c->usage = strdup(cr->usage);
338 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
339 goto command_new_error;
342 c->handler = cr->handler;
343 c->jim_handler = cr->jim_handler;
344 c->jim_handler_data = cr->jim_handler_data;
347 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
356 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
358 static int register_command_handler(struct command_context *cmd_ctx,
361 Jim_Interp *interp = cmd_ctx->interp;
362 char *ocd_name = alloc_printf("ocd_%s", c->name);
363 if (NULL == ocd_name)
366 LOG_DEBUG("registering '%s'...", ocd_name);
368 Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
369 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
371 if (JIM_OK != retval)
374 /* we now need to add an overrideable proc */
375 char *override_name = alloc_printf(
376 "proc %s {args} {eval ocd_bouncer %s $args}",
378 if (NULL == override_name)
381 retval = Jim_Eval_Named(interp, override_name, 0, 0);
387 struct command *register_command(struct command_context *context,
388 struct command *parent, const struct command_registration *cr)
390 if (!context || !cr->name)
393 const char *name = cr->name;
394 struct command **head = command_list_for_parent(context, parent);
395 struct command *c = command_find(*head, name);
397 /* TODO: originally we treated attempting to register a cmd twice as an error
398 * Sometimes we need this behaviour, such as with flash banks.
399 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
400 LOG_DEBUG("command '%s' is already registered in '%s' context",
401 name, parent ? parent->name : "<global>");
405 c = command_new(context, parent, cr);
409 int retval = ERROR_OK;
410 if (NULL != cr->jim_handler && NULL == parent) {
411 retval = Jim_CreateCommand(context->interp, cr->name,
412 cr->jim_handler, cr->jim_handler_data, NULL);
413 } else if (NULL != cr->handler || NULL != parent)
414 retval = register_command_handler(context, command_root(c));
416 if (ERROR_OK != retval) {
417 unregister_command(context, parent, name);
423 int register_commands(struct command_context *cmd_ctx, struct command *parent,
424 const struct command_registration *cmds)
426 int retval = ERROR_OK;
428 for (i = 0; cmds[i].name || cmds[i].chain; i++) {
429 const struct command_registration *cr = cmds + i;
431 struct command *c = NULL;
432 if (NULL != cr->name) {
433 c = register_command(cmd_ctx, parent, cr);
439 if (NULL != cr->chain) {
440 struct command *p = c ? : parent;
441 retval = register_commands(cmd_ctx, p, cr->chain);
442 if (ERROR_OK != retval)
446 if (ERROR_OK != retval) {
447 for (unsigned j = 0; j < i; j++)
448 unregister_command(cmd_ctx, parent, cmds[j].name);
453 int unregister_all_commands(struct command_context *context,
454 struct command *parent)
459 struct command **head = command_list_for_parent(context, parent);
460 while (NULL != *head) {
461 struct command *tmp = *head;
469 int unregister_command(struct command_context *context,
470 struct command *parent, const char *name)
472 if ((!context) || (!name))
473 return ERROR_COMMAND_SYNTAX_ERROR;
475 struct command *p = NULL;
476 struct command **head = command_list_for_parent(context, parent);
477 for (struct command *c = *head; NULL != c; p = c, c = c->next) {
478 if (strcmp(name, c->name) != 0)
493 void command_set_handler_data(struct command *c, void *p)
495 if (NULL != c->handler || NULL != c->jim_handler)
496 c->jim_handler_data = p;
497 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
498 command_set_handler_data(cc, p);
501 void command_output_text(struct command_context *context, const char *data)
503 if (context && context->output_handler && data)
504 context->output_handler(context, data);
507 void command_print_sameline(struct command_context *context, const char *format, ...)
512 va_start(ap, format);
514 string = alloc_vprintf(format, ap);
515 if (string != NULL) {
516 /* we want this collected in the log + we also want to pick it up as a tcl return
519 * The latter bit isn't precisely neat, but will do for now.
521 LOG_USER_N("%s", string);
522 /* We already printed it above
523 * command_output_text(context, string); */
530 void command_print(struct command_context *context, const char *format, ...)
535 va_start(ap, format);
537 string = alloc_vprintf(format, ap);
538 if (string != NULL) {
539 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
541 /* we want this collected in the log + we also want to pick it up as a tcl return
544 * The latter bit isn't precisely neat, but will do for now.
546 LOG_USER_N("%s", string);
547 /* We already printed it above
548 * command_output_text(context, string); */
555 static char *__command_name(struct command *c, char delim, unsigned extra)
558 unsigned len = strlen(c->name);
559 if (NULL == c->parent) {
560 /* allocate enough for the name, child names, and '\0' */
561 name = malloc(len + extra + 1);
562 strcpy(name, c->name);
564 /* parent's extra must include both the space and name */
565 name = __command_name(c->parent, delim, 1 + len + extra);
566 char dstr[2] = { delim, 0 };
568 strcat(name, c->name);
573 char *command_name(struct command *c, char delim)
575 return __command_name(c, delim, 0);
578 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
580 return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
583 static int run_command(struct command_context *context,
584 struct command *c, const char *words[], unsigned num_words)
586 if (!command_can_run(context, c)) {
587 /* Many commands may be run only before/after 'init' */
596 /* handle the impossible with humor; it guarantees a bug report! */
598 when = "if Cthulhu is summoned by";
601 LOG_ERROR("The '%s' command must be used %s 'init'.",
606 struct command_invocation cmd = {
610 .argc = num_words - 1,
613 int retval = c->handler(&cmd);
614 if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
615 /* Print help for command */
616 char *full_name = command_name(c, ' ');
617 if (NULL != full_name) {
618 command_run_linef(context, "usage %s", full_name);
622 } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
623 /* just fall through for a shutdown request */
624 } else if (retval != ERROR_OK) {
625 /* we do not print out an error message because the command *should*
626 * have printed out an error
628 LOG_DEBUG("Command failed with error code %d", retval);
634 int command_run_line(struct command_context *context, char *line)
636 /* all the parent commands have been registered with the interpreter
637 * so, can just evaluate the line as a script and check for
640 /* run the line thru a script engine */
641 int retval = ERROR_FAIL;
643 /* Beware! This code needs to be reentrant. It is also possible
644 * for OpenOCD commands to be invoked directly from Tcl. This would
645 * happen when the Jim Tcl interpreter is provided by eCos for
648 Jim_Interp *interp = context->interp;
649 Jim_DeleteAssocData(interp, "context");
650 retcode = Jim_SetAssocData(interp, "context", NULL, context);
651 if (retcode == JIM_OK) {
652 /* associated the return value */
653 Jim_DeleteAssocData(interp, "retval");
654 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
655 if (retcode == JIM_OK) {
656 retcode = Jim_Eval_Named(interp, line, 0, 0);
658 Jim_DeleteAssocData(interp, "retval");
660 Jim_DeleteAssocData(interp, "context");
662 if (retcode == JIM_OK) {
666 result = Jim_GetString(Jim_GetResult(interp), &reslen);
670 for (i = 0; i < reslen; i += 256) {
675 strncpy(buff, result + i, chunk);
677 LOG_USER_N("%s", buff);
682 } else if (retcode == JIM_EXIT) {
684 * exit(Jim_GetExitCode(interp)); */
685 } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
688 Jim_MakeErrorMessage(interp);
689 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
691 if (retval == ERROR_OK) {
692 /* It wasn't a low level OpenOCD command that failed */
701 int command_run_linef(struct command_context *context, const char *format, ...)
703 int retval = ERROR_FAIL;
706 va_start(ap, format);
707 string = alloc_vprintf(format, ap);
708 if (string != NULL) {
709 retval = command_run_line(context, string);
716 void command_set_output_handler(struct command_context *context,
717 command_output_handler_t output_handler, void *priv)
719 context->output_handler = output_handler;
720 context->output_handler_priv = priv;
723 struct command_context *copy_command_context(struct command_context *context)
725 struct command_context *copy_context = malloc(sizeof(struct command_context));
727 *copy_context = *context;
732 void command_done(struct command_context *cmd_ctx)
740 /* find full path to file */
741 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
745 const char *file = Jim_GetString(argv[1], NULL);
746 char *full_path = find_file(file);
747 if (full_path == NULL)
749 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
752 Jim_SetResult(interp, result);
756 COMMAND_HANDLER(jim_echo)
758 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
759 LOG_USER_N("%s", CMD_ARGV[1]);
764 LOG_USER("%s", CMD_ARGV[0]);
768 /* Capture progress output and return as tcl return value. If the
769 * progress output was empty, return tcl return value.
771 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
776 struct log_capture_state *state = command_log_capture_start(interp);
778 /* disable polling during capture. This avoids capturing output
781 * This is necessary in order to avoid accidentally getting a non-empty
782 * string for tcl fn's.
784 bool save_poll = jtag_poll_get_enabled();
786 jtag_poll_set_enabled(false);
788 const char *str = Jim_GetString(argv[1], NULL);
789 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
791 jtag_poll_set_enabled(save_poll);
793 command_log_capture_finish(state);
798 static COMMAND_HELPER(command_help_find, struct command *head,
799 struct command **out)
802 return ERROR_COMMAND_SYNTAX_ERROR;
803 *out = command_find(head, CMD_ARGV[0]);
804 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
805 *out = command_find(head, CMD_ARGV[0] + 4);
807 return ERROR_COMMAND_SYNTAX_ERROR;
811 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
814 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
815 bool show_help, const char *cmd_match);
817 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
818 bool show_help, const char *cmd_match)
820 for (struct command *c = head; NULL != c; c = c->next)
821 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, cmd_match);
825 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
827 static void command_help_show_indent(unsigned n)
829 for (unsigned i = 0; i < n; i++)
832 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
834 const char *cp = str, *last = str;
836 const char *next = last;
841 } while (*next != ' ' && *next != '\t' && *next != '\0');
842 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
843 if (next - last < HELP_LINE_WIDTH(n))
845 command_help_show_indent(n);
846 LOG_USER("%.*s", (int)(cp - last), last);
852 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
853 bool show_help, const char *cmd_match)
855 char *cmd_name = command_name(c, ' ');
856 if (NULL == cmd_name)
859 /* If the match string occurs anywhere, we print out
860 * stuff for this command. */
861 bool is_match = (strstr(cmd_name, cmd_match) != NULL) ||
862 ((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) ||
863 ((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
866 command_help_show_indent(n);
867 LOG_USER_N("%s", cmd_name);
872 if (c->usage && strlen(c->usage) > 0) {
874 command_help_show_wrap(c->usage, 0, n + 5);
879 if (is_match && show_help) {
882 /* Normal commands are runtime-only; highlight exceptions */
883 if (c->mode != COMMAND_EXEC) {
884 const char *stage_msg = "";
888 stage_msg = " (configuration command)";
891 stage_msg = " (command valid any time)";
894 stage_msg = " (?mode error?)";
897 msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
899 msg = alloc_printf("%s", c->help ? : "");
902 command_help_show_wrap(msg, n + 3, n + 3);
909 LOG_ERROR("command recursion exceeded");
913 return CALL_COMMAND_HANDLER(command_help_show_list,
914 c->children, n, show_help, cmd_match);
917 COMMAND_HANDLER(handle_help_command)
919 bool full = strcmp(CMD_NAME, "help") == 0;
921 struct command *c = CMD_CTX->commands;
922 char *cmd_match = NULL;
926 else if (CMD_ARGC >= 1) {
929 for (i = 0; i < CMD_ARGC; ++i) {
930 if (NULL != cmd_match) {
931 char *prev = cmd_match;
933 cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]);
935 if (NULL == cmd_match) {
936 LOG_ERROR("unable to build search string");
940 cmd_match = alloc_printf("%s", CMD_ARGV[i]);
941 if (NULL == cmd_match) {
942 LOG_ERROR("unable to build search string");
948 return ERROR_COMMAND_SYNTAX_ERROR;
950 retval = CALL_COMMAND_HANDLER(command_help_show_list,
951 c, 0, full, cmd_match);
958 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
959 struct command *head, struct command **out, bool top_level)
963 const char *cmd_name = Jim_GetString(argv[0], NULL);
964 struct command *c = command_find(head, cmd_name);
965 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
966 c = command_find(head, cmd_name + 4);
970 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
973 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
975 const char *cmd_name = Jim_GetString(argv[0], NULL);
976 if (strcmp(cmd_name, "unknown") == 0) {
982 script_debug(interp, cmd_name, argc, argv);
984 struct command_context *cmd_ctx = current_command_context(interp);
985 struct command *c = cmd_ctx->commands;
986 int remaining = command_unknown_find(argc, argv, c, &c, true);
987 /* if nothing could be consumed, then it's really an unknown command */
988 if (remaining == argc) {
989 const char *cmd = Jim_GetString(argv[0], NULL);
990 LOG_ERROR("Unknown command:\n %s", cmd);
995 Jim_Obj *const *start;
997 if (c->handler || c->jim_handler) {
998 /* include the command name in the list */
999 count = remaining + 1;
1000 start = argv + (argc - remaining - 1);
1002 c = command_find(cmd_ctx->commands, "usage");
1004 LOG_ERROR("unknown command, but usage is missing too");
1007 count = argc - remaining;
1011 /* pass the command through to the intended handler */
1012 if (c->jim_handler) {
1013 interp->cmdPrivData = c->jim_handler_data;
1014 return (*c->jim_handler)(interp, count, start);
1017 return script_command_run(interp, count, start, c, found);
1020 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1022 struct command_context *cmd_ctx = current_command_context(interp);
1023 enum command_mode mode;
1026 struct command *c = cmd_ctx->commands;
1027 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1028 /* if nothing could be consumed, then it's an unknown command */
1029 if (remaining == argc - 1) {
1030 Jim_SetResultString(interp, "unknown", -1);
1035 mode = cmd_ctx->mode;
1037 const char *mode_str;
1042 case COMMAND_CONFIG:
1043 mode_str = "config";
1049 mode_str = "unknown";
1052 Jim_SetResultString(interp, mode_str, -1);
1056 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1061 struct command_context *cmd_ctx = current_command_context(interp);
1062 struct command *c = cmd_ctx->commands;
1063 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1064 /* if nothing could be consumed, then it's an unknown command */
1065 if (remaining == argc - 1) {
1066 Jim_SetResultString(interp, "unknown", -1);
1071 Jim_SetResultString(interp, "native", -1);
1072 else if (c->handler)
1073 Jim_SetResultString(interp, "simple", -1);
1074 else if (remaining == 0)
1075 Jim_SetResultString(interp, "group", -1);
1077 Jim_SetResultString(interp, "unknown", -1);
1082 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1083 const char *cmd_name, const char *help_text, const char *usage)
1085 struct command **head = command_list_for_parent(cmd_ctx, parent);
1086 struct command *nc = command_find(*head, cmd_name);
1088 /* add a new command with help text */
1089 struct command_registration cr = {
1091 .mode = COMMAND_ANY,
1095 nc = register_command(cmd_ctx, parent, &cr);
1097 LOG_ERROR("failed to add '%s' help text", cmd_name);
1100 LOG_DEBUG("added '%s' help text", cmd_name);
1104 bool replaced = false;
1109 nc->help = strdup(help_text);
1111 LOG_INFO("replaced existing '%s' help", cmd_name);
1113 LOG_DEBUG("added '%s' help text", cmd_name);
1116 bool replaced = false;
1121 nc->usage = strdup(usage);
1123 LOG_INFO("replaced existing '%s' usage", cmd_name);
1125 LOG_DEBUG("added '%s' usage text", cmd_name);
1130 COMMAND_HANDLER(handle_help_add_command)
1133 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1134 return ERROR_COMMAND_SYNTAX_ERROR;
1137 /* save help text and remove it from argument list */
1138 const char *str = CMD_ARGV[--CMD_ARGC];
1139 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1140 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1141 if (!help && !usage) {
1142 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1143 return ERROR_COMMAND_SYNTAX_ERROR;
1145 /* likewise for the leaf command name */
1146 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1148 struct command *c = NULL;
1150 c = CMD_CTX->commands;
1151 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1152 if (ERROR_OK != retval)
1155 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1158 /* sleep command sleeps for <n> milliseconds
1159 * this is useful in target startup scripts
1161 COMMAND_HANDLER(handle_sleep_command)
1164 if (CMD_ARGC == 2) {
1165 if (strcmp(CMD_ARGV[1], "busy") == 0)
1168 return ERROR_COMMAND_SYNTAX_ERROR;
1169 } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1170 return ERROR_COMMAND_SYNTAX_ERROR;
1172 unsigned long duration = 0;
1173 int retval = parse_ulong(CMD_ARGV[0], &duration);
1174 if (ERROR_OK != retval)
1178 long long then = timeval_ms();
1179 while (timeval_ms() - then < (long long)duration) {
1180 target_call_timer_callbacks_now();
1184 busy_sleep(duration);
1189 static const struct command_registration command_subcommand_handlers[] = {
1192 .mode = COMMAND_ANY,
1193 .jim_handler = jim_command_mode,
1194 .usage = "[command_name ...]",
1195 .help = "Returns the command modes allowed by a command:"
1196 "'any', 'config', or 'exec'. If no command is"
1197 "specified, returns the current command mode. "
1198 "Returns 'unknown' if an unknown command is given. "
1199 "Command can be multiple tokens.",
1203 .mode = COMMAND_ANY,
1204 .jim_handler = jim_command_type,
1205 .usage = "command_name [...]",
1206 .help = "Returns the type of built-in command:"
1207 "'native', 'simple', 'group', or 'unknown'. "
1208 "Command can be multiple tokens.",
1210 COMMAND_REGISTRATION_DONE
1213 static const struct command_registration command_builtin_handlers[] = {
1216 .handler = jim_echo,
1217 .mode = COMMAND_ANY,
1218 .help = "Logs a message at \"user\" priority. "
1219 "Output message to stdout. "
1220 "Option \"-n\" suppresses trailing newline",
1221 .usage = "[-n] string",
1224 .name = "add_help_text",
1225 .handler = handle_help_add_command,
1226 .mode = COMMAND_ANY,
1227 .help = "Add new command help text; "
1228 "Command can be multiple tokens.",
1229 .usage = "command_name helptext_string",
1232 .name = "add_usage_text",
1233 .handler = handle_help_add_command,
1234 .mode = COMMAND_ANY,
1235 .help = "Add new command usage text; "
1236 "command can be multiple tokens.",
1237 .usage = "command_name usage_string",
1241 .handler = handle_sleep_command,
1242 .mode = COMMAND_ANY,
1243 .help = "Sleep for specified number of milliseconds. "
1244 "\"busy\" will busy wait instead (avoid this).",
1245 .usage = "milliseconds ['busy']",
1249 .handler = handle_help_command,
1250 .mode = COMMAND_ANY,
1251 .help = "Show full command help; "
1252 "command can be multiple tokens.",
1253 .usage = "[command_name]",
1257 .handler = handle_help_command,
1258 .mode = COMMAND_ANY,
1259 .help = "Show basic command usage; "
1260 "command can be multiple tokens.",
1261 .usage = "[command_name]",
1265 .mode = COMMAND_ANY,
1266 .help = "core command group (introspection)",
1267 .chain = command_subcommand_handlers,
1269 COMMAND_REGISTRATION_DONE
1272 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
1274 struct command_context *context = malloc(sizeof(struct command_context));
1277 context->mode = COMMAND_EXEC;
1278 context->commands = NULL;
1279 context->current_target = 0;
1280 context->output_handler = NULL;
1281 context->output_handler_priv = NULL;
1283 /* Create a jim interpreter if we were not handed one */
1284 if (interp == NULL) {
1285 /* Create an interpreter */
1286 interp = Jim_CreateInterp();
1287 /* Add all the Jim core commands */
1288 Jim_RegisterCoreCommands(interp);
1289 Jim_InitStaticExtensions(interp);
1292 context->interp = interp;
1294 /* Stick to lowercase for HostOS strings. */
1295 #if defined(_MSC_VER)
1296 /* WinXX - is generic, the forward
1297 * looking problem is this:
1299 * "win32" or "win64"
1301 * "winxx" is generic.
1304 #elif defined(__linux__)
1306 #elif defined(__APPLE__) || defined(__DARWIN__)
1308 #elif defined(__CYGWIN__)
1310 #elif defined(__MINGW32__)
1312 #elif defined(__ECOS)
1314 #elif defined(__FreeBSD__)
1316 #elif defined(__NetBSD__)
1318 #elif defined(__OpenBSD__)
1321 #warning "Unrecognized host OS..."
1324 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1325 Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
1327 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1328 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1330 register_commands(context, NULL, command_builtin_handlers);
1332 Jim_SetAssocData(interp, "context", NULL, context);
1333 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
1334 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1335 Jim_MakeErrorMessage(interp);
1336 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1339 Jim_DeleteAssocData(interp, "context");
1344 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1347 return ERROR_COMMAND_SYNTAX_ERROR;
1349 cmd_ctx->mode = mode;
1353 void process_jim_events(struct command_context *cmd_ctx)
1355 static int recursion;
1360 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1364 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1365 int parse ## name(const char *str, type * ul) \
1368 LOG_ERROR("Invalid command argument"); \
1369 return ERROR_COMMAND_ARGUMENT_INVALID; \
1372 *ul = func(str, &end, 0); \
1374 LOG_ERROR("Invalid command argument"); \
1375 return ERROR_COMMAND_ARGUMENT_INVALID; \
1377 if ((max == *ul) && (ERANGE == errno)) { \
1378 LOG_ERROR("Argument overflow"); \
1379 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1381 if (min && (min == *ul) && (ERANGE == errno)) { \
1382 LOG_ERROR("Argument underflow"); \
1383 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1387 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
1388 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1389 DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
1390 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1392 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1393 int parse ## name(const char *str, type * ul) \
1396 int retval = parse ## funcname(str, &n); \
1397 if (ERROR_OK != retval) \
1400 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1402 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1407 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1408 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1409 DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
1410 DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
1411 DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
1412 DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
1413 DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
1415 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1416 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1417 DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
1418 DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
1419 DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1420 DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1421 DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1423 static int command_parse_bool(const char *in, bool *out,
1424 const char *on, const char *off)
1426 if (strcasecmp(in, on) == 0)
1428 else if (strcasecmp(in, off) == 0)
1431 return ERROR_COMMAND_SYNTAX_ERROR;
1435 int command_parse_bool_arg(const char *in, bool *out)
1437 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1439 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1441 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1443 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1445 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1447 return ERROR_COMMAND_SYNTAX_ERROR;
1450 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1454 const char *in = CMD_ARGV[0];
1455 if (command_parse_bool_arg(in, out) != ERROR_OK) {
1456 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1457 return ERROR_COMMAND_SYNTAX_ERROR;
1462 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1465 return ERROR_COMMAND_SYNTAX_ERROR;