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 void script_debug(Jim_Interp *interp, const char *name,
112 unsigned argc, Jim_Obj *const *argv)
114 LOG_DEBUG("command - %s", name);
115 for (unsigned i = 0; i < argc; i++)
118 const char *w = Jim_GetString(argv[i], &len);
120 /* end of line comment? */
124 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
128 static void script_command_args_free(const char **words, unsigned nwords)
130 for (unsigned i = 0; i < nwords; i++)
131 free((void *)words[i]);
134 static const char **script_command_args_alloc(
135 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
137 const char **words = malloc(argc * sizeof(char *));
142 for (i = 0; i < argc; i++)
145 const char *w = Jim_GetString(argv[i], &len);
146 /* a comment may end the line early */
150 words[i] = strdup(w);
151 if (words[i] == NULL)
153 script_command_args_free(words, i);
161 static struct command_context *current_command_context(Jim_Interp *interp)
163 /* grab the command context from the associated data */
164 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
167 /* Tcl can invoke commands directly instead of via command_run_line(). This would
168 * happen when the Jim Tcl interpreter is provided by eCos.
170 cmd_ctx = global_cmd_ctx;
175 static int script_command_run(Jim_Interp *interp,
176 int argc, Jim_Obj *const *argv, struct command *c, bool capture)
178 target_call_timer_callbacks_now();
179 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
182 const char **words = script_command_args_alloc(argc, argv, &nwords);
186 struct log_capture_state *state = NULL;
188 state = command_log_capture_start(interp);
190 struct command_context *cmd_ctx = current_command_context(interp);
191 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
193 command_log_capture_finish(state);
195 script_command_args_free(words, nwords);
196 return command_retval_set(interp, retval);
199 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
201 /* the private data is stashed in the interp structure */
203 struct command *c = interp->cmdPrivData;
205 script_debug(interp, c->name, argc, argv);
206 return script_command_run(interp, argc, argv, c, true);
209 static struct command *command_root(struct command *c)
211 while (NULL != c->parent)
217 * Find a command by name from a list of commands.
218 * @returns Returns the named command if it exists in the list.
219 * Returns NULL otherwise.
221 static struct command *command_find(struct command *head, const char *name)
223 for (struct command *cc = head; cc; cc = cc->next)
225 if (strcmp(cc->name, name) == 0)
230 struct command *command_find_in_context(struct command_context *cmd_ctx,
233 return command_find(cmd_ctx->commands, name);
235 struct command *command_find_in_parent(struct command *parent,
238 return command_find(parent->children, name);
242 * Add the command into the linked list, sorted by name.
243 * @param head Address to head of command list pointer, which may be
244 * updated if @c c gets inserted at the beginning of the list.
245 * @param c The command to add to the list pointed to by @c head.
247 static void command_add_child(struct command **head, struct command *c)
256 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
257 head = &(*head)->next;
259 if (strcmp(c->name, (*head)->name) > 0) {
260 c->next = (*head)->next;
268 static struct command **command_list_for_parent(
269 struct command_context *cmd_ctx, struct command *parent)
271 return parent ? &parent->children : &cmd_ctx->commands;
274 static void command_free(struct command *c)
276 /// @todo if command has a handler, unregister its jim command!
278 while (NULL != c->children)
280 struct command *tmp = c->children;
281 c->children = tmp->next;
288 free((void*)c->help);
290 free((void*)c->usage);
294 static struct command *command_new(struct command_context *cmd_ctx,
295 struct command *parent, const struct command_registration *cr)
299 struct command *c = calloc(1, sizeof(struct command));
303 c->name = strdup(cr->name);
305 c->help = strdup(cr->help);
307 c->usage = strdup(cr->usage);
309 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
310 goto command_new_error;
313 c->handler = cr->handler;
314 c->jim_handler = cr->jim_handler;
315 c->jim_handler_data = cr->jim_handler_data;
318 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
327 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
329 static int register_command_handler(struct command_context *cmd_ctx,
332 Jim_Interp *interp = cmd_ctx->interp;
333 const char *ocd_name = alloc_printf("ocd_%s", c->name);
334 if (NULL == ocd_name)
337 LOG_DEBUG("registering '%s'...", ocd_name);
339 Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
340 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
341 free((void *)ocd_name);
342 if (JIM_OK != retval)
345 /* we now need to add an overrideable proc */
346 const char *override_name = alloc_printf(
347 "proc %s {args} {eval ocd_bouncer %s $args}",
349 if (NULL == override_name)
352 retval = Jim_Eval_Named(interp, override_name, __FILE__, __LINE__);
353 free((void *)override_name);
358 struct command* register_command(struct command_context *context,
359 struct command *parent, const struct command_registration *cr)
361 if (!context || !cr->name)
364 const char *name = cr->name;
365 struct command **head = command_list_for_parent(context, parent);
366 struct command *c = command_find(*head, name);
369 LOG_ERROR("command '%s' is already registered in '%s' context",
370 name, parent ? parent->name : "<global>");
374 c = command_new(context, parent, cr);
378 int retval = ERROR_OK;
379 if (NULL != cr->jim_handler && NULL == parent)
381 retval = Jim_CreateCommand(context->interp, cr->name,
382 cr->jim_handler, cr->jim_handler_data, NULL);
384 else if (NULL != cr->handler || NULL != parent)
385 retval = register_command_handler(context, command_root(c));
387 if (ERROR_OK != retval)
389 unregister_command(context, parent, name);
395 int register_commands(struct command_context *cmd_ctx, struct command *parent,
396 const struct command_registration *cmds)
398 int retval = ERROR_OK;
400 for (i = 0; cmds[i].name || cmds[i].chain; i++)
402 const struct command_registration *cr = cmds + i;
404 struct command *c = NULL;
405 if (NULL != cr->name)
407 c = register_command(cmd_ctx, parent, cr);
414 if (NULL != cr->chain)
416 struct command *p = c ? : parent;
417 retval = register_commands(cmd_ctx, p, cr->chain);
418 if (ERROR_OK != retval)
422 if (ERROR_OK != retval)
424 for (unsigned j = 0; j < i; j++)
425 unregister_command(cmd_ctx, parent, cmds[j].name);
430 int unregister_all_commands(struct command_context *context,
431 struct command *parent)
436 struct command **head = command_list_for_parent(context, parent);
437 while (NULL != *head)
439 struct command *tmp = *head;
447 int unregister_command(struct command_context *context,
448 struct command *parent, const char *name)
450 if ((!context) || (!name))
451 return ERROR_INVALID_ARGUMENTS;
453 struct command *p = NULL;
454 struct command **head = command_list_for_parent(context, parent);
455 for (struct command *c = *head; NULL != c; p = c, c = c->next)
457 if (strcmp(name, c->name) != 0)
472 void command_set_handler_data(struct command *c, void *p)
474 if (NULL != c->handler || NULL != c->jim_handler)
475 c->jim_handler_data = p;
476 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
477 command_set_handler_data(cc, p);
480 void command_output_text(struct command_context *context, const char *data)
482 if (context && context->output_handler && data) {
483 context->output_handler(context, data);
487 void command_print_sameline(struct command_context *context, const char *format, ...)
492 va_start(ap, format);
494 string = alloc_vprintf(format, ap);
497 /* we want this collected in the log + we also want to pick it up as a tcl return
500 * The latter bit isn't precisely neat, but will do for now.
502 LOG_USER_N("%s", string);
503 /* We already printed it above */
504 /* command_output_text(context, string); */
511 void command_print(struct command_context *context, const char *format, ...)
516 va_start(ap, format);
518 string = alloc_vprintf(format, ap);
521 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
522 /* we want this collected in the log + we also want to pick it up as a tcl return
525 * The latter bit isn't precisely neat, but will do for now.
527 LOG_USER_N("%s", string);
528 /* We already printed it above */
529 /* command_output_text(context, string); */
536 static char *__command_name(struct command *c, char delim, unsigned extra)
539 unsigned len = strlen(c->name);
540 if (NULL == c->parent) {
541 // allocate enough for the name, child names, and '\0'
542 name = malloc(len + extra + 1);
543 strcpy(name, c->name);
545 // parent's extra must include both the space and name
546 name = __command_name(c->parent, delim, 1 + len + extra);
547 char dstr[2] = { delim, 0 };
549 strcat(name, c->name);
553 char *command_name(struct command *c, char delim)
555 return __command_name(c, delim, 0);
558 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
560 return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
563 static int run_command(struct command_context *context,
564 struct command *c, const char *words[], unsigned num_words)
566 if (!command_can_run(context, c))
568 /* Many commands may be run only before/after 'init' */
571 case COMMAND_CONFIG: when = "before"; break;
572 case COMMAND_EXEC: when = "after"; break;
573 // handle the impossible with humor; it guarantees a bug report!
574 default: when = "if Cthulhu is summoned by"; break;
576 LOG_ERROR("The '%s' command must be used %s 'init'.",
581 struct command_invocation cmd = {
585 .argc = num_words - 1,
588 int retval = c->handler(&cmd);
589 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
591 /* Print help for command */
592 char *full_name = command_name(c, ' ');
593 if (NULL != full_name) {
594 command_run_linef(context, "usage %s", full_name);
599 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
601 /* just fall through for a shutdown request */
603 else if (retval != ERROR_OK)
605 /* we do not print out an error message because the command *should*
606 * have printed out an error
608 LOG_DEBUG("Command failed with error code %d", retval);
614 int command_run_line(struct command_context *context, char *line)
616 /* all the parent commands have been registered with the interpreter
617 * so, can just evaluate the line as a script and check for
620 /* run the line thru a script engine */
621 int retval = ERROR_FAIL;
623 /* Beware! This code needs to be reentrant. It is also possible
624 * for OpenOCD commands to be invoked directly from Tcl. This would
625 * happen when the Jim Tcl interpreter is provided by eCos for
628 Jim_Interp *interp = context->interp;
629 Jim_DeleteAssocData(interp, "context");
630 retcode = Jim_SetAssocData(interp, "context", NULL, context);
631 if (retcode == JIM_OK)
633 /* associated the return value */
634 Jim_DeleteAssocData(interp, "retval");
635 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
636 if (retcode == JIM_OK)
638 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
640 Jim_DeleteAssocData(interp, "retval");
642 Jim_DeleteAssocData(interp, "context");
644 if (retcode == JIM_ERR) {
645 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
647 /* We do not print the connection closed error message */
648 Jim_PrintErrorMessage(interp);
650 if (retval == ERROR_OK)
652 /* It wasn't a low level OpenOCD command that failed */
656 } else if (retcode == JIM_EXIT) {
658 /* exit(Jim_GetExitCode(interp)); */
663 result = Jim_GetString(Jim_GetResult(interp), &reslen);
668 for (i = 0; i < reslen; i += 256)
674 strncpy(buff, result + i, chunk);
676 LOG_USER_N("%s", buff);
678 LOG_USER_N("%s", "\n");
685 int command_run_linef(struct command_context *context, const char *format, ...)
687 int retval = ERROR_FAIL;
690 va_start(ap, format);
691 string = alloc_vprintf(format, ap);
694 retval = command_run_line(context, string);
700 void command_set_output_handler(struct command_context* context,
701 command_output_handler_t output_handler, void *priv)
703 context->output_handler = output_handler;
704 context->output_handler_priv = priv;
707 struct command_context* copy_command_context(struct command_context* context)
709 struct command_context* copy_context = malloc(sizeof(struct command_context));
711 *copy_context = *context;
716 void command_done(struct command_context *cmd_ctx)
724 /* find full path to file */
725 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
729 const char *file = Jim_GetString(argv[1], NULL);
730 char *full_path = find_file(file);
731 if (full_path == NULL)
733 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
736 Jim_SetResult(interp, result);
740 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
744 const char *str = Jim_GetString(argv[1], NULL);
749 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
755 /* make it a char easier to read code */
759 if (ptr == NULL || interp == NULL || nbytes == 0) {
763 /* do we have to chunk it? */
764 if (ptr[nbytes] == 0)
766 /* no it is a C style string */
767 LOG_USER_N("%s", ptr);
770 /* GRR we must chunk - not null terminated */
780 memcpy(chunk, ptr, x);
784 LOG_USER_N("%s", chunk);
792 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
794 /* TCL wants to read... tell him no */
798 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
809 cp = alloc_vprintf(fmt, ap);
812 LOG_USER_N("%s", cp);
819 static int openocd_jim_fflush(void *cookie)
821 /* nothing to flush */
825 static char* openocd_jim_fgets(char *s, int size, void *cookie)
832 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
837 struct log_capture_state *state = command_log_capture_start(interp);
839 const char *str = Jim_GetString(argv[1], NULL);
840 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
842 command_log_capture_finish(state);
847 static COMMAND_HELPER(command_help_find, struct command *head,
848 struct command **out)
851 return ERROR_INVALID_ARGUMENTS;
852 *out = command_find(head, CMD_ARGV[0]);
853 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
854 *out = command_find(head, CMD_ARGV[0] + 4);
856 return ERROR_INVALID_ARGUMENTS;
860 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
863 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
864 bool show_help, const char *match);
866 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
867 bool show_help, const char *match)
869 for (struct command *c = head; NULL != c; c = c->next)
870 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
874 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
876 static void command_help_show_indent(unsigned n)
878 for (unsigned i = 0; i < n; i++)
881 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
883 const char *cp = str, *last = str;
886 const char *next = last;
891 } while (*next != ' ' && *next != '\t' && *next != '\0');
892 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
893 if (next - last < HELP_LINE_WIDTH(n))
895 command_help_show_indent(n);
896 LOG_USER_N("%.*s", (int)(cp - last), last);
902 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
903 bool show_help, const char *match)
905 if (!command_can_run(CMD_CTX, c))
908 char *cmd_name = command_name(c, ' ');
909 if (NULL == cmd_name)
912 /* If the match string occurs anywhere, we print out
913 * stuff for this command. */
914 bool is_match = (strstr(cmd_name, match) != NULL) ||
915 ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
916 ((c->help != NULL) && (strstr(c->help, match) != NULL));
920 command_help_show_indent(n);
921 LOG_USER_N("%s", cmd_name);
929 command_help_show_wrap(c->usage, 0, n + 5);
935 if (is_match && show_help)
937 const char *stage_msg;
939 case COMMAND_CONFIG: stage_msg = "CONFIG"; break;
940 case COMMAND_EXEC: stage_msg = "EXEC"; break;
941 case COMMAND_ANY: stage_msg = "CONFIG or EXEC"; break;
942 default: stage_msg = "***UNKNOWN***"; break;
944 char *msg = alloc_printf("%s%sValid Modes: %s",
945 c->help ? : "", c->help ? " " : "", stage_msg);
948 command_help_show_wrap(msg, n + 3, n + 3);
957 return CALL_COMMAND_HANDLER(command_help_show_list,
958 c->children, n, show_help, match);
960 COMMAND_HANDLER(handle_help_command)
962 bool full = strcmp(CMD_NAME, "help") == 0;
964 struct command *c = CMD_CTX->commands;
969 else if (CMD_ARGC >= 1) {
972 for (i = 0; i < CMD_ARGC; ++i) {
976 match = alloc_printf("%s %s", match,
980 LOG_ERROR("unable to build "
985 match = alloc_printf("%s", CMD_ARGV[i]);
987 LOG_ERROR("unable to build "
994 return ERROR_COMMAND_SYNTAX_ERROR;
996 retval = CALL_COMMAND_HANDLER(command_help_show_list,
1004 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
1005 struct command *head, struct command **out, bool top_level)
1009 const char *cmd_name = Jim_GetString(argv[0], NULL);
1010 struct command *c = command_find(head, cmd_name);
1011 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
1012 c = command_find(head, cmd_name + 4);
1016 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
1020 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1022 const char *cmd_name = Jim_GetString(argv[0], NULL);
1023 if (strcmp(cmd_name, "unknown") == 0)
1030 script_debug(interp, cmd_name, argc, argv);
1032 struct command_context *cmd_ctx = current_command_context(interp);
1033 struct command *c = cmd_ctx->commands;
1034 int remaining = command_unknown_find(argc, argv, c, &c, true);
1035 // if nothing could be consumed, then it's really an unknown command
1036 if (remaining == argc)
1038 const char *cmd = Jim_GetString(argv[0], NULL);
1039 LOG_ERROR("Unknown command:\n %s", cmd);
1044 Jim_Obj *const *start;
1046 if (c->handler || c->jim_handler)
1048 // include the command name in the list
1049 count = remaining + 1;
1050 start = argv + (argc - remaining - 1);
1054 c = command_find(cmd_ctx->commands, "usage");
1057 LOG_ERROR("unknown command, but usage is missing too");
1060 count = argc - remaining;
1064 // pass the command through to the intended handler
1067 interp->cmdPrivData = c->jim_handler_data;
1068 return (*c->jim_handler)(interp, count, start);
1071 return script_command_run(interp, count, start, c, found);
1074 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1076 struct command_context *cmd_ctx = current_command_context(interp);
1077 enum command_mode mode;
1080 struct command *c = cmd_ctx->commands;
1081 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1082 // if nothing could be consumed, then it's an unknown command
1083 if (remaining == argc - 1)
1085 Jim_SetResultString(interp, "unknown", -1);
1091 mode = cmd_ctx->mode;
1093 const char *mode_str;
1095 case COMMAND_ANY: mode_str = "any"; break;
1096 case COMMAND_CONFIG: mode_str = "config"; break;
1097 case COMMAND_EXEC: mode_str = "exec"; break;
1098 default: mode_str = "unknown"; break;
1100 Jim_SetResultString(interp, mode_str, -1);
1104 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1109 struct command_context *cmd_ctx = current_command_context(interp);
1110 struct command *c = cmd_ctx->commands;
1111 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1112 // if nothing could be consumed, then it's an unknown command
1113 if (remaining == argc - 1)
1115 Jim_SetResultString(interp, "unknown", -1);
1120 Jim_SetResultString(interp, "native", -1);
1121 else if (c->handler)
1122 Jim_SetResultString(interp, "simple", -1);
1124 Jim_SetResultString(interp, "group", -1);
1129 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1130 const char *cmd_name, const char *help_text, const char *usage)
1132 struct command **head = command_list_for_parent(cmd_ctx, parent);
1133 struct command *nc = command_find(*head, cmd_name);
1136 // add a new command with help text
1137 struct command_registration cr = {
1139 .mode = COMMAND_ANY,
1143 nc = register_command(cmd_ctx, parent, &cr);
1146 LOG_ERROR("failed to add '%s' help text", cmd_name);
1149 LOG_DEBUG("added '%s' help text", cmd_name);
1154 bool replaced = false;
1157 free((void *)nc->help);
1160 nc->help = strdup(help_text);
1162 LOG_INFO("replaced existing '%s' help", cmd_name);
1164 LOG_DEBUG("added '%s' help text", cmd_name);
1168 bool replaced = false;
1171 free((void *)nc->usage);
1174 nc->usage = strdup(usage);
1176 LOG_INFO("replaced existing '%s' usage", cmd_name);
1178 LOG_DEBUG("added '%s' usage text", cmd_name);
1183 COMMAND_HANDLER(handle_help_add_command)
1187 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1188 return ERROR_INVALID_ARGUMENTS;
1191 // save help text and remove it from argument list
1192 const char *str = CMD_ARGV[--CMD_ARGC];
1193 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1194 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1195 if (!help && !usage)
1197 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1198 return ERROR_INVALID_ARGUMENTS;
1200 // likewise for the leaf command name
1201 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1203 struct command *c = NULL;
1206 c = CMD_CTX->commands;
1207 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1208 if (ERROR_OK != retval)
1211 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1214 /* sleep command sleeps for <n> miliseconds
1215 * this is useful in target startup scripts
1217 COMMAND_HANDLER(handle_sleep_command)
1222 if (strcmp(CMD_ARGV[1], "busy") == 0)
1225 return ERROR_COMMAND_SYNTAX_ERROR;
1227 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1228 return ERROR_COMMAND_SYNTAX_ERROR;
1230 unsigned long duration = 0;
1231 int retval = parse_ulong(CMD_ARGV[0], &duration);
1232 if (ERROR_OK != retval)
1237 long long then = timeval_ms();
1238 while (timeval_ms() - then < (long long)duration)
1240 target_call_timer_callbacks_now();
1245 busy_sleep(duration);
1250 static const struct command_registration command_subcommand_handlers[] = {
1253 .mode = COMMAND_ANY,
1254 .jim_handler = &jim_command_mode,
1255 .usage = "[<name> ...]",
1256 .help = "Returns the command modes allowed by a command:"
1257 "'any', 'config', or 'exec'. If no command is"
1258 "specified, returns the current command mode.",
1262 .mode = COMMAND_ANY,
1263 .jim_handler = &jim_command_type,
1264 .usage = "<name> ...",
1265 .help = "Returns the type of built-in command:"
1266 "'native', 'simple', 'group', or 'unknown'",
1268 COMMAND_REGISTRATION_DONE
1271 static const struct command_registration command_builtin_handlers[] = {
1273 .name = "add_help_text",
1274 .handler = &handle_help_add_command,
1275 .mode = COMMAND_ANY,
1276 .help = "add new command help text",
1277 .usage = "<command> [...] <help_text>]",
1280 .name = "add_usage_text",
1281 .handler = &handle_help_add_command,
1282 .mode = COMMAND_ANY,
1283 .help = "add new command usage text",
1284 .usage = "<command> [...] <usage_text>]",
1288 .handler = &handle_sleep_command,
1289 .mode = COMMAND_ANY,
1290 .help = "sleep for n milliseconds. "
1291 "\"busy\" will busy wait",
1292 .usage = "<n> [busy]",
1296 .handler = &handle_help_command,
1297 .mode = COMMAND_ANY,
1298 .help = "show full command help",
1299 .usage = "[<command> ...]",
1303 .handler = &handle_help_command,
1304 .mode = COMMAND_ANY,
1305 .help = "show basic command usage",
1306 .usage = "[<command> ...]",
1311 .help = "core command group (introspection)",
1312 .chain = command_subcommand_handlers,
1314 COMMAND_REGISTRATION_DONE
1317 struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp)
1319 struct command_context* context = malloc(sizeof(struct command_context));
1322 context->mode = COMMAND_EXEC;
1323 context->commands = NULL;
1324 context->current_target = 0;
1325 context->output_handler = NULL;
1326 context->output_handler_priv = NULL;
1328 #if !BUILD_ECOSBOARD
1329 /* Create a jim interpreter if we were not handed one */
1333 /* Create an interpreter */
1334 interp = Jim_CreateInterp();
1335 /* Add all the Jim core commands */
1336 Jim_RegisterCoreCommands(interp);
1339 context->interp = interp;
1341 #if defined(_MSC_VER)
1342 /* WinXX - is generic, the forward
1343 * looking problem is this:
1345 * "win32" or "win64"
1347 * "winxx" is generic.
1350 #elif defined(__linux__)
1352 #elif defined(__DARWIN__)
1354 #elif defined(__CYGWIN__)
1356 #elif defined(__MINGW32__)
1358 #elif defined(__ECOS)
1361 #warn unrecognized host OS...
1364 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1365 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1367 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1368 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
1369 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1371 /* Set Jim's STDIO */
1372 interp->cookie_stdin = interp;
1373 interp->cookie_stdout = interp;
1374 interp->cookie_stderr = interp;
1375 interp->cb_fwrite = openocd_jim_fwrite;
1376 interp->cb_fread = openocd_jim_fread ;
1377 interp->cb_vfprintf = openocd_jim_vfprintf;
1378 interp->cb_fflush = openocd_jim_fflush;
1379 interp->cb_fgets = openocd_jim_fgets;
1381 register_commands(context, NULL, command_builtin_handlers);
1383 #if !BUILD_ECOSBOARD
1384 Jim_EventLoopOnLoad(interp);
1386 Jim_SetAssocData(interp, "context", NULL, context);
1387 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1389 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1390 Jim_PrintErrorMessage(interp);
1393 Jim_DeleteAssocData(interp, "context");
1398 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1401 return ERROR_INVALID_ARGUMENTS;
1403 cmd_ctx->mode = mode;
1407 void process_jim_events(struct command_context *cmd_ctx)
1409 #if !BUILD_ECOSBOARD
1410 static int recursion = 0;
1415 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1420 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1421 int parse##name(const char *str, type *ul) \
1425 LOG_ERROR("Invalid command argument"); \
1426 return ERROR_COMMAND_ARGUMENT_INVALID; \
1429 *ul = func(str, &end, 0); \
1432 LOG_ERROR("Invalid command argument"); \
1433 return ERROR_COMMAND_ARGUMENT_INVALID; \
1435 if ((max == *ul) && (ERANGE == errno)) \
1437 LOG_ERROR("Argument overflow"); \
1438 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1440 if (min && (min == *ul) && (ERANGE == errno)) \
1442 LOG_ERROR("Argument underflow"); \
1443 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1447 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1448 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1449 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1450 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1452 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1453 int parse##name(const char *str, type *ul) \
1456 int retval = parse##funcname(str, &n); \
1457 if (ERROR_OK != retval) \
1460 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1462 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1467 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1468 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1469 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1470 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1471 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1472 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1474 #define DEFINE_PARSE_LONG(name, type, min, max) \
1475 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1476 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1477 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1478 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1479 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1481 static int command_parse_bool(const char *in, bool *out,
1482 const char *on, const char *off)
1484 if (strcasecmp(in, on) == 0)
1486 else if (strcasecmp(in, off) == 0)
1489 return ERROR_COMMAND_SYNTAX_ERROR;
1493 int command_parse_bool_arg(const char *in, bool *out)
1495 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1497 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1499 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1501 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1503 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1505 return ERROR_INVALID_ARGUMENTS;
1508 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1512 const char *in = CMD_ARGV[0];
1513 if (command_parse_bool_arg(in, out) != ERROR_OK)
1515 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1516 return ERROR_INVALID_ARGUMENTS;
1521 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1524 return ERROR_INVALID_ARGUMENTS;