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 for (c
= context
->commands
; c
; c
= c
->next
)
294 if (strcmp(name
, c
->name
) == 0)
303 context
->commands
= c
->next
;
306 /* unregister children */
309 for (c2
= c
->children
; c2
; c2
= c2
->next
)
321 /* 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
);
477 for (i
= 0; i
< reslen
; i
+= 256)
483 strncpy(buff
, result
+i
, chunk
);
485 LOG_USER_N("%s", buff
);
487 LOG_USER_N("%s", "\n");
493 int command_run_linef(command_context_t
*context
, char *format
, ...)
495 int retval
=ERROR_FAIL
;
498 va_start(ap
, format
);
499 string
= alloc_vprintf(format
, ap
);
502 retval
=command_run_line(context
, string
);
508 void command_set_output_handler(command_context_t
* context
, int (*output_handler
)(struct command_context_s
*context
, const char* line
), void *priv
)
510 context
->output_handler
= output_handler
;
511 context
->output_handler_priv
= priv
;
514 command_context_t
* copy_command_context(command_context_t
* context
)
516 command_context_t
* copy_context
= malloc(sizeof(command_context_t
));
518 *copy_context
= *context
;
523 int command_done(command_context_t
*context
)
531 /* find full path to file */
532 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
536 const char *file
= Jim_GetString(argv
[1], NULL
);
537 char *full_path
= find_file(file
);
538 if (full_path
== NULL
)
540 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
543 Jim_SetResult(interp
, result
);
547 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
551 const char *str
= Jim_GetString(argv
[1], NULL
);
556 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
562 /* make it a char easier to read code */
566 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
570 /* do we have to chunk it? */
571 if (ptr
[nbytes
] == 0)
573 /* no it is a C style string */
574 LOG_USER_N("%s", ptr
);
577 /* GRR we must chunk - not null terminated */
587 memcpy(chunk
, ptr
, x
);
591 LOG_USER_N("%s", chunk
);
599 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
601 /* TCL wants to read... tell him no */
605 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
616 cp
= alloc_vprintf(fmt
, ap
);
619 LOG_USER_N("%s", cp
);
626 static int openocd_jim_fflush(void *cookie
)
628 /* nothing to flush */
632 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
640 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
645 const char *str
= Jim_GetString(argv
[1], NULL
);
647 /* capture log output and return it */
648 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
649 /* a garbage collect can happen, so we need a reference count to this object */
650 Jim_IncrRefCount(tclOutput
);
652 log_add_callback(tcl_output
, tclOutput
);
654 retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
656 log_remove_callback(tcl_output
, tclOutput
);
658 /* We dump output into this local variable */
659 Jim_SetResult(interp
, tclOutput
);
660 Jim_DecrRefCount(interp
, tclOutput
);
665 command_context_t
* command_init()
667 command_context_t
* context
= malloc(sizeof(command_context_t
));
668 extern const char startup_tcl
[];
670 context
->mode
= COMMAND_EXEC
;
671 context
->commands
= NULL
;
672 context
->current_target
= 0;
673 context
->output_handler
= NULL
;
674 context
->output_handler_priv
= NULL
;
678 /* Create an interpreter */
679 interp
= Jim_CreateInterp();
680 /* Add all the Jim core commands */
681 Jim_RegisterCoreCommands(interp
);
684 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
685 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
686 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
688 /* Set Jim's STDIO */
689 interp
->cookie_stdin
= interp
;
690 interp
->cookie_stdout
= interp
;
691 interp
->cookie_stderr
= interp
;
692 interp
->cb_fwrite
= openocd_jim_fwrite
;
693 interp
->cb_fread
= openocd_jim_fread
;
694 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
695 interp
->cb_fflush
= openocd_jim_fflush
;
696 interp
->cb_fgets
= openocd_jim_fgets
;
701 Jim_EventLoopOnLoad(interp
);
703 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1)==JIM_ERR
)
705 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
706 Jim_PrintErrorMessage(interp
);
710 register_command(context
, NULL
, "sleep", handle_sleep_command
,
711 COMMAND_ANY
, "<n> [busy] - sleep for n milliseconds. \"busy\" means busy wait");
713 register_command(context
, NULL
, "fast", handle_fast_command
,
714 COMMAND_ANY
, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
719 int command_context_mode(command_context_t
*cmd_ctx
, enum command_mode mode
)
722 return ERROR_INVALID_ARGUMENTS
;
724 cmd_ctx
->mode
= mode
;
728 /* sleep command sleeps for <n> miliseconds
729 * this is useful in target startup scripts
731 int handle_sleep_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
733 unsigned long duration
= 0;
741 if (strcmp(args
[1], "busy")!=0)
742 return ERROR_COMMAND_SYNTAX_ERROR
;
746 return ERROR_COMMAND_SYNTAX_ERROR
;
749 duration
= strtoul(args
[0], NULL
, 0);
753 busy_sleep(duration
);
756 long long then
=timeval_ms();
757 while ((timeval_ms()-then
)<duration
)
759 target_call_timer_callbacks_now();
767 int handle_fast_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
770 return ERROR_COMMAND_SYNTAX_ERROR
;
772 fast_and_dangerous
= strcmp("enable", args
[0])==0;
777 void process_jim_events(void)
780 static int recursion
= 0;
785 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
|JIM_DONT_WAIT
);
791 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
)
793 Jim_CreateCommand(interp
, name
, cmd
, NULL
, NULL
);
795 /* FIX!!! it would be prettier to invoke add_help_text...
796 accumulate help text in Tcl helptext list. */
797 Jim_Obj
*helptext
=Jim_GetGlobalVariableStr(interp
, "ocd_helptext", JIM_ERRMSG
);
798 if (Jim_IsShared(helptext
))
799 helptext
= Jim_DuplicateObj(interp
, helptext
);
801 Jim_Obj
*cmd_entry
=Jim_NewListObj(interp
, NULL
, 0);
803 Jim_Obj
*cmd_list
=Jim_NewListObj(interp
, NULL
, 0);
804 Jim_ListAppendElement(interp
, cmd_list
, Jim_NewStringObj(interp
, name
, -1));
806 Jim_ListAppendElement(interp
, cmd_entry
, cmd_list
);
807 Jim_ListAppendElement(interp
, cmd_entry
, Jim_NewStringObj(interp
, help
, -1));
808 Jim_ListAppendElement(interp
, helptext
, cmd_entry
);
812 /* return global variable long value or 0 upon failure */
813 long jim_global_long(const char *variable
)
815 Jim_Obj
*objPtr
=Jim_GetGlobalVariableStr(interp
, variable
, JIM_ERRMSG
);
817 if (Jim_GetLong(interp
, objPtr
, &t
)==JIM_OK
)
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)