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
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"
50 Jim_Interp
*interp
= NULL
;
52 static int run_command(struct command_context
*context
,
53 struct command
*c
, const char *words
[], unsigned num_words
);
55 static void tcl_output(void *privData
, const char *file
, unsigned line
,
56 const char *function
, const char *string
)
58 Jim_Obj
*tclOutput
= (Jim_Obj
*)privData
;
59 Jim_AppendString(interp
, tclOutput
, string
, strlen(string
));
62 static Jim_Obj
*command_log_capture_start(Jim_Interp
*interp
)
64 /* capture log output and return it. A garbage collect can
65 * happen, so we need a reference count to this object */
66 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
67 if (NULL
== tclOutput
)
69 Jim_IncrRefCount(tclOutput
);
70 log_add_callback(tcl_output
, tclOutput
);
74 static void command_log_capture_finish(Jim_Interp
*interp
, Jim_Obj
*tclOutput
)
76 log_remove_callback(tcl_output
, tclOutput
);
77 Jim_SetResult(interp
, tclOutput
);
78 Jim_DecrRefCount(interp
, tclOutput
);
81 static int command_retval_set(Jim_Interp
*interp
, int retval
)
83 int *return_retval
= Jim_GetAssocData(interp
, "retval");
84 if (return_retval
!= NULL
)
85 *return_retval
= retval
;
87 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
90 extern struct command_context
*global_cmd_ctx
;
92 void script_debug(Jim_Interp
*interp
, const char *name
,
93 unsigned argc
, Jim_Obj
*const *argv
)
95 LOG_DEBUG("command - %s", name
);
96 for (unsigned i
= 0; i
< argc
; i
++)
99 const char *w
= Jim_GetString(argv
[i
], &len
);
101 /* end of line comment? */
105 LOG_DEBUG("%s - argv[%d]=%s", name
, i
, w
);
109 static void script_command_args_free(const char **words
, unsigned nwords
)
111 for (unsigned i
= 0; i
< nwords
; i
++)
112 free((void *)words
[i
]);
115 static const char **script_command_args_alloc(
116 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
118 const char **words
= malloc(argc
* sizeof(char *));
123 for (i
= 0; i
< argc
; i
++)
126 const char *w
= Jim_GetString(argv
[i
], &len
);
127 /* a comment may end the line early */
131 words
[i
] = strdup(w
);
132 if (words
[i
] == NULL
)
134 script_command_args_free(words
, i
);
142 static struct command_context
*current_command_context(void)
144 /* grab the command context from the associated data */
145 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
148 /* Tcl can invoke commands directly instead of via command_run_line(). This would
149 * happen when the Jim Tcl interpreter is provided by eCos.
151 cmd_ctx
= global_cmd_ctx
;
156 static int script_command_run(Jim_Interp
*interp
,
157 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
159 target_call_timer_callbacks_now();
160 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
163 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
167 Jim_Obj
*tclOutput
= NULL
;
169 tclOutput
= command_log_capture_start(interp
);
171 struct command_context
*cmd_ctx
= current_command_context();
172 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
175 command_log_capture_finish(interp
, tclOutput
);
177 script_command_args_free(words
, nwords
);
178 return command_retval_set(interp
, retval
);
181 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
183 /* the private data is stashed in the interp structure */
185 struct command
*c
= interp
->cmdPrivData
;
187 script_debug(interp
, c
->name
, argc
, argv
);
188 return script_command_run(interp
, argc
, argv
, c
, true);
191 static struct command
*command_root(struct command
*c
)
193 while (NULL
!= c
->parent
)
199 * Find a command by name from a list of commands.
200 * @returns Returns the named command if it exists in the list.
201 * Returns NULL otherwise.
203 static struct command
*command_find(struct command
*head
, const char *name
)
205 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
207 if (strcmp(cc
->name
, name
) == 0)
212 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
215 return command_find(cmd_ctx
->commands
, name
);
217 struct command
*command_find_in_parent(struct command
*parent
,
220 return command_find(parent
->children
, name
);
224 * Add the command into the linked list, sorted by name.
225 * @param head Address to head of command list pointer, which may be
226 * updated if @c c gets inserted at the beginning of the list.
227 * @param c The command to add to the list pointed to by @c head.
229 static void command_add_child(struct command
**head
, struct command
*c
)
238 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
239 head
= &(*head
)->next
;
241 if (strcmp(c
->name
, (*head
)->name
) > 0) {
242 c
->next
= (*head
)->next
;
250 static struct command
**command_list_for_parent(
251 struct command_context
*cmd_ctx
, struct command
*parent
)
253 return parent
? &parent
->children
: &cmd_ctx
->commands
;
256 static struct command
*command_new(struct command_context
*cmd_ctx
,
257 struct command
*parent
, const struct command_registration
*cr
)
261 struct command
*c
= malloc(sizeof(struct command
));
262 memset(c
, 0, sizeof(struct command
));
264 c
->name
= strdup(cr
->name
);
266 c
->help
= strdup(cr
->help
);
268 c
->usage
= strdup(cr
->usage
);
270 c
->handler
= cr
->handler
;
271 c
->jim_handler
= cr
->jim_handler
;
272 c
->jim_handler_data
= cr
->jim_handler_data
;
275 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
279 static void command_free(struct command
*c
)
281 /// @todo if command has a handler, unregister its jim command!
283 while (NULL
!= c
->children
)
285 struct command
*tmp
= c
->children
;
286 c
->children
= tmp
->next
;
293 free((void*)c
->help
);
295 free((void*)c
->usage
);
299 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
301 static int register_command_handler(struct command
*c
)
303 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
304 if (NULL
== ocd_name
)
307 LOG_DEBUG("registering '%s'...", ocd_name
);
309 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
310 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
311 free((void *)ocd_name
);
312 if (JIM_OK
!= retval
)
315 /* we now need to add an overrideable proc */
316 const char *override_name
= alloc_printf(
317 "proc %s {args} {eval ocd_bouncer %s $args}",
319 if (NULL
== override_name
)
322 retval
= Jim_Eval_Named(interp
, override_name
, __FILE__
, __LINE__
);
323 free((void *)override_name
);
328 struct command
* register_command(struct command_context
*context
,
329 struct command
*parent
, const struct command_registration
*cr
)
331 if (!context
|| !cr
->name
)
334 const char *name
= cr
->name
;
335 struct command
**head
= command_list_for_parent(context
, parent
);
336 struct command
*c
= command_find(*head
, name
);
339 LOG_ERROR("command '%s' is already registered in '%s' context",
340 name
, parent
? parent
->name
: "<global>");
344 c
= command_new(context
, parent
, cr
);
348 int retval
= ERROR_OK
;
349 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
351 retval
= Jim_CreateCommand(interp
, cr
->name
,
352 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
354 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
355 retval
= register_command_handler(command_root(c
));
357 if (ERROR_OK
!= retval
)
359 unregister_command(context
, parent
, name
);
365 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
366 const struct command_registration
*cmds
)
368 int retval
= ERROR_OK
;
370 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
372 const struct command_registration
*cr
= cmds
+ i
;
374 struct command
*c
= NULL
;
375 if (NULL
!= cr
->name
)
377 c
= register_command(cmd_ctx
, parent
, cr
);
384 if (NULL
!= cr
->chain
)
386 struct command
*p
= c
? : parent
;
387 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
388 if (ERROR_OK
!= retval
)
392 if (ERROR_OK
!= retval
)
394 for (unsigned j
= 0; j
< i
; j
++)
395 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
400 int unregister_all_commands(struct command_context
*context
,
401 struct command
*parent
)
406 struct command
**head
= command_list_for_parent(context
, parent
);
407 while (NULL
!= *head
)
409 struct command
*tmp
= *head
;
417 int unregister_command(struct command_context
*context
,
418 struct command
*parent
, const char *name
)
420 if ((!context
) || (!name
))
421 return ERROR_INVALID_ARGUMENTS
;
423 struct command
*p
= NULL
;
424 struct command
**head
= command_list_for_parent(context
, parent
);
425 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
427 if (strcmp(name
, c
->name
) != 0)
442 void command_set_handler_data(struct command
*c
, void *p
)
444 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
445 c
->jim_handler_data
= p
;
446 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
447 command_set_handler_data(cc
, p
);
450 void command_output_text(struct command_context
*context
, const char *data
)
452 if (context
&& context
->output_handler
&& data
) {
453 context
->output_handler(context
, data
);
457 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
462 va_start(ap
, format
);
464 string
= alloc_vprintf(format
, ap
);
467 /* we want this collected in the log + we also want to pick it up as a tcl return
470 * The latter bit isn't precisely neat, but will do for now.
472 LOG_USER_N("%s", string
);
473 /* We already printed it above */
474 /* command_output_text(context, string); */
481 void command_print(struct command_context
*context
, const char *format
, ...)
486 va_start(ap
, format
);
488 string
= alloc_vprintf(format
, ap
);
491 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
492 /* we want this collected in the log + we also want to pick it up as a tcl return
495 * The latter bit isn't precisely neat, but will do for now.
497 LOG_USER_N("%s", string
);
498 /* We already printed it above */
499 /* command_output_text(context, string); */
506 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
509 unsigned len
= strlen(c
->name
);
510 if (NULL
== c
->parent
) {
511 // allocate enough for the name, child names, and '\0'
512 name
= malloc(len
+ extra
+ 1);
513 strcpy(name
, c
->name
);
515 // parent's extra must include both the space and name
516 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
517 char dstr
[2] = { delim
, 0 };
519 strcat(name
, c
->name
);
523 char *command_name(struct command
*c
, char delim
)
525 return __command_name(c
, delim
, 0);
528 static int run_command(struct command_context
*context
,
529 struct command
*c
, const char *words
[], unsigned num_words
)
531 if (!((context
->mode
== COMMAND_CONFIG
) || (c
->mode
== COMMAND_ANY
) || (c
->mode
== context
->mode
)))
533 /* Config commands can not run after the config stage */
534 LOG_ERROR("Command '%s' only runs during configuration stage", c
->name
);
538 struct command_invocation cmd
= {
541 .argc
= num_words
- 1,
544 int retval
= c
->handler(&cmd
);
545 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
547 /* Print help for command */
548 char *full_name
= command_name(c
, ' ');
549 if (NULL
!= full_name
) {
550 command_run_linef(context
, "help %s", full_name
);
555 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
557 /* just fall through for a shutdown request */
559 else if (retval
!= ERROR_OK
)
561 /* we do not print out an error message because the command *should*
562 * have printed out an error
564 LOG_DEBUG("Command failed with error code %d", retval
);
570 int command_run_line(struct command_context
*context
, char *line
)
572 /* all the parent commands have been registered with the interpreter
573 * so, can just evaluate the line as a script and check for
576 /* run the line thru a script engine */
577 int retval
= ERROR_FAIL
;
579 /* Beware! This code needs to be reentrant. It is also possible
580 * for OpenOCD commands to be invoked directly from Tcl. This would
581 * happen when the Jim Tcl interpreter is provided by eCos for
584 Jim_DeleteAssocData(interp
, "context");
585 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
586 if (retcode
== JIM_OK
)
588 /* associated the return value */
589 Jim_DeleteAssocData(interp
, "retval");
590 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
591 if (retcode
== JIM_OK
)
593 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
595 Jim_DeleteAssocData(interp
, "retval");
597 Jim_DeleteAssocData(interp
, "context");
599 if (retcode
== JIM_ERR
) {
600 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
602 /* We do not print the connection closed error message */
603 Jim_PrintErrorMessage(interp
);
605 if (retval
== ERROR_OK
)
607 /* It wasn't a low level OpenOCD command that failed */
611 } else if (retcode
== JIM_EXIT
) {
613 /* exit(Jim_GetExitCode(interp)); */
618 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
623 for (i
= 0; i
< reslen
; i
+= 256)
629 strncpy(buff
, result
+ i
, chunk
);
631 LOG_USER_N("%s", buff
);
633 LOG_USER_N("%s", "\n");
640 int command_run_linef(struct command_context
*context
, const char *format
, ...)
642 int retval
= ERROR_FAIL
;
645 va_start(ap
, format
);
646 string
= alloc_vprintf(format
, ap
);
649 retval
= command_run_line(context
, string
);
655 void command_set_output_handler(struct command_context
* context
,
656 command_output_handler_t output_handler
, void *priv
)
658 context
->output_handler
= output_handler
;
659 context
->output_handler_priv
= priv
;
662 struct command_context
* copy_command_context(struct command_context
* context
)
664 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
666 *copy_context
= *context
;
671 int command_done(struct command_context
*context
)
679 /* find full path to file */
680 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
684 const char *file
= Jim_GetString(argv
[1], NULL
);
685 char *full_path
= find_file(file
);
686 if (full_path
== NULL
)
688 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
691 Jim_SetResult(interp
, result
);
695 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
699 const char *str
= Jim_GetString(argv
[1], NULL
);
704 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
710 /* make it a char easier to read code */
714 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
718 /* do we have to chunk it? */
719 if (ptr
[nbytes
] == 0)
721 /* no it is a C style string */
722 LOG_USER_N("%s", ptr
);
725 /* GRR we must chunk - not null terminated */
735 memcpy(chunk
, ptr
, x
);
739 LOG_USER_N("%s", chunk
);
747 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
749 /* TCL wants to read... tell him no */
753 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
764 cp
= alloc_vprintf(fmt
, ap
);
767 LOG_USER_N("%s", cp
);
774 static int openocd_jim_fflush(void *cookie
)
776 /* nothing to flush */
780 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
787 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
792 Jim_Obj
*tclOutput
= command_log_capture_start(interp
);
794 const char *str
= Jim_GetString(argv
[1], NULL
);
795 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
797 command_log_capture_finish(interp
, tclOutput
);
802 static COMMAND_HELPER(command_help_find
, struct command
*head
,
803 struct command
**out
)
806 return ERROR_INVALID_ARGUMENTS
;
807 *out
= command_find(head
, CMD_ARGV
[0]);
808 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
809 *out
= command_find(head
, CMD_ARGV
[0] + 4);
811 return ERROR_INVALID_ARGUMENTS
;
815 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
818 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
821 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
824 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
825 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
829 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
831 static void command_help_show_indent(unsigned n
)
833 for (unsigned i
= 0; i
< n
; i
++)
836 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
838 const char *cp
= str
, *last
= str
;
841 const char *next
= last
;
846 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
847 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
848 if (next
- last
< HELP_LINE_WIDTH(n
))
850 command_help_show_indent(n
);
851 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
857 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
860 command_help_show_indent(n
);
861 LOG_USER_N("%s", command_name(c
, ' '));
864 command_help_show_wrap(c
->usage
, 0, n
+ 5);
868 if (show_help
&& c
->help
)
869 command_help_show_wrap(c
->help
, n
+ 3, n
+ 3);
873 return CALL_COMMAND_HANDLER(command_help_show_list
,
874 c
->children
, n
, show_help
);
876 COMMAND_HANDLER(handle_help_command
)
878 bool full
= strcmp(CMD_NAME
, "help") == 0;
880 struct command
*c
= CMD_CTX
->commands
;
883 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, full
);
885 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
886 if (ERROR_OK
!= retval
)
889 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, full
);
892 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
893 struct command
*head
, struct command
**out
, bool top_level
)
897 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
898 struct command
*c
= command_find(head
, cmd_name
);
899 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
900 c
= command_find(head
, cmd_name
+ 4);
904 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
907 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
909 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
910 if (strcmp(cmd_name
, "unknown") == 0)
917 script_debug(interp
, cmd_name
, argc
, argv
);
919 struct command_context
*cmd_ctx
= current_command_context();
920 struct command
*c
= cmd_ctx
->commands
;
921 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
922 // if nothing could be consumed, then it's really an unknown command
923 if (remaining
== argc
)
925 const char *cmd
= Jim_GetString(argv
[0], NULL
);
926 LOG_ERROR("Unknown command:\n %s", cmd
);
931 Jim_Obj
*const *start
;
933 if (c
->handler
|| c
->jim_handler
)
935 // include the command name in the list
936 count
= remaining
+ 1;
937 start
= argv
+ (argc
- remaining
- 1);
941 c
= command_find(cmd_ctx
->commands
, "help");
944 LOG_ERROR("unknown command, but help is missing too");
947 count
= argc
- remaining
;
951 // pass the command through to the intended handler
954 interp
->cmdPrivData
= c
->jim_handler_data
;
955 return (*c
->jim_handler
)(interp
, count
, start
);
958 return script_command_run(interp
, count
, start
, c
, found
);
961 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
963 struct command_context
*cmd_ctx
= current_command_context();
964 enum command_mode mode
;
967 struct command
*c
= cmd_ctx
->commands
;
968 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
969 // if nothing could be consumed, then it's an unknown command
970 if (remaining
== argc
- 1)
972 Jim_SetResultString(interp
, "unknown", -1);
978 mode
= cmd_ctx
->mode
;
980 const char *mode_str
;
982 case COMMAND_ANY
: mode_str
= "any"; break;
983 case COMMAND_CONFIG
: mode_str
= "config"; break;
984 case COMMAND_EXEC
: mode_str
= "exec"; break;
985 default: mode_str
= "unknown"; break;
987 Jim_SetResultString(interp
, mode_str
, -1);
991 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
996 struct command_context
*cmd_ctx
= current_command_context();
997 struct command
*c
= cmd_ctx
->commands
;
998 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
999 // if nothing could be consumed, then it's an unknown command
1000 if (remaining
== argc
- 1)
1002 Jim_SetResultString(interp
, "unknown", -1);
1007 Jim_SetResultString(interp
, "native", -1);
1008 else if (c
->handler
)
1009 Jim_SetResultString(interp
, "simple", -1);
1011 Jim_SetResultString(interp
, "group", -1);
1016 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1017 const char *cmd_name
, const char *help_text
, const char *usage
)
1019 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1020 struct command
*nc
= command_find(*head
, cmd_name
);
1023 // add a new command with help text
1024 struct command_registration cr
= {
1026 .mode
= COMMAND_ANY
,
1030 nc
= register_command(cmd_ctx
, parent
, &cr
);
1033 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1036 LOG_DEBUG("added '%s' help text", cmd_name
);
1041 bool replaced
= false;
1044 free((void *)nc
->help
);
1047 nc
->help
= strdup(help_text
);
1049 LOG_INFO("replaced existing '%s' help", cmd_name
);
1051 LOG_DEBUG("added '%s' help text", cmd_name
);
1055 bool replaced
= false;
1058 free((void *)nc
->usage
);
1061 nc
->usage
= strdup(usage
);
1063 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1065 LOG_DEBUG("added '%s' usage text", cmd_name
);
1070 COMMAND_HANDLER(handle_help_add_command
)
1074 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1075 return ERROR_INVALID_ARGUMENTS
;
1078 // save help text and remove it from argument list
1079 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1080 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1081 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1082 if (!help
&& !usage
)
1084 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1085 return ERROR_INVALID_ARGUMENTS
;
1087 // likewise for the leaf command name
1088 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1090 struct command
*c
= NULL
;
1093 c
= CMD_CTX
->commands
;
1094 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1095 if (ERROR_OK
!= retval
)
1098 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1101 /* sleep command sleeps for <n> miliseconds
1102 * this is useful in target startup scripts
1104 COMMAND_HANDLER(handle_sleep_command
)
1109 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1112 return ERROR_COMMAND_SYNTAX_ERROR
;
1114 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1115 return ERROR_COMMAND_SYNTAX_ERROR
;
1117 unsigned long duration
= 0;
1118 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1119 if (ERROR_OK
!= retval
)
1124 long long then
= timeval_ms();
1125 while (timeval_ms() - then
< (long long)duration
)
1127 target_call_timer_callbacks_now();
1132 busy_sleep(duration
);
1137 static const struct command_registration command_subcommand_handlers
[] = {
1140 .mode
= COMMAND_ANY
,
1141 .jim_handler
= &jim_command_mode
,
1142 .usage
= "[<name> ...]",
1143 .help
= "Returns the command modes allowed by a command:"
1144 "'any', 'config', or 'exec'. If no command is"
1145 "specified, returns the current command mode.",
1149 .mode
= COMMAND_ANY
,
1150 .jim_handler
= &jim_command_type
,
1151 .usage
= "<name> ...",
1152 .help
= "Returns the type of built-in command:"
1153 "'native', 'simple', 'group', or 'unknown'",
1155 COMMAND_REGISTRATION_DONE
1158 static const struct command_registration command_builtin_handlers
[] = {
1160 .name
= "add_help_text",
1161 .handler
= &handle_help_add_command
,
1162 .mode
= COMMAND_ANY
,
1163 .help
= "add new command help text",
1164 .usage
= "<command> [...] <help_text>]",
1167 .name
= "add_usage_text",
1168 .handler
= &handle_help_add_command
,
1169 .mode
= COMMAND_ANY
,
1170 .help
= "add new command usage text",
1171 .usage
= "<command> [...] <usage_text>]",
1175 .handler
= &handle_sleep_command
,
1176 .mode
= COMMAND_ANY
,
1177 .help
= "sleep for n milliseconds. "
1178 "\"busy\" will busy wait",
1179 .usage
= "<n> [busy]",
1183 .handler
= &handle_help_command
,
1184 .mode
= COMMAND_ANY
,
1185 .help
= "show full command help",
1186 .usage
= "[<command> ...]",
1190 .handler
= &handle_help_command
,
1191 .mode
= COMMAND_ANY
,
1192 .help
= "show basic command usage",
1193 .usage
= "[<command> ...]",
1198 .help
= "core command group (introspection)",
1199 .chain
= command_subcommand_handlers
,
1201 COMMAND_REGISTRATION_DONE
1204 struct command_context
* command_init(const char *startup_tcl
)
1206 struct command_context
* context
= malloc(sizeof(struct command_context
));
1209 context
->mode
= COMMAND_EXEC
;
1210 context
->commands
= NULL
;
1211 context
->current_target
= 0;
1212 context
->output_handler
= NULL
;
1213 context
->output_handler_priv
= NULL
;
1215 #if !BUILD_ECOSBOARD
1217 /* Create an interpreter */
1218 interp
= Jim_CreateInterp();
1219 /* Add all the Jim core commands */
1220 Jim_RegisterCoreCommands(interp
);
1223 #if defined(_MSC_VER)
1224 /* WinXX - is generic, the forward
1225 * looking problem is this:
1227 * "win32" or "win64"
1229 * "winxx" is generic.
1232 #elif defined(__linux__)
1234 #elif defined(__DARWIN__)
1236 #elif defined(__CYGWIN__)
1238 #elif defined(__MINGW32__)
1240 #elif defined(__ECOS)
1243 #warn unrecognized host OS...
1246 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1247 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1249 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1250 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1251 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1253 /* Set Jim's STDIO */
1254 interp
->cookie_stdin
= interp
;
1255 interp
->cookie_stdout
= interp
;
1256 interp
->cookie_stderr
= interp
;
1257 interp
->cb_fwrite
= openocd_jim_fwrite
;
1258 interp
->cb_fread
= openocd_jim_fread
;
1259 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1260 interp
->cb_fflush
= openocd_jim_fflush
;
1261 interp
->cb_fgets
= openocd_jim_fgets
;
1263 register_commands(context
, NULL
, command_builtin_handlers
);
1265 #if !BUILD_ECOSBOARD
1266 Jim_EventLoopOnLoad(interp
);
1268 Jim_SetAssocData(interp
, "context", NULL
, context
);
1269 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1271 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1272 Jim_PrintErrorMessage(interp
);
1275 Jim_DeleteAssocData(interp
, "context");
1280 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1283 return ERROR_INVALID_ARGUMENTS
;
1285 cmd_ctx
->mode
= mode
;
1289 void process_jim_events(void)
1291 #if !BUILD_ECOSBOARD
1292 static int recursion
= 0;
1297 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1303 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1304 int parse##name(const char *str, type *ul) \
1308 LOG_ERROR("Invalid command argument"); \
1309 return ERROR_COMMAND_ARGUMENT_INVALID; \
1312 *ul = func(str, &end, 0); \
1315 LOG_ERROR("Invalid command argument"); \
1316 return ERROR_COMMAND_ARGUMENT_INVALID; \
1318 if ((max == *ul) && (ERANGE == errno)) \
1320 LOG_ERROR("Argument overflow"); \
1321 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1323 if (min && (min == *ul) && (ERANGE == errno)) \
1325 LOG_ERROR("Argument underflow"); \
1326 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1330 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1331 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1332 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1333 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1335 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1336 int parse##name(const char *str, type *ul) \
1339 int retval = parse##funcname(str, &n); \
1340 if (ERROR_OK != retval) \
1343 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1345 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1350 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1351 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1352 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1353 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1354 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1355 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1357 #define DEFINE_PARSE_LONG(name, type, min, max) \
1358 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1359 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1360 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1361 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1362 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1364 static int command_parse_bool(const char *in
, bool *out
,
1365 const char *on
, const char *off
)
1367 if (strcasecmp(in
, on
) == 0)
1369 else if (strcasecmp(in
, off
) == 0)
1372 return ERROR_COMMAND_SYNTAX_ERROR
;
1376 int command_parse_bool_arg(const char *in
, bool *out
)
1378 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1380 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1382 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1384 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1386 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1388 return ERROR_INVALID_ARGUMENTS
;
1391 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1395 const char *in
= CMD_ARGV
[0];
1396 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1398 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1399 return ERROR_INVALID_ARGUMENTS
;
1404 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1407 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)