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
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"
50 Jim_Interp *interp = NULL;
52 static int run_command(struct command_context *context,
53 struct command *c, const char *words[], unsigned num_words);
55 static void tcl_output(void *privData, const char *file, unsigned line,
56 const char *function, const char *string)
58 Jim_Obj *tclOutput = (Jim_Obj *)privData;
59 Jim_AppendString(interp, tclOutput, string, strlen(string));
62 static Jim_Obj *command_log_capture_start(Jim_Interp *interp)
64 /* capture log output and return it. A garbage collect can
65 * happen, so we need a reference count to this object */
66 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
67 if (NULL == tclOutput)
69 Jim_IncrRefCount(tclOutput);
70 log_add_callback(tcl_output, tclOutput);
74 static void command_log_capture_finish(Jim_Interp *interp, Jim_Obj *tclOutput)
76 log_remove_callback(tcl_output, tclOutput);
77 Jim_SetResult(interp, tclOutput);
78 Jim_DecrRefCount(interp, tclOutput);
81 static int command_retval_set(Jim_Interp *interp, int retval)
83 int *return_retval = Jim_GetAssocData(interp, "retval");
84 if (return_retval != NULL)
85 *return_retval = retval;
87 return (retval == ERROR_OK) ? JIM_OK : JIM_ERR;
90 extern struct command_context *global_cmd_ctx;
92 void script_debug(Jim_Interp *interp, const char *name,
93 unsigned argc, Jim_Obj *const *argv)
95 LOG_DEBUG("command - %s", name);
96 for (unsigned i = 0; i < argc; i++)
99 const char *w = Jim_GetString(argv[i], &len);
101 /* end of line comment? */
105 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
109 static void script_command_args_free(const char **words, unsigned nwords)
111 for (unsigned i = 0; i < nwords; i++)
112 free((void *)words[i]);
115 static const char **script_command_args_alloc(
116 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
118 const char **words = malloc(argc * sizeof(char *));
123 for (i = 0; i < argc; i++)
126 const char *w = Jim_GetString(argv[i], &len);
127 /* a comment may end the line early */
131 words[i] = strdup(w);
132 if (words[i] == NULL)
134 script_command_args_free(words, i);
142 static struct command_context *current_command_context(void)
144 /* grab the command context from the associated data */
145 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
148 /* Tcl can invoke commands directly instead of via command_run_line(). This would
149 * happen when the Jim Tcl interpreter is provided by eCos.
151 cmd_ctx = global_cmd_ctx;
156 static int script_command_run(Jim_Interp *interp,
157 int argc, Jim_Obj *const *argv, struct command *c, bool capture)
159 target_call_timer_callbacks_now();
160 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
163 const char **words = script_command_args_alloc(argc, argv, &nwords);
167 Jim_Obj *tclOutput = NULL;
169 tclOutput = command_log_capture_start(interp);
171 struct command_context *cmd_ctx = current_command_context();
172 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
175 command_log_capture_finish(interp, tclOutput);
177 script_command_args_free(words, nwords);
178 return command_retval_set(interp, retval);
181 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
183 /* the private data is stashed in the interp structure */
185 struct command *c = interp->cmdPrivData;
187 script_debug(interp, c->name, argc, argv);
188 return script_command_run(interp, argc, argv, c, true);
191 static struct command *command_root(struct command *c)
193 while (NULL != c->parent)
199 * Find a command by name from a list of commands.
200 * @returns Returns the named command if it exists in the list.
201 * Returns NULL otherwise.
203 static struct command *command_find(struct command *head, const char *name)
205 for (struct command *cc = head; cc; cc = cc->next)
207 if (strcmp(cc->name, name) == 0)
212 struct command *command_find_in_context(struct command_context *cmd_ctx,
215 return command_find(cmd_ctx->commands, name);
217 struct command *command_find_in_parent(struct command *parent,
220 return command_find(parent->children, name);
224 * Add the command into the linked list, sorted by name.
225 * @param head Address to head of command list pointer, which may be
226 * updated if @c c gets inserted at the beginning of the list.
227 * @param c The command to add to the list pointed to by @c head.
229 static void command_add_child(struct command **head, struct command *c)
238 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
239 head = &(*head)->next;
241 if (strcmp(c->name, (*head)->name) > 0) {
242 c->next = (*head)->next;
250 static struct command **command_list_for_parent(
251 struct command_context *cmd_ctx, struct command *parent)
253 return parent ? &parent->children : &cmd_ctx->commands;
256 static struct command *command_new(struct command_context *cmd_ctx,
257 struct command *parent, const struct command_registration *cr)
261 struct command *c = malloc(sizeof(struct command));
262 memset(c, 0, sizeof(struct command));
264 c->name = strdup(cr->name);
266 c->help = strdup(cr->help);
268 c->usage = strdup(cr->usage);
270 c->handler = cr->handler;
271 c->jim_handler = cr->jim_handler;
272 c->jim_handler_data = cr->jim_handler_data;
275 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
279 static void command_free(struct command *c)
281 /// @todo if command has a handler, unregister its jim command!
283 while (NULL != c->children)
285 struct command *tmp = c->children;
286 c->children = tmp->next;
293 free((void*)c->help);
295 free((void*)c->usage);
299 static int register_command_handler(struct command *c)
301 int retval = -ENOMEM;
302 const char *full_name = command_name(c, '_');
303 if (NULL == full_name)
306 if (NULL != c->handler)
308 const char *ocd_name = alloc_printf("ocd_%s", full_name);
309 if (NULL == full_name)
312 Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
313 free((void *)ocd_name);
316 /* we now need to add an overrideable proc */
317 const char *override_name = alloc_printf("proc %s {args} {"
318 "if {[catch {eval ocd_%s $args}] == 0} "
319 "{return \"\"} else {return -code error}}",
320 full_name, full_name);
321 if (NULL == override_name)
324 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
325 free((void *)override_name);
330 free((void *)full_name);
334 struct command* register_command(struct command_context *context,
335 struct command *parent, const struct command_registration *cr)
337 if (!context || !cr->name)
340 const char *name = cr->name;
341 struct command **head = command_list_for_parent(context, parent);
342 struct command *c = command_find(*head, name);
345 LOG_ERROR("command '%s' is already registered in '%s' context",
346 name, parent ? parent->name : "<global>");
350 c = command_new(context, parent, cr);
354 if (NULL != c->handler)
356 int retval = register_command_handler(command_root(c));
357 if (ERROR_OK != retval)
359 unregister_command(context, parent, name);
364 if (NULL != cr->jim_handler && NULL == parent)
365 Jim_CreateCommand(interp, cr->name, cr->jim_handler, cr->jim_handler_data, NULL);
370 int register_commands(struct command_context *cmd_ctx, struct command *parent,
371 const struct command_registration *cmds)
373 int retval = ERROR_OK;
375 for (i = 0; cmds[i].name || cmds[i].chain; i++)
377 const struct command_registration *cr = cmds + i;
379 struct command *c = NULL;
380 if (NULL != cr->name)
382 c = register_command(cmd_ctx, parent, cr);
389 if (NULL != cr->chain)
391 struct command *p = c ? : parent;
392 retval = register_commands(cmd_ctx, p, cr->chain);
393 if (ERROR_OK != retval)
397 if (ERROR_OK != retval)
399 for (unsigned j = 0; j < i; j++)
400 unregister_command(cmd_ctx, parent, cmds[j].name);
405 int unregister_all_commands(struct command_context *context,
406 struct command *parent)
411 struct command **head = command_list_for_parent(context, parent);
412 while (NULL != *head)
414 struct command *tmp = *head;
422 int unregister_command(struct command_context *context,
423 struct command *parent, const char *name)
425 if ((!context) || (!name))
426 return ERROR_INVALID_ARGUMENTS;
428 struct command *p = NULL;
429 struct command **head = command_list_for_parent(context, parent);
430 for (struct command *c = *head; NULL != c; p = c, c = c->next)
432 if (strcmp(name, c->name) != 0)
447 void command_output_text(struct command_context *context, const char *data)
449 if (context && context->output_handler && data) {
450 context->output_handler(context, data);
454 void command_print_sameline(struct command_context *context, const char *format, ...)
459 va_start(ap, format);
461 string = alloc_vprintf(format, ap);
464 /* we want this collected in the log + we also want to pick it up as a tcl return
467 * The latter bit isn't precisely neat, but will do for now.
469 LOG_USER_N("%s", string);
470 /* We already printed it above */
471 /* command_output_text(context, string); */
478 void command_print(struct command_context *context, const char *format, ...)
483 va_start(ap, format);
485 string = alloc_vprintf(format, ap);
488 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
489 /* we want this collected in the log + we also want to pick it up as a tcl return
492 * The latter bit isn't precisely neat, but will do for now.
494 LOG_USER_N("%s", string);
495 /* We already printed it above */
496 /* command_output_text(context, string); */
503 static char *__command_name(struct command *c, char delim, unsigned extra)
506 unsigned len = strlen(c->name);
507 if (NULL == c->parent) {
508 // allocate enough for the name, child names, and '\0'
509 name = malloc(len + extra + 1);
510 strcpy(name, c->name);
512 // parent's extra must include both the space and name
513 name = __command_name(c->parent, delim, 1 + len + extra);
514 char dstr[2] = { delim, 0 };
516 strcat(name, c->name);
520 char *command_name(struct command *c, char delim)
522 return __command_name(c, delim, 0);
525 static int run_command(struct command_context *context,
526 struct command *c, const char *words[], unsigned num_words)
528 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
530 /* Config commands can not run after the config stage */
531 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
535 struct command_invocation cmd = {
538 .argc = num_words - 1,
541 int retval = c->handler(&cmd);
542 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
544 /* Print help for command */
545 char *full_name = command_name(c, ' ');
546 if (NULL != full_name) {
547 command_run_linef(context, "help %s", full_name);
552 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
554 /* just fall through for a shutdown request */
556 else if (retval != ERROR_OK)
558 /* we do not print out an error message because the command *should*
559 * have printed out an error
561 LOG_DEBUG("Command failed with error code %d", retval);
567 int command_run_line(struct command_context *context, char *line)
569 /* all the parent commands have been registered with the interpreter
570 * so, can just evaluate the line as a script and check for
573 /* run the line thru a script engine */
574 int retval = ERROR_FAIL;
576 /* Beware! This code needs to be reentrant. It is also possible
577 * for OpenOCD commands to be invoked directly from Tcl. This would
578 * happen when the Jim Tcl interpreter is provided by eCos for
581 Jim_DeleteAssocData(interp, "context");
582 retcode = Jim_SetAssocData(interp, "context", NULL, context);
583 if (retcode == JIM_OK)
585 /* associated the return value */
586 Jim_DeleteAssocData(interp, "retval");
587 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
588 if (retcode == JIM_OK)
590 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
592 Jim_DeleteAssocData(interp, "retval");
594 Jim_DeleteAssocData(interp, "context");
596 if (retcode == JIM_ERR) {
597 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
599 /* We do not print the connection closed error message */
600 Jim_PrintErrorMessage(interp);
602 if (retval == ERROR_OK)
604 /* It wasn't a low level OpenOCD command that failed */
608 } else if (retcode == JIM_EXIT) {
610 /* exit(Jim_GetExitCode(interp)); */
615 result = Jim_GetString(Jim_GetResult(interp), &reslen);
620 for (i = 0; i < reslen; i += 256)
626 strncpy(buff, result + i, chunk);
628 LOG_USER_N("%s", buff);
630 LOG_USER_N("%s", "\n");
637 int command_run_linef(struct command_context *context, const char *format, ...)
639 int retval = ERROR_FAIL;
642 va_start(ap, format);
643 string = alloc_vprintf(format, ap);
646 retval = command_run_line(context, string);
652 void command_set_output_handler(struct command_context* context,
653 command_output_handler_t output_handler, void *priv)
655 context->output_handler = output_handler;
656 context->output_handler_priv = priv;
659 struct command_context* copy_command_context(struct command_context* context)
661 struct command_context* copy_context = malloc(sizeof(struct command_context));
663 *copy_context = *context;
668 int command_done(struct command_context *context)
676 /* find full path to file */
677 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
681 const char *file = Jim_GetString(argv[1], NULL);
682 char *full_path = find_file(file);
683 if (full_path == NULL)
685 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
688 Jim_SetResult(interp, result);
692 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
696 const char *str = Jim_GetString(argv[1], NULL);
701 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
707 /* make it a char easier to read code */
711 if (ptr == NULL || interp == NULL || nbytes == 0) {
715 /* do we have to chunk it? */
716 if (ptr[nbytes] == 0)
718 /* no it is a C style string */
719 LOG_USER_N("%s", ptr);
722 /* GRR we must chunk - not null terminated */
732 memcpy(chunk, ptr, x);
736 LOG_USER_N("%s", chunk);
744 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
746 /* TCL wants to read... tell him no */
750 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
761 cp = alloc_vprintf(fmt, ap);
764 LOG_USER_N("%s", cp);
771 static int openocd_jim_fflush(void *cookie)
773 /* nothing to flush */
777 static char* openocd_jim_fgets(char *s, int size, void *cookie)
784 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
789 Jim_Obj *tclOutput = command_log_capture_start(interp);
791 const char *str = Jim_GetString(argv[1], NULL);
792 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
794 command_log_capture_finish(interp, tclOutput);
799 static COMMAND_HELPER(command_help_find, struct command *head,
800 struct command **out)
803 return ERROR_INVALID_ARGUMENTS;
804 *out = command_find(head, CMD_ARGV[0]);
805 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
806 *out = command_find(head, CMD_ARGV[0] + 4);
808 return ERROR_INVALID_ARGUMENTS;
812 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
815 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
818 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
821 for (struct command *c = head; NULL != c; c = c->next)
822 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help);
826 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
828 static void command_help_show_indent(unsigned n)
830 for (unsigned i = 0; i < n; i++)
833 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
835 const char *cp = str, *last = str;
838 const char *next = last;
843 } while (*next != ' ' && *next != '\t' && *next != '\0');
844 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
845 if (next - last < HELP_LINE_WIDTH(n))
847 command_help_show_indent(n);
848 LOG_USER_N("%.*s", (int)(cp - last), last);
854 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
857 command_help_show_indent(n);
858 LOG_USER_N("%s", command_name(c, ' '));
861 command_help_show_wrap(c->usage, 0, n + 5);
865 if (show_help && c->help)
866 command_help_show_wrap(c->help, n + 3, n + 3);
870 return CALL_COMMAND_HANDLER(command_help_show_list,
871 c->children, n, show_help);
873 COMMAND_HANDLER(handle_help_command)
875 bool full = strcmp(CMD_NAME, "help") == 0;
877 struct command *c = CMD_CTX->commands;
880 return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, full);
882 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
883 if (ERROR_OK != retval)
886 return CALL_COMMAND_HANDLER(command_help_show, c, 0, full);
889 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
890 struct command *head, struct command **out, bool top_level)
894 const char *cmd_name = Jim_GetString(argv[0], NULL);
895 struct command *c = command_find(head, cmd_name);
896 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
897 c = command_find(head, cmd_name + 4);
901 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
904 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
906 const char *cmd_name = Jim_GetString(argv[0], NULL);
907 script_debug(interp, cmd_name, argc - 1, argv + 1);
909 struct command_context *cmd_ctx = current_command_context();
910 struct command *c = cmd_ctx->commands;
911 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
912 // if nothing could be consumed, then it's really an unknown command
913 if (remaining == argc - 1)
915 const char *cmd = Jim_GetString(argv[1], NULL);
916 LOG_ERROR("Unknown command:\n %s", cmd);
921 Jim_Obj *const *start;
923 if (c->handler || c->jim_handler)
925 // include the command name in the list
926 count = remaining + 1;
927 start = argv + (argc - remaining - 1);
931 c = command_find(cmd_ctx->commands, "help");
934 LOG_ERROR("unknown command, but help is missing too");
937 count = argc - remaining;
941 // pass the command through to the intended handler
944 interp->cmdPrivData = c->jim_handler_data;
945 return (*c->jim_handler)(interp, count, start);
948 return script_command_run(interp, count, start, c, found);
951 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
956 struct command_context *cmd_ctx = current_command_context();
957 struct command *c = cmd_ctx->commands;
958 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
959 // if nothing could be consumed, then it's an unknown command
960 if (remaining == argc - 1)
962 Jim_SetResultString(interp, "unknown", -1);
967 Jim_SetResultString(interp, "native", -1);
969 Jim_SetResultString(interp, "simple", -1);
971 Jim_SetResultString(interp, "group", -1);
976 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
977 const char *cmd_name, const char *help_text, const char *usage)
979 struct command **head = command_list_for_parent(cmd_ctx, parent);
980 struct command *nc = command_find(*head, cmd_name);
983 // add a new command with help text
984 struct command_registration cr = {
990 nc = register_command(cmd_ctx, parent, &cr);
993 LOG_ERROR("failed to add '%s' help text", cmd_name);
996 LOG_DEBUG("added '%s' help text", cmd_name);
1001 bool replaced = false;
1004 free((void *)nc->help);
1007 nc->help = strdup(help_text);
1009 LOG_INFO("replaced existing '%s' help", cmd_name);
1011 LOG_DEBUG("added '%s' help text", cmd_name);
1015 bool replaced = false;
1018 free((void *)nc->usage);
1021 nc->usage = strdup(usage);
1023 LOG_INFO("replaced existing '%s' usage", cmd_name);
1025 LOG_DEBUG("added '%s' usage text", cmd_name);
1030 COMMAND_HANDLER(handle_help_add_command)
1034 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1035 return ERROR_INVALID_ARGUMENTS;
1038 // save help text and remove it from argument list
1039 const char *str = CMD_ARGV[--CMD_ARGC];
1040 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1041 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1042 if (!help && !usage)
1044 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1045 return ERROR_INVALID_ARGUMENTS;
1047 // likewise for the leaf command name
1048 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1050 struct command *c = NULL;
1053 c = CMD_CTX->commands;
1054 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1055 if (ERROR_OK != retval)
1058 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1061 /* sleep command sleeps for <n> miliseconds
1062 * this is useful in target startup scripts
1064 COMMAND_HANDLER(handle_sleep_command)
1069 if (strcmp(CMD_ARGV[1], "busy") == 0)
1072 return ERROR_COMMAND_SYNTAX_ERROR;
1074 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1075 return ERROR_COMMAND_SYNTAX_ERROR;
1077 unsigned long duration = 0;
1078 int retval = parse_ulong(CMD_ARGV[0], &duration);
1079 if (ERROR_OK != retval)
1084 long long then = timeval_ms();
1085 while (timeval_ms() - then < (long long)duration)
1087 target_call_timer_callbacks_now();
1092 busy_sleep(duration);
1097 static const struct command_registration command_subcommand_handlers[] = {
1100 .mode = COMMAND_ANY,
1101 .jim_handler = &jim_command_type,
1102 .usage = "<name> ...",
1103 .help = "Returns the type of built-in command:"
1104 "'native', 'simple', 'group', or 'unknown'",
1106 COMMAND_REGISTRATION_DONE
1109 static const struct command_registration command_builtin_handlers[] = {
1111 .name = "add_help_text",
1112 .handler = &handle_help_add_command,
1113 .mode = COMMAND_ANY,
1114 .help = "add new command help text",
1115 .usage = "<command> [...] <help_text>]",
1118 .name = "add_usage_text",
1119 .handler = &handle_help_add_command,
1120 .mode = COMMAND_ANY,
1121 .help = "add new command usage text",
1122 .usage = "<command> [...] <usage_text>]",
1126 .handler = &handle_sleep_command,
1127 .mode = COMMAND_ANY,
1128 .help = "sleep for n milliseconds. "
1129 "\"busy\" will busy wait",
1130 .usage = "<n> [busy]",
1134 .handler = &handle_help_command,
1135 .mode = COMMAND_ANY,
1136 .help = "show full command help",
1137 .usage = "[<command> ...]",
1141 .handler = &handle_help_command,
1142 .mode = COMMAND_ANY,
1143 .help = "show basic command usage",
1144 .usage = "[<command> ...]",
1149 .help = "core command group (introspection)",
1150 .chain = command_subcommand_handlers,
1152 COMMAND_REGISTRATION_DONE
1155 struct command_context* command_init(const char *startup_tcl)
1157 struct command_context* context = malloc(sizeof(struct command_context));
1160 context->mode = COMMAND_EXEC;
1161 context->commands = NULL;
1162 context->current_target = 0;
1163 context->output_handler = NULL;
1164 context->output_handler_priv = NULL;
1166 #if !BUILD_ECOSBOARD
1168 /* Create an interpreter */
1169 interp = Jim_CreateInterp();
1170 /* Add all the Jim core commands */
1171 Jim_RegisterCoreCommands(interp);
1174 #if defined(_MSC_VER)
1175 /* WinXX - is generic, the forward
1176 * looking problem is this:
1178 * "win32" or "win64"
1180 * "winxx" is generic.
1183 #elif defined(__linux__)
1185 #elif defined(__DARWIN__)
1187 #elif defined(__CYGWIN__)
1189 #elif defined(__MINGW32__)
1191 #elif defined(__ECOS)
1194 #warn unrecognized host OS...
1197 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1198 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1200 Jim_CreateCommand(interp, "unknown", &command_unknown, NULL, NULL);
1201 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1202 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
1203 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1205 /* Set Jim's STDIO */
1206 interp->cookie_stdin = interp;
1207 interp->cookie_stdout = interp;
1208 interp->cookie_stderr = interp;
1209 interp->cb_fwrite = openocd_jim_fwrite;
1210 interp->cb_fread = openocd_jim_fread ;
1211 interp->cb_vfprintf = openocd_jim_vfprintf;
1212 interp->cb_fflush = openocd_jim_fflush;
1213 interp->cb_fgets = openocd_jim_fgets;
1215 register_commands(context, NULL, command_builtin_handlers);
1217 #if !BUILD_ECOSBOARD
1218 Jim_EventLoopOnLoad(interp);
1220 Jim_SetAssocData(interp, "context", NULL, context);
1221 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1223 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1224 Jim_PrintErrorMessage(interp);
1227 Jim_DeleteAssocData(interp, "context");
1232 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1235 return ERROR_INVALID_ARGUMENTS;
1237 cmd_ctx->mode = mode;
1241 void process_jim_events(void)
1243 #if !BUILD_ECOSBOARD
1244 static int recursion = 0;
1249 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1255 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1256 int parse##name(const char *str, type *ul) \
1260 LOG_ERROR("Invalid command argument"); \
1261 return ERROR_COMMAND_ARGUMENT_INVALID; \
1264 *ul = func(str, &end, 0); \
1267 LOG_ERROR("Invalid command argument"); \
1268 return ERROR_COMMAND_ARGUMENT_INVALID; \
1270 if ((max == *ul) && (ERANGE == errno)) \
1272 LOG_ERROR("Argument overflow"); \
1273 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1275 if (min && (min == *ul) && (ERANGE == errno)) \
1277 LOG_ERROR("Argument underflow"); \
1278 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1282 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1283 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1284 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1285 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1287 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1288 int parse##name(const char *str, type *ul) \
1291 int retval = parse##funcname(str, &n); \
1292 if (ERROR_OK != retval) \
1295 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1297 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1302 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1303 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1304 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1305 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1306 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1307 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1309 #define DEFINE_PARSE_LONG(name, type, min, max) \
1310 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1311 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1312 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1313 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1314 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1316 static int command_parse_bool(const char *in, bool *out,
1317 const char *on, const char *off)
1319 if (strcasecmp(in, on) == 0)
1321 else if (strcasecmp(in, off) == 0)
1324 return ERROR_COMMAND_SYNTAX_ERROR;
1328 int command_parse_bool_arg(const char *in, bool *out)
1330 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1332 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1334 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1336 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1338 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1340 return ERROR_INVALID_ARGUMENTS;
1343 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1347 const char *in = CMD_ARGV[0];
1348 if (command_parse_bool_arg(in, out) != ERROR_OK)
1350 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1351 return ERROR_INVALID_ARGUMENTS;
1356 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1359 return ERROR_INVALID_ARGUMENTS;