1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 /***************************************************************************
4 * Copyright (C) 2005 by Dominic Rath *
5 * Dominic.Rath@gmx.de *
7 * Copyright (C) 2007,2008 Øyvind Harboe *
8 * oyvind.harboe@zylin.com *
10 * Copyright (C) 2008, Duane Ellis *
11 * openocd@duaneeellis.com *
13 * part of this file is taken from libcli (libcli.sourceforge.net) *
14 * Copyright (C) David Parrish (david@dparrish.com) *
15 ***************************************************************************/
21 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
24 /* @todo the inclusion of target.h here is a layering violation */
25 #include <jtag/jtag.h>
26 #include <target/target.h>
28 #include "configuration.h"
30 #include "time_support.h"
31 #include "jim-eventloop.h"
33 /* nice short description of source file */
34 #define __THIS__FILE__ "command.c"
36 struct log_capture_state {
41 static int unregister_command(struct command_context *context,
42 const char *cmd_prefix, const char *name);
43 static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
44 static int help_add_command(struct command_context *cmd_ctx,
45 const char *cmd_name, const char *help_text, const char *usage_text);
46 static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name);
48 /* set of functions to wrap jimtcl internal data */
49 static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
54 bool jimcmd_is_oocd_command(Jim_Cmd *cmd)
56 return !cmd->isproc && cmd->u.native.cmdProc == jim_command_dispatch;
59 void *jimcmd_privdata(Jim_Cmd *cmd)
61 return cmd->isproc ? NULL : cmd->u.native.privData;
64 static void tcl_output(void *privData, const char *file, unsigned line,
65 const char *function, const char *string)
67 struct log_capture_state *state = privData;
68 Jim_AppendString(state->interp, state->output, string, strlen(string));
71 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
73 /* capture log output and return it. A garbage collect can
74 * happen, so we need a reference count to this object */
75 Jim_Obj *jim_output = Jim_NewStringObj(interp, "", 0);
79 Jim_IncrRefCount(jim_output);
81 struct log_capture_state *state = malloc(sizeof(*state));
83 LOG_ERROR("Out of memory");
84 Jim_DecrRefCount(interp, jim_output);
88 state->interp = interp;
89 state->output = jim_output;
91 log_add_callback(tcl_output, state);
96 /* Classic openocd commands provide progress output which we
97 * will capture and return as a Tcl return value.
99 * However, if a non-openocd command has been invoked, then it
100 * makes sense to return the tcl return value from that command.
102 * The tcl return value is empty for openocd commands that provide
105 * Therefore we set the tcl return value only if we actually
108 static void command_log_capture_finish(struct log_capture_state *state)
113 log_remove_callback(tcl_output, state);
116 Jim_GetString(state->output, &length);
119 Jim_SetResult(state->interp, state->output);
121 /* No output captured, use tcl return value (which could
124 Jim_DecrRefCount(state->interp, state->output);
129 static int command_retval_set(Jim_Interp *interp, int retval)
131 int *return_retval = Jim_GetAssocData(interp, "retval");
133 *return_retval = retval;
135 return (retval == ERROR_OK) ? JIM_OK : retval;
138 extern struct command_context *global_cmd_ctx;
140 /* dump a single line to the log for the command.
141 * Do nothing in case we are not at debug level 3 */
142 static void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
144 if (debug_level < LOG_LVL_DEBUG)
147 char *dbg = alloc_printf("command -");
148 for (unsigned i = 0; i < argc; i++) {
150 const char *w = Jim_GetString(argv[i], &len);
151 char *t = alloc_printf("%s %s", dbg, w);
155 LOG_DEBUG("%s", dbg);
159 static void script_command_args_free(char **words, unsigned nwords)
161 for (unsigned i = 0; i < nwords; i++)
166 static char **script_command_args_alloc(
167 unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
169 char **words = malloc(argc * sizeof(char *));
174 for (i = 0; i < argc; i++) {
176 const char *w = Jim_GetString(argv[i], &len);
177 words[i] = strdup(w);
179 script_command_args_free(words, i);
187 struct command_context *current_command_context(Jim_Interp *interp)
189 /* grab the command context from the associated data */
190 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
192 /* Tcl can invoke commands directly instead of via command_run_line(). This would
193 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
194 * commands in a startup script.
196 * A telnet or gdb server would provide a non-default command context to
197 * handle piping of error output, have a separate current target, etc.
199 cmd_ctx = global_cmd_ctx;
205 * Find a openocd command from fullname.
206 * @returns Returns the named command if it is registred in interp.
207 * Returns NULL otherwise.
209 static struct command *command_find_from_name(Jim_Interp *interp, const char *name)
214 Jim_Obj *jim_name = Jim_NewStringObj(interp, name, -1);
215 Jim_IncrRefCount(jim_name);
216 Jim_Cmd *cmd = Jim_GetCommand(interp, jim_name, JIM_NONE);
217 Jim_DecrRefCount(interp, jim_name);
218 if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_oocd_command(cmd))
221 return jimcmd_privdata(cmd);
224 static struct command *command_new(struct command_context *cmd_ctx,
225 const char *full_name, const struct command_registration *cr)
230 * If it is a non-jim command with no .usage specified,
233 * strlen(.usage) == 0 means that the command takes no
236 if (!cr->jim_handler && !cr->usage)
237 LOG_ERROR("BUG: command '%s' does not have the "
238 "'.usage' field filled out",
241 struct command *c = calloc(1, sizeof(struct command));
245 c->name = strdup(cr->name);
251 c->handler = cr->handler;
252 c->jim_handler = cr->jim_handler;
255 if (cr->help || cr->usage)
256 help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
261 static void command_free(struct Jim_Interp *interp, void *priv)
263 struct command *c = priv;
269 static struct command *register_command(struct command_context *context,
270 const char *cmd_prefix, const struct command_registration *cr)
274 if (!context || !cr->name)
278 full_name = alloc_printf("%s %s", cmd_prefix, cr->name);
280 full_name = strdup(cr->name);
284 struct command *c = command_find_from_name(context->interp, full_name);
286 /* TODO: originally we treated attempting to register a cmd twice as an error
287 * Sometimes we need this behaviour, such as with flash banks.
288 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
289 LOG_DEBUG("command '%s' is already registered", full_name);
294 c = command_new(context, full_name, cr);
300 if (false) /* too noisy with debug_level 3 */
301 LOG_DEBUG("registering '%s'...", full_name);
302 int retval = Jim_CreateCommand(context->interp, full_name,
303 jim_command_dispatch, c, command_free);
304 if (retval != JIM_OK) {
305 command_run_linef(context, "del_help_text {%s}", full_name);
306 command_run_linef(context, "del_usage_text {%s}", full_name);
316 int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
317 const struct command_registration *cmds, void *data,
318 struct target *override_target)
320 int retval = ERROR_OK;
322 for (i = 0; cmds[i].name || cmds[i].chain; i++) {
323 const struct command_registration *cr = cmds + i;
325 struct command *c = NULL;
327 c = register_command(cmd_ctx, cmd_prefix, cr);
332 c->jim_handler_data = data;
333 c->jim_override_target = override_target;
338 char *new_prefix = alloc_printf("%s %s", cmd_prefix, cr->name);
343 retval = __register_commands(cmd_ctx, new_prefix, cr->chain, data, override_target);
346 retval = __register_commands(cmd_ctx, cr->name, cr->chain, data, override_target);
349 retval = __register_commands(cmd_ctx, cmd_prefix, cr->chain, data, override_target);
351 if (retval != ERROR_OK)
355 if (retval != ERROR_OK) {
356 for (unsigned j = 0; j < i; j++)
357 unregister_command(cmd_ctx, cmd_prefix, cmds[j].name);
362 static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)))
363 int unregister_commands_match(struct command_context *cmd_ctx, const char *format, ...)
365 Jim_Interp *interp = cmd_ctx->interp;
368 va_start(ap, format);
369 char *query = alloc_vprintf(format, ap);
374 char *query_cmd = alloc_printf("info commands {%s}", query);
379 int retval = Jim_EvalSource(interp, __THIS__FILE__, __LINE__, query_cmd);
381 if (retval != JIM_OK)
384 Jim_Obj *list = Jim_GetResult(interp);
385 Jim_IncrRefCount(list);
387 int len = Jim_ListLength(interp, list);
388 for (int i = 0; i < len; i++) {
389 Jim_Obj *elem = Jim_ListGetIndex(interp, list, i);
390 Jim_IncrRefCount(elem);
392 const char *name = Jim_GetString(elem, NULL);
393 struct command *c = command_find_from_name(interp, name);
395 /* not openocd command */
396 Jim_DecrRefCount(interp, elem);
399 if (false) /* too noisy with debug_level 3 */
400 LOG_DEBUG("delete command \"%s\"", name);
401 #if JIM_VERSION >= 80
402 Jim_DeleteCommand(interp, elem);
404 Jim_DeleteCommand(interp, name);
407 help_del_command(cmd_ctx, name);
409 Jim_DecrRefCount(interp, elem);
412 Jim_DecrRefCount(interp, list);
416 int unregister_all_commands(struct command_context *context,
417 const char *cmd_prefix)
422 if (!cmd_prefix || !*cmd_prefix)
423 return unregister_commands_match(context, "*");
425 int retval = unregister_commands_match(context, "%s *", cmd_prefix);
426 if (retval != ERROR_OK)
429 return unregister_commands_match(context, "%s", cmd_prefix);
432 static int unregister_command(struct command_context *context,
433 const char *cmd_prefix, const char *name)
435 if (!context || !name)
436 return ERROR_COMMAND_SYNTAX_ERROR;
438 if (!cmd_prefix || !*cmd_prefix)
439 return unregister_commands_match(context, "%s", name);
441 return unregister_commands_match(context, "%s %s", cmd_prefix, name);
444 void command_output_text(struct command_context *context, const char *data)
446 if (context && context->output_handler && data)
447 context->output_handler(context, data);
450 void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
455 va_start(ap, format);
457 string = alloc_vprintf(format, ap);
459 /* we want this collected in the log + we also want to pick it up as a tcl return
462 * The latter bit isn't precisely neat, but will do for now.
464 Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
465 /* We already printed it above
466 * command_output_text(context, string); */
473 void command_print(struct command_invocation *cmd, const char *format, ...)
478 va_start(ap, format);
480 string = alloc_vprintf(format, ap);
482 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
484 /* we want this collected in the log + we also want to pick it up as a tcl return
487 * The latter bit isn't precisely neat, but will do for now.
489 Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
490 /* We already printed it above
491 * command_output_text(context, string); */
498 static bool command_can_run(struct command_context *cmd_ctx, struct command *c, const char *full_name)
500 if (c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode)
503 /* Many commands may be run only before/after 'init' */
512 /* handle the impossible with humor; it guarantees a bug report! */
514 when = "if Cthulhu is summoned by";
517 LOG_ERROR("The '%s' command must be used %s 'init'.",
518 full_name ? full_name : c->name, when);
522 static int run_command(struct command_context *context,
523 struct command *c, const char **words, unsigned num_words)
525 struct command_invocation cmd = {
529 .argc = num_words - 1,
533 cmd.output = Jim_NewEmptyStringObj(context->interp);
534 Jim_IncrRefCount(cmd.output);
536 int retval = c->handler(&cmd);
537 if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
538 /* Print help for command */
539 command_run_linef(context, "usage %s", words[0]);
540 } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
541 /* just fall through for a shutdown request */
543 if (retval != ERROR_OK)
544 LOG_DEBUG("Command '%s' failed with error code %d",
546 /* Use the command output as the Tcl result */
547 Jim_SetResult(context->interp, cmd.output);
549 Jim_DecrRefCount(context->interp, cmd.output);
554 int command_run_line(struct command_context *context, char *line)
556 /* all the parent commands have been registered with the interpreter
557 * so, can just evaluate the line as a script and check for
560 /* run the line thru a script engine */
561 int retval = ERROR_FAIL;
563 /* Beware! This code needs to be reentrant. It is also possible
564 * for OpenOCD commands to be invoked directly from Tcl. This would
565 * happen when the Jim Tcl interpreter is provided by eCos for
568 struct target *saved_target_override = context->current_target_override;
569 context->current_target_override = NULL;
571 Jim_Interp *interp = context->interp;
572 struct command_context *old_context = Jim_GetAssocData(interp, "context");
573 Jim_DeleteAssocData(interp, "context");
574 retcode = Jim_SetAssocData(interp, "context", NULL, context);
575 if (retcode == JIM_OK) {
576 /* associated the return value */
577 Jim_DeleteAssocData(interp, "retval");
578 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
579 if (retcode == JIM_OK) {
580 retcode = Jim_Eval_Named(interp, line, 0, 0);
582 Jim_DeleteAssocData(interp, "retval");
584 Jim_DeleteAssocData(interp, "context");
585 int inner_retcode = Jim_SetAssocData(interp, "context", NULL, old_context);
586 if (retcode == JIM_OK)
587 retcode = inner_retcode;
589 context->current_target_override = saved_target_override;
590 if (retcode == JIM_OK) {
594 result = Jim_GetString(Jim_GetResult(interp), &reslen);
596 command_output_text(context, result);
597 command_output_text(context, "\n");
600 } else if (retcode == JIM_EXIT) {
602 * exit(Jim_GetExitCode(interp)); */
603 } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
606 Jim_MakeErrorMessage(interp);
607 /* error is broadcast */
608 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
610 if (retval == ERROR_OK) {
611 /* It wasn't a low level OpenOCD command that failed */
620 int command_run_linef(struct command_context *context, const char *format, ...)
622 int retval = ERROR_FAIL;
625 va_start(ap, format);
626 string = alloc_vprintf(format, ap);
628 retval = command_run_line(context, string);
635 void command_set_output_handler(struct command_context *context,
636 command_output_handler_t output_handler, void *priv)
638 context->output_handler = output_handler;
639 context->output_handler_priv = priv;
642 struct command_context *copy_command_context(struct command_context *context)
644 struct command_context *copy_context = malloc(sizeof(struct command_context));
646 *copy_context = *context;
651 void command_done(struct command_context *cmd_ctx)
659 /* find full path to file */
660 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
664 const char *file = Jim_GetString(argv[1], NULL);
665 char *full_path = find_file(file);
668 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
671 Jim_SetResult(interp, result);
675 COMMAND_HANDLER(handle_echo)
677 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
678 LOG_USER_N("%s", CMD_ARGV[1]);
685 LOG_USER("%s", CMD_ARGV[0]);
689 /* Capture progress output and return as tcl return value. If the
690 * progress output was empty, return tcl return value.
692 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
697 struct log_capture_state *state = command_log_capture_start(interp);
699 /* disable polling during capture. This avoids capturing output
702 * This is necessary in order to avoid accidentally getting a non-empty
703 * string for tcl fn's.
705 bool save_poll_mask = jtag_poll_mask();
707 const char *str = Jim_GetString(argv[1], NULL);
708 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
710 jtag_poll_unmask(save_poll_mask);
712 command_log_capture_finish(state);
724 static COMMAND_HELPER(command_help_show, struct help_entry *c,
725 bool show_help, const char *cmd_match);
727 static COMMAND_HELPER(command_help_show_list, bool show_help, const char *cmd_match)
729 struct help_entry *entry;
731 list_for_each_entry(entry, CMD_CTX->help_list, lh)
732 CALL_COMMAND_HANDLER(command_help_show, entry, show_help, cmd_match);
736 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
738 static void command_help_show_indent(unsigned n)
740 for (unsigned i = 0; i < n; i++)
743 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
745 const char *cp = str, *last = str;
747 const char *next = last;
752 } while (*next != ' ' && *next != '\t' && *next != '\0');
753 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
754 if (next - last < HELP_LINE_WIDTH(n))
756 command_help_show_indent(n);
757 LOG_USER("%.*s", (int)(cp - last), last);
763 static COMMAND_HELPER(command_help_show, struct help_entry *c,
764 bool show_help, const char *cmd_match)
767 for (const char *s = strchr(c->cmd_name, ' '); s; s = strchr(s + 1, ' '))
770 /* If the match string occurs anywhere, we print out
771 * stuff for this command. */
772 bool is_match = strstr(c->cmd_name, cmd_match) ||
773 (c->usage && strstr(c->usage, cmd_match)) ||
774 (c->help && strstr(c->help, cmd_match));
777 if (c->usage && strlen(c->usage) > 0) {
778 char *msg = alloc_printf("%s %s", c->cmd_name, c->usage);
779 command_help_show_wrap(msg, n, n + 5);
782 command_help_show_wrap(c->cmd_name, n, n + 5);
786 if (is_match && show_help) {
789 /* TODO: factorize jim_command_mode() to avoid running jim command here */
790 char *request = alloc_printf("command mode %s", c->cmd_name);
792 LOG_ERROR("Out of memory");
795 int retval = Jim_Eval(CMD_CTX->interp, request);
797 enum command_mode mode = COMMAND_UNKNOWN;
798 if (retval != JIM_ERR) {
799 const char *result = Jim_GetString(Jim_GetResult(CMD_CTX->interp), NULL);
800 if (!strcmp(result, "any"))
802 else if (!strcmp(result, "config"))
803 mode = COMMAND_CONFIG;
804 else if (!strcmp(result, "exec"))
808 /* Normal commands are runtime-only; highlight exceptions */
809 if (mode != COMMAND_EXEC) {
810 const char *stage_msg = "";
814 stage_msg = " (configuration command)";
817 stage_msg = " (command valid any time)";
820 stage_msg = " (?mode error?)";
823 msg = alloc_printf("%s%s", c->help ? c->help : "", stage_msg);
825 msg = alloc_printf("%s", c->help ? c->help : "");
828 command_help_show_wrap(msg, n + 3, n + 3);
837 COMMAND_HANDLER(handle_help_command)
839 bool full = strcmp(CMD_NAME, "help") == 0;
844 cmd_match = strdup("");
847 cmd_match = strdup(CMD_ARGV[0]);
849 for (unsigned int i = 1; i < CMD_ARGC && cmd_match; ++i) {
850 char *prev = cmd_match;
851 cmd_match = alloc_printf("%s %s", prev, CMD_ARGV[i]);
857 LOG_ERROR("unable to build search string");
860 retval = CALL_COMMAND_HANDLER(command_help_show_list, full, cmd_match);
866 static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
873 all = strdup(Jim_GetString(argv[0], NULL));
875 LOG_ERROR("Out of memory");
879 for (i = 1; i < argc; ++i) {
881 all = alloc_printf("%s %s", all, Jim_GetString(argv[i], NULL));
884 LOG_ERROR("Out of memory");
892 static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
893 struct command *c, int argc, Jim_Obj * const *argv)
896 return c->jim_handler(interp, argc, argv);
900 char **words = script_command_args_alloc(argc, argv, &nwords);
904 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
905 script_command_args_free(words, nwords);
906 return command_retval_set(interp, retval);
909 static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
911 /* check subcommands */
913 char *s = alloc_printf("%s %s", Jim_GetString(argv[0], NULL), Jim_GetString(argv[1], NULL));
914 Jim_Obj *js = Jim_NewStringObj(interp, s, -1);
915 Jim_IncrRefCount(js);
917 Jim_Cmd *cmd = Jim_GetCommand(interp, js, JIM_NONE);
919 int retval = Jim_EvalObjPrefix(interp, js, argc - 2, argv + 2);
920 Jim_DecrRefCount(interp, js);
923 Jim_DecrRefCount(interp, js);
926 script_debug(interp, argc, argv);
928 struct command *c = jim_to_command(interp);
929 if (!c->jim_handler && !c->handler) {
930 Jim_EvalObjPrefix(interp, Jim_NewStringObj(interp, "usage", -1), 1, argv);
934 struct command_context *cmd_ctx = current_command_context(interp);
936 if (!command_can_run(cmd_ctx, c, Jim_GetString(argv[0], NULL)))
939 target_call_timer_callbacks_now();
942 * Black magic of overridden current target:
943 * If the command we are going to handle has a target prefix,
944 * override the current target temporarily for the time
945 * of processing the command.
946 * current_target_override is used also for event handlers
947 * therefore we prevent touching it if command has no prefix.
948 * Previous override is saved and restored back to ensure
949 * correct work when jim_command_dispatch() is re-entered.
951 struct target *saved_target_override = cmd_ctx->current_target_override;
952 if (c->jim_override_target)
953 cmd_ctx->current_target_override = c->jim_override_target;
955 int retval = exec_command(interp, cmd_ctx, c, argc, argv);
957 if (c->jim_override_target)
958 cmd_ctx->current_target_override = saved_target_override;
963 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
965 struct command_context *cmd_ctx = current_command_context(interp);
966 enum command_mode mode;
969 char *full_name = alloc_concatenate_strings(argc - 1, argv + 1);
972 Jim_Obj *s = Jim_NewStringObj(interp, full_name, -1);
974 Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
975 Jim_DecrRefCount(interp, s);
977 if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_oocd_command(cmd))) {
978 Jim_SetResultString(interp, "unknown", -1);
982 if (jimcmd_is_proc(cmd)) {
986 struct command *c = jimcmd_privdata(cmd);
991 mode = cmd_ctx->mode;
993 const char *mode_str;
1005 mode_str = "unknown";
1008 Jim_SetResultString(interp, mode_str, -1);
1012 int help_del_all_commands(struct command_context *cmd_ctx)
1014 struct help_entry *curr, *n;
1016 list_for_each_entry_safe(curr, n, cmd_ctx->help_list, lh) {
1017 list_del(&curr->lh);
1018 free(curr->cmd_name);
1026 static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name)
1028 struct help_entry *curr;
1030 list_for_each_entry(curr, cmd_ctx->help_list, lh) {
1031 if (!strcmp(cmd_name, curr->cmd_name)) {
1032 list_del(&curr->lh);
1033 free(curr->cmd_name);
1044 static int help_add_command(struct command_context *cmd_ctx,
1045 const char *cmd_name, const char *help_text, const char *usage_text)
1047 int cmp = -1; /* add after curr */
1048 struct help_entry *curr;
1050 list_for_each_entry_reverse(curr, cmd_ctx->help_list, lh) {
1051 cmp = strcmp(cmd_name, curr->cmd_name);
1056 struct help_entry *entry;
1058 entry = calloc(1, sizeof(*entry));
1060 LOG_ERROR("Out of memory");
1063 entry->cmd_name = strdup(cmd_name);
1064 if (!entry->cmd_name) {
1065 LOG_ERROR("Out of memory");
1069 list_add(&entry->lh, &curr->lh);
1075 char *text = strdup(help_text);
1077 LOG_ERROR("Out of memory");
1085 char *text = strdup(usage_text);
1087 LOG_ERROR("Out of memory");
1091 entry->usage = text;
1097 COMMAND_HANDLER(handle_help_add_command)
1100 return ERROR_COMMAND_SYNTAX_ERROR;
1102 const char *help = !strcmp(CMD_NAME, "add_help_text") ? CMD_ARGV[1] : NULL;
1103 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? CMD_ARGV[1] : NULL;
1104 if (!help && !usage) {
1105 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1106 return ERROR_COMMAND_SYNTAX_ERROR;
1108 const char *cmd_name = CMD_ARGV[0];
1109 return help_add_command(CMD_CTX, cmd_name, help, usage);
1112 /* sleep command sleeps for <n> milliseconds
1113 * this is useful in target startup scripts
1115 COMMAND_HANDLER(handle_sleep_command)
1118 if (CMD_ARGC == 2) {
1119 if (strcmp(CMD_ARGV[1], "busy") == 0)
1122 return ERROR_COMMAND_SYNTAX_ERROR;
1123 } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1124 return ERROR_COMMAND_SYNTAX_ERROR;
1126 unsigned long duration = 0;
1127 int retval = parse_ulong(CMD_ARGV[0], &duration);
1128 if (retval != ERROR_OK)
1132 int64_t then = timeval_ms();
1133 while (timeval_ms() - then < (int64_t)duration) {
1134 target_call_timer_callbacks_now();
1139 busy_sleep(duration);
1144 static const struct command_registration command_subcommand_handlers[] = {
1147 .mode = COMMAND_ANY,
1148 .jim_handler = jim_command_mode,
1149 .usage = "[command_name ...]",
1150 .help = "Returns the command modes allowed by a command: "
1151 "'any', 'config', or 'exec'. If no command is "
1152 "specified, returns the current command mode. "
1153 "Returns 'unknown' if an unknown command is given. "
1154 "Command can be multiple tokens.",
1156 COMMAND_REGISTRATION_DONE
1159 static const struct command_registration command_builtin_handlers[] = {
1162 .mode = COMMAND_ANY,
1163 .jim_handler = jim_find,
1164 .help = "find full path to file",
1169 .mode = COMMAND_ANY,
1170 .jim_handler = jim_capture,
1171 .help = "Capture progress output and return as tcl return value. If the "
1172 "progress output was empty, return tcl return value.",
1177 .handler = handle_echo,
1178 .mode = COMMAND_ANY,
1179 .help = "Logs a message at \"user\" priority. "
1180 "Option \"-n\" suppresses trailing newline",
1181 .usage = "[-n] string",
1184 .name = "add_help_text",
1185 .handler = handle_help_add_command,
1186 .mode = COMMAND_ANY,
1187 .help = "Add new command help text; "
1188 "Command can be multiple tokens.",
1189 .usage = "command_name helptext_string",
1192 .name = "add_usage_text",
1193 .handler = handle_help_add_command,
1194 .mode = COMMAND_ANY,
1195 .help = "Add new command usage text; "
1196 "command can be multiple tokens.",
1197 .usage = "command_name usage_string",
1201 .handler = handle_sleep_command,
1202 .mode = COMMAND_ANY,
1203 .help = "Sleep for specified number of milliseconds. "
1204 "\"busy\" will busy wait instead (avoid this).",
1205 .usage = "milliseconds ['busy']",
1209 .handler = handle_help_command,
1210 .mode = COMMAND_ANY,
1211 .help = "Show full command help; "
1212 "command can be multiple tokens.",
1213 .usage = "[command_name]",
1217 .handler = handle_help_command,
1218 .mode = COMMAND_ANY,
1219 .help = "Show basic command usage; "
1220 "command can be multiple tokens.",
1221 .usage = "[command_name]",
1225 .mode = COMMAND_ANY,
1226 .help = "core command group (introspection)",
1227 .chain = command_subcommand_handlers,
1230 COMMAND_REGISTRATION_DONE
1233 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
1235 struct command_context *context = calloc(1, sizeof(struct command_context));
1237 context->mode = COMMAND_EXEC;
1239 /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
1240 context->help_list = malloc(sizeof(*context->help_list));
1241 INIT_LIST_HEAD(context->help_list);
1243 /* Create a jim interpreter if we were not handed one */
1245 /* Create an interpreter */
1246 interp = Jim_CreateInterp();
1247 /* Add all the Jim core commands */
1248 Jim_RegisterCoreCommands(interp);
1249 Jim_InitStaticExtensions(interp);
1252 context->interp = interp;
1254 register_commands(context, NULL, command_builtin_handlers);
1256 Jim_SetAssocData(interp, "context", NULL, context);
1257 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
1258 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1259 Jim_MakeErrorMessage(interp);
1260 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1263 Jim_DeleteAssocData(interp, "context");
1268 void command_exit(struct command_context *context)
1273 Jim_FreeInterp(context->interp);
1274 free(context->help_list);
1275 command_done(context);
1278 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1281 return ERROR_COMMAND_SYNTAX_ERROR;
1283 cmd_ctx->mode = mode;
1287 void process_jim_events(struct command_context *cmd_ctx)
1289 static int recursion;
1294 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1298 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1299 int parse ## name(const char *str, type * ul) \
1302 LOG_ERROR("Invalid command argument"); \
1303 return ERROR_COMMAND_ARGUMENT_INVALID; \
1307 *ul = func(str, &end, 0); \
1309 LOG_ERROR("Invalid command argument"); \
1310 return ERROR_COMMAND_ARGUMENT_INVALID; \
1312 if ((max == *ul) && (errno == ERANGE)) { \
1313 LOG_ERROR("Argument overflow"); \
1314 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1316 if (min && (min == *ul) && (errno == ERANGE)) { \
1317 LOG_ERROR("Argument underflow"); \
1318 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1322 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
1323 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1324 DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
1325 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1327 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1328 int parse ## name(const char *str, type * ul) \
1331 int retval = parse ## funcname(str, &n); \
1332 if (retval != ERROR_OK) \
1335 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1337 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1342 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1343 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1344 DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
1345 DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
1346 DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
1347 DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
1348 DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
1350 DEFINE_PARSE_ULONGLONG(_target_addr, target_addr_t, 0, TARGET_ADDR_MAX)
1352 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1353 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1354 DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
1355 DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
1356 DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1357 DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1358 DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1360 static int command_parse_bool(const char *in, bool *out,
1361 const char *on, const char *off)
1363 if (strcasecmp(in, on) == 0)
1365 else if (strcasecmp(in, off) == 0)
1368 return ERROR_COMMAND_SYNTAX_ERROR;
1372 int command_parse_bool_arg(const char *in, bool *out)
1374 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1376 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1378 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1380 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1382 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1384 return ERROR_COMMAND_SYNTAX_ERROR;
1387 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1391 const char *in = CMD_ARGV[0];
1392 if (command_parse_bool_arg(in, out) != ERROR_OK) {
1393 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1394 return ERROR_COMMAND_SYNTAX_ERROR;
1399 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1402 return ERROR_COMMAND_SYNTAX_ERROR;