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 Jim_Interp *interp = NULL;
49 static int run_command(struct command_context *context,
50 struct command *c, const char *words[], unsigned num_words);
52 static void tcl_output(void *privData, const char *file, unsigned line,
53 const char *function, const char *string)
55 Jim_Obj *tclOutput = (Jim_Obj *)privData;
56 Jim_AppendString(interp, tclOutput, string, strlen(string));
59 extern struct command_context *global_cmd_ctx;
61 void script_debug(Jim_Interp *interp, const char *name,
62 unsigned argc, Jim_Obj *const *argv)
64 LOG_DEBUG("command - %s", name);
65 for (unsigned i = 0; i < argc; i++)
68 const char *w = Jim_GetString(argv[i], &len);
70 /* end of line comment? */
74 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
78 static void script_command_args_free(const char **words, unsigned nwords)
80 for (unsigned i = 0; i < nwords; i++)
81 free((void *)words[i]);
84 static const char **script_command_args_alloc(
85 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
87 const char **words = malloc(argc * sizeof(char *));
92 for (i = 0; i < argc; i++)
95 const char *w = Jim_GetString(argv[i], &len);
96 /* a comment may end the line early */
100 words[i] = strdup(w);
101 if (words[i] == NULL)
103 script_command_args_free(words, i);
111 static struct command_context *current_command_context(void)
113 /* grab the command context from the associated data */
114 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
117 /* Tcl can invoke commands directly instead of via command_run_line(). This would
118 * happen when the Jim Tcl interpreter is provided by eCos.
120 cmd_ctx = global_cmd_ctx;
125 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
127 /* the private data is stashed in the interp structure */
131 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
132 * get overwritten by running other Jim commands! Treat it as an
133 * emphemeral global variable that is used in lieu of an argument
134 * to the fn and fish it out manually.
136 c = interp->cmdPrivData;
139 LOG_ERROR("BUG: interp->cmdPrivData == NULL");
142 target_call_timer_callbacks_now();
143 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
145 script_debug(interp, c->name, argc, argv);
148 const char **words = script_command_args_alloc(argc, argv, &nwords);
152 /* capture log output and return it */
153 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
154 /* a garbage collect can happen, so we need a reference count to this object */
155 Jim_IncrRefCount(tclOutput);
157 log_add_callback(tcl_output, tclOutput);
159 struct command_context *cmd_ctx = current_command_context();
160 retval = run_command(cmd_ctx, c, (const char **)words, nwords);
162 log_remove_callback(tcl_output, tclOutput);
164 /* We dump output into this local variable */
165 Jim_SetResult(interp, tclOutput);
166 Jim_DecrRefCount(interp, tclOutput);
168 script_command_args_free(words, nwords);
170 int *return_retval = Jim_GetAssocData(interp, "retval");
171 if (return_retval != NULL)
173 *return_retval = retval;
176 return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
179 /* nice short description of source file */
180 #define __THIS__FILE__ "command.c"
183 * Find a command by name from a list of commands.
184 * @returns Returns the named command if it exists in the list.
185 * Returns NULL otherwise.
187 static struct command *command_find(struct command *head, const char *name)
189 for (struct command *cc = head; cc; cc = cc->next)
191 if (strcmp(cc->name, name) == 0)
196 struct command *command_find_in_context(struct command_context *cmd_ctx,
199 return command_find(cmd_ctx->commands, name);
201 struct command *command_find_in_parent(struct command *parent,
204 return command_find(parent->children, name);
208 * Add the command into the linked list, sorted by name.
209 * @param head Address to head of command list pointer, which may be
210 * updated if @c c gets inserted at the beginning of the list.
211 * @param c The command to add to the list pointed to by @c head.
213 static void command_add_child(struct command **head, struct command *c)
222 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
223 head = &(*head)->next;
225 if (strcmp(c->name, (*head)->name) > 0) {
226 c->next = (*head)->next;
234 static struct command **command_list_for_parent(
235 struct command_context *cmd_ctx, struct command *parent)
237 return parent ? &parent->children : &cmd_ctx->commands;
240 static struct command *command_new(struct command_context *cmd_ctx,
241 struct command *parent, const char *name,
242 command_handler_t handler, enum command_mode mode,
243 const char *help, const char *usage)
247 struct command *c = malloc(sizeof(struct command));
248 memset(c, 0, sizeof(struct command));
250 c->name = strdup(name);
252 c->help = strdup(help);
254 c->usage = strdup(usage);
256 c->handler = handler;
259 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
263 static void command_free(struct command *c)
265 /// @todo if command has a handler, unregister its jim command!
267 while (NULL != c->children)
269 struct command *tmp = c->children;
270 c->children = tmp->next;
277 free((void*)c->help);
279 free((void*)c->usage);
283 static int register_command_handler(struct command *c)
285 int retval = -ENOMEM;
286 const char *full_name = command_name(c, '_');
287 if (NULL == full_name)
290 const char *ocd_name = alloc_printf("ocd_%s", full_name);
291 if (NULL == full_name)
294 Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
295 free((void *)ocd_name);
297 /* we now need to add an overrideable proc */
298 const char *override_name = alloc_printf("proc %s {args} {"
299 "if {[catch {eval ocd_%s $args}] == 0} "
300 "{return \"\"} else {return -code error}}",
301 full_name, full_name);
302 if (NULL == full_name)
305 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
306 free((void *)override_name);
311 free((void *)full_name);
315 struct command* register_command(struct command_context *context,
316 struct command *parent, const struct command_registration *cr)
318 if (!context || !cr->name)
321 const char *name = cr->name;
322 struct command **head = command_list_for_parent(context, parent);
323 struct command *c = command_find(*head, name);
326 LOG_ERROR("command '%s' is already registered in '%s' context",
327 name, parent ? parent->name : "<global>");
331 c = command_new(context, parent, name, cr->handler, cr->mode, cr->help, cr->usage);
332 /* if allocation failed or it is a placeholder (no handler), we're done */
333 if (NULL == c || NULL == c->handler)
336 int retval = register_command_handler(c);
337 if (ERROR_OK != retval)
339 unregister_command(context, parent, name);
345 int register_commands(struct command_context *cmd_ctx, struct command *parent,
346 const struct command_registration *cmds)
348 int retval = ERROR_OK;
350 for (i = 0; cmds[i].name || cmds[i].chain; i++)
352 const struct command_registration *cr = cmds + i;
354 struct command *c = NULL;
355 if (NULL != cr->name)
357 c = register_command(cmd_ctx, parent, cr);
364 if (NULL != cr->chain)
366 struct command *p = c ? : parent;
367 retval = register_commands(cmd_ctx, p, cr->chain);
368 if (ERROR_OK != retval)
372 if (ERROR_OK != retval)
374 for (unsigned j = 0; j < i; j++)
375 unregister_command(cmd_ctx, parent, cmds[j].name);
380 int unregister_all_commands(struct command_context *context,
381 struct command *parent)
386 struct command **head = command_list_for_parent(context, parent);
387 while (NULL != *head)
389 struct command *tmp = *head;
397 int unregister_command(struct command_context *context,
398 struct command *parent, const char *name)
400 if ((!context) || (!name))
401 return ERROR_INVALID_ARGUMENTS;
403 struct command *p = NULL;
404 struct command **head = command_list_for_parent(context, parent);
405 for (struct command *c = *head; NULL != c; p = c, c = c->next)
407 if (strcmp(name, c->name) != 0)
422 void command_output_text(struct command_context *context, const char *data)
424 if (context && context->output_handler && data) {
425 context->output_handler(context, data);
429 void command_print_sameline(struct command_context *context, const char *format, ...)
434 va_start(ap, format);
436 string = alloc_vprintf(format, ap);
439 /* we want this collected in the log + we also want to pick it up as a tcl return
442 * The latter bit isn't precisely neat, but will do for now.
444 LOG_USER_N("%s", string);
445 /* We already printed it above */
446 /* command_output_text(context, string); */
453 void command_print(struct command_context *context, const char *format, ...)
458 va_start(ap, format);
460 string = alloc_vprintf(format, ap);
463 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
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 static char *__command_name(struct command *c, char delim, unsigned extra)
481 unsigned len = strlen(c->name);
482 if (NULL == c->parent) {
483 // allocate enough for the name, child names, and '\0'
484 name = malloc(len + extra + 1);
485 strcpy(name, c->name);
487 // parent's extra must include both the space and name
488 name = __command_name(c->parent, delim, 1 + len + extra);
489 char dstr[2] = { delim, 0 };
491 strcat(name, c->name);
495 char *command_name(struct command *c, char delim)
497 return __command_name(c, delim, 0);
500 static int run_command(struct command_context *context,
501 struct command *c, const char *words[], unsigned num_words)
503 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
505 /* Config commands can not run after the config stage */
506 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
510 struct command_invocation cmd = {
513 .argc = num_words - 1,
516 int retval = c->handler(&cmd);
517 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
519 /* Print help for command */
520 char *full_name = command_name(c, ' ');
521 if (NULL != full_name) {
522 command_run_linef(context, "help %s", full_name);
527 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
529 /* just fall through for a shutdown request */
531 else if (retval != ERROR_OK)
533 /* we do not print out an error message because the command *should*
534 * have printed out an error
536 LOG_DEBUG("Command failed with error code %d", retval);
542 int command_run_line(struct command_context *context, char *line)
544 /* all the parent commands have been registered with the interpreter
545 * so, can just evaluate the line as a script and check for
548 /* run the line thru a script engine */
549 int retval = ERROR_FAIL;
551 /* Beware! This code needs to be reentrant. It is also possible
552 * for OpenOCD commands to be invoked directly from Tcl. This would
553 * happen when the Jim Tcl interpreter is provided by eCos for
556 Jim_DeleteAssocData(interp, "context");
557 retcode = Jim_SetAssocData(interp, "context", NULL, context);
558 if (retcode == JIM_OK)
560 /* associated the return value */
561 Jim_DeleteAssocData(interp, "retval");
562 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
563 if (retcode == JIM_OK)
565 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
567 Jim_DeleteAssocData(interp, "retval");
569 Jim_DeleteAssocData(interp, "context");
571 if (retcode == JIM_ERR) {
572 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
574 /* We do not print the connection closed error message */
575 Jim_PrintErrorMessage(interp);
577 if (retval == ERROR_OK)
579 /* It wasn't a low level OpenOCD command that failed */
583 } else if (retcode == JIM_EXIT) {
585 /* exit(Jim_GetExitCode(interp)); */
590 result = Jim_GetString(Jim_GetResult(interp), &reslen);
595 for (i = 0; i < reslen; i += 256)
601 strncpy(buff, result + i, chunk);
603 LOG_USER_N("%s", buff);
605 LOG_USER_N("%s", "\n");
612 int command_run_linef(struct command_context *context, const char *format, ...)
614 int retval = ERROR_FAIL;
617 va_start(ap, format);
618 string = alloc_vprintf(format, ap);
621 retval = command_run_line(context, string);
627 void command_set_output_handler(struct command_context* context,
628 command_output_handler_t output_handler, void *priv)
630 context->output_handler = output_handler;
631 context->output_handler_priv = priv;
634 struct command_context* copy_command_context(struct command_context* context)
636 struct command_context* copy_context = malloc(sizeof(struct command_context));
638 *copy_context = *context;
643 int command_done(struct command_context *context)
651 /* find full path to file */
652 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
656 const char *file = Jim_GetString(argv[1], NULL);
657 char *full_path = find_file(file);
658 if (full_path == NULL)
660 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
663 Jim_SetResult(interp, result);
667 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
671 const char *str = Jim_GetString(argv[1], NULL);
676 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
682 /* make it a char easier to read code */
686 if (ptr == NULL || interp == NULL || nbytes == 0) {
690 /* do we have to chunk it? */
691 if (ptr[nbytes] == 0)
693 /* no it is a C style string */
694 LOG_USER_N("%s", ptr);
697 /* GRR we must chunk - not null terminated */
707 memcpy(chunk, ptr, x);
711 LOG_USER_N("%s", chunk);
719 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
721 /* TCL wants to read... tell him no */
725 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
736 cp = alloc_vprintf(fmt, ap);
739 LOG_USER_N("%s", cp);
746 static int openocd_jim_fflush(void *cookie)
748 /* nothing to flush */
752 static char* openocd_jim_fgets(char *s, int size, void *cookie)
759 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
764 const char *str = Jim_GetString(argv[1], NULL);
766 /* capture log output and return it */
767 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
768 /* a garbage collect can happen, so we need a reference count to this object */
769 Jim_IncrRefCount(tclOutput);
771 log_add_callback(tcl_output, tclOutput);
773 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
775 log_remove_callback(tcl_output, tclOutput);
777 /* We dump output into this local variable */
778 Jim_SetResult(interp, tclOutput);
779 Jim_DecrRefCount(interp, tclOutput);
784 static COMMAND_HELPER(command_help_find, struct command *head,
785 struct command **out)
788 return ERROR_INVALID_ARGUMENTS;
789 *out = command_find(head, CMD_ARGV[0]);
791 return ERROR_INVALID_ARGUMENTS;
795 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
798 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
801 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
804 for (struct command *c = head; NULL != c; c = c->next)
805 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help);
808 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
811 const char *usage = c->usage ? : "";
812 const char *help = "";
813 const char *sep = "";
814 if (show_help && c->help)
816 help = c->help ? : "";
817 sep = c->usage ? " | " : "";
819 command_run_linef(CMD_CTX, "cmd_help {%s} {%s%s%s} %d",
820 command_name(c, ' '), usage, sep, help, n);
825 return CALL_COMMAND_HANDLER(command_help_show_list,
826 c->children, n, show_help);
828 COMMAND_HANDLER(handle_help_command)
830 struct command *c = CMD_CTX->commands;
833 return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, true);
835 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
836 if (ERROR_OK != retval)
839 return CALL_COMMAND_HANDLER(command_help_show, c, 0, true);
842 COMMAND_HANDLER(handle_usage_command)
844 struct command *c = CMD_CTX->commands;
847 return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, false);
849 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
850 if (ERROR_OK != retval)
853 return CALL_COMMAND_HANDLER(command_help_show, c, 0, false);
856 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
857 struct command *head, struct command **out)
861 struct command *c = command_find(head, Jim_GetString(argv[0], NULL));
865 return command_unknown_find(--argc, ++argv, (*out)->children, out);
868 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
870 const char *cmd_name = Jim_GetString(argv[0], NULL);
871 script_debug(interp, cmd_name, argc - 1, argv + 1);
873 struct command_context *cmd_ctx = current_command_context();
874 struct command *c = cmd_ctx->commands;
875 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c);
876 // if nothing could be consumed, then it's really an unknown command
877 if (remaining == argc - 1)
879 const char *cmd = Jim_GetString(argv[1], NULL);
880 LOG_ERROR("Unknown command:\n %s", cmd);
885 Jim_Obj *const *start;
889 // include the command name in the list
890 count = remaining + 1;
891 start = argv + (argc - remaining - 1);
895 c = command_find(cmd_ctx->commands, "help");
898 LOG_ERROR("unknown command, but help is missing too");
901 count = argc - remaining;
907 const char **words = script_command_args_alloc(count, start, &nwords);
911 int retval = run_command(cmd_ctx, c, words, nwords);
913 script_command_args_free(words, nwords);
915 if (!found && ERROR_OK == retval)
921 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
922 const char *cmd_name, const char *help_text, const char *usage)
924 struct command **head = command_list_for_parent(cmd_ctx, parent);
925 struct command *nc = command_find(*head, cmd_name);
928 // add a new command with help text
929 struct command_registration cr = {
935 nc = register_command(cmd_ctx, parent, &cr);
938 LOG_ERROR("failed to add '%s' help text", cmd_name);
941 LOG_DEBUG("added '%s' help text", cmd_name);
945 bool replaced = false;
948 free((void *)nc->help);
951 nc->help = strdup(help_text);
954 LOG_INFO("replaced existing '%s' help", cmd_name);
956 LOG_DEBUG("added '%s' help text", cmd_name);
961 COMMAND_HANDLER(handle_help_add_command)
965 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
966 return ERROR_INVALID_ARGUMENTS;
969 // save help text and remove it from argument list
970 const char *help_text = CMD_ARGV[--CMD_ARGC];
971 // likewise for the leaf command name
972 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
974 struct command *c = NULL;
977 c = CMD_CTX->commands;
978 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
979 if (ERROR_OK != retval)
982 return help_add_command(CMD_CTX, c, cmd_name, help_text, NULL);
985 /* sleep command sleeps for <n> miliseconds
986 * this is useful in target startup scripts
988 COMMAND_HANDLER(handle_sleep_command)
993 if (strcmp(CMD_ARGV[1], "busy") == 0)
996 return ERROR_COMMAND_SYNTAX_ERROR;
998 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
999 return ERROR_COMMAND_SYNTAX_ERROR;
1001 unsigned long duration = 0;
1002 int retval = parse_ulong(CMD_ARGV[0], &duration);
1003 if (ERROR_OK != retval)
1008 long long then = timeval_ms();
1009 while (timeval_ms() - then < (long long)duration)
1011 target_call_timer_callbacks_now();
1016 busy_sleep(duration);
1021 static const struct command_registration command_builtin_handlers[] = {
1023 .name = "add_help_text",
1024 .handler = &handle_help_add_command,
1025 .mode = COMMAND_ANY,
1026 .help = "add new command help text",
1027 .usage = "<command> [...] <help_text>]",
1031 .handler = &handle_sleep_command,
1032 .mode = COMMAND_ANY,
1033 .help = "sleep for n milliseconds. "
1034 "\"busy\" will busy wait",
1035 .usage = "<n> [busy]",
1039 .handler = &handle_help_command,
1040 .mode = COMMAND_ANY,
1041 .help = "show built-in command help",
1042 .usage = "[<command_name> ...]",
1046 .handler = &handle_usage_command,
1047 .mode = COMMAND_ANY,
1048 .help = "show command usage",
1049 .usage = "[<command_name> ...]",
1051 COMMAND_REGISTRATION_DONE
1054 struct command_context* command_init(const char *startup_tcl)
1056 struct command_context* context = malloc(sizeof(struct command_context));
1059 context->mode = COMMAND_EXEC;
1060 context->commands = NULL;
1061 context->current_target = 0;
1062 context->output_handler = NULL;
1063 context->output_handler_priv = NULL;
1065 #if !BUILD_ECOSBOARD
1067 /* Create an interpreter */
1068 interp = Jim_CreateInterp();
1069 /* Add all the Jim core commands */
1070 Jim_RegisterCoreCommands(interp);
1073 #if defined(_MSC_VER)
1074 /* WinXX - is generic, the forward
1075 * looking problem is this:
1077 * "win32" or "win64"
1079 * "winxx" is generic.
1082 #elif defined(__linux__)
1084 #elif defined(__DARWIN__)
1086 #elif defined(__CYGWIN__)
1088 #elif defined(__MINGW32__)
1090 #elif defined(__ECOS)
1093 #warn unrecognized host OS...
1096 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1097 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1099 Jim_CreateCommand(interp, "unknown", &command_unknown, NULL, NULL);
1100 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1101 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
1102 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1104 /* Set Jim's STDIO */
1105 interp->cookie_stdin = interp;
1106 interp->cookie_stdout = interp;
1107 interp->cookie_stderr = interp;
1108 interp->cb_fwrite = openocd_jim_fwrite;
1109 interp->cb_fread = openocd_jim_fread ;
1110 interp->cb_vfprintf = openocd_jim_vfprintf;
1111 interp->cb_fflush = openocd_jim_fflush;
1112 interp->cb_fgets = openocd_jim_fgets;
1114 register_commands(context, NULL, command_builtin_handlers);
1116 #if !BUILD_ECOSBOARD
1117 Jim_EventLoopOnLoad(interp);
1119 Jim_SetAssocData(interp, "context", NULL, context);
1120 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1122 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1123 Jim_PrintErrorMessage(interp);
1126 Jim_DeleteAssocData(interp, "context");
1131 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1134 return ERROR_INVALID_ARGUMENTS;
1136 cmd_ctx->mode = mode;
1140 void process_jim_events(void)
1142 #if !BUILD_ECOSBOARD
1143 static int recursion = 0;
1148 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1154 void register_jim(struct command_context *cmd_ctx, const char *name,
1155 Jim_CmdProc cmd, const char *help)
1157 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
1159 Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
1160 Jim_ListAppendElement(interp, cmd_list,
1161 Jim_NewStringObj(interp, name, -1));
1163 help_add_command(cmd_ctx, NULL, name, help, NULL);
1166 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1167 int parse##name(const char *str, type *ul) \
1171 LOG_ERROR("Invalid command argument"); \
1172 return ERROR_COMMAND_ARGUMENT_INVALID; \
1175 *ul = func(str, &end, 0); \
1178 LOG_ERROR("Invalid command argument"); \
1179 return ERROR_COMMAND_ARGUMENT_INVALID; \
1181 if ((max == *ul) && (ERANGE == errno)) \
1183 LOG_ERROR("Argument overflow"); \
1184 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1186 if (min && (min == *ul) && (ERANGE == errno)) \
1188 LOG_ERROR("Argument underflow"); \
1189 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1193 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1194 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1195 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1196 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1198 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1199 int parse##name(const char *str, type *ul) \
1202 int retval = parse##funcname(str, &n); \
1203 if (ERROR_OK != retval) \
1206 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1208 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1213 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1214 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1215 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1216 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1217 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1218 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1220 #define DEFINE_PARSE_LONG(name, type, min, max) \
1221 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1222 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1223 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1224 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1225 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1227 static int command_parse_bool(const char *in, bool *out,
1228 const char *on, const char *off)
1230 if (strcasecmp(in, on) == 0)
1232 else if (strcasecmp(in, off) == 0)
1235 return ERROR_COMMAND_SYNTAX_ERROR;
1239 int command_parse_bool_arg(const char *in, bool *out)
1241 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1243 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1245 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1247 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1249 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1251 return ERROR_INVALID_ARGUMENTS;
1254 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1258 const char *in = CMD_ARGV[0];
1259 if (command_parse_bool_arg(in, out) != ERROR_OK)
1261 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1262 return ERROR_INVALID_ARGUMENTS;
1267 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1270 return ERROR_INVALID_ARGUMENTS;