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 void tcl_output(void *privData
, const char *file
, unsigned line
,
56 const char *function
, const char *string
)
58 struct log_capture_state
*state
= privData
;
59 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
62 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
64 /* capture log output and return it. A garbage collect can
65 * happen, so we need a reference count to this object */
66 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
67 if (NULL
== tclOutput
)
70 struct log_capture_state
*state
= malloc(sizeof(*state
));
74 state
->interp
= interp
;
75 Jim_IncrRefCount(tclOutput
);
76 state
->output
= tclOutput
;
78 log_add_callback(tcl_output
, state
);
83 /* Classic openocd commands provide progress output which we
84 * will capture and return as a Tcl return value.
86 * However, if a non-openocd command has been invoked, then it
87 * makes sense to return the tcl return value from that command.
89 * The tcl return value is empty for openocd commands that provide
92 * Therefore we set the tcl return value only if we actually
95 static void command_log_capture_finish(struct log_capture_state
*state
)
100 log_remove_callback(tcl_output
, state
);
103 Jim_GetString(state
->output
, &length
);
106 Jim_SetResult(state
->interp
, state
->output
);
108 /* No output captured, use tcl return value (which could
111 Jim_DecrRefCount(state
->interp
, state
->output
);
116 static int command_retval_set(Jim_Interp
*interp
, int retval
)
118 int *return_retval
= Jim_GetAssocData(interp
, "retval");
119 if (return_retval
!= NULL
)
120 *return_retval
= retval
;
122 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
125 extern struct command_context
*global_cmd_ctx
;
127 /* dump a single line to the log for the command.
128 * Do nothing in case we are not at debug level 3 */
129 void script_debug(Jim_Interp
*interp
, const char *name
,
130 unsigned argc
, Jim_Obj
* const *argv
)
132 if (debug_level
< LOG_LVL_DEBUG
)
135 char *dbg
= alloc_printf("command - %s", name
);
136 for (unsigned i
= 0; i
< argc
; i
++) {
138 const char *w
= Jim_GetString(argv
[i
], &len
);
139 char *t
= alloc_printf("%s %s", dbg
, w
);
143 LOG_DEBUG("%s", dbg
);
147 static void script_command_args_free(char **words
, unsigned nwords
)
149 for (unsigned i
= 0; i
< nwords
; i
++)
154 static char **script_command_args_alloc(
155 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
157 char **words
= malloc(argc
* sizeof(char *));
162 for (i
= 0; i
< argc
; i
++) {
164 const char *w
= Jim_GetString(argv
[i
], &len
);
165 words
[i
] = strdup(w
);
166 if (words
[i
] == NULL
) {
167 script_command_args_free(words
, i
);
175 struct command_context
*current_command_context(Jim_Interp
*interp
)
177 /* grab the command context from the associated data */
178 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
179 if (NULL
== cmd_ctx
) {
180 /* Tcl can invoke commands directly instead of via command_run_line(). This would
181 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
182 * commands in a startup script.
184 * A telnet or gdb server would provide a non-default command context to
185 * handle piping of error output, have a separate current target, etc.
187 cmd_ctx
= global_cmd_ctx
;
192 static int script_command_run(Jim_Interp
*interp
,
193 int argc
, Jim_Obj
* const *argv
, struct command
*c
)
195 target_call_timer_callbacks_now();
196 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
199 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
203 struct command_context
*cmd_ctx
= current_command_context(interp
);
204 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
206 script_command_args_free(words
, nwords
);
207 return command_retval_set(interp
, retval
);
210 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
212 /* the private data is stashed in the interp structure */
214 struct command
*c
= interp
->cmdPrivData
;
216 script_debug(interp
, c
->name
, argc
, argv
);
217 return script_command_run(interp
, argc
, argv
, c
);
220 static struct command
*command_root(struct command
*c
)
222 while (NULL
!= c
->parent
)
228 * Find a command by name from a list of commands.
229 * @returns Returns the named command if it exists in the list.
230 * Returns NULL otherwise.
232 static struct command
*command_find(struct command
*head
, const char *name
)
234 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
235 if (strcmp(cc
->name
, name
) == 0)
241 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
244 return command_find(cmd_ctx
->commands
, name
);
246 struct command
*command_find_in_parent(struct command
*parent
,
249 return command_find(parent
->children
, name
);
253 * Add the command into the linked list, sorted by name.
254 * @param head Address to head of command list pointer, which may be
255 * updated if @c c gets inserted at the beginning of the list.
256 * @param c The command to add to the list pointed to by @c head.
258 static void command_add_child(struct command
**head
, struct command
*c
)
266 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
267 head
= &(*head
)->next
;
269 if (strcmp(c
->name
, (*head
)->name
) > 0) {
270 c
->next
= (*head
)->next
;
278 static struct command
**command_list_for_parent(
279 struct command_context
*cmd_ctx
, struct command
*parent
)
281 return parent
? &parent
->children
: &cmd_ctx
->commands
;
284 static void command_free(struct command
*c
)
286 /** @todo if command has a handler, unregister its jim command! */
288 while (NULL
!= c
->children
) {
289 struct command
*tmp
= c
->children
;
290 c
->children
= tmp
->next
;
300 static struct command
*command_new(struct command_context
*cmd_ctx
,
301 struct command
*parent
, const struct command_registration
*cr
)
306 * If it is a non-jim command with no .usage specified,
309 * strlen(.usage) == 0 means that the command takes no
312 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
313 LOG_ERROR("BUG: command '%s%s%s' does not have the "
314 "'.usage' field filled out",
315 parent
&& parent
->name
? parent
->name
: "",
316 parent
&& parent
->name
? " " : "",
320 struct command
*c
= calloc(1, sizeof(struct command
));
324 c
->name
= strdup(cr
->name
);
326 c
->help
= strdup(cr
->help
);
328 c
->usage
= strdup(cr
->usage
);
330 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
331 goto command_new_error
;
334 c
->handler
= cr
->handler
;
335 c
->jim_handler
= cr
->jim_handler
;
336 c
->jim_handler_data
= cr
->jim_handler_data
;
339 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
348 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
350 static int register_command_handler(struct command_context
*cmd_ctx
,
353 Jim_Interp
*interp
= cmd_ctx
->interp
;
355 LOG_DEBUG("registering '%s'...", c
->name
);
357 Jim_CmdProc
*func
= c
->handler
? &script_command
: &command_unknown
;
358 int retval
= Jim_CreateCommand(interp
, c
->name
, func
, c
, NULL
);
363 struct command
*register_command(struct command_context
*context
,
364 struct command
*parent
, const struct command_registration
*cr
)
366 if (!context
|| !cr
->name
)
369 const char *name
= cr
->name
;
370 struct command
**head
= command_list_for_parent(context
, parent
);
371 struct command
*c
= command_find(*head
, name
);
373 /* TODO: originally we treated attempting to register a cmd twice as an error
374 * Sometimes we need this behaviour, such as with flash banks.
375 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
376 LOG_DEBUG("command '%s' is already registered in '%s' context",
377 name
, parent
? parent
->name
: "<global>");
381 c
= command_new(context
, parent
, cr
);
385 int retval
= ERROR_OK
;
386 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
387 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
388 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
389 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
390 retval
= register_command_handler(context
, command_root(c
));
392 if (ERROR_OK
!= retval
) {
393 unregister_command(context
, parent
, name
);
399 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
400 const struct command_registration
*cmds
)
402 int retval
= ERROR_OK
;
404 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
405 const struct command_registration
*cr
= cmds
+ i
;
407 struct command
*c
= NULL
;
408 if (NULL
!= cr
->name
) {
409 c
= register_command(cmd_ctx
, parent
, cr
);
415 if (NULL
!= cr
->chain
) {
416 struct command
*p
= c
? : parent
;
417 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
418 if (ERROR_OK
!= retval
)
422 if (ERROR_OK
!= retval
) {
423 for (unsigned j
= 0; j
< i
; j
++)
424 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
429 int unregister_all_commands(struct command_context
*context
,
430 struct command
*parent
)
435 struct command
**head
= command_list_for_parent(context
, parent
);
436 while (NULL
!= *head
) {
437 struct command
*tmp
= *head
;
445 int unregister_command(struct command_context
*context
,
446 struct command
*parent
, const char *name
)
448 if ((!context
) || (!name
))
449 return ERROR_COMMAND_SYNTAX_ERROR
;
451 struct command
*p
= NULL
;
452 struct command
**head
= command_list_for_parent(context
, parent
);
453 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
454 if (strcmp(name
, c
->name
) != 0)
469 void command_set_handler_data(struct command
*c
, void *p
)
471 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
472 c
->jim_handler_data
= p
;
473 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
474 command_set_handler_data(cc
, p
);
477 void command_output_text(struct command_context
*context
, const char *data
)
479 if (context
&& context
->output_handler
&& data
)
480 context
->output_handler(context
, data
);
483 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
488 va_start(ap
, format
);
490 string
= alloc_vprintf(format
, ap
);
491 if (string
!= NULL
&& cmd
) {
492 /* we want this collected in the log + we also want to pick it up as a tcl return
495 * The latter bit isn't precisely neat, but will do for now.
497 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
498 /* We already printed it above
499 * command_output_text(context, string); */
506 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
511 va_start(ap
, format
);
513 string
= alloc_vprintf(format
, ap
);
514 if (string
!= NULL
&& cmd
) {
515 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
517 /* we want this collected in the log + we also want to pick it up as a tcl return
520 * The latter bit isn't precisely neat, but will do for now.
522 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
523 /* We already printed it above
524 * command_output_text(context, string); */
531 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
534 unsigned len
= strlen(c
->name
);
535 if (NULL
== c
->parent
) {
536 /* allocate enough for the name, child names, and '\0' */
537 name
= malloc(len
+ extra
+ 1);
539 LOG_ERROR("Out of memory");
542 strcpy(name
, c
->name
);
544 /* parent's extra must include both the space and name */
545 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
546 char dstr
[2] = { delim
, 0 };
548 strcat(name
, c
->name
);
553 char *command_name(struct command
*c
, char delim
)
555 return __command_name(c
, delim
, 0);
558 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
560 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
563 /* Many commands may be run only before/after 'init' */
572 /* handle the impossible with humor; it guarantees a bug report! */
574 when
= "if Cthulhu is summoned by";
577 char *full_name
= command_name(c
, ' ');
578 LOG_ERROR("The '%s' command must be used %s 'init'.",
579 full_name
? full_name
: c
->name
, when
);
584 static int run_command(struct command_context
*context
,
585 struct command
*c
, const char *words
[], unsigned num_words
)
587 if (!command_can_run(context
, c
))
590 struct command_invocation cmd
= {
594 .argc
= num_words
- 1,
597 /* Black magic of overridden current target:
598 * If the command we are going to handle has a target prefix,
599 * override the current target temporarily for the time
600 * of processing the command.
601 * current_target_override is used also for event handlers
602 * therefore we prevent touching it if command has no prefix.
603 * Previous override is saved and restored back to ensure
604 * correct work when run_command() is re-entered. */
605 struct target
*saved_target_override
= context
->current_target_override
;
606 if (c
->jim_handler_data
)
607 context
->current_target_override
= c
->jim_handler_data
;
609 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
610 Jim_IncrRefCount(cmd
.output
);
612 int retval
= c
->handler(&cmd
);
614 if (c
->jim_handler_data
)
615 context
->current_target_override
= saved_target_override
;
617 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
618 /* Print help for command */
619 char *full_name
= command_name(c
, ' ');
620 if (NULL
!= full_name
) {
621 command_run_linef(context
, "usage %s", full_name
);
624 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
625 /* just fall through for a shutdown request */
626 } else if (retval
!= ERROR_OK
) {
627 /* we do not print out an error message because the command *should*
628 * have printed out an error
630 char *full_name
= command_name(c
, ' ');
631 LOG_DEBUG("Command '%s' failed with error code %d",
632 full_name
? full_name
: c
->name
, retval
);
635 /* Use the command output as the Tcl result */
636 Jim_SetResult(context
->interp
, cmd
.output
);
638 Jim_DecrRefCount(context
->interp
, cmd
.output
);
643 int command_run_line(struct command_context
*context
, char *line
)
645 /* all the parent commands have been registered with the interpreter
646 * so, can just evaluate the line as a script and check for
649 /* run the line thru a script engine */
650 int retval
= ERROR_FAIL
;
652 /* Beware! This code needs to be reentrant. It is also possible
653 * for OpenOCD commands to be invoked directly from Tcl. This would
654 * happen when the Jim Tcl interpreter is provided by eCos for
657 context
->current_target_override
= NULL
;
659 Jim_Interp
*interp
= context
->interp
;
660 Jim_DeleteAssocData(interp
, "context");
661 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
662 if (retcode
== JIM_OK
) {
663 /* associated the return value */
664 Jim_DeleteAssocData(interp
, "retval");
665 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
666 if (retcode
== JIM_OK
) {
667 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
669 Jim_DeleteAssocData(interp
, "retval");
671 Jim_DeleteAssocData(interp
, "context");
673 if (retcode
== JIM_OK
) {
677 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
681 for (i
= 0; i
< reslen
; i
+= 256) {
686 strncpy(buff
, result
+ i
, chunk
);
688 LOG_USER_N("%s", buff
);
693 } else if (retcode
== JIM_EXIT
) {
695 * exit(Jim_GetExitCode(interp)); */
696 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
699 Jim_MakeErrorMessage(interp
);
700 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
702 if (retval
== ERROR_OK
) {
703 /* It wasn't a low level OpenOCD command that failed */
712 int command_run_linef(struct command_context
*context
, const char *format
, ...)
714 int retval
= ERROR_FAIL
;
717 va_start(ap
, format
);
718 string
= alloc_vprintf(format
, ap
);
719 if (string
!= NULL
) {
720 retval
= command_run_line(context
, string
);
727 void command_set_output_handler(struct command_context
*context
,
728 command_output_handler_t output_handler
, void *priv
)
730 context
->output_handler
= output_handler
;
731 context
->output_handler_priv
= priv
;
734 struct command_context
*copy_command_context(struct command_context
*context
)
736 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
738 *copy_context
= *context
;
743 void command_done(struct command_context
*cmd_ctx
)
751 /* find full path to file */
752 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
756 const char *file
= Jim_GetString(argv
[1], NULL
);
757 char *full_path
= find_file(file
);
758 if (full_path
== NULL
)
760 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
763 Jim_SetResult(interp
, result
);
767 COMMAND_HANDLER(jim_echo
)
769 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
770 LOG_USER_N("%s", CMD_ARGV
[1]);
775 LOG_USER("%s", CMD_ARGV
[0]);
779 /* Capture progress output and return as tcl return value. If the
780 * progress output was empty, return tcl return value.
782 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
787 struct log_capture_state
*state
= command_log_capture_start(interp
);
789 /* disable polling during capture. This avoids capturing output
792 * This is necessary in order to avoid accidentally getting a non-empty
793 * string for tcl fn's.
795 bool save_poll
= jtag_poll_get_enabled();
797 jtag_poll_set_enabled(false);
799 const char *str
= Jim_GetString(argv
[1], NULL
);
800 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
802 jtag_poll_set_enabled(save_poll
);
804 command_log_capture_finish(state
);
809 static COMMAND_HELPER(command_help_find
, struct command
*head
,
810 struct command
**out
)
813 return ERROR_COMMAND_SYNTAX_ERROR
;
814 *out
= command_find(head
, CMD_ARGV
[0]);
815 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
816 *out
= command_find(head
, CMD_ARGV
[0] + 4);
818 return ERROR_COMMAND_SYNTAX_ERROR
;
822 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
825 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
826 bool show_help
, const char *cmd_match
);
828 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
829 bool show_help
, const char *cmd_match
)
831 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
832 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
836 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
838 static void command_help_show_indent(unsigned n
)
840 for (unsigned i
= 0; i
< n
; i
++)
843 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
845 const char *cp
= str
, *last
= str
;
847 const char *next
= last
;
852 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
853 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
854 if (next
- last
< HELP_LINE_WIDTH(n
))
856 command_help_show_indent(n
);
857 LOG_USER("%.*s", (int)(cp
- last
), last
);
863 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
864 bool show_help
, const char *cmd_match
)
866 char *cmd_name
= command_name(c
, ' ');
867 if (NULL
== cmd_name
)
870 /* If the match string occurs anywhere, we print out
871 * stuff for this command. */
872 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
873 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
874 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
877 command_help_show_indent(n
);
878 LOG_USER_N("%s", cmd_name
);
883 if (c
->usage
&& strlen(c
->usage
) > 0) {
885 command_help_show_wrap(c
->usage
, 0, n
+ 5);
890 if (is_match
&& show_help
) {
893 /* Normal commands are runtime-only; highlight exceptions */
894 if (c
->mode
!= COMMAND_EXEC
) {
895 const char *stage_msg
= "";
899 stage_msg
= " (configuration command)";
902 stage_msg
= " (command valid any time)";
905 stage_msg
= " (?mode error?)";
908 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
910 msg
= alloc_printf("%s", c
->help
? : "");
913 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
920 LOG_ERROR("command recursion exceeded");
924 return CALL_COMMAND_HANDLER(command_help_show_list
,
925 c
->children
, n
, show_help
, cmd_match
);
928 COMMAND_HANDLER(handle_help_command
)
930 bool full
= strcmp(CMD_NAME
, "help") == 0;
932 struct command
*c
= CMD_CTX
->commands
;
933 char *cmd_match
= NULL
;
937 else if (CMD_ARGC
>= 1) {
940 for (i
= 0; i
< CMD_ARGC
; ++i
) {
941 if (NULL
!= cmd_match
) {
942 char *prev
= cmd_match
;
944 cmd_match
= alloc_printf("%s %s", cmd_match
, CMD_ARGV
[i
]);
946 if (NULL
== cmd_match
) {
947 LOG_ERROR("unable to build search string");
951 cmd_match
= alloc_printf("%s", CMD_ARGV
[i
]);
952 if (NULL
== cmd_match
) {
953 LOG_ERROR("unable to build search string");
959 return ERROR_COMMAND_SYNTAX_ERROR
;
961 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
962 c
, 0, full
, cmd_match
);
969 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
970 struct command
*head
, struct command
**out
, bool top_level
)
974 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
975 struct command
*c
= command_find(head
, cmd_name
);
976 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
977 c
= command_find(head
, cmd_name
+ 4);
981 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
984 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
986 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
987 if (strcmp(cmd_name
, "unknown") == 0) {
993 script_debug(interp
, cmd_name
, argc
, argv
);
995 struct command_context
*cmd_ctx
= current_command_context(interp
);
996 struct command
*c
= cmd_ctx
->commands
;
997 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
998 /* if nothing could be consumed, then it's really an unknown command */
999 if (remaining
== argc
) {
1000 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1001 LOG_ERROR("Unknown command:\n %s", cmd
);
1005 Jim_Obj
*const *start
;
1007 if (c
->handler
|| c
->jim_handler
) {
1008 /* include the command name in the list */
1009 count
= remaining
+ 1;
1010 start
= argv
+ (argc
- remaining
- 1);
1012 c
= command_find(cmd_ctx
->commands
, "usage");
1014 LOG_ERROR("unknown command, but usage is missing too");
1017 count
= argc
- remaining
;
1020 /* pass the command through to the intended handler */
1021 if (c
->jim_handler
) {
1022 if (!command_can_run(cmd_ctx
, c
))
1025 interp
->cmdPrivData
= c
->jim_handler_data
;
1026 return (*c
->jim_handler
)(interp
, count
, start
);
1029 return script_command_run(interp
, count
, start
, c
);
1032 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1034 struct command_context
*cmd_ctx
= current_command_context(interp
);
1035 enum command_mode mode
;
1038 struct command
*c
= cmd_ctx
->commands
;
1039 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1040 /* if nothing could be consumed, then it's an unknown command */
1041 if (remaining
== argc
- 1) {
1042 Jim_SetResultString(interp
, "unknown", -1);
1047 mode
= cmd_ctx
->mode
;
1049 const char *mode_str
;
1054 case COMMAND_CONFIG
:
1055 mode_str
= "config";
1061 mode_str
= "unknown";
1064 Jim_SetResultString(interp
, mode_str
, -1);
1068 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1069 const char *cmd_name
, const char *help_text
, const char *usage
)
1071 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1072 struct command
*nc
= command_find(*head
, cmd_name
);
1074 /* add a new command with help text */
1075 struct command_registration cr
= {
1077 .mode
= COMMAND_ANY
,
1079 .usage
= usage
? : "",
1081 nc
= register_command(cmd_ctx
, parent
, &cr
);
1083 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1086 LOG_DEBUG("added '%s' help text", cmd_name
);
1090 bool replaced
= false;
1095 nc
->help
= strdup(help_text
);
1097 LOG_INFO("replaced existing '%s' help", cmd_name
);
1099 LOG_DEBUG("added '%s' help text", cmd_name
);
1102 bool replaced
= false;
1108 nc
->usage
= strdup(usage
);
1110 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1112 LOG_DEBUG("added '%s' usage text", cmd_name
);
1117 COMMAND_HANDLER(handle_help_add_command
)
1120 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1121 return ERROR_COMMAND_SYNTAX_ERROR
;
1124 /* save help text and remove it from argument list */
1125 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1126 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1127 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1128 if (!help
&& !usage
) {
1129 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1130 return ERROR_COMMAND_SYNTAX_ERROR
;
1132 /* likewise for the leaf command name */
1133 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1135 struct command
*c
= NULL
;
1137 c
= CMD_CTX
->commands
;
1138 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1139 if (ERROR_OK
!= retval
)
1142 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1145 /* sleep command sleeps for <n> milliseconds
1146 * this is useful in target startup scripts
1148 COMMAND_HANDLER(handle_sleep_command
)
1151 if (CMD_ARGC
== 2) {
1152 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1155 return ERROR_COMMAND_SYNTAX_ERROR
;
1156 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1157 return ERROR_COMMAND_SYNTAX_ERROR
;
1159 unsigned long duration
= 0;
1160 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1161 if (ERROR_OK
!= retval
)
1165 int64_t then
= timeval_ms();
1166 while (timeval_ms() - then
< (int64_t)duration
) {
1167 target_call_timer_callbacks_now();
1171 busy_sleep(duration
);
1176 static const struct command_registration command_subcommand_handlers
[] = {
1179 .mode
= COMMAND_ANY
,
1180 .jim_handler
= jim_command_mode
,
1181 .usage
= "[command_name ...]",
1182 .help
= "Returns the command modes allowed by a command:"
1183 "'any', 'config', or 'exec'. If no command is"
1184 "specified, returns the current command mode. "
1185 "Returns 'unknown' if an unknown command is given. "
1186 "Command can be multiple tokens.",
1188 COMMAND_REGISTRATION_DONE
1191 static const struct command_registration command_builtin_handlers
[] = {
1194 .handler
= jim_echo
,
1195 .mode
= COMMAND_ANY
,
1196 .help
= "Logs a message at \"user\" priority. "
1197 "Output message to stdout. "
1198 "Option \"-n\" suppresses trailing newline",
1199 .usage
= "[-n] string",
1202 .name
= "add_help_text",
1203 .handler
= handle_help_add_command
,
1204 .mode
= COMMAND_ANY
,
1205 .help
= "Add new command help text; "
1206 "Command can be multiple tokens.",
1207 .usage
= "command_name helptext_string",
1210 .name
= "add_usage_text",
1211 .handler
= handle_help_add_command
,
1212 .mode
= COMMAND_ANY
,
1213 .help
= "Add new command usage text; "
1214 "command can be multiple tokens.",
1215 .usage
= "command_name usage_string",
1219 .handler
= handle_sleep_command
,
1220 .mode
= COMMAND_ANY
,
1221 .help
= "Sleep for specified number of milliseconds. "
1222 "\"busy\" will busy wait instead (avoid this).",
1223 .usage
= "milliseconds ['busy']",
1227 .handler
= handle_help_command
,
1228 .mode
= COMMAND_ANY
,
1229 .help
= "Show full command help; "
1230 "command can be multiple tokens.",
1231 .usage
= "[command_name]",
1235 .handler
= handle_help_command
,
1236 .mode
= COMMAND_ANY
,
1237 .help
= "Show basic command usage; "
1238 "command can be multiple tokens.",
1239 .usage
= "[command_name]",
1243 .mode
= COMMAND_ANY
,
1244 .help
= "core command group (introspection)",
1245 .chain
= command_subcommand_handlers
,
1248 COMMAND_REGISTRATION_DONE
1251 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1253 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1256 context
->mode
= COMMAND_EXEC
;
1258 /* Create a jim interpreter if we were not handed one */
1259 if (interp
== NULL
) {
1260 /* Create an interpreter */
1261 interp
= Jim_CreateInterp();
1262 /* Add all the Jim core commands */
1263 Jim_RegisterCoreCommands(interp
);
1264 Jim_InitStaticExtensions(interp
);
1267 context
->interp
= interp
;
1269 /* Stick to lowercase for HostOS strings. */
1270 #if defined(_MSC_VER)
1271 /* WinXX - is generic, the forward
1272 * looking problem is this:
1274 * "win32" or "win64"
1276 * "winxx" is generic.
1279 #elif defined(__linux__)
1281 #elif defined(__APPLE__) || defined(__DARWIN__)
1283 #elif defined(__CYGWIN__)
1285 #elif defined(__MINGW32__)
1287 #elif defined(__ECOS)
1289 #elif defined(__FreeBSD__)
1291 #elif defined(__NetBSD__)
1293 #elif defined(__OpenBSD__)
1296 #warning "Unrecognized host OS..."
1299 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1300 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1302 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1303 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1305 register_commands(context
, NULL
, command_builtin_handlers
);
1307 Jim_SetAssocData(interp
, "context", NULL
, context
);
1308 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1309 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1310 Jim_MakeErrorMessage(interp
);
1311 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1314 Jim_DeleteAssocData(interp
, "context");
1319 void command_exit(struct command_context
*context
)
1324 Jim_FreeInterp(context
->interp
);
1325 command_done(context
);
1328 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1331 return ERROR_COMMAND_SYNTAX_ERROR
;
1333 cmd_ctx
->mode
= mode
;
1337 void process_jim_events(struct command_context
*cmd_ctx
)
1339 static int recursion
;
1344 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1348 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1349 int parse ## name(const char *str, type * ul) \
1352 LOG_ERROR("Invalid command argument"); \
1353 return ERROR_COMMAND_ARGUMENT_INVALID; \
1356 *ul = func(str, &end, 0); \
1358 LOG_ERROR("Invalid command argument"); \
1359 return ERROR_COMMAND_ARGUMENT_INVALID; \
1361 if ((max == *ul) && (ERANGE == errno)) { \
1362 LOG_ERROR("Argument overflow"); \
1363 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1365 if (min && (min == *ul) && (ERANGE == errno)) { \
1366 LOG_ERROR("Argument underflow"); \
1367 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1371 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1372 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1373 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1374 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1376 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1377 int parse ## name(const char *str, type * ul) \
1380 int retval = parse ## funcname(str, &n); \
1381 if (ERROR_OK != retval) \
1384 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1386 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1391 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1392 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1393 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1394 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1395 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1396 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1397 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1399 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1401 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1402 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1403 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1404 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1405 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1406 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1407 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1409 static int command_parse_bool(const char *in
, bool *out
,
1410 const char *on
, const char *off
)
1412 if (strcasecmp(in
, on
) == 0)
1414 else if (strcasecmp(in
, off
) == 0)
1417 return ERROR_COMMAND_SYNTAX_ERROR
;
1421 int command_parse_bool_arg(const char *in
, bool *out
)
1423 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1425 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1427 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1429 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1431 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1433 return ERROR_COMMAND_SYNTAX_ERROR
;
1436 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1440 const char *in
= CMD_ARGV
[0];
1441 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1442 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1443 return ERROR_COMMAND_SYNTAX_ERROR
;
1448 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1451 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)