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 <target/target.h>
41 #include "configuration.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
47 /* nice short description of source file */
48 #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 static void command_log_capture_finish(struct log_capture_state
*state
)
92 log_remove_callback(tcl_output
, state
);
94 Jim_SetResult(state
->interp
, state
->output
);
95 Jim_DecrRefCount(state
->interp
, state
->output
);
100 static int command_retval_set(Jim_Interp
*interp
, int retval
)
102 int *return_retval
= Jim_GetAssocData(interp
, "retval");
103 if (return_retval
!= NULL
)
104 *return_retval
= retval
;
106 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
109 extern struct command_context
*global_cmd_ctx
;
111 /* dump a single line to the log for the command.
112 * Do nothing in case we are not at debug level 3 */
113 void script_debug(Jim_Interp
*interp
, const char *name
,
114 unsigned argc
, Jim_Obj
*const *argv
)
116 if (debug_level
< LOG_LVL_DEBUG
)
119 char * dbg
= alloc_printf("command - %s", name
);
120 for (unsigned i
= 0; i
< argc
; i
++)
123 const char *w
= Jim_GetString(argv
[i
], &len
);
125 /* end of line comment? */
129 char * t
= alloc_printf("%s %s", dbg
, w
);
133 LOG_DEBUG("%s", dbg
);
137 static void script_command_args_free(const char **words
, unsigned nwords
)
139 for (unsigned i
= 0; i
< nwords
; i
++)
140 free((void *)words
[i
]);
143 static const char **script_command_args_alloc(
144 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
146 const char **words
= malloc(argc
* sizeof(char *));
151 for (i
= 0; i
< argc
; i
++)
154 const char *w
= Jim_GetString(argv
[i
], &len
);
155 /* a comment may end the line early */
159 words
[i
] = strdup(w
);
160 if (words
[i
] == NULL
)
162 script_command_args_free(words
, i
);
170 struct command_context
*current_command_context(Jim_Interp
*interp
)
172 /* grab the command context from the associated data */
173 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
176 /* Tcl can invoke commands directly instead of via command_run_line(). This would
177 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
178 * commands in a startup script.
180 * A telnet or gdb server would provide a non-default command context to
181 * handle piping of error output, have a separate current target, etc.
183 cmd_ctx
= global_cmd_ctx
;
188 static int script_command_run(Jim_Interp
*interp
,
189 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
191 target_call_timer_callbacks_now();
192 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
195 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
199 struct log_capture_state
*state
= NULL
;
201 state
= command_log_capture_start(interp
);
203 struct command_context
*cmd_ctx
= current_command_context(interp
);
204 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
206 command_log_capture_finish(state
);
208 script_command_args_free(words
, nwords
);
209 return command_retval_set(interp
, retval
);
212 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
214 /* the private data is stashed in the interp structure */
216 struct command
*c
= interp
->cmdPrivData
;
218 script_debug(interp
, c
->name
, argc
, argv
);
219 return script_command_run(interp
, argc
, argv
, c
, true);
222 static struct command
*command_root(struct command
*c
)
224 while (NULL
!= c
->parent
)
230 * Find a command by name from a list of commands.
231 * @returns Returns the named command if it exists in the list.
232 * Returns NULL otherwise.
234 static struct command
*command_find(struct command
*head
, const char *name
)
236 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
238 if (strcmp(cc
->name
, name
) == 0)
243 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
246 return command_find(cmd_ctx
->commands
, name
);
248 struct command
*command_find_in_parent(struct command
*parent
,
251 return command_find(parent
->children
, name
);
255 * Add the command into the linked list, sorted by name.
256 * @param head Address to head of command list pointer, which may be
257 * updated if @c c gets inserted at the beginning of the list.
258 * @param c The command to add to the list pointed to by @c head.
260 static void command_add_child(struct command
**head
, struct command
*c
)
269 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
270 head
= &(*head
)->next
;
272 if (strcmp(c
->name
, (*head
)->name
) > 0) {
273 c
->next
= (*head
)->next
;
281 static struct command
**command_list_for_parent(
282 struct command_context
*cmd_ctx
, struct command
*parent
)
284 return parent
? &parent
->children
: &cmd_ctx
->commands
;
287 static void command_free(struct command
*c
)
289 /// @todo if command has a handler, unregister its jim command!
291 while (NULL
!= c
->children
)
293 struct command
*tmp
= c
->children
;
294 c
->children
= tmp
->next
;
301 free((void*)c
->help
);
303 free((void*)c
->usage
);
307 static struct command
*command_new(struct command_context
*cmd_ctx
,
308 struct command
*parent
, const struct command_registration
*cr
)
312 struct command
*c
= calloc(1, sizeof(struct command
));
316 c
->name
= strdup(cr
->name
);
318 c
->help
= strdup(cr
->help
);
320 c
->usage
= strdup(cr
->usage
);
322 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
323 goto command_new_error
;
326 c
->handler
= cr
->handler
;
327 c
->jim_handler
= cr
->jim_handler
;
328 c
->jim_handler_data
= cr
->jim_handler_data
;
331 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
340 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
342 static int register_command_handler(struct command_context
*cmd_ctx
,
345 Jim_Interp
*interp
= cmd_ctx
->interp
;
346 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
347 if (NULL
== ocd_name
)
350 LOG_DEBUG("registering '%s'...", ocd_name
);
352 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
353 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
354 free((void *)ocd_name
);
355 if (JIM_OK
!= retval
)
358 /* we now need to add an overrideable proc */
359 const char *override_name
= alloc_printf(
360 "proc %s {args} {eval ocd_bouncer %s $args}",
362 if (NULL
== override_name
)
365 retval
= Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
366 free((void *)override_name
);
371 struct command
* register_command(struct command_context
*context
,
372 struct command
*parent
, const struct command_registration
*cr
)
374 if (!context
|| !cr
->name
)
377 const char *name
= cr
->name
;
378 struct command
**head
= command_list_for_parent(context
, parent
);
379 struct command
*c
= command_find(*head
, name
);
382 /* TODO: originally we treated attempting to register a cmd twice as an error
383 * Sometimes we need this behaviour, such as with flash banks.
384 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
385 LOG_DEBUG("command '%s' is already registered in '%s' context",
386 name
, parent
? parent
->name
: "<global>");
390 c
= command_new(context
, parent
, cr
);
394 int retval
= ERROR_OK
;
395 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
397 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
398 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
400 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
401 retval
= register_command_handler(context
, command_root(c
));
403 if (ERROR_OK
!= retval
)
405 unregister_command(context
, parent
, name
);
411 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
412 const struct command_registration
*cmds
)
414 int retval
= ERROR_OK
;
416 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
418 const struct command_registration
*cr
= cmds
+ i
;
420 struct command
*c
= NULL
;
421 if (NULL
!= cr
->name
)
423 c
= register_command(cmd_ctx
, parent
, cr
);
430 if (NULL
!= cr
->chain
)
432 struct command
*p
= c
? : parent
;
433 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
434 if (ERROR_OK
!= retval
)
438 if (ERROR_OK
!= retval
)
440 for (unsigned j
= 0; j
< i
; j
++)
441 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
446 int unregister_all_commands(struct command_context
*context
,
447 struct command
*parent
)
452 struct command
**head
= command_list_for_parent(context
, parent
);
453 while (NULL
!= *head
)
455 struct command
*tmp
= *head
;
463 int unregister_command(struct command_context
*context
,
464 struct command
*parent
, const char *name
)
466 if ((!context
) || (!name
))
467 return ERROR_INVALID_ARGUMENTS
;
469 struct command
*p
= NULL
;
470 struct command
**head
= command_list_for_parent(context
, parent
);
471 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
473 if (strcmp(name
, c
->name
) != 0)
488 void command_set_handler_data(struct command
*c
, void *p
)
490 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
491 c
->jim_handler_data
= p
;
492 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
493 command_set_handler_data(cc
, p
);
496 void command_output_text(struct command_context
*context
, const char *data
)
498 if (context
&& context
->output_handler
&& data
) {
499 context
->output_handler(context
, data
);
503 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
508 va_start(ap
, format
);
510 string
= alloc_vprintf(format
, ap
);
513 /* we want this collected in the log + we also want to pick it up as a tcl return
516 * The latter bit isn't precisely neat, but will do for now.
518 LOG_USER_N("%s", string
);
519 /* We already printed it above */
520 /* command_output_text(context, string); */
527 void command_print(struct command_context
*context
, const char *format
, ...)
532 va_start(ap
, format
);
534 string
= alloc_vprintf(format
, ap
);
537 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
538 /* we want this collected in the log + we also want to pick it up as a tcl return
541 * The latter bit isn't precisely neat, but will do for now.
543 LOG_USER_N("%s", string
);
544 /* We already printed it above */
545 /* command_output_text(context, string); */
552 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
555 unsigned len
= strlen(c
->name
);
556 if (NULL
== c
->parent
) {
557 // allocate enough for the name, child names, and '\0'
558 name
= malloc(len
+ extra
+ 1);
559 strcpy(name
, c
->name
);
561 // parent's extra must include both the space and name
562 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
563 char dstr
[2] = { delim
, 0 };
565 strcat(name
, c
->name
);
569 char *command_name(struct command
*c
, char delim
)
571 return __command_name(c
, delim
, 0);
574 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
576 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
579 static int run_command(struct command_context
*context
,
580 struct command
*c
, const char *words
[], unsigned num_words
)
582 if (!command_can_run(context
, c
))
584 /* Many commands may be run only before/after 'init' */
587 case COMMAND_CONFIG
: when
= "before"; break;
588 case COMMAND_EXEC
: when
= "after"; break;
589 // handle the impossible with humor; it guarantees a bug report!
590 default: when
= "if Cthulhu is summoned by"; break;
592 LOG_ERROR("The '%s' command must be used %s 'init'.",
597 struct command_invocation cmd
= {
601 .argc
= num_words
- 1,
604 int retval
= c
->handler(&cmd
);
605 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
607 /* Print help for command */
608 char *full_name
= command_name(c
, ' ');
609 if (NULL
!= full_name
) {
610 command_run_linef(context
, "usage %s", full_name
);
615 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
617 /* just fall through for a shutdown request */
619 else if (retval
!= ERROR_OK
)
621 /* we do not print out an error message because the command *should*
622 * have printed out an error
624 LOG_DEBUG("Command failed with error code %d", retval
);
630 int command_run_line(struct command_context
*context
, char *line
)
632 /* all the parent commands have been registered with the interpreter
633 * so, can just evaluate the line as a script and check for
636 /* run the line thru a script engine */
637 int retval
= ERROR_FAIL
;
639 /* Beware! This code needs to be reentrant. It is also possible
640 * for OpenOCD commands to be invoked directly from Tcl. This would
641 * happen when the Jim Tcl interpreter is provided by eCos for
644 Jim_Interp
*interp
= context
->interp
;
645 Jim_DeleteAssocData(interp
, "context");
646 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
647 if (retcode
== JIM_OK
)
649 /* associated the return value */
650 Jim_DeleteAssocData(interp
, "retval");
651 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
652 if (retcode
== JIM_OK
)
654 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
656 Jim_DeleteAssocData(interp
, "retval");
658 Jim_DeleteAssocData(interp
, "context");
660 if (retcode
== JIM_ERR
) {
661 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
663 /* We do not print the connection closed error message */
664 Jim_PrintErrorMessage(interp
);
666 if (retval
== ERROR_OK
)
668 /* It wasn't a low level OpenOCD command that failed */
672 } else if (retcode
== JIM_EXIT
) {
674 /* exit(Jim_GetExitCode(interp)); */
679 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
684 for (i
= 0; i
< reslen
; i
+= 256)
690 strncpy(buff
, result
+ i
, chunk
);
692 LOG_USER_N("%s", buff
);
694 LOG_USER_N("%s", "\n");
701 int command_run_linef(struct command_context
*context
, const char *format
, ...)
703 int retval
= ERROR_FAIL
;
706 va_start(ap
, format
);
707 string
= alloc_vprintf(format
, ap
);
710 retval
= command_run_line(context
, string
);
716 void command_set_output_handler(struct command_context
* context
,
717 command_output_handler_t output_handler
, void *priv
)
719 context
->output_handler
= output_handler
;
720 context
->output_handler_priv
= priv
;
723 struct command_context
* copy_command_context(struct command_context
* context
)
725 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
727 *copy_context
= *context
;
732 void command_done(struct command_context
*cmd_ctx
)
740 /* find full path to file */
741 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
745 const char *file
= Jim_GetString(argv
[1], NULL
);
746 char *full_path
= find_file(file
);
747 if (full_path
== NULL
)
749 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
752 Jim_SetResult(interp
, result
);
756 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
760 const char *str
= Jim_GetString(argv
[1], NULL
);
765 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
771 /* make it a char easier to read code */
775 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
779 /* do we have to chunk it? */
780 if (ptr
[nbytes
] == 0)
782 /* no it is a C style string */
783 LOG_USER_N("%s", ptr
);
786 /* GRR we must chunk - not null terminated */
796 memcpy(chunk
, ptr
, x
);
800 LOG_USER_N("%s", chunk
);
808 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
810 /* TCL wants to read... tell him no */
814 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
825 cp
= alloc_vprintf(fmt
, ap
);
828 LOG_USER_N("%s", cp
);
835 static int openocd_jim_fflush(void *cookie
)
837 /* nothing to flush */
841 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
848 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
853 struct log_capture_state
*state
= command_log_capture_start(interp
);
855 const char *str
= Jim_GetString(argv
[1], NULL
);
856 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
858 command_log_capture_finish(state
);
863 static COMMAND_HELPER(command_help_find
, struct command
*head
,
864 struct command
**out
)
867 return ERROR_INVALID_ARGUMENTS
;
868 *out
= command_find(head
, CMD_ARGV
[0]);
869 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
870 *out
= command_find(head
, CMD_ARGV
[0] + 4);
872 return ERROR_INVALID_ARGUMENTS
;
876 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
879 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
880 bool show_help
, const char *match
);
882 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
883 bool show_help
, const char *match
)
885 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
886 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, match
);
890 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
892 static void command_help_show_indent(unsigned n
)
894 for (unsigned i
= 0; i
< n
; i
++)
897 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
899 const char *cp
= str
, *last
= str
;
902 const char *next
= last
;
907 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
908 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
909 if (next
- last
< HELP_LINE_WIDTH(n
))
911 command_help_show_indent(n
);
912 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
918 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
919 bool show_help
, const char *match
)
921 if (!command_can_run(CMD_CTX
, c
))
924 char *cmd_name
= command_name(c
, ' ');
925 if (NULL
== cmd_name
)
928 /* If the match string occurs anywhere, we print out
929 * stuff for this command. */
930 bool is_match
= (strstr(cmd_name
, match
) != NULL
) ||
931 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
932 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
936 command_help_show_indent(n
);
937 LOG_USER_N("%s", cmd_name
);
945 command_help_show_wrap(c
->usage
, 0, n
+ 5);
951 if (is_match
&& show_help
)
955 /* Normal commands are runtime-only; highlight exceptions */
956 if (c
->mode
!= COMMAND_EXEC
) {
957 const char *stage_msg
= "";
961 stage_msg
= " (configuration command)";
964 stage_msg
= " (command valid any time)";
967 stage_msg
= " (?mode error?)";
970 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
972 msg
= alloc_printf("%s", c
->help
? : "");
976 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
985 return CALL_COMMAND_HANDLER(command_help_show_list
,
986 c
->children
, n
, show_help
, match
);
988 COMMAND_HANDLER(handle_help_command
)
990 bool full
= strcmp(CMD_NAME
, "help") == 0;
992 struct command
*c
= CMD_CTX
->commands
;
997 else if (CMD_ARGC
>= 1) {
1000 for (i
= 0; i
< CMD_ARGC
; ++i
) {
1001 if (NULL
!= match
) {
1004 match
= alloc_printf("%s %s", match
,
1007 if (NULL
== match
) {
1008 LOG_ERROR("unable to build "
1013 match
= alloc_printf("%s", CMD_ARGV
[i
]);
1014 if (NULL
== match
) {
1015 LOG_ERROR("unable to build "
1022 return ERROR_COMMAND_SYNTAX_ERROR
;
1024 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
1032 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
1033 struct command
*head
, struct command
**out
, bool top_level
)
1037 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1038 struct command
*c
= command_find(head
, cmd_name
);
1039 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
1040 c
= command_find(head
, cmd_name
+ 4);
1044 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
1048 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1050 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1051 if (strcmp(cmd_name
, "unknown") == 0)
1058 script_debug(interp
, cmd_name
, argc
, argv
);
1060 struct command_context
*cmd_ctx
= current_command_context(interp
);
1061 struct command
*c
= cmd_ctx
->commands
;
1062 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
1063 // if nothing could be consumed, then it's really an unknown command
1064 if (remaining
== argc
)
1066 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1067 LOG_ERROR("Unknown command:\n %s", cmd
);
1072 Jim_Obj
*const *start
;
1074 if (c
->handler
|| c
->jim_handler
)
1076 // include the command name in the list
1077 count
= remaining
+ 1;
1078 start
= argv
+ (argc
- remaining
- 1);
1082 c
= command_find(cmd_ctx
->commands
, "usage");
1085 LOG_ERROR("unknown command, but usage is missing too");
1088 count
= argc
- remaining
;
1092 // pass the command through to the intended handler
1095 interp
->cmdPrivData
= c
->jim_handler_data
;
1096 return (*c
->jim_handler
)(interp
, count
, start
);
1099 return script_command_run(interp
, count
, start
, c
, found
);
1102 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1104 struct command_context
*cmd_ctx
= current_command_context(interp
);
1105 enum command_mode mode
;
1109 struct command
*c
= cmd_ctx
->commands
;
1110 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1111 // if nothing could be consumed, then it's an unknown command
1112 if (remaining
== argc
- 1)
1114 Jim_SetResultString(interp
, "unknown", -1);
1120 mode
= cmd_ctx
->mode
;
1122 const char *mode_str
;
1124 case COMMAND_ANY
: mode_str
= "any"; break;
1125 case COMMAND_CONFIG
: mode_str
= "config"; break;
1126 case COMMAND_EXEC
: mode_str
= "exec"; break;
1127 default: mode_str
= "unknown"; break;
1129 Jim_SetResultString(interp
, mode_str
, -1);
1133 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1138 struct command_context
*cmd_ctx
= current_command_context(interp
);
1139 struct command
*c
= cmd_ctx
->commands
;
1140 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1141 // if nothing could be consumed, then it's an unknown command
1142 if (remaining
== argc
- 1)
1144 Jim_SetResultString(interp
, "unknown", -1);
1149 Jim_SetResultString(interp
, "native", -1);
1150 else if (c
->handler
)
1151 Jim_SetResultString(interp
, "simple", -1);
1153 Jim_SetResultString(interp
, "group", -1);
1158 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1159 const char *cmd_name
, const char *help_text
, const char *usage
)
1161 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1162 struct command
*nc
= command_find(*head
, cmd_name
);
1165 // add a new command with help text
1166 struct command_registration cr
= {
1168 .mode
= COMMAND_ANY
,
1172 nc
= register_command(cmd_ctx
, parent
, &cr
);
1175 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1178 LOG_DEBUG("added '%s' help text", cmd_name
);
1183 bool replaced
= false;
1186 free((void *)nc
->help
);
1189 nc
->help
= strdup(help_text
);
1191 LOG_INFO("replaced existing '%s' help", cmd_name
);
1193 LOG_DEBUG("added '%s' help text", cmd_name
);
1197 bool replaced
= false;
1200 free((void *)nc
->usage
);
1203 nc
->usage
= strdup(usage
);
1205 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1207 LOG_DEBUG("added '%s' usage text", cmd_name
);
1212 COMMAND_HANDLER(handle_help_add_command
)
1216 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1217 return ERROR_INVALID_ARGUMENTS
;
1220 // save help text and remove it from argument list
1221 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1222 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1223 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1224 if (!help
&& !usage
)
1226 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1227 return ERROR_INVALID_ARGUMENTS
;
1229 // likewise for the leaf command name
1230 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1232 struct command
*c
= NULL
;
1235 c
= CMD_CTX
->commands
;
1236 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1237 if (ERROR_OK
!= retval
)
1240 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1243 /* sleep command sleeps for <n> milliseconds
1244 * this is useful in target startup scripts
1246 COMMAND_HANDLER(handle_sleep_command
)
1251 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1254 return ERROR_COMMAND_SYNTAX_ERROR
;
1256 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1257 return ERROR_COMMAND_SYNTAX_ERROR
;
1259 unsigned long duration
= 0;
1260 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1261 if (ERROR_OK
!= retval
)
1266 long long then
= timeval_ms();
1267 while (timeval_ms() - then
< (long long)duration
)
1269 target_call_timer_callbacks_now();
1274 busy_sleep(duration
);
1279 static const struct command_registration command_subcommand_handlers
[] = {
1282 .mode
= COMMAND_ANY
,
1283 .jim_handler
= jim_command_mode
,
1284 .usage
= "[command_name ...]",
1285 .help
= "Returns the command modes allowed by a command:"
1286 "'any', 'config', or 'exec'. If no command is"
1287 "specified, returns the current command mode. "
1288 "Returns 'unknown' if an unknown command is given. "
1289 "Command can be multiple tokens.",
1293 .mode
= COMMAND_ANY
,
1294 .jim_handler
= jim_command_type
,
1295 .usage
= "command_name [...]",
1296 .help
= "Returns the type of built-in command:"
1297 "'native', 'simple', 'group', or 'unknown'. "
1298 "Command can be multiple tokens.",
1300 COMMAND_REGISTRATION_DONE
1303 static const struct command_registration command_builtin_handlers
[] = {
1305 .name
= "add_help_text",
1306 .handler
= handle_help_add_command
,
1307 .mode
= COMMAND_ANY
,
1308 .help
= "Add new command help text; "
1309 "Command can be multiple tokens.",
1310 .usage
= "command_name helptext_string",
1313 .name
= "add_usage_text",
1314 .handler
= handle_help_add_command
,
1315 .mode
= COMMAND_ANY
,
1316 .help
= "Add new command usage text; "
1317 "command can be multiple tokens.",
1318 .usage
= "command_name usage_string",
1322 .handler
= handle_sleep_command
,
1323 .mode
= COMMAND_ANY
,
1324 .help
= "Sleep for specified number of milliseconds. "
1325 "\"busy\" will busy wait instead (avoid this).",
1326 .usage
= "milliseconds ['busy']",
1330 .handler
= handle_help_command
,
1331 .mode
= COMMAND_ANY
,
1332 .help
= "Show full command help; "
1333 "command can be multiple tokens.",
1334 .usage
= "[command_name]",
1338 .handler
= handle_help_command
,
1339 .mode
= COMMAND_ANY
,
1340 .help
= "Show basic command usage; "
1341 "command can be multiple tokens.",
1342 .usage
= "[command_name]",
1347 .help
= "core command group (introspection)",
1348 .chain
= command_subcommand_handlers
,
1350 COMMAND_REGISTRATION_DONE
1353 struct command_context
* command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1355 struct command_context
* context
= malloc(sizeof(struct command_context
));
1358 context
->mode
= COMMAND_EXEC
;
1359 context
->commands
= NULL
;
1360 context
->current_target
= 0;
1361 context
->output_handler
= NULL
;
1362 context
->output_handler_priv
= NULL
;
1364 #if !BUILD_ECOSBOARD
1365 /* Create a jim interpreter if we were not handed one */
1369 /* Create an interpreter */
1370 interp
= Jim_CreateInterp();
1371 /* Add all the Jim core commands */
1372 Jim_RegisterCoreCommands(interp
);
1375 context
->interp
= interp
;
1377 /* Stick to lowercase for HostOS strings. */
1378 #if defined(_MSC_VER)
1379 /* WinXX - is generic, the forward
1380 * looking problem is this:
1382 * "win32" or "win64"
1384 * "winxx" is generic.
1387 #elif defined(__linux__)
1389 #elif defined(__APPLE__) || defined(__DARWIN__)
1391 #elif defined(__CYGWIN__)
1393 #elif defined(__MINGW32__)
1395 #elif defined(__ECOS)
1397 #elif defined(__FreeBSD__)
1400 #warning "Unrecognized host OS..."
1403 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1404 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1406 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1407 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1408 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1410 /* Set Jim's STDIO */
1411 interp
->cookie_stdin
= interp
;
1412 interp
->cookie_stdout
= interp
;
1413 interp
->cookie_stderr
= interp
;
1414 interp
->cb_fwrite
= openocd_jim_fwrite
;
1415 interp
->cb_fread
= openocd_jim_fread
;
1416 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1417 interp
->cb_fflush
= openocd_jim_fflush
;
1418 interp
->cb_fgets
= openocd_jim_fgets
;
1420 register_commands(context
, NULL
, command_builtin_handlers
);
1422 #if !BUILD_ECOSBOARD
1423 Jim_EventLoopOnLoad(interp
);
1425 Jim_SetAssocData(interp
, "context", NULL
, context
);
1426 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1428 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1429 Jim_PrintErrorMessage(interp
);
1432 Jim_DeleteAssocData(interp
, "context");
1437 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1440 return ERROR_INVALID_ARGUMENTS
;
1442 cmd_ctx
->mode
= mode
;
1446 void process_jim_events(struct command_context
*cmd_ctx
)
1448 #if !BUILD_ECOSBOARD
1449 static int recursion
= 0;
1454 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1459 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1460 int parse##name(const char *str, type *ul) \
1464 LOG_ERROR("Invalid command argument"); \
1465 return ERROR_COMMAND_ARGUMENT_INVALID; \
1468 *ul = func(str, &end, 0); \
1471 LOG_ERROR("Invalid command argument"); \
1472 return ERROR_COMMAND_ARGUMENT_INVALID; \
1474 if ((max == *ul) && (ERANGE == errno)) \
1476 LOG_ERROR("Argument overflow"); \
1477 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1479 if (min && (min == *ul) && (ERANGE == errno)) \
1481 LOG_ERROR("Argument underflow"); \
1482 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1486 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1487 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1488 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1489 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1491 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1492 int parse##name(const char *str, type *ul) \
1495 int retval = parse##funcname(str, &n); \
1496 if (ERROR_OK != retval) \
1499 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1501 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1506 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1507 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1508 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1509 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1510 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1511 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1513 #define DEFINE_PARSE_LONG(name, type, min, max) \
1514 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1515 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1516 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1517 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1518 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1520 static int command_parse_bool(const char *in
, bool *out
,
1521 const char *on
, const char *off
)
1523 if (strcasecmp(in
, on
) == 0)
1525 else if (strcasecmp(in
, off
) == 0)
1528 return ERROR_COMMAND_SYNTAX_ERROR
;
1532 int command_parse_bool_arg(const char *in
, bool *out
)
1534 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1536 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1538 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1540 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1542 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1544 return ERROR_INVALID_ARGUMENTS
;
1547 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1551 const char *in
= CMD_ARGV
[0];
1552 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1554 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1555 return ERROR_INVALID_ARGUMENTS
;
1560 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1563 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)