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 ***************************************************************************/
33 #include "replacements.h"
36 #include "configuration.h"
39 #include "time_support.h"
40 #include "jim-eventloop.h"
50 int fast_and_dangerous = 0;
51 Jim_Interp *interp = NULL;
53 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
56 int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
58 static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
60 Jim_Obj *tclOutput=(Jim_Obj *)privData;
62 Jim_AppendString(interp, tclOutput, string, strlen(string));
65 extern command_context_t *global_cmd_ctx;
67 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
69 /* the private data is stashed in the interp structure */
71 command_context_t *context;
77 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
78 * get overwritten by running other Jim commands! Treat it as an
79 * emphemeral global variable that is used in lieu of an argument
80 * to the fn and fish it out manually.
82 c = interp->cmdPrivData;
85 LOG_ERROR("BUG: interp->cmdPrivData==NULL");
88 target_call_timer_callbacks_now();
89 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
91 LOG_DEBUG("script_command - %s", c->name);
93 words = malloc(sizeof(char *) * argc);
94 for (i = 0; i < argc; i++)
97 const char *w=Jim_GetString(argv[i], &len);
100 /* hit an end of line comment */
103 words[i] = strdup(w);
104 if (words[i] == NULL)
108 LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
112 /* grab the command context from the associated data */
113 context = Jim_GetAssocData(interp, "context");
116 /* Tcl can invoke commands directly instead of via command_run_line(). This would
117 * happen when the Jim Tcl interpreter is provided by eCos.
119 context = global_cmd_ctx;
122 /* capture log output and return it */
123 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
124 /* a garbage collect can happen, so we need a reference count to this object */
125 Jim_IncrRefCount(tclOutput);
127 log_add_callback(tcl_output, tclOutput);
129 retval = run_command(context, c, words, nwords);
131 log_remove_callback(tcl_output, tclOutput);
133 /* We dump output into this local variable */
134 Jim_SetResult(interp, tclOutput);
135 Jim_DecrRefCount(interp, tclOutput);
137 for (i = 0; i < nwords; i++)
141 int *return_retval = Jim_GetAssocData(interp, "retval");
142 if (return_retval != NULL)
144 *return_retval = retval;
147 return (retval==ERROR_OK)?JIM_OK:JIM_ERR;
150 /* nice short description of source file */
151 #define __THIS__FILE__ "command.c"
153 command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
157 if (!context || !name)
160 c = malloc(sizeof(command_t));
162 c->name = strdup(name);
165 c->handler = handler;
171 /* place command in tree */
174 if (parent->children)
176 /* find last child */
177 for (p = parent->children; p && p->next; p = p->next);
183 parent->children = c;
188 if (context->commands)
190 /* find last command */
191 for (p = context->commands; p && p->next; p = p->next);
197 context->commands = c;
201 /* just a placeholder, no handler */
202 if (c->handler==NULL)
205 /* If this is a two level command, e.g. "flash banks", then the
206 * "unknown" proc in startup.tcl must redirect to this command.
208 * "flash banks" is translated by "unknown" to "flash_banks"
209 * if such a proc exists
211 /* Print help for command */
215 /* maximum of two levels :-) */
222 const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3);
223 Jim_CreateCommand(interp, full_name, script_command, c, NULL);
224 free((void *)full_name);
226 /* we now need to add an overrideable proc */
227 const char *override_name=alloc_printf("proc %s%s%s {args} {if {[catch {eval \"ocd_%s%s%s $args\"}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3);
228 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__ );
229 free((void *)override_name);
231 /* accumulate help text in Tcl helptext list. */
232 Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
233 if (Jim_IsShared(helptext))
234 helptext = Jim_DuplicateObj(interp, helptext);
235 Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
237 Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
239 /* maximum of two levels :-) */
242 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
244 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
246 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
247 Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
248 Jim_ListAppendElement(interp, helptext, cmd_entry);
252 int unregister_all_commands(command_context_t *context)
259 while(NULL != context->commands)
261 c = context->commands;
263 while(NULL != c->children)
266 c->children = c->children->next;
273 context->commands = context->commands->next;
284 int unregister_command(command_context_t *context, char *name)
286 command_t *c, *p = NULL, *c2;
288 if ((!context) || (!name))
289 return ERROR_INVALID_ARGUMENTS;
292 c = context->commands;
296 if (strcmp(name, c->name) == 0)
305 /* first element in command list */
306 context->commands = c->next;
309 /* unregister children */
310 while(NULL != c->children)
313 c->children = c->children->next;
328 /* remember the last command for unlinking */
336 void command_output_text(command_context_t *context, const char *data)
338 if( context && context->output_handler && data ){
339 context->output_handler( context, data );
343 void command_print_n(command_context_t *context, char *format, ...)
348 va_start(ap, format);
350 string = alloc_vprintf(format, ap);
353 /* we want this collected in the log + we also want to pick it up as a tcl return
356 * The latter bit isn't precisely neat, but will do for now.
358 LOG_USER_N("%s", string);
359 // We already printed it above
360 //command_output_text(context, string);
367 void command_print(command_context_t *context, char *format, ...)
372 va_start(ap, format);
374 string = alloc_vprintf(format, ap);
377 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
378 /* we want this collected in the log + we also want to pick it up as a tcl return
381 * The latter bit isn't precisely neat, but will do for now.
383 LOG_USER_N("%s", string);
384 // We already printed it above
385 //command_output_text(context, string);
392 int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
395 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
397 /* Config commands can not run after the config stage */
398 LOG_ERROR("Illegal mode for command");
402 int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
403 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
405 /* Print help for command */
409 /* maximum of two levels :-) */
416 command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
418 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
420 /* just fall through for a shutdown request */
422 else if (retval != ERROR_OK)
424 /* we do not print out an error message because the command *should*
425 * have printed out an error
427 LOG_DEBUG("Command failed with error code %d", retval);
433 int command_run_line(command_context_t *context, char *line)
435 /* all the parent commands have been registered with the interpreter
436 * so, can just evaluate the line as a script and check for
439 /* run the line thru a script engine */
440 int retval=ERROR_FAIL;
442 /* Beware! This code needs to be reentrant. It is also possible
443 * for OpenOCD commands to be invoked directly from Tcl. This would
444 * happen when the Jim Tcl interpreter is provided by eCos for
447 Jim_DeleteAssocData(interp, "context");
448 retcode = Jim_SetAssocData(interp, "context", NULL, context);
449 if (retcode == JIM_OK)
451 /* associated the return value */
452 Jim_DeleteAssocData(interp, "retval");
453 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
454 if (retcode == JIM_OK)
456 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ );
458 Jim_DeleteAssocData(interp, "retval");
460 Jim_DeleteAssocData(interp, "context");
462 if (retcode == JIM_ERR) {
463 if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
465 /* We do not print the connection closed error message */
466 Jim_PrintErrorMessage(interp);
468 if (retval==ERROR_OK)
470 /* It wasn't a low level OpenOCD command that failed */
474 } else if (retcode == JIM_EXIT) {
476 /* exit(Jim_GetExitCode(interp)); */
481 result = Jim_GetString(Jim_GetResult(interp), &reslen);
485 for (i = 0; i < reslen; i += 256)
491 strncpy(buff, result+i, chunk);
493 LOG_USER_N("%s", buff);
495 LOG_USER_N("%s", "\n");
501 int command_run_linef(command_context_t *context, char *format, ...)
503 int retval=ERROR_FAIL;
506 va_start(ap, format);
507 string = alloc_vprintf(format, ap);
510 retval=command_run_line(context, string);
516 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
518 context->output_handler = output_handler;
519 context->output_handler_priv = priv;
522 command_context_t* copy_command_context(command_context_t* context)
524 command_context_t* copy_context = malloc(sizeof(command_context_t));
526 *copy_context = *context;
531 int command_done(command_context_t *context)
539 /* find full path to file */
540 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
544 const char *file = Jim_GetString(argv[1], NULL);
545 char *full_path = find_file(file);
546 if (full_path == NULL)
548 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
551 Jim_SetResult(interp, result);
555 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
559 const char *str = Jim_GetString(argv[1], NULL);
564 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
570 /* make it a char easier to read code */
574 if (ptr == NULL || interp == NULL || nbytes == 0) {
578 /* do we have to chunk it? */
579 if (ptr[nbytes] == 0)
581 /* no it is a C style string */
582 LOG_USER_N("%s", ptr);
585 /* GRR we must chunk - not null terminated */
595 memcpy(chunk, ptr, x);
599 LOG_USER_N("%s", chunk);
607 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
609 /* TCL wants to read... tell him no */
613 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
624 cp = alloc_vprintf(fmt, ap);
627 LOG_USER_N("%s", cp);
634 static int openocd_jim_fflush(void *cookie)
636 /* nothing to flush */
640 static char* openocd_jim_fgets(char *s, int size, void *cookie)
648 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
653 const char *str = Jim_GetString(argv[1], NULL);
655 /* capture log output and return it */
656 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
657 /* a garbage collect can happen, so we need a reference count to this object */
658 Jim_IncrRefCount(tclOutput);
660 log_add_callback(tcl_output, tclOutput);
662 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__ );
664 log_remove_callback(tcl_output, tclOutput);
666 /* We dump output into this local variable */
667 Jim_SetResult(interp, tclOutput);
668 Jim_DecrRefCount(interp, tclOutput);
673 command_context_t* command_init()
675 command_context_t* context = malloc(sizeof(command_context_t));
676 extern const char startup_tcl[];
678 context->mode = COMMAND_EXEC;
679 context->commands = NULL;
680 context->current_target = 0;
681 context->output_handler = NULL;
682 context->output_handler_priv = NULL;
686 /* Create an interpreter */
687 interp = Jim_CreateInterp();
688 /* Add all the Jim core commands */
689 Jim_RegisterCoreCommands(interp);
692 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
693 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
694 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
696 /* Set Jim's STDIO */
697 interp->cookie_stdin = interp;
698 interp->cookie_stdout = interp;
699 interp->cookie_stderr = interp;
700 interp->cb_fwrite = openocd_jim_fwrite;
701 interp->cb_fread = openocd_jim_fread ;
702 interp->cb_vfprintf = openocd_jim_vfprintf;
703 interp->cb_fflush = openocd_jim_fflush;
704 interp->cb_fgets = openocd_jim_fgets;
709 Jim_EventLoopOnLoad(interp);
711 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR)
713 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
714 Jim_PrintErrorMessage(interp);
718 register_command(context, NULL, "sleep", handle_sleep_command,
719 COMMAND_ANY, "<n> [busy] - sleep for n milliseconds. \"busy\" means busy wait");
721 register_command(context, NULL, "fast", handle_fast_command,
722 COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
727 int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
730 return ERROR_INVALID_ARGUMENTS;
732 cmd_ctx->mode = mode;
736 /* sleep command sleeps for <n> miliseconds
737 * this is useful in target startup scripts
739 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
741 unsigned long duration = 0;
749 if (strcmp(args[1], "busy")!=0)
750 return ERROR_COMMAND_SYNTAX_ERROR;
754 return ERROR_COMMAND_SYNTAX_ERROR;
757 duration = strtoul(args[0], NULL, 0);
761 busy_sleep(duration);
764 long long then=timeval_ms();
765 while ((timeval_ms()-then)<duration)
767 target_call_timer_callbacks_now();
775 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
778 return ERROR_COMMAND_SYNTAX_ERROR;
780 fast_and_dangerous = strcmp("enable", args[0])==0;
785 void process_jim_events(void)
788 static int recursion = 0;
793 Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT);
799 void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
801 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
803 /* FIX!!! it would be prettier to invoke add_help_text...
804 accumulate help text in Tcl helptext list. */
805 Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
806 if (Jim_IsShared(helptext))
807 helptext = Jim_DuplicateObj(interp, helptext);
809 Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
811 Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
812 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
814 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
815 Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
816 Jim_ListAppendElement(interp, helptext, cmd_entry);
820 /* return global variable long value or 0 upon failure */
821 long jim_global_long(const char *variable)
823 Jim_Obj *objPtr=Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
825 if (Jim_GetLong(interp, objPtr, &t)==JIM_OK)