1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * part of this file is taken from libcli (libcli.sourceforge.net) *
12 * Copyright (C) David Parrish (david@dparrish.com) *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program; if not, write to the *
26 * Free Software Foundation, Inc., *
27 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
28 ***************************************************************************/
34 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
38 // @todo the inclusion of target.h here is a layering violation
39 #include <jtag/jtag.h>
40 #include <target/target.h>
42 #include "configuration.h"
44 #include "time_support.h"
45 #include "jim-eventloop.h"
48 /* nice short description of source file */
49 #define __THIS__FILE__ "command.c"
52 static int run_command(struct command_context
*context
,
53 struct command
*c
, const char *words
[], unsigned num_words
);
55 struct log_capture_state
{
60 static void tcl_output(void *privData
, const char *file
, unsigned line
,
61 const char *function
, const char *string
)
63 struct log_capture_state
*state
= (struct log_capture_state
*)privData
;
64 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
67 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
69 /* capture log output and return it. A garbage collect can
70 * happen, so we need a reference count to this object */
71 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
72 if (NULL
== tclOutput
)
75 struct log_capture_state
*state
= malloc(sizeof(*state
));
79 state
->interp
= interp
;
80 Jim_IncrRefCount(tclOutput
);
81 state
->output
= tclOutput
;
83 log_add_callback(tcl_output
, state
);
88 /* Classic openocd commands provide progress output which we
89 * will capture and return as a Tcl return value.
91 * However, if a non-openocd command has been invoked, then it
92 * makes sense to return the tcl return value from that command.
94 * The tcl return value is empty for openocd commands that provide
97 * Therefore we set the tcl return value only if we actually
100 static void command_log_capture_finish(struct log_capture_state
*state
)
105 log_remove_callback(tcl_output
, state
);
108 Jim_GetString(state
->output
, &length
);
112 Jim_SetResult(state
->interp
, state
->output
);
115 /* No output captured, use tcl return value (which could
118 Jim_DecrRefCount(state
->interp
, state
->output
);
123 static int command_retval_set(Jim_Interp
*interp
, int retval
)
125 int *return_retval
= Jim_GetAssocData(interp
, "retval");
126 if (return_retval
!= NULL
)
127 *return_retval
= retval
;
129 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
132 extern struct command_context
*global_cmd_ctx
;
134 /* dump a single line to the log for the command.
135 * Do nothing in case we are not at debug level 3 */
136 void script_debug(Jim_Interp
*interp
, const char *name
,
137 unsigned argc
, Jim_Obj
*const *argv
)
139 if (debug_level
< LOG_LVL_DEBUG
)
142 char * dbg
= alloc_printf("command - %s", name
);
143 for (unsigned i
= 0; i
< argc
; i
++)
146 const char *w
= Jim_GetString(argv
[i
], &len
);
147 char * t
= alloc_printf("%s %s", dbg
, w
);
151 LOG_DEBUG("%s", dbg
);
155 static void script_command_args_free(const char **words
, unsigned nwords
)
157 for (unsigned i
= 0; i
< nwords
; i
++)
158 free((void *)words
[i
]);
161 static const char **script_command_args_alloc(
162 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
164 const char **words
= malloc(argc
* sizeof(char *));
169 for (i
= 0; i
< argc
; i
++)
172 const char *w
= Jim_GetString(argv
[i
], &len
);
173 words
[i
] = strdup(w
);
174 if (words
[i
] == NULL
)
176 script_command_args_free(words
, i
);
184 struct command_context
*current_command_context(Jim_Interp
*interp
)
186 /* grab the command context from the associated data */
187 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
190 /* Tcl can invoke commands directly instead of via command_run_line(). This would
191 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
192 * commands in a startup script.
194 * A telnet or gdb server would provide a non-default command context to
195 * handle piping of error output, have a separate current target, etc.
197 cmd_ctx
= global_cmd_ctx
;
202 static int script_command_run(Jim_Interp
*interp
,
203 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
205 target_call_timer_callbacks_now();
206 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
209 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
213 struct log_capture_state
*state
= NULL
;
215 state
= command_log_capture_start(interp
);
217 struct command_context
*cmd_ctx
= current_command_context(interp
);
218 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
220 command_log_capture_finish(state
);
222 script_command_args_free(words
, nwords
);
223 return command_retval_set(interp
, retval
);
226 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
228 /* the private data is stashed in the interp structure */
230 struct command
*c
= interp
->cmdPrivData
;
232 script_debug(interp
, c
->name
, argc
, argv
);
233 return script_command_run(interp
, argc
, argv
, c
, true);
236 static struct command
*command_root(struct command
*c
)
238 while (NULL
!= c
->parent
)
244 * Find a command by name from a list of commands.
245 * @returns Returns the named command if it exists in the list.
246 * Returns NULL otherwise.
248 static struct command
*command_find(struct command
*head
, const char *name
)
250 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
252 if (strcmp(cc
->name
, name
) == 0)
257 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
260 return command_find(cmd_ctx
->commands
, name
);
262 struct command
*command_find_in_parent(struct command
*parent
,
265 return command_find(parent
->children
, name
);
269 * Add the command into the linked list, sorted by name.
270 * @param head Address to head of command list pointer, which may be
271 * updated if @c c gets inserted at the beginning of the list.
272 * @param c The command to add to the list pointed to by @c head.
274 static void command_add_child(struct command
**head
, struct command
*c
)
283 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
284 head
= &(*head
)->next
;
286 if (strcmp(c
->name
, (*head
)->name
) > 0) {
287 c
->next
= (*head
)->next
;
295 static struct command
**command_list_for_parent(
296 struct command_context
*cmd_ctx
, struct command
*parent
)
298 return parent
? &parent
->children
: &cmd_ctx
->commands
;
301 static void command_free(struct command
*c
)
303 /// @todo if command has a handler, unregister its jim command!
305 while (NULL
!= c
->children
)
307 struct command
*tmp
= c
->children
;
308 c
->children
= tmp
->next
;
313 free((void *)c
->name
);
315 free((void*)c
->help
);
317 free((void*)c
->usage
);
321 static struct command
*command_new(struct command_context
*cmd_ctx
,
322 struct command
*parent
, const struct command_registration
*cr
)
326 struct command
*c
= calloc(1, sizeof(struct command
));
330 c
->name
= strdup(cr
->name
);
332 c
->help
= strdup(cr
->help
);
334 c
->usage
= strdup(cr
->usage
);
336 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
337 goto command_new_error
;
340 c
->handler
= cr
->handler
;
341 c
->jim_handler
= cr
->jim_handler
;
342 c
->jim_handler_data
= cr
->jim_handler_data
;
345 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
354 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
356 static int register_command_handler(struct command_context
*cmd_ctx
,
359 Jim_Interp
*interp
= cmd_ctx
->interp
;
360 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
361 if (NULL
== ocd_name
)
364 LOG_DEBUG("registering '%s'...", ocd_name
);
366 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
367 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
368 free((void *)ocd_name
);
369 if (JIM_OK
!= retval
)
372 /* we now need to add an overrideable proc */
373 const char *override_name
= alloc_printf(
374 "proc %s {args} {eval ocd_bouncer %s $args}",
376 if (NULL
== override_name
)
379 retval
= Jim_Eval_Named(interp
, override_name
, 0, 0);
380 free((void *)override_name
);
385 struct command
* register_command(struct command_context
*context
,
386 struct command
*parent
, const struct command_registration
*cr
)
388 if (!context
|| !cr
->name
)
391 const char *name
= cr
->name
;
392 struct command
**head
= command_list_for_parent(context
, parent
);
393 struct command
*c
= command_find(*head
, name
);
396 /* TODO: originally we treated attempting to register a cmd twice as an error
397 * Sometimes we need this behaviour, such as with flash banks.
398 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
399 LOG_DEBUG("command '%s' is already registered in '%s' context",
400 name
, parent
? parent
->name
: "<global>");
404 c
= command_new(context
, parent
, cr
);
408 int retval
= ERROR_OK
;
409 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
411 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
412 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
414 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
415 retval
= register_command_handler(context
, command_root(c
));
417 if (ERROR_OK
!= retval
)
419 unregister_command(context
, parent
, name
);
425 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
426 const struct command_registration
*cmds
)
428 int retval
= ERROR_OK
;
430 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
)
437 c
= register_command(cmd_ctx
, parent
, cr
);
444 if (NULL
!= cr
->chain
)
446 struct command
*p
= c
? : parent
;
447 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
448 if (ERROR_OK
!= retval
)
452 if (ERROR_OK
!= retval
)
454 for (unsigned j
= 0; j
< i
; j
++)
455 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
460 int unregister_all_commands(struct command_context
*context
,
461 struct command
*parent
)
466 struct command
**head
= command_list_for_parent(context
, parent
);
467 while (NULL
!= *head
)
469 struct command
*tmp
= *head
;
477 int unregister_command(struct command_context
*context
,
478 struct command
*parent
, const char *name
)
480 if ((!context
) || (!name
))
481 return ERROR_INVALID_ARGUMENTS
;
483 struct command
*p
= NULL
;
484 struct command
**head
= command_list_for_parent(context
, parent
);
485 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
487 if (strcmp(name
, c
->name
) != 0)
502 void command_set_handler_data(struct command
*c
, void *p
)
504 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
505 c
->jim_handler_data
= p
;
506 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
507 command_set_handler_data(cc
, p
);
510 void command_output_text(struct command_context
*context
, const char *data
)
512 if (context
&& context
->output_handler
&& data
) {
513 context
->output_handler(context
, data
);
517 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
522 va_start(ap
, format
);
524 string
= alloc_vprintf(format
, ap
);
527 /* we want this collected in the log + we also want to pick it up as a tcl return
530 * The latter bit isn't precisely neat, but will do for now.
532 LOG_USER_N("%s", string
);
533 /* We already printed it above */
534 /* command_output_text(context, string); */
541 void command_print(struct command_context
*context
, const char *format
, ...)
546 va_start(ap
, format
);
548 string
= alloc_vprintf(format
, ap
);
551 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
552 /* we want this collected in the log + we also want to pick it up as a tcl return
555 * The latter bit isn't precisely neat, but will do for now.
557 LOG_USER_N("%s", string
);
558 /* We already printed it above */
559 /* command_output_text(context, string); */
566 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
569 unsigned len
= strlen(c
->name
);
570 if (NULL
== c
->parent
) {
571 // allocate enough for the name, child names, and '\0'
572 name
= malloc(len
+ extra
+ 1);
573 strcpy(name
, c
->name
);
575 // parent's extra must include both the space and name
576 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
577 char dstr
[2] = { delim
, 0 };
579 strcat(name
, c
->name
);
583 char *command_name(struct command
*c
, char delim
)
585 return __command_name(c
, delim
, 0);
588 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
590 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
593 static int run_command(struct command_context
*context
,
594 struct command
*c
, const char *words
[], unsigned num_words
)
596 if (!command_can_run(context
, c
))
598 /* Many commands may be run only before/after 'init' */
601 case COMMAND_CONFIG
: when
= "before"; break;
602 case COMMAND_EXEC
: when
= "after"; break;
603 // handle the impossible with humor; it guarantees a bug report!
604 default: when
= "if Cthulhu is summoned by"; break;
606 LOG_ERROR("The '%s' command must be used %s 'init'.",
611 struct command_invocation cmd
= {
615 .argc
= num_words
- 1,
618 int retval
= c
->handler(&cmd
);
619 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
621 /* Print help for command */
622 char *full_name
= command_name(c
, ' ');
623 if (NULL
!= full_name
) {
624 command_run_linef(context
, "usage %s", full_name
);
629 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
631 /* just fall through for a shutdown request */
633 else if (retval
!= ERROR_OK
)
635 /* we do not print out an error message because the command *should*
636 * have printed out an error
638 LOG_DEBUG("Command failed with error code %d", retval
);
644 int command_run_line(struct command_context
*context
, char *line
)
646 /* all the parent commands have been registered with the interpreter
647 * so, can just evaluate the line as a script and check for
650 /* run the line thru a script engine */
651 int retval
= ERROR_FAIL
;
653 /* Beware! This code needs to be reentrant. It is also possible
654 * for OpenOCD commands to be invoked directly from Tcl. This would
655 * happen when the Jim Tcl interpreter is provided by eCos for
658 Jim_Interp
*interp
= context
->interp
;
659 Jim_DeleteAssocData(interp
, "context");
660 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
661 if (retcode
== JIM_OK
)
663 /* associated the return value */
664 Jim_DeleteAssocData(interp
, "retval");
665 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
666 if (retcode
== JIM_OK
)
668 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
670 Jim_DeleteAssocData(interp
, "retval");
672 Jim_DeleteAssocData(interp
, "context");
674 if (retcode
== JIM_ERR
) {
675 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
677 /* We do not print the connection closed error message */
678 Jim_MakeErrorMessage(interp
);
679 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
681 if (retval
== ERROR_OK
)
683 /* It wasn't a low level OpenOCD command that failed */
687 } else if (retcode
== JIM_EXIT
) {
689 /* exit(Jim_GetExitCode(interp)); */
694 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
699 for (i
= 0; i
< reslen
; i
+= 256)
705 strncpy(buff
, result
+ i
, chunk
);
707 LOG_USER_N("%s", buff
);
716 int command_run_linef(struct command_context
*context
, const char *format
, ...)
718 int retval
= ERROR_FAIL
;
721 va_start(ap
, format
);
722 string
= alloc_vprintf(format
, ap
);
725 retval
= command_run_line(context
, string
);
731 void command_set_output_handler(struct command_context
* context
,
732 command_output_handler_t output_handler
, void *priv
)
734 context
->output_handler
= output_handler
;
735 context
->output_handler_priv
= priv
;
738 struct command_context
* copy_command_context(struct command_context
* context
)
740 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
742 *copy_context
= *context
;
747 void command_done(struct command_context
*cmd_ctx
)
755 /* find full path to file */
756 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
760 const char *file
= Jim_GetString(argv
[1], NULL
);
761 char *full_path
= find_file(file
);
762 if (full_path
== NULL
)
764 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
767 Jim_SetResult(interp
, result
);
771 COMMAND_HANDLER(jim_echo
)
773 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n"))
775 LOG_USER_N("%s", CMD_ARGV
[1]);
780 LOG_USER("%s", CMD_ARGV
[0]);
784 /* Capture progress output and return as tcl return value. If the
785 * progress output was empty, return tcl return value.
787 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
792 struct log_capture_state
*state
= command_log_capture_start(interp
);
794 /* disable polling during capture. This avoids capturing output
797 * This is necessary in order to avoid accidentially getting a non-empty
798 * string for tcl fn's.
800 bool save_poll
= jtag_poll_get_enabled();
802 jtag_poll_set_enabled(false);
804 const char *str
= Jim_GetString(argv
[1], NULL
);
805 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
807 jtag_poll_set_enabled(save_poll
);
809 command_log_capture_finish(state
);
814 static COMMAND_HELPER(command_help_find
, struct command
*head
,
815 struct command
**out
)
818 return ERROR_INVALID_ARGUMENTS
;
819 *out
= command_find(head
, CMD_ARGV
[0]);
820 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
821 *out
= command_find(head
, CMD_ARGV
[0] + 4);
823 return ERROR_INVALID_ARGUMENTS
;
827 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
830 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
831 bool show_help
, const char *match
);
833 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
834 bool show_help
, const char *match
)
836 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
837 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, match
);
841 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
843 static void command_help_show_indent(unsigned n
)
845 for (unsigned i
= 0; i
< n
; i
++)
848 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
850 const char *cp
= str
, *last
= str
;
853 const char *next
= last
;
858 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
859 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
860 if (next
- last
< HELP_LINE_WIDTH(n
))
862 command_help_show_indent(n
);
863 LOG_USER("%.*s", (int)(cp
- last
), last
);
868 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
869 bool show_help
, const char *match
)
871 char *cmd_name
= command_name(c
, ' ');
872 if (NULL
== cmd_name
)
875 /* If the match string occurs anywhere, we print out
876 * stuff for this command. */
877 bool is_match
= (strstr(cmd_name
, match
) != NULL
) ||
878 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
879 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
883 command_help_show_indent(n
);
884 LOG_USER_N("%s", cmd_name
);
892 command_help_show_wrap(c
->usage
, 0, n
+ 5);
898 if (is_match
&& show_help
)
902 /* Normal commands are runtime-only; highlight exceptions */
903 if (c
->mode
!= COMMAND_EXEC
) {
904 const char *stage_msg
= "";
908 stage_msg
= " (configuration command)";
911 stage_msg
= " (command valid any time)";
914 stage_msg
= " (?mode error?)";
917 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
919 msg
= alloc_printf("%s", c
->help
? : "");
923 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
932 return CALL_COMMAND_HANDLER(command_help_show_list
,
933 c
->children
, n
, show_help
, match
);
935 COMMAND_HANDLER(handle_help_command
)
937 bool full
= strcmp(CMD_NAME
, "help") == 0;
939 struct command
*c
= CMD_CTX
->commands
;
944 else if (CMD_ARGC
>= 1) {
947 for (i
= 0; i
< CMD_ARGC
; ++i
) {
951 match
= alloc_printf("%s %s", match
,
955 LOG_ERROR("unable to build "
960 match
= alloc_printf("%s", CMD_ARGV
[i
]);
962 LOG_ERROR("unable to build "
969 return ERROR_COMMAND_SYNTAX_ERROR
;
971 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
979 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
980 struct command
*head
, struct command
**out
, bool top_level
)
984 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
985 struct command
*c
= command_find(head
, cmd_name
);
986 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
987 c
= command_find(head
, cmd_name
+ 4);
991 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
995 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
997 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
998 if (strcmp(cmd_name
, "unknown") == 0)
1005 script_debug(interp
, cmd_name
, argc
, argv
);
1007 struct command_context
*cmd_ctx
= current_command_context(interp
);
1008 struct command
*c
= cmd_ctx
->commands
;
1009 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
1010 // if nothing could be consumed, then it's really an unknown command
1011 if (remaining
== argc
)
1013 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1014 LOG_ERROR("Unknown command:\n %s", cmd
);
1019 Jim_Obj
*const *start
;
1021 if (c
->handler
|| c
->jim_handler
)
1023 // include the command name in the list
1024 count
= remaining
+ 1;
1025 start
= argv
+ (argc
- remaining
- 1);
1029 c
= command_find(cmd_ctx
->commands
, "usage");
1032 LOG_ERROR("unknown command, but usage is missing too");
1035 count
= argc
- remaining
;
1039 // pass the command through to the intended handler
1042 interp
->cmdPrivData
= c
->jim_handler_data
;
1043 return (*c
->jim_handler
)(interp
, count
, start
);
1046 return script_command_run(interp
, count
, start
, c
, found
);
1049 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1051 struct command_context
*cmd_ctx
= current_command_context(interp
);
1052 enum command_mode mode
;
1056 struct command
*c
= cmd_ctx
->commands
;
1057 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1058 // if nothing could be consumed, then it's an unknown command
1059 if (remaining
== argc
- 1)
1061 Jim_SetResultString(interp
, "unknown", -1);
1067 mode
= cmd_ctx
->mode
;
1069 const char *mode_str
;
1071 case COMMAND_ANY
: mode_str
= "any"; break;
1072 case COMMAND_CONFIG
: mode_str
= "config"; break;
1073 case COMMAND_EXEC
: mode_str
= "exec"; break;
1074 default: mode_str
= "unknown"; break;
1076 Jim_SetResultString(interp
, mode_str
, -1);
1080 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1085 struct command_context
*cmd_ctx
= current_command_context(interp
);
1086 struct command
*c
= cmd_ctx
->commands
;
1087 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1088 // if nothing could be consumed, then it's an unknown command
1089 if (remaining
== argc
- 1)
1091 Jim_SetResultString(interp
, "unknown", -1);
1096 Jim_SetResultString(interp
, "native", -1);
1097 else if (c
->handler
)
1098 Jim_SetResultString(interp
, "simple", -1);
1100 Jim_SetResultString(interp
, "group", -1);
1105 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1106 const char *cmd_name
, const char *help_text
, const char *usage
)
1108 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1109 struct command
*nc
= command_find(*head
, cmd_name
);
1112 // add a new command with help text
1113 struct command_registration cr
= {
1115 .mode
= COMMAND_ANY
,
1119 nc
= register_command(cmd_ctx
, parent
, &cr
);
1122 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1125 LOG_DEBUG("added '%s' help text", cmd_name
);
1130 bool replaced
= false;
1133 free((void *)nc
->help
);
1136 nc
->help
= strdup(help_text
);
1138 LOG_INFO("replaced existing '%s' help", cmd_name
);
1140 LOG_DEBUG("added '%s' help text", cmd_name
);
1144 bool replaced
= false;
1147 free((void *)nc
->usage
);
1150 nc
->usage
= strdup(usage
);
1152 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1154 LOG_DEBUG("added '%s' usage text", cmd_name
);
1159 COMMAND_HANDLER(handle_help_add_command
)
1163 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1164 return ERROR_INVALID_ARGUMENTS
;
1167 // save help text and remove it from argument list
1168 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1169 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1170 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1171 if (!help
&& !usage
)
1173 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1174 return ERROR_INVALID_ARGUMENTS
;
1176 // likewise for the leaf command name
1177 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1179 struct command
*c
= NULL
;
1182 c
= CMD_CTX
->commands
;
1183 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1184 if (ERROR_OK
!= retval
)
1187 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1190 /* sleep command sleeps for <n> milliseconds
1191 * this is useful in target startup scripts
1193 COMMAND_HANDLER(handle_sleep_command
)
1198 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1201 return ERROR_COMMAND_SYNTAX_ERROR
;
1203 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1204 return ERROR_COMMAND_SYNTAX_ERROR
;
1206 unsigned long duration
= 0;
1207 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1208 if (ERROR_OK
!= retval
)
1213 long long then
= timeval_ms();
1214 while (timeval_ms() - then
< (long long)duration
)
1216 target_call_timer_callbacks_now();
1221 busy_sleep(duration
);
1226 static const struct command_registration command_subcommand_handlers
[] = {
1229 .mode
= COMMAND_ANY
,
1230 .jim_handler
= jim_command_mode
,
1231 .usage
= "[command_name ...]",
1232 .help
= "Returns the command modes allowed by a command:"
1233 "'any', 'config', or 'exec'. If no command is"
1234 "specified, returns the current command mode. "
1235 "Returns 'unknown' if an unknown command is given. "
1236 "Command can be multiple tokens.",
1240 .mode
= COMMAND_ANY
,
1241 .jim_handler
= jim_command_type
,
1242 .usage
= "command_name [...]",
1243 .help
= "Returns the type of built-in command:"
1244 "'native', 'simple', 'group', or 'unknown'. "
1245 "Command can be multiple tokens.",
1247 COMMAND_REGISTRATION_DONE
1250 static const struct command_registration command_builtin_handlers
[] = {
1253 .handler
= jim_echo
,
1254 .mode
= COMMAND_ANY
,
1255 .help
= "Logs a message at \"user\" priority. "
1256 "Output message to stdout. "
1257 "Option \"-n\" suppresses trailing newline",
1258 .usage
= "[-n] string",
1261 .name
= "add_help_text",
1262 .handler
= handle_help_add_command
,
1263 .mode
= COMMAND_ANY
,
1264 .help
= "Add new command help text; "
1265 "Command can be multiple tokens.",
1266 .usage
= "command_name helptext_string",
1269 .name
= "add_usage_text",
1270 .handler
= handle_help_add_command
,
1271 .mode
= COMMAND_ANY
,
1272 .help
= "Add new command usage text; "
1273 "command can be multiple tokens.",
1274 .usage
= "command_name usage_string",
1278 .handler
= handle_sleep_command
,
1279 .mode
= COMMAND_ANY
,
1280 .help
= "Sleep for specified number of milliseconds. "
1281 "\"busy\" will busy wait instead (avoid this).",
1282 .usage
= "milliseconds ['busy']",
1286 .handler
= handle_help_command
,
1287 .mode
= COMMAND_ANY
,
1288 .help
= "Show full command help; "
1289 "command can be multiple tokens.",
1290 .usage
= "[command_name]",
1294 .handler
= handle_help_command
,
1295 .mode
= COMMAND_ANY
,
1296 .help
= "Show basic command usage; "
1297 "command can be multiple tokens.",
1298 .usage
= "[command_name]",
1303 .help
= "core command group (introspection)",
1304 .chain
= command_subcommand_handlers
,
1306 COMMAND_REGISTRATION_DONE
1309 struct command_context
* command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1311 struct command_context
* context
= malloc(sizeof(struct command_context
));
1314 context
->mode
= COMMAND_EXEC
;
1315 context
->commands
= NULL
;
1316 context
->current_target
= 0;
1317 context
->output_handler
= NULL
;
1318 context
->output_handler_priv
= NULL
;
1320 #if !BUILD_ECOSBOARD
1321 /* Create a jim interpreter if we were not handed one */
1324 /* Create an interpreter */
1325 interp
= Jim_CreateInterp();
1326 /* Add all the Jim core commands */
1327 Jim_RegisterCoreCommands(interp
);
1328 Jim_InitStaticExtensions(interp
);
1331 context
->interp
= interp
;
1333 /* Stick to lowercase for HostOS strings. */
1334 #if defined(_MSC_VER)
1335 /* WinXX - is generic, the forward
1336 * looking problem is this:
1338 * "win32" or "win64"
1340 * "winxx" is generic.
1343 #elif defined(__linux__)
1345 #elif defined(__APPLE__) || defined(__DARWIN__)
1347 #elif defined(__CYGWIN__)
1349 #elif defined(__MINGW32__)
1351 #elif defined(__ECOS)
1353 #elif defined(__FreeBSD__)
1356 #warning "Unrecognized host OS..."
1359 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1360 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1362 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1363 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1365 register_commands(context
, NULL
, command_builtin_handlers
);
1367 Jim_SetAssocData(interp
, "context", NULL
, context
);
1368 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1370 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1371 Jim_MakeErrorMessage(interp
);
1372 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1375 Jim_DeleteAssocData(interp
, "context");
1380 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1383 return ERROR_INVALID_ARGUMENTS
;
1385 cmd_ctx
->mode
= mode
;
1389 void process_jim_events(struct command_context
*cmd_ctx
)
1391 #if !BUILD_ECOSBOARD
1392 static int recursion
= 0;
1397 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1402 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1403 int parse##name(const char *str, type *ul) \
1407 LOG_ERROR("Invalid command argument"); \
1408 return ERROR_COMMAND_ARGUMENT_INVALID; \
1411 *ul = func(str, &end, 0); \
1414 LOG_ERROR("Invalid command argument"); \
1415 return ERROR_COMMAND_ARGUMENT_INVALID; \
1417 if ((max == *ul) && (ERANGE == errno)) \
1419 LOG_ERROR("Argument overflow"); \
1420 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1422 if (min && (min == *ul) && (ERANGE == errno)) \
1424 LOG_ERROR("Argument underflow"); \
1425 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1429 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1430 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1431 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1432 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1434 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1435 int parse##name(const char *str, type *ul) \
1438 int retval = parse##funcname(str, &n); \
1439 if (ERROR_OK != retval) \
1442 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1444 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1449 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1450 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1451 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1452 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1453 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1454 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1456 #define DEFINE_PARSE_LONG(name, type, min, max) \
1457 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1458 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1459 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1460 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1461 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1463 static int command_parse_bool(const char *in
, bool *out
,
1464 const char *on
, const char *off
)
1466 if (strcasecmp(in
, on
) == 0)
1468 else if (strcasecmp(in
, off
) == 0)
1471 return ERROR_COMMAND_SYNTAX_ERROR
;
1475 int command_parse_bool_arg(const char *in
, bool *out
)
1477 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1479 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1481 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1483 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1485 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1487 return ERROR_INVALID_ARGUMENTS
;
1490 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1494 const char *in
= CMD_ARGV
[0];
1495 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1497 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1498 return ERROR_INVALID_ARGUMENTS
;
1503 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1506 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)