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 ***************************************************************************/
35 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
39 /* @todo the inclusion of target.h here is a layering violation */
40 #include <jtag/jtag.h>
41 #include <target/target.h>
43 #include "configuration.h"
45 #include "time_support.h"
46 #include "jim-eventloop.h"
48 /* nice short description of source file */
49 #define __THIS__FILE__ "command.c"
51 static int run_command(struct command_context
*context
,
52 struct command
*c
, const char *words
[], unsigned num_words
);
54 struct log_capture_state
{
59 static void tcl_output(void *privData
, const char *file
, unsigned line
,
60 const char *function
, const char *string
)
62 struct log_capture_state
*state
= (struct log_capture_state
*)privData
;
63 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
66 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
68 /* capture log output and return it. A garbage collect can
69 * happen, so we need a reference count to this object */
70 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
71 if (NULL
== tclOutput
)
74 struct log_capture_state
*state
= malloc(sizeof(*state
));
78 state
->interp
= interp
;
79 Jim_IncrRefCount(tclOutput
);
80 state
->output
= tclOutput
;
82 log_add_callback(tcl_output
, state
);
87 /* Classic openocd commands provide progress output which we
88 * will capture and return as a Tcl return value.
90 * However, if a non-openocd command has been invoked, then it
91 * makes sense to return the tcl return value from that command.
93 * The tcl return value is empty for openocd commands that provide
96 * Therefore we set the tcl return value only if we actually
99 static void command_log_capture_finish(struct log_capture_state
*state
)
104 log_remove_callback(tcl_output
, state
);
107 Jim_GetString(state
->output
, &length
);
110 Jim_SetResult(state
->interp
, state
->output
);
112 /* No output captured, use tcl return value (which could
115 Jim_DecrRefCount(state
->interp
, state
->output
);
120 static int command_retval_set(Jim_Interp
*interp
, int retval
)
122 int *return_retval
= Jim_GetAssocData(interp
, "retval");
123 if (return_retval
!= NULL
)
124 *return_retval
= retval
;
126 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
129 extern struct command_context
*global_cmd_ctx
;
131 /* dump a single line to the log for the command.
132 * Do nothing in case we are not at debug level 3 */
133 void script_debug(Jim_Interp
*interp
, const char *name
,
134 unsigned argc
, Jim_Obj
* const *argv
)
136 if (debug_level
< LOG_LVL_DEBUG
)
139 char *dbg
= alloc_printf("command - %s", name
);
140 for (unsigned i
= 0; i
< argc
; i
++) {
142 const char *w
= Jim_GetString(argv
[i
], &len
);
143 char *t
= alloc_printf("%s %s", dbg
, w
);
147 LOG_DEBUG("%s", dbg
);
151 static void script_command_args_free(const char **words
, unsigned nwords
)
153 for (unsigned i
= 0; i
< nwords
; i
++)
154 free((void *)words
[i
]);
157 static const char **script_command_args_alloc(
158 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
160 const char **words
= malloc(argc
* sizeof(char *));
165 for (i
= 0; i
< argc
; i
++) {
167 const char *w
= Jim_GetString(argv
[i
], &len
);
168 words
[i
] = strdup(w
);
169 if (words
[i
] == NULL
) {
170 script_command_args_free(words
, i
);
178 struct command_context
*current_command_context(Jim_Interp
*interp
)
180 /* grab the command context from the associated data */
181 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
182 if (NULL
== cmd_ctx
) {
183 /* Tcl can invoke commands directly instead of via command_run_line(). This would
184 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
185 * commands in a startup script.
187 * A telnet or gdb server would provide a non-default command context to
188 * handle piping of error output, have a separate current target, etc.
190 cmd_ctx
= global_cmd_ctx
;
195 static int script_command_run(Jim_Interp
*interp
,
196 int argc
, Jim_Obj
* const *argv
, struct command
*c
, bool capture
)
198 target_call_timer_callbacks_now();
199 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
202 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
206 struct log_capture_state
*state
= NULL
;
208 state
= command_log_capture_start(interp
);
210 struct command_context
*cmd_ctx
= current_command_context(interp
);
211 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
213 command_log_capture_finish(state
);
215 script_command_args_free(words
, nwords
);
216 return command_retval_set(interp
, retval
);
219 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
221 /* the private data is stashed in the interp structure */
223 struct command
*c
= interp
->cmdPrivData
;
225 script_debug(interp
, c
->name
, argc
, argv
);
226 return script_command_run(interp
, argc
, argv
, c
, true);
229 static struct command
*command_root(struct command
*c
)
231 while (NULL
!= c
->parent
)
237 * Find a command by name from a list of commands.
238 * @returns Returns the named command if it exists in the list.
239 * Returns NULL otherwise.
241 static struct command
*command_find(struct command
*head
, const char *name
)
243 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
244 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
);
575 char *command_name(struct command
*c
, char delim
)
577 return __command_name(c
, delim
, 0);
580 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
582 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
585 static int run_command(struct command_context
*context
,
586 struct command
*c
, const char *words
[], unsigned num_words
)
588 if (!command_can_run(context
, c
)) {
589 /* Many commands may be run only before/after 'init' */
598 /* handle the impossible with humor; it guarantees a bug report! */
600 when
= "if Cthulhu is summoned by";
603 LOG_ERROR("The '%s' command must be used %s 'init'.",
608 struct command_invocation cmd
= {
612 .argc
= num_words
- 1,
615 int retval
= c
->handler(&cmd
);
616 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
617 /* Print help for command */
618 char *full_name
= command_name(c
, ' ');
619 if (NULL
!= full_name
) {
620 command_run_linef(context
, "usage %s", full_name
);
624 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
625 /* just fall through for a shutdown request */
626 } else if (retval
!= ERROR_OK
) {
627 /* we do not print out an error message because the command *should*
628 * have printed out an error
630 LOG_DEBUG("Command failed with error code %d", retval
);
636 int command_run_line(struct command_context
*context
, char *line
)
638 /* all the parent commands have been registered with the interpreter
639 * so, can just evaluate the line as a script and check for
642 /* run the line thru a script engine */
643 int retval
= ERROR_FAIL
;
645 /* Beware! This code needs to be reentrant. It is also possible
646 * for OpenOCD commands to be invoked directly from Tcl. This would
647 * happen when the Jim Tcl interpreter is provided by eCos for
650 Jim_Interp
*interp
= context
->interp
;
651 Jim_DeleteAssocData(interp
, "context");
652 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
653 if (retcode
== JIM_OK
) {
654 /* associated the return value */
655 Jim_DeleteAssocData(interp
, "retval");
656 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
657 if (retcode
== JIM_OK
) {
658 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
660 Jim_DeleteAssocData(interp
, "retval");
662 Jim_DeleteAssocData(interp
, "context");
664 if (retcode
== JIM_ERR
) {
665 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
) {
666 /* We do not print the connection closed error message */
667 Jim_MakeErrorMessage(interp
);
668 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
670 if (retval
== ERROR_OK
) {
671 /* It wasn't a low level OpenOCD command that failed */
675 } else if (retcode
== JIM_EXIT
) {
677 * exit(Jim_GetExitCode(interp)); */
682 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
686 for (i
= 0; i
< reslen
; i
+= 256) {
691 strncpy(buff
, result
+ i
, chunk
);
693 LOG_USER_N("%s", buff
);
702 int command_run_linef(struct command_context
*context
, const char *format
, ...)
704 int retval
= ERROR_FAIL
;
707 va_start(ap
, format
);
708 string
= alloc_vprintf(format
, ap
);
709 if (string
!= NULL
) {
710 retval
= command_run_line(context
, string
);
717 void command_set_output_handler(struct command_context
*context
,
718 command_output_handler_t output_handler
, void *priv
)
720 context
->output_handler
= output_handler
;
721 context
->output_handler_priv
= priv
;
724 struct command_context
*copy_command_context(struct command_context
*context
)
726 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
728 *copy_context
= *context
;
733 void command_done(struct command_context
*cmd_ctx
)
741 /* find full path to file */
742 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
746 const char *file
= Jim_GetString(argv
[1], NULL
);
747 char *full_path
= find_file(file
);
748 if (full_path
== NULL
)
750 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
753 Jim_SetResult(interp
, result
);
757 COMMAND_HANDLER(jim_echo
)
759 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
760 LOG_USER_N("%s", CMD_ARGV
[1]);
765 LOG_USER("%s", CMD_ARGV
[0]);
769 /* Capture progress output and return as tcl return value. If the
770 * progress output was empty, return tcl return value.
772 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
777 struct log_capture_state
*state
= command_log_capture_start(interp
);
779 /* disable polling during capture. This avoids capturing output
782 * This is necessary in order to avoid accidentially getting a non-empty
783 * string for tcl fn's.
785 bool save_poll
= jtag_poll_get_enabled();
787 jtag_poll_set_enabled(false);
789 const char *str
= Jim_GetString(argv
[1], NULL
);
790 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
792 jtag_poll_set_enabled(save_poll
);
794 command_log_capture_finish(state
);
799 static COMMAND_HELPER(command_help_find
, struct command
*head
,
800 struct command
**out
)
803 return ERROR_COMMAND_SYNTAX_ERROR
;
804 *out
= command_find(head
, CMD_ARGV
[0]);
805 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
806 *out
= command_find(head
, CMD_ARGV
[0] + 4);
808 return ERROR_COMMAND_SYNTAX_ERROR
;
812 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
815 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
816 bool show_help
, const char *match
);
818 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
819 bool show_help
, const char *match
)
821 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
822 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, match
);
826 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
828 static void command_help_show_indent(unsigned n
)
830 for (unsigned i
= 0; i
< n
; i
++)
833 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
835 const char *cp
= str
, *last
= str
;
837 const char *next
= last
;
842 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
843 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
844 if (next
- last
< HELP_LINE_WIDTH(n
))
846 command_help_show_indent(n
);
847 LOG_USER("%.*s", (int)(cp
- last
), last
);
852 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
853 bool show_help
, const char *match
)
855 char *cmd_name
= command_name(c
, ' ');
856 if (NULL
== cmd_name
)
859 /* If the match string occurs anywhere, we print out
860 * stuff for this command. */
861 bool is_match
= (strstr(cmd_name
, match
) != NULL
) ||
862 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
863 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
866 command_help_show_indent(n
);
867 LOG_USER_N("%s", cmd_name
);
874 command_help_show_wrap(c
->usage
, 0, n
+ 5);
879 if (is_match
&& show_help
) {
882 /* Normal commands are runtime-only; highlight exceptions */
883 if (c
->mode
!= COMMAND_EXEC
) {
884 const char *stage_msg
= "";
888 stage_msg
= " (configuration command)";
891 stage_msg
= " (command valid any time)";
894 stage_msg
= " (?mode error?)";
897 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
899 msg
= alloc_printf("%s", c
->help
? : "");
902 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
909 LOG_ERROR("command recursion exceeded");
913 return CALL_COMMAND_HANDLER(command_help_show_list
,
914 c
->children
, n
, show_help
, match
);
916 COMMAND_HANDLER(handle_help_command
)
918 bool full
= strcmp(CMD_NAME
, "help") == 0;
920 struct command
*c
= CMD_CTX
->commands
;
925 else if (CMD_ARGC
>= 1) {
928 for (i
= 0; i
< CMD_ARGC
; ++i
) {
932 match
= alloc_printf("%s %s", match
,
936 LOG_ERROR("unable to build "
941 match
= alloc_printf("%s", CMD_ARGV
[i
]);
943 LOG_ERROR("unable to build "
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 #if !BUILD_ECOSBOARD
1284 /* Create a jim interpreter if we were not handed one */
1285 if (interp
== NULL
) {
1286 /* Create an interpreter */
1287 interp
= Jim_CreateInterp();
1288 /* Add all the Jim core commands */
1289 Jim_RegisterCoreCommands(interp
);
1290 Jim_InitStaticExtensions(interp
);
1293 context
->interp
= interp
;
1295 /* Stick to lowercase for HostOS strings. */
1296 #if defined(_MSC_VER)
1297 /* WinXX - is generic, the forward
1298 * looking problem is this:
1300 * "win32" or "win64"
1302 * "winxx" is generic.
1305 #elif defined(__linux__)
1307 #elif defined(__APPLE__) || defined(__DARWIN__)
1309 #elif defined(__CYGWIN__)
1311 #elif defined(__MINGW32__)
1313 #elif defined(__ECOS)
1315 #elif defined(__FreeBSD__)
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 #if !BUILD_ECOSBOARD
1353 static int recursion
;
1358 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1363 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1364 int parse ## name(const char *str, type * ul) \
1367 LOG_ERROR("Invalid command argument"); \
1368 return ERROR_COMMAND_ARGUMENT_INVALID; \
1371 *ul = func(str, &end, 0); \
1373 LOG_ERROR("Invalid command argument"); \
1374 return ERROR_COMMAND_ARGUMENT_INVALID; \
1376 if ((max == *ul) && (ERANGE == errno)) { \
1377 LOG_ERROR("Argument overflow"); \
1378 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1380 if (min && (min == *ul) && (ERANGE == errno)) { \
1381 LOG_ERROR("Argument underflow"); \
1382 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1386 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1387 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1388 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1389 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1391 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1392 int parse ## name(const char *str, type * ul) \
1395 int retval = parse ## funcname(str, &n); \
1396 if (ERROR_OK != retval) \
1399 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1401 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1406 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1407 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1408 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1409 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1410 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1411 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1413 #define DEFINE_PARSE_LONG(name, type, min, max) \
1414 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1415 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1416 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1417 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1418 DEFINE_PARSE_LONG(_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
;