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
, unsigned int argc
, Jim_Obj
* const *argv
)
131 if (debug_level
< LOG_LVL_DEBUG
)
134 char *dbg
= alloc_printf("command -");
135 for (unsigned i
= 0; i
< argc
; i
++) {
137 const char *w
= Jim_GetString(argv
[i
], &len
);
138 char *t
= alloc_printf("%s %s", dbg
, w
);
142 LOG_DEBUG("%s", dbg
);
146 static void script_command_args_free(char **words
, unsigned nwords
)
148 for (unsigned i
= 0; i
< nwords
; i
++)
153 static char **script_command_args_alloc(
154 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
156 char **words
= malloc(argc
* sizeof(char *));
161 for (i
= 0; i
< argc
; i
++) {
163 const char *w
= Jim_GetString(argv
[i
], &len
);
164 words
[i
] = strdup(w
);
165 if (words
[i
] == NULL
) {
166 script_command_args_free(words
, i
);
174 struct command_context
*current_command_context(Jim_Interp
*interp
)
176 /* grab the command context from the associated data */
177 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
178 if (NULL
== cmd_ctx
) {
179 /* Tcl can invoke commands directly instead of via command_run_line(). This would
180 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
181 * commands in a startup script.
183 * A telnet or gdb server would provide a non-default command context to
184 * handle piping of error output, have a separate current target, etc.
186 cmd_ctx
= global_cmd_ctx
;
191 static int script_command_run(Jim_Interp
*interp
,
192 int argc
, Jim_Obj
* const *argv
, struct command
*c
)
194 target_call_timer_callbacks_now();
195 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
198 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
202 struct command_context
*cmd_ctx
= current_command_context(interp
);
203 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
205 script_command_args_free(words
, nwords
);
206 return command_retval_set(interp
, retval
);
209 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
211 /* the private data is stashed in the interp structure */
213 struct command
*c
= interp
->cmdPrivData
;
215 script_debug(interp
, argc
, argv
);
216 return script_command_run(interp
, argc
, argv
, c
);
219 static struct command
*command_root(struct command
*c
)
221 while (NULL
!= c
->parent
)
227 * Find a command by name from a list of commands.
228 * @returns Returns the named command if it exists in the list.
229 * Returns NULL otherwise.
231 static struct command
*command_find(struct command
*head
, const char *name
)
233 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
234 if (strcmp(cc
->name
, name
) == 0)
240 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
243 return command_find(cmd_ctx
->commands
, name
);
245 struct command
*command_find_in_parent(struct command
*parent
,
248 return command_find(parent
->children
, name
);
252 * Add the command into the linked list, sorted by name.
253 * @param head Address to head of command list pointer, which may be
254 * updated if @c c gets inserted at the beginning of the list.
255 * @param c The command to add to the list pointed to by @c head.
257 static void command_add_child(struct command
**head
, struct command
*c
)
265 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
266 head
= &(*head
)->next
;
268 if (strcmp(c
->name
, (*head
)->name
) > 0) {
269 c
->next
= (*head
)->next
;
277 static struct command
**command_list_for_parent(
278 struct command_context
*cmd_ctx
, struct command
*parent
)
280 return parent
? &parent
->children
: &cmd_ctx
->commands
;
283 static void command_free(struct command
*c
)
285 /** @todo if command has a handler, unregister its jim command! */
287 while (NULL
!= c
->children
) {
288 struct command
*tmp
= c
->children
;
289 c
->children
= tmp
->next
;
299 static struct command
*command_new(struct command_context
*cmd_ctx
,
300 struct command
*parent
, const struct command_registration
*cr
)
305 * If it is a non-jim command with no .usage specified,
308 * strlen(.usage) == 0 means that the command takes no
311 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
312 LOG_ERROR("BUG: command '%s%s%s' does not have the "
313 "'.usage' field filled out",
314 parent
&& parent
->name
? parent
->name
: "",
315 parent
&& parent
->name
? " " : "",
319 struct command
*c
= calloc(1, sizeof(struct command
));
323 c
->name
= strdup(cr
->name
);
325 c
->help
= strdup(cr
->help
);
327 c
->usage
= strdup(cr
->usage
);
329 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
330 goto command_new_error
;
333 c
->handler
= cr
->handler
;
334 c
->jim_handler
= cr
->jim_handler
;
337 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
346 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
348 static int register_command_handler(struct command_context
*cmd_ctx
,
351 Jim_Interp
*interp
= cmd_ctx
->interp
;
353 LOG_DEBUG("registering '%s'...", c
->name
);
355 Jim_CmdProc
*func
= c
->handler
? &script_command
: &command_unknown
;
356 int retval
= Jim_CreateCommand(interp
, c
->name
, func
, c
, NULL
);
361 struct command
*register_command(struct command_context
*context
,
362 struct command
*parent
, const struct command_registration
*cr
)
364 if (!context
|| !cr
->name
)
367 const char *name
= cr
->name
;
368 struct command
**head
= command_list_for_parent(context
, parent
);
369 struct command
*c
= command_find(*head
, name
);
371 /* TODO: originally we treated attempting to register a cmd twice as an error
372 * Sometimes we need this behaviour, such as with flash banks.
373 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
374 LOG_DEBUG("command '%s' is already registered in '%s' context",
375 name
, parent
? parent
->name
: "<global>");
379 c
= command_new(context
, parent
, cr
);
384 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
385 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
386 cr
->jim_handler
, NULL
, NULL
);
387 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
388 retval
= register_command_handler(context
, command_root(c
));
390 if (retval
!= JIM_OK
) {
391 unregister_command(context
, parent
, name
);
397 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
398 const struct command_registration
*cmds
)
400 int retval
= ERROR_OK
;
402 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
403 const struct command_registration
*cr
= cmds
+ i
;
405 struct command
*c
= NULL
;
406 if (NULL
!= cr
->name
) {
407 c
= register_command(cmd_ctx
, parent
, cr
);
413 if (NULL
!= cr
->chain
) {
414 struct command
*p
= c
? : parent
;
415 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
416 if (ERROR_OK
!= retval
)
420 if (ERROR_OK
!= retval
) {
421 for (unsigned j
= 0; j
< i
; j
++)
422 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
427 int unregister_all_commands(struct command_context
*context
,
428 struct command
*parent
)
433 struct command
**head
= command_list_for_parent(context
, parent
);
434 while (NULL
!= *head
) {
435 struct command
*tmp
= *head
;
443 int unregister_command(struct command_context
*context
,
444 struct command
*parent
, const char *name
)
446 if ((!context
) || (!name
))
447 return ERROR_COMMAND_SYNTAX_ERROR
;
449 struct command
*p
= NULL
;
450 struct command
**head
= command_list_for_parent(context
, parent
);
451 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
452 if (strcmp(name
, c
->name
) != 0)
467 void command_set_handler_data(struct command
*c
, void *p
)
469 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
470 c
->jim_handler_data
= p
;
471 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
472 command_set_handler_data(cc
, p
);
475 void command_output_text(struct command_context
*context
, const char *data
)
477 if (context
&& context
->output_handler
&& data
)
478 context
->output_handler(context
, data
);
481 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
486 va_start(ap
, format
);
488 string
= alloc_vprintf(format
, ap
);
489 if (string
!= NULL
&& cmd
) {
490 /* we want this collected in the log + we also want to pick it up as a tcl return
493 * The latter bit isn't precisely neat, but will do for now.
495 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
496 /* We already printed it above
497 * command_output_text(context, string); */
504 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
509 va_start(ap
, format
);
511 string
= alloc_vprintf(format
, ap
);
512 if (string
!= NULL
&& cmd
) {
513 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
515 /* we want this collected in the log + we also want to pick it up as a tcl return
518 * The latter bit isn't precisely neat, but will do for now.
520 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
521 /* We already printed it above
522 * command_output_text(context, string); */
529 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
532 unsigned len
= strlen(c
->name
);
533 if (NULL
== c
->parent
) {
534 /* allocate enough for the name, child names, and '\0' */
535 name
= malloc(len
+ extra
+ 1);
537 LOG_ERROR("Out of memory");
540 strcpy(name
, c
->name
);
542 /* parent's extra must include both the space and name */
543 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
544 char dstr
[2] = { delim
, 0 };
546 strcat(name
, c
->name
);
551 char *command_name(struct command
*c
, char delim
)
553 return __command_name(c
, delim
, 0);
556 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
558 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
561 /* Many commands may be run only before/after 'init' */
570 /* handle the impossible with humor; it guarantees a bug report! */
572 when
= "if Cthulhu is summoned by";
575 char *full_name
= command_name(c
, ' ');
576 LOG_ERROR("The '%s' command must be used %s 'init'.",
577 full_name
? full_name
: c
->name
, when
);
582 static int run_command(struct command_context
*context
,
583 struct command
*c
, const char *words
[], unsigned num_words
)
585 if (!command_can_run(context
, c
))
588 struct command_invocation cmd
= {
592 .argc
= num_words
- 1,
595 /* Black magic of overridden current target:
596 * If the command we are going to handle has a target prefix,
597 * override the current target temporarily for the time
598 * of processing the command.
599 * current_target_override is used also for event handlers
600 * therefore we prevent touching it if command has no prefix.
601 * Previous override is saved and restored back to ensure
602 * correct work when run_command() is re-entered. */
603 struct target
*saved_target_override
= context
->current_target_override
;
604 if (c
->jim_handler_data
)
605 context
->current_target_override
= c
->jim_handler_data
;
607 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
608 Jim_IncrRefCount(cmd
.output
);
610 int retval
= c
->handler(&cmd
);
612 if (c
->jim_handler_data
)
613 context
->current_target_override
= saved_target_override
;
615 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
616 /* Print help for command */
617 char *full_name
= command_name(c
, ' ');
618 if (NULL
!= full_name
) {
619 command_run_linef(context
, "usage %s", full_name
);
622 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
623 /* just fall through for a shutdown request */
625 if (retval
!= ERROR_OK
) {
626 char *full_name
= command_name(c
, ' ');
627 LOG_DEBUG("Command '%s' failed with error code %d",
628 full_name
? full_name
: c
->name
, retval
);
631 /* Use the command output as the Tcl result */
632 Jim_SetResult(context
->interp
, cmd
.output
);
634 Jim_DecrRefCount(context
->interp
, cmd
.output
);
639 int command_run_line(struct command_context
*context
, char *line
)
641 /* all the parent commands have been registered with the interpreter
642 * so, can just evaluate the line as a script and check for
645 /* run the line thru a script engine */
646 int retval
= ERROR_FAIL
;
648 /* Beware! This code needs to be reentrant. It is also possible
649 * for OpenOCD commands to be invoked directly from Tcl. This would
650 * happen when the Jim Tcl interpreter is provided by eCos for
653 struct target
*saved_target_override
= context
->current_target_override
;
654 context
->current_target_override
= NULL
;
656 Jim_Interp
*interp
= context
->interp
;
657 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
658 Jim_DeleteAssocData(interp
, "context");
659 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
660 if (retcode
== JIM_OK
) {
661 /* associated the return value */
662 Jim_DeleteAssocData(interp
, "retval");
663 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
664 if (retcode
== JIM_OK
) {
665 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
667 Jim_DeleteAssocData(interp
, "retval");
669 Jim_DeleteAssocData(interp
, "context");
670 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
671 if (retcode
== JIM_OK
)
672 retcode
= inner_retcode
;
674 context
->current_target_override
= saved_target_override
;
675 if (retcode
== JIM_OK
) {
679 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
681 command_output_text(context
, result
);
682 command_output_text(context
, "\n");
685 } else if (retcode
== JIM_EXIT
) {
687 * exit(Jim_GetExitCode(interp)); */
688 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
691 Jim_MakeErrorMessage(interp
);
692 /* error is broadcast */
693 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
695 if (retval
== ERROR_OK
) {
696 /* It wasn't a low level OpenOCD command that failed */
705 int command_run_linef(struct command_context
*context
, const char *format
, ...)
707 int retval
= ERROR_FAIL
;
710 va_start(ap
, format
);
711 string
= alloc_vprintf(format
, ap
);
712 if (string
!= NULL
) {
713 retval
= command_run_line(context
, string
);
720 void command_set_output_handler(struct command_context
*context
,
721 command_output_handler_t output_handler
, void *priv
)
723 context
->output_handler
= output_handler
;
724 context
->output_handler_priv
= priv
;
727 struct command_context
*copy_command_context(struct command_context
*context
)
729 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
731 *copy_context
= *context
;
736 void command_done(struct command_context
*cmd_ctx
)
744 /* find full path to file */
745 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
749 const char *file
= Jim_GetString(argv
[1], NULL
);
750 char *full_path
= find_file(file
);
751 if (full_path
== NULL
)
753 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
756 Jim_SetResult(interp
, result
);
760 COMMAND_HANDLER(jim_echo
)
762 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
763 LOG_USER_N("%s", CMD_ARGV
[1]);
768 LOG_USER("%s", CMD_ARGV
[0]);
772 /* Capture progress output and return as tcl return value. If the
773 * progress output was empty, return tcl return value.
775 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
780 struct log_capture_state
*state
= command_log_capture_start(interp
);
782 /* disable polling during capture. This avoids capturing output
785 * This is necessary in order to avoid accidentally getting a non-empty
786 * string for tcl fn's.
788 bool save_poll
= jtag_poll_get_enabled();
790 jtag_poll_set_enabled(false);
792 const char *str
= Jim_GetString(argv
[1], NULL
);
793 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
795 jtag_poll_set_enabled(save_poll
);
797 command_log_capture_finish(state
);
802 static COMMAND_HELPER(command_help_find
, struct command
*head
,
803 struct command
**out
)
806 return ERROR_COMMAND_SYNTAX_ERROR
;
807 *out
= command_find(head
, CMD_ARGV
[0]);
809 return ERROR_COMMAND_SYNTAX_ERROR
;
813 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
816 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
817 bool show_help
, const char *cmd_match
);
819 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
820 bool show_help
, const char *cmd_match
)
822 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
823 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
827 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
829 static void command_help_show_indent(unsigned n
)
831 for (unsigned i
= 0; i
< n
; i
++)
834 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
836 const char *cp
= str
, *last
= str
;
838 const char *next
= last
;
843 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
844 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
845 if (next
- last
< HELP_LINE_WIDTH(n
))
847 command_help_show_indent(n
);
848 LOG_USER("%.*s", (int)(cp
- last
), last
);
854 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
855 bool show_help
, const char *cmd_match
)
857 char *cmd_name
= command_name(c
, ' ');
858 if (NULL
== cmd_name
)
861 /* If the match string occurs anywhere, we print out
862 * stuff for this command. */
863 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
864 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
865 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
868 command_help_show_indent(n
);
869 LOG_USER_N("%s", cmd_name
);
874 if (c
->usage
&& strlen(c
->usage
) > 0) {
876 command_help_show_wrap(c
->usage
, 0, n
+ 5);
881 if (is_match
&& show_help
) {
884 /* Normal commands are runtime-only; highlight exceptions */
885 if (c
->mode
!= COMMAND_EXEC
) {
886 const char *stage_msg
= "";
890 stage_msg
= " (configuration command)";
893 stage_msg
= " (command valid any time)";
896 stage_msg
= " (?mode error?)";
899 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
901 msg
= alloc_printf("%s", c
->help
? : "");
904 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
911 LOG_ERROR("command recursion exceeded");
915 return CALL_COMMAND_HANDLER(command_help_show_list
,
916 c
->children
, n
, show_help
, cmd_match
);
919 COMMAND_HANDLER(handle_help_command
)
921 bool full
= strcmp(CMD_NAME
, "help") == 0;
923 struct command
*c
= CMD_CTX
->commands
;
924 char *cmd_match
= NULL
;
928 else if (CMD_ARGC
>= 1) {
931 for (i
= 0; i
< CMD_ARGC
; ++i
) {
932 if (NULL
!= cmd_match
) {
933 char *prev
= cmd_match
;
935 cmd_match
= alloc_printf("%s %s", cmd_match
, CMD_ARGV
[i
]);
937 if (NULL
== cmd_match
) {
938 LOG_ERROR("unable to build search string");
942 cmd_match
= alloc_printf("%s", CMD_ARGV
[i
]);
943 if (NULL
== cmd_match
) {
944 LOG_ERROR("unable to build search string");
950 return ERROR_COMMAND_SYNTAX_ERROR
;
952 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
953 c
, 0, full
, cmd_match
);
960 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
961 struct command
*head
, struct command
**out
)
965 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
966 struct command
*c
= command_find(head
, cmd_name
);
970 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
973 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
980 all
= strdup(Jim_GetString(argv
[0], NULL
));
982 LOG_ERROR("Out of memory");
986 for (i
= 1; i
< argc
; ++i
) {
988 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
991 LOG_ERROR("Out of memory");
999 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
1001 struct command_context
*cmd_ctx
= current_command_context(interp
);
1005 assert(argc_valid
>= 1);
1006 assert(argc
>= argc_valid
);
1008 command
= alloc_concatenate_strings(argc_valid
, argv
);
1012 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
1013 if (retval
!= ERROR_OK
) {
1014 LOG_ERROR("unable to execute command \"usage %s\"", command
);
1018 if (argc_valid
== argc
)
1019 LOG_ERROR("%s: command requires more arguments", command
);
1022 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
1025 LOG_ERROR("invalid subcommand \"%s\"", command
);
1032 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1034 script_debug(interp
, argc
, argv
);
1036 struct command_context
*cmd_ctx
= current_command_context(interp
);
1037 struct command
*c
= cmd_ctx
->commands
;
1038 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1039 /* if nothing could be consumed, then it's really an unknown command */
1040 if (remaining
== argc
) {
1041 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1042 LOG_ERROR("Unknown command:\n %s", cmd
);
1046 Jim_Obj
*const *start
;
1048 if (c
->handler
|| c
->jim_handler
) {
1049 /* include the command name in the list */
1050 count
= remaining
+ 1;
1051 start
= argv
+ (argc
- remaining
- 1);
1053 count
= argc
- remaining
;
1055 run_usage(interp
, count
, argc
, start
);
1058 /* pass the command through to the intended handler */
1059 if (c
->jim_handler
) {
1060 if (!command_can_run(cmd_ctx
, c
))
1063 interp
->cmdPrivData
= c
->jim_handler_data
;
1064 return (*c
->jim_handler
)(interp
, count
, start
);
1067 return script_command_run(interp
, count
, start
, c
);
1070 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1072 struct command_context
*cmd_ctx
= current_command_context(interp
);
1073 enum command_mode mode
;
1076 struct command
*c
= cmd_ctx
->commands
;
1077 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1078 /* if nothing could be consumed, then it's an unknown command */
1079 if (remaining
== argc
- 1) {
1080 Jim_SetResultString(interp
, "unknown", -1);
1085 mode
= cmd_ctx
->mode
;
1087 const char *mode_str
;
1092 case COMMAND_CONFIG
:
1093 mode_str
= "config";
1099 mode_str
= "unknown";
1102 Jim_SetResultString(interp
, mode_str
, -1);
1106 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1107 const char *cmd_name
, const char *help_text
, const char *usage
)
1109 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1110 struct command
*nc
= command_find(*head
, cmd_name
);
1112 /* add a new command with help text */
1113 struct command_registration cr
= {
1115 .mode
= COMMAND_ANY
,
1117 .usage
= usage
? : "",
1119 nc
= register_command(cmd_ctx
, parent
, &cr
);
1121 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1124 LOG_DEBUG("added '%s' help text", cmd_name
);
1128 bool replaced
= false;
1133 nc
->help
= strdup(help_text
);
1135 LOG_INFO("replaced existing '%s' help", cmd_name
);
1137 LOG_DEBUG("added '%s' help text", cmd_name
);
1140 bool replaced
= false;
1146 nc
->usage
= strdup(usage
);
1148 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1150 LOG_DEBUG("added '%s' usage text", cmd_name
);
1155 COMMAND_HANDLER(handle_help_add_command
)
1158 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1159 return ERROR_COMMAND_SYNTAX_ERROR
;
1162 /* save help text and remove it from argument list */
1163 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1164 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1165 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1166 if (!help
&& !usage
) {
1167 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1168 return ERROR_COMMAND_SYNTAX_ERROR
;
1170 /* likewise for the leaf command name */
1171 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1173 struct command
*c
= NULL
;
1175 c
= CMD_CTX
->commands
;
1176 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1177 if (ERROR_OK
!= retval
)
1180 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1183 /* sleep command sleeps for <n> milliseconds
1184 * this is useful in target startup scripts
1186 COMMAND_HANDLER(handle_sleep_command
)
1189 if (CMD_ARGC
== 2) {
1190 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1193 return ERROR_COMMAND_SYNTAX_ERROR
;
1194 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1195 return ERROR_COMMAND_SYNTAX_ERROR
;
1197 unsigned long duration
= 0;
1198 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1199 if (ERROR_OK
!= retval
)
1203 int64_t then
= timeval_ms();
1204 while (timeval_ms() - then
< (int64_t)duration
) {
1205 target_call_timer_callbacks_now();
1209 busy_sleep(duration
);
1214 static const struct command_registration command_subcommand_handlers
[] = {
1217 .mode
= COMMAND_ANY
,
1218 .jim_handler
= jim_command_mode
,
1219 .usage
= "[command_name ...]",
1220 .help
= "Returns the command modes allowed by a command: "
1221 "'any', 'config', or 'exec'. If no command is "
1222 "specified, returns the current command mode. "
1223 "Returns 'unknown' if an unknown command is given. "
1224 "Command can be multiple tokens.",
1226 COMMAND_REGISTRATION_DONE
1229 static const struct command_registration command_builtin_handlers
[] = {
1232 .mode
= COMMAND_ANY
,
1233 .jim_handler
= jim_find
,
1234 .help
= "find full path to file",
1239 .mode
= COMMAND_ANY
,
1240 .jim_handler
= jim_capture
,
1241 .help
= "Capture progress output and return as tcl return value. If the "
1242 "progress output was empty, return tcl return value.",
1247 .handler
= jim_echo
,
1248 .mode
= COMMAND_ANY
,
1249 .help
= "Logs a message at \"user\" priority. "
1250 "Output message to stdout. "
1251 "Option \"-n\" suppresses trailing newline",
1252 .usage
= "[-n] string",
1255 .name
= "add_help_text",
1256 .handler
= handle_help_add_command
,
1257 .mode
= COMMAND_ANY
,
1258 .help
= "Add new command help text; "
1259 "Command can be multiple tokens.",
1260 .usage
= "command_name helptext_string",
1263 .name
= "add_usage_text",
1264 .handler
= handle_help_add_command
,
1265 .mode
= COMMAND_ANY
,
1266 .help
= "Add new command usage text; "
1267 "command can be multiple tokens.",
1268 .usage
= "command_name usage_string",
1272 .handler
= handle_sleep_command
,
1273 .mode
= COMMAND_ANY
,
1274 .help
= "Sleep for specified number of milliseconds. "
1275 "\"busy\" will busy wait instead (avoid this).",
1276 .usage
= "milliseconds ['busy']",
1280 .handler
= handle_help_command
,
1281 .mode
= COMMAND_ANY
,
1282 .help
= "Show full command help; "
1283 "command can be multiple tokens.",
1284 .usage
= "[command_name]",
1288 .handler
= handle_help_command
,
1289 .mode
= COMMAND_ANY
,
1290 .help
= "Show basic command usage; "
1291 "command can be multiple tokens.",
1292 .usage
= "[command_name]",
1296 .mode
= COMMAND_ANY
,
1297 .help
= "core command group (introspection)",
1298 .chain
= command_subcommand_handlers
,
1301 COMMAND_REGISTRATION_DONE
1304 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1306 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1309 context
->mode
= COMMAND_EXEC
;
1311 /* Create a jim interpreter if we were not handed one */
1312 if (interp
== NULL
) {
1313 /* Create an interpreter */
1314 interp
= Jim_CreateInterp();
1315 /* Add all the Jim core commands */
1316 Jim_RegisterCoreCommands(interp
);
1317 Jim_InitStaticExtensions(interp
);
1320 context
->interp
= interp
;
1322 /* Stick to lowercase for HostOS strings. */
1323 #if defined(_MSC_VER)
1324 /* WinXX - is generic, the forward
1325 * looking problem is this:
1327 * "win32" or "win64"
1329 * "winxx" is generic.
1332 #elif defined(__linux__)
1334 #elif defined(__APPLE__) || defined(__DARWIN__)
1336 #elif defined(__CYGWIN__)
1338 #elif defined(__MINGW32__)
1340 #elif defined(__ECOS)
1342 #elif defined(__FreeBSD__)
1344 #elif defined(__NetBSD__)
1346 #elif defined(__OpenBSD__)
1349 #warning "Unrecognized host OS..."
1352 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1353 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1355 register_commands(context
, NULL
, command_builtin_handlers
);
1357 Jim_SetAssocData(interp
, "context", NULL
, context
);
1358 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1359 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1360 Jim_MakeErrorMessage(interp
);
1361 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1364 Jim_DeleteAssocData(interp
, "context");
1369 void command_exit(struct command_context
*context
)
1374 Jim_FreeInterp(context
->interp
);
1375 command_done(context
);
1378 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1381 return ERROR_COMMAND_SYNTAX_ERROR
;
1383 cmd_ctx
->mode
= mode
;
1387 void process_jim_events(struct command_context
*cmd_ctx
)
1389 static int recursion
;
1394 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1398 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1399 int parse ## name(const char *str, type * ul) \
1402 LOG_ERROR("Invalid command argument"); \
1403 return ERROR_COMMAND_ARGUMENT_INVALID; \
1407 *ul = func(str, &end, 0); \
1409 LOG_ERROR("Invalid command argument"); \
1410 return ERROR_COMMAND_ARGUMENT_INVALID; \
1412 if ((max == *ul) && (ERANGE == errno)) { \
1413 LOG_ERROR("Argument overflow"); \
1414 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1416 if (min && (min == *ul) && (ERANGE == errno)) { \
1417 LOG_ERROR("Argument underflow"); \
1418 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1422 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1423 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1424 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1425 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1427 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1428 int parse ## name(const char *str, type * ul) \
1431 int retval = parse ## funcname(str, &n); \
1432 if (ERROR_OK != retval) \
1435 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1437 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1442 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1443 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1444 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1445 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1446 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1447 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1448 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1450 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1452 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1453 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1454 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1455 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1456 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1457 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1458 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1460 static int command_parse_bool(const char *in
, bool *out
,
1461 const char *on
, const char *off
)
1463 if (strcasecmp(in
, on
) == 0)
1465 else if (strcasecmp(in
, off
) == 0)
1468 return ERROR_COMMAND_SYNTAX_ERROR
;
1472 int command_parse_bool_arg(const char *in
, bool *out
)
1474 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1476 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1478 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1480 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1482 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1484 return ERROR_COMMAND_SYNTAX_ERROR
;
1487 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1491 const char *in
= CMD_ARGV
[0];
1492 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1493 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1494 return ERROR_COMMAND_SYNTAX_ERROR
;
1499 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1502 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)