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 void script_debug(Jim_Interp
*interp
, const char *name
,
112 unsigned argc
, Jim_Obj
*const *argv
)
114 LOG_DEBUG("command - %s", name
);
115 for (unsigned i
= 0; i
< argc
; i
++)
118 const char *w
= Jim_GetString(argv
[i
], &len
);
120 /* end of line comment? */
124 LOG_DEBUG("%s - argv[%d]=%s", name
, i
, w
);
128 static void script_command_args_free(const char **words
, unsigned nwords
)
130 for (unsigned i
= 0; i
< nwords
; i
++)
131 free((void *)words
[i
]);
134 static const char **script_command_args_alloc(
135 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
137 const char **words
= malloc(argc
* sizeof(char *));
142 for (i
= 0; i
< argc
; i
++)
145 const char *w
= Jim_GetString(argv
[i
], &len
);
146 /* a comment may end the line early */
150 words
[i
] = strdup(w
);
151 if (words
[i
] == NULL
)
153 script_command_args_free(words
, i
);
161 static struct command_context
*current_command_context(Jim_Interp
*interp
)
163 /* grab the command context from the associated data */
164 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
167 /* Tcl can invoke commands directly instead of via command_run_line(). This would
168 * happen when the Jim Tcl interpreter is provided by eCos.
170 cmd_ctx
= global_cmd_ctx
;
175 static int script_command_run(Jim_Interp
*interp
,
176 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
178 target_call_timer_callbacks_now();
179 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
182 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
186 struct log_capture_state
*state
= NULL
;
188 state
= command_log_capture_start(interp
);
190 struct command_context
*cmd_ctx
= current_command_context(interp
);
191 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
193 command_log_capture_finish(state
);
195 script_command_args_free(words
, nwords
);
196 return command_retval_set(interp
, retval
);
199 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
201 /* the private data is stashed in the interp structure */
203 struct command
*c
= interp
->cmdPrivData
;
205 script_debug(interp
, c
->name
, argc
, argv
);
206 return script_command_run(interp
, argc
, argv
, c
, true);
209 static struct command
*command_root(struct command
*c
)
211 while (NULL
!= c
->parent
)
217 * Find a command by name from a list of commands.
218 * @returns Returns the named command if it exists in the list.
219 * Returns NULL otherwise.
221 static struct command
*command_find(struct command
*head
, const char *name
)
223 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
225 if (strcmp(cc
->name
, name
) == 0)
230 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
233 return command_find(cmd_ctx
->commands
, name
);
235 struct command
*command_find_in_parent(struct command
*parent
,
238 return command_find(parent
->children
, name
);
242 * Add the command into the linked list, sorted by name.
243 * @param head Address to head of command list pointer, which may be
244 * updated if @c c gets inserted at the beginning of the list.
245 * @param c The command to add to the list pointed to by @c head.
247 static void command_add_child(struct command
**head
, struct command
*c
)
256 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
257 head
= &(*head
)->next
;
259 if (strcmp(c
->name
, (*head
)->name
) > 0) {
260 c
->next
= (*head
)->next
;
268 static struct command
**command_list_for_parent(
269 struct command_context
*cmd_ctx
, struct command
*parent
)
271 return parent
? &parent
->children
: &cmd_ctx
->commands
;
274 static void command_free(struct command
*c
)
276 /// @todo if command has a handler, unregister its jim command!
278 while (NULL
!= c
->children
)
280 struct command
*tmp
= c
->children
;
281 c
->children
= tmp
->next
;
288 free((void*)c
->help
);
290 free((void*)c
->usage
);
294 static struct command
*command_new(struct command_context
*cmd_ctx
,
295 struct command
*parent
, const struct command_registration
*cr
)
299 struct command
*c
= calloc(1, sizeof(struct command
));
303 c
->name
= strdup(cr
->name
);
305 c
->help
= strdup(cr
->help
);
307 c
->usage
= strdup(cr
->usage
);
309 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
310 goto command_new_error
;
313 c
->handler
= cr
->handler
;
314 c
->jim_handler
= cr
->jim_handler
;
315 c
->jim_handler_data
= cr
->jim_handler_data
;
318 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
327 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
329 static int register_command_handler(struct command_context
*cmd_ctx
,
332 Jim_Interp
*interp
= cmd_ctx
->interp
;
333 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
334 if (NULL
== ocd_name
)
337 LOG_DEBUG("registering '%s'...", ocd_name
);
339 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
340 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
341 free((void *)ocd_name
);
342 if (JIM_OK
!= retval
)
345 /* we now need to add an overrideable proc */
346 const char *override_name
= alloc_printf(
347 "proc %s {args} {eval ocd_bouncer %s $args}",
349 if (NULL
== override_name
)
352 retval
= Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
353 free((void *)override_name
);
358 struct command
* register_command(struct command_context
*context
,
359 struct command
*parent
, const struct command_registration
*cr
)
361 if (!context
|| !cr
->name
)
364 const char *name
= cr
->name
;
365 struct command
**head
= command_list_for_parent(context
, parent
);
366 struct command
*c
= command_find(*head
, name
);
369 LOG_ERROR("command '%s' is already registered in '%s' context",
370 name
, parent
? parent
->name
: "<global>");
374 c
= command_new(context
, parent
, cr
);
378 int retval
= ERROR_OK
;
379 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
381 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
382 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
384 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
385 retval
= register_command_handler(context
, command_root(c
));
387 if (ERROR_OK
!= retval
)
389 unregister_command(context
, parent
, name
);
395 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
396 const struct command_registration
*cmds
)
398 int retval
= ERROR_OK
;
400 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
402 const struct command_registration
*cr
= cmds
+ i
;
404 struct command
*c
= NULL
;
405 if (NULL
!= cr
->name
)
407 c
= register_command(cmd_ctx
, parent
, cr
);
414 if (NULL
!= cr
->chain
)
416 struct command
*p
= c
? : parent
;
417 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
418 if (ERROR_OK
!= retval
)
422 if (ERROR_OK
!= retval
)
424 for (unsigned j
= 0; j
< i
; j
++)
425 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
430 int unregister_all_commands(struct command_context
*context
,
431 struct command
*parent
)
436 struct command
**head
= command_list_for_parent(context
, parent
);
437 while (NULL
!= *head
)
439 struct command
*tmp
= *head
;
447 int unregister_command(struct command_context
*context
,
448 struct command
*parent
, const char *name
)
450 if ((!context
) || (!name
))
451 return ERROR_INVALID_ARGUMENTS
;
453 struct command
*p
= NULL
;
454 struct command
**head
= command_list_for_parent(context
, parent
);
455 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
457 if (strcmp(name
, c
->name
) != 0)
472 void command_set_handler_data(struct command
*c
, void *p
)
474 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
475 c
->jim_handler_data
= p
;
476 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
477 command_set_handler_data(cc
, p
);
480 void command_output_text(struct command_context
*context
, const char *data
)
482 if (context
&& context
->output_handler
&& data
) {
483 context
->output_handler(context
, data
);
487 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
492 va_start(ap
, format
);
494 string
= alloc_vprintf(format
, ap
);
497 /* we want this collected in the log + we also want to pick it up as a tcl return
500 * The latter bit isn't precisely neat, but will do for now.
502 LOG_USER_N("%s", string
);
503 /* We already printed it above */
504 /* command_output_text(context, string); */
511 void command_print(struct command_context
*context
, const char *format
, ...)
516 va_start(ap
, format
);
518 string
= alloc_vprintf(format
, ap
);
521 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
522 /* we want this collected in the log + we also want to pick it up as a tcl return
525 * The latter bit isn't precisely neat, but will do for now.
527 LOG_USER_N("%s", string
);
528 /* We already printed it above */
529 /* command_output_text(context, string); */
536 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
539 unsigned len
= strlen(c
->name
);
540 if (NULL
== c
->parent
) {
541 // allocate enough for the name, child names, and '\0'
542 name
= malloc(len
+ extra
+ 1);
543 strcpy(name
, c
->name
);
545 // parent's extra must include both the space and name
546 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
547 char dstr
[2] = { delim
, 0 };
549 strcat(name
, c
->name
);
553 char *command_name(struct command
*c
, char delim
)
555 return __command_name(c
, delim
, 0);
558 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
560 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
563 static int run_command(struct command_context
*context
,
564 struct command
*c
, const char *words
[], unsigned num_words
)
566 if (!command_can_run(context
, c
))
568 /* Many commands may be run only before/after 'init' */
571 case COMMAND_CONFIG
: when
= "before"; break;
572 case COMMAND_EXEC
: when
= "after"; break;
573 // handle the impossible with humor; it guarantees a bug report!
574 default: when
= "if Cthulhu is summoned by"; break;
576 LOG_ERROR("The '%s' command must be used %s 'init'.",
581 struct command_invocation cmd
= {
585 .argc
= num_words
- 1,
588 int retval
= c
->handler(&cmd
);
589 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
591 /* Print help for command */
592 char *full_name
= command_name(c
, ' ');
593 if (NULL
!= full_name
) {
594 command_run_linef(context
, "usage %s", full_name
);
599 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
601 /* just fall through for a shutdown request */
603 else if (retval
!= ERROR_OK
)
605 /* we do not print out an error message because the command *should*
606 * have printed out an error
608 LOG_DEBUG("Command failed with error code %d", retval
);
614 int command_run_line(struct command_context
*context
, char *line
)
616 /* all the parent commands have been registered with the interpreter
617 * so, can just evaluate the line as a script and check for
620 /* run the line thru a script engine */
621 int retval
= ERROR_FAIL
;
623 /* Beware! This code needs to be reentrant. It is also possible
624 * for OpenOCD commands to be invoked directly from Tcl. This would
625 * happen when the Jim Tcl interpreter is provided by eCos for
628 Jim_Interp
*interp
= context
->interp
;
629 Jim_DeleteAssocData(interp
, "context");
630 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
631 if (retcode
== JIM_OK
)
633 /* associated the return value */
634 Jim_DeleteAssocData(interp
, "retval");
635 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
636 if (retcode
== JIM_OK
)
638 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
640 Jim_DeleteAssocData(interp
, "retval");
642 Jim_DeleteAssocData(interp
, "context");
644 if (retcode
== JIM_ERR
) {
645 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
647 /* We do not print the connection closed error message */
648 Jim_PrintErrorMessage(interp
);
650 if (retval
== ERROR_OK
)
652 /* It wasn't a low level OpenOCD command that failed */
656 } else if (retcode
== JIM_EXIT
) {
658 /* exit(Jim_GetExitCode(interp)); */
663 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
668 for (i
= 0; i
< reslen
; i
+= 256)
674 strncpy(buff
, result
+ i
, chunk
);
676 LOG_USER_N("%s", buff
);
678 LOG_USER_N("%s", "\n");
685 int command_run_linef(struct command_context
*context
, const char *format
, ...)
687 int retval
= ERROR_FAIL
;
690 va_start(ap
, format
);
691 string
= alloc_vprintf(format
, ap
);
694 retval
= command_run_line(context
, string
);
700 void command_set_output_handler(struct command_context
* context
,
701 command_output_handler_t output_handler
, void *priv
)
703 context
->output_handler
= output_handler
;
704 context
->output_handler_priv
= priv
;
707 struct command_context
* copy_command_context(struct command_context
* context
)
709 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
711 *copy_context
= *context
;
716 void command_done(struct command_context
*cmd_ctx
)
724 /* find full path to file */
725 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
729 const char *file
= Jim_GetString(argv
[1], NULL
);
730 char *full_path
= find_file(file
);
731 if (full_path
== NULL
)
733 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
736 Jim_SetResult(interp
, result
);
740 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
744 const char *str
= Jim_GetString(argv
[1], NULL
);
749 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
755 /* make it a char easier to read code */
759 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
763 /* do we have to chunk it? */
764 if (ptr
[nbytes
] == 0)
766 /* no it is a C style string */
767 LOG_USER_N("%s", ptr
);
770 /* GRR we must chunk - not null terminated */
780 memcpy(chunk
, ptr
, x
);
784 LOG_USER_N("%s", chunk
);
792 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
794 /* TCL wants to read... tell him no */
798 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
809 cp
= alloc_vprintf(fmt
, ap
);
812 LOG_USER_N("%s", cp
);
819 static int openocd_jim_fflush(void *cookie
)
821 /* nothing to flush */
825 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
832 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
837 struct log_capture_state
*state
= command_log_capture_start(interp
);
839 const char *str
= Jim_GetString(argv
[1], NULL
);
840 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
842 command_log_capture_finish(state
);
847 static COMMAND_HELPER(command_help_find
, struct command
*head
,
848 struct command
**out
)
851 return ERROR_INVALID_ARGUMENTS
;
852 *out
= command_find(head
, CMD_ARGV
[0]);
853 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
854 *out
= command_find(head
, CMD_ARGV
[0] + 4);
856 return ERROR_INVALID_ARGUMENTS
;
860 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
863 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
864 bool show_help
, const char *match
);
866 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
867 bool show_help
, const char *match
)
869 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
870 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, match
);
874 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
876 static void command_help_show_indent(unsigned n
)
878 for (unsigned i
= 0; i
< n
; i
++)
881 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
883 const char *cp
= str
, *last
= str
;
886 const char *next
= last
;
891 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
892 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
893 if (next
- last
< HELP_LINE_WIDTH(n
))
895 command_help_show_indent(n
);
896 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
902 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
903 bool show_help
, const char *match
)
905 if (!command_can_run(CMD_CTX
, c
))
908 char *cmd_name
= command_name(c
, ' ');
909 if (NULL
== cmd_name
)
912 /* If the match string occurs anywhere, we print out
913 * stuff for this command. */
914 bool is_match
= (strstr(cmd_name
, match
) != NULL
) ||
915 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
916 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
920 command_help_show_indent(n
);
921 LOG_USER_N("%s", cmd_name
);
929 command_help_show_wrap(c
->usage
, 0, n
+ 5);
935 if (is_match
&& show_help
)
939 /* Normal commands are runtime-only; highlight exceptions */
940 if (c
->mode
!= COMMAND_EXEC
) {
941 const char *stage_msg
= "";
945 stage_msg
= " (configuration command)";
948 stage_msg
= " (command valid any time)";
951 stage_msg
= " (?mode error?)";
954 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
956 msg
= alloc_printf("%s", c
->help
? : "");
960 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
969 return CALL_COMMAND_HANDLER(command_help_show_list
,
970 c
->children
, n
, show_help
, match
);
972 COMMAND_HANDLER(handle_help_command
)
974 bool full
= strcmp(CMD_NAME
, "help") == 0;
976 struct command
*c
= CMD_CTX
->commands
;
981 else if (CMD_ARGC
>= 1) {
984 for (i
= 0; i
< CMD_ARGC
; ++i
) {
988 match
= alloc_printf("%s %s", match
,
992 LOG_ERROR("unable to build "
997 match
= alloc_printf("%s", CMD_ARGV
[i
]);
999 LOG_ERROR("unable to build "
1006 return ERROR_COMMAND_SYNTAX_ERROR
;
1008 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
1016 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
1017 struct command
*head
, struct command
**out
, bool top_level
)
1021 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1022 struct command
*c
= command_find(head
, cmd_name
);
1023 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
1024 c
= command_find(head
, cmd_name
+ 4);
1028 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
1032 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1034 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1035 if (strcmp(cmd_name
, "unknown") == 0)
1042 script_debug(interp
, cmd_name
, argc
, argv
);
1044 struct command_context
*cmd_ctx
= current_command_context(interp
);
1045 struct command
*c
= cmd_ctx
->commands
;
1046 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
1047 // if nothing could be consumed, then it's really an unknown command
1048 if (remaining
== argc
)
1050 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1051 LOG_ERROR("Unknown command:\n %s", cmd
);
1056 Jim_Obj
*const *start
;
1058 if (c
->handler
|| c
->jim_handler
)
1060 // include the command name in the list
1061 count
= remaining
+ 1;
1062 start
= argv
+ (argc
- remaining
- 1);
1066 c
= command_find(cmd_ctx
->commands
, "usage");
1069 LOG_ERROR("unknown command, but usage is missing too");
1072 count
= argc
- remaining
;
1076 // pass the command through to the intended handler
1079 interp
->cmdPrivData
= c
->jim_handler_data
;
1080 return (*c
->jim_handler
)(interp
, count
, start
);
1083 return script_command_run(interp
, count
, start
, c
, found
);
1086 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1088 struct command_context
*cmd_ctx
= current_command_context(interp
);
1089 enum command_mode mode
;
1093 struct command
*c
= cmd_ctx
->commands
;
1094 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1095 // if nothing could be consumed, then it's an unknown command
1096 if (remaining
== argc
- 1)
1098 Jim_SetResultString(interp
, "unknown", -1);
1104 mode
= cmd_ctx
->mode
;
1106 const char *mode_str
;
1108 case COMMAND_ANY
: mode_str
= "any"; break;
1109 case COMMAND_CONFIG
: mode_str
= "config"; break;
1110 case COMMAND_EXEC
: mode_str
= "exec"; break;
1111 default: mode_str
= "unknown"; break;
1113 Jim_SetResultString(interp
, mode_str
, -1);
1117 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1122 struct command_context
*cmd_ctx
= current_command_context(interp
);
1123 struct command
*c
= cmd_ctx
->commands
;
1124 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1125 // if nothing could be consumed, then it's an unknown command
1126 if (remaining
== argc
- 1)
1128 Jim_SetResultString(interp
, "unknown", -1);
1133 Jim_SetResultString(interp
, "native", -1);
1134 else if (c
->handler
)
1135 Jim_SetResultString(interp
, "simple", -1);
1137 Jim_SetResultString(interp
, "group", -1);
1142 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1143 const char *cmd_name
, const char *help_text
, const char *usage
)
1145 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1146 struct command
*nc
= command_find(*head
, cmd_name
);
1149 // add a new command with help text
1150 struct command_registration cr
= {
1152 .mode
= COMMAND_ANY
,
1156 nc
= register_command(cmd_ctx
, parent
, &cr
);
1159 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1162 LOG_DEBUG("added '%s' help text", cmd_name
);
1167 bool replaced
= false;
1170 free((void *)nc
->help
);
1173 nc
->help
= strdup(help_text
);
1175 LOG_INFO("replaced existing '%s' help", cmd_name
);
1177 LOG_DEBUG("added '%s' help text", cmd_name
);
1181 bool replaced
= false;
1184 free((void *)nc
->usage
);
1187 nc
->usage
= strdup(usage
);
1189 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1191 LOG_DEBUG("added '%s' usage text", cmd_name
);
1196 COMMAND_HANDLER(handle_help_add_command
)
1200 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1201 return ERROR_INVALID_ARGUMENTS
;
1204 // save help text and remove it from argument list
1205 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1206 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1207 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1208 if (!help
&& !usage
)
1210 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1211 return ERROR_INVALID_ARGUMENTS
;
1213 // likewise for the leaf command name
1214 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1216 struct command
*c
= NULL
;
1219 c
= CMD_CTX
->commands
;
1220 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1221 if (ERROR_OK
!= retval
)
1224 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1227 /* sleep command sleeps for <n> milliseconds
1228 * this is useful in target startup scripts
1230 COMMAND_HANDLER(handle_sleep_command
)
1235 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1238 return ERROR_COMMAND_SYNTAX_ERROR
;
1240 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1241 return ERROR_COMMAND_SYNTAX_ERROR
;
1243 unsigned long duration
= 0;
1244 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1245 if (ERROR_OK
!= retval
)
1250 long long then
= timeval_ms();
1251 while (timeval_ms() - then
< (long long)duration
)
1253 target_call_timer_callbacks_now();
1258 busy_sleep(duration
);
1263 static const struct command_registration command_subcommand_handlers
[] = {
1266 .mode
= COMMAND_ANY
,
1267 .jim_handler
= jim_command_mode
,
1268 .usage
= "[command_name ...]",
1269 .help
= "Returns the command modes allowed by a command:"
1270 "'any', 'config', or 'exec'. If no command is"
1271 "specified, returns the current command mode. "
1272 "Returns 'unknown' if an unknown command is given. "
1273 "Command can be multiple tokens.",
1277 .mode
= COMMAND_ANY
,
1278 .jim_handler
= jim_command_type
,
1279 .usage
= "command_name [...]",
1280 .help
= "Returns the type of built-in command:"
1281 "'native', 'simple', 'group', or 'unknown'. "
1282 "Command can be multiple tokens.",
1284 COMMAND_REGISTRATION_DONE
1287 static const struct command_registration command_builtin_handlers
[] = {
1289 .name
= "add_help_text",
1290 .handler
= handle_help_add_command
,
1291 .mode
= COMMAND_ANY
,
1292 .help
= "Add new command help text; "
1293 "Command can be multiple tokens.",
1294 .usage
= "command_name helptext_string",
1297 .name
= "add_usage_text",
1298 .handler
= handle_help_add_command
,
1299 .mode
= COMMAND_ANY
,
1300 .help
= "Add new command usage text; "
1301 "command can be multiple tokens.",
1302 .usage
= "command_name usage_string",
1306 .handler
= handle_sleep_command
,
1307 .mode
= COMMAND_ANY
,
1308 .help
= "Sleep for specified number of milliseconds. "
1309 "\"busy\" will busy wait instead (avoid this).",
1310 .usage
= "milliseconds ['busy']",
1314 .handler
= handle_help_command
,
1315 .mode
= COMMAND_ANY
,
1316 .help
= "Show full command help; "
1317 "command can be multiple tokens.",
1318 .usage
= "[command_name]",
1322 .handler
= handle_help_command
,
1323 .mode
= COMMAND_ANY
,
1324 .help
= "Show basic command usage; "
1325 "command can be multiple tokens.",
1326 .usage
= "[command_name]",
1331 .help
= "core command group (introspection)",
1332 .chain
= command_subcommand_handlers
,
1334 COMMAND_REGISTRATION_DONE
1337 struct command_context
* command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1339 struct command_context
* context
= malloc(sizeof(struct command_context
));
1342 context
->mode
= COMMAND_EXEC
;
1343 context
->commands
= NULL
;
1344 context
->current_target
= 0;
1345 context
->output_handler
= NULL
;
1346 context
->output_handler_priv
= NULL
;
1348 #if !BUILD_ECOSBOARD
1349 /* Create a jim interpreter if we were not handed one */
1353 /* Create an interpreter */
1354 interp
= Jim_CreateInterp();
1355 /* Add all the Jim core commands */
1356 Jim_RegisterCoreCommands(interp
);
1359 context
->interp
= interp
;
1361 /* Stick to lowercase for HostOS strings. */
1362 #if defined(_MSC_VER)
1363 /* WinXX - is generic, the forward
1364 * looking problem is this:
1366 * "win32" or "win64"
1368 * "winxx" is generic.
1371 #elif defined(__linux__)
1373 #elif defined(__APPLE__) || defined(__DARWIN__)
1375 #elif defined(__CYGWIN__)
1377 #elif defined(__MINGW32__)
1379 #elif defined(__ECOS)
1381 #elif defined(__FreeBSD__)
1384 #warning "Unrecognized host OS..."
1387 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1388 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1390 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1391 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1392 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1394 /* Set Jim's STDIO */
1395 interp
->cookie_stdin
= interp
;
1396 interp
->cookie_stdout
= interp
;
1397 interp
->cookie_stderr
= interp
;
1398 interp
->cb_fwrite
= openocd_jim_fwrite
;
1399 interp
->cb_fread
= openocd_jim_fread
;
1400 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1401 interp
->cb_fflush
= openocd_jim_fflush
;
1402 interp
->cb_fgets
= openocd_jim_fgets
;
1404 register_commands(context
, NULL
, command_builtin_handlers
);
1406 #if !BUILD_ECOSBOARD
1407 Jim_EventLoopOnLoad(interp
);
1409 Jim_SetAssocData(interp
, "context", NULL
, context
);
1410 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1412 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1413 Jim_PrintErrorMessage(interp
);
1416 Jim_DeleteAssocData(interp
, "context");
1421 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1424 return ERROR_INVALID_ARGUMENTS
;
1426 cmd_ctx
->mode
= mode
;
1430 void process_jim_events(struct command_context
*cmd_ctx
)
1432 #if !BUILD_ECOSBOARD
1433 static int recursion
= 0;
1438 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1443 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1444 int parse##name(const char *str, type *ul) \
1448 LOG_ERROR("Invalid command argument"); \
1449 return ERROR_COMMAND_ARGUMENT_INVALID; \
1452 *ul = func(str, &end, 0); \
1455 LOG_ERROR("Invalid command argument"); \
1456 return ERROR_COMMAND_ARGUMENT_INVALID; \
1458 if ((max == *ul) && (ERANGE == errno)) \
1460 LOG_ERROR("Argument overflow"); \
1461 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1463 if (min && (min == *ul) && (ERANGE == errno)) \
1465 LOG_ERROR("Argument underflow"); \
1466 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1470 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1471 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1472 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1473 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1475 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1476 int parse##name(const char *str, type *ul) \
1479 int retval = parse##funcname(str, &n); \
1480 if (ERROR_OK != retval) \
1483 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1485 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1490 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1491 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1492 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1493 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1494 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1495 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1497 #define DEFINE_PARSE_LONG(name, type, min, max) \
1498 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1499 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1500 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1501 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1502 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1504 static int command_parse_bool(const char *in
, bool *out
,
1505 const char *on
, const char *off
)
1507 if (strcasecmp(in
, on
) == 0)
1509 else if (strcasecmp(in
, off
) == 0)
1512 return ERROR_COMMAND_SYNTAX_ERROR
;
1516 int command_parse_bool_arg(const char *in
, bool *out
)
1518 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1520 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1522 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1524 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1526 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1528 return ERROR_INVALID_ARGUMENTS
;
1531 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1535 const char *in
= CMD_ARGV
[0];
1536 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1538 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1539 return ERROR_INVALID_ARGUMENTS
;
1544 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1547 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)