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
);
121 * FIXME: workaround for memory leak in jimtcl 0.80
122 * Jim API Jim_CreateCommand() converts the command name in a Jim object and
123 * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
124 * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
125 * and override the bugged API through preprocessor's macro.
126 * This workaround works only when jimtcl is compiled as OpenOCD submodule.
127 * If jimtcl is linked-in from a precompiled library, either static or dynamic,
128 * the symbol Jim_CreateCommandObj is not exported and the build will use the
130 * To be removed when OpenOCD will switch to jimtcl 0.81
132 #if JIM_VERSION == 80
133 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
134 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
);
135 int Jim_CreateCommandObj(Jim_Interp
*interp
, Jim_Obj
*cmdNameObj
,
136 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
137 __attribute__((weak
, alias("workaround_createcommand")));
138 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
139 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
141 if ((void *)Jim_CreateCommandObj
== (void *)workaround_createcommand
)
142 return Jim_CreateCommand(interp
, cmdName
, cmdProc
, privData
, delProc
);
144 Jim_Obj
*cmd_name
= Jim_NewStringObj(interp
, cmdName
, -1);
145 Jim_IncrRefCount(cmd_name
);
146 int retval
= Jim_CreateCommandObj(interp
, cmd_name
, cmdProc
, privData
, delProc
);
147 Jim_DecrRefCount(interp
, cmd_name
);
150 #define Jim_CreateCommand workaround_createcommand
151 #endif /* JIM_VERSION == 80 */
152 /* FIXME: end of workaround for memory leak in jimtcl 0.80 */
154 static int command_retval_set(Jim_Interp
*interp
, int retval
)
156 int *return_retval
= Jim_GetAssocData(interp
, "retval");
157 if (return_retval
!= NULL
)
158 *return_retval
= retval
;
160 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
163 extern struct command_context
*global_cmd_ctx
;
165 /* dump a single line to the log for the command.
166 * Do nothing in case we are not at debug level 3 */
167 void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
169 if (debug_level
< LOG_LVL_DEBUG
)
172 char *dbg
= alloc_printf("command -");
173 for (unsigned i
= 0; i
< argc
; i
++) {
175 const char *w
= Jim_GetString(argv
[i
], &len
);
176 char *t
= alloc_printf("%s %s", dbg
, w
);
180 LOG_DEBUG("%s", dbg
);
184 static void script_command_args_free(char **words
, unsigned nwords
)
186 for (unsigned i
= 0; i
< nwords
; i
++)
191 static char **script_command_args_alloc(
192 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
194 char **words
= malloc(argc
* sizeof(char *));
199 for (i
= 0; i
< argc
; i
++) {
201 const char *w
= Jim_GetString(argv
[i
], &len
);
202 words
[i
] = strdup(w
);
203 if (words
[i
] == NULL
) {
204 script_command_args_free(words
, i
);
212 struct command_context
*current_command_context(Jim_Interp
*interp
)
214 /* grab the command context from the associated data */
215 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
216 if (NULL
== cmd_ctx
) {
217 /* Tcl can invoke commands directly instead of via command_run_line(). This would
218 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
219 * commands in a startup script.
221 * A telnet or gdb server would provide a non-default command context to
222 * handle piping of error output, have a separate current target, etc.
224 cmd_ctx
= global_cmd_ctx
;
229 static int script_command_run(Jim_Interp
*interp
,
230 int argc
, Jim_Obj
* const *argv
, struct command
*c
)
232 target_call_timer_callbacks_now();
233 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
236 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
240 struct command_context
*cmd_ctx
= current_command_context(interp
);
241 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
243 script_command_args_free(words
, nwords
);
244 return command_retval_set(interp
, retval
);
247 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
249 /* the private data is stashed in the interp structure */
251 struct command
*c
= interp
->cmdPrivData
;
253 script_debug(interp
, argc
, argv
);
254 return script_command_run(interp
, argc
, argv
, c
);
257 static struct command
*command_root(struct command
*c
)
259 while (NULL
!= c
->parent
)
265 * Find a command by name from a list of commands.
266 * @returns Returns the named command if it exists in the list.
267 * Returns NULL otherwise.
269 static struct command
*command_find(struct command
*head
, const char *name
)
271 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
272 if (strcmp(cc
->name
, name
) == 0)
278 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
281 return command_find(cmd_ctx
->commands
, name
);
285 * Add the command into the linked list, sorted by name.
286 * @param head Address to head of command list pointer, which may be
287 * updated if @c c gets inserted at the beginning of the list.
288 * @param c The command to add to the list pointed to by @c head.
290 static void command_add_child(struct command
**head
, struct command
*c
)
298 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
299 head
= &(*head
)->next
;
301 if (strcmp(c
->name
, (*head
)->name
) > 0) {
302 c
->next
= (*head
)->next
;
310 static struct command
**command_list_for_parent(
311 struct command_context
*cmd_ctx
, struct command
*parent
)
313 return parent
? &parent
->children
: &cmd_ctx
->commands
;
316 static void command_free(struct command
*c
)
318 /** @todo if command has a handler, unregister its jim command! */
320 while (NULL
!= c
->children
) {
321 struct command
*tmp
= c
->children
;
322 c
->children
= tmp
->next
;
332 static struct command
*command_new(struct command_context
*cmd_ctx
,
333 struct command
*parent
, const struct command_registration
*cr
)
338 * If it is a non-jim command with no .usage specified,
341 * strlen(.usage) == 0 means that the command takes no
344 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
345 LOG_ERROR("BUG: command '%s%s%s' does not have the "
346 "'.usage' field filled out",
347 parent
&& parent
->name
? parent
->name
: "",
348 parent
&& parent
->name
? " " : "",
352 struct command
*c
= calloc(1, sizeof(struct command
));
356 c
->name
= strdup(cr
->name
);
358 c
->help
= strdup(cr
->help
);
360 c
->usage
= strdup(cr
->usage
);
362 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
363 goto command_new_error
;
366 c
->handler
= cr
->handler
;
367 c
->jim_handler
= cr
->jim_handler
;
370 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
379 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
381 static int register_command_handler(struct command_context
*cmd_ctx
,
384 Jim_Interp
*interp
= cmd_ctx
->interp
;
387 LOG_DEBUG("registering '%s'...", c
->name
);
390 Jim_CmdProc
*func
= c
->handler
? &script_command
: &command_unknown
;
391 int retval
= Jim_CreateCommand(interp
, c
->name
, func
, c
, NULL
);
396 static struct command
*register_command(struct command_context
*context
,
397 struct command
*parent
, const struct command_registration
*cr
)
399 if (!context
|| !cr
->name
)
402 const char *name
= cr
->name
;
403 struct command
**head
= command_list_for_parent(context
, parent
);
404 struct command
*c
= command_find(*head
, name
);
406 /* TODO: originally we treated attempting to register a cmd twice as an error
407 * Sometimes we need this behaviour, such as with flash banks.
408 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
409 LOG_DEBUG("command '%s' is already registered in '%s' context",
410 name
, parent
? parent
->name
: "<global>");
414 c
= command_new(context
, parent
, cr
);
419 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
420 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
421 cr
->jim_handler
, NULL
, NULL
);
422 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
423 retval
= register_command_handler(context
, command_root(c
));
425 if (retval
!= JIM_OK
) {
426 unregister_command(context
, parent
, name
);
432 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
433 const struct command_registration
*cmds
)
435 int retval
= ERROR_OK
;
437 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
438 const struct command_registration
*cr
= cmds
+ i
;
440 struct command
*c
= NULL
;
441 if (NULL
!= cr
->name
) {
442 c
= register_command(cmd_ctx
, parent
, cr
);
448 if (NULL
!= cr
->chain
) {
449 struct command
*p
= c
? : parent
;
450 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
451 if (ERROR_OK
!= retval
)
455 if (ERROR_OK
!= retval
) {
456 for (unsigned j
= 0; j
< i
; j
++)
457 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
462 int unregister_all_commands(struct command_context
*context
,
463 struct command
*parent
)
468 struct command
**head
= command_list_for_parent(context
, parent
);
469 while (NULL
!= *head
) {
470 struct command
*tmp
= *head
;
478 static int unregister_command(struct command_context
*context
,
479 struct command
*parent
, const char *name
)
481 if ((!context
) || (!name
))
482 return ERROR_COMMAND_SYNTAX_ERROR
;
484 struct command
*p
= NULL
;
485 struct command
**head
= command_list_for_parent(context
, parent
);
486 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
487 if (strcmp(name
, c
->name
) != 0)
502 void command_set_handler_data(struct command
*c
, void *p
)
504 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
505 c
->jim_handler_data
= p
;
506 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
507 command_set_handler_data(cc
, p
);
510 void command_output_text(struct command_context
*context
, const char *data
)
512 if (context
&& context
->output_handler
&& data
)
513 context
->output_handler(context
, data
);
516 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
521 va_start(ap
, format
);
523 string
= alloc_vprintf(format
, ap
);
524 if (string
!= NULL
&& cmd
) {
525 /* we want this collected in the log + we also want to pick it up as a tcl return
528 * The latter bit isn't precisely neat, but will do for now.
530 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
531 /* We already printed it above
532 * command_output_text(context, string); */
539 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
544 va_start(ap
, format
);
546 string
= alloc_vprintf(format
, ap
);
547 if (string
!= NULL
&& cmd
) {
548 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
550 /* we want this collected in the log + we also want to pick it up as a tcl return
553 * The latter bit isn't precisely neat, but will do for now.
555 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
556 /* We already printed it above
557 * command_output_text(context, string); */
564 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
567 unsigned len
= strlen(c
->name
);
568 if (NULL
== c
->parent
) {
569 /* allocate enough for the name, child names, and '\0' */
570 name
= malloc(len
+ extra
+ 1);
572 LOG_ERROR("Out of memory");
575 strcpy(name
, c
->name
);
577 /* parent's extra must include both the space and name */
578 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
579 char dstr
[2] = { delim
, 0 };
581 strcat(name
, c
->name
);
586 static char *command_name(struct command
*c
, char delim
)
588 return __command_name(c
, delim
, 0);
591 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
593 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
596 /* Many commands may be run only before/after 'init' */
605 /* handle the impossible with humor; it guarantees a bug report! */
607 when
= "if Cthulhu is summoned by";
610 char *full_name
= command_name(c
, ' ');
611 LOG_ERROR("The '%s' command must be used %s 'init'.",
612 full_name
? full_name
: c
->name
, when
);
617 static int run_command(struct command_context
*context
,
618 struct command
*c
, const char *words
[], unsigned num_words
)
620 if (!command_can_run(context
, c
))
623 struct command_invocation cmd
= {
627 .argc
= num_words
- 1,
630 /* Black magic of overridden current target:
631 * If the command we are going to handle has a target prefix,
632 * override the current target temporarily for the time
633 * of processing the command.
634 * current_target_override is used also for event handlers
635 * therefore we prevent touching it if command has no prefix.
636 * Previous override is saved and restored back to ensure
637 * correct work when run_command() is re-entered. */
638 struct target
*saved_target_override
= context
->current_target_override
;
639 if (c
->jim_handler_data
)
640 context
->current_target_override
= c
->jim_handler_data
;
642 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
643 Jim_IncrRefCount(cmd
.output
);
645 int retval
= c
->handler(&cmd
);
647 if (c
->jim_handler_data
)
648 context
->current_target_override
= saved_target_override
;
650 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
651 /* Print help for command */
652 char *full_name
= command_name(c
, ' ');
653 if (NULL
!= full_name
) {
654 command_run_linef(context
, "usage %s", full_name
);
657 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
658 /* just fall through for a shutdown request */
660 if (retval
!= ERROR_OK
) {
661 char *full_name
= command_name(c
, ' ');
662 LOG_DEBUG("Command '%s' failed with error code %d",
663 full_name
? full_name
: c
->name
, retval
);
666 /* Use the command output as the Tcl result */
667 Jim_SetResult(context
->interp
, cmd
.output
);
669 Jim_DecrRefCount(context
->interp
, cmd
.output
);
674 int command_run_line(struct command_context
*context
, char *line
)
676 /* all the parent commands have been registered with the interpreter
677 * so, can just evaluate the line as a script and check for
680 /* run the line thru a script engine */
681 int retval
= ERROR_FAIL
;
683 /* Beware! This code needs to be reentrant. It is also possible
684 * for OpenOCD commands to be invoked directly from Tcl. This would
685 * happen when the Jim Tcl interpreter is provided by eCos for
688 struct target
*saved_target_override
= context
->current_target_override
;
689 context
->current_target_override
= NULL
;
691 Jim_Interp
*interp
= context
->interp
;
692 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
693 Jim_DeleteAssocData(interp
, "context");
694 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
695 if (retcode
== JIM_OK
) {
696 /* associated the return value */
697 Jim_DeleteAssocData(interp
, "retval");
698 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
699 if (retcode
== JIM_OK
) {
700 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
702 Jim_DeleteAssocData(interp
, "retval");
704 Jim_DeleteAssocData(interp
, "context");
705 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
706 if (retcode
== JIM_OK
)
707 retcode
= inner_retcode
;
709 context
->current_target_override
= saved_target_override
;
710 if (retcode
== JIM_OK
) {
714 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
716 command_output_text(context
, result
);
717 command_output_text(context
, "\n");
720 } else if (retcode
== JIM_EXIT
) {
722 * exit(Jim_GetExitCode(interp)); */
723 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
726 Jim_MakeErrorMessage(interp
);
727 /* error is broadcast */
728 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
730 if (retval
== ERROR_OK
) {
731 /* It wasn't a low level OpenOCD command that failed */
740 int command_run_linef(struct command_context
*context
, const char *format
, ...)
742 int retval
= ERROR_FAIL
;
745 va_start(ap
, format
);
746 string
= alloc_vprintf(format
, ap
);
747 if (string
!= NULL
) {
748 retval
= command_run_line(context
, string
);
755 void command_set_output_handler(struct command_context
*context
,
756 command_output_handler_t output_handler
, void *priv
)
758 context
->output_handler
= output_handler
;
759 context
->output_handler_priv
= priv
;
762 struct command_context
*copy_command_context(struct command_context
*context
)
764 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
766 *copy_context
= *context
;
771 void command_done(struct command_context
*cmd_ctx
)
779 /* find full path to file */
780 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
784 const char *file
= Jim_GetString(argv
[1], NULL
);
785 char *full_path
= find_file(file
);
786 if (full_path
== NULL
)
788 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
791 Jim_SetResult(interp
, result
);
795 COMMAND_HANDLER(jim_echo
)
797 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
798 LOG_USER_N("%s", CMD_ARGV
[1]);
803 LOG_USER("%s", CMD_ARGV
[0]);
807 /* Capture progress output and return as tcl return value. If the
808 * progress output was empty, return tcl return value.
810 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
815 struct log_capture_state
*state
= command_log_capture_start(interp
);
817 /* disable polling during capture. This avoids capturing output
820 * This is necessary in order to avoid accidentally getting a non-empty
821 * string for tcl fn's.
823 bool save_poll
= jtag_poll_get_enabled();
825 jtag_poll_set_enabled(false);
827 const char *str
= Jim_GetString(argv
[1], NULL
);
828 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
830 jtag_poll_set_enabled(save_poll
);
832 command_log_capture_finish(state
);
837 static COMMAND_HELPER(command_help_find
, struct command
*head
,
838 struct command
**out
)
841 return ERROR_COMMAND_SYNTAX_ERROR
;
842 *out
= command_find(head
, CMD_ARGV
[0]);
844 return ERROR_COMMAND_SYNTAX_ERROR
;
848 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
851 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
852 bool show_help
, const char *cmd_match
);
854 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
855 bool show_help
, const char *cmd_match
)
857 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
858 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
862 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
864 static void command_help_show_indent(unsigned n
)
866 for (unsigned i
= 0; i
< n
; i
++)
869 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
871 const char *cp
= str
, *last
= str
;
873 const char *next
= last
;
878 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
879 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
880 if (next
- last
< HELP_LINE_WIDTH(n
))
882 command_help_show_indent(n
);
883 LOG_USER("%.*s", (int)(cp
- last
), last
);
889 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
890 bool show_help
, const char *cmd_match
)
892 char *cmd_name
= command_name(c
, ' ');
893 if (NULL
== cmd_name
)
896 /* If the match string occurs anywhere, we print out
897 * stuff for this command. */
898 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
899 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
900 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
903 command_help_show_indent(n
);
904 LOG_USER_N("%s", cmd_name
);
909 if (c
->usage
&& strlen(c
->usage
) > 0) {
911 command_help_show_wrap(c
->usage
, 0, n
+ 5);
916 if (is_match
&& show_help
) {
919 /* Normal commands are runtime-only; highlight exceptions */
920 if (c
->mode
!= COMMAND_EXEC
) {
921 const char *stage_msg
= "";
925 stage_msg
= " (configuration command)";
928 stage_msg
= " (command valid any time)";
931 stage_msg
= " (?mode error?)";
934 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
936 msg
= alloc_printf("%s", c
->help
? : "");
939 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
946 LOG_ERROR("command recursion exceeded");
950 return CALL_COMMAND_HANDLER(command_help_show_list
,
951 c
->children
, n
, show_help
, cmd_match
);
954 COMMAND_HANDLER(handle_help_command
)
956 bool full
= strcmp(CMD_NAME
, "help") == 0;
958 struct command
*c
= CMD_CTX
->commands
;
962 cmd_match
= strdup("");
965 cmd_match
= strdup(CMD_ARGV
[0]);
967 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
968 char *prev
= cmd_match
;
969 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
974 if (cmd_match
== NULL
) {
975 LOG_ERROR("unable to build search string");
978 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
979 c
, 0, full
, cmd_match
);
985 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
986 struct command
*head
, struct command
**out
)
990 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
991 struct command
*c
= command_find(head
, cmd_name
);
995 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
998 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
1005 all
= strdup(Jim_GetString(argv
[0], NULL
));
1007 LOG_ERROR("Out of memory");
1011 for (i
= 1; i
< argc
; ++i
) {
1013 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
1016 LOG_ERROR("Out of memory");
1024 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
1026 struct command_context
*cmd_ctx
= current_command_context(interp
);
1030 assert(argc_valid
>= 1);
1031 assert(argc
>= argc_valid
);
1033 command
= alloc_concatenate_strings(argc_valid
, argv
);
1037 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
1038 if (retval
!= ERROR_OK
) {
1039 LOG_ERROR("unable to execute command \"usage %s\"", command
);
1043 if (argc_valid
== argc
)
1044 LOG_ERROR("%s: command requires more arguments", command
);
1047 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
1050 LOG_ERROR("invalid subcommand \"%s\"", command
);
1057 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1059 script_debug(interp
, argc
, argv
);
1061 struct command_context
*cmd_ctx
= current_command_context(interp
);
1062 struct command
*c
= cmd_ctx
->commands
;
1063 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1064 /* if nothing could be consumed, then it's really an unknown command */
1065 if (remaining
== argc
) {
1066 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1067 LOG_ERROR("Unknown command:\n %s", cmd
);
1071 Jim_Obj
*const *start
;
1073 if (c
->handler
|| c
->jim_handler
) {
1074 /* include the command name in the list */
1075 count
= remaining
+ 1;
1076 start
= argv
+ (argc
- remaining
- 1);
1078 count
= argc
- remaining
;
1080 run_usage(interp
, count
, argc
, start
);
1083 /* pass the command through to the intended handler */
1084 if (c
->jim_handler
) {
1085 if (!command_can_run(cmd_ctx
, c
))
1088 interp
->cmdPrivData
= c
->jim_handler_data
;
1089 return (*c
->jim_handler
)(interp
, count
, start
);
1092 return script_command_run(interp
, count
, start
, c
);
1095 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1097 struct command_context
*cmd_ctx
= current_command_context(interp
);
1098 enum command_mode mode
;
1101 struct command
*c
= cmd_ctx
->commands
;
1102 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1103 /* if nothing could be consumed, then it's an unknown command */
1104 if (remaining
== argc
- 1) {
1105 Jim_SetResultString(interp
, "unknown", -1);
1110 mode
= cmd_ctx
->mode
;
1112 const char *mode_str
;
1117 case COMMAND_CONFIG
:
1118 mode_str
= "config";
1124 mode_str
= "unknown";
1127 Jim_SetResultString(interp
, mode_str
, -1);
1131 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1132 const char *cmd_name
, const char *help_text
, const char *usage
)
1134 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1135 struct command
*nc
= command_find(*head
, cmd_name
);
1137 /* add a new command with help text */
1138 struct command_registration cr
= {
1140 .mode
= COMMAND_ANY
,
1142 .usage
= usage
? : "",
1144 nc
= register_command(cmd_ctx
, parent
, &cr
);
1146 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1149 LOG_DEBUG("added '%s' help text", cmd_name
);
1153 bool replaced
= false;
1158 nc
->help
= strdup(help_text
);
1160 LOG_INFO("replaced existing '%s' help", cmd_name
);
1162 LOG_DEBUG("added '%s' help text", cmd_name
);
1165 bool replaced
= false;
1171 nc
->usage
= strdup(usage
);
1173 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1175 LOG_DEBUG("added '%s' usage text", cmd_name
);
1180 COMMAND_HANDLER(handle_help_add_command
)
1183 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1184 return ERROR_COMMAND_SYNTAX_ERROR
;
1187 /* save help text and remove it from argument list */
1188 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1189 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1190 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1191 if (!help
&& !usage
) {
1192 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1193 return ERROR_COMMAND_SYNTAX_ERROR
;
1195 /* likewise for the leaf command name */
1196 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1198 struct command
*c
= NULL
;
1200 c
= CMD_CTX
->commands
;
1201 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1202 if (ERROR_OK
!= retval
)
1205 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1208 /* sleep command sleeps for <n> milliseconds
1209 * this is useful in target startup scripts
1211 COMMAND_HANDLER(handle_sleep_command
)
1214 if (CMD_ARGC
== 2) {
1215 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1218 return ERROR_COMMAND_SYNTAX_ERROR
;
1219 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1220 return ERROR_COMMAND_SYNTAX_ERROR
;
1222 unsigned long duration
= 0;
1223 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1224 if (ERROR_OK
!= retval
)
1228 int64_t then
= timeval_ms();
1229 while (timeval_ms() - then
< (int64_t)duration
) {
1230 target_call_timer_callbacks_now();
1234 busy_sleep(duration
);
1239 static const struct command_registration command_subcommand_handlers
[] = {
1242 .mode
= COMMAND_ANY
,
1243 .jim_handler
= jim_command_mode
,
1244 .usage
= "[command_name ...]",
1245 .help
= "Returns the command modes allowed by a command: "
1246 "'any', 'config', or 'exec'. If no command is "
1247 "specified, returns the current command mode. "
1248 "Returns 'unknown' if an unknown command is given. "
1249 "Command can be multiple tokens.",
1251 COMMAND_REGISTRATION_DONE
1254 static const struct command_registration command_builtin_handlers
[] = {
1257 .mode
= COMMAND_ANY
,
1258 .jim_handler
= jim_find
,
1259 .help
= "find full path to file",
1264 .mode
= COMMAND_ANY
,
1265 .jim_handler
= jim_capture
,
1266 .help
= "Capture progress output and return as tcl return value. If the "
1267 "progress output was empty, return tcl return value.",
1272 .handler
= jim_echo
,
1273 .mode
= COMMAND_ANY
,
1274 .help
= "Logs a message at \"user\" priority. "
1275 "Output message to stdout. "
1276 "Option \"-n\" suppresses trailing newline",
1277 .usage
= "[-n] string",
1280 .name
= "add_help_text",
1281 .handler
= handle_help_add_command
,
1282 .mode
= COMMAND_ANY
,
1283 .help
= "Add new command help text; "
1284 "Command can be multiple tokens.",
1285 .usage
= "command_name helptext_string",
1288 .name
= "add_usage_text",
1289 .handler
= handle_help_add_command
,
1290 .mode
= COMMAND_ANY
,
1291 .help
= "Add new command usage text; "
1292 "command can be multiple tokens.",
1293 .usage
= "command_name usage_string",
1297 .handler
= handle_sleep_command
,
1298 .mode
= COMMAND_ANY
,
1299 .help
= "Sleep for specified number of milliseconds. "
1300 "\"busy\" will busy wait instead (avoid this).",
1301 .usage
= "milliseconds ['busy']",
1305 .handler
= handle_help_command
,
1306 .mode
= COMMAND_ANY
,
1307 .help
= "Show full command help; "
1308 "command can be multiple tokens.",
1309 .usage
= "[command_name]",
1313 .handler
= handle_help_command
,
1314 .mode
= COMMAND_ANY
,
1315 .help
= "Show basic command usage; "
1316 "command can be multiple tokens.",
1317 .usage
= "[command_name]",
1321 .mode
= COMMAND_ANY
,
1322 .help
= "core command group (introspection)",
1323 .chain
= command_subcommand_handlers
,
1326 COMMAND_REGISTRATION_DONE
1329 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1331 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1334 context
->mode
= COMMAND_EXEC
;
1336 /* Create a jim interpreter if we were not handed one */
1337 if (interp
== NULL
) {
1338 /* Create an interpreter */
1339 interp
= Jim_CreateInterp();
1340 /* Add all the Jim core commands */
1341 Jim_RegisterCoreCommands(interp
);
1342 Jim_InitStaticExtensions(interp
);
1345 context
->interp
= interp
;
1347 /* Stick to lowercase for HostOS strings. */
1348 #if defined(_MSC_VER)
1349 /* WinXX - is generic, the forward
1350 * looking problem is this:
1352 * "win32" or "win64"
1354 * "winxx" is generic.
1357 #elif defined(__linux__)
1359 #elif defined(__APPLE__) || defined(__DARWIN__)
1361 #elif defined(__CYGWIN__)
1363 #elif defined(__MINGW32__)
1365 #elif defined(__ECOS)
1367 #elif defined(__FreeBSD__)
1369 #elif defined(__NetBSD__)
1371 #elif defined(__OpenBSD__)
1374 #warning "Unrecognized host OS..."
1377 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1378 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1380 register_commands(context
, NULL
, command_builtin_handlers
);
1382 Jim_SetAssocData(interp
, "context", NULL
, context
);
1383 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1384 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1385 Jim_MakeErrorMessage(interp
);
1386 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1389 Jim_DeleteAssocData(interp
, "context");
1394 void command_exit(struct command_context
*context
)
1399 Jim_FreeInterp(context
->interp
);
1400 command_done(context
);
1403 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1406 return ERROR_COMMAND_SYNTAX_ERROR
;
1408 cmd_ctx
->mode
= mode
;
1412 void process_jim_events(struct command_context
*cmd_ctx
)
1414 static int recursion
;
1419 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1423 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1424 int parse ## name(const char *str, type * ul) \
1427 LOG_ERROR("Invalid command argument"); \
1428 return ERROR_COMMAND_ARGUMENT_INVALID; \
1432 *ul = func(str, &end, 0); \
1434 LOG_ERROR("Invalid command argument"); \
1435 return ERROR_COMMAND_ARGUMENT_INVALID; \
1437 if ((max == *ul) && (ERANGE == errno)) { \
1438 LOG_ERROR("Argument overflow"); \
1439 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1441 if (min && (min == *ul) && (ERANGE == errno)) { \
1442 LOG_ERROR("Argument underflow"); \
1443 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1447 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1448 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1449 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1450 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1452 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1453 int parse ## name(const char *str, type * ul) \
1456 int retval = parse ## funcname(str, &n); \
1457 if (ERROR_OK != retval) \
1460 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1462 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1467 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1468 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1469 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1470 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1471 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1472 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1473 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1475 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1477 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1478 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1479 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1480 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1481 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1482 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1483 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1485 static int command_parse_bool(const char *in
, bool *out
,
1486 const char *on
, const char *off
)
1488 if (strcasecmp(in
, on
) == 0)
1490 else if (strcasecmp(in
, off
) == 0)
1493 return ERROR_COMMAND_SYNTAX_ERROR
;
1497 int command_parse_bool_arg(const char *in
, bool *out
)
1499 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1501 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1503 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1505 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1507 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1509 return ERROR_COMMAND_SYNTAX_ERROR
;
1512 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1516 const char *in
= CMD_ARGV
[0];
1517 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1518 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1519 return ERROR_COMMAND_SYNTAX_ERROR
;
1524 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1527 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)