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
= (struct log_capture_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(const char **words
, unsigned nwords
)
151 for (unsigned i
= 0; i
< nwords
; i
++)
152 free((void *)words
[i
]);
156 static const char **script_command_args_alloc(
157 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
159 const 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 const 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
;
303 free((void *)c
->name
);
305 free((void *)c
->help
);
307 free((void *)c
->usage
);
311 static struct command
*command_new(struct command_context
*cmd_ctx
,
312 struct command
*parent
, const struct command_registration
*cr
)
317 * If it is a non-jim command with no .usage specified,
320 * strlen(.usage) == 0 means that the command takes no
323 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
324 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
325 "'.usage' field filled out",
326 parent
&& parent
->name
? parent
->name
: "",
327 parent
&& parent
->name
? " " : "",
331 struct command
*c
= calloc(1, sizeof(struct command
));
335 c
->name
= strdup(cr
->name
);
337 c
->help
= strdup(cr
->help
);
339 c
->usage
= strdup(cr
->usage
);
341 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
342 goto command_new_error
;
345 c
->handler
= cr
->handler
;
346 c
->jim_handler
= cr
->jim_handler
;
347 c
->jim_handler_data
= cr
->jim_handler_data
;
350 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
359 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
361 static int register_command_handler(struct command_context
*cmd_ctx
,
364 Jim_Interp
*interp
= cmd_ctx
->interp
;
365 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
366 if (NULL
== ocd_name
)
369 LOG_DEBUG("registering '%s'...", ocd_name
);
371 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
372 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
373 free((void *)ocd_name
);
374 if (JIM_OK
!= retval
)
377 /* we now need to add an overrideable proc */
378 const char *override_name
= alloc_printf(
379 "proc %s {args} {eval ocd_bouncer %s $args}",
381 if (NULL
== override_name
)
384 retval
= Jim_Eval_Named(interp
, override_name
, 0, 0);
385 free((void *)override_name
);
390 struct command
*register_command(struct command_context
*context
,
391 struct command
*parent
, const struct command_registration
*cr
)
393 if (!context
|| !cr
->name
)
396 const char *name
= cr
->name
;
397 struct command
**head
= command_list_for_parent(context
, parent
);
398 struct command
*c
= command_find(*head
, name
);
400 /* TODO: originally we treated attempting to register a cmd twice as an error
401 * Sometimes we need this behaviour, such as with flash banks.
402 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
403 LOG_DEBUG("command '%s' is already registered in '%s' context",
404 name
, parent
? parent
->name
: "<global>");
408 c
= command_new(context
, parent
, cr
);
412 int retval
= ERROR_OK
;
413 if (NULL
!= cr
->jim_handler
&& NULL
== parent
) {
414 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
415 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
416 } else if (NULL
!= cr
->handler
|| NULL
!= parent
)
417 retval
= register_command_handler(context
, command_root(c
));
419 if (ERROR_OK
!= retval
) {
420 unregister_command(context
, parent
, name
);
426 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
427 const struct command_registration
*cmds
)
429 int retval
= ERROR_OK
;
431 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
432 const struct command_registration
*cr
= cmds
+ i
;
434 struct command
*c
= NULL
;
435 if (NULL
!= cr
->name
) {
436 c
= register_command(cmd_ctx
, parent
, cr
);
442 if (NULL
!= cr
->chain
) {
443 struct command
*p
= c
? : parent
;
444 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
445 if (ERROR_OK
!= retval
)
449 if (ERROR_OK
!= retval
) {
450 for (unsigned j
= 0; j
< i
; j
++)
451 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
456 int unregister_all_commands(struct command_context
*context
,
457 struct command
*parent
)
462 struct command
**head
= command_list_for_parent(context
, parent
);
463 while (NULL
!= *head
) {
464 struct command
*tmp
= *head
;
472 int unregister_command(struct command_context
*context
,
473 struct command
*parent
, const char *name
)
475 if ((!context
) || (!name
))
476 return ERROR_COMMAND_SYNTAX_ERROR
;
478 struct command
*p
= NULL
;
479 struct command
**head
= command_list_for_parent(context
, parent
);
480 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
481 if (strcmp(name
, c
->name
) != 0)
496 void command_set_handler_data(struct command
*c
, void *p
)
498 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
499 c
->jim_handler_data
= p
;
500 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
501 command_set_handler_data(cc
, p
);
504 void command_output_text(struct command_context
*context
, const char *data
)
506 if (context
&& context
->output_handler
&& data
)
507 context
->output_handler(context
, data
);
510 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
515 va_start(ap
, format
);
517 string
= alloc_vprintf(format
, ap
);
518 if (string
!= NULL
) {
519 /* we want this collected in the log + we also want to pick it up as a tcl return
522 * The latter bit isn't precisely neat, but will do for now.
524 LOG_USER_N("%s", string
);
525 /* We already printed it above
526 * command_output_text(context, string); */
533 void command_print(struct command_context
*context
, const char *format
, ...)
538 va_start(ap
, format
);
540 string
= alloc_vprintf(format
, ap
);
541 if (string
!= NULL
) {
542 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
544 /* we want this collected in the log + we also want to pick it up as a tcl return
547 * The latter bit isn't precisely neat, but will do for now.
549 LOG_USER_N("%s", string
);
550 /* We already printed it above
551 * command_output_text(context, string); */
558 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
561 unsigned len
= strlen(c
->name
);
562 if (NULL
== c
->parent
) {
563 /* allocate enough for the name, child names, and '\0' */
564 name
= malloc(len
+ extra
+ 1);
565 strcpy(name
, c
->name
);
567 /* parent's extra must include both the space and name */
568 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
569 char dstr
[2] = { delim
, 0 };
571 strcat(name
, c
->name
);
576 char *command_name(struct command
*c
, char delim
)
578 return __command_name(c
, delim
, 0);
581 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
583 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
586 static int run_command(struct command_context
*context
,
587 struct command
*c
, const char *words
[], unsigned num_words
)
589 if (!command_can_run(context
, c
)) {
590 /* Many commands may be run only before/after 'init' */
599 /* handle the impossible with humor; it guarantees a bug report! */
601 when
= "if Cthulhu is summoned by";
604 LOG_ERROR("The '%s' command must be used %s 'init'.",
609 struct command_invocation cmd
= {
613 .argc
= num_words
- 1,
616 int retval
= c
->handler(&cmd
);
617 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
618 /* Print help for command */
619 char *full_name
= command_name(c
, ' ');
620 if (NULL
!= full_name
) {
621 command_run_linef(context
, "usage %s", full_name
);
625 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
626 /* just fall through for a shutdown request */
627 } else if (retval
!= ERROR_OK
) {
628 /* we do not print out an error message because the command *should*
629 * have printed out an error
631 LOG_DEBUG("Command failed with error code %d", retval
);
637 int command_run_line(struct command_context
*context
, char *line
)
639 /* all the parent commands have been registered with the interpreter
640 * so, can just evaluate the line as a script and check for
643 /* run the line thru a script engine */
644 int retval
= ERROR_FAIL
;
646 /* Beware! This code needs to be reentrant. It is also possible
647 * for OpenOCD commands to be invoked directly from Tcl. This would
648 * happen when the Jim Tcl interpreter is provided by eCos for
651 Jim_Interp
*interp
= context
->interp
;
652 Jim_DeleteAssocData(interp
, "context");
653 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
654 if (retcode
== JIM_OK
) {
655 /* associated the return value */
656 Jim_DeleteAssocData(interp
, "retval");
657 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
658 if (retcode
== JIM_OK
) {
659 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
661 Jim_DeleteAssocData(interp
, "retval");
663 Jim_DeleteAssocData(interp
, "context");
665 if (retcode
== JIM_ERR
) {
666 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
) {
667 /* We do not print the connection closed error message */
668 Jim_MakeErrorMessage(interp
);
669 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
671 if (retval
== ERROR_OK
) {
672 /* It wasn't a low level OpenOCD command that failed */
676 } else if (retcode
== JIM_EXIT
) {
678 * exit(Jim_GetExitCode(interp)); */
683 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
687 for (i
= 0; i
< reslen
; i
+= 256) {
692 strncpy(buff
, result
+ i
, chunk
);
694 LOG_USER_N("%s", buff
);
703 int command_run_linef(struct command_context
*context
, const char *format
, ...)
705 int retval
= ERROR_FAIL
;
708 va_start(ap
, format
);
709 string
= alloc_vprintf(format
, ap
);
710 if (string
!= NULL
) {
711 retval
= command_run_line(context
, string
);
718 void command_set_output_handler(struct command_context
*context
,
719 command_output_handler_t output_handler
, void *priv
)
721 context
->output_handler
= output_handler
;
722 context
->output_handler_priv
= priv
;
725 struct command_context
*copy_command_context(struct command_context
*context
)
727 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
729 *copy_context
= *context
;
734 void command_done(struct command_context
*cmd_ctx
)
742 /* find full path to file */
743 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
747 const char *file
= Jim_GetString(argv
[1], NULL
);
748 char *full_path
= find_file(file
);
749 if (full_path
== NULL
)
751 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
754 Jim_SetResult(interp
, result
);
758 COMMAND_HANDLER(jim_echo
)
760 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
761 LOG_USER_N("%s", CMD_ARGV
[1]);
766 LOG_USER("%s", CMD_ARGV
[0]);
770 /* Capture progress output and return as tcl return value. If the
771 * progress output was empty, return tcl return value.
773 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
778 struct log_capture_state
*state
= command_log_capture_start(interp
);
780 /* disable polling during capture. This avoids capturing output
783 * This is necessary in order to avoid accidentally getting a non-empty
784 * string for tcl fn's.
786 bool save_poll
= jtag_poll_get_enabled();
788 jtag_poll_set_enabled(false);
790 const char *str
= Jim_GetString(argv
[1], NULL
);
791 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
793 jtag_poll_set_enabled(save_poll
);
795 command_log_capture_finish(state
);
800 static COMMAND_HELPER(command_help_find
, struct command
*head
,
801 struct command
**out
)
804 return ERROR_COMMAND_SYNTAX_ERROR
;
805 *out
= command_find(head
, CMD_ARGV
[0]);
806 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
807 *out
= command_find(head
, CMD_ARGV
[0] + 4);
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 *match
);
819 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
820 bool show_help
, const char *match
)
822 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
823 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, 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 *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
, match
) != NULL
) ||
864 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
865 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
868 command_help_show_indent(n
);
869 LOG_USER_N("%s", cmd_name
);
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
, match
);
919 COMMAND_HANDLER(handle_help_command
)
921 bool full
= strcmp(CMD_NAME
, "help") == 0;
923 struct command
*c
= CMD_CTX
->commands
;
928 else if (CMD_ARGC
>= 1) {
931 for (i
= 0; i
< CMD_ARGC
; ++i
) {
935 match
= alloc_printf("%s %s", match
, CMD_ARGV
[i
]);
938 LOG_ERROR("unable to build search string");
942 match
= alloc_printf("%s", CMD_ARGV
[i
]);
944 LOG_ERROR("unable to build search string");
950 return ERROR_COMMAND_SYNTAX_ERROR
;
952 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
960 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
961 struct command
*head
, struct command
**out
, bool top_level
)
965 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
966 struct command
*c
= command_find(head
, cmd_name
);
967 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
968 c
= command_find(head
, cmd_name
+ 4);
972 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
975 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
977 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
978 if (strcmp(cmd_name
, "unknown") == 0) {
984 script_debug(interp
, cmd_name
, argc
, argv
);
986 struct command_context
*cmd_ctx
= current_command_context(interp
);
987 struct command
*c
= cmd_ctx
->commands
;
988 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
989 /* if nothing could be consumed, then it's really an unknown command */
990 if (remaining
== argc
) {
991 const char *cmd
= Jim_GetString(argv
[0], NULL
);
992 LOG_ERROR("Unknown command:\n %s", cmd
);
997 Jim_Obj
*const *start
;
999 if (c
->handler
|| c
->jim_handler
) {
1000 /* include the command name in the list */
1001 count
= remaining
+ 1;
1002 start
= argv
+ (argc
- remaining
- 1);
1004 c
= command_find(cmd_ctx
->commands
, "usage");
1006 LOG_ERROR("unknown command, but usage is missing too");
1009 count
= argc
- remaining
;
1013 /* pass the command through to the intended handler */
1014 if (c
->jim_handler
) {
1015 interp
->cmdPrivData
= c
->jim_handler_data
;
1016 return (*c
->jim_handler
)(interp
, count
, start
);
1019 return script_command_run(interp
, count
, start
, c
, found
);
1022 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1024 struct command_context
*cmd_ctx
= current_command_context(interp
);
1025 enum command_mode mode
;
1028 struct command
*c
= cmd_ctx
->commands
;
1029 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1030 /* if nothing could be consumed, then it's an unknown command */
1031 if (remaining
== argc
- 1) {
1032 Jim_SetResultString(interp
, "unknown", -1);
1037 mode
= cmd_ctx
->mode
;
1039 const char *mode_str
;
1044 case COMMAND_CONFIG
:
1045 mode_str
= "config";
1051 mode_str
= "unknown";
1054 Jim_SetResultString(interp
, mode_str
, -1);
1058 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1063 struct command_context
*cmd_ctx
= current_command_context(interp
);
1064 struct command
*c
= cmd_ctx
->commands
;
1065 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1066 /* if nothing could be consumed, then it's an unknown command */
1067 if (remaining
== argc
- 1) {
1068 Jim_SetResultString(interp
, "unknown", -1);
1073 Jim_SetResultString(interp
, "native", -1);
1074 else if (c
->handler
)
1075 Jim_SetResultString(interp
, "simple", -1);
1077 Jim_SetResultString(interp
, "group", -1);
1082 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1083 const char *cmd_name
, const char *help_text
, const char *usage
)
1085 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1086 struct command
*nc
= command_find(*head
, cmd_name
);
1088 /* add a new command with help text */
1089 struct command_registration cr
= {
1091 .mode
= COMMAND_ANY
,
1095 nc
= register_command(cmd_ctx
, parent
, &cr
);
1097 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1100 LOG_DEBUG("added '%s' help text", cmd_name
);
1104 bool replaced
= false;
1106 free((void *)nc
->help
);
1109 nc
->help
= strdup(help_text
);
1111 LOG_INFO("replaced existing '%s' help", cmd_name
);
1113 LOG_DEBUG("added '%s' help text", cmd_name
);
1116 bool replaced
= false;
1118 free((void *)nc
->usage
);
1121 nc
->usage
= strdup(usage
);
1123 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1125 LOG_DEBUG("added '%s' usage text", cmd_name
);
1130 COMMAND_HANDLER(handle_help_add_command
)
1133 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1134 return ERROR_COMMAND_SYNTAX_ERROR
;
1137 /* save help text and remove it from argument list */
1138 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1139 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1140 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1141 if (!help
&& !usage
) {
1142 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1143 return ERROR_COMMAND_SYNTAX_ERROR
;
1145 /* likewise for the leaf command name */
1146 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1148 struct command
*c
= NULL
;
1150 c
= CMD_CTX
->commands
;
1151 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1152 if (ERROR_OK
!= retval
)
1155 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1158 /* sleep command sleeps for <n> milliseconds
1159 * this is useful in target startup scripts
1161 COMMAND_HANDLER(handle_sleep_command
)
1164 if (CMD_ARGC
== 2) {
1165 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1168 return ERROR_COMMAND_SYNTAX_ERROR
;
1169 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1170 return ERROR_COMMAND_SYNTAX_ERROR
;
1172 unsigned long duration
= 0;
1173 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1174 if (ERROR_OK
!= retval
)
1178 long long then
= timeval_ms();
1179 while (timeval_ms() - then
< (long long)duration
) {
1180 target_call_timer_callbacks_now();
1184 busy_sleep(duration
);
1189 static const struct command_registration command_subcommand_handlers
[] = {
1192 .mode
= COMMAND_ANY
,
1193 .jim_handler
= jim_command_mode
,
1194 .usage
= "[command_name ...]",
1195 .help
= "Returns the command modes allowed by a command:"
1196 "'any', 'config', or 'exec'. If no command is"
1197 "specified, returns the current command mode. "
1198 "Returns 'unknown' if an unknown command is given. "
1199 "Command can be multiple tokens.",
1203 .mode
= COMMAND_ANY
,
1204 .jim_handler
= jim_command_type
,
1205 .usage
= "command_name [...]",
1206 .help
= "Returns the type of built-in command:"
1207 "'native', 'simple', 'group', or 'unknown'. "
1208 "Command can be multiple tokens.",
1210 COMMAND_REGISTRATION_DONE
1213 static const struct command_registration command_builtin_handlers
[] = {
1216 .handler
= jim_echo
,
1217 .mode
= COMMAND_ANY
,
1218 .help
= "Logs a message at \"user\" priority. "
1219 "Output message to stdout. "
1220 "Option \"-n\" suppresses trailing newline",
1221 .usage
= "[-n] string",
1224 .name
= "add_help_text",
1225 .handler
= handle_help_add_command
,
1226 .mode
= COMMAND_ANY
,
1227 .help
= "Add new command help text; "
1228 "Command can be multiple tokens.",
1229 .usage
= "command_name helptext_string",
1232 .name
= "add_usage_text",
1233 .handler
= handle_help_add_command
,
1234 .mode
= COMMAND_ANY
,
1235 .help
= "Add new command usage text; "
1236 "command can be multiple tokens.",
1237 .usage
= "command_name usage_string",
1241 .handler
= handle_sleep_command
,
1242 .mode
= COMMAND_ANY
,
1243 .help
= "Sleep for specified number of milliseconds. "
1244 "\"busy\" will busy wait instead (avoid this).",
1245 .usage
= "milliseconds ['busy']",
1249 .handler
= handle_help_command
,
1250 .mode
= COMMAND_ANY
,
1251 .help
= "Show full command help; "
1252 "command can be multiple tokens.",
1253 .usage
= "[command_name]",
1257 .handler
= handle_help_command
,
1258 .mode
= COMMAND_ANY
,
1259 .help
= "Show basic command usage; "
1260 "command can be multiple tokens.",
1261 .usage
= "[command_name]",
1265 .mode
= COMMAND_ANY
,
1266 .help
= "core command group (introspection)",
1267 .chain
= command_subcommand_handlers
,
1269 COMMAND_REGISTRATION_DONE
1272 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1274 struct command_context
*context
= malloc(sizeof(struct command_context
));
1277 context
->mode
= COMMAND_EXEC
;
1278 context
->commands
= NULL
;
1279 context
->current_target
= 0;
1280 context
->output_handler
= NULL
;
1281 context
->output_handler_priv
= NULL
;
1283 /* Create a jim interpreter if we were not handed one */
1284 if (interp
== NULL
) {
1285 /* Create an interpreter */
1286 interp
= Jim_CreateInterp();
1287 /* Add all the Jim core commands */
1288 Jim_RegisterCoreCommands(interp
);
1289 Jim_InitStaticExtensions(interp
);
1292 context
->interp
= interp
;
1294 /* Stick to lowercase for HostOS strings. */
1295 #if defined(_MSC_VER)
1296 /* WinXX - is generic, the forward
1297 * looking problem is this:
1299 * "win32" or "win64"
1301 * "winxx" is generic.
1304 #elif defined(__linux__)
1306 #elif defined(__APPLE__) || defined(__DARWIN__)
1308 #elif defined(__CYGWIN__)
1310 #elif defined(__MINGW32__)
1312 #elif defined(__ECOS)
1314 #elif defined(__FreeBSD__)
1316 #elif defined(__NetBSD__)
1318 #elif defined(__OpenBSD__)
1321 #warning "Unrecognized host OS..."
1324 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1325 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1327 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1328 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1330 register_commands(context
, NULL
, command_builtin_handlers
);
1332 Jim_SetAssocData(interp
, "context", NULL
, context
);
1333 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1334 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1335 Jim_MakeErrorMessage(interp
);
1336 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1339 Jim_DeleteAssocData(interp
, "context");
1344 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1347 return ERROR_COMMAND_SYNTAX_ERROR
;
1349 cmd_ctx
->mode
= mode
;
1353 void process_jim_events(struct command_context
*cmd_ctx
)
1355 static int recursion
;
1360 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1364 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1365 int parse ## name(const char *str, type * ul) \
1368 LOG_ERROR("Invalid command argument"); \
1369 return ERROR_COMMAND_ARGUMENT_INVALID; \
1372 *ul = func(str, &end, 0); \
1374 LOG_ERROR("Invalid command argument"); \
1375 return ERROR_COMMAND_ARGUMENT_INVALID; \
1377 if ((max == *ul) && (ERANGE == errno)) { \
1378 LOG_ERROR("Argument overflow"); \
1379 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1381 if (min && (min == *ul) && (ERANGE == errno)) { \
1382 LOG_ERROR("Argument underflow"); \
1383 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1387 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1388 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1389 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1390 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1392 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1393 int parse ## name(const char *str, type * ul) \
1396 int retval = parse ## funcname(str, &n); \
1397 if (ERROR_OK != retval) \
1400 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1402 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1407 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1408 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1409 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1410 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1411 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1412 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1414 #define DEFINE_PARSE_LONG(name, type, min, max) \
1415 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1416 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1417 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1418 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1419 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1421 static int command_parse_bool(const char *in
, bool *out
,
1422 const char *on
, const char *off
)
1424 if (strcasecmp(in
, on
) == 0)
1426 else if (strcasecmp(in
, off
) == 0)
1429 return ERROR_COMMAND_SYNTAX_ERROR
;
1433 int command_parse_bool_arg(const char *in
, bool *out
)
1435 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1437 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1439 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1441 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1443 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1445 return ERROR_COMMAND_SYNTAX_ERROR
;
1448 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1452 const char *in
= CMD_ARGV
[0];
1453 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1454 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1455 return ERROR_COMMAND_SYNTAX_ERROR
;
1460 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1463 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)