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
, bool capture
)
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 log_capture_state
*state
= NULL
;
205 state
= command_log_capture_start(interp
);
207 struct command_context
*cmd_ctx
= current_command_context(interp
);
208 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
210 command_log_capture_finish(state
);
212 script_command_args_free(words
, nwords
);
213 return command_retval_set(interp
, retval
);
216 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
218 /* the private data is stashed in the interp structure */
220 struct command
*c
= interp
->cmdPrivData
;
222 script_debug(interp
, c
->name
, argc
, argv
);
223 return script_command_run(interp
, argc
, argv
, c
, true);
226 static struct command
*command_root(struct command
*c
)
228 while (NULL
!= c
->parent
)
234 * Find a command by name from a list of commands.
235 * @returns Returns the named command if it exists in the list.
236 * Returns NULL otherwise.
238 static struct command
*command_find(struct command
*head
, const char *name
)
240 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
241 if (strcmp(cc
->name
, name
) == 0)
247 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
250 return command_find(cmd_ctx
->commands
, name
);
252 struct command
*command_find_in_parent(struct command
*parent
,
255 return command_find(parent
->children
, name
);
259 * Add the command into the linked list, sorted by name.
260 * @param head Address to head of command list pointer, which may be
261 * updated if @c c gets inserted at the beginning of the list.
262 * @param c The command to add to the list pointed to by @c head.
264 static void command_add_child(struct command
**head
, struct command
*c
)
272 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
273 head
= &(*head
)->next
;
275 if (strcmp(c
->name
, (*head
)->name
) > 0) {
276 c
->next
= (*head
)->next
;
284 static struct command
**command_list_for_parent(
285 struct command_context
*cmd_ctx
, struct command
*parent
)
287 return parent
? &parent
->children
: &cmd_ctx
->commands
;
290 static void command_free(struct command
*c
)
292 /** @todo if command has a handler, unregister its jim command! */
294 while (NULL
!= c
->children
) {
295 struct command
*tmp
= c
->children
;
296 c
->children
= tmp
->next
;
306 static struct command
*command_new(struct command_context
*cmd_ctx
,
307 struct command
*parent
, const struct command_registration
*cr
)
312 * If it is a non-jim command with no .usage specified,
315 * strlen(.usage) == 0 means that the command takes no
318 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
319 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
320 "'.usage' field filled out",
321 parent
&& parent
->name
? parent
->name
: "",
322 parent
&& parent
->name
? " " : "",
326 struct command
*c
= calloc(1, sizeof(struct command
));
330 c
->name
= strdup(cr
->name
);
332 c
->help
= strdup(cr
->help
);
334 c
->usage
= strdup(cr
->usage
);
336 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
337 goto command_new_error
;
340 c
->handler
= cr
->handler
;
341 c
->jim_handler
= cr
->jim_handler
;
342 c
->jim_handler_data
= cr
->jim_handler_data
;
345 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
354 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
356 static int register_command_handler(struct command_context
*cmd_ctx
,
359 Jim_Interp
*interp
= cmd_ctx
->interp
;
360 char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
361 if (NULL
== ocd_name
)
364 LOG_DEBUG("registering '%s'...", ocd_name
);
366 Jim_CmdProc
*func
= c
->handler
? &script_command
: &command_unknown
;
367 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
369 if (JIM_OK
!= retval
)
372 /* we now need to add an overrideable proc */
373 char *override_name
= alloc_printf(
374 "proc %s {args} {eval ocd_bouncer %s $args}",
376 if (NULL
== override_name
)
379 retval
= Jim_Eval_Named(interp
, override_name
, 0, 0);
385 struct command
*register_command(struct command_context
*context
,
386 struct command
*parent
, const struct command_registration
*cr
)
388 if (!context
|| !cr
->name
)
391 const char *name
= cr
->name
;
392 struct command
**head
= command_list_for_parent(context
, parent
);
393 struct command
*c
= command_find(*head
, name
);
395 /* TODO: originally we treated attempting to register a cmd twice as an error
396 * Sometimes we need this behaviour, such as with flash banks.
397 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
398 LOG_DEBUG("command '%s' is already registered in '%s' context",
399 name
, parent
? parent
->name
: "<global>");
403 c
= command_new(context
, parent
, cr
);
407 int retval
= ERROR_OK
;
408 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
409 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
410 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
411 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
412 retval
= register_command_handler(context
, command_root(c
));
414 if (ERROR_OK
!= retval
) {
415 unregister_command(context
, parent
, name
);
421 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
422 const struct command_registration
*cmds
)
424 int retval
= ERROR_OK
;
426 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
427 const struct command_registration
*cr
= cmds
+ i
;
429 struct command
*c
= NULL
;
430 if (NULL
!= cr
->name
) {
431 c
= register_command(cmd_ctx
, parent
, cr
);
437 if (NULL
!= cr
->chain
) {
438 struct command
*p
= c
? : parent
;
439 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
440 if (ERROR_OK
!= retval
)
444 if (ERROR_OK
!= retval
) {
445 for (unsigned j
= 0; j
< i
; j
++)
446 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
451 int unregister_all_commands(struct command_context
*context
,
452 struct command
*parent
)
457 struct command
**head
= command_list_for_parent(context
, parent
);
458 while (NULL
!= *head
) {
459 struct command
*tmp
= *head
;
467 int unregister_command(struct command_context
*context
,
468 struct command
*parent
, const char *name
)
470 if ((!context
) || (!name
))
471 return ERROR_COMMAND_SYNTAX_ERROR
;
473 struct command
*p
= NULL
;
474 struct command
**head
= command_list_for_parent(context
, parent
);
475 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
476 if (strcmp(name
, c
->name
) != 0)
491 void command_set_handler_data(struct command
*c
, void *p
)
493 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
494 c
->jim_handler_data
= p
;
495 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
496 command_set_handler_data(cc
, p
);
499 void command_output_text(struct command_context
*context
, const char *data
)
501 if (context
&& context
->output_handler
&& data
)
502 context
->output_handler(context
, data
);
505 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
510 va_start(ap
, format
);
512 string
= alloc_vprintf(format
, ap
);
513 if (string
!= NULL
) {
514 /* we want this collected in the log + we also want to pick it up as a tcl return
517 * The latter bit isn't precisely neat, but will do for now.
519 LOG_USER_N("%s", string
);
520 /* We already printed it above
521 * command_output_text(context, string); */
528 void command_print(struct command_context
*context
, const char *format
, ...)
533 va_start(ap
, format
);
535 string
= alloc_vprintf(format
, ap
);
536 if (string
!= NULL
) {
537 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
539 /* we want this collected in the log + we also want to pick it up as a tcl return
542 * The latter bit isn't precisely neat, but will do for now.
544 LOG_USER_N("%s", string
);
545 /* We already printed it above
546 * command_output_text(context, string); */
553 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
556 unsigned len
= strlen(c
->name
);
557 if (NULL
== c
->parent
) {
558 /* allocate enough for the name, child names, and '\0' */
559 name
= malloc(len
+ extra
+ 1);
561 LOG_ERROR("Out of memory");
564 strcpy(name
, c
->name
);
566 /* parent's extra must include both the space and name */
567 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
568 char dstr
[2] = { delim
, 0 };
570 strcat(name
, c
->name
);
575 char *command_name(struct command
*c
, char delim
)
577 return __command_name(c
, delim
, 0);
580 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
582 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
585 static int run_command(struct command_context
*context
,
586 struct command
*c
, const char *words
[], unsigned num_words
)
588 if (!command_can_run(context
, c
)) {
589 /* Many commands may be run only before/after 'init' */
598 /* handle the impossible with humor; it guarantees a bug report! */
600 when
= "if Cthulhu is summoned by";
603 LOG_ERROR("The '%s' command must be used %s 'init'.",
608 struct command_invocation cmd
= {
612 .argc
= num_words
- 1,
615 /* Black magic of overridden current target:
616 * If the command we are going to handle has a target prefix,
617 * override the current target temporarily for the time
618 * of processing the command.
619 * current_target_override is used also for event handlers
620 * therefore we prevent touching it if command has no prefix.
621 * Previous override is saved and restored back to ensure
622 * correct work when run_command() is re-entered. */
623 struct target
*saved_target_override
= context
->current_target_override
;
624 if (c
->jim_handler_data
)
625 context
->current_target_override
= c
->jim_handler_data
;
627 int retval
= c
->handler(&cmd
);
629 if (c
->jim_handler_data
)
630 context
->current_target_override
= saved_target_override
;
632 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
633 /* Print help for command */
634 char *full_name
= command_name(c
, ' ');
635 if (NULL
!= full_name
) {
636 command_run_linef(context
, "usage %s", full_name
);
639 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
640 /* just fall through for a shutdown request */
641 } else if (retval
!= ERROR_OK
) {
642 /* we do not print out an error message because the command *should*
643 * have printed out an error
645 LOG_DEBUG("Command '%s' failed with error code %d", c
->name
, retval
);
651 int command_run_line(struct command_context
*context
, char *line
)
653 /* all the parent commands have been registered with the interpreter
654 * so, can just evaluate the line as a script and check for
657 /* run the line thru a script engine */
658 int retval
= ERROR_FAIL
;
660 /* Beware! This code needs to be reentrant. It is also possible
661 * for OpenOCD commands to be invoked directly from Tcl. This would
662 * happen when the Jim Tcl interpreter is provided by eCos for
665 context
->current_target_override
= NULL
;
667 Jim_Interp
*interp
= context
->interp
;
668 Jim_DeleteAssocData(interp
, "context");
669 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
670 if (retcode
== JIM_OK
) {
671 /* associated the return value */
672 Jim_DeleteAssocData(interp
, "retval");
673 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
674 if (retcode
== JIM_OK
) {
675 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
677 Jim_DeleteAssocData(interp
, "retval");
679 Jim_DeleteAssocData(interp
, "context");
681 if (retcode
== JIM_OK
) {
685 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
689 for (i
= 0; i
< reslen
; i
+= 256) {
694 strncpy(buff
, result
+ i
, chunk
);
696 LOG_USER_N("%s", buff
);
701 } else if (retcode
== JIM_EXIT
) {
703 * exit(Jim_GetExitCode(interp)); */
704 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
707 Jim_MakeErrorMessage(interp
);
708 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
710 if (retval
== ERROR_OK
) {
711 /* It wasn't a low level OpenOCD command that failed */
720 int command_run_linef(struct command_context
*context
, const char *format
, ...)
722 int retval
= ERROR_FAIL
;
725 va_start(ap
, format
);
726 string
= alloc_vprintf(format
, ap
);
727 if (string
!= NULL
) {
728 retval
= command_run_line(context
, string
);
735 void command_set_output_handler(struct command_context
*context
,
736 command_output_handler_t output_handler
, void *priv
)
738 context
->output_handler
= output_handler
;
739 context
->output_handler_priv
= priv
;
742 struct command_context
*copy_command_context(struct command_context
*context
)
744 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
746 *copy_context
= *context
;
751 void command_done(struct command_context
*cmd_ctx
)
759 /* find full path to file */
760 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
764 const char *file
= Jim_GetString(argv
[1], NULL
);
765 char *full_path
= find_file(file
);
766 if (full_path
== NULL
)
768 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
771 Jim_SetResult(interp
, result
);
775 COMMAND_HANDLER(jim_echo
)
777 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
778 LOG_USER_N("%s", CMD_ARGV
[1]);
783 LOG_USER("%s", CMD_ARGV
[0]);
787 /* Capture progress output and return as tcl return value. If the
788 * progress output was empty, return tcl return value.
790 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
795 struct log_capture_state
*state
= command_log_capture_start(interp
);
797 /* disable polling during capture. This avoids capturing output
800 * This is necessary in order to avoid accidentally getting a non-empty
801 * string for tcl fn's.
803 bool save_poll
= jtag_poll_get_enabled();
805 jtag_poll_set_enabled(false);
807 const char *str
= Jim_GetString(argv
[1], NULL
);
808 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
810 jtag_poll_set_enabled(save_poll
);
812 command_log_capture_finish(state
);
817 static COMMAND_HELPER(command_help_find
, struct command
*head
,
818 struct command
**out
)
821 return ERROR_COMMAND_SYNTAX_ERROR
;
822 *out
= command_find(head
, CMD_ARGV
[0]);
823 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
824 *out
= command_find(head
, CMD_ARGV
[0] + 4);
826 return ERROR_COMMAND_SYNTAX_ERROR
;
830 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
833 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
834 bool show_help
, const char *cmd_match
);
836 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
837 bool show_help
, const char *cmd_match
)
839 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
840 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
844 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
846 static void command_help_show_indent(unsigned n
)
848 for (unsigned i
= 0; i
< n
; i
++)
851 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
853 const char *cp
= str
, *last
= str
;
855 const char *next
= last
;
860 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
861 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
862 if (next
- last
< HELP_LINE_WIDTH(n
))
864 command_help_show_indent(n
);
865 LOG_USER("%.*s", (int)(cp
- last
), last
);
871 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
872 bool show_help
, const char *cmd_match
)
874 char *cmd_name
= command_name(c
, ' ');
875 if (NULL
== cmd_name
)
878 /* If the match string occurs anywhere, we print out
879 * stuff for this command. */
880 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
881 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
882 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
885 command_help_show_indent(n
);
886 LOG_USER_N("%s", cmd_name
);
891 if (c
->usage
&& strlen(c
->usage
) > 0) {
893 command_help_show_wrap(c
->usage
, 0, n
+ 5);
898 if (is_match
&& show_help
) {
901 /* Normal commands are runtime-only; highlight exceptions */
902 if (c
->mode
!= COMMAND_EXEC
) {
903 const char *stage_msg
= "";
907 stage_msg
= " (configuration command)";
910 stage_msg
= " (command valid any time)";
913 stage_msg
= " (?mode error?)";
916 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
918 msg
= alloc_printf("%s", c
->help
? : "");
921 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
928 LOG_ERROR("command recursion exceeded");
932 return CALL_COMMAND_HANDLER(command_help_show_list
,
933 c
->children
, n
, show_help
, cmd_match
);
936 COMMAND_HANDLER(handle_help_command
)
938 bool full
= strcmp(CMD_NAME
, "help") == 0;
940 struct command
*c
= CMD_CTX
->commands
;
941 char *cmd_match
= NULL
;
945 else if (CMD_ARGC
>= 1) {
948 for (i
= 0; i
< CMD_ARGC
; ++i
) {
949 if (NULL
!= cmd_match
) {
950 char *prev
= cmd_match
;
952 cmd_match
= alloc_printf("%s %s", cmd_match
, CMD_ARGV
[i
]);
954 if (NULL
== cmd_match
) {
955 LOG_ERROR("unable to build search string");
959 cmd_match
= alloc_printf("%s", CMD_ARGV
[i
]);
960 if (NULL
== cmd_match
) {
961 LOG_ERROR("unable to build search string");
967 return ERROR_COMMAND_SYNTAX_ERROR
;
969 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
970 c
, 0, full
, cmd_match
);
977 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
978 struct command
*head
, struct command
**out
, bool top_level
)
982 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
983 struct command
*c
= command_find(head
, cmd_name
);
984 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
985 c
= command_find(head
, cmd_name
+ 4);
989 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
992 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
994 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
995 if (strcmp(cmd_name
, "unknown") == 0) {
1001 script_debug(interp
, cmd_name
, argc
, argv
);
1003 struct command_context
*cmd_ctx
= current_command_context(interp
);
1004 struct command
*c
= cmd_ctx
->commands
;
1005 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
1006 /* if nothing could be consumed, then it's really an unknown command */
1007 if (remaining
== argc
) {
1008 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1009 LOG_ERROR("Unknown command:\n %s", cmd
);
1014 Jim_Obj
*const *start
;
1016 if (c
->handler
|| c
->jim_handler
) {
1017 /* include the command name in the list */
1018 count
= remaining
+ 1;
1019 start
= argv
+ (argc
- remaining
- 1);
1021 c
= command_find(cmd_ctx
->commands
, "usage");
1023 LOG_ERROR("unknown command, but usage is missing too");
1026 count
= argc
- remaining
;
1030 /* pass the command through to the intended handler */
1031 if (c
->jim_handler
) {
1032 interp
->cmdPrivData
= c
->jim_handler_data
;
1033 return (*c
->jim_handler
)(interp
, count
, start
);
1036 return script_command_run(interp
, count
, start
, c
, found
);
1039 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1041 struct command_context
*cmd_ctx
= current_command_context(interp
);
1042 enum command_mode mode
;
1045 struct command
*c
= cmd_ctx
->commands
;
1046 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1047 /* if nothing could be consumed, then it's an unknown command */
1048 if (remaining
== argc
- 1) {
1049 Jim_SetResultString(interp
, "unknown", -1);
1054 mode
= cmd_ctx
->mode
;
1056 const char *mode_str
;
1061 case COMMAND_CONFIG
:
1062 mode_str
= "config";
1068 mode_str
= "unknown";
1071 Jim_SetResultString(interp
, mode_str
, -1);
1075 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1080 struct command_context
*cmd_ctx
= current_command_context(interp
);
1081 struct command
*c
= cmd_ctx
->commands
;
1082 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1083 /* if nothing could be consumed, then it's an unknown command */
1084 if (remaining
== argc
- 1) {
1085 Jim_SetResultString(interp
, "unknown", -1);
1090 Jim_SetResultString(interp
, "native", -1);
1091 else if (c
->handler
)
1092 Jim_SetResultString(interp
, "simple", -1);
1093 else if (remaining
== 0)
1094 Jim_SetResultString(interp
, "group", -1);
1096 Jim_SetResultString(interp
, "unknown", -1);
1101 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1102 const char *cmd_name
, const char *help_text
, const char *usage
)
1104 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1105 struct command
*nc
= command_find(*head
, cmd_name
);
1107 /* add a new command with help text */
1108 struct command_registration cr
= {
1110 .mode
= COMMAND_ANY
,
1114 nc
= register_command(cmd_ctx
, parent
, &cr
);
1116 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1119 LOG_DEBUG("added '%s' help text", cmd_name
);
1123 bool replaced
= false;
1128 nc
->help
= strdup(help_text
);
1130 LOG_INFO("replaced existing '%s' help", cmd_name
);
1132 LOG_DEBUG("added '%s' help text", cmd_name
);
1135 bool replaced
= false;
1140 nc
->usage
= strdup(usage
);
1142 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1144 LOG_DEBUG("added '%s' usage text", cmd_name
);
1149 COMMAND_HANDLER(handle_help_add_command
)
1152 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1153 return ERROR_COMMAND_SYNTAX_ERROR
;
1156 /* save help text and remove it from argument list */
1157 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1158 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1159 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1160 if (!help
&& !usage
) {
1161 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1162 return ERROR_COMMAND_SYNTAX_ERROR
;
1164 /* likewise for the leaf command name */
1165 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1167 struct command
*c
= NULL
;
1169 c
= CMD_CTX
->commands
;
1170 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1171 if (ERROR_OK
!= retval
)
1174 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1177 /* sleep command sleeps for <n> milliseconds
1178 * this is useful in target startup scripts
1180 COMMAND_HANDLER(handle_sleep_command
)
1183 if (CMD_ARGC
== 2) {
1184 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1187 return ERROR_COMMAND_SYNTAX_ERROR
;
1188 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1189 return ERROR_COMMAND_SYNTAX_ERROR
;
1191 unsigned long duration
= 0;
1192 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1193 if (ERROR_OK
!= retval
)
1197 int64_t then
= timeval_ms();
1198 while (timeval_ms() - then
< (int64_t)duration
) {
1199 target_call_timer_callbacks_now();
1203 busy_sleep(duration
);
1208 static const struct command_registration command_subcommand_handlers
[] = {
1211 .mode
= COMMAND_ANY
,
1212 .jim_handler
= jim_command_mode
,
1213 .usage
= "[command_name ...]",
1214 .help
= "Returns the command modes allowed by a command:"
1215 "'any', 'config', or 'exec'. If no command is"
1216 "specified, returns the current command mode. "
1217 "Returns 'unknown' if an unknown command is given. "
1218 "Command can be multiple tokens.",
1222 .mode
= COMMAND_ANY
,
1223 .jim_handler
= jim_command_type
,
1224 .usage
= "command_name [...]",
1225 .help
= "Returns the type of built-in command:"
1226 "'native', 'simple', 'group', or 'unknown'. "
1227 "Command can be multiple tokens.",
1229 COMMAND_REGISTRATION_DONE
1232 static const struct command_registration command_builtin_handlers
[] = {
1235 .handler
= jim_echo
,
1236 .mode
= COMMAND_ANY
,
1237 .help
= "Logs a message at \"user\" priority. "
1238 "Output message to stdout. "
1239 "Option \"-n\" suppresses trailing newline",
1240 .usage
= "[-n] string",
1243 .name
= "add_help_text",
1244 .handler
= handle_help_add_command
,
1245 .mode
= COMMAND_ANY
,
1246 .help
= "Add new command help text; "
1247 "Command can be multiple tokens.",
1248 .usage
= "command_name helptext_string",
1251 .name
= "add_usage_text",
1252 .handler
= handle_help_add_command
,
1253 .mode
= COMMAND_ANY
,
1254 .help
= "Add new command usage text; "
1255 "command can be multiple tokens.",
1256 .usage
= "command_name usage_string",
1260 .handler
= handle_sleep_command
,
1261 .mode
= COMMAND_ANY
,
1262 .help
= "Sleep for specified number of milliseconds. "
1263 "\"busy\" will busy wait instead (avoid this).",
1264 .usage
= "milliseconds ['busy']",
1268 .handler
= handle_help_command
,
1269 .mode
= COMMAND_ANY
,
1270 .help
= "Show full command help; "
1271 "command can be multiple tokens.",
1272 .usage
= "[command_name]",
1276 .handler
= handle_help_command
,
1277 .mode
= COMMAND_ANY
,
1278 .help
= "Show basic command usage; "
1279 "command can be multiple tokens.",
1280 .usage
= "[command_name]",
1284 .mode
= COMMAND_ANY
,
1285 .help
= "core command group (introspection)",
1286 .chain
= command_subcommand_handlers
,
1288 COMMAND_REGISTRATION_DONE
1291 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1293 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1296 context
->mode
= COMMAND_EXEC
;
1298 /* Create a jim interpreter if we were not handed one */
1299 if (interp
== NULL
) {
1300 /* Create an interpreter */
1301 interp
= Jim_CreateInterp();
1302 /* Add all the Jim core commands */
1303 Jim_RegisterCoreCommands(interp
);
1304 Jim_InitStaticExtensions(interp
);
1307 context
->interp
= interp
;
1309 /* Stick to lowercase for HostOS strings. */
1310 #if defined(_MSC_VER)
1311 /* WinXX - is generic, the forward
1312 * looking problem is this:
1314 * "win32" or "win64"
1316 * "winxx" is generic.
1319 #elif defined(__linux__)
1321 #elif defined(__APPLE__) || defined(__DARWIN__)
1323 #elif defined(__CYGWIN__)
1325 #elif defined(__MINGW32__)
1327 #elif defined(__ECOS)
1329 #elif defined(__FreeBSD__)
1331 #elif defined(__NetBSD__)
1333 #elif defined(__OpenBSD__)
1336 #warning "Unrecognized host OS..."
1339 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1340 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1342 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1343 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1345 register_commands(context
, NULL
, command_builtin_handlers
);
1347 Jim_SetAssocData(interp
, "context", NULL
, context
);
1348 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1349 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1350 Jim_MakeErrorMessage(interp
);
1351 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1354 Jim_DeleteAssocData(interp
, "context");
1359 void command_exit(struct command_context
*context
)
1364 Jim_FreeInterp(context
->interp
);
1365 command_done(context
);
1368 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1371 return ERROR_COMMAND_SYNTAX_ERROR
;
1373 cmd_ctx
->mode
= mode
;
1377 void process_jim_events(struct command_context
*cmd_ctx
)
1379 static int recursion
;
1384 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1388 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1389 int parse ## name(const char *str, type * ul) \
1392 LOG_ERROR("Invalid command argument"); \
1393 return ERROR_COMMAND_ARGUMENT_INVALID; \
1396 *ul = func(str, &end, 0); \
1398 LOG_ERROR("Invalid command argument"); \
1399 return ERROR_COMMAND_ARGUMENT_INVALID; \
1401 if ((max == *ul) && (ERANGE == errno)) { \
1402 LOG_ERROR("Argument overflow"); \
1403 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1405 if (min && (min == *ul) && (ERANGE == errno)) { \
1406 LOG_ERROR("Argument underflow"); \
1407 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1411 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1412 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1413 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1414 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1416 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1417 int parse ## name(const char *str, type * ul) \
1420 int retval = parse ## funcname(str, &n); \
1421 if (ERROR_OK != retval) \
1424 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1426 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1431 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1432 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1433 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1434 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1435 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1436 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1437 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1439 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1441 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1442 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1443 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1444 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1445 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1446 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1447 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1449 static int command_parse_bool(const char *in
, bool *out
,
1450 const char *on
, const char *off
)
1452 if (strcasecmp(in
, on
) == 0)
1454 else if (strcasecmp(in
, off
) == 0)
1457 return ERROR_COMMAND_SYNTAX_ERROR
;
1461 int command_parse_bool_arg(const char *in
, bool *out
)
1463 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1465 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1467 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1469 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1471 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1473 return ERROR_COMMAND_SYNTAX_ERROR
;
1476 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1480 const char *in
= CMD_ARGV
[0];
1481 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1482 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1483 return ERROR_COMMAND_SYNTAX_ERROR
;
1488 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1491 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)