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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
28 ***************************************************************************/
34 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
38 // @todo the inclusion of target.h here is a layering violation
39 #include <jtag/jtag.h>
40 #include <target/target.h>
42 #include "configuration.h"
44 #include "time_support.h"
45 #include "jim-eventloop.h"
48 /* nice short description of source file */
49 #define __THIS__FILE__ "command.c"
52 static int run_command(struct command_context *context,
53 struct command *c, const char *words[], unsigned num_words);
55 struct log_capture_state {
60 static void tcl_output(void *privData, const char *file, unsigned line,
61 const char *function, const char *string)
63 struct log_capture_state *state = (struct log_capture_state *)privData;
64 Jim_AppendString(state->interp, state->output, string, strlen(string));
67 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
69 /* capture log output and return it. A garbage collect can
70 * happen, so we need a reference count to this object */
71 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
72 if (NULL == tclOutput)
75 struct log_capture_state *state = malloc(sizeof(*state));
79 state->interp = interp;
80 Jim_IncrRefCount(tclOutput);
81 state->output = tclOutput;
83 log_add_callback(tcl_output, state);
88 /* Classic openocd commands provide progress output which we
89 * will capture and return as a Tcl return value.
91 * However, if a non-openocd command has been invoked, then it
92 * makes sense to return the tcl return value from that command.
94 * The tcl return value is empty for openocd commands that provide
97 * Therefore we set the tcl return value only if we actually
100 static void command_log_capture_finish(struct log_capture_state *state)
105 log_remove_callback(tcl_output, state);
108 Jim_GetString(state->output, &length);
112 Jim_SetResult(state->interp, state->output);
115 /* No output captured, use tcl return value (which could
118 Jim_DecrRefCount(state->interp, state->output);
123 static int command_retval_set(Jim_Interp *interp, int retval)
125 int *return_retval = Jim_GetAssocData(interp, "retval");
126 if (return_retval != NULL)
127 *return_retval = retval;
129 return (retval == ERROR_OK) ? JIM_OK : JIM_ERR;
132 extern struct command_context *global_cmd_ctx;
134 /* dump a single line to the log for the command.
135 * Do nothing in case we are not at debug level 3 */
136 void script_debug(Jim_Interp *interp, const char *name,
137 unsigned argc, Jim_Obj *const *argv)
139 if (debug_level < LOG_LVL_DEBUG)
142 char * dbg = alloc_printf("command - %s", name);
143 for (unsigned i = 0; i < argc; i++)
146 const char *w = Jim_GetString(argv[i], &len);
147 char * t = alloc_printf("%s %s", dbg, w);
151 LOG_DEBUG("%s", dbg);
155 static void script_command_args_free(const char **words, unsigned nwords)
157 for (unsigned i = 0; i < nwords; i++)
158 free((void *)words[i]);
161 static const char **script_command_args_alloc(
162 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
164 const char **words = malloc(argc * sizeof(char *));
169 for (i = 0; i < argc; i++)
172 const char *w = Jim_GetString(argv[i], &len);
173 words[i] = strdup(w);
174 if (words[i] == NULL)
176 script_command_args_free(words, i);
184 struct command_context *current_command_context(Jim_Interp *interp)
186 /* grab the command context from the associated data */
187 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
190 /* Tcl can invoke commands directly instead of via command_run_line(). This would
191 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
192 * commands in a startup script.
194 * A telnet or gdb server would provide a non-default command context to
195 * handle piping of error output, have a separate current target, etc.
197 cmd_ctx = global_cmd_ctx;
202 static int script_command_run(Jim_Interp *interp,
203 int argc, Jim_Obj *const *argv, struct command *c, bool capture)
205 target_call_timer_callbacks_now();
206 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
209 const char **words = script_command_args_alloc(argc, argv, &nwords);
213 struct log_capture_state *state = NULL;
215 state = command_log_capture_start(interp);
217 struct command_context *cmd_ctx = current_command_context(interp);
218 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
220 command_log_capture_finish(state);
222 script_command_args_free(words, nwords);
223 return command_retval_set(interp, retval);
226 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
228 /* the private data is stashed in the interp structure */
230 struct command *c = interp->cmdPrivData;
232 script_debug(interp, c->name, argc, argv);
233 return script_command_run(interp, argc, argv, c, true);
236 static struct command *command_root(struct command *c)
238 while (NULL != c->parent)
244 * Find a command by name from a list of commands.
245 * @returns Returns the named command if it exists in the list.
246 * Returns NULL otherwise.
248 static struct command *command_find(struct command *head, const char *name)
250 for (struct command *cc = head; cc; cc = cc->next)
252 if (strcmp(cc->name, name) == 0)
257 struct command *command_find_in_context(struct command_context *cmd_ctx,
260 return command_find(cmd_ctx->commands, name);
262 struct command *command_find_in_parent(struct command *parent,
265 return command_find(parent->children, name);
269 * Add the command into the linked list, sorted by name.
270 * @param head Address to head of command list pointer, which may be
271 * updated if @c c gets inserted at the beginning of the list.
272 * @param c The command to add to the list pointed to by @c head.
274 static void command_add_child(struct command **head, struct command *c)
283 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
284 head = &(*head)->next;
286 if (strcmp(c->name, (*head)->name) > 0) {
287 c->next = (*head)->next;
295 static struct command **command_list_for_parent(
296 struct command_context *cmd_ctx, struct command *parent)
298 return parent ? &parent->children : &cmd_ctx->commands;
301 static void command_free(struct command *c)
303 /// @todo if command has a handler, unregister its jim command!
305 while (NULL != c->children)
307 struct command *tmp = c->children;
308 c->children = tmp->next;
313 free((void *)c->name);
315 free((void*)c->help);
317 free((void*)c->usage);
321 static struct command *command_new(struct command_context *cmd_ctx,
322 struct command *parent, const struct command_registration *cr)
326 struct command *c = calloc(1, sizeof(struct command));
330 c->name = strdup(cr->name);
332 c->help = strdup(cr->help);
334 c->usage = strdup(cr->usage);
336 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
337 goto command_new_error;
340 c->handler = cr->handler;
341 c->jim_handler = cr->jim_handler;
342 c->jim_handler_data = cr->jim_handler_data;
345 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
354 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
356 static int register_command_handler(struct command_context *cmd_ctx,
359 Jim_Interp *interp = cmd_ctx->interp;
360 const char *ocd_name = alloc_printf("ocd_%s", c->name);
361 if (NULL == ocd_name)
364 LOG_DEBUG("registering '%s'...", ocd_name);
366 Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
367 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
368 free((void *)ocd_name);
369 if (JIM_OK != retval)
372 /* we now need to add an overrideable proc */
373 const char *override_name = alloc_printf(
374 "proc %s {args} {eval ocd_bouncer %s $args}",
376 if (NULL == override_name)
379 retval = Jim_Eval_Named(interp, override_name, 0, 0);
380 free((void *)override_name);
385 struct command* register_command(struct command_context *context,
386 struct command *parent, const struct command_registration *cr)
388 if (!context || !cr->name)
391 const char *name = cr->name;
392 struct command **head = command_list_for_parent(context, parent);
393 struct command *c = command_find(*head, name);
396 /* TODO: originally we treated attempting to register a cmd twice as an error
397 * Sometimes we need this behaviour, such as with flash banks.
398 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
399 LOG_DEBUG("command '%s' is already registered in '%s' context",
400 name, parent ? parent->name : "<global>");
404 c = command_new(context, parent, cr);
408 int retval = ERROR_OK;
409 if (NULL != cr->jim_handler && NULL == parent)
411 retval = Jim_CreateCommand(context->interp, cr->name,
412 cr->jim_handler, cr->jim_handler_data, NULL);
414 else if (NULL != cr->handler || NULL != parent)
415 retval = register_command_handler(context, command_root(c));
417 if (ERROR_OK != retval)
419 unregister_command(context, parent, name);
425 int register_commands(struct command_context *cmd_ctx, struct command *parent,
426 const struct command_registration *cmds)
428 int retval = ERROR_OK;
430 for (i = 0; cmds[i].name || cmds[i].chain; i++)
432 const struct command_registration *cr = cmds + i;
434 struct command *c = NULL;
435 if (NULL != cr->name)
437 c = register_command(cmd_ctx, parent, cr);
444 if (NULL != cr->chain)
446 struct command *p = c ? : parent;
447 retval = register_commands(cmd_ctx, p, cr->chain);
448 if (ERROR_OK != retval)
452 if (ERROR_OK != retval)
454 for (unsigned j = 0; j < i; j++)
455 unregister_command(cmd_ctx, parent, cmds[j].name);
460 int unregister_all_commands(struct command_context *context,
461 struct command *parent)
466 struct command **head = command_list_for_parent(context, parent);
467 while (NULL != *head)
469 struct command *tmp = *head;
477 int unregister_command(struct command_context *context,
478 struct command *parent, const char *name)
480 if ((!context) || (!name))
481 return ERROR_INVALID_ARGUMENTS;
483 struct command *p = NULL;
484 struct command **head = command_list_for_parent(context, parent);
485 for (struct command *c = *head; NULL != c; p = c, c = c->next)
487 if (strcmp(name, c->name) != 0)
502 void command_set_handler_data(struct command *c, void *p)
504 if (NULL != c->handler || NULL != c->jim_handler)
505 c->jim_handler_data = p;
506 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
507 command_set_handler_data(cc, p);
510 void command_output_text(struct command_context *context, const char *data)
512 if (context && context->output_handler && data) {
513 context->output_handler(context, data);
517 void command_print_sameline(struct command_context *context, const char *format, ...)
522 va_start(ap, format);
524 string = alloc_vprintf(format, ap);
527 /* we want this collected in the log + we also want to pick it up as a tcl return
530 * The latter bit isn't precisely neat, but will do for now.
532 LOG_USER_N("%s", string);
533 /* We already printed it above */
534 /* command_output_text(context, string); */
541 void command_print(struct command_context *context, const char *format, ...)
546 va_start(ap, format);
548 string = alloc_vprintf(format, ap);
551 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
552 /* we want this collected in the log + we also want to pick it up as a tcl return
555 * The latter bit isn't precisely neat, but will do for now.
557 LOG_USER_N("%s", string);
558 /* We already printed it above */
559 /* command_output_text(context, string); */
566 static char *__command_name(struct command *c, char delim, unsigned extra)
569 unsigned len = strlen(c->name);
570 if (NULL == c->parent) {
571 // allocate enough for the name, child names, and '\0'
572 name = malloc(len + extra + 1);
573 strcpy(name, c->name);
575 // parent's extra must include both the space and name
576 name = __command_name(c->parent, delim, 1 + len + extra);
577 char dstr[2] = { delim, 0 };
579 strcat(name, c->name);
583 char *command_name(struct command *c, char delim)
585 return __command_name(c, delim, 0);
588 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
590 return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
593 static int run_command(struct command_context *context,
594 struct command *c, const char *words[], unsigned num_words)
596 if (!command_can_run(context, c))
598 /* Many commands may be run only before/after 'init' */
601 case COMMAND_CONFIG: when = "before"; break;
602 case COMMAND_EXEC: when = "after"; break;
603 // handle the impossible with humor; it guarantees a bug report!
604 default: when = "if Cthulhu is summoned by"; break;
606 LOG_ERROR("The '%s' command must be used %s 'init'.",
611 struct command_invocation cmd = {
615 .argc = num_words - 1,
618 int retval = c->handler(&cmd);
619 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
621 /* Print help for command */
622 char *full_name = command_name(c, ' ');
623 if (NULL != full_name) {
624 command_run_linef(context, "usage %s", full_name);
629 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
631 /* just fall through for a shutdown request */
633 else if (retval != ERROR_OK)
635 /* we do not print out an error message because the command *should*
636 * have printed out an error
638 LOG_DEBUG("Command failed with error code %d", retval);
644 int command_run_line(struct command_context *context, char *line)
646 /* all the parent commands have been registered with the interpreter
647 * so, can just evaluate the line as a script and check for
650 /* run the line thru a script engine */
651 int retval = ERROR_FAIL;
653 /* Beware! This code needs to be reentrant. It is also possible
654 * for OpenOCD commands to be invoked directly from Tcl. This would
655 * happen when the Jim Tcl interpreter is provided by eCos for
658 Jim_Interp *interp = context->interp;
659 Jim_DeleteAssocData(interp, "context");
660 retcode = Jim_SetAssocData(interp, "context", NULL, context);
661 if (retcode == JIM_OK)
663 /* associated the return value */
664 Jim_DeleteAssocData(interp, "retval");
665 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
666 if (retcode == JIM_OK)
668 retcode = Jim_Eval_Named(interp, line, 0, 0);
670 Jim_DeleteAssocData(interp, "retval");
672 Jim_DeleteAssocData(interp, "context");
674 if (retcode == JIM_ERR) {
675 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
677 /* We do not print the connection closed error message */
678 Jim_MakeErrorMessage(interp);
679 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
681 if (retval == ERROR_OK)
683 /* It wasn't a low level OpenOCD command that failed */
687 } else if (retcode == JIM_EXIT) {
689 /* exit(Jim_GetExitCode(interp)); */
694 result = Jim_GetString(Jim_GetResult(interp), &reslen);
699 for (i = 0; i < reslen; i += 256)
705 strncpy(buff, result + i, chunk);
707 LOG_USER_N("%s", buff);
716 int command_run_linef(struct command_context *context, const char *format, ...)
718 int retval = ERROR_FAIL;
721 va_start(ap, format);
722 string = alloc_vprintf(format, ap);
725 retval = command_run_line(context, string);
732 void command_set_output_handler(struct command_context* context,
733 command_output_handler_t output_handler, void *priv)
735 context->output_handler = output_handler;
736 context->output_handler_priv = priv;
739 struct command_context* copy_command_context(struct command_context* context)
741 struct command_context* copy_context = malloc(sizeof(struct command_context));
743 *copy_context = *context;
748 void command_done(struct command_context *cmd_ctx)
756 /* find full path to file */
757 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
761 const char *file = Jim_GetString(argv[1], NULL);
762 char *full_path = find_file(file);
763 if (full_path == NULL)
765 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
768 Jim_SetResult(interp, result);
772 COMMAND_HANDLER(jim_echo)
774 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n"))
776 LOG_USER_N("%s", CMD_ARGV[1]);
781 LOG_USER("%s", CMD_ARGV[0]);
785 /* Capture progress output and return as tcl return value. If the
786 * progress output was empty, return tcl return value.
788 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
793 struct log_capture_state *state = command_log_capture_start(interp);
795 /* disable polling during capture. This avoids capturing output
798 * This is necessary in order to avoid accidentially getting a non-empty
799 * string for tcl fn's.
801 bool save_poll = jtag_poll_get_enabled();
803 jtag_poll_set_enabled(false);
805 const char *str = Jim_GetString(argv[1], NULL);
806 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
808 jtag_poll_set_enabled(save_poll);
810 command_log_capture_finish(state);
815 static COMMAND_HELPER(command_help_find, struct command *head,
816 struct command **out)
819 return ERROR_INVALID_ARGUMENTS;
820 *out = command_find(head, CMD_ARGV[0]);
821 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
822 *out = command_find(head, CMD_ARGV[0] + 4);
824 return ERROR_INVALID_ARGUMENTS;
828 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
831 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
832 bool show_help, const char *match);
834 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
835 bool show_help, const char *match)
837 for (struct command *c = head; NULL != c; c = c->next)
838 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
842 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
844 static void command_help_show_indent(unsigned n)
846 for (unsigned i = 0; i < n; i++)
849 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
851 const char *cp = str, *last = str;
854 const char *next = last;
859 } while (*next != ' ' && *next != '\t' && *next != '\0');
860 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
861 if (next - last < HELP_LINE_WIDTH(n))
863 command_help_show_indent(n);
864 LOG_USER("%.*s", (int)(cp - last), last);
869 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
870 bool show_help, const char *match)
872 char *cmd_name = command_name(c, ' ');
873 if (NULL == cmd_name)
876 /* If the match string occurs anywhere, we print out
877 * stuff for this command. */
878 bool is_match = (strstr(cmd_name, match) != NULL) ||
879 ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
880 ((c->help != NULL) && (strstr(c->help, match) != NULL));
884 command_help_show_indent(n);
885 LOG_USER_N("%s", cmd_name);
893 command_help_show_wrap(c->usage, 0, n + 5);
899 if (is_match && show_help)
903 /* Normal commands are runtime-only; highlight exceptions */
904 if (c->mode != COMMAND_EXEC) {
905 const char *stage_msg = "";
909 stage_msg = " (configuration command)";
912 stage_msg = " (command valid any time)";
915 stage_msg = " (?mode error?)";
918 msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
920 msg = alloc_printf("%s", c->help ? : "");
924 command_help_show_wrap(msg, n + 3, n + 3);
931 LOG_ERROR("command recursion exceeded");
935 return CALL_COMMAND_HANDLER(command_help_show_list,
936 c->children, n, show_help, match);
938 COMMAND_HANDLER(handle_help_command)
940 bool full = strcmp(CMD_NAME, "help") == 0;
942 struct command *c = CMD_CTX->commands;
947 else if (CMD_ARGC >= 1) {
950 for (i = 0; i < CMD_ARGC; ++i) {
954 match = alloc_printf("%s %s", match,
958 LOG_ERROR("unable to build "
963 match = alloc_printf("%s", CMD_ARGV[i]);
965 LOG_ERROR("unable to build "
972 return ERROR_COMMAND_SYNTAX_ERROR;
974 retval = CALL_COMMAND_HANDLER(command_help_show_list,
982 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
983 struct command *head, struct command **out, bool top_level)
987 const char *cmd_name = Jim_GetString(argv[0], NULL);
988 struct command *c = command_find(head, cmd_name);
989 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
990 c = command_find(head, cmd_name + 4);
994 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
998 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1000 const char *cmd_name = Jim_GetString(argv[0], NULL);
1001 if (strcmp(cmd_name, "unknown") == 0)
1008 script_debug(interp, cmd_name, argc, argv);
1010 struct command_context *cmd_ctx = current_command_context(interp);
1011 struct command *c = cmd_ctx->commands;
1012 int remaining = command_unknown_find(argc, argv, c, &c, true);
1013 // if nothing could be consumed, then it's really an unknown command
1014 if (remaining == argc)
1016 const char *cmd = Jim_GetString(argv[0], NULL);
1017 LOG_ERROR("Unknown command:\n %s", cmd);
1022 Jim_Obj *const *start;
1024 if (c->handler || c->jim_handler)
1026 // include the command name in the list
1027 count = remaining + 1;
1028 start = argv + (argc - remaining - 1);
1032 c = command_find(cmd_ctx->commands, "usage");
1035 LOG_ERROR("unknown command, but usage is missing too");
1038 count = argc - remaining;
1042 // pass the command through to the intended handler
1045 interp->cmdPrivData = c->jim_handler_data;
1046 return (*c->jim_handler)(interp, count, start);
1049 return script_command_run(interp, count, start, c, found);
1052 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1054 struct command_context *cmd_ctx = current_command_context(interp);
1055 enum command_mode mode;
1059 struct command *c = cmd_ctx->commands;
1060 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1061 // if nothing could be consumed, then it's an unknown command
1062 if (remaining == argc - 1)
1064 Jim_SetResultString(interp, "unknown", -1);
1070 mode = cmd_ctx->mode;
1072 const char *mode_str;
1074 case COMMAND_ANY: mode_str = "any"; break;
1075 case COMMAND_CONFIG: mode_str = "config"; break;
1076 case COMMAND_EXEC: mode_str = "exec"; break;
1077 default: mode_str = "unknown"; break;
1079 Jim_SetResultString(interp, mode_str, -1);
1083 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1088 struct command_context *cmd_ctx = current_command_context(interp);
1089 struct command *c = cmd_ctx->commands;
1090 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1091 // if nothing could be consumed, then it's an unknown command
1092 if (remaining == argc - 1)
1094 Jim_SetResultString(interp, "unknown", -1);
1099 Jim_SetResultString(interp, "native", -1);
1100 else if (c->handler)
1101 Jim_SetResultString(interp, "simple", -1);
1103 Jim_SetResultString(interp, "group", -1);
1108 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1109 const char *cmd_name, const char *help_text, const char *usage)
1111 struct command **head = command_list_for_parent(cmd_ctx, parent);
1112 struct command *nc = command_find(*head, cmd_name);
1115 // add a new command with help text
1116 struct command_registration cr = {
1118 .mode = COMMAND_ANY,
1122 nc = register_command(cmd_ctx, parent, &cr);
1125 LOG_ERROR("failed to add '%s' help text", cmd_name);
1128 LOG_DEBUG("added '%s' help text", cmd_name);
1133 bool replaced = false;
1136 free((void *)nc->help);
1139 nc->help = strdup(help_text);
1141 LOG_INFO("replaced existing '%s' help", cmd_name);
1143 LOG_DEBUG("added '%s' help text", cmd_name);
1147 bool replaced = false;
1150 free((void *)nc->usage);
1153 nc->usage = strdup(usage);
1155 LOG_INFO("replaced existing '%s' usage", cmd_name);
1157 LOG_DEBUG("added '%s' usage text", cmd_name);
1162 COMMAND_HANDLER(handle_help_add_command)
1166 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1167 return ERROR_INVALID_ARGUMENTS;
1170 // save help text and remove it from argument list
1171 const char *str = CMD_ARGV[--CMD_ARGC];
1172 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1173 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1174 if (!help && !usage)
1176 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1177 return ERROR_INVALID_ARGUMENTS;
1179 // likewise for the leaf command name
1180 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1182 struct command *c = NULL;
1185 c = CMD_CTX->commands;
1186 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1187 if (ERROR_OK != retval)
1190 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1193 /* sleep command sleeps for <n> milliseconds
1194 * this is useful in target startup scripts
1196 COMMAND_HANDLER(handle_sleep_command)
1201 if (strcmp(CMD_ARGV[1], "busy") == 0)
1204 return ERROR_COMMAND_SYNTAX_ERROR;
1206 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1207 return ERROR_COMMAND_SYNTAX_ERROR;
1209 unsigned long duration = 0;
1210 int retval = parse_ulong(CMD_ARGV[0], &duration);
1211 if (ERROR_OK != retval)
1216 long long then = timeval_ms();
1217 while (timeval_ms() - then < (long long)duration)
1219 target_call_timer_callbacks_now();
1224 busy_sleep(duration);
1229 static const struct command_registration command_subcommand_handlers[] = {
1232 .mode = COMMAND_ANY,
1233 .jim_handler = jim_command_mode,
1234 .usage = "[command_name ...]",
1235 .help = "Returns the command modes allowed by a command:"
1236 "'any', 'config', or 'exec'. If no command is"
1237 "specified, returns the current command mode. "
1238 "Returns 'unknown' if an unknown command is given. "
1239 "Command can be multiple tokens.",
1243 .mode = COMMAND_ANY,
1244 .jim_handler = jim_command_type,
1245 .usage = "command_name [...]",
1246 .help = "Returns the type of built-in command:"
1247 "'native', 'simple', 'group', or 'unknown'. "
1248 "Command can be multiple tokens.",
1250 COMMAND_REGISTRATION_DONE
1253 static const struct command_registration command_builtin_handlers[] = {
1256 .handler = jim_echo,
1257 .mode = COMMAND_ANY,
1258 .help = "Logs a message at \"user\" priority. "
1259 "Output message to stdout. "
1260 "Option \"-n\" suppresses trailing newline",
1261 .usage = "[-n] string",
1264 .name = "add_help_text",
1265 .handler = handle_help_add_command,
1266 .mode = COMMAND_ANY,
1267 .help = "Add new command help text; "
1268 "Command can be multiple tokens.",
1269 .usage = "command_name helptext_string",
1272 .name = "add_usage_text",
1273 .handler = handle_help_add_command,
1274 .mode = COMMAND_ANY,
1275 .help = "Add new command usage text; "
1276 "command can be multiple tokens.",
1277 .usage = "command_name usage_string",
1281 .handler = handle_sleep_command,
1282 .mode = COMMAND_ANY,
1283 .help = "Sleep for specified number of milliseconds. "
1284 "\"busy\" will busy wait instead (avoid this).",
1285 .usage = "milliseconds ['busy']",
1289 .handler = handle_help_command,
1290 .mode = COMMAND_ANY,
1291 .help = "Show full command help; "
1292 "command can be multiple tokens.",
1293 .usage = "[command_name]",
1297 .handler = handle_help_command,
1298 .mode = COMMAND_ANY,
1299 .help = "Show basic command usage; "
1300 "command can be multiple tokens.",
1301 .usage = "[command_name]",
1306 .help = "core command group (introspection)",
1307 .chain = command_subcommand_handlers,
1309 COMMAND_REGISTRATION_DONE
1312 struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp)
1314 struct command_context* context = malloc(sizeof(struct command_context));
1317 context->mode = COMMAND_EXEC;
1318 context->commands = NULL;
1319 context->current_target = 0;
1320 context->output_handler = NULL;
1321 context->output_handler_priv = NULL;
1323 #if !BUILD_ECOSBOARD
1324 /* Create a jim interpreter if we were not handed one */
1327 /* Create an interpreter */
1328 interp = Jim_CreateInterp();
1329 /* Add all the Jim core commands */
1330 Jim_RegisterCoreCommands(interp);
1331 Jim_InitStaticExtensions(interp);
1334 context->interp = interp;
1336 /* Stick to lowercase for HostOS strings. */
1337 #if defined(_MSC_VER)
1338 /* WinXX - is generic, the forward
1339 * looking problem is this:
1341 * "win32" or "win64"
1343 * "winxx" is generic.
1346 #elif defined(__linux__)
1348 #elif defined(__APPLE__) || defined(__DARWIN__)
1350 #elif defined(__CYGWIN__)
1352 #elif defined(__MINGW32__)
1354 #elif defined(__ECOS)
1356 #elif defined(__FreeBSD__)
1359 #warning "Unrecognized host OS..."
1362 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1363 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1365 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1366 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1368 register_commands(context, NULL, command_builtin_handlers);
1370 Jim_SetAssocData(interp, "context", NULL, context);
1371 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1373 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1374 Jim_MakeErrorMessage(interp);
1375 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1378 Jim_DeleteAssocData(interp, "context");
1383 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1386 return ERROR_INVALID_ARGUMENTS;
1388 cmd_ctx->mode = mode;
1392 void process_jim_events(struct command_context *cmd_ctx)
1394 #if !BUILD_ECOSBOARD
1395 static int recursion = 0;
1400 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1405 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1406 int parse##name(const char *str, type *ul) \
1410 LOG_ERROR("Invalid command argument"); \
1411 return ERROR_COMMAND_ARGUMENT_INVALID; \
1414 *ul = func(str, &end, 0); \
1417 LOG_ERROR("Invalid command argument"); \
1418 return ERROR_COMMAND_ARGUMENT_INVALID; \
1420 if ((max == *ul) && (ERANGE == errno)) \
1422 LOG_ERROR("Argument overflow"); \
1423 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1425 if (min && (min == *ul) && (ERANGE == errno)) \
1427 LOG_ERROR("Argument underflow"); \
1428 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1432 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1433 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1434 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1435 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1437 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1438 int parse##name(const char *str, type *ul) \
1441 int retval = parse##funcname(str, &n); \
1442 if (ERROR_OK != retval) \
1445 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1447 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1452 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1453 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1454 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1455 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1456 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1457 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1459 #define DEFINE_PARSE_LONG(name, type, min, max) \
1460 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1461 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1462 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1463 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1464 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1466 static int command_parse_bool(const char *in, bool *out,
1467 const char *on, const char *off)
1469 if (strcasecmp(in, on) == 0)
1471 else if (strcasecmp(in, off) == 0)
1474 return ERROR_COMMAND_SYNTAX_ERROR;
1478 int command_parse_bool_arg(const char *in, bool *out)
1480 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1482 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1484 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1486 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1488 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1490 return ERROR_INVALID_ARGUMENTS;
1493 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1497 const char *in = CMD_ARGV[0];
1498 if (command_parse_bool_arg(in, out) != ERROR_OK)
1500 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1501 return ERROR_INVALID_ARGUMENTS;
1506 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1509 return ERROR_INVALID_ARGUMENTS;