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 int fast_and_dangerous
= 0;
48 Jim_Interp
*interp
= NULL
;
50 int handle_sleep_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
51 int handle_fast_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
53 int run_command(command_context_t
*context
, command_t
*c
, char *words
[], int num_words
);
55 static void tcl_output(void *privData
, const char *file
, int line
, const char *function
, const char *string
)
57 Jim_Obj
*tclOutput
=(Jim_Obj
*)privData
;
59 Jim_AppendString(interp
, tclOutput
, string
, strlen(string
));
62 extern command_context_t
*global_cmd_ctx
;
64 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
66 /* the private data is stashed in the interp structure */
68 command_context_t
*context
;
74 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
75 * get overwritten by running other Jim commands! Treat it as an
76 * emphemeral global variable that is used in lieu of an argument
77 * to the fn and fish it out manually.
79 c
= interp
->cmdPrivData
;
82 LOG_ERROR("BUG: interp->cmdPrivData==NULL");
85 target_call_timer_callbacks_now();
86 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
88 LOG_DEBUG("script_command - %s", c
->name
);
90 words
= malloc(sizeof(char *) * argc
);
91 for (i
= 0; i
< argc
; i
++)
94 const char *w
=Jim_GetString(argv
[i
], &len
);
97 /* hit an end of line comment */
100 words
[i
] = strdup(w
);
101 if (words
[i
] == NULL
)
105 LOG_DEBUG("script_command - %s, argv[%u]=%s", c
->name
, i
, words
[i
]);
109 /* grab the command context from the associated data */
110 context
= Jim_GetAssocData(interp
, "context");
113 /* Tcl can invoke commands directly instead of via command_run_line(). This would
114 * happen when the Jim Tcl interpreter is provided by eCos.
116 context
= global_cmd_ctx
;
119 /* capture log output and return it */
120 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
121 /* a garbage collect can happen, so we need a reference count to this object */
122 Jim_IncrRefCount(tclOutput
);
124 log_add_callback(tcl_output
, tclOutput
);
126 retval
= run_command(context
, c
, words
, nwords
);
128 log_remove_callback(tcl_output
, tclOutput
);
130 /* We dump output into this local variable */
131 Jim_SetResult(interp
, tclOutput
);
132 Jim_DecrRefCount(interp
, tclOutput
);
134 for (i
= 0; i
< nwords
; i
++)
138 int *return_retval
= Jim_GetAssocData(interp
, "retval");
139 if (return_retval
!= NULL
)
141 *return_retval
= retval
;
144 return (retval
==ERROR_OK
)?JIM_OK
:JIM_ERR
;
147 /* nice short description of source file */
148 #define __THIS__FILE__ "command.c"
150 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
)
154 if (!context
|| !name
)
157 c
= malloc(sizeof(command_t
));
159 c
->name
= strdup(name
);
162 c
->handler
= handler
;
168 /* place command in tree */
171 if (parent
->children
)
173 /* find last child */
174 for (p
= parent
->children
; p
&& p
->next
; p
= p
->next
);
180 parent
->children
= c
;
185 if (context
->commands
)
187 /* find last command */
188 for (p
= context
->commands
; p
&& p
->next
; p
= p
->next
);
194 context
->commands
= c
;
198 /* just a placeholder, no handler */
199 if (c
->handler
==NULL
)
202 /* If this is a two level command, e.g. "flash banks", then the
203 * "unknown" proc in startup.tcl must redirect to this command.
205 * "flash banks" is translated by "unknown" to "flash_banks"
206 * if such a proc exists
208 /* Print help for command */
212 /* maximum of two levels :-) */
219 const char *full_name
=alloc_printf("ocd_%s%s%s", t1
, t2
, t3
);
220 Jim_CreateCommand(interp
, full_name
, script_command
, c
, NULL
);
221 free((void *)full_name
);
223 /* we now need to add an overrideable proc */
224 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
);
225 Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
226 free((void *)override_name
);
228 /* accumulate help text in Tcl helptext list. */
229 Jim_Obj
*helptext
=Jim_GetGlobalVariableStr(interp
, "ocd_helptext", JIM_ERRMSG
);
230 if (Jim_IsShared(helptext
))
231 helptext
= Jim_DuplicateObj(interp
, helptext
);
232 Jim_Obj
*cmd_entry
=Jim_NewListObj(interp
, NULL
, 0);
234 Jim_Obj
*cmd_list
=Jim_NewListObj(interp
, NULL
, 0);
236 /* maximum of two levels :-) */
239 Jim_ListAppendElement(interp
, cmd_list
, Jim_NewStringObj(interp
, c
->parent
->name
, -1));
241 Jim_ListAppendElement(interp
, cmd_list
, Jim_NewStringObj(interp
, c
->name
, -1));
243 Jim_ListAppendElement(interp
, cmd_entry
, cmd_list
);
244 Jim_ListAppendElement(interp
, cmd_entry
, Jim_NewStringObj(interp
, help
, -1));
245 Jim_ListAppendElement(interp
, helptext
, cmd_entry
);
249 int unregister_all_commands(command_context_t
*context
)
256 while(NULL
!= context
->commands
)
258 c
= context
->commands
;
260 while(NULL
!= c
->children
)
263 c
->children
= c
->children
->next
;
270 context
->commands
= context
->commands
->next
;
281 int unregister_command(command_context_t
*context
, char *name
)
283 command_t
*c
, *p
= NULL
, *c2
;
285 if ((!context
) || (!name
))
286 return ERROR_INVALID_ARGUMENTS
;
289 c
= context
->commands
;
293 if (strcmp(name
, c
->name
) == 0)
302 /* first element in command list */
303 context
->commands
= c
->next
;
306 /* unregister children */
307 while(NULL
!= c
->children
)
310 c
->children
= c
->children
->next
;
325 /* remember the last command for unlinking */
333 void command_output_text(command_context_t
*context
, const char *data
)
335 if( context
&& context
->output_handler
&& data
){
336 context
->output_handler( context
, data
);
340 void command_print_sameline(command_context_t
*context
, const char *format
, ...)
345 va_start(ap
, format
);
347 string
= alloc_vprintf(format
, ap
);
350 /* we want this collected in the log + we also want to pick it up as a tcl return
353 * The latter bit isn't precisely neat, but will do for now.
355 LOG_USER_N("%s", string
);
356 /* We already printed it above */
357 /* command_output_text(context, string); */
364 void command_print(command_context_t
*context
, const char *format
, ...)
369 va_start(ap
, format
);
371 string
= alloc_vprintf(format
, ap
);
374 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
375 /* we want this collected in the log + we also want to pick it up as a tcl return
378 * The latter bit isn't precisely neat, but will do for now.
380 LOG_USER_N("%s", string
);
381 /* We already printed it above */
382 /* command_output_text(context, string); */
389 int run_command(command_context_t
*context
, command_t
*c
, char *words
[], int num_words
)
392 if (!((context
->mode
== COMMAND_CONFIG
) || (c
->mode
== COMMAND_ANY
) || (c
->mode
== context
->mode
) ))
394 /* Config commands can not run after the config stage */
395 LOG_ERROR("Command '%s' only runs during configuration stage", c
->name
);
399 int retval
= c
->handler(context
, c
->name
, words
+ start_word
+ 1, num_words
- start_word
- 1);
400 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
402 /* Print help for command */
406 /* maximum of two levels :-) */
413 command_run_linef(context
, "help {%s%s%s}", t1
, t2
, t3
);
415 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
417 /* just fall through for a shutdown request */
419 else if (retval
!= ERROR_OK
)
421 /* we do not print out an error message because the command *should*
422 * have printed out an error
424 LOG_DEBUG("Command failed with error code %d", retval
);
430 int command_run_line(command_context_t
*context
, char *line
)
432 /* all the parent commands have been registered with the interpreter
433 * so, can just evaluate the line as a script and check for
436 /* run the line thru a script engine */
437 int retval
=ERROR_FAIL
;
439 /* Beware! This code needs to be reentrant. It is also possible
440 * for OpenOCD commands to be invoked directly from Tcl. This would
441 * happen when the Jim Tcl interpreter is provided by eCos for
444 Jim_DeleteAssocData(interp
, "context");
445 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
446 if (retcode
== JIM_OK
)
448 /* associated the return value */
449 Jim_DeleteAssocData(interp
, "retval");
450 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
451 if (retcode
== JIM_OK
)
453 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
455 Jim_DeleteAssocData(interp
, "retval");
457 Jim_DeleteAssocData(interp
, "context");
459 if (retcode
== JIM_ERR
) {
460 if (retval
!=ERROR_COMMAND_CLOSE_CONNECTION
)
462 /* We do not print the connection closed error message */
463 Jim_PrintErrorMessage(interp
);
465 if (retval
==ERROR_OK
)
467 /* It wasn't a low level OpenOCD command that failed */
471 } else if (retcode
== JIM_EXIT
) {
473 /* exit(Jim_GetExitCode(interp)); */
478 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
483 for (i
= 0; i
< reslen
; i
+= 256)
489 strncpy(buff
, result
+i
, chunk
);
491 LOG_USER_N("%s", buff
);
493 LOG_USER_N("%s", "\n");
500 int command_run_linef(command_context_t
*context
, const char *format
, ...)
502 int retval
=ERROR_FAIL
;
505 va_start(ap
, format
);
506 string
= alloc_vprintf(format
, ap
);
509 retval
=command_run_line(context
, string
);
515 void command_set_output_handler(command_context_t
* context
, int (*output_handler
)(struct command_context_s
*context
, const char* line
), void *priv
)
517 context
->output_handler
= output_handler
;
518 context
->output_handler_priv
= priv
;
521 command_context_t
* copy_command_context(command_context_t
* context
)
523 command_context_t
* copy_context
= malloc(sizeof(command_context_t
));
525 *copy_context
= *context
;
530 int command_done(command_context_t
*context
)
538 /* find full path to file */
539 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
543 const char *file
= Jim_GetString(argv
[1], NULL
);
544 char *full_path
= find_file(file
);
545 if (full_path
== NULL
)
547 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
550 Jim_SetResult(interp
, result
);
554 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
558 const char *str
= Jim_GetString(argv
[1], NULL
);
563 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
569 /* make it a char easier to read code */
573 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
577 /* do we have to chunk it? */
578 if (ptr
[nbytes
] == 0)
580 /* no it is a C style string */
581 LOG_USER_N("%s", ptr
);
584 /* GRR we must chunk - not null terminated */
594 memcpy(chunk
, ptr
, x
);
598 LOG_USER_N("%s", chunk
);
606 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
608 /* TCL wants to read... tell him no */
612 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
623 cp
= alloc_vprintf(fmt
, ap
);
626 LOG_USER_N("%s", cp
);
633 static int openocd_jim_fflush(void *cookie
)
635 /* nothing to flush */
639 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
646 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
651 const char *str
= Jim_GetString(argv
[1], NULL
);
653 /* capture log output and return it */
654 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
655 /* a garbage collect can happen, so we need a reference count to this object */
656 Jim_IncrRefCount(tclOutput
);
658 log_add_callback(tcl_output
, tclOutput
);
660 retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
662 log_remove_callback(tcl_output
, tclOutput
);
664 /* We dump output into this local variable */
665 Jim_SetResult(interp
, tclOutput
);
666 Jim_DecrRefCount(interp
, tclOutput
);
671 command_context_t
* command_init()
673 command_context_t
* context
= malloc(sizeof(command_context_t
));
674 extern const char startup_tcl
[];
677 context
->mode
= COMMAND_EXEC
;
678 context
->commands
= NULL
;
679 context
->current_target
= 0;
680 context
->output_handler
= NULL
;
681 context
->output_handler_priv
= NULL
;
685 /* Create an interpreter */
686 interp
= Jim_CreateInterp();
687 /* Add all the Jim core commands */
688 Jim_RegisterCoreCommands(interp
);
691 #if defined( _MSC_VER )
692 /* WinXX - is generic, the forward
693 * looking problem is this:
697 * "winxx" is generic.
700 #elif defined( __LINUX__)
702 #elif defined( __DARWIN__ )
704 #elif defined( __CYGWIN__ )
706 #elif defined( __MINGW32__ )
711 Jim_SetGlobalVariableStr( interp
, "ocd_HOSTOS", Jim_NewStringObj( interp
, HostOs
, strlen(HostOs
)) );
713 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
714 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
715 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
717 /* Set Jim's STDIO */
718 interp
->cookie_stdin
= interp
;
719 interp
->cookie_stdout
= interp
;
720 interp
->cookie_stderr
= interp
;
721 interp
->cb_fwrite
= openocd_jim_fwrite
;
722 interp
->cb_fread
= openocd_jim_fread
;
723 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
724 interp
->cb_fflush
= openocd_jim_fflush
;
725 interp
->cb_fgets
= openocd_jim_fgets
;
730 Jim_EventLoopOnLoad(interp
);
732 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1)==JIM_ERR
)
734 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
735 Jim_PrintErrorMessage(interp
);
739 register_command(context
, NULL
, "sleep", handle_sleep_command
,
740 COMMAND_ANY
, "<n> [busy] - sleep for n milliseconds. \"busy\" means busy wait");
742 register_command(context
, NULL
, "fast", handle_fast_command
,
743 COMMAND_ANY
, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
748 int command_context_mode(command_context_t
*cmd_ctx
, enum command_mode mode
)
751 return ERROR_INVALID_ARGUMENTS
;
753 cmd_ctx
->mode
= mode
;
757 /* sleep command sleeps for <n> miliseconds
758 * this is useful in target startup scripts
760 int handle_sleep_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
762 unsigned long duration
= 0;
770 if (strcmp(args
[1], "busy")!=0)
771 return ERROR_COMMAND_SYNTAX_ERROR
;
775 return ERROR_COMMAND_SYNTAX_ERROR
;
778 duration
= strtoul(args
[0], NULL
, 0);
782 busy_sleep(duration
);
785 long long then
=timeval_ms();
786 while ((timeval_ms()-then
)<(long long)duration
)
788 target_call_timer_callbacks_now();
796 int handle_fast_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
799 return ERROR_COMMAND_SYNTAX_ERROR
;
801 fast_and_dangerous
= strcmp("enable", args
[0])==0;
806 void process_jim_events(void)
809 static int recursion
= 0;
814 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
|JIM_DONT_WAIT
);
820 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
)
822 Jim_CreateCommand(interp
, name
, cmd
, NULL
, NULL
);
824 /* FIX!!! it would be prettier to invoke add_help_text...
825 * accumulate help text in Tcl helptext list. */
826 Jim_Obj
*helptext
=Jim_GetGlobalVariableStr(interp
, "ocd_helptext", JIM_ERRMSG
);
827 if (Jim_IsShared(helptext
))
828 helptext
= Jim_DuplicateObj(interp
, helptext
);
830 Jim_Obj
*cmd_entry
=Jim_NewListObj(interp
, NULL
, 0);
832 Jim_Obj
*cmd_list
=Jim_NewListObj(interp
, NULL
, 0);
833 Jim_ListAppendElement(interp
, cmd_list
, Jim_NewStringObj(interp
, name
, -1));
835 Jim_ListAppendElement(interp
, cmd_entry
, cmd_list
);
836 Jim_ListAppendElement(interp
, cmd_entry
, Jim_NewStringObj(interp
, help
, -1));
837 Jim_ListAppendElement(interp
, helptext
, cmd_entry
);
840 /* return global variable long value or 0 upon failure */
841 long jim_global_long(const char *variable
)
843 Jim_Obj
*objPtr
=Jim_GetGlobalVariableStr(interp
, variable
, JIM_ERRMSG
);
845 if (Jim_GetLong(interp
, objPtr
, &t
)==JIM_OK
)
852 int parse_ullong(const char *str
, unsigned long long *ul
)
855 *ul
= strtoull(str
, &end
, 0);
856 bool okay
= *str
&& !*end
&& ULLONG_MAX
!= *ul
;
857 return okay
? ERROR_OK
: ERROR_COMMAND_SYNTAX_ERROR
;
859 int parse_ulong(const char *str
, unsigned long *ul
)
862 *ul
= strtoul(str
, &end
, 0);
863 bool okay
= *str
&& !*end
&& ULONG_MAX
!= *ul
;
864 return okay
? ERROR_OK
: ERROR_COMMAND_SYNTAX_ERROR
;
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)