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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
28 ***************************************************************************/
34 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
38 // @todo the inclusion of target.h here is a layering violation
39 #include <jtag/jtag.h>
40 #include <target/target.h>
42 #include "configuration.h"
44 #include "time_support.h"
45 #include "jim-eventloop.h"
48 /* nice short description of source file */
49 #define __THIS__FILE__ "command.c"
52 static int run_command(struct command_context
*context
,
53 struct command
*c
, const char *words
[], unsigned num_words
);
55 struct log_capture_state
{
60 static void tcl_output(void *privData
, const char *file
, unsigned line
,
61 const char *function
, const char *string
)
63 struct log_capture_state
*state
= (struct log_capture_state
*)privData
;
64 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
67 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
69 /* capture log output and return it. A garbage collect can
70 * happen, so we need a reference count to this object */
71 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
72 if (NULL
== tclOutput
)
75 struct log_capture_state
*state
= malloc(sizeof(*state
));
79 state
->interp
= interp
;
80 Jim_IncrRefCount(tclOutput
);
81 state
->output
= tclOutput
;
83 log_add_callback(tcl_output
, state
);
88 /* Classic openocd commands provide progress output which we
89 * will capture and return as a Tcl return value.
91 * However, if a non-openocd command has been invoked, then it
92 * makes sense to return the tcl return value from that command.
94 * The tcl return value is empty for openocd commands that provide
97 * Therefore we set the tcl return value only if we actually
100 static void command_log_capture_finish(struct log_capture_state
*state
)
105 log_remove_callback(tcl_output
, state
);
108 Jim_GetString(state
->output
, &length
);
112 Jim_SetResult(state
->interp
, state
->output
);
115 /* No output captured, use tcl return value (which could
118 Jim_DecrRefCount(state
->interp
, state
->output
);
123 static int command_retval_set(Jim_Interp
*interp
, int retval
)
125 int *return_retval
= Jim_GetAssocData(interp
, "retval");
126 if (return_retval
!= NULL
)
127 *return_retval
= retval
;
129 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
132 extern struct command_context
*global_cmd_ctx
;
134 /* dump a single line to the log for the command.
135 * Do nothing in case we are not at debug level 3 */
136 void script_debug(Jim_Interp
*interp
, const char *name
,
137 unsigned argc
, Jim_Obj
*const *argv
)
139 if (debug_level
< LOG_LVL_DEBUG
)
142 char * dbg
= alloc_printf("command - %s", name
);
143 for (unsigned i
= 0; i
< argc
; i
++)
146 const char *w
= Jim_GetString(argv
[i
], &len
);
148 /* end of line comment? */
152 char * t
= alloc_printf("%s %s", dbg
, w
);
156 LOG_DEBUG("%s", dbg
);
160 static void script_command_args_free(const char **words
, unsigned nwords
)
162 for (unsigned i
= 0; i
< nwords
; i
++)
163 free((void *)words
[i
]);
166 static const char **script_command_args_alloc(
167 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
169 const char **words
= malloc(argc
* sizeof(char *));
174 for (i
= 0; i
< argc
; i
++)
177 const char *w
= Jim_GetString(argv
[i
], &len
);
178 /* a comment may end the line early */
182 words
[i
] = strdup(w
);
183 if (words
[i
] == NULL
)
185 script_command_args_free(words
, i
);
193 struct command_context
*current_command_context(Jim_Interp
*interp
)
195 /* grab the command context from the associated data */
196 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
199 /* Tcl can invoke commands directly instead of via command_run_line(). This would
200 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
201 * commands in a startup script.
203 * A telnet or gdb server would provide a non-default command context to
204 * handle piping of error output, have a separate current target, etc.
206 cmd_ctx
= global_cmd_ctx
;
211 static int script_command_run(Jim_Interp
*interp
,
212 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
214 target_call_timer_callbacks_now();
215 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
218 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
222 struct log_capture_state
*state
= NULL
;
224 state
= command_log_capture_start(interp
);
226 struct command_context
*cmd_ctx
= current_command_context(interp
);
227 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
229 command_log_capture_finish(state
);
231 script_command_args_free(words
, nwords
);
232 return command_retval_set(interp
, retval
);
235 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
237 /* the private data is stashed in the interp structure */
239 struct command
*c
= interp
->cmdPrivData
;
241 script_debug(interp
, c
->name
, argc
, argv
);
242 return script_command_run(interp
, argc
, argv
, c
, true);
245 static struct command
*command_root(struct command
*c
)
247 while (NULL
!= c
->parent
)
253 * Find a command by name from a list of commands.
254 * @returns Returns the named command if it exists in the list.
255 * Returns NULL otherwise.
257 static struct command
*command_find(struct command
*head
, const char *name
)
259 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
261 if (strcmp(cc
->name
, name
) == 0)
266 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
269 return command_find(cmd_ctx
->commands
, name
);
271 struct command
*command_find_in_parent(struct command
*parent
,
274 return command_find(parent
->children
, name
);
278 * Add the command into the linked list, sorted by name.
279 * @param head Address to head of command list pointer, which may be
280 * updated if @c c gets inserted at the beginning of the list.
281 * @param c The command to add to the list pointed to by @c head.
283 static void command_add_child(struct command
**head
, struct command
*c
)
292 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
293 head
= &(*head
)->next
;
295 if (strcmp(c
->name
, (*head
)->name
) > 0) {
296 c
->next
= (*head
)->next
;
304 static struct command
**command_list_for_parent(
305 struct command_context
*cmd_ctx
, struct command
*parent
)
307 return parent
? &parent
->children
: &cmd_ctx
->commands
;
310 static void command_free(struct command
*c
)
312 /// @todo if command has a handler, unregister its jim command!
314 while (NULL
!= c
->children
)
316 struct command
*tmp
= c
->children
;
317 c
->children
= tmp
->next
;
324 free((void*)c
->help
);
326 free((void*)c
->usage
);
330 static struct command
*command_new(struct command_context
*cmd_ctx
,
331 struct command
*parent
, const struct command_registration
*cr
)
335 struct command
*c
= calloc(1, sizeof(struct command
));
339 c
->name
= strdup(cr
->name
);
341 c
->help
= strdup(cr
->help
);
343 c
->usage
= strdup(cr
->usage
);
345 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
346 goto command_new_error
;
349 c
->handler
= cr
->handler
;
350 c
->jim_handler
= cr
->jim_handler
;
351 c
->jim_handler_data
= cr
->jim_handler_data
;
354 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
363 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
365 static int register_command_handler(struct command_context
*cmd_ctx
,
368 Jim_Interp
*interp
= cmd_ctx
->interp
;
369 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
370 if (NULL
== ocd_name
)
373 LOG_DEBUG("registering '%s'...", ocd_name
);
375 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
376 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
377 free((void *)ocd_name
);
378 if (JIM_OK
!= retval
)
381 /* we now need to add an overrideable proc */
382 const char *override_name
= alloc_printf(
383 "proc %s {args} {eval ocd_bouncer %s $args}",
385 if (NULL
== override_name
)
388 retval
= Jim_Eval_Named(interp
, override_name
, 0, 0);
389 free((void *)override_name
);
394 struct command
* register_command(struct command_context
*context
,
395 struct command
*parent
, const struct command_registration
*cr
)
397 if (!context
|| !cr
->name
)
400 const char *name
= cr
->name
;
401 struct command
**head
= command_list_for_parent(context
, parent
);
402 struct command
*c
= command_find(*head
, name
);
405 /* TODO: originally we treated attempting to register a cmd twice as an error
406 * Sometimes we need this behaviour, such as with flash banks.
407 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
408 LOG_DEBUG("command '%s' is already registered in '%s' context",
409 name
, parent
? parent
->name
: "<global>");
413 c
= command_new(context
, parent
, cr
);
417 int retval
= ERROR_OK
;
418 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
420 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
421 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
423 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
424 retval
= register_command_handler(context
, command_root(c
));
426 if (ERROR_OK
!= retval
)
428 unregister_command(context
, parent
, name
);
434 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
435 const struct command_registration
*cmds
)
437 int retval
= ERROR_OK
;
439 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
441 const struct command_registration
*cr
= cmds
+ i
;
443 struct command
*c
= NULL
;
444 if (NULL
!= cr
->name
)
446 c
= register_command(cmd_ctx
, parent
, cr
);
453 if (NULL
!= cr
->chain
)
455 struct command
*p
= c
? : parent
;
456 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
457 if (ERROR_OK
!= retval
)
461 if (ERROR_OK
!= retval
)
463 for (unsigned j
= 0; j
< i
; j
++)
464 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
469 int unregister_all_commands(struct command_context
*context
,
470 struct command
*parent
)
475 struct command
**head
= command_list_for_parent(context
, parent
);
476 while (NULL
!= *head
)
478 struct command
*tmp
= *head
;
486 int unregister_command(struct command_context
*context
,
487 struct command
*parent
, const char *name
)
489 if ((!context
) || (!name
))
490 return ERROR_INVALID_ARGUMENTS
;
492 struct command
*p
= NULL
;
493 struct command
**head
= command_list_for_parent(context
, parent
);
494 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
496 if (strcmp(name
, c
->name
) != 0)
511 void command_set_handler_data(struct command
*c
, void *p
)
513 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
514 c
->jim_handler_data
= p
;
515 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
516 command_set_handler_data(cc
, p
);
519 void command_output_text(struct command_context
*context
, const char *data
)
521 if (context
&& context
->output_handler
&& data
) {
522 context
->output_handler(context
, data
);
526 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
531 va_start(ap
, format
);
533 string
= alloc_vprintf(format
, ap
);
536 /* we want this collected in the log + we also want to pick it up as a tcl return
539 * The latter bit isn't precisely neat, but will do for now.
541 LOG_USER_N("%s", string
);
542 /* We already printed it above */
543 /* command_output_text(context, string); */
550 void command_print(struct command_context
*context
, const char *format
, ...)
555 va_start(ap
, format
);
557 string
= alloc_vprintf(format
, ap
);
560 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
561 /* we want this collected in the log + we also want to pick it up as a tcl return
564 * The latter bit isn't precisely neat, but will do for now.
566 LOG_USER_N("%s", string
);
567 /* We already printed it above */
568 /* command_output_text(context, string); */
575 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
578 unsigned len
= strlen(c
->name
);
579 if (NULL
== c
->parent
) {
580 // allocate enough for the name, child names, and '\0'
581 name
= malloc(len
+ extra
+ 1);
582 strcpy(name
, c
->name
);
584 // parent's extra must include both the space and name
585 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
586 char dstr
[2] = { delim
, 0 };
588 strcat(name
, c
->name
);
592 char *command_name(struct command
*c
, char delim
)
594 return __command_name(c
, delim
, 0);
597 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
599 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
602 static int run_command(struct command_context
*context
,
603 struct command
*c
, const char *words
[], unsigned num_words
)
605 if (!command_can_run(context
, c
))
607 /* Many commands may be run only before/after 'init' */
610 case COMMAND_CONFIG
: when
= "before"; break;
611 case COMMAND_EXEC
: when
= "after"; break;
612 // handle the impossible with humor; it guarantees a bug report!
613 default: when
= "if Cthulhu is summoned by"; break;
615 LOG_ERROR("The '%s' command must be used %s 'init'.",
620 struct command_invocation cmd
= {
624 .argc
= num_words
- 1,
627 int retval
= c
->handler(&cmd
);
628 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
630 /* Print help for command */
631 char *full_name
= command_name(c
, ' ');
632 if (NULL
!= full_name
) {
633 command_run_linef(context
, "usage %s", full_name
);
638 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
640 /* just fall through for a shutdown request */
642 else if (retval
!= ERROR_OK
)
644 /* we do not print out an error message because the command *should*
645 * have printed out an error
647 LOG_DEBUG("Command failed with error code %d", retval
);
653 int command_run_line(struct command_context
*context
, char *line
)
655 /* all the parent commands have been registered with the interpreter
656 * so, can just evaluate the line as a script and check for
659 /* run the line thru a script engine */
660 int retval
= ERROR_FAIL
;
662 /* Beware! This code needs to be reentrant. It is also possible
663 * for OpenOCD commands to be invoked directly from Tcl. This would
664 * happen when the Jim Tcl interpreter is provided by eCos for
667 Jim_Interp
*interp
= context
->interp
;
668 Jim_DeleteAssocData(interp
, "context");
669 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
670 if (retcode
== JIM_OK
)
672 /* associated the return value */
673 Jim_DeleteAssocData(interp
, "retval");
674 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
675 if (retcode
== JIM_OK
)
677 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
679 Jim_DeleteAssocData(interp
, "retval");
681 Jim_DeleteAssocData(interp
, "context");
683 if (retcode
== JIM_ERR
) {
684 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
686 /* We do not print the connection closed error message */
687 Jim_MakeErrorMessage(interp
);
688 LOG_USER_N("%s\n", Jim_GetString(Jim_GetResult(interp
), NULL
));
690 if (retval
== ERROR_OK
)
692 /* It wasn't a low level OpenOCD command that failed */
696 } else if (retcode
== JIM_EXIT
) {
698 /* exit(Jim_GetExitCode(interp)); */
703 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
708 for (i
= 0; i
< reslen
; i
+= 256)
714 strncpy(buff
, result
+ i
, chunk
);
716 LOG_USER_N("%s", buff
);
718 LOG_USER_N("%s", "\n");
725 int command_run_linef(struct command_context
*context
, const char *format
, ...)
727 int retval
= ERROR_FAIL
;
730 va_start(ap
, format
);
731 string
= alloc_vprintf(format
, ap
);
734 retval
= command_run_line(context
, string
);
740 void command_set_output_handler(struct command_context
* context
,
741 command_output_handler_t output_handler
, void *priv
)
743 context
->output_handler
= output_handler
;
744 context
->output_handler_priv
= priv
;
747 struct command_context
* copy_command_context(struct command_context
* context
)
749 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
751 *copy_context
= *context
;
756 void command_done(struct command_context
*cmd_ctx
)
764 /* find full path to file */
765 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
769 const char *file
= Jim_GetString(argv
[1], NULL
);
770 char *full_path
= find_file(file
);
771 if (full_path
== NULL
)
773 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
776 Jim_SetResult(interp
, result
);
780 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
783 str
= Jim_GetString(argv
[1], NULL
);
784 if (argc
== 3 && !strcmp(str
, "-n"))
786 str
= Jim_GetString(argv
[2], NULL
);
787 LOG_USER_N("%s", str
);
796 /* Capture progress output and return as tcl return value. If the
797 * progress output was empty, return tcl return value.
799 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
804 struct log_capture_state
*state
= command_log_capture_start(interp
);
806 /* disable polling during capture. This avoids capturing output
809 * This is necessary in order to avoid accidentially getting a non-empty
810 * string for tcl fn's.
812 bool save_poll
= jtag_poll_get_enabled();
814 jtag_poll_set_enabled(false);
816 const char *str
= Jim_GetString(argv
[1], NULL
);
817 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
819 jtag_poll_set_enabled(save_poll
);
821 command_log_capture_finish(state
);
826 static COMMAND_HELPER(command_help_find
, struct command
*head
,
827 struct command
**out
)
830 return ERROR_INVALID_ARGUMENTS
;
831 *out
= command_find(head
, CMD_ARGV
[0]);
832 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
833 *out
= command_find(head
, CMD_ARGV
[0] + 4);
835 return ERROR_INVALID_ARGUMENTS
;
839 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
842 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
843 bool show_help
, const char *match
);
845 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
846 bool show_help
, const char *match
)
848 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
849 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, match
);
853 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
855 static void command_help_show_indent(unsigned n
)
857 for (unsigned i
= 0; i
< n
; i
++)
860 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
862 const char *cp
= str
, *last
= str
;
865 const char *next
= last
;
870 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
871 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
872 if (next
- last
< HELP_LINE_WIDTH(n
))
874 command_help_show_indent(n
);
875 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
881 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
882 bool show_help
, const char *match
)
884 char *cmd_name
= command_name(c
, ' ');
885 if (NULL
== cmd_name
)
888 /* If the match string occurs anywhere, we print out
889 * stuff for this command. */
890 bool is_match
= (strstr(cmd_name
, match
) != NULL
) ||
891 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
892 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
896 command_help_show_indent(n
);
897 LOG_USER_N("%s", cmd_name
);
905 command_help_show_wrap(c
->usage
, 0, n
+ 5);
911 if (is_match
&& show_help
)
915 /* Normal commands are runtime-only; highlight exceptions */
916 if (c
->mode
!= COMMAND_EXEC
) {
917 const char *stage_msg
= "";
921 stage_msg
= " (configuration command)";
924 stage_msg
= " (command valid any time)";
927 stage_msg
= " (?mode error?)";
930 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
932 msg
= alloc_printf("%s", c
->help
? : "");
936 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
945 return CALL_COMMAND_HANDLER(command_help_show_list
,
946 c
->children
, n
, show_help
, match
);
948 COMMAND_HANDLER(handle_help_command
)
950 bool full
= strcmp(CMD_NAME
, "help") == 0;
952 struct command
*c
= CMD_CTX
->commands
;
957 else if (CMD_ARGC
>= 1) {
960 for (i
= 0; i
< CMD_ARGC
; ++i
) {
964 match
= alloc_printf("%s %s", match
,
968 LOG_ERROR("unable to build "
973 match
= alloc_printf("%s", CMD_ARGV
[i
]);
975 LOG_ERROR("unable to build "
982 return ERROR_COMMAND_SYNTAX_ERROR
;
984 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
992 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
993 struct command
*head
, struct command
**out
, bool top_level
)
997 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
998 struct command
*c
= command_find(head
, cmd_name
);
999 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
1000 c
= command_find(head
, cmd_name
+ 4);
1004 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
1008 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1010 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1011 if (strcmp(cmd_name
, "unknown") == 0)
1018 script_debug(interp
, cmd_name
, argc
, argv
);
1020 struct command_context
*cmd_ctx
= current_command_context(interp
);
1021 struct command
*c
= cmd_ctx
->commands
;
1022 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
1023 // if nothing could be consumed, then it's really an unknown command
1024 if (remaining
== argc
)
1026 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1027 LOG_ERROR("Unknown command:\n %s", cmd
);
1032 Jim_Obj
*const *start
;
1034 if (c
->handler
|| c
->jim_handler
)
1036 // include the command name in the list
1037 count
= remaining
+ 1;
1038 start
= argv
+ (argc
- remaining
- 1);
1042 c
= command_find(cmd_ctx
->commands
, "usage");
1045 LOG_ERROR("unknown command, but usage is missing too");
1048 count
= argc
- remaining
;
1052 // pass the command through to the intended handler
1055 interp
->cmdPrivData
= c
->jim_handler_data
;
1056 return (*c
->jim_handler
)(interp
, count
, start
);
1059 return script_command_run(interp
, count
, start
, c
, found
);
1062 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1064 struct command_context
*cmd_ctx
= current_command_context(interp
);
1065 enum command_mode mode
;
1069 struct command
*c
= cmd_ctx
->commands
;
1070 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1071 // if nothing could be consumed, then it's an unknown command
1072 if (remaining
== argc
- 1)
1074 Jim_SetResultString(interp
, "unknown", -1);
1080 mode
= cmd_ctx
->mode
;
1082 const char *mode_str
;
1084 case COMMAND_ANY
: mode_str
= "any"; break;
1085 case COMMAND_CONFIG
: mode_str
= "config"; break;
1086 case COMMAND_EXEC
: mode_str
= "exec"; break;
1087 default: mode_str
= "unknown"; break;
1089 Jim_SetResultString(interp
, mode_str
, -1);
1093 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1098 struct command_context
*cmd_ctx
= current_command_context(interp
);
1099 struct command
*c
= cmd_ctx
->commands
;
1100 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1101 // if nothing could be consumed, then it's an unknown command
1102 if (remaining
== argc
- 1)
1104 Jim_SetResultString(interp
, "unknown", -1);
1109 Jim_SetResultString(interp
, "native", -1);
1110 else if (c
->handler
)
1111 Jim_SetResultString(interp
, "simple", -1);
1113 Jim_SetResultString(interp
, "group", -1);
1118 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1119 const char *cmd_name
, const char *help_text
, const char *usage
)
1121 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1122 struct command
*nc
= command_find(*head
, cmd_name
);
1125 // add a new command with help text
1126 struct command_registration cr
= {
1128 .mode
= COMMAND_ANY
,
1132 nc
= register_command(cmd_ctx
, parent
, &cr
);
1135 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1138 LOG_DEBUG("added '%s' help text", cmd_name
);
1143 bool replaced
= false;
1146 free((void *)nc
->help
);
1149 nc
->help
= strdup(help_text
);
1151 LOG_INFO("replaced existing '%s' help", cmd_name
);
1153 LOG_DEBUG("added '%s' help text", cmd_name
);
1157 bool replaced
= false;
1160 free((void *)nc
->usage
);
1163 nc
->usage
= strdup(usage
);
1165 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1167 LOG_DEBUG("added '%s' usage text", cmd_name
);
1172 COMMAND_HANDLER(handle_help_add_command
)
1176 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1177 return ERROR_INVALID_ARGUMENTS
;
1180 // save help text and remove it from argument list
1181 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1182 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1183 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1184 if (!help
&& !usage
)
1186 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1187 return ERROR_INVALID_ARGUMENTS
;
1189 // likewise for the leaf command name
1190 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1192 struct command
*c
= NULL
;
1195 c
= CMD_CTX
->commands
;
1196 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1197 if (ERROR_OK
!= retval
)
1200 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1203 /* sleep command sleeps for <n> milliseconds
1204 * this is useful in target startup scripts
1206 COMMAND_HANDLER(handle_sleep_command
)
1211 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1214 return ERROR_COMMAND_SYNTAX_ERROR
;
1216 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1217 return ERROR_COMMAND_SYNTAX_ERROR
;
1219 unsigned long duration
= 0;
1220 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1221 if (ERROR_OK
!= retval
)
1226 long long then
= timeval_ms();
1227 while (timeval_ms() - then
< (long long)duration
)
1229 target_call_timer_callbacks_now();
1234 busy_sleep(duration
);
1239 static const struct command_registration command_subcommand_handlers
[] = {
1242 .mode
= COMMAND_ANY
,
1243 .jim_handler
= jim_command_mode
,
1244 .usage
= "[command_name ...]",
1245 .help
= "Returns the command modes allowed by a command:"
1246 "'any', 'config', or 'exec'. If no command is"
1247 "specified, returns the current command mode. "
1248 "Returns 'unknown' if an unknown command is given. "
1249 "Command can be multiple tokens.",
1253 .mode
= COMMAND_ANY
,
1254 .jim_handler
= jim_command_type
,
1255 .usage
= "command_name [...]",
1256 .help
= "Returns the type of built-in command:"
1257 "'native', 'simple', 'group', or 'unknown'. "
1258 "Command can be multiple tokens.",
1260 COMMAND_REGISTRATION_DONE
1263 static const struct command_registration command_builtin_handlers
[] = {
1265 .name
= "add_help_text",
1266 .handler
= handle_help_add_command
,
1267 .mode
= COMMAND_ANY
,
1268 .help
= "Add new command help text; "
1269 "Command can be multiple tokens.",
1270 .usage
= "command_name helptext_string",
1273 .name
= "add_usage_text",
1274 .handler
= handle_help_add_command
,
1275 .mode
= COMMAND_ANY
,
1276 .help
= "Add new command usage text; "
1277 "command can be multiple tokens.",
1278 .usage
= "command_name usage_string",
1282 .handler
= handle_sleep_command
,
1283 .mode
= COMMAND_ANY
,
1284 .help
= "Sleep for specified number of milliseconds. "
1285 "\"busy\" will busy wait instead (avoid this).",
1286 .usage
= "milliseconds ['busy']",
1290 .handler
= handle_help_command
,
1291 .mode
= COMMAND_ANY
,
1292 .help
= "Show full command help; "
1293 "command can be multiple tokens.",
1294 .usage
= "[command_name]",
1298 .handler
= handle_help_command
,
1299 .mode
= COMMAND_ANY
,
1300 .help
= "Show basic command usage; "
1301 "command can be multiple tokens.",
1302 .usage
= "[command_name]",
1307 .help
= "core command group (introspection)",
1308 .chain
= command_subcommand_handlers
,
1310 COMMAND_REGISTRATION_DONE
1313 struct command_context
* command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1315 struct command_context
* context
= malloc(sizeof(struct command_context
));
1318 context
->mode
= COMMAND_EXEC
;
1319 context
->commands
= NULL
;
1320 context
->current_target
= 0;
1321 context
->output_handler
= NULL
;
1322 context
->output_handler_priv
= NULL
;
1324 #if !BUILD_ECOSBOARD
1325 /* Create a jim interpreter if we were not handed one */
1328 /* Create an interpreter */
1329 interp
= Jim_CreateInterp();
1330 /* Add all the Jim core commands */
1331 Jim_RegisterCoreCommands(interp
);
1332 Jim_InitStaticExtensions(interp
);
1335 context
->interp
= interp
;
1337 /* Stick to lowercase for HostOS strings. */
1338 #if defined(_MSC_VER)
1339 /* WinXX - is generic, the forward
1340 * looking problem is this:
1342 * "win32" or "win64"
1344 * "winxx" is generic.
1347 #elif defined(__linux__)
1349 #elif defined(__APPLE__) || defined(__DARWIN__)
1351 #elif defined(__CYGWIN__)
1353 #elif defined(__MINGW32__)
1355 #elif defined(__ECOS)
1357 #elif defined(__FreeBSD__)
1360 #warning "Unrecognized host OS..."
1363 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1364 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1366 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1367 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1368 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1370 register_commands(context
, NULL
, command_builtin_handlers
);
1372 Jim_SetAssocData(interp
, "context", NULL
, context
);
1373 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1375 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1376 Jim_MakeErrorMessage(interp
);
1377 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1380 Jim_DeleteAssocData(interp
, "context");
1385 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1388 return ERROR_INVALID_ARGUMENTS
;
1390 cmd_ctx
->mode
= mode
;
1394 void process_jim_events(struct command_context
*cmd_ctx
)
1396 #if !BUILD_ECOSBOARD
1397 static int recursion
= 0;
1402 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1407 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1408 int parse##name(const char *str, type *ul) \
1412 LOG_ERROR("Invalid command argument"); \
1413 return ERROR_COMMAND_ARGUMENT_INVALID; \
1416 *ul = func(str, &end, 0); \
1419 LOG_ERROR("Invalid command argument"); \
1420 return ERROR_COMMAND_ARGUMENT_INVALID; \
1422 if ((max == *ul) && (ERANGE == errno)) \
1424 LOG_ERROR("Argument overflow"); \
1425 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1427 if (min && (min == *ul) && (ERANGE == errno)) \
1429 LOG_ERROR("Argument underflow"); \
1430 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1434 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1435 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1436 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1437 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1439 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1440 int parse##name(const char *str, type *ul) \
1443 int retval = parse##funcname(str, &n); \
1444 if (ERROR_OK != retval) \
1447 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1449 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1454 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1455 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1456 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1457 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1458 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1459 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1461 #define DEFINE_PARSE_LONG(name, type, min, max) \
1462 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1463 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1464 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1465 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1466 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1468 static int command_parse_bool(const char *in
, bool *out
,
1469 const char *on
, const char *off
)
1471 if (strcasecmp(in
, on
) == 0)
1473 else if (strcasecmp(in
, off
) == 0)
1476 return ERROR_COMMAND_SYNTAX_ERROR
;
1480 int command_parse_bool_arg(const char *in
, bool *out
)
1482 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1484 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1486 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1488 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1490 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1492 return ERROR_INVALID_ARGUMENTS
;
1495 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1499 const char *in
= CMD_ARGV
[0];
1500 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1502 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1503 return ERROR_INVALID_ARGUMENTS
;
1508 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1511 return ERROR_INVALID_ARGUMENTS
;
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)