1 // SPDX-License-Identifier: GPL-2.0-or-later
3 /***************************************************************************
4 * Copyright (C) 2005 by Dominic Rath *
5 * Dominic.Rath@gmx.de *
7 * Copyright (C) 2007,2008 Øyvind Harboe *
8 * oyvind.harboe@zylin.com *
10 * Copyright (C) 2008, Duane Ellis *
11 * openocd@duaneeellis.com *
13 * part of this file is taken from libcli (libcli.sourceforge.net) *
14 * Copyright (C) David Parrish (david@dparrish.com) *
15 ***************************************************************************/
21 /* @todo the inclusion of target.h here is a layering violation */
22 #include <jtag/jtag.h>
23 #include <target/target.h>
25 #include "configuration.h"
27 #include "time_support.h"
28 #include "jim-eventloop.h"
30 /* nice short description of source file */
31 #define __THIS__FILE__ "command.c"
33 struct log_capture_state
{
38 static int unregister_command(struct command_context
*context
,
39 const char *cmd_prefix
, const char *name
);
40 static int jim_command_dispatch(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
);
41 static int help_add_command(struct command_context
*cmd_ctx
,
42 const char *cmd_name
, const char *help_text
, const char *usage_text
);
43 static int help_del_command(struct command_context
*cmd_ctx
, const char *cmd_name
);
45 /* set of functions to wrap jimtcl internal data */
46 static inline bool jimcmd_is_proc(Jim_Cmd
*cmd
)
51 bool jimcmd_is_oocd_command(Jim_Cmd
*cmd
)
53 return !cmd
->isproc
&& cmd
->u
.native
.cmdProc
== jim_command_dispatch
;
56 void *jimcmd_privdata(Jim_Cmd
*cmd
)
58 return cmd
->isproc
? NULL
: cmd
->u
.native
.privData
;
61 static void tcl_output(void *privData
, const char *file
, unsigned line
,
62 const char *function
, const char *string
)
64 struct log_capture_state
*state
= privData
;
65 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
68 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
70 /* capture log output and return it. A garbage collect can
71 * happen, so we need a reference count to this object */
72 Jim_Obj
*jim_output
= Jim_NewStringObj(interp
, "", 0);
76 Jim_IncrRefCount(jim_output
);
78 struct log_capture_state
*state
= malloc(sizeof(*state
));
80 LOG_ERROR("Out of memory");
81 Jim_DecrRefCount(interp
, jim_output
);
85 state
->interp
= interp
;
86 state
->output
= jim_output
;
88 log_add_callback(tcl_output
, state
);
93 /* Classic openocd commands provide progress output which we
94 * will capture and return as a Tcl return value.
96 * However, if a non-openocd command has been invoked, then it
97 * makes sense to return the tcl return value from that command.
99 * The tcl return value is empty for openocd commands that provide
102 * For other commands, we prepend the logs to the tcl return value.
104 static void command_log_capture_finish(struct log_capture_state
*state
)
109 log_remove_callback(tcl_output
, state
);
112 const char *log_result
= Jim_GetString(state
->output
, &loglen
);
114 const char *cmd_result
= Jim_GetString(Jim_GetResult(state
->interp
), &reslen
);
116 // Just in case the log doesn't end with a newline, we add it
117 if (loglen
!= 0 && reslen
!= 0 && log_result
[loglen
- 1] != '\n')
118 Jim_AppendString(state
->interp
, state
->output
, "\n", 1);
120 Jim_AppendString(state
->interp
, state
->output
, cmd_result
, reslen
);
122 Jim_SetResult(state
->interp
, state
->output
);
123 Jim_DecrRefCount(state
->interp
, state
->output
);
128 static int command_retval_set(Jim_Interp
*interp
, int retval
)
130 int *return_retval
= Jim_GetAssocData(interp
, "retval");
132 *return_retval
= retval
;
134 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
137 extern struct command_context
*global_cmd_ctx
;
139 /* dump a single line to the log for the command.
140 * Do nothing in case we are not at debug level 3 */
141 static void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
143 if (debug_level
< LOG_LVL_DEBUG
)
146 char *dbg
= alloc_printf("command -");
147 for (unsigned i
= 0; i
< argc
; i
++) {
148 const char *w
= Jim_GetString(argv
[i
], NULL
);
149 char *t
= alloc_printf("%s %s", dbg
, w
);
153 LOG_DEBUG("%s", dbg
);
157 static void script_command_args_free(char **words
, unsigned nwords
)
159 for (unsigned i
= 0; i
< nwords
; i
++)
164 static char **script_command_args_alloc(unsigned int argc
, Jim_Obj
* const *argv
)
166 char **words
= malloc(argc
* sizeof(char *));
170 for (unsigned int i
= 0; i
< argc
; i
++) {
171 const char *w
= Jim_GetString(argv
[i
], NULL
);
172 words
[i
] = strdup(w
);
174 script_command_args_free(words
, i
);
181 struct command_context
*current_command_context(Jim_Interp
*interp
)
183 /* grab the command context from the associated data */
184 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
186 /* Tcl can invoke commands directly instead of via command_run_line(). This would
187 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
188 * commands in a startup script.
190 * A telnet or gdb server would provide a non-default command context to
191 * handle piping of error output, have a separate current target, etc.
193 cmd_ctx
= global_cmd_ctx
;
199 * Find a openocd command from fullname.
200 * @returns Returns the named command if it is registred in interp.
201 * Returns NULL otherwise.
203 static struct command
*command_find_from_name(Jim_Interp
*interp
, const char *name
)
208 Jim_Obj
*jim_name
= Jim_NewStringObj(interp
, name
, -1);
209 Jim_IncrRefCount(jim_name
);
210 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, jim_name
, JIM_NONE
);
211 Jim_DecrRefCount(interp
, jim_name
);
212 if (!cmd
|| jimcmd_is_proc(cmd
) || !jimcmd_is_oocd_command(cmd
))
215 return jimcmd_privdata(cmd
);
218 static struct command
*command_new(struct command_context
*cmd_ctx
,
219 const char *full_name
, const struct command_registration
*cr
)
224 * If it is a non-jim command with no .usage specified,
227 * strlen(.usage) == 0 means that the command takes no
230 if (!cr
->jim_handler
&& !cr
->usage
)
231 LOG_ERROR("BUG: command '%s' does not have the "
232 "'.usage' field filled out",
235 struct command
*c
= calloc(1, sizeof(struct command
));
239 c
->name
= strdup(cr
->name
);
245 c
->handler
= cr
->handler
;
246 c
->jim_handler
= cr
->jim_handler
;
249 if (cr
->help
|| cr
->usage
)
250 help_add_command(cmd_ctx
, full_name
, cr
->help
, cr
->usage
);
255 static void command_free(struct Jim_Interp
*interp
, void *priv
)
257 struct command
*c
= priv
;
263 static struct command
*register_command(struct command_context
*context
,
264 const char *cmd_prefix
, const struct command_registration
*cr
)
268 if (!context
|| !cr
->name
)
272 full_name
= alloc_printf("%s %s", cmd_prefix
, cr
->name
);
274 full_name
= strdup(cr
->name
);
278 struct command
*c
= command_find_from_name(context
->interp
, full_name
);
280 /* TODO: originally we treated attempting to register a cmd twice as an error
281 * Sometimes we need this behaviour, such as with flash banks.
282 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
283 LOG_DEBUG("command '%s' is already registered", full_name
);
288 c
= command_new(context
, full_name
, cr
);
294 if (false) /* too noisy with debug_level 3 */
295 LOG_DEBUG("registering '%s'...", full_name
);
296 int retval
= Jim_CreateCommand(context
->interp
, full_name
,
297 jim_command_dispatch
, c
, command_free
);
298 if (retval
!= JIM_OK
) {
299 command_run_linef(context
, "del_help_text {%s}", full_name
);
300 command_run_linef(context
, "del_usage_text {%s}", full_name
);
310 int __register_commands(struct command_context
*cmd_ctx
, const char *cmd_prefix
,
311 const struct command_registration
*cmds
, void *data
,
312 struct target
*override_target
)
314 int retval
= ERROR_OK
;
316 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
317 const struct command_registration
*cr
= cmds
+ i
;
319 struct command
*c
= NULL
;
321 c
= register_command(cmd_ctx
, cmd_prefix
, cr
);
326 c
->jim_handler_data
= data
;
327 c
->jim_override_target
= override_target
;
332 char *new_prefix
= alloc_printf("%s %s", cmd_prefix
, cr
->name
);
337 retval
= __register_commands(cmd_ctx
, new_prefix
, cr
->chain
, data
, override_target
);
340 retval
= __register_commands(cmd_ctx
, cr
->name
, cr
->chain
, data
, override_target
);
343 retval
= __register_commands(cmd_ctx
, cmd_prefix
, cr
->chain
, data
, override_target
);
345 if (retval
!= ERROR_OK
)
349 if (retval
!= ERROR_OK
) {
350 for (unsigned j
= 0; j
< i
; j
++)
351 unregister_command(cmd_ctx
, cmd_prefix
, cmds
[j
].name
);
356 static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)))
357 int unregister_commands_match(struct command_context
*cmd_ctx
, const char *format
, ...)
359 Jim_Interp
*interp
= cmd_ctx
->interp
;
362 va_start(ap
, format
);
363 char *query
= alloc_vprintf(format
, ap
);
368 char *query_cmd
= alloc_printf("info commands {%s}", query
);
373 int retval
= Jim_EvalSource(interp
, __THIS__FILE__
, __LINE__
, query_cmd
);
375 if (retval
!= JIM_OK
)
378 Jim_Obj
*list
= Jim_GetResult(interp
);
379 Jim_IncrRefCount(list
);
381 int len
= Jim_ListLength(interp
, list
);
382 for (int i
= 0; i
< len
; i
++) {
383 Jim_Obj
*elem
= Jim_ListGetIndex(interp
, list
, i
);
384 Jim_IncrRefCount(elem
);
386 const char *name
= Jim_GetString(elem
, NULL
);
387 struct command
*c
= command_find_from_name(interp
, name
);
389 /* not openocd command */
390 Jim_DecrRefCount(interp
, elem
);
393 if (false) /* too noisy with debug_level 3 */
394 LOG_DEBUG("delete command \"%s\"", name
);
395 #if JIM_VERSION >= 80
396 Jim_DeleteCommand(interp
, elem
);
398 Jim_DeleteCommand(interp
, name
);
401 help_del_command(cmd_ctx
, name
);
403 Jim_DecrRefCount(interp
, elem
);
406 Jim_DecrRefCount(interp
, list
);
410 int unregister_all_commands(struct command_context
*context
,
411 const char *cmd_prefix
)
416 if (!cmd_prefix
|| !*cmd_prefix
)
417 return unregister_commands_match(context
, "*");
419 int retval
= unregister_commands_match(context
, "%s *", cmd_prefix
);
420 if (retval
!= ERROR_OK
)
423 return unregister_commands_match(context
, "%s", cmd_prefix
);
426 static int unregister_command(struct command_context
*context
,
427 const char *cmd_prefix
, const char *name
)
429 if (!context
|| !name
)
430 return ERROR_COMMAND_SYNTAX_ERROR
;
432 if (!cmd_prefix
|| !*cmd_prefix
)
433 return unregister_commands_match(context
, "%s", name
);
435 return unregister_commands_match(context
, "%s %s", cmd_prefix
, name
);
438 void command_output_text(struct command_context
*context
, const char *data
)
440 if (context
&& context
->output_handler
&& data
)
441 context
->output_handler(context
, data
);
444 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
449 va_start(ap
, format
);
451 string
= alloc_vprintf(format
, ap
);
453 /* we want this collected in the log + we also want to pick it up as a tcl return
456 * The latter bit isn't precisely neat, but will do for now.
458 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
459 /* We already printed it above
460 * command_output_text(context, string); */
467 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
472 va_start(ap
, format
);
474 string
= alloc_vprintf(format
, ap
);
476 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
478 /* we want this collected in the log + we also want to pick it up as a tcl return
481 * The latter bit isn't precisely neat, but will do for now.
483 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
484 /* We already printed it above
485 * command_output_text(context, string); */
492 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
, const char *full_name
)
494 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
497 /* Many commands may be run only before/after 'init' */
506 /* handle the impossible with humor; it guarantees a bug report! */
508 when
= "if Cthulhu is summoned by";
511 LOG_ERROR("The '%s' command must be used %s 'init'.",
512 full_name
? full_name
: c
->name
, when
);
516 static int run_command(struct command_context
*context
,
517 struct command
*c
, const char **words
, unsigned num_words
)
519 struct command_invocation cmd
= {
523 .argc
= num_words
- 1,
527 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
528 Jim_IncrRefCount(cmd
.output
);
530 int retval
= c
->handler(&cmd
);
531 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
532 /* Print help for command */
533 command_run_linef(context
, "usage %s", words
[0]);
534 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
535 /* just fall through for a shutdown request */
537 if (retval
!= ERROR_OK
)
538 LOG_DEBUG("Command '%s' failed with error code %d",
541 * Use the command output as the Tcl result.
542 * Drop last '\n' to allow command output concatenation
543 * while keep using command_print() everywhere.
545 const char *output_txt
= Jim_String(cmd
.output
);
546 int len
= strlen(output_txt
);
547 if (len
&& output_txt
[len
- 1] == '\n')
549 Jim_SetResultString(context
->interp
, output_txt
, len
);
551 Jim_DecrRefCount(context
->interp
, cmd
.output
);
556 int command_run_line(struct command_context
*context
, char *line
)
558 /* all the parent commands have been registered with the interpreter
559 * so, can just evaluate the line as a script and check for
562 /* run the line thru a script engine */
563 int retval
= ERROR_FAIL
;
565 /* Beware! This code needs to be reentrant. It is also possible
566 * for OpenOCD commands to be invoked directly from Tcl. This would
567 * happen when the Jim Tcl interpreter is provided by eCos for
570 struct target
*saved_target_override
= context
->current_target_override
;
571 context
->current_target_override
= NULL
;
573 Jim_Interp
*interp
= context
->interp
;
574 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
575 Jim_DeleteAssocData(interp
, "context");
576 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
577 if (retcode
== JIM_OK
) {
578 /* associated the return value */
579 Jim_DeleteAssocData(interp
, "retval");
580 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
581 if (retcode
== JIM_OK
) {
582 retcode
= Jim_Eval_Named(interp
, line
, NULL
, 0);
584 Jim_DeleteAssocData(interp
, "retval");
586 Jim_DeleteAssocData(interp
, "context");
587 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
588 if (retcode
== JIM_OK
)
589 retcode
= inner_retcode
;
591 context
->current_target_override
= saved_target_override
;
592 if (retcode
== JIM_OK
) {
596 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
598 command_output_text(context
, result
);
599 command_output_text(context
, "\n");
602 } else if (retcode
== JIM_EXIT
) {
604 * exit(Jim_GetExitCode(interp)); */
605 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
608 Jim_MakeErrorMessage(interp
);
609 /* error is broadcast */
610 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
612 if (retval
== ERROR_OK
) {
613 /* It wasn't a low level OpenOCD command that failed */
622 int command_run_linef(struct command_context
*context
, const char *format
, ...)
624 int retval
= ERROR_FAIL
;
627 va_start(ap
, format
);
628 string
= alloc_vprintf(format
, ap
);
630 retval
= command_run_line(context
, string
);
637 void command_set_output_handler(struct command_context
*context
,
638 command_output_handler_t output_handler
, void *priv
)
640 context
->output_handler
= output_handler
;
641 context
->output_handler_priv
= priv
;
644 struct command_context
*copy_command_context(struct command_context
*context
)
646 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
648 *copy_context
= *context
;
653 void command_done(struct command_context
*cmd_ctx
)
661 /* find full path to file */
662 COMMAND_HANDLER(handle_find
)
665 return ERROR_COMMAND_SYNTAX_ERROR
;
667 char *full_path
= find_file(CMD_ARGV
[0]);
669 return ERROR_COMMAND_ARGUMENT_INVALID
;
671 command_print(CMD
, "%s", full_path
);
677 COMMAND_HANDLER(handle_echo
)
679 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
680 LOG_USER_N("%s", CMD_ARGV
[1]);
687 LOG_USER("%s", CMD_ARGV
[0]);
691 /* Return both the progress output (LOG_INFO and higher)
692 * and the tcl return value of a command.
694 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
699 struct log_capture_state
*state
= command_log_capture_start(interp
);
701 /* disable polling during capture. This avoids capturing output
704 * This is necessary in order to avoid accidentally getting a non-empty
705 * string for tcl fn's.
707 bool save_poll_mask
= jtag_poll_mask();
709 const char *str
= Jim_GetString(argv
[1], NULL
);
710 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
712 jtag_poll_unmask(save_poll_mask
);
714 command_log_capture_finish(state
);
726 static COMMAND_HELPER(command_help_show
, struct help_entry
*c
,
727 bool show_help
, const char *cmd_match
);
729 static COMMAND_HELPER(command_help_show_list
, bool show_help
, const char *cmd_match
)
731 struct help_entry
*entry
;
733 list_for_each_entry(entry
, CMD_CTX
->help_list
, lh
)
734 CALL_COMMAND_HANDLER(command_help_show
, entry
, show_help
, cmd_match
);
738 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
740 static void command_help_show_indent(unsigned n
)
742 for (unsigned i
= 0; i
< n
; i
++)
745 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
747 const char *cp
= str
, *last
= str
;
749 const char *next
= last
;
754 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
755 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
756 if (next
- last
< HELP_LINE_WIDTH(n
))
758 command_help_show_indent(n
);
759 LOG_USER("%.*s", (int)(cp
- last
), last
);
765 static COMMAND_HELPER(command_help_show
, struct help_entry
*c
,
766 bool show_help
, const char *cmd_match
)
769 for (const char *s
= strchr(c
->cmd_name
, ' '); s
; s
= strchr(s
+ 1, ' '))
772 /* If the match string occurs anywhere, we print out
773 * stuff for this command. */
774 bool is_match
= strstr(c
->cmd_name
, cmd_match
) ||
775 (c
->usage
&& strstr(c
->usage
, cmd_match
)) ||
776 (c
->help
&& strstr(c
->help
, cmd_match
));
779 if (c
->usage
&& strlen(c
->usage
) > 0) {
780 char *msg
= alloc_printf("%s %s", c
->cmd_name
, c
->usage
);
781 command_help_show_wrap(msg
, n
, n
+ 5);
784 command_help_show_wrap(c
->cmd_name
, n
, n
+ 5);
788 if (is_match
&& show_help
) {
791 /* TODO: factorize jim_command_mode() to avoid running jim command here */
792 char *request
= alloc_printf("command mode %s", c
->cmd_name
);
794 LOG_ERROR("Out of memory");
797 int retval
= Jim_Eval(CMD_CTX
->interp
, request
);
799 enum command_mode mode
= COMMAND_UNKNOWN
;
800 if (retval
!= JIM_ERR
) {
801 const char *result
= Jim_GetString(Jim_GetResult(CMD_CTX
->interp
), NULL
);
802 if (!strcmp(result
, "any"))
804 else if (!strcmp(result
, "config"))
805 mode
= COMMAND_CONFIG
;
806 else if (!strcmp(result
, "exec"))
810 /* Normal commands are runtime-only; highlight exceptions */
811 if (mode
!= COMMAND_EXEC
) {
812 const char *stage_msg
= "";
816 stage_msg
= " (configuration command)";
819 stage_msg
= " (command valid any time)";
822 stage_msg
= " (?mode error?)";
825 msg
= alloc_printf("%s%s", c
->help
? c
->help
: "", stage_msg
);
827 msg
= alloc_printf("%s", c
->help
? c
->help
: "");
830 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
839 COMMAND_HANDLER(handle_help_command
)
841 bool full
= strcmp(CMD_NAME
, "help") == 0;
846 cmd_match
= strdup("");
849 cmd_match
= strdup(CMD_ARGV
[0]);
851 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
852 char *prev
= cmd_match
;
853 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
859 LOG_ERROR("unable to build search string");
862 retval
= CALL_COMMAND_HANDLER(command_help_show_list
, full
, cmd_match
);
868 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
875 all
= strdup(Jim_GetString(argv
[0], NULL
));
877 LOG_ERROR("Out of memory");
881 for (i
= 1; i
< argc
; ++i
) {
883 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
886 LOG_ERROR("Out of memory");
894 static int exec_command(Jim_Interp
*interp
, struct command_context
*cmd_ctx
,
895 struct command
*c
, int argc
, Jim_Obj
* const *argv
)
898 return c
->jim_handler(interp
, argc
, argv
);
901 unsigned int nwords
= argc
;
902 char **words
= script_command_args_alloc(argc
, argv
);
906 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
907 script_command_args_free(words
, nwords
);
908 return command_retval_set(interp
, retval
);
911 static int jim_command_dispatch(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
913 /* check subcommands */
915 char *s
= alloc_printf("%s %s", Jim_GetString(argv
[0], NULL
), Jim_GetString(argv
[1], NULL
));
916 Jim_Obj
*js
= Jim_NewStringObj(interp
, s
, -1);
917 Jim_IncrRefCount(js
);
919 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, js
, JIM_NONE
);
921 int retval
= Jim_EvalObjPrefix(interp
, js
, argc
- 2, argv
+ 2);
922 Jim_DecrRefCount(interp
, js
);
925 Jim_DecrRefCount(interp
, js
);
928 script_debug(interp
, argc
, argv
);
930 struct command
*c
= jim_to_command(interp
);
931 if (!c
->jim_handler
&& !c
->handler
) {
932 Jim_EvalObjPrefix(interp
, Jim_NewStringObj(interp
, "usage", -1), 1, argv
);
936 struct command_context
*cmd_ctx
= current_command_context(interp
);
938 if (!command_can_run(cmd_ctx
, c
, Jim_GetString(argv
[0], NULL
)))
941 target_call_timer_callbacks();
944 * Black magic of overridden current target:
945 * If the command we are going to handle has a target prefix,
946 * override the current target temporarily for the time
947 * of processing the command.
948 * current_target_override is used also for event handlers
949 * therefore we prevent touching it if command has no prefix.
950 * Previous override is saved and restored back to ensure
951 * correct work when jim_command_dispatch() is re-entered.
953 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
954 if (c
->jim_override_target
)
955 cmd_ctx
->current_target_override
= c
->jim_override_target
;
957 int retval
= exec_command(interp
, cmd_ctx
, c
, argc
, argv
);
959 if (c
->jim_override_target
)
960 cmd_ctx
->current_target_override
= saved_target_override
;
965 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
967 struct command_context
*cmd_ctx
= current_command_context(interp
);
968 enum command_mode mode
;
971 char *full_name
= alloc_concatenate_strings(argc
- 1, argv
+ 1);
974 Jim_Obj
*s
= Jim_NewStringObj(interp
, full_name
, -1);
976 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, s
, JIM_NONE
);
977 Jim_DecrRefCount(interp
, s
);
979 if (!cmd
|| !(jimcmd_is_proc(cmd
) || jimcmd_is_oocd_command(cmd
))) {
980 Jim_SetResultString(interp
, "unknown", -1);
984 if (jimcmd_is_proc(cmd
)) {
988 struct command
*c
= jimcmd_privdata(cmd
);
993 mode
= cmd_ctx
->mode
;
995 const char *mode_str
;
1000 case COMMAND_CONFIG
:
1001 mode_str
= "config";
1007 mode_str
= "unknown";
1010 Jim_SetResultString(interp
, mode_str
, -1);
1014 int help_del_all_commands(struct command_context
*cmd_ctx
)
1016 struct help_entry
*curr
, *n
;
1018 list_for_each_entry_safe(curr
, n
, cmd_ctx
->help_list
, lh
) {
1019 list_del(&curr
->lh
);
1020 free(curr
->cmd_name
);
1028 static int help_del_command(struct command_context
*cmd_ctx
, const char *cmd_name
)
1030 struct help_entry
*curr
;
1032 list_for_each_entry(curr
, cmd_ctx
->help_list
, lh
) {
1033 if (!strcmp(cmd_name
, curr
->cmd_name
)) {
1034 list_del(&curr
->lh
);
1035 free(curr
->cmd_name
);
1046 static int help_add_command(struct command_context
*cmd_ctx
,
1047 const char *cmd_name
, const char *help_text
, const char *usage_text
)
1049 int cmp
= -1; /* add after curr */
1050 struct help_entry
*curr
;
1052 list_for_each_entry_reverse(curr
, cmd_ctx
->help_list
, lh
) {
1053 cmp
= strcmp(cmd_name
, curr
->cmd_name
);
1058 struct help_entry
*entry
;
1060 entry
= calloc(1, sizeof(*entry
));
1062 LOG_ERROR("Out of memory");
1065 entry
->cmd_name
= strdup(cmd_name
);
1066 if (!entry
->cmd_name
) {
1067 LOG_ERROR("Out of memory");
1071 list_add(&entry
->lh
, &curr
->lh
);
1077 char *text
= strdup(help_text
);
1079 LOG_ERROR("Out of memory");
1087 char *text
= strdup(usage_text
);
1089 LOG_ERROR("Out of memory");
1093 entry
->usage
= text
;
1099 COMMAND_HANDLER(handle_help_add_command
)
1102 return ERROR_COMMAND_SYNTAX_ERROR
;
1104 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? CMD_ARGV
[1] : NULL
;
1105 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? CMD_ARGV
[1] : NULL
;
1106 if (!help
&& !usage
) {
1107 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1108 return ERROR_COMMAND_SYNTAX_ERROR
;
1110 const char *cmd_name
= CMD_ARGV
[0];
1111 return help_add_command(CMD_CTX
, cmd_name
, help
, usage
);
1114 /* sleep command sleeps for <n> milliseconds
1115 * this is useful in target startup scripts
1117 COMMAND_HANDLER(handle_sleep_command
)
1120 if (CMD_ARGC
== 2) {
1121 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1124 return ERROR_COMMAND_SYNTAX_ERROR
;
1125 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1126 return ERROR_COMMAND_SYNTAX_ERROR
;
1128 unsigned long duration
= 0;
1129 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1130 if (retval
!= ERROR_OK
)
1134 int64_t then
= timeval_ms();
1135 while (timeval_ms() - then
< (int64_t)duration
) {
1136 target_call_timer_callbacks_now();
1141 busy_sleep(duration
);
1146 static const struct command_registration command_subcommand_handlers
[] = {
1149 .mode
= COMMAND_ANY
,
1150 .jim_handler
= jim_command_mode
,
1151 .usage
= "[command_name ...]",
1152 .help
= "Returns the command modes allowed by a command: "
1153 "'any', 'config', or 'exec'. If no command is "
1154 "specified, returns the current command mode. "
1155 "Returns 'unknown' if an unknown command is given. "
1156 "Command can be multiple tokens.",
1158 COMMAND_REGISTRATION_DONE
1161 static const struct command_registration command_builtin_handlers
[] = {
1164 .mode
= COMMAND_ANY
,
1165 .handler
= handle_find
,
1166 .help
= "find full path to file",
1171 .mode
= COMMAND_ANY
,
1172 .jim_handler
= jim_capture
,
1173 .help
= "Capture progress output and return as tcl return value. If the "
1174 "progress output was empty, return tcl return value.",
1179 .handler
= handle_echo
,
1180 .mode
= COMMAND_ANY
,
1181 .help
= "Logs a message at \"user\" priority. "
1182 "Option \"-n\" suppresses trailing newline",
1183 .usage
= "[-n] string",
1186 .name
= "add_help_text",
1187 .handler
= handle_help_add_command
,
1188 .mode
= COMMAND_ANY
,
1189 .help
= "Add new command help text; "
1190 "Command can be multiple tokens.",
1191 .usage
= "command_name helptext_string",
1194 .name
= "add_usage_text",
1195 .handler
= handle_help_add_command
,
1196 .mode
= COMMAND_ANY
,
1197 .help
= "Add new command usage text; "
1198 "command can be multiple tokens.",
1199 .usage
= "command_name usage_string",
1203 .handler
= handle_sleep_command
,
1204 .mode
= COMMAND_ANY
,
1205 .help
= "Sleep for specified number of milliseconds. "
1206 "\"busy\" will busy wait instead (avoid this).",
1207 .usage
= "milliseconds ['busy']",
1211 .handler
= handle_help_command
,
1212 .mode
= COMMAND_ANY
,
1213 .help
= "Show full command help; "
1214 "command can be multiple tokens.",
1215 .usage
= "[command_name]",
1219 .handler
= handle_help_command
,
1220 .mode
= COMMAND_ANY
,
1221 .help
= "Show basic command usage; "
1222 "command can be multiple tokens.",
1223 .usage
= "[command_name]",
1227 .mode
= COMMAND_ANY
,
1228 .help
= "core command group (introspection)",
1229 .chain
= command_subcommand_handlers
,
1232 COMMAND_REGISTRATION_DONE
1235 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1237 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1239 context
->mode
= COMMAND_EXEC
;
1241 /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
1242 context
->help_list
= malloc(sizeof(*context
->help_list
));
1243 INIT_LIST_HEAD(context
->help_list
);
1245 /* Create a jim interpreter if we were not handed one */
1247 /* Create an interpreter */
1248 interp
= Jim_CreateInterp();
1249 /* Add all the Jim core commands */
1250 Jim_RegisterCoreCommands(interp
);
1251 Jim_InitStaticExtensions(interp
);
1254 context
->interp
= interp
;
1256 register_commands(context
, NULL
, command_builtin_handlers
);
1258 Jim_SetAssocData(interp
, "context", NULL
, context
);
1259 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1260 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1261 Jim_MakeErrorMessage(interp
);
1262 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1265 Jim_DeleteAssocData(interp
, "context");
1270 void command_exit(struct command_context
*context
)
1275 Jim_FreeInterp(context
->interp
);
1276 free(context
->help_list
);
1277 command_done(context
);
1280 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1283 return ERROR_COMMAND_SYNTAX_ERROR
;
1285 cmd_ctx
->mode
= mode
;
1289 void process_jim_events(struct command_context
*cmd_ctx
)
1291 static int recursion
;
1296 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1300 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1301 int parse ## name(const char *str, type * ul) \
1304 LOG_ERROR("Invalid command argument"); \
1305 return ERROR_COMMAND_ARGUMENT_INVALID; \
1309 *ul = func(str, &end, 0); \
1311 LOG_ERROR("Invalid command argument"); \
1312 return ERROR_COMMAND_ARGUMENT_INVALID; \
1314 if ((max == *ul) && (errno == ERANGE)) { \
1315 LOG_ERROR("Argument overflow"); \
1316 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1318 if (min && (min == *ul) && (errno == ERANGE)) { \
1319 LOG_ERROR("Argument underflow"); \
1320 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1324 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1325 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1326 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1327 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1329 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1330 int parse ## name(const char *str, type * ul) \
1333 int retval = parse ## funcname(str, &n); \
1334 if (retval != ERROR_OK) \
1337 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1339 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1344 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1345 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1346 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1347 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1348 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1349 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1350 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1352 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1354 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1355 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1356 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1357 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1358 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1359 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1360 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1362 static int command_parse_bool(const char *in
, bool *out
,
1363 const char *on
, const char *off
)
1365 if (strcasecmp(in
, on
) == 0)
1367 else if (strcasecmp(in
, off
) == 0)
1370 return ERROR_COMMAND_SYNTAX_ERROR
;
1374 int command_parse_bool_arg(const char *in
, bool *out
)
1376 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1378 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1380 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1382 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1384 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1386 return ERROR_COMMAND_SYNTAX_ERROR
;
1389 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1393 const char *in
= CMD_ARGV
[0];
1394 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1395 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1396 return ERROR_COMMAND_SYNTAX_ERROR
;
1401 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1404 return 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)