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 // @todo the inclusion of target.h here is a layering violation
36 #include "configuration.h"
38 #include "time_support.h"
39 #include "jim-eventloop.h"
42 int fast_and_dangerous = 0;
43 Jim_Interp *interp = NULL;
45 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
46 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48 int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
50 static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
52 Jim_Obj *tclOutput=(Jim_Obj *)privData;
54 Jim_AppendString(interp, tclOutput, string, strlen(string));
57 extern command_context_t *global_cmd_ctx;
59 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
61 /* the private data is stashed in the interp structure */
63 command_context_t *context;
69 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
70 * get overwritten by running other Jim commands! Treat it as an
71 * emphemeral global variable that is used in lieu of an argument
72 * to the fn and fish it out manually.
74 c = interp->cmdPrivData;
77 LOG_ERROR("BUG: interp->cmdPrivData==NULL");
80 target_call_timer_callbacks_now();
81 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
83 LOG_DEBUG("script_command - %s", c->name);
85 words = malloc(sizeof(char *) * argc);
86 for (i = 0; i < argc; i++)
89 const char *w=Jim_GetString(argv[i], &len);
92 /* hit an end of line comment */
100 LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
104 /* grab the command context from the associated data */
105 context = Jim_GetAssocData(interp, "context");
108 /* Tcl can invoke commands directly instead of via command_run_line(). This would
109 * happen when the Jim Tcl interpreter is provided by eCos.
111 context = global_cmd_ctx;
114 /* capture log output and return it */
115 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
116 /* a garbage collect can happen, so we need a reference count to this object */
117 Jim_IncrRefCount(tclOutput);
119 log_add_callback(tcl_output, tclOutput);
121 retval = run_command(context, c, words, nwords);
123 log_remove_callback(tcl_output, tclOutput);
125 /* We dump output into this local variable */
126 Jim_SetResult(interp, tclOutput);
127 Jim_DecrRefCount(interp, tclOutput);
129 for (i = 0; i < nwords; i++)
133 int *return_retval = Jim_GetAssocData(interp, "retval");
134 if (return_retval != NULL)
136 *return_retval = retval;
139 return (retval==ERROR_OK)?JIM_OK:JIM_ERR;
142 /* nice short description of source file */
143 #define __THIS__FILE__ "command.c"
145 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)
149 if (!context || !name)
152 c = malloc(sizeof(command_t));
154 c->name = strdup(name);
157 c->handler = handler;
163 /* place command in tree */
166 if (parent->children)
168 /* find last child */
169 for (p = parent->children; p && p->next; p = p->next);
175 parent->children = c;
180 if (context->commands)
182 /* find last command */
183 for (p = context->commands; p && p->next; p = p->next);
189 context->commands = c;
193 /* just a placeholder, no handler */
194 if (c->handler==NULL)
197 /* If this is a two level command, e.g. "flash banks", then the
198 * "unknown" proc in startup.tcl must redirect to this command.
200 * "flash banks" is translated by "unknown" to "flash_banks"
201 * if such a proc exists
203 /* Print help for command */
207 /* maximum of two levels :-) */
214 const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3);
215 Jim_CreateCommand(interp, full_name, script_command, c, NULL);
216 free((void *)full_name);
218 /* we now need to add an overrideable proc */
219 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);
220 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__ );
221 free((void *)override_name);
223 /* accumulate help text in Tcl helptext list. */
224 Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
225 if (Jim_IsShared(helptext))
226 helptext = Jim_DuplicateObj(interp, helptext);
227 Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
229 Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
231 /* maximum of two levels :-) */
234 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
236 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
238 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
239 Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
240 Jim_ListAppendElement(interp, helptext, cmd_entry);
244 int unregister_all_commands(command_context_t *context)
251 while(NULL != context->commands)
253 c = context->commands;
255 while(NULL != c->children)
258 c->children = c->children->next;
265 context->commands = context->commands->next;
276 int unregister_command(command_context_t *context, char *name)
278 command_t *c, *p = NULL, *c2;
280 if ((!context) || (!name))
281 return ERROR_INVALID_ARGUMENTS;
284 c = context->commands;
288 if (strcmp(name, c->name) == 0)
297 /* first element in command list */
298 context->commands = c->next;
301 /* unregister children */
302 while(NULL != c->children)
305 c->children = c->children->next;
320 /* remember the last command for unlinking */
328 void command_output_text(command_context_t *context, const char *data)
330 if( context && context->output_handler && data ){
331 context->output_handler( context, data );
335 void command_print_n(command_context_t *context, char *format, ...)
340 va_start(ap, format);
342 string = alloc_vprintf(format, ap);
345 /* we want this collected in the log + we also want to pick it up as a tcl return
348 * The latter bit isn't precisely neat, but will do for now.
350 LOG_USER_N("%s", string);
351 /* We already printed it above */
352 /* command_output_text(context, string); */
359 void command_print(command_context_t *context, char *format, ...)
364 va_start(ap, format);
366 string = alloc_vprintf(format, ap);
369 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
370 /* we want this collected in the log + we also want to pick it up as a tcl return
373 * The latter bit isn't precisely neat, but will do for now.
375 LOG_USER_N("%s", string);
376 /* We already printed it above */
377 /* command_output_text(context, string); */
384 int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
387 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
389 /* Config commands can not run after the config stage */
390 LOG_ERROR("Illegal mode for command");
394 int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
395 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
397 /* Print help for command */
401 /* maximum of two levels :-) */
408 command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
410 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
412 /* just fall through for a shutdown request */
414 else if (retval != ERROR_OK)
416 /* we do not print out an error message because the command *should*
417 * have printed out an error
419 LOG_DEBUG("Command failed with error code %d", retval);
425 int command_run_line(command_context_t *context, char *line)
427 /* all the parent commands have been registered with the interpreter
428 * so, can just evaluate the line as a script and check for
431 /* run the line thru a script engine */
432 int retval=ERROR_FAIL;
434 /* Beware! This code needs to be reentrant. It is also possible
435 * for OpenOCD commands to be invoked directly from Tcl. This would
436 * happen when the Jim Tcl interpreter is provided by eCos for
439 Jim_DeleteAssocData(interp, "context");
440 retcode = Jim_SetAssocData(interp, "context", NULL, context);
441 if (retcode == JIM_OK)
443 /* associated the return value */
444 Jim_DeleteAssocData(interp, "retval");
445 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
446 if (retcode == JIM_OK)
448 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ );
450 Jim_DeleteAssocData(interp, "retval");
452 Jim_DeleteAssocData(interp, "context");
454 if (retcode == JIM_ERR) {
455 if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
457 /* We do not print the connection closed error message */
458 Jim_PrintErrorMessage(interp);
460 if (retval==ERROR_OK)
462 /* It wasn't a low level OpenOCD command that failed */
466 } else if (retcode == JIM_EXIT) {
468 /* exit(Jim_GetExitCode(interp)); */
473 result = Jim_GetString(Jim_GetResult(interp), &reslen);
478 for (i = 0; i < reslen; i += 256)
484 strncpy(buff, result+i, chunk);
486 LOG_USER_N("%s", buff);
488 LOG_USER_N("%s", "\n");
495 int command_run_linef(command_context_t *context, char *format, ...)
497 int retval=ERROR_FAIL;
500 va_start(ap, format);
501 string = alloc_vprintf(format, ap);
504 retval=command_run_line(context, string);
510 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
512 context->output_handler = output_handler;
513 context->output_handler_priv = priv;
516 command_context_t* copy_command_context(command_context_t* context)
518 command_context_t* copy_context = malloc(sizeof(command_context_t));
520 *copy_context = *context;
525 int command_done(command_context_t *context)
533 /* find full path to file */
534 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
538 const char *file = Jim_GetString(argv[1], NULL);
539 char *full_path = find_file(file);
540 if (full_path == NULL)
542 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
545 Jim_SetResult(interp, result);
549 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
553 const char *str = Jim_GetString(argv[1], NULL);
558 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
564 /* make it a char easier to read code */
568 if (ptr == NULL || interp == NULL || nbytes == 0) {
572 /* do we have to chunk it? */
573 if (ptr[nbytes] == 0)
575 /* no it is a C style string */
576 LOG_USER_N("%s", ptr);
579 /* GRR we must chunk - not null terminated */
589 memcpy(chunk, ptr, x);
593 LOG_USER_N("%s", chunk);
601 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
603 /* TCL wants to read... tell him no */
607 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
618 cp = alloc_vprintf(fmt, ap);
621 LOG_USER_N("%s", cp);
628 static int openocd_jim_fflush(void *cookie)
630 /* nothing to flush */
634 static char* openocd_jim_fgets(char *s, int size, void *cookie)
641 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
646 const char *str = Jim_GetString(argv[1], NULL);
648 /* capture log output and return it */
649 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
650 /* a garbage collect can happen, so we need a reference count to this object */
651 Jim_IncrRefCount(tclOutput);
653 log_add_callback(tcl_output, tclOutput);
655 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__ );
657 log_remove_callback(tcl_output, tclOutput);
659 /* We dump output into this local variable */
660 Jim_SetResult(interp, tclOutput);
661 Jim_DecrRefCount(interp, tclOutput);
666 command_context_t* command_init()
668 command_context_t* context = malloc(sizeof(command_context_t));
669 extern const char startup_tcl[];
672 context->mode = COMMAND_EXEC;
673 context->commands = NULL;
674 context->current_target = 0;
675 context->output_handler = NULL;
676 context->output_handler_priv = NULL;
680 /* Create an interpreter */
681 interp = Jim_CreateInterp();
682 /* Add all the Jim core commands */
683 Jim_RegisterCoreCommands(interp);
686 #if defined( _MSC_VER )
687 /* WinXX - is generic, the forward
688 * looking problem is this:
692 * "winxx" is generic.
695 #elif defined( __LINUX__)
697 #elif defined( __DARWIN__ )
699 #elif defined( __CYGWIN__ )
701 #elif defined( __MINGW32__ )
706 Jim_SetGlobalVariableStr( interp, "ocd_HOSTOS", Jim_NewStringObj( interp, HostOs , strlen(HostOs)) );
708 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
709 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
710 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
712 /* Set Jim's STDIO */
713 interp->cookie_stdin = interp;
714 interp->cookie_stdout = interp;
715 interp->cookie_stderr = interp;
716 interp->cb_fwrite = openocd_jim_fwrite;
717 interp->cb_fread = openocd_jim_fread ;
718 interp->cb_vfprintf = openocd_jim_vfprintf;
719 interp->cb_fflush = openocd_jim_fflush;
720 interp->cb_fgets = openocd_jim_fgets;
725 Jim_EventLoopOnLoad(interp);
727 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR)
729 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
730 Jim_PrintErrorMessage(interp);
734 register_command(context, NULL, "sleep", handle_sleep_command,
735 COMMAND_ANY, "<n> [busy] - sleep for n milliseconds. \"busy\" means busy wait");
737 register_command(context, NULL, "fast", handle_fast_command,
738 COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
743 int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
746 return ERROR_INVALID_ARGUMENTS;
748 cmd_ctx->mode = mode;
752 /* sleep command sleeps for <n> miliseconds
753 * this is useful in target startup scripts
755 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
757 unsigned long duration = 0;
765 if (strcmp(args[1], "busy")!=0)
766 return ERROR_COMMAND_SYNTAX_ERROR;
770 return ERROR_COMMAND_SYNTAX_ERROR;
773 duration = strtoul(args[0], NULL, 0);
777 busy_sleep(duration);
780 long long then=timeval_ms();
781 while ((timeval_ms()-then)<(long long)duration)
783 target_call_timer_callbacks_now();
791 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
794 return ERROR_COMMAND_SYNTAX_ERROR;
796 fast_and_dangerous = strcmp("enable", args[0])==0;
801 void process_jim_events(void)
804 static int recursion = 0;
809 Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT);
815 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)
817 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
819 /* FIX!!! it would be prettier to invoke add_help_text...
820 * accumulate help text in Tcl helptext list. */
821 Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
822 if (Jim_IsShared(helptext))
823 helptext = Jim_DuplicateObj(interp, helptext);
825 Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
827 Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
828 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
830 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
831 Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
832 Jim_ListAppendElement(interp, helptext, cmd_entry);
835 /* return global variable long value or 0 upon failure */
836 long jim_global_long(const char *variable)
838 Jim_Obj *objPtr=Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
840 if (Jim_GetLong(interp, objPtr, &t)==JIM_OK)