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 static 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.
179 cmd_ctx
= global_cmd_ctx
;
184 static int script_command_run(Jim_Interp
*interp
,
185 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
187 target_call_timer_callbacks_now();
188 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
191 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
195 struct log_capture_state
*state
= NULL
;
197 state
= command_log_capture_start(interp
);
199 struct command_context
*cmd_ctx
= current_command_context(interp
);
200 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
202 command_log_capture_finish(state
);
204 script_command_args_free(words
, nwords
);
205 return command_retval_set(interp
, retval
);
208 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
210 /* the private data is stashed in the interp structure */
212 struct command
*c
= interp
->cmdPrivData
;
214 script_debug(interp
, c
->name
, argc
, argv
);
215 return script_command_run(interp
, argc
, argv
, c
, true);
218 static struct command
*command_root(struct command
*c
)
220 while (NULL
!= c
->parent
)
226 * Find a command by name from a list of commands.
227 * @returns Returns the named command if it exists in the list.
228 * Returns NULL otherwise.
230 static struct command
*command_find(struct command
*head
, const char *name
)
232 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
234 if (strcmp(cc
->name
, name
) == 0)
239 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
242 return command_find(cmd_ctx
->commands
, name
);
244 struct command
*command_find_in_parent(struct command
*parent
,
247 return command_find(parent
->children
, name
);
251 * Add the command into the linked list, sorted by name.
252 * @param head Address to head of command list pointer, which may be
253 * updated if @c c gets inserted at the beginning of the list.
254 * @param c The command to add to the list pointed to by @c head.
256 static void command_add_child(struct command
**head
, struct command
*c
)
265 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
266 head
= &(*head
)->next
;
268 if (strcmp(c
->name
, (*head
)->name
) > 0) {
269 c
->next
= (*head
)->next
;
277 static struct command
**command_list_for_parent(
278 struct command_context
*cmd_ctx
, struct command
*parent
)
280 return parent
? &parent
->children
: &cmd_ctx
->commands
;
283 static void command_free(struct command
*c
)
285 /// @todo if command has a handler, unregister its jim command!
287 while (NULL
!= c
->children
)
289 struct command
*tmp
= c
->children
;
290 c
->children
= tmp
->next
;
297 free((void*)c
->help
);
299 free((void*)c
->usage
);
303 static struct command
*command_new(struct command_context
*cmd_ctx
,
304 struct command
*parent
, const struct command_registration
*cr
)
308 struct command
*c
= calloc(1, sizeof(struct command
));
312 c
->name
= strdup(cr
->name
);
314 c
->help
= strdup(cr
->help
);
316 c
->usage
= strdup(cr
->usage
);
318 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
319 goto command_new_error
;
322 c
->handler
= cr
->handler
;
323 c
->jim_handler
= cr
->jim_handler
;
324 c
->jim_handler_data
= cr
->jim_handler_data
;
327 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
336 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
338 static int register_command_handler(struct command_context
*cmd_ctx
,
341 Jim_Interp
*interp
= cmd_ctx
->interp
;
342 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
343 if (NULL
== ocd_name
)
346 LOG_DEBUG("registering '%s'...", ocd_name
);
348 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
349 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
350 free((void *)ocd_name
);
351 if (JIM_OK
!= retval
)
354 /* we now need to add an overrideable proc */
355 const char *override_name
= alloc_printf(
356 "proc %s {args} {eval ocd_bouncer %s $args}",
358 if (NULL
== override_name
)
361 retval
= Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
362 free((void *)override_name
);
367 struct command
* register_command(struct command_context
*context
,
368 struct command
*parent
, const struct command_registration
*cr
)
370 if (!context
|| !cr
->name
)
373 const char *name
= cr
->name
;
374 struct command
**head
= command_list_for_parent(context
, parent
);
375 struct command
*c
= command_find(*head
, name
);
378 /* TODO: originally we treated attempting to register a cmd twice as an error
379 * Sometimes we need this behaviour, such as with flash banks.
380 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
381 LOG_DEBUG("command '%s' is already registered in '%s' context",
382 name
, parent
? parent
->name
: "<global>");
386 c
= command_new(context
, parent
, cr
);
390 int retval
= ERROR_OK
;
391 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
393 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
394 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
396 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
397 retval
= register_command_handler(context
, command_root(c
));
399 if (ERROR_OK
!= retval
)
401 unregister_command(context
, parent
, name
);
407 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
408 const struct command_registration
*cmds
)
410 int retval
= ERROR_OK
;
412 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
414 const struct command_registration
*cr
= cmds
+ i
;
416 struct command
*c
= NULL
;
417 if (NULL
!= cr
->name
)
419 c
= register_command(cmd_ctx
, parent
, cr
);
426 if (NULL
!= cr
->chain
)
428 struct command
*p
= c
? : parent
;
429 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
430 if (ERROR_OK
!= retval
)
434 if (ERROR_OK
!= retval
)
436 for (unsigned j
= 0; j
< i
; j
++)
437 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
442 int unregister_all_commands(struct command_context
*context
,
443 struct command
*parent
)
448 struct command
**head
= command_list_for_parent(context
, parent
);
449 while (NULL
!= *head
)
451 struct command
*tmp
= *head
;
459 int unregister_command(struct command_context
*context
,
460 struct command
*parent
, const char *name
)
462 if ((!context
) || (!name
))
463 return ERROR_INVALID_ARGUMENTS
;
465 struct command
*p
= NULL
;
466 struct command
**head
= command_list_for_parent(context
, parent
);
467 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
469 if (strcmp(name
, c
->name
) != 0)
484 void command_set_handler_data(struct command
*c
, void *p
)
486 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
487 c
->jim_handler_data
= p
;
488 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
489 command_set_handler_data(cc
, p
);
492 void command_output_text(struct command_context
*context
, const char *data
)
494 if (context
&& context
->output_handler
&& data
) {
495 context
->output_handler(context
, data
);
499 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
504 va_start(ap
, format
);
506 string
= alloc_vprintf(format
, ap
);
509 /* we want this collected in the log + we also want to pick it up as a tcl return
512 * The latter bit isn't precisely neat, but will do for now.
514 LOG_USER_N("%s", string
);
515 /* We already printed it above */
516 /* command_output_text(context, string); */
523 void command_print(struct command_context
*context
, const char *format
, ...)
528 va_start(ap
, format
);
530 string
= alloc_vprintf(format
, ap
);
533 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
534 /* we want this collected in the log + we also want to pick it up as a tcl return
537 * The latter bit isn't precisely neat, but will do for now.
539 LOG_USER_N("%s", string
);
540 /* We already printed it above */
541 /* command_output_text(context, string); */
548 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
551 unsigned len
= strlen(c
->name
);
552 if (NULL
== c
->parent
) {
553 // allocate enough for the name, child names, and '\0'
554 name
= malloc(len
+ extra
+ 1);
555 strcpy(name
, c
->name
);
557 // parent's extra must include both the space and name
558 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
559 char dstr
[2] = { delim
, 0 };
561 strcat(name
, c
->name
);
565 char *command_name(struct command
*c
, char delim
)
567 return __command_name(c
, delim
, 0);
570 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
572 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
575 static int run_command(struct command_context
*context
,
576 struct command
*c
, const char *words
[], unsigned num_words
)
578 if (!command_can_run(context
, c
))
580 /* Many commands may be run only before/after 'init' */
583 case COMMAND_CONFIG
: when
= "before"; break;
584 case COMMAND_EXEC
: when
= "after"; break;
585 // handle the impossible with humor; it guarantees a bug report!
586 default: when
= "if Cthulhu is summoned by"; break;
588 LOG_ERROR("The '%s' command must be used %s 'init'.",
593 struct command_invocation cmd
= {
597 .argc
= num_words
- 1,
600 int retval
= c
->handler(&cmd
);
601 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
603 /* Print help for command */
604 char *full_name
= command_name(c
, ' ');
605 if (NULL
!= full_name
) {
606 command_run_linef(context
, "usage %s", full_name
);
611 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
613 /* just fall through for a shutdown request */
615 else if (retval
!= ERROR_OK
)
617 /* we do not print out an error message because the command *should*
618 * have printed out an error
620 LOG_DEBUG("Command failed with error code %d", retval
);
626 int command_run_line(struct command_context
*context
, char *line
)
628 /* all the parent commands have been registered with the interpreter
629 * so, can just evaluate the line as a script and check for
632 /* run the line thru a script engine */
633 int retval
= ERROR_FAIL
;
635 /* Beware! This code needs to be reentrant. It is also possible
636 * for OpenOCD commands to be invoked directly from Tcl. This would
637 * happen when the Jim Tcl interpreter is provided by eCos for
640 Jim_Interp
*interp
= context
->interp
;
641 Jim_DeleteAssocData(interp
, "context");
642 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
643 if (retcode
== JIM_OK
)
645 /* associated the return value */
646 Jim_DeleteAssocData(interp
, "retval");
647 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
648 if (retcode
== JIM_OK
)
650 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
652 Jim_DeleteAssocData(interp
, "retval");
654 Jim_DeleteAssocData(interp
, "context");
656 if (retcode
== JIM_ERR
) {
657 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
659 /* We do not print the connection closed error message */
660 Jim_PrintErrorMessage(interp
);
662 if (retval
== ERROR_OK
)
664 /* It wasn't a low level OpenOCD command that failed */
668 } else if (retcode
== JIM_EXIT
) {
670 /* exit(Jim_GetExitCode(interp)); */
675 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
680 for (i
= 0; i
< reslen
; i
+= 256)
686 strncpy(buff
, result
+ i
, chunk
);
688 LOG_USER_N("%s", buff
);
690 LOG_USER_N("%s", "\n");
697 int command_run_linef(struct command_context
*context
, const char *format
, ...)
699 int retval
= ERROR_FAIL
;
702 va_start(ap
, format
);
703 string
= alloc_vprintf(format
, ap
);
706 retval
= command_run_line(context
, string
);
712 void command_set_output_handler(struct command_context
* context
,
713 command_output_handler_t output_handler
, void *priv
)
715 context
->output_handler
= output_handler
;
716 context
->output_handler_priv
= priv
;
719 struct command_context
* copy_command_context(struct command_context
* context
)
721 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
723 *copy_context
= *context
;
728 void command_done(struct command_context
*cmd_ctx
)
736 /* find full path to file */
737 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
741 const char *file
= Jim_GetString(argv
[1], NULL
);
742 char *full_path
= find_file(file
);
743 if (full_path
== NULL
)
745 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
748 Jim_SetResult(interp
, result
);
752 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
756 const char *str
= Jim_GetString(argv
[1], NULL
);
761 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
767 /* make it a char easier to read code */
771 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
775 /* do we have to chunk it? */
776 if (ptr
[nbytes
] == 0)
778 /* no it is a C style string */
779 LOG_USER_N("%s", ptr
);
782 /* GRR we must chunk - not null terminated */
792 memcpy(chunk
, ptr
, x
);
796 LOG_USER_N("%s", chunk
);
804 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
806 /* TCL wants to read... tell him no */
810 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
821 cp
= alloc_vprintf(fmt
, ap
);
824 LOG_USER_N("%s", cp
);
831 static int openocd_jim_fflush(void *cookie
)
833 /* nothing to flush */
837 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
844 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
849 struct log_capture_state
*state
= command_log_capture_start(interp
);
851 const char *str
= Jim_GetString(argv
[1], NULL
);
852 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
854 command_log_capture_finish(state
);
859 static COMMAND_HELPER(command_help_find
, struct command
*head
,
860 struct command
**out
)
863 return ERROR_INVALID_ARGUMENTS
;
864 *out
= command_find(head
, CMD_ARGV
[0]);
865 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
866 *out
= command_find(head
, CMD_ARGV
[0] + 4);
868 return ERROR_INVALID_ARGUMENTS
;
872 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
875 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
876 bool show_help
, const char *match
);
878 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
879 bool show_help
, const char *match
)
881 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
882 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, match
);
886 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
888 static void command_help_show_indent(unsigned n
)
890 for (unsigned i
= 0; i
< n
; i
++)
893 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
895 const char *cp
= str
, *last
= str
;
898 const char *next
= last
;
903 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
904 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
905 if (next
- last
< HELP_LINE_WIDTH(n
))
907 command_help_show_indent(n
);
908 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
914 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
915 bool show_help
, const char *match
)
917 if (!command_can_run(CMD_CTX
, c
))
920 char *cmd_name
= command_name(c
, ' ');
921 if (NULL
== cmd_name
)
924 /* If the match string occurs anywhere, we print out
925 * stuff for this command. */
926 bool is_match
= (strstr(cmd_name
, match
) != NULL
) ||
927 ((c
->usage
!= NULL
) && (strstr(c
->usage
, match
) != NULL
)) ||
928 ((c
->help
!= NULL
) && (strstr(c
->help
, match
) != NULL
));
932 command_help_show_indent(n
);
933 LOG_USER_N("%s", cmd_name
);
941 command_help_show_wrap(c
->usage
, 0, n
+ 5);
947 if (is_match
&& show_help
)
951 /* Normal commands are runtime-only; highlight exceptions */
952 if (c
->mode
!= COMMAND_EXEC
) {
953 const char *stage_msg
= "";
957 stage_msg
= " (configuration command)";
960 stage_msg
= " (command valid any time)";
963 stage_msg
= " (?mode error?)";
966 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
968 msg
= alloc_printf("%s", c
->help
? : "");
972 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
981 return CALL_COMMAND_HANDLER(command_help_show_list
,
982 c
->children
, n
, show_help
, match
);
984 COMMAND_HANDLER(handle_help_command
)
986 bool full
= strcmp(CMD_NAME
, "help") == 0;
988 struct command
*c
= CMD_CTX
->commands
;
993 else if (CMD_ARGC
>= 1) {
996 for (i
= 0; i
< CMD_ARGC
; ++i
) {
1000 match
= alloc_printf("%s %s", match
,
1003 if (NULL
== match
) {
1004 LOG_ERROR("unable to build "
1009 match
= alloc_printf("%s", CMD_ARGV
[i
]);
1010 if (NULL
== match
) {
1011 LOG_ERROR("unable to build "
1018 return ERROR_COMMAND_SYNTAX_ERROR
;
1020 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
1028 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
1029 struct command
*head
, struct command
**out
, bool top_level
)
1033 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1034 struct command
*c
= command_find(head
, cmd_name
);
1035 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
1036 c
= command_find(head
, cmd_name
+ 4);
1040 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
1044 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1046 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
1047 if (strcmp(cmd_name
, "unknown") == 0)
1054 script_debug(interp
, cmd_name
, argc
, argv
);
1056 struct command_context
*cmd_ctx
= current_command_context(interp
);
1057 struct command
*c
= cmd_ctx
->commands
;
1058 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
1059 // if nothing could be consumed, then it's really an unknown command
1060 if (remaining
== argc
)
1062 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1063 LOG_ERROR("Unknown command:\n %s", cmd
);
1068 Jim_Obj
*const *start
;
1070 if (c
->handler
|| c
->jim_handler
)
1072 // include the command name in the list
1073 count
= remaining
+ 1;
1074 start
= argv
+ (argc
- remaining
- 1);
1078 c
= command_find(cmd_ctx
->commands
, "usage");
1081 LOG_ERROR("unknown command, but usage is missing too");
1084 count
= argc
- remaining
;
1088 // pass the command through to the intended handler
1091 interp
->cmdPrivData
= c
->jim_handler_data
;
1092 return (*c
->jim_handler
)(interp
, count
, start
);
1095 return script_command_run(interp
, count
, start
, c
, found
);
1098 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1100 struct command_context
*cmd_ctx
= current_command_context(interp
);
1101 enum command_mode mode
;
1105 struct command
*c
= cmd_ctx
->commands
;
1106 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1107 // if nothing could be consumed, then it's an unknown command
1108 if (remaining
== argc
- 1)
1110 Jim_SetResultString(interp
, "unknown", -1);
1116 mode
= cmd_ctx
->mode
;
1118 const char *mode_str
;
1120 case COMMAND_ANY
: mode_str
= "any"; break;
1121 case COMMAND_CONFIG
: mode_str
= "config"; break;
1122 case COMMAND_EXEC
: mode_str
= "exec"; break;
1123 default: mode_str
= "unknown"; break;
1125 Jim_SetResultString(interp
, mode_str
, -1);
1129 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1134 struct command_context
*cmd_ctx
= current_command_context(interp
);
1135 struct command
*c
= cmd_ctx
->commands
;
1136 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1137 // if nothing could be consumed, then it's an unknown command
1138 if (remaining
== argc
- 1)
1140 Jim_SetResultString(interp
, "unknown", -1);
1145 Jim_SetResultString(interp
, "native", -1);
1146 else if (c
->handler
)
1147 Jim_SetResultString(interp
, "simple", -1);
1149 Jim_SetResultString(interp
, "group", -1);
1154 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1155 const char *cmd_name
, const char *help_text
, const char *usage
)
1157 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1158 struct command
*nc
= command_find(*head
, cmd_name
);
1161 // add a new command with help text
1162 struct command_registration cr
= {
1164 .mode
= COMMAND_ANY
,
1168 nc
= register_command(cmd_ctx
, parent
, &cr
);
1171 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1174 LOG_DEBUG("added '%s' help text", cmd_name
);
1179 bool replaced
= false;
1182 free((void *)nc
->help
);
1185 nc
->help
= strdup(help_text
);
1187 LOG_INFO("replaced existing '%s' help", cmd_name
);
1189 LOG_DEBUG("added '%s' help text", cmd_name
);
1193 bool replaced
= false;
1196 free((void *)nc
->usage
);
1199 nc
->usage
= strdup(usage
);
1201 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1203 LOG_DEBUG("added '%s' usage text", cmd_name
);
1208 COMMAND_HANDLER(handle_help_add_command
)
1212 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1213 return ERROR_INVALID_ARGUMENTS
;
1216 // save help text and remove it from argument list
1217 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1218 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1219 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1220 if (!help
&& !usage
)
1222 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1223 return ERROR_INVALID_ARGUMENTS
;
1225 // likewise for the leaf command name
1226 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1228 struct command
*c
= NULL
;
1231 c
= CMD_CTX
->commands
;
1232 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1233 if (ERROR_OK
!= retval
)
1236 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1239 /* sleep command sleeps for <n> milliseconds
1240 * this is useful in target startup scripts
1242 COMMAND_HANDLER(handle_sleep_command
)
1247 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1250 return ERROR_COMMAND_SYNTAX_ERROR
;
1252 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1253 return ERROR_COMMAND_SYNTAX_ERROR
;
1255 unsigned long duration
= 0;
1256 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1257 if (ERROR_OK
!= retval
)
1262 long long then
= timeval_ms();
1263 while (timeval_ms() - then
< (long long)duration
)
1265 target_call_timer_callbacks_now();
1270 busy_sleep(duration
);
1275 static const struct command_registration command_subcommand_handlers
[] = {
1278 .mode
= COMMAND_ANY
,
1279 .jim_handler
= jim_command_mode
,
1280 .usage
= "[command_name ...]",
1281 .help
= "Returns the command modes allowed by a command:"
1282 "'any', 'config', or 'exec'. If no command is"
1283 "specified, returns the current command mode. "
1284 "Returns 'unknown' if an unknown command is given. "
1285 "Command can be multiple tokens.",
1289 .mode
= COMMAND_ANY
,
1290 .jim_handler
= jim_command_type
,
1291 .usage
= "command_name [...]",
1292 .help
= "Returns the type of built-in command:"
1293 "'native', 'simple', 'group', or 'unknown'. "
1294 "Command can be multiple tokens.",
1296 COMMAND_REGISTRATION_DONE
1299 static const struct command_registration command_builtin_handlers
[] = {
1301 .name
= "add_help_text",
1302 .handler
= handle_help_add_command
,
1303 .mode
= COMMAND_ANY
,
1304 .help
= "Add new command help text; "
1305 "Command can be multiple tokens.",
1306 .usage
= "command_name helptext_string",
1309 .name
= "add_usage_text",
1310 .handler
= handle_help_add_command
,
1311 .mode
= COMMAND_ANY
,
1312 .help
= "Add new command usage text; "
1313 "command can be multiple tokens.",
1314 .usage
= "command_name usage_string",
1318 .handler
= handle_sleep_command
,
1319 .mode
= COMMAND_ANY
,
1320 .help
= "Sleep for specified number of milliseconds. "
1321 "\"busy\" will busy wait instead (avoid this).",
1322 .usage
= "milliseconds ['busy']",
1326 .handler
= handle_help_command
,
1327 .mode
= COMMAND_ANY
,
1328 .help
= "Show full command help; "
1329 "command can be multiple tokens.",
1330 .usage
= "[command_name]",
1334 .handler
= handle_help_command
,
1335 .mode
= COMMAND_ANY
,
1336 .help
= "Show basic command usage; "
1337 "command can be multiple tokens.",
1338 .usage
= "[command_name]",
1343 .help
= "core command group (introspection)",
1344 .chain
= command_subcommand_handlers
,
1346 COMMAND_REGISTRATION_DONE
1349 struct command_context
* command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1351 struct command_context
* context
= malloc(sizeof(struct command_context
));
1354 context
->mode
= COMMAND_EXEC
;
1355 context
->commands
= NULL
;
1356 context
->current_target
= 0;
1357 context
->output_handler
= NULL
;
1358 context
->output_handler_priv
= NULL
;
1360 #if !BUILD_ECOSBOARD
1361 /* Create a jim interpreter if we were not handed one */
1365 /* Create an interpreter */
1366 interp
= Jim_CreateInterp();
1367 /* Add all the Jim core commands */
1368 Jim_RegisterCoreCommands(interp
);
1371 context
->interp
= interp
;
1373 /* Stick to lowercase for HostOS strings. */
1374 #if defined(_MSC_VER)
1375 /* WinXX - is generic, the forward
1376 * looking problem is this:
1378 * "win32" or "win64"
1380 * "winxx" is generic.
1383 #elif defined(__linux__)
1385 #elif defined(__APPLE__) || defined(__DARWIN__)
1387 #elif defined(__CYGWIN__)
1389 #elif defined(__MINGW32__)
1391 #elif defined(__ECOS)
1393 #elif defined(__FreeBSD__)
1396 #warning "Unrecognized host OS..."
1399 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1400 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1402 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1403 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1404 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1406 /* Set Jim's STDIO */
1407 interp
->cookie_stdin
= interp
;
1408 interp
->cookie_stdout
= interp
;
1409 interp
->cookie_stderr
= interp
;
1410 interp
->cb_fwrite
= openocd_jim_fwrite
;
1411 interp
->cb_fread
= openocd_jim_fread
;
1412 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1413 interp
->cb_fflush
= openocd_jim_fflush
;
1414 interp
->cb_fgets
= openocd_jim_fgets
;
1416 register_commands(context
, NULL
, command_builtin_handlers
);
1418 #if !BUILD_ECOSBOARD
1419 Jim_EventLoopOnLoad(interp
);
1421 Jim_SetAssocData(interp
, "context", NULL
, context
);
1422 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1424 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1425 Jim_PrintErrorMessage(interp
);
1428 Jim_DeleteAssocData(interp
, "context");
1433 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1436 return ERROR_INVALID_ARGUMENTS
;
1438 cmd_ctx
->mode
= mode
;
1442 void process_jim_events(struct command_context
*cmd_ctx
)
1444 #if !BUILD_ECOSBOARD
1445 static int recursion
= 0;
1450 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1455 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1456 int parse##name(const char *str, type *ul) \
1460 LOG_ERROR("Invalid command argument"); \
1461 return ERROR_COMMAND_ARGUMENT_INVALID; \
1464 *ul = func(str, &end, 0); \
1467 LOG_ERROR("Invalid command argument"); \
1468 return ERROR_COMMAND_ARGUMENT_INVALID; \
1470 if ((max == *ul) && (ERANGE == errno)) \
1472 LOG_ERROR("Argument overflow"); \
1473 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1475 if (min && (min == *ul) && (ERANGE == errno)) \
1477 LOG_ERROR("Argument underflow"); \
1478 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1482 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1483 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1484 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1485 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1487 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1488 int parse##name(const char *str, type *ul) \
1491 int retval = parse##funcname(str, &n); \
1492 if (ERROR_OK != retval) \
1495 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1497 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1502 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1503 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1504 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1505 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1506 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1507 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1509 #define DEFINE_PARSE_LONG(name, type, min, max) \
1510 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1511 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1512 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1513 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1514 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1516 static int command_parse_bool(const char *in
, bool *out
,
1517 const char *on
, const char *off
)
1519 if (strcasecmp(in
, on
) == 0)
1521 else if (strcasecmp(in
, off
) == 0)
1524 return ERROR_COMMAND_SYNTAX_ERROR
;
1528 int command_parse_bool_arg(const char *in
, bool *out
)
1530 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1532 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1534 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1536 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1538 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1540 return ERROR_INVALID_ARGUMENTS
;
1543 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1547 const char *in
= CMD_ARGV
[0];
1548 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1550 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1551 return ERROR_INVALID_ARGUMENTS
;
1556 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1559 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)