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 <target/target.h>
41 #include "configuration.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
47 /* nice short description of source file */
48 #define __THIS__FILE__ "command.c"
51 static int run_command(struct command_context *context,
52 struct command *c, const char *words[], unsigned num_words);
54 struct log_capture_state {
59 static void tcl_output(void *privData, const char *file, unsigned line,
60 const char *function, const char *string)
62 struct log_capture_state *state = (struct log_capture_state *)privData;
63 Jim_AppendString(state->interp, state->output, string, strlen(string));
66 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
68 /* capture log output and return it. A garbage collect can
69 * happen, so we need a reference count to this object */
70 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
71 if (NULL == tclOutput)
74 struct log_capture_state *state = malloc(sizeof(*state));
78 state->interp = interp;
79 Jim_IncrRefCount(tclOutput);
80 state->output = tclOutput;
82 log_add_callback(tcl_output, state);
87 static void command_log_capture_finish(struct log_capture_state *state)
92 log_remove_callback(tcl_output, state);
94 Jim_SetResult(state->interp, state->output);
95 Jim_DecrRefCount(state->interp, state->output);
100 static int command_retval_set(Jim_Interp *interp, int retval)
102 int *return_retval = Jim_GetAssocData(interp, "retval");
103 if (return_retval != NULL)
104 *return_retval = retval;
106 return (retval == ERROR_OK) ? JIM_OK : JIM_ERR;
109 extern struct command_context *global_cmd_ctx;
111 /* dump a single line to the log for the command.
112 * Do nothing in case we are not at debug level 3 */
113 void script_debug(Jim_Interp *interp, const char *name,
114 unsigned argc, Jim_Obj *const *argv)
116 if (debug_level < LOG_LVL_DEBUG)
119 char * dbg = alloc_printf("command - %s", name);
120 for (unsigned i = 0; i < argc; i++)
123 const char *w = Jim_GetString(argv[i], &len);
125 /* end of line comment? */
129 char * t = alloc_printf("%s %s", dbg, w);
133 LOG_DEBUG("%s", dbg);
137 static void script_command_args_free(const char **words, unsigned nwords)
139 for (unsigned i = 0; i < nwords; i++)
140 free((void *)words[i]);
143 static const char **script_command_args_alloc(
144 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
146 const char **words = malloc(argc * sizeof(char *));
151 for (i = 0; i < argc; i++)
154 const char *w = Jim_GetString(argv[i], &len);
155 /* a comment may end the line early */
159 words[i] = strdup(w);
160 if (words[i] == NULL)
162 script_command_args_free(words, i);
170 static struct command_context *current_command_context(Jim_Interp *interp)
172 /* grab the command context from the associated data */
173 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
176 /* Tcl can invoke commands directly instead of via command_run_line(). This would
177 * happen when the Jim Tcl interpreter is provided by eCos.
179 cmd_ctx = global_cmd_ctx;
184 static int script_command_run(Jim_Interp *interp,
185 int argc, Jim_Obj *const *argv, struct command *c, bool capture)
187 target_call_timer_callbacks_now();
188 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
191 const char **words = script_command_args_alloc(argc, argv, &nwords);
195 struct log_capture_state *state = NULL;
197 state = command_log_capture_start(interp);
199 struct command_context *cmd_ctx = current_command_context(interp);
200 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
202 command_log_capture_finish(state);
204 script_command_args_free(words, nwords);
205 return command_retval_set(interp, retval);
208 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
210 /* the private data is stashed in the interp structure */
212 struct command *c = interp->cmdPrivData;
214 script_debug(interp, c->name, argc, argv);
215 return script_command_run(interp, argc, argv, c, true);
218 static struct command *command_root(struct command *c)
220 while (NULL != c->parent)
226 * Find a command by name from a list of commands.
227 * @returns Returns the named command if it exists in the list.
228 * Returns NULL otherwise.
230 static struct command *command_find(struct command *head, const char *name)
232 for (struct command *cc = head; cc; cc = cc->next)
234 if (strcmp(cc->name, name) == 0)
239 struct command *command_find_in_context(struct command_context *cmd_ctx,
242 return command_find(cmd_ctx->commands, name);
244 struct command *command_find_in_parent(struct command *parent,
247 return command_find(parent->children, name);
251 * Add the command into the linked list, sorted by name.
252 * @param head Address to head of command list pointer, which may be
253 * updated if @c c gets inserted at the beginning of the list.
254 * @param c The command to add to the list pointed to by @c head.
256 static void command_add_child(struct command **head, struct command *c)
265 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
266 head = &(*head)->next;
268 if (strcmp(c->name, (*head)->name) > 0) {
269 c->next = (*head)->next;
277 static struct command **command_list_for_parent(
278 struct command_context *cmd_ctx, struct command *parent)
280 return parent ? &parent->children : &cmd_ctx->commands;
283 static void command_free(struct command *c)
285 /// @todo if command has a handler, unregister its jim command!
287 while (NULL != c->children)
289 struct command *tmp = c->children;
290 c->children = tmp->next;
297 free((void*)c->help);
299 free((void*)c->usage);
303 static struct command *command_new(struct command_context *cmd_ctx,
304 struct command *parent, const struct command_registration *cr)
308 struct command *c = calloc(1, sizeof(struct command));
312 c->name = strdup(cr->name);
314 c->help = strdup(cr->help);
316 c->usage = strdup(cr->usage);
318 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
319 goto command_new_error;
322 c->handler = cr->handler;
323 c->jim_handler = cr->jim_handler;
324 c->jim_handler_data = cr->jim_handler_data;
327 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
336 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
338 static int register_command_handler(struct command_context *cmd_ctx,
341 Jim_Interp *interp = cmd_ctx->interp;
342 const char *ocd_name = alloc_printf("ocd_%s", c->name);
343 if (NULL == ocd_name)
346 LOG_DEBUG("registering '%s'...", ocd_name);
348 Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
349 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
350 free((void *)ocd_name);
351 if (JIM_OK != retval)
354 /* we now need to add an overrideable proc */
355 const char *override_name = alloc_printf(
356 "proc %s {args} {eval ocd_bouncer %s $args}",
358 if (NULL == override_name)
361 retval = Jim_Eval_Named(interp, override_name, __THIS__FILE__ , __LINE__);
362 free((void *)override_name);
367 struct command* register_command(struct command_context *context,
368 struct command *parent, const struct command_registration *cr)
370 if (!context || !cr->name)
373 const char *name = cr->name;
374 struct command **head = command_list_for_parent(context, parent);
375 struct command *c = command_find(*head, name);
378 LOG_ERROR("command '%s' is already registered in '%s' context",
379 name, parent ? parent->name : "<global>");
383 c = command_new(context, parent, cr);
387 int retval = ERROR_OK;
388 if (NULL != cr->jim_handler && NULL == parent)
390 retval = Jim_CreateCommand(context->interp, cr->name,
391 cr->jim_handler, cr->jim_handler_data, NULL);
393 else if (NULL != cr->handler || NULL != parent)
394 retval = register_command_handler(context, command_root(c));
396 if (ERROR_OK != retval)
398 unregister_command(context, parent, name);
404 int register_commands(struct command_context *cmd_ctx, struct command *parent,
405 const struct command_registration *cmds)
407 int retval = ERROR_OK;
409 for (i = 0; cmds[i].name || cmds[i].chain; i++)
411 const struct command_registration *cr = cmds + i;
413 struct command *c = NULL;
414 if (NULL != cr->name)
416 c = register_command(cmd_ctx, parent, cr);
423 if (NULL != cr->chain)
425 struct command *p = c ? : parent;
426 retval = register_commands(cmd_ctx, p, cr->chain);
427 if (ERROR_OK != retval)
431 if (ERROR_OK != retval)
433 for (unsigned j = 0; j < i; j++)
434 unregister_command(cmd_ctx, parent, cmds[j].name);
439 int unregister_all_commands(struct command_context *context,
440 struct command *parent)
445 struct command **head = command_list_for_parent(context, parent);
446 while (NULL != *head)
448 struct command *tmp = *head;
456 int unregister_command(struct command_context *context,
457 struct command *parent, const char *name)
459 if ((!context) || (!name))
460 return ERROR_INVALID_ARGUMENTS;
462 struct command *p = NULL;
463 struct command **head = command_list_for_parent(context, parent);
464 for (struct command *c = *head; NULL != c; p = c, c = c->next)
466 if (strcmp(name, c->name) != 0)
481 void command_set_handler_data(struct command *c, void *p)
483 if (NULL != c->handler || NULL != c->jim_handler)
484 c->jim_handler_data = p;
485 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
486 command_set_handler_data(cc, p);
489 void command_output_text(struct command_context *context, const char *data)
491 if (context && context->output_handler && data) {
492 context->output_handler(context, data);
496 void command_print_sameline(struct command_context *context, const char *format, ...)
501 va_start(ap, format);
503 string = alloc_vprintf(format, ap);
506 /* we want this collected in the log + we also want to pick it up as a tcl return
509 * The latter bit isn't precisely neat, but will do for now.
511 LOG_USER_N("%s", string);
512 /* We already printed it above */
513 /* command_output_text(context, string); */
520 void command_print(struct command_context *context, const char *format, ...)
525 va_start(ap, format);
527 string = alloc_vprintf(format, ap);
530 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
531 /* we want this collected in the log + we also want to pick it up as a tcl return
534 * The latter bit isn't precisely neat, but will do for now.
536 LOG_USER_N("%s", string);
537 /* We already printed it above */
538 /* command_output_text(context, string); */
545 static char *__command_name(struct command *c, char delim, unsigned extra)
548 unsigned len = strlen(c->name);
549 if (NULL == c->parent) {
550 // allocate enough for the name, child names, and '\0'
551 name = malloc(len + extra + 1);
552 strcpy(name, c->name);
554 // parent's extra must include both the space and name
555 name = __command_name(c->parent, delim, 1 + len + extra);
556 char dstr[2] = { delim, 0 };
558 strcat(name, c->name);
562 char *command_name(struct command *c, char delim)
564 return __command_name(c, delim, 0);
567 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
569 return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
572 static int run_command(struct command_context *context,
573 struct command *c, const char *words[], unsigned num_words)
575 if (!command_can_run(context, c))
577 /* Many commands may be run only before/after 'init' */
580 case COMMAND_CONFIG: when = "before"; break;
581 case COMMAND_EXEC: when = "after"; break;
582 // handle the impossible with humor; it guarantees a bug report!
583 default: when = "if Cthulhu is summoned by"; break;
585 LOG_ERROR("The '%s' command must be used %s 'init'.",
590 struct command_invocation cmd = {
594 .argc = num_words - 1,
597 int retval = c->handler(&cmd);
598 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
600 /* Print help for command */
601 char *full_name = command_name(c, ' ');
602 if (NULL != full_name) {
603 command_run_linef(context, "usage %s", full_name);
608 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
610 /* just fall through for a shutdown request */
612 else if (retval != ERROR_OK)
614 /* we do not print out an error message because the command *should*
615 * have printed out an error
617 LOG_DEBUG("Command failed with error code %d", retval);
623 int command_run_line(struct command_context *context, char *line)
625 /* all the parent commands have been registered with the interpreter
626 * so, can just evaluate the line as a script and check for
629 /* run the line thru a script engine */
630 int retval = ERROR_FAIL;
632 /* Beware! This code needs to be reentrant. It is also possible
633 * for OpenOCD commands to be invoked directly from Tcl. This would
634 * happen when the Jim Tcl interpreter is provided by eCos for
637 Jim_Interp *interp = context->interp;
638 Jim_DeleteAssocData(interp, "context");
639 retcode = Jim_SetAssocData(interp, "context", NULL, context);
640 if (retcode == JIM_OK)
642 /* associated the return value */
643 Jim_DeleteAssocData(interp, "retval");
644 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
645 if (retcode == JIM_OK)
647 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
649 Jim_DeleteAssocData(interp, "retval");
651 Jim_DeleteAssocData(interp, "context");
653 if (retcode == JIM_ERR) {
654 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
656 /* We do not print the connection closed error message */
657 Jim_PrintErrorMessage(interp);
659 if (retval == ERROR_OK)
661 /* It wasn't a low level OpenOCD command that failed */
665 } else if (retcode == JIM_EXIT) {
667 /* exit(Jim_GetExitCode(interp)); */
672 result = Jim_GetString(Jim_GetResult(interp), &reslen);
677 for (i = 0; i < reslen; i += 256)
683 strncpy(buff, result + i, chunk);
685 LOG_USER_N("%s", buff);
687 LOG_USER_N("%s", "\n");
694 int command_run_linef(struct command_context *context, const char *format, ...)
696 int retval = ERROR_FAIL;
699 va_start(ap, format);
700 string = alloc_vprintf(format, ap);
703 retval = command_run_line(context, string);
709 void command_set_output_handler(struct command_context* context,
710 command_output_handler_t output_handler, void *priv)
712 context->output_handler = output_handler;
713 context->output_handler_priv = priv;
716 struct command_context* copy_command_context(struct command_context* context)
718 struct command_context* copy_context = malloc(sizeof(struct command_context));
720 *copy_context = *context;
725 void command_done(struct command_context *cmd_ctx)
733 /* find full path to file */
734 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
738 const char *file = Jim_GetString(argv[1], NULL);
739 char *full_path = find_file(file);
740 if (full_path == NULL)
742 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
745 Jim_SetResult(interp, result);
749 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
753 const char *str = Jim_GetString(argv[1], NULL);
758 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
764 /* make it a char easier to read code */
768 if (ptr == NULL || interp == NULL || nbytes == 0) {
772 /* do we have to chunk it? */
773 if (ptr[nbytes] == 0)
775 /* no it is a C style string */
776 LOG_USER_N("%s", ptr);
779 /* GRR we must chunk - not null terminated */
789 memcpy(chunk, ptr, x);
793 LOG_USER_N("%s", chunk);
801 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
803 /* TCL wants to read... tell him no */
807 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
818 cp = alloc_vprintf(fmt, ap);
821 LOG_USER_N("%s", cp);
828 static int openocd_jim_fflush(void *cookie)
830 /* nothing to flush */
834 static char* openocd_jim_fgets(char *s, int size, void *cookie)
841 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
846 struct log_capture_state *state = command_log_capture_start(interp);
848 const char *str = Jim_GetString(argv[1], NULL);
849 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
851 command_log_capture_finish(state);
856 static COMMAND_HELPER(command_help_find, struct command *head,
857 struct command **out)
860 return ERROR_INVALID_ARGUMENTS;
861 *out = command_find(head, CMD_ARGV[0]);
862 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
863 *out = command_find(head, CMD_ARGV[0] + 4);
865 return ERROR_INVALID_ARGUMENTS;
869 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
872 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
873 bool show_help, const char *match);
875 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
876 bool show_help, const char *match)
878 for (struct command *c = head; NULL != c; c = c->next)
879 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
883 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
885 static void command_help_show_indent(unsigned n)
887 for (unsigned i = 0; i < n; i++)
890 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
892 const char *cp = str, *last = str;
895 const char *next = last;
900 } while (*next != ' ' && *next != '\t' && *next != '\0');
901 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
902 if (next - last < HELP_LINE_WIDTH(n))
904 command_help_show_indent(n);
905 LOG_USER_N("%.*s", (int)(cp - last), last);
911 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
912 bool show_help, const char *match)
914 if (!command_can_run(CMD_CTX, c))
917 char *cmd_name = command_name(c, ' ');
918 if (NULL == cmd_name)
921 /* If the match string occurs anywhere, we print out
922 * stuff for this command. */
923 bool is_match = (strstr(cmd_name, match) != NULL) ||
924 ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
925 ((c->help != NULL) && (strstr(c->help, match) != NULL));
929 command_help_show_indent(n);
930 LOG_USER_N("%s", cmd_name);
938 command_help_show_wrap(c->usage, 0, n + 5);
944 if (is_match && show_help)
948 /* Normal commands are runtime-only; highlight exceptions */
949 if (c->mode != COMMAND_EXEC) {
950 const char *stage_msg = "";
954 stage_msg = " (configuration command)";
957 stage_msg = " (command valid any time)";
960 stage_msg = " (?mode error?)";
963 msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
965 msg = alloc_printf("%s", c->help ? : "");
969 command_help_show_wrap(msg, n + 3, n + 3);
978 return CALL_COMMAND_HANDLER(command_help_show_list,
979 c->children, n, show_help, match);
981 COMMAND_HANDLER(handle_help_command)
983 bool full = strcmp(CMD_NAME, "help") == 0;
985 struct command *c = CMD_CTX->commands;
990 else if (CMD_ARGC >= 1) {
993 for (i = 0; i < CMD_ARGC; ++i) {
997 match = alloc_printf("%s %s", match,
1000 if (NULL == match) {
1001 LOG_ERROR("unable to build "
1006 match = alloc_printf("%s", CMD_ARGV[i]);
1007 if (NULL == match) {
1008 LOG_ERROR("unable to build "
1015 return ERROR_COMMAND_SYNTAX_ERROR;
1017 retval = CALL_COMMAND_HANDLER(command_help_show_list,
1025 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
1026 struct command *head, struct command **out, bool top_level)
1030 const char *cmd_name = Jim_GetString(argv[0], NULL);
1031 struct command *c = command_find(head, cmd_name);
1032 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
1033 c = command_find(head, cmd_name + 4);
1037 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
1041 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1043 const char *cmd_name = Jim_GetString(argv[0], NULL);
1044 if (strcmp(cmd_name, "unknown") == 0)
1051 script_debug(interp, cmd_name, argc, argv);
1053 struct command_context *cmd_ctx = current_command_context(interp);
1054 struct command *c = cmd_ctx->commands;
1055 int remaining = command_unknown_find(argc, argv, c, &c, true);
1056 // if nothing could be consumed, then it's really an unknown command
1057 if (remaining == argc)
1059 const char *cmd = Jim_GetString(argv[0], NULL);
1060 LOG_ERROR("Unknown command:\n %s", cmd);
1065 Jim_Obj *const *start;
1067 if (c->handler || c->jim_handler)
1069 // include the command name in the list
1070 count = remaining + 1;
1071 start = argv + (argc - remaining - 1);
1075 c = command_find(cmd_ctx->commands, "usage");
1078 LOG_ERROR("unknown command, but usage is missing too");
1081 count = argc - remaining;
1085 // pass the command through to the intended handler
1088 interp->cmdPrivData = c->jim_handler_data;
1089 return (*c->jim_handler)(interp, count, start);
1092 return script_command_run(interp, count, start, c, found);
1095 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1097 struct command_context *cmd_ctx = current_command_context(interp);
1098 enum command_mode mode;
1102 struct command *c = cmd_ctx->commands;
1103 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1104 // if nothing could be consumed, then it's an unknown command
1105 if (remaining == argc - 1)
1107 Jim_SetResultString(interp, "unknown", -1);
1113 mode = cmd_ctx->mode;
1115 const char *mode_str;
1117 case COMMAND_ANY: mode_str = "any"; break;
1118 case COMMAND_CONFIG: mode_str = "config"; break;
1119 case COMMAND_EXEC: mode_str = "exec"; break;
1120 default: mode_str = "unknown"; break;
1122 Jim_SetResultString(interp, mode_str, -1);
1126 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1131 struct command_context *cmd_ctx = current_command_context(interp);
1132 struct command *c = cmd_ctx->commands;
1133 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1134 // if nothing could be consumed, then it's an unknown command
1135 if (remaining == argc - 1)
1137 Jim_SetResultString(interp, "unknown", -1);
1142 Jim_SetResultString(interp, "native", -1);
1143 else if (c->handler)
1144 Jim_SetResultString(interp, "simple", -1);
1146 Jim_SetResultString(interp, "group", -1);
1151 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1152 const char *cmd_name, const char *help_text, const char *usage)
1154 struct command **head = command_list_for_parent(cmd_ctx, parent);
1155 struct command *nc = command_find(*head, cmd_name);
1158 // add a new command with help text
1159 struct command_registration cr = {
1161 .mode = COMMAND_ANY,
1165 nc = register_command(cmd_ctx, parent, &cr);
1168 LOG_ERROR("failed to add '%s' help text", cmd_name);
1171 LOG_DEBUG("added '%s' help text", cmd_name);
1176 bool replaced = false;
1179 free((void *)nc->help);
1182 nc->help = strdup(help_text);
1184 LOG_INFO("replaced existing '%s' help", cmd_name);
1186 LOG_DEBUG("added '%s' help text", cmd_name);
1190 bool replaced = false;
1193 free((void *)nc->usage);
1196 nc->usage = strdup(usage);
1198 LOG_INFO("replaced existing '%s' usage", cmd_name);
1200 LOG_DEBUG("added '%s' usage text", cmd_name);
1205 COMMAND_HANDLER(handle_help_add_command)
1209 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1210 return ERROR_INVALID_ARGUMENTS;
1213 // save help text and remove it from argument list
1214 const char *str = CMD_ARGV[--CMD_ARGC];
1215 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1216 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1217 if (!help && !usage)
1219 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1220 return ERROR_INVALID_ARGUMENTS;
1222 // likewise for the leaf command name
1223 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1225 struct command *c = NULL;
1228 c = CMD_CTX->commands;
1229 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1230 if (ERROR_OK != retval)
1233 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1236 /* sleep command sleeps for <n> milliseconds
1237 * this is useful in target startup scripts
1239 COMMAND_HANDLER(handle_sleep_command)
1244 if (strcmp(CMD_ARGV[1], "busy") == 0)
1247 return ERROR_COMMAND_SYNTAX_ERROR;
1249 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1250 return ERROR_COMMAND_SYNTAX_ERROR;
1252 unsigned long duration = 0;
1253 int retval = parse_ulong(CMD_ARGV[0], &duration);
1254 if (ERROR_OK != retval)
1259 long long then = timeval_ms();
1260 while (timeval_ms() - then < (long long)duration)
1262 target_call_timer_callbacks_now();
1267 busy_sleep(duration);
1272 static const struct command_registration command_subcommand_handlers[] = {
1275 .mode = COMMAND_ANY,
1276 .jim_handler = jim_command_mode,
1277 .usage = "[command_name ...]",
1278 .help = "Returns the command modes allowed by a command:"
1279 "'any', 'config', or 'exec'. If no command is"
1280 "specified, returns the current command mode. "
1281 "Returns 'unknown' if an unknown command is given. "
1282 "Command can be multiple tokens.",
1286 .mode = COMMAND_ANY,
1287 .jim_handler = jim_command_type,
1288 .usage = "command_name [...]",
1289 .help = "Returns the type of built-in command:"
1290 "'native', 'simple', 'group', or 'unknown'. "
1291 "Command can be multiple tokens.",
1293 COMMAND_REGISTRATION_DONE
1296 static const struct command_registration command_builtin_handlers[] = {
1298 .name = "add_help_text",
1299 .handler = handle_help_add_command,
1300 .mode = COMMAND_ANY,
1301 .help = "Add new command help text; "
1302 "Command can be multiple tokens.",
1303 .usage = "command_name helptext_string",
1306 .name = "add_usage_text",
1307 .handler = handle_help_add_command,
1308 .mode = COMMAND_ANY,
1309 .help = "Add new command usage text; "
1310 "command can be multiple tokens.",
1311 .usage = "command_name usage_string",
1315 .handler = handle_sleep_command,
1316 .mode = COMMAND_ANY,
1317 .help = "Sleep for specified number of milliseconds. "
1318 "\"busy\" will busy wait instead (avoid this).",
1319 .usage = "milliseconds ['busy']",
1323 .handler = handle_help_command,
1324 .mode = COMMAND_ANY,
1325 .help = "Show full command help; "
1326 "command can be multiple tokens.",
1327 .usage = "[command_name]",
1331 .handler = handle_help_command,
1332 .mode = COMMAND_ANY,
1333 .help = "Show basic command usage; "
1334 "command can be multiple tokens.",
1335 .usage = "[command_name]",
1340 .help = "core command group (introspection)",
1341 .chain = command_subcommand_handlers,
1343 COMMAND_REGISTRATION_DONE
1346 struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp)
1348 struct command_context* context = malloc(sizeof(struct command_context));
1351 context->mode = COMMAND_EXEC;
1352 context->commands = NULL;
1353 context->current_target = 0;
1354 context->output_handler = NULL;
1355 context->output_handler_priv = NULL;
1357 #if !BUILD_ECOSBOARD
1358 /* Create a jim interpreter if we were not handed one */
1362 /* Create an interpreter */
1363 interp = Jim_CreateInterp();
1364 /* Add all the Jim core commands */
1365 Jim_RegisterCoreCommands(interp);
1368 context->interp = interp;
1370 /* Stick to lowercase for HostOS strings. */
1371 #if defined(_MSC_VER)
1372 /* WinXX - is generic, the forward
1373 * looking problem is this:
1375 * "win32" or "win64"
1377 * "winxx" is generic.
1380 #elif defined(__linux__)
1382 #elif defined(__APPLE__) || defined(__DARWIN__)
1384 #elif defined(__CYGWIN__)
1386 #elif defined(__MINGW32__)
1388 #elif defined(__ECOS)
1390 #elif defined(__FreeBSD__)
1393 #warning "Unrecognized host OS..."
1396 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1397 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1399 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1400 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
1401 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1403 /* Set Jim's STDIO */
1404 interp->cookie_stdin = interp;
1405 interp->cookie_stdout = interp;
1406 interp->cookie_stderr = interp;
1407 interp->cb_fwrite = openocd_jim_fwrite;
1408 interp->cb_fread = openocd_jim_fread ;
1409 interp->cb_vfprintf = openocd_jim_vfprintf;
1410 interp->cb_fflush = openocd_jim_fflush;
1411 interp->cb_fgets = openocd_jim_fgets;
1413 register_commands(context, NULL, command_builtin_handlers);
1415 #if !BUILD_ECOSBOARD
1416 Jim_EventLoopOnLoad(interp);
1418 Jim_SetAssocData(interp, "context", NULL, context);
1419 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1421 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1422 Jim_PrintErrorMessage(interp);
1425 Jim_DeleteAssocData(interp, "context");
1430 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1433 return ERROR_INVALID_ARGUMENTS;
1435 cmd_ctx->mode = mode;
1439 void process_jim_events(struct command_context *cmd_ctx)
1441 #if !BUILD_ECOSBOARD
1442 static int recursion = 0;
1447 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1452 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1453 int parse##name(const char *str, type *ul) \
1457 LOG_ERROR("Invalid command argument"); \
1458 return ERROR_COMMAND_ARGUMENT_INVALID; \
1461 *ul = func(str, &end, 0); \
1464 LOG_ERROR("Invalid command argument"); \
1465 return ERROR_COMMAND_ARGUMENT_INVALID; \
1467 if ((max == *ul) && (ERANGE == errno)) \
1469 LOG_ERROR("Argument overflow"); \
1470 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1472 if (min && (min == *ul) && (ERANGE == errno)) \
1474 LOG_ERROR("Argument underflow"); \
1475 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1479 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1480 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1481 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1482 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1484 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1485 int parse##name(const char *str, type *ul) \
1488 int retval = parse##funcname(str, &n); \
1489 if (ERROR_OK != retval) \
1492 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1494 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1499 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1500 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1501 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1502 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1503 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1504 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1506 #define DEFINE_PARSE_LONG(name, type, min, max) \
1507 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1508 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1509 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1510 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1511 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1513 static int command_parse_bool(const char *in, bool *out,
1514 const char *on, const char *off)
1516 if (strcasecmp(in, on) == 0)
1518 else if (strcasecmp(in, off) == 0)
1521 return ERROR_COMMAND_SYNTAX_ERROR;
1525 int command_parse_bool_arg(const char *in, bool *out)
1527 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1529 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1531 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1533 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1535 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1537 return ERROR_INVALID_ARGUMENTS;
1540 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1544 const char *in = CMD_ARGV[0];
1545 if (command_parse_bool_arg(in, out) != ERROR_OK)
1547 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1548 return ERROR_INVALID_ARGUMENTS;
1553 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1556 return ERROR_INVALID_ARGUMENTS;