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, write to the *
26 * Free Software Foundation, Inc., *
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
28 ***************************************************************************/
34 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
37 /* @todo the inclusion of target.h here is a layering violation */
38 #include <jtag/jtag.h>
39 #include <target/target.h>
41 #include "configuration.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
46 /* nice short description of source file */
47 #define __THIS__FILE__ "command.c"
49 static int run_command(struct command_context
*context
,
50 struct command
*c
, const char *words
[], unsigned num_words
);
52 struct log_capture_state
{
57 static void tcl_output(void *privData
, const char *file
, unsigned line
,
58 const char *function
, const char *string
)
60 struct log_capture_state
*state
= privData
;
61 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
64 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
66 /* capture log output and return it. A garbage collect can
67 * happen, so we need a reference count to this object */
68 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
69 if (NULL
== tclOutput
)
72 struct log_capture_state
*state
= malloc(sizeof(*state
));
76 state
->interp
= interp
;
77 Jim_IncrRefCount(tclOutput
);
78 state
->output
= tclOutput
;
80 log_add_callback(tcl_output
, state
);
85 /* Classic openocd commands provide progress output which we
86 * will capture and return as a Tcl return value.
88 * However, if a non-openocd command has been invoked, then it
89 * makes sense to return the tcl return value from that command.
91 * The tcl return value is empty for openocd commands that provide
94 * Therefore we set the tcl return value only if we actually
97 static void command_log_capture_finish(struct log_capture_state
*state
)
102 log_remove_callback(tcl_output
, state
);
105 Jim_GetString(state
->output
, &length
);
108 Jim_SetResult(state
->interp
, state
->output
);
110 /* No output captured, use tcl return value (which could
113 Jim_DecrRefCount(state
->interp
, state
->output
);
118 static int command_retval_set(Jim_Interp
*interp
, int retval
)
120 int *return_retval
= Jim_GetAssocData(interp
, "retval");
121 if (return_retval
!= NULL
)
122 *return_retval
= retval
;
124 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
127 extern struct command_context
*global_cmd_ctx
;
129 /* dump a single line to the log for the command.
130 * Do nothing in case we are not at debug level 3 */
131 void script_debug(Jim_Interp
*interp
, const char *name
,
132 unsigned argc
, Jim_Obj
* const *argv
)
134 if (debug_level
< LOG_LVL_DEBUG
)
137 char *dbg
= alloc_printf("command - %s", name
);
138 for (unsigned i
= 0; i
< argc
; i
++) {
140 const char *w
= Jim_GetString(argv
[i
], &len
);
141 char *t
= alloc_printf("%s %s", dbg
, w
);
145 LOG_DEBUG("%s", dbg
);
149 static void script_command_args_free(char **words
, unsigned nwords
)
151 for (unsigned i
= 0; i
< nwords
; i
++)
156 static char **script_command_args_alloc(
157 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
159 char **words
= malloc(argc
* sizeof(char *));
164 for (i
= 0; i
< argc
; i
++) {
166 const char *w
= Jim_GetString(argv
[i
], &len
);
167 words
[i
] = strdup(w
);
168 if (words
[i
] == NULL
) {
169 script_command_args_free(words
, i
);
177 struct command_context
*current_command_context(Jim_Interp
*interp
)
179 /* grab the command context from the associated data */
180 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
181 if (NULL
== cmd_ctx
) {
182 /* Tcl can invoke commands directly instead of via command_run_line(). This would
183 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
184 * commands in a startup script.
186 * A telnet or gdb server would provide a non-default command context to
187 * handle piping of error output, have a separate current target, etc.
189 cmd_ctx
= global_cmd_ctx
;
194 static int script_command_run(Jim_Interp
*interp
,
195 int argc
, Jim_Obj
* const *argv
, struct command
*c
, bool capture
)
197 target_call_timer_callbacks_now();
198 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
201 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
205 struct log_capture_state
*state
= NULL
;
207 state
= command_log_capture_start(interp
);
209 struct command_context
*cmd_ctx
= current_command_context(interp
);
210 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
212 command_log_capture_finish(state
);
214 script_command_args_free(words
, nwords
);
215 return command_retval_set(interp
, retval
);
218 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
220 /* the private data is stashed in the interp structure */
222 struct command
*c
= interp
->cmdPrivData
;
224 script_debug(interp
, c
->name
, argc
, argv
);
225 return script_command_run(interp
, argc
, argv
, c
, true);
228 static struct command
*command_root(struct command
*c
)
230 while (NULL
!= c
->parent
)
236 * Find a command by name from a list of commands.
237 * @returns Returns the named command if it exists in the list.
238 * Returns NULL otherwise.
240 static struct command
*command_find(struct command
*head
, const char *name
)
242 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
243 if (strcmp(cc
->name
, name
) == 0)
249 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
252 return command_find(cmd_ctx
->commands
, name
);
254 struct command
*command_find_in_parent(struct command
*parent
,
257 return command_find(parent
->children
, name
);
261 * Add the command into the linked list, sorted by name.
262 * @param head Address to head of command list pointer, which may be
263 * updated if @c c gets inserted at the beginning of the list.
264 * @param c The command to add to the list pointed to by @c head.
266 static void command_add_child(struct command
**head
, struct command
*c
)
274 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
275 head
= &(*head
)->next
;
277 if (strcmp(c
->name
, (*head
)->name
) > 0) {
278 c
->next
= (*head
)->next
;
286 static struct command
**command_list_for_parent(
287 struct command_context
*cmd_ctx
, struct command
*parent
)
289 return parent
? &parent
->children
: &cmd_ctx
->commands
;
292 static void command_free(struct command
*c
)
294 /** @todo if command has a handler, unregister its jim command! */
296 while (NULL
!= c
->children
) {
297 struct command
*tmp
= c
->children
;
298 c
->children
= tmp
->next
;
308 static struct command
*command_new(struct command_context
*cmd_ctx
,
309 struct command
*parent
, const struct command_registration
*cr
)
314 * If it is a non-jim command with no .usage specified,
317 * strlen(.usage) == 0 means that the command takes no
320 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
321 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
322 "'.usage' field filled out",
323 parent
&& parent
->name
? parent
->name
: "",
324 parent
&& parent
->name
? " " : "",
328 struct command
*c
= calloc(1, sizeof(struct command
));
332 c
->name
= strdup(cr
->name
);
334 c
->help
= strdup(cr
->help
);
336 c
->usage
= strdup(cr
->usage
);
338 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
339 goto command_new_error
;
342 c
->handler
= cr
->handler
;
343 c
->jim_handler
= cr
->jim_handler
;
344 c
->jim_handler_data
= cr
->jim_handler_data
;
347 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
356 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
358 static int register_command_handler(struct command_context
*cmd_ctx
,
361 Jim_Interp
*interp
= cmd_ctx
->interp
;
362 char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
363 if (NULL
== ocd_name
)
366 LOG_DEBUG("registering '%s'...", ocd_name
);
368 Jim_CmdProc
*func
= c
->handler
? &script_command
: &command_unknown
;
369 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
371 if (JIM_OK
!= retval
)
374 /* we now need to add an overrideable proc */
375 char *override_name
= alloc_printf(
376 "proc %s {args} {eval ocd_bouncer %s $args}",
378 if (NULL
== override_name
)
381 retval
= Jim_Eval_Named(interp
, override_name
, 0, 0);
387 struct command
*register_command(struct command_context
*context
,
388 struct command
*parent
, const struct command_registration
*cr
)
390 if (!context
|| !cr
->name
)
393 const char *name
= cr
->name
;
394 struct command
**head
= command_list_for_parent(context
, parent
);
395 struct command
*c
= command_find(*head
, name
);
397 /* TODO: originally we treated attempting to register a cmd twice as an error
398 * Sometimes we need this behaviour, such as with flash banks.
399 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
400 LOG_DEBUG("command '%s' is already registered in '%s' context",
401 name
, parent
? parent
->name
: "<global>");
405 c
= command_new(context
, parent
, cr
);
409 int retval
= ERROR_OK
;
410 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
411 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
412 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
413 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
414 retval
= register_command_handler(context
, command_root(c
));
416 if (ERROR_OK
!= retval
) {
417 unregister_command(context
, parent
, name
);
423 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
424 const struct command_registration
*cmds
)
426 int retval
= ERROR_OK
;
428 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
429 const struct command_registration
*cr
= cmds
+ i
;
431 struct command
*c
= NULL
;
432 if (NULL
!= cr
->name
) {
433 c
= register_command(cmd_ctx
, parent
, cr
);
439 if (NULL
!= cr
->chain
) {
440 struct command
*p
= c
? : parent
;
441 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
442 if (ERROR_OK
!= retval
)
446 if (ERROR_OK
!= retval
) {
447 for (unsigned j
= 0; j
< i
; j
++)
448 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
453 int unregister_all_commands(struct command_context
*context
,
454 struct command
*parent
)
459 struct command
**head
= command_list_for_parent(context
, parent
);
460 while (NULL
!= *head
) {
461 struct command
*tmp
= *head
;
469 int unregister_command(struct command_context
*context
,
470 struct command
*parent
, const char *name
)
472 if ((!context
) || (!name
))
473 return ERROR_COMMAND_SYNTAX_ERROR
;
475 struct command
*p
= NULL
;
476 struct command
**head
= command_list_for_parent(context
, parent
);
477 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
478 if (strcmp(name
, c
->name
) != 0)
493 void command_set_handler_data(struct command
*c
, void *p
)
495 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
496 c
->jim_handler_data
= p
;
497 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
498 command_set_handler_data(cc
, p
);
501 void command_output_text(struct command_context
*context
, const char *data
)
503 if (context
&& context
->output_handler
&& data
)
504 context
->output_handler(context
, data
);
507 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
512 va_start(ap
, format
);
514 string
= alloc_vprintf(format
, ap
);
515 if (string
!= NULL
) {
516 /* we want this collected in the log + we also want to pick it up as a tcl return
519 * The latter bit isn't precisely neat, but will do for now.
521 LOG_USER_N("%s", string
);
522 /* We already printed it above
523 * command_output_text(context, string); */
530 void command_print(struct command_context
*context
, const char *format
, ...)
535 va_start(ap
, format
);
537 string
= alloc_vprintf(format
, ap
);
538 if (string
!= NULL
) {
539 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
541 /* we want this collected in the log + we also want to pick it up as a tcl return
544 * The latter bit isn't precisely neat, but will do for now.
546 LOG_USER_N("%s", string
);
547 /* We already printed it above
548 * command_output_text(context, string); */
555 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
558 unsigned len
= strlen(c
->name
);
559 if (NULL
== c
->parent
) {
560 /* allocate enough for the name, child names, and '\0' */
561 name
= malloc(len
+ extra
+ 1);
562 strcpy(name
, c
->name
);
564 /* parent's extra must include both the space and name */
565 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
566 char dstr
[2] = { delim
, 0 };
568 strcat(name
, c
->name
);
573 char *command_name(struct command
*c
, char delim
)
575 return __command_name(c
, delim
, 0);
578 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
580 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
583 static int run_command(struct command_context
*context
,
584 struct command
*c
, const char *words
[], unsigned num_words
)
586 if (!command_can_run(context
, c
)) {
587 /* Many commands may be run only before/after 'init' */
596 /* handle the impossible with humor; it guarantees a bug report! */
598 when
= "if Cthulhu is summoned by";
601 LOG_ERROR("The '%s' command must be used %s 'init'.",
606 struct command_invocation cmd
= {
610 .argc
= num_words
- 1,
613 int retval
= c
->handler(&cmd
);
614 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
615 /* Print help for command */
616 char *full_name
= command_name(c
, ' ');
617 if (NULL
!= full_name
) {
618 command_run_linef(context
, "usage %s", full_name
);
622 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
623 /* just fall through for a shutdown request */
624 } else if (retval
!= ERROR_OK
) {
625 /* we do not print out an error message because the command *should*
626 * have printed out an error
628 LOG_DEBUG("Command failed with error code %d", retval
);
634 int command_run_line(struct command_context
*context
, char *line
)
636 /* all the parent commands have been registered with the interpreter
637 * so, can just evaluate the line as a script and check for
640 /* run the line thru a script engine */
641 int retval
= ERROR_FAIL
;
643 /* Beware! This code needs to be reentrant. It is also possible
644 * for OpenOCD commands to be invoked directly from Tcl. This would
645 * happen when the Jim Tcl interpreter is provided by eCos for
648 Jim_Interp
*interp
= context
->interp
;
649 Jim_DeleteAssocData(interp
, "context");
650 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
651 if (retcode
== JIM_OK
) {
652 /* associated the return value */
653 Jim_DeleteAssocData(interp
, "retval");
654 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
655 if (retcode
== JIM_OK
) {
656 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
658 Jim_DeleteAssocData(interp
, "retval");
660 Jim_DeleteAssocData(interp
, "context");
662 if (retcode
== JIM_ERR
) {
663 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
) {
664 /* We do not print the connection closed error message */
665 Jim_MakeErrorMessage(interp
);
666 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
668 if (retval
== ERROR_OK
) {
669 /* It wasn't a low level OpenOCD command that failed */
673 } else if (retcode
== JIM_EXIT
) {
675 * exit(Jim_GetExitCode(interp)); */
680 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
684 for (i
= 0; i
< reslen
; i
+= 256) {
689 strncpy(buff
, result
+ i
, chunk
);
691 LOG_USER_N("%s", buff
);
700 int command_run_linef(struct command_context
*context
, const char *format
, ...)
702 int retval
= ERROR_FAIL
;
705 va_start(ap
, format
);
706 string
= alloc_vprintf(format
, ap
);
707 if (string
!= NULL
) {
708 retval
= command_run_line(context
, string
);
715 void command_set_output_handler(struct command_context
*context
,
716 command_output_handler_t output_handler
, void *priv
)
718 context
->output_handler
= output_handler
;
719 context
->output_handler_priv
= priv
;
722 struct command_context
*copy_command_context(struct command_context
*context
)
724 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
726 *copy_context
= *context
;
731 void command_done(struct command_context
*cmd_ctx
)
739 /* find full path to file */
740 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
744 const char *file
= Jim_GetString(argv
[1], NULL
);
745 char *full_path
= find_file(file
);
746 if (full_path
== NULL
)
748 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
751 Jim_SetResult(interp
, result
);
755 COMMAND_HANDLER(jim_echo
)
757 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
758 LOG_USER_N("%s", CMD_ARGV
[1]);
763 LOG_USER("%s", CMD_ARGV
[0]);
767 /* Capture progress output and return as tcl return value. If the
768 * progress output was empty, return tcl return value.
770 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
775 struct log_capture_state
*state
= command_log_capture_start(interp
);
777 /* disable polling during capture. This avoids capturing output
780 * This is necessary in order to avoid accidentally getting a non-empty
781 * string for tcl fn's.
783 bool save_poll
= jtag_poll_get_enabled();
785 jtag_poll_set_enabled(false);
787 const char *str
= Jim_GetString(argv
[1], NULL
);
788 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
790 jtag_poll_set_enabled(save_poll
);
792 command_log_capture_finish(state
);
797 static COMMAND_HELPER(command_help_find
, struct command
*head
,
798 struct command
**out
)
801 return ERROR_COMMAND_SYNTAX_ERROR
;
802 *out
= command_find(head
, CMD_ARGV
[0]);
803 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
804 *out
= command_find(head
, CMD_ARGV
[0] + 4);
806 return ERROR_COMMAND_SYNTAX_ERROR
;
810 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
813 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
814 bool show_help
, const char *cmd_match
);
816 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
817 bool show_help
, const char *cmd_match
)
819 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
820 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
824 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
826 static void command_help_show_indent(unsigned n
)
828 for (unsigned i
= 0; i
< n
; i
++)
831 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
833 const char *cp
= str
, *last
= str
;
835 const char *next
= last
;
840 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
841 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
842 if (next
- last
< HELP_LINE_WIDTH(n
))
844 command_help_show_indent(n
);
845 LOG_USER("%.*s", (int)(cp
- last
), last
);
851 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
852 bool show_help
, const char *cmd_match
)
854 char *cmd_name
= command_name(c
, ' ');
855 if (NULL
== cmd_name
)
858 /* If the match string occurs anywhere, we print out
859 * stuff for this command. */
860 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
861 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
862 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
865 command_help_show_indent(n
);
866 LOG_USER_N("%s", cmd_name
);
871 if (c
->usage
&& strlen(c
->usage
) > 0) {
873 command_help_show_wrap(c
->usage
, 0, n
+ 5);
878 if (is_match
&& show_help
) {
881 /* Normal commands are runtime-only; highlight exceptions */
882 if (c
->mode
!= COMMAND_EXEC
) {
883 const char *stage_msg
= "";
887 stage_msg
= " (configuration command)";
890 stage_msg
= " (command valid any time)";
893 stage_msg
= " (?mode error?)";
896 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
898 msg
= alloc_printf("%s", c
->help
? : "");
901 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
908 LOG_ERROR("command recursion exceeded");
912 return CALL_COMMAND_HANDLER(command_help_show_list
,
913 c
->children
, n
, show_help
, cmd_match
);
916 COMMAND_HANDLER(handle_help_command
)
918 bool full
= strcmp(CMD_NAME
, "help") == 0;
920 struct command
*c
= CMD_CTX
->commands
;
921 char *cmd_match
= NULL
;
925 else if (CMD_ARGC
>= 1) {
928 for (i
= 0; i
< CMD_ARGC
; ++i
) {
929 if (NULL
!= cmd_match
) {
930 char *prev
= cmd_match
;
932 cmd_match
= alloc_printf("%s %s", cmd_match
, CMD_ARGV
[i
]);
934 if (NULL
== cmd_match
) {
935 LOG_ERROR("unable to build search string");
939 cmd_match
= alloc_printf("%s", CMD_ARGV
[i
]);
940 if (NULL
== cmd_match
) {
941 LOG_ERROR("unable to build search string");
947 return ERROR_COMMAND_SYNTAX_ERROR
;
949 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
950 c
, 0, full
, cmd_match
);
957 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
958 struct command
*head
, struct command
**out
, bool top_level
)
962 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
963 struct command
*c
= command_find(head
, cmd_name
);
964 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
965 c
= command_find(head
, cmd_name
+ 4);
969 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
972 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
974 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
975 if (strcmp(cmd_name
, "unknown") == 0) {
981 script_debug(interp
, cmd_name
, argc
, argv
);
983 struct command_context
*cmd_ctx
= current_command_context(interp
);
984 struct command
*c
= cmd_ctx
->commands
;
985 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
986 /* if nothing could be consumed, then it's really an unknown command */
987 if (remaining
== argc
) {
988 const char *cmd
= Jim_GetString(argv
[0], NULL
);
989 LOG_ERROR("Unknown command:\n %s", cmd
);
994 Jim_Obj
*const *start
;
996 if (c
->handler
|| c
->jim_handler
) {
997 /* include the command name in the list */
998 count
= remaining
+ 1;
999 start
= argv
+ (argc
- remaining
- 1);
1001 c
= command_find(cmd_ctx
->commands
, "usage");
1003 LOG_ERROR("unknown command, but usage is missing too");
1006 count
= argc
- remaining
;
1010 /* pass the command through to the intended handler */
1011 if (c
->jim_handler
) {
1012 interp
->cmdPrivData
= c
->jim_handler_data
;
1013 return (*c
->jim_handler
)(interp
, count
, start
);
1016 return script_command_run(interp
, count
, start
, c
, found
);
1019 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1021 struct command_context
*cmd_ctx
= current_command_context(interp
);
1022 enum command_mode mode
;
1025 struct command
*c
= cmd_ctx
->commands
;
1026 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1027 /* if nothing could be consumed, then it's an unknown command */
1028 if (remaining
== argc
- 1) {
1029 Jim_SetResultString(interp
, "unknown", -1);
1034 mode
= cmd_ctx
->mode
;
1036 const char *mode_str
;
1041 case COMMAND_CONFIG
:
1042 mode_str
= "config";
1048 mode_str
= "unknown";
1051 Jim_SetResultString(interp
, mode_str
, -1);
1055 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1060 struct command_context
*cmd_ctx
= current_command_context(interp
);
1061 struct command
*c
= cmd_ctx
->commands
;
1062 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1063 /* if nothing could be consumed, then it's an unknown command */
1064 if (remaining
== argc
- 1) {
1065 Jim_SetResultString(interp
, "unknown", -1);
1070 Jim_SetResultString(interp
, "native", -1);
1071 else if (c
->handler
)
1072 Jim_SetResultString(interp
, "simple", -1);
1074 Jim_SetResultString(interp
, "group", -1);
1079 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1080 const char *cmd_name
, const char *help_text
, const char *usage
)
1082 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1083 struct command
*nc
= command_find(*head
, cmd_name
);
1085 /* add a new command with help text */
1086 struct command_registration cr
= {
1088 .mode
= COMMAND_ANY
,
1092 nc
= register_command(cmd_ctx
, parent
, &cr
);
1094 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1097 LOG_DEBUG("added '%s' help text", cmd_name
);
1101 bool replaced
= false;
1106 nc
->help
= strdup(help_text
);
1108 LOG_INFO("replaced existing '%s' help", cmd_name
);
1110 LOG_DEBUG("added '%s' help text", cmd_name
);
1113 bool replaced
= false;
1118 nc
->usage
= strdup(usage
);
1120 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1122 LOG_DEBUG("added '%s' usage text", cmd_name
);
1127 COMMAND_HANDLER(handle_help_add_command
)
1130 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1131 return ERROR_COMMAND_SYNTAX_ERROR
;
1134 /* save help text and remove it from argument list */
1135 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1136 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1137 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1138 if (!help
&& !usage
) {
1139 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1140 return ERROR_COMMAND_SYNTAX_ERROR
;
1142 /* likewise for the leaf command name */
1143 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1145 struct command
*c
= NULL
;
1147 c
= CMD_CTX
->commands
;
1148 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1149 if (ERROR_OK
!= retval
)
1152 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1155 /* sleep command sleeps for <n> milliseconds
1156 * this is useful in target startup scripts
1158 COMMAND_HANDLER(handle_sleep_command
)
1161 if (CMD_ARGC
== 2) {
1162 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1165 return ERROR_COMMAND_SYNTAX_ERROR
;
1166 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1167 return ERROR_COMMAND_SYNTAX_ERROR
;
1169 unsigned long duration
= 0;
1170 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1171 if (ERROR_OK
!= retval
)
1175 long long then
= timeval_ms();
1176 while (timeval_ms() - then
< (long long)duration
) {
1177 target_call_timer_callbacks_now();
1181 busy_sleep(duration
);
1186 static const struct command_registration command_subcommand_handlers
[] = {
1189 .mode
= COMMAND_ANY
,
1190 .jim_handler
= jim_command_mode
,
1191 .usage
= "[command_name ...]",
1192 .help
= "Returns the command modes allowed by a command:"
1193 "'any', 'config', or 'exec'. If no command is"
1194 "specified, returns the current command mode. "
1195 "Returns 'unknown' if an unknown command is given. "
1196 "Command can be multiple tokens.",
1200 .mode
= COMMAND_ANY
,
1201 .jim_handler
= jim_command_type
,
1202 .usage
= "command_name [...]",
1203 .help
= "Returns the type of built-in command:"
1204 "'native', 'simple', 'group', or 'unknown'. "
1205 "Command can be multiple tokens.",
1207 COMMAND_REGISTRATION_DONE
1210 static const struct command_registration command_builtin_handlers
[] = {
1213 .handler
= jim_echo
,
1214 .mode
= COMMAND_ANY
,
1215 .help
= "Logs a message at \"user\" priority. "
1216 "Output message to stdout. "
1217 "Option \"-n\" suppresses trailing newline",
1218 .usage
= "[-n] string",
1221 .name
= "add_help_text",
1222 .handler
= handle_help_add_command
,
1223 .mode
= COMMAND_ANY
,
1224 .help
= "Add new command help text; "
1225 "Command can be multiple tokens.",
1226 .usage
= "command_name helptext_string",
1229 .name
= "add_usage_text",
1230 .handler
= handle_help_add_command
,
1231 .mode
= COMMAND_ANY
,
1232 .help
= "Add new command usage text; "
1233 "command can be multiple tokens.",
1234 .usage
= "command_name usage_string",
1238 .handler
= handle_sleep_command
,
1239 .mode
= COMMAND_ANY
,
1240 .help
= "Sleep for specified number of milliseconds. "
1241 "\"busy\" will busy wait instead (avoid this).",
1242 .usage
= "milliseconds ['busy']",
1246 .handler
= handle_help_command
,
1247 .mode
= COMMAND_ANY
,
1248 .help
= "Show full command help; "
1249 "command can be multiple tokens.",
1250 .usage
= "[command_name]",
1254 .handler
= handle_help_command
,
1255 .mode
= COMMAND_ANY
,
1256 .help
= "Show basic command usage; "
1257 "command can be multiple tokens.",
1258 .usage
= "[command_name]",
1262 .mode
= COMMAND_ANY
,
1263 .help
= "core command group (introspection)",
1264 .chain
= command_subcommand_handlers
,
1266 COMMAND_REGISTRATION_DONE
1269 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1271 struct command_context
*context
= malloc(sizeof(struct command_context
));
1274 context
->mode
= COMMAND_EXEC
;
1275 context
->commands
= NULL
;
1276 context
->current_target
= 0;
1277 context
->output_handler
= NULL
;
1278 context
->output_handler_priv
= NULL
;
1280 /* Create a jim interpreter if we were not handed one */
1281 if (interp
== NULL
) {
1282 /* Create an interpreter */
1283 interp
= Jim_CreateInterp();
1284 /* Add all the Jim core commands */
1285 Jim_RegisterCoreCommands(interp
);
1286 Jim_InitStaticExtensions(interp
);
1289 context
->interp
= interp
;
1291 /* Stick to lowercase for HostOS strings. */
1292 #if defined(_MSC_VER)
1293 /* WinXX - is generic, the forward
1294 * looking problem is this:
1296 * "win32" or "win64"
1298 * "winxx" is generic.
1301 #elif defined(__linux__)
1303 #elif defined(__APPLE__) || defined(__DARWIN__)
1305 #elif defined(__CYGWIN__)
1307 #elif defined(__MINGW32__)
1309 #elif defined(__ECOS)
1311 #elif defined(__FreeBSD__)
1313 #elif defined(__NetBSD__)
1315 #elif defined(__OpenBSD__)
1318 #warning "Unrecognized host OS..."
1321 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1322 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1324 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1325 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1327 register_commands(context
, NULL
, command_builtin_handlers
);
1329 Jim_SetAssocData(interp
, "context", NULL
, context
);
1330 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1331 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1332 Jim_MakeErrorMessage(interp
);
1333 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1336 Jim_DeleteAssocData(interp
, "context");
1341 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1344 return ERROR_COMMAND_SYNTAX_ERROR
;
1346 cmd_ctx
->mode
= mode
;
1350 void process_jim_events(struct command_context
*cmd_ctx
)
1352 static int recursion
;
1357 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1361 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1362 int parse ## name(const char *str, type * ul) \
1365 LOG_ERROR("Invalid command argument"); \
1366 return ERROR_COMMAND_ARGUMENT_INVALID; \
1369 *ul = func(str, &end, 0); \
1371 LOG_ERROR("Invalid command argument"); \
1372 return ERROR_COMMAND_ARGUMENT_INVALID; \
1374 if ((max == *ul) && (ERANGE == errno)) { \
1375 LOG_ERROR("Argument overflow"); \
1376 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1378 if (min && (min == *ul) && (ERANGE == errno)) { \
1379 LOG_ERROR("Argument underflow"); \
1380 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1384 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1385 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1386 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1387 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1389 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1390 int parse ## name(const char *str, type * ul) \
1393 int retval = parse ## funcname(str, &n); \
1394 if (ERROR_OK != retval) \
1397 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1399 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1404 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1405 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1406 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1407 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1408 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1409 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1410 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1412 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1413 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1414 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1415 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1416 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1417 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1418 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1420 static int command_parse_bool(const char *in
, bool *out
,
1421 const char *on
, const char *off
)
1423 if (strcasecmp(in
, on
) == 0)
1425 else if (strcasecmp(in
, off
) == 0)
1428 return ERROR_COMMAND_SYNTAX_ERROR
;
1432 int command_parse_bool_arg(const char *in
, bool *out
)
1434 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1436 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1438 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1440 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1442 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1444 return ERROR_COMMAND_SYNTAX_ERROR
;
1447 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1451 const char *in
= CMD_ARGV
[0];
1452 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1453 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1454 return ERROR_COMMAND_SYNTAX_ERROR
;
1459 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1462 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)