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, see <http://www.gnu.org/licenses/>. *
26 ***************************************************************************/
32 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
35 /* @todo the inclusion of target.h here is a layering violation */
36 #include <jtag/jtag.h>
37 #include <target/target.h>
39 #include "configuration.h"
41 #include "time_support.h"
42 #include "jim-eventloop.h"
44 /* nice short description of source file */
45 #define __THIS__FILE__ "command.c"
47 static int run_command(struct command_context
*context
,
48 struct command
*c
, const char *words
[], unsigned num_words
);
50 struct log_capture_state
{
55 static int unregister_command(struct command_context
*context
,
56 struct command
*parent
, const char *name
);
57 static char *command_name(struct command
*c
, char delim
);
59 static void tcl_output(void *privData
, const char *file
, unsigned line
,
60 const char *function
, const char *string
)
62 struct log_capture_state
*state
= privData
;
63 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
66 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
68 /* capture log output and return it. A garbage collect can
69 * happen, so we need a reference count to this object */
70 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
71 if (NULL
== tclOutput
)
74 struct log_capture_state
*state
= malloc(sizeof(*state
));
78 state
->interp
= interp
;
79 Jim_IncrRefCount(tclOutput
);
80 state
->output
= tclOutput
;
82 log_add_callback(tcl_output
, state
);
87 /* Classic openocd commands provide progress output which we
88 * will capture and return as a Tcl return value.
90 * However, if a non-openocd command has been invoked, then it
91 * makes sense to return the tcl return value from that command.
93 * The tcl return value is empty for openocd commands that provide
96 * Therefore we set the tcl return value only if we actually
99 static void command_log_capture_finish(struct log_capture_state
*state
)
104 log_remove_callback(tcl_output
, state
);
107 Jim_GetString(state
->output
, &length
);
110 Jim_SetResult(state
->interp
, state
->output
);
112 /* No output captured, use tcl return value (which could
115 Jim_DecrRefCount(state
->interp
, state
->output
);
120 static int command_retval_set(Jim_Interp
*interp
, int retval
)
122 int *return_retval
= Jim_GetAssocData(interp
, "retval");
123 if (return_retval
!= NULL
)
124 *return_retval
= retval
;
126 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
129 extern struct command_context
*global_cmd_ctx
;
131 /* dump a single line to the log for the command.
132 * Do nothing in case we are not at debug level 3 */
133 void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
135 if (debug_level
< LOG_LVL_DEBUG
)
138 char *dbg
= alloc_printf("command -");
139 for (unsigned i
= 0; i
< argc
; i
++) {
141 const char *w
= Jim_GetString(argv
[i
], &len
);
142 char *t
= alloc_printf("%s %s", dbg
, w
);
146 LOG_DEBUG("%s", dbg
);
150 static void script_command_args_free(char **words
, unsigned nwords
)
152 for (unsigned i
= 0; i
< nwords
; i
++)
157 static char **script_command_args_alloc(
158 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
160 char **words
= malloc(argc
* sizeof(char *));
165 for (i
= 0; i
< argc
; i
++) {
167 const char *w
= Jim_GetString(argv
[i
], &len
);
168 words
[i
] = strdup(w
);
169 if (words
[i
] == NULL
) {
170 script_command_args_free(words
, i
);
178 struct command_context
*current_command_context(Jim_Interp
*interp
)
180 /* grab the command context from the associated data */
181 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
182 if (NULL
== cmd_ctx
) {
183 /* Tcl can invoke commands directly instead of via command_run_line(). This would
184 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
185 * commands in a startup script.
187 * A telnet or gdb server would provide a non-default command context to
188 * handle piping of error output, have a separate current target, etc.
190 cmd_ctx
= global_cmd_ctx
;
195 static int script_command_run(Jim_Interp
*interp
,
196 int argc
, Jim_Obj
* const *argv
, struct command
*c
)
198 target_call_timer_callbacks_now();
199 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
202 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
206 struct command_context
*cmd_ctx
= current_command_context(interp
);
207 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
209 script_command_args_free(words
, nwords
);
210 return command_retval_set(interp
, retval
);
213 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
215 /* the private data is stashed in the interp structure */
217 struct command
*c
= interp
->cmdPrivData
;
219 script_debug(interp
, argc
, argv
);
220 return script_command_run(interp
, argc
, argv
, c
);
223 static struct command
*command_root(struct command
*c
)
225 while (NULL
!= c
->parent
)
231 * Find a command by name from a list of commands.
232 * @returns Returns the named command if it exists in the list.
233 * Returns NULL otherwise.
235 static struct command
*command_find(struct command
*head
, const char *name
)
237 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
238 if (strcmp(cc
->name
, name
) == 0)
244 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
247 return command_find(cmd_ctx
->commands
, name
);
251 * Add the command into the linked list, sorted by name.
252 * @param head Address to head of command list pointer, which may be
253 * updated if @c c gets inserted at the beginning of the list.
254 * @param c The command to add to the list pointed to by @c head.
256 static void command_add_child(struct command
**head
, struct command
*c
)
264 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
265 head
= &(*head
)->next
;
267 if (strcmp(c
->name
, (*head
)->name
) > 0) {
268 c
->next
= (*head
)->next
;
276 static struct command
**command_list_for_parent(
277 struct command_context
*cmd_ctx
, struct command
*parent
)
279 return parent
? &parent
->children
: &cmd_ctx
->commands
;
282 static void command_free(struct command
*c
)
284 /** @todo if command has a handler, unregister its jim command! */
286 while (NULL
!= c
->children
) {
287 struct command
*tmp
= c
->children
;
288 c
->children
= tmp
->next
;
298 static struct command
*command_new(struct command_context
*cmd_ctx
,
299 struct command
*parent
, const struct command_registration
*cr
)
304 * If it is a non-jim command with no .usage specified,
307 * strlen(.usage) == 0 means that the command takes no
310 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
311 LOG_ERROR("BUG: command '%s%s%s' does not have the "
312 "'.usage' field filled out",
313 parent
&& parent
->name
? parent
->name
: "",
314 parent
&& parent
->name
? " " : "",
318 struct command
*c
= calloc(1, sizeof(struct command
));
322 c
->name
= strdup(cr
->name
);
324 c
->help
= strdup(cr
->help
);
326 c
->usage
= strdup(cr
->usage
);
328 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
329 goto command_new_error
;
332 c
->handler
= cr
->handler
;
333 c
->jim_handler
= cr
->jim_handler
;
336 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
345 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
347 static int register_command_handler(struct command_context
*cmd_ctx
,
350 Jim_Interp
*interp
= cmd_ctx
->interp
;
352 LOG_DEBUG("registering '%s'...", c
->name
);
354 Jim_CmdProc
*func
= c
->handler
? &script_command
: &command_unknown
;
355 int retval
= Jim_CreateCommand(interp
, c
->name
, func
, c
, NULL
);
360 static struct command
*register_command(struct command_context
*context
,
361 struct command
*parent
, const struct command_registration
*cr
)
363 if (!context
|| !cr
->name
)
366 const char *name
= cr
->name
;
367 struct command
**head
= command_list_for_parent(context
, parent
);
368 struct command
*c
= command_find(*head
, name
);
370 /* TODO: originally we treated attempting to register a cmd twice as an error
371 * Sometimes we need this behaviour, such as with flash banks.
372 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
373 LOG_DEBUG("command '%s' is already registered in '%s' context",
374 name
, parent
? parent
->name
: "<global>");
378 c
= command_new(context
, parent
, cr
);
383 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
384 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
385 cr
->jim_handler
, NULL
, NULL
);
386 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
387 retval
= register_command_handler(context
, command_root(c
));
389 if (retval
!= JIM_OK
) {
390 unregister_command(context
, parent
, name
);
396 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
397 const struct command_registration
*cmds
)
399 int retval
= ERROR_OK
;
401 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
402 const struct command_registration
*cr
= cmds
+ i
;
404 struct command
*c
= NULL
;
405 if (NULL
!= cr
->name
) {
406 c
= register_command(cmd_ctx
, parent
, cr
);
412 if (NULL
!= cr
->chain
) {
413 struct command
*p
= c
? : parent
;
414 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
415 if (ERROR_OK
!= retval
)
419 if (ERROR_OK
!= retval
) {
420 for (unsigned j
= 0; j
< i
; j
++)
421 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
426 int unregister_all_commands(struct command_context
*context
,
427 struct command
*parent
)
432 struct command
**head
= command_list_for_parent(context
, parent
);
433 while (NULL
!= *head
) {
434 struct command
*tmp
= *head
;
442 static int unregister_command(struct command_context
*context
,
443 struct command
*parent
, const char *name
)
445 if ((!context
) || (!name
))
446 return ERROR_COMMAND_SYNTAX_ERROR
;
448 struct command
*p
= NULL
;
449 struct command
**head
= command_list_for_parent(context
, parent
);
450 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
451 if (strcmp(name
, c
->name
) != 0)
466 void command_set_handler_data(struct command
*c
, void *p
)
468 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
469 c
->jim_handler_data
= p
;
470 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
471 command_set_handler_data(cc
, p
);
474 void command_output_text(struct command_context
*context
, const char *data
)
476 if (context
&& context
->output_handler
&& data
)
477 context
->output_handler(context
, data
);
480 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
485 va_start(ap
, format
);
487 string
= alloc_vprintf(format
, ap
);
488 if (string
!= NULL
&& cmd
) {
489 /* we want this collected in the log + we also want to pick it up as a tcl return
492 * The latter bit isn't precisely neat, but will do for now.
494 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
495 /* We already printed it above
496 * command_output_text(context, string); */
503 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
508 va_start(ap
, format
);
510 string
= alloc_vprintf(format
, ap
);
511 if (string
!= NULL
&& cmd
) {
512 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
514 /* we want this collected in the log + we also want to pick it up as a tcl return
517 * The latter bit isn't precisely neat, but will do for now.
519 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
520 /* We already printed it above
521 * command_output_text(context, string); */
528 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
531 unsigned len
= strlen(c
->name
);
532 if (NULL
== c
->parent
) {
533 /* allocate enough for the name, child names, and '\0' */
534 name
= malloc(len
+ extra
+ 1);
536 LOG_ERROR("Out of memory");
539 strcpy(name
, c
->name
);
541 /* parent's extra must include both the space and name */
542 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
543 char dstr
[2] = { delim
, 0 };
545 strcat(name
, c
->name
);
550 static char *command_name(struct command
*c
, char delim
)
552 return __command_name(c
, delim
, 0);
555 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
557 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
560 /* Many commands may be run only before/after 'init' */
569 /* handle the impossible with humor; it guarantees a bug report! */
571 when
= "if Cthulhu is summoned by";
574 char *full_name
= command_name(c
, ' ');
575 LOG_ERROR("The '%s' command must be used %s 'init'.",
576 full_name
? full_name
: c
->name
, when
);
581 static int run_command(struct command_context
*context
,
582 struct command
*c
, const char *words
[], unsigned num_words
)
584 if (!command_can_run(context
, c
))
587 struct command_invocation cmd
= {
591 .argc
= num_words
- 1,
594 /* Black magic of overridden current target:
595 * If the command we are going to handle has a target prefix,
596 * override the current target temporarily for the time
597 * of processing the command.
598 * current_target_override is used also for event handlers
599 * therefore we prevent touching it if command has no prefix.
600 * Previous override is saved and restored back to ensure
601 * correct work when run_command() is re-entered. */
602 struct target
*saved_target_override
= context
->current_target_override
;
603 if (c
->jim_handler_data
)
604 context
->current_target_override
= c
->jim_handler_data
;
606 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
607 Jim_IncrRefCount(cmd
.output
);
609 int retval
= c
->handler(&cmd
);
611 if (c
->jim_handler_data
)
612 context
->current_target_override
= saved_target_override
;
614 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
615 /* Print help for command */
616 char *full_name
= command_name(c
, ' ');
617 if (NULL
!= full_name
) {
618 command_run_linef(context
, "usage %s", full_name
);
621 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
622 /* just fall through for a shutdown request */
624 if (retval
!= ERROR_OK
) {
625 char *full_name
= command_name(c
, ' ');
626 LOG_DEBUG("Command '%s' failed with error code %d",
627 full_name
? full_name
: c
->name
, retval
);
630 /* Use the command output as the Tcl result */
631 Jim_SetResult(context
->interp
, cmd
.output
);
633 Jim_DecrRefCount(context
->interp
, cmd
.output
);
638 int command_run_line(struct command_context
*context
, char *line
)
640 /* all the parent commands have been registered with the interpreter
641 * so, can just evaluate the line as a script and check for
644 /* run the line thru a script engine */
645 int retval
= ERROR_FAIL
;
647 /* Beware! This code needs to be reentrant. It is also possible
648 * for OpenOCD commands to be invoked directly from Tcl. This would
649 * happen when the Jim Tcl interpreter is provided by eCos for
652 struct target
*saved_target_override
= context
->current_target_override
;
653 context
->current_target_override
= NULL
;
655 Jim_Interp
*interp
= context
->interp
;
656 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
657 Jim_DeleteAssocData(interp
, "context");
658 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
659 if (retcode
== JIM_OK
) {
660 /* associated the return value */
661 Jim_DeleteAssocData(interp
, "retval");
662 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
663 if (retcode
== JIM_OK
) {
664 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
666 Jim_DeleteAssocData(interp
, "retval");
668 Jim_DeleteAssocData(interp
, "context");
669 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
670 if (retcode
== JIM_OK
)
671 retcode
= inner_retcode
;
673 context
->current_target_override
= saved_target_override
;
674 if (retcode
== JIM_OK
) {
678 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
680 command_output_text(context
, result
);
681 command_output_text(context
, "\n");
684 } else if (retcode
== JIM_EXIT
) {
686 * exit(Jim_GetExitCode(interp)); */
687 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
690 Jim_MakeErrorMessage(interp
);
691 /* error is broadcast */
692 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
694 if (retval
== ERROR_OK
) {
695 /* It wasn't a low level OpenOCD command that failed */
704 int command_run_linef(struct command_context
*context
, const char *format
, ...)
706 int retval
= ERROR_FAIL
;
709 va_start(ap
, format
);
710 string
= alloc_vprintf(format
, ap
);
711 if (string
!= NULL
) {
712 retval
= command_run_line(context
, string
);
719 void command_set_output_handler(struct command_context
*context
,
720 command_output_handler_t output_handler
, void *priv
)
722 context
->output_handler
= output_handler
;
723 context
->output_handler_priv
= priv
;
726 struct command_context
*copy_command_context(struct command_context
*context
)
728 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
730 *copy_context
= *context
;
735 void command_done(struct command_context
*cmd_ctx
)
743 /* find full path to file */
744 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
748 const char *file
= Jim_GetString(argv
[1], NULL
);
749 char *full_path
= find_file(file
);
750 if (full_path
== NULL
)
752 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
755 Jim_SetResult(interp
, result
);
759 COMMAND_HANDLER(jim_echo
)
761 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
762 LOG_USER_N("%s", CMD_ARGV
[1]);
767 LOG_USER("%s", CMD_ARGV
[0]);
771 /* Capture progress output and return as tcl return value. If the
772 * progress output was empty, return tcl return value.
774 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
779 struct log_capture_state
*state
= command_log_capture_start(interp
);
781 /* disable polling during capture. This avoids capturing output
784 * This is necessary in order to avoid accidentally getting a non-empty
785 * string for tcl fn's.
787 bool save_poll
= jtag_poll_get_enabled();
789 jtag_poll_set_enabled(false);
791 const char *str
= Jim_GetString(argv
[1], NULL
);
792 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
794 jtag_poll_set_enabled(save_poll
);
796 command_log_capture_finish(state
);
801 static COMMAND_HELPER(command_help_find
, struct command
*head
,
802 struct command
**out
)
805 return ERROR_COMMAND_SYNTAX_ERROR
;
806 *out
= command_find(head
, CMD_ARGV
[0]);
808 return ERROR_COMMAND_SYNTAX_ERROR
;
812 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
815 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
816 bool show_help
, const char *cmd_match
);
818 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
819 bool show_help
, const char *cmd_match
)
821 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
822 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
826 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
828 static void command_help_show_indent(unsigned n
)
830 for (unsigned i
= 0; i
< n
; i
++)
833 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
835 const char *cp
= str
, *last
= str
;
837 const char *next
= last
;
842 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
843 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
844 if (next
- last
< HELP_LINE_WIDTH(n
))
846 command_help_show_indent(n
);
847 LOG_USER("%.*s", (int)(cp
- last
), last
);
853 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
854 bool show_help
, const char *cmd_match
)
856 char *cmd_name
= command_name(c
, ' ');
857 if (NULL
== cmd_name
)
860 /* If the match string occurs anywhere, we print out
861 * stuff for this command. */
862 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
863 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
864 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
867 command_help_show_indent(n
);
868 LOG_USER_N("%s", cmd_name
);
873 if (c
->usage
&& strlen(c
->usage
) > 0) {
875 command_help_show_wrap(c
->usage
, 0, n
+ 5);
880 if (is_match
&& show_help
) {
883 /* Normal commands are runtime-only; highlight exceptions */
884 if (c
->mode
!= COMMAND_EXEC
) {
885 const char *stage_msg
= "";
889 stage_msg
= " (configuration command)";
892 stage_msg
= " (command valid any time)";
895 stage_msg
= " (?mode error?)";
898 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
900 msg
= alloc_printf("%s", c
->help
? : "");
903 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
910 LOG_ERROR("command recursion exceeded");
914 return CALL_COMMAND_HANDLER(command_help_show_list
,
915 c
->children
, n
, show_help
, cmd_match
);
918 COMMAND_HANDLER(handle_help_command
)
920 bool full
= strcmp(CMD_NAME
, "help") == 0;
922 struct command
*c
= CMD_CTX
->commands
;
923 char *cmd_match
= NULL
;
927 else if (CMD_ARGC
>= 1) {
930 for (i
= 0; i
< CMD_ARGC
; ++i
) {
931 if (NULL
!= cmd_match
) {
932 char *prev
= cmd_match
;
934 cmd_match
= alloc_printf("%s %s", cmd_match
, CMD_ARGV
[i
]);
936 if (NULL
== cmd_match
) {
937 LOG_ERROR("unable to build search string");
941 cmd_match
= alloc_printf("%s", CMD_ARGV
[i
]);
942 if (NULL
== cmd_match
) {
943 LOG_ERROR("unable to build search string");
949 return ERROR_COMMAND_SYNTAX_ERROR
;
951 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
952 c
, 0, full
, cmd_match
);
959 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
960 struct command
*head
, struct command
**out
)
964 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
965 struct command
*c
= command_find(head
, cmd_name
);
969 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
972 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
979 all
= strdup(Jim_GetString(argv
[0], NULL
));
981 LOG_ERROR("Out of memory");
985 for (i
= 1; i
< argc
; ++i
) {
987 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
990 LOG_ERROR("Out of memory");
998 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
1000 struct command_context
*cmd_ctx
= current_command_context(interp
);
1004 assert(argc_valid
>= 1);
1005 assert(argc
>= argc_valid
);
1007 command
= alloc_concatenate_strings(argc_valid
, argv
);
1011 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
1012 if (retval
!= ERROR_OK
) {
1013 LOG_ERROR("unable to execute command \"usage %s\"", command
);
1017 if (argc_valid
== argc
)
1018 LOG_ERROR("%s: command requires more arguments", command
);
1021 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
1024 LOG_ERROR("invalid subcommand \"%s\"", command
);
1031 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1033 script_debug(interp
, argc
, argv
);
1035 struct command_context
*cmd_ctx
= current_command_context(interp
);
1036 struct command
*c
= cmd_ctx
->commands
;
1037 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1038 /* if nothing could be consumed, then it's really an unknown command */
1039 if (remaining
== argc
) {
1040 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1041 LOG_ERROR("Unknown command:\n %s", cmd
);
1045 Jim_Obj
*const *start
;
1047 if (c
->handler
|| c
->jim_handler
) {
1048 /* include the command name in the list */
1049 count
= remaining
+ 1;
1050 start
= argv
+ (argc
- remaining
- 1);
1052 count
= argc
- remaining
;
1054 run_usage(interp
, count
, argc
, start
);
1057 /* pass the command through to the intended handler */
1058 if (c
->jim_handler
) {
1059 if (!command_can_run(cmd_ctx
, c
))
1062 interp
->cmdPrivData
= c
->jim_handler_data
;
1063 return (*c
->jim_handler
)(interp
, count
, start
);
1066 return script_command_run(interp
, count
, start
, c
);
1069 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1071 struct command_context
*cmd_ctx
= current_command_context(interp
);
1072 enum command_mode mode
;
1075 struct command
*c
= cmd_ctx
->commands
;
1076 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1077 /* if nothing could be consumed, then it's an unknown command */
1078 if (remaining
== argc
- 1) {
1079 Jim_SetResultString(interp
, "unknown", -1);
1084 mode
= cmd_ctx
->mode
;
1086 const char *mode_str
;
1091 case COMMAND_CONFIG
:
1092 mode_str
= "config";
1098 mode_str
= "unknown";
1101 Jim_SetResultString(interp
, mode_str
, -1);
1105 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1106 const char *cmd_name
, const char *help_text
, const char *usage
)
1108 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1109 struct command
*nc
= command_find(*head
, cmd_name
);
1111 /* add a new command with help text */
1112 struct command_registration cr
= {
1114 .mode
= COMMAND_ANY
,
1116 .usage
= usage
? : "",
1118 nc
= register_command(cmd_ctx
, parent
, &cr
);
1120 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1123 LOG_DEBUG("added '%s' help text", cmd_name
);
1127 bool replaced
= false;
1132 nc
->help
= strdup(help_text
);
1134 LOG_INFO("replaced existing '%s' help", cmd_name
);
1136 LOG_DEBUG("added '%s' help text", cmd_name
);
1139 bool replaced
= false;
1145 nc
->usage
= strdup(usage
);
1147 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1149 LOG_DEBUG("added '%s' usage text", cmd_name
);
1154 COMMAND_HANDLER(handle_help_add_command
)
1157 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1158 return ERROR_COMMAND_SYNTAX_ERROR
;
1161 /* save help text and remove it from argument list */
1162 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1163 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1164 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1165 if (!help
&& !usage
) {
1166 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1167 return ERROR_COMMAND_SYNTAX_ERROR
;
1169 /* likewise for the leaf command name */
1170 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1172 struct command
*c
= NULL
;
1174 c
= CMD_CTX
->commands
;
1175 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1176 if (ERROR_OK
!= retval
)
1179 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1182 /* sleep command sleeps for <n> milliseconds
1183 * this is useful in target startup scripts
1185 COMMAND_HANDLER(handle_sleep_command
)
1188 if (CMD_ARGC
== 2) {
1189 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1192 return ERROR_COMMAND_SYNTAX_ERROR
;
1193 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1194 return ERROR_COMMAND_SYNTAX_ERROR
;
1196 unsigned long duration
= 0;
1197 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1198 if (ERROR_OK
!= retval
)
1202 int64_t then
= timeval_ms();
1203 while (timeval_ms() - then
< (int64_t)duration
) {
1204 target_call_timer_callbacks_now();
1208 busy_sleep(duration
);
1213 static const struct command_registration command_subcommand_handlers
[] = {
1216 .mode
= COMMAND_ANY
,
1217 .jim_handler
= jim_command_mode
,
1218 .usage
= "[command_name ...]",
1219 .help
= "Returns the command modes allowed by a command: "
1220 "'any', 'config', or 'exec'. If no command is "
1221 "specified, returns the current command mode. "
1222 "Returns 'unknown' if an unknown command is given. "
1223 "Command can be multiple tokens.",
1225 COMMAND_REGISTRATION_DONE
1228 static const struct command_registration command_builtin_handlers
[] = {
1231 .mode
= COMMAND_ANY
,
1232 .jim_handler
= jim_find
,
1233 .help
= "find full path to file",
1238 .mode
= COMMAND_ANY
,
1239 .jim_handler
= jim_capture
,
1240 .help
= "Capture progress output and return as tcl return value. If the "
1241 "progress output was empty, return tcl return value.",
1246 .handler
= jim_echo
,
1247 .mode
= COMMAND_ANY
,
1248 .help
= "Logs a message at \"user\" priority. "
1249 "Output message to stdout. "
1250 "Option \"-n\" suppresses trailing newline",
1251 .usage
= "[-n] string",
1254 .name
= "add_help_text",
1255 .handler
= handle_help_add_command
,
1256 .mode
= COMMAND_ANY
,
1257 .help
= "Add new command help text; "
1258 "Command can be multiple tokens.",
1259 .usage
= "command_name helptext_string",
1262 .name
= "add_usage_text",
1263 .handler
= handle_help_add_command
,
1264 .mode
= COMMAND_ANY
,
1265 .help
= "Add new command usage text; "
1266 "command can be multiple tokens.",
1267 .usage
= "command_name usage_string",
1271 .handler
= handle_sleep_command
,
1272 .mode
= COMMAND_ANY
,
1273 .help
= "Sleep for specified number of milliseconds. "
1274 "\"busy\" will busy wait instead (avoid this).",
1275 .usage
= "milliseconds ['busy']",
1279 .handler
= handle_help_command
,
1280 .mode
= COMMAND_ANY
,
1281 .help
= "Show full command help; "
1282 "command can be multiple tokens.",
1283 .usage
= "[command_name]",
1287 .handler
= handle_help_command
,
1288 .mode
= COMMAND_ANY
,
1289 .help
= "Show basic command usage; "
1290 "command can be multiple tokens.",
1291 .usage
= "[command_name]",
1295 .mode
= COMMAND_ANY
,
1296 .help
= "core command group (introspection)",
1297 .chain
= command_subcommand_handlers
,
1300 COMMAND_REGISTRATION_DONE
1303 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1305 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1308 context
->mode
= COMMAND_EXEC
;
1310 /* Create a jim interpreter if we were not handed one */
1311 if (interp
== NULL
) {
1312 /* Create an interpreter */
1313 interp
= Jim_CreateInterp();
1314 /* Add all the Jim core commands */
1315 Jim_RegisterCoreCommands(interp
);
1316 Jim_InitStaticExtensions(interp
);
1319 context
->interp
= interp
;
1321 /* Stick to lowercase for HostOS strings. */
1322 #if defined(_MSC_VER)
1323 /* WinXX - is generic, the forward
1324 * looking problem is this:
1326 * "win32" or "win64"
1328 * "winxx" is generic.
1331 #elif defined(__linux__)
1333 #elif defined(__APPLE__) || defined(__DARWIN__)
1335 #elif defined(__CYGWIN__)
1337 #elif defined(__MINGW32__)
1339 #elif defined(__ECOS)
1341 #elif defined(__FreeBSD__)
1343 #elif defined(__NetBSD__)
1345 #elif defined(__OpenBSD__)
1348 #warning "Unrecognized host OS..."
1351 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1352 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1354 register_commands(context
, NULL
, command_builtin_handlers
);
1356 Jim_SetAssocData(interp
, "context", NULL
, context
);
1357 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1358 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1359 Jim_MakeErrorMessage(interp
);
1360 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1363 Jim_DeleteAssocData(interp
, "context");
1368 void command_exit(struct command_context
*context
)
1373 Jim_FreeInterp(context
->interp
);
1374 command_done(context
);
1377 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1380 return ERROR_COMMAND_SYNTAX_ERROR
;
1382 cmd_ctx
->mode
= mode
;
1386 void process_jim_events(struct command_context
*cmd_ctx
)
1388 static int recursion
;
1393 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1397 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1398 int parse ## name(const char *str, type * ul) \
1401 LOG_ERROR("Invalid command argument"); \
1402 return ERROR_COMMAND_ARGUMENT_INVALID; \
1406 *ul = func(str, &end, 0); \
1408 LOG_ERROR("Invalid command argument"); \
1409 return ERROR_COMMAND_ARGUMENT_INVALID; \
1411 if ((max == *ul) && (ERANGE == errno)) { \
1412 LOG_ERROR("Argument overflow"); \
1413 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1415 if (min && (min == *ul) && (ERANGE == errno)) { \
1416 LOG_ERROR("Argument underflow"); \
1417 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1421 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1422 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1423 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1424 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1426 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1427 int parse ## name(const char *str, type * ul) \
1430 int retval = parse ## funcname(str, &n); \
1431 if (ERROR_OK != retval) \
1434 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1436 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1441 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1442 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1443 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1444 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1445 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1446 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1447 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1449 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1451 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1452 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1453 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1454 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1455 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1456 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1457 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1459 static int command_parse_bool(const char *in
, bool *out
,
1460 const char *on
, const char *off
)
1462 if (strcasecmp(in
, on
) == 0)
1464 else if (strcasecmp(in
, off
) == 0)
1467 return ERROR_COMMAND_SYNTAX_ERROR
;
1471 int command_parse_bool_arg(const char *in
, bool *out
)
1473 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1475 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1477 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1479 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1481 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1483 return ERROR_COMMAND_SYNTAX_ERROR
;
1486 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1490 const char *in
= CMD_ARGV
[0];
1491 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1492 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1493 return ERROR_COMMAND_SYNTAX_ERROR
;
1498 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1501 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)