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 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 static void command_log_capture_finish(struct log_capture_state
*state
)
93 log_remove_callback(tcl_output
, state
);
95 Jim_SetResult(state
->interp
, state
->output
);
96 Jim_DecrRefCount(state
->interp
, state
->output
);
101 static int command_retval_set(Jim_Interp
*interp
, int retval
)
103 int *return_retval
= Jim_GetAssocData(interp
, "retval");
104 if (return_retval
!= NULL
)
105 *return_retval
= retval
;
107 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
110 extern struct command_context
*global_cmd_ctx
;
112 void script_debug(Jim_Interp
*interp
, const char *name
,
113 unsigned argc
, Jim_Obj
*const *argv
)
115 LOG_DEBUG("command - %s", name
);
116 for (unsigned i
= 0; i
< argc
; i
++)
119 const char *w
= Jim_GetString(argv
[i
], &len
);
121 /* end of line comment? */
125 LOG_DEBUG("%s - argv[%d]=%s", name
, i
, w
);
129 static void script_command_args_free(const char **words
, unsigned nwords
)
131 for (unsigned i
= 0; i
< nwords
; i
++)
132 free((void *)words
[i
]);
135 static const char **script_command_args_alloc(
136 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
138 const char **words
= malloc(argc
* sizeof(char *));
143 for (i
= 0; i
< argc
; i
++)
146 const char *w
= Jim_GetString(argv
[i
], &len
);
147 /* a comment may end the line early */
151 words
[i
] = strdup(w
);
152 if (words
[i
] == NULL
)
154 script_command_args_free(words
, i
);
162 static struct command_context
*current_command_context(void)
164 /* grab the command context from the associated data */
165 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
168 /* Tcl can invoke commands directly instead of via command_run_line(). This would
169 * happen when the Jim Tcl interpreter is provided by eCos.
171 cmd_ctx
= global_cmd_ctx
;
176 static int script_command_run(Jim_Interp
*interp
,
177 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
179 target_call_timer_callbacks_now();
180 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
183 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
187 struct log_capture_state
*state
= NULL
;
189 state
= command_log_capture_start(interp
);
191 struct command_context
*cmd_ctx
= current_command_context();
192 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
194 command_log_capture_finish(state
);
196 script_command_args_free(words
, nwords
);
197 return command_retval_set(interp
, retval
);
200 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
202 /* the private data is stashed in the interp structure */
204 struct command
*c
= interp
->cmdPrivData
;
206 script_debug(interp
, c
->name
, argc
, argv
);
207 return script_command_run(interp
, argc
, argv
, c
, true);
210 static struct command
*command_root(struct command
*c
)
212 while (NULL
!= c
->parent
)
218 * Find a command by name from a list of commands.
219 * @returns Returns the named command if it exists in the list.
220 * Returns NULL otherwise.
222 static struct command
*command_find(struct command
*head
, const char *name
)
224 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
226 if (strcmp(cc
->name
, name
) == 0)
231 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
234 return command_find(cmd_ctx
->commands
, name
);
236 struct command
*command_find_in_parent(struct command
*parent
,
239 return command_find(parent
->children
, name
);
243 * Add the command into the linked list, sorted by name.
244 * @param head Address to head of command list pointer, which may be
245 * updated if @c c gets inserted at the beginning of the list.
246 * @param c The command to add to the list pointed to by @c head.
248 static void command_add_child(struct command
**head
, struct command
*c
)
257 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
258 head
= &(*head
)->next
;
260 if (strcmp(c
->name
, (*head
)->name
) > 0) {
261 c
->next
= (*head
)->next
;
269 static struct command
**command_list_for_parent(
270 struct command_context
*cmd_ctx
, struct command
*parent
)
272 return parent
? &parent
->children
: &cmd_ctx
->commands
;
275 static void command_free(struct command
*c
)
277 /// @todo if command has a handler, unregister its jim command!
279 while (NULL
!= c
->children
)
281 struct command
*tmp
= c
->children
;
282 c
->children
= tmp
->next
;
289 free((void*)c
->help
);
291 free((void*)c
->usage
);
295 static struct command
*command_new(struct command_context
*cmd_ctx
,
296 struct command
*parent
, const struct command_registration
*cr
)
300 struct command
*c
= calloc(1, sizeof(struct command
));
304 c
->name
= strdup(cr
->name
);
306 c
->help
= strdup(cr
->help
);
308 c
->usage
= strdup(cr
->usage
);
310 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
311 goto command_new_error
;
314 c
->handler
= cr
->handler
;
315 c
->jim_handler
= cr
->jim_handler
;
316 c
->jim_handler_data
= cr
->jim_handler_data
;
319 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
328 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
330 static int register_command_handler(struct command
*c
)
332 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
333 if (NULL
== ocd_name
)
336 LOG_DEBUG("registering '%s'...", ocd_name
);
338 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
339 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
340 free((void *)ocd_name
);
341 if (JIM_OK
!= retval
)
344 /* we now need to add an overrideable proc */
345 const char *override_name
= alloc_printf(
346 "proc %s {args} {eval ocd_bouncer %s $args}",
348 if (NULL
== override_name
)
351 retval
= Jim_Eval_Named(interp
, override_name
, __FILE__
, __LINE__
);
352 free((void *)override_name
);
357 struct command
* register_command(struct command_context
*context
,
358 struct command
*parent
, const struct command_registration
*cr
)
360 if (!context
|| !cr
->name
)
363 const char *name
= cr
->name
;
364 struct command
**head
= command_list_for_parent(context
, parent
);
365 struct command
*c
= command_find(*head
, name
);
368 LOG_ERROR("command '%s' is already registered in '%s' context",
369 name
, parent
? parent
->name
: "<global>");
373 c
= command_new(context
, parent
, cr
);
377 int retval
= ERROR_OK
;
378 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
380 retval
= Jim_CreateCommand(interp
, cr
->name
,
381 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
383 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
384 retval
= register_command_handler(command_root(c
));
386 if (ERROR_OK
!= retval
)
388 unregister_command(context
, parent
, name
);
394 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
395 const struct command_registration
*cmds
)
397 int retval
= ERROR_OK
;
399 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
401 const struct command_registration
*cr
= cmds
+ i
;
403 struct command
*c
= NULL
;
404 if (NULL
!= cr
->name
)
406 c
= register_command(cmd_ctx
, parent
, cr
);
413 if (NULL
!= cr
->chain
)
415 struct command
*p
= c
? : parent
;
416 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
417 if (ERROR_OK
!= retval
)
421 if (ERROR_OK
!= retval
)
423 for (unsigned j
= 0; j
< i
; j
++)
424 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
429 int unregister_all_commands(struct command_context
*context
,
430 struct command
*parent
)
435 struct command
**head
= command_list_for_parent(context
, parent
);
436 while (NULL
!= *head
)
438 struct command
*tmp
= *head
;
446 int unregister_command(struct command_context
*context
,
447 struct command
*parent
, const char *name
)
449 if ((!context
) || (!name
))
450 return ERROR_INVALID_ARGUMENTS
;
452 struct command
*p
= NULL
;
453 struct command
**head
= command_list_for_parent(context
, parent
);
454 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
456 if (strcmp(name
, c
->name
) != 0)
471 void command_set_handler_data(struct command
*c
, void *p
)
473 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
474 c
->jim_handler_data
= p
;
475 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
476 command_set_handler_data(cc
, p
);
479 void command_output_text(struct command_context
*context
, const char *data
)
481 if (context
&& context
->output_handler
&& data
) {
482 context
->output_handler(context
, data
);
486 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
491 va_start(ap
, format
);
493 string
= alloc_vprintf(format
, ap
);
496 /* we want this collected in the log + we also want to pick it up as a tcl return
499 * The latter bit isn't precisely neat, but will do for now.
501 LOG_USER_N("%s", string
);
502 /* We already printed it above */
503 /* command_output_text(context, string); */
510 void command_print(struct command_context
*context
, const char *format
, ...)
515 va_start(ap
, format
);
517 string
= alloc_vprintf(format
, ap
);
520 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
521 /* we want this collected in the log + we also want to pick it up as a tcl return
524 * The latter bit isn't precisely neat, but will do for now.
526 LOG_USER_N("%s", string
);
527 /* We already printed it above */
528 /* command_output_text(context, string); */
535 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
538 unsigned len
= strlen(c
->name
);
539 if (NULL
== c
->parent
) {
540 // allocate enough for the name, child names, and '\0'
541 name
= malloc(len
+ extra
+ 1);
542 strcpy(name
, c
->name
);
544 // parent's extra must include both the space and name
545 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
546 char dstr
[2] = { delim
, 0 };
548 strcat(name
, c
->name
);
552 char *command_name(struct command
*c
, char delim
)
554 return __command_name(c
, delim
, 0);
557 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
559 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
562 static int run_command(struct command_context
*context
,
563 struct command
*c
, const char *words
[], unsigned num_words
)
565 if (!command_can_run(context
, c
))
567 /* Config commands can not run after the config stage */
568 LOG_ERROR("The '%s' command must be used before 'init'.", c
->name
);
572 struct command_invocation cmd
= {
575 .argc
= num_words
- 1,
578 int retval
= c
->handler(&cmd
);
579 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
581 /* Print help for command */
582 char *full_name
= command_name(c
, ' ');
583 if (NULL
!= full_name
) {
584 command_run_linef(context
, "usage %s", full_name
);
589 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
591 /* just fall through for a shutdown request */
593 else if (retval
!= ERROR_OK
)
595 /* we do not print out an error message because the command *should*
596 * have printed out an error
598 LOG_DEBUG("Command failed with error code %d", retval
);
604 int command_run_line(struct command_context
*context
, char *line
)
606 /* all the parent commands have been registered with the interpreter
607 * so, can just evaluate the line as a script and check for
610 /* run the line thru a script engine */
611 int retval
= ERROR_FAIL
;
613 /* Beware! This code needs to be reentrant. It is also possible
614 * for OpenOCD commands to be invoked directly from Tcl. This would
615 * happen when the Jim Tcl interpreter is provided by eCos for
618 Jim_DeleteAssocData(interp
, "context");
619 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
620 if (retcode
== JIM_OK
)
622 /* associated the return value */
623 Jim_DeleteAssocData(interp
, "retval");
624 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
625 if (retcode
== JIM_OK
)
627 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
629 Jim_DeleteAssocData(interp
, "retval");
631 Jim_DeleteAssocData(interp
, "context");
633 if (retcode
== JIM_ERR
) {
634 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
636 /* We do not print the connection closed error message */
637 Jim_PrintErrorMessage(interp
);
639 if (retval
== ERROR_OK
)
641 /* It wasn't a low level OpenOCD command that failed */
645 } else if (retcode
== JIM_EXIT
) {
647 /* exit(Jim_GetExitCode(interp)); */
652 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
657 for (i
= 0; i
< reslen
; i
+= 256)
663 strncpy(buff
, result
+ i
, chunk
);
665 LOG_USER_N("%s", buff
);
667 LOG_USER_N("%s", "\n");
674 int command_run_linef(struct command_context
*context
, const char *format
, ...)
676 int retval
= ERROR_FAIL
;
679 va_start(ap
, format
);
680 string
= alloc_vprintf(format
, ap
);
683 retval
= command_run_line(context
, string
);
689 void command_set_output_handler(struct command_context
* context
,
690 command_output_handler_t output_handler
, void *priv
)
692 context
->output_handler
= output_handler
;
693 context
->output_handler_priv
= priv
;
696 struct command_context
* copy_command_context(struct command_context
* context
)
698 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
700 *copy_context
= *context
;
705 void command_done(struct command_context
*cmd_ctx
)
713 /* find full path to file */
714 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
718 const char *file
= Jim_GetString(argv
[1], NULL
);
719 char *full_path
= find_file(file
);
720 if (full_path
== NULL
)
722 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
725 Jim_SetResult(interp
, result
);
729 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
733 const char *str
= Jim_GetString(argv
[1], NULL
);
738 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
744 /* make it a char easier to read code */
748 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
752 /* do we have to chunk it? */
753 if (ptr
[nbytes
] == 0)
755 /* no it is a C style string */
756 LOG_USER_N("%s", ptr
);
759 /* GRR we must chunk - not null terminated */
769 memcpy(chunk
, ptr
, x
);
773 LOG_USER_N("%s", chunk
);
781 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
783 /* TCL wants to read... tell him no */
787 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
798 cp
= alloc_vprintf(fmt
, ap
);
801 LOG_USER_N("%s", cp
);
808 static int openocd_jim_fflush(void *cookie
)
810 /* nothing to flush */
814 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
821 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
826 struct log_capture_state
*state
= command_log_capture_start(interp
);
828 const char *str
= Jim_GetString(argv
[1], NULL
);
829 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
831 command_log_capture_finish(state
);
836 static COMMAND_HELPER(command_help_find
, struct command
*head
,
837 struct command
**out
)
840 return ERROR_INVALID_ARGUMENTS
;
841 *out
= command_find(head
, CMD_ARGV
[0]);
842 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
843 *out
= command_find(head
, CMD_ARGV
[0] + 4);
845 return ERROR_INVALID_ARGUMENTS
;
849 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
852 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
855 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
858 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
859 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
863 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
865 static void command_help_show_indent(unsigned n
)
867 for (unsigned i
= 0; i
< n
; i
++)
870 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
872 const char *cp
= str
, *last
= str
;
875 const char *next
= last
;
880 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
881 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
882 if (next
- last
< HELP_LINE_WIDTH(n
))
884 command_help_show_indent(n
);
885 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
891 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
894 if (!command_can_run(CMD_CTX
, c
))
897 char *cmd_name
= command_name(c
, ' ');
898 if (NULL
== cmd_name
)
901 command_help_show_indent(n
);
902 LOG_USER_N("%s", cmd_name
);
907 command_help_show_wrap(c
->usage
, 0, n
+ 5);
914 const char *stage_msg
;
916 case COMMAND_CONFIG
: stage_msg
= "CONFIG"; break;
917 case COMMAND_EXEC
: stage_msg
= "EXEC"; break;
918 case COMMAND_ANY
: stage_msg
= "CONFIG or EXEC"; break;
919 default: stage_msg
= "***UNKNOWN***"; break;
921 char *msg
= alloc_printf("%s%sValid Modes: %s",
922 c
->help
? : "", c
->help
? " " : "", stage_msg
);
925 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
934 return CALL_COMMAND_HANDLER(command_help_show_list
,
935 c
->children
, n
, show_help
);
937 COMMAND_HANDLER(handle_help_command
)
939 bool full
= strcmp(CMD_NAME
, "help") == 0;
941 struct command
*c
= CMD_CTX
->commands
;
944 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, full
);
946 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
947 if (ERROR_OK
!= retval
)
950 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, full
);
953 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
954 struct command
*head
, struct command
**out
, bool top_level
)
958 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
959 struct command
*c
= command_find(head
, cmd_name
);
960 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
961 c
= command_find(head
, cmd_name
+ 4);
965 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
968 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
970 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
971 if (strcmp(cmd_name
, "unknown") == 0)
978 script_debug(interp
, cmd_name
, argc
, argv
);
980 struct command_context
*cmd_ctx
= current_command_context();
981 struct command
*c
= cmd_ctx
->commands
;
982 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
983 // if nothing could be consumed, then it's really an unknown command
984 if (remaining
== argc
)
986 const char *cmd
= Jim_GetString(argv
[0], NULL
);
987 LOG_ERROR("Unknown command:\n %s", cmd
);
992 Jim_Obj
*const *start
;
994 if (c
->handler
|| c
->jim_handler
)
996 // include the command name in the list
997 count
= remaining
+ 1;
998 start
= argv
+ (argc
- remaining
- 1);
1002 c
= command_find(cmd_ctx
->commands
, "usage");
1005 LOG_ERROR("unknown command, but usage is missing too");
1008 count
= argc
- remaining
;
1012 // pass the command through to the intended handler
1015 interp
->cmdPrivData
= c
->jim_handler_data
;
1016 return (*c
->jim_handler
)(interp
, count
, start
);
1019 return script_command_run(interp
, count
, start
, c
, found
);
1022 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1024 struct command_context
*cmd_ctx
= current_command_context();
1025 enum command_mode mode
;
1028 struct command
*c
= cmd_ctx
->commands
;
1029 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1030 // if nothing could be consumed, then it's an unknown command
1031 if (remaining
== argc
- 1)
1033 Jim_SetResultString(interp
, "unknown", -1);
1039 mode
= cmd_ctx
->mode
;
1041 const char *mode_str
;
1043 case COMMAND_ANY
: mode_str
= "any"; break;
1044 case COMMAND_CONFIG
: mode_str
= "config"; break;
1045 case COMMAND_EXEC
: mode_str
= "exec"; break;
1046 default: mode_str
= "unknown"; break;
1048 Jim_SetResultString(interp
, mode_str
, -1);
1052 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1057 struct command_context
*cmd_ctx
= current_command_context();
1058 struct command
*c
= cmd_ctx
->commands
;
1059 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1060 // if nothing could be consumed, then it's an unknown command
1061 if (remaining
== argc
- 1)
1063 Jim_SetResultString(interp
, "unknown", -1);
1068 Jim_SetResultString(interp
, "native", -1);
1069 else if (c
->handler
)
1070 Jim_SetResultString(interp
, "simple", -1);
1072 Jim_SetResultString(interp
, "group", -1);
1077 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1078 const char *cmd_name
, const char *help_text
, const char *usage
)
1080 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1081 struct command
*nc
= command_find(*head
, cmd_name
);
1084 // add a new command with help text
1085 struct command_registration cr
= {
1087 .mode
= COMMAND_ANY
,
1091 nc
= register_command(cmd_ctx
, parent
, &cr
);
1094 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1097 LOG_DEBUG("added '%s' help text", cmd_name
);
1102 bool replaced
= false;
1105 free((void *)nc
->help
);
1108 nc
->help
= strdup(help_text
);
1110 LOG_INFO("replaced existing '%s' help", cmd_name
);
1112 LOG_DEBUG("added '%s' help text", cmd_name
);
1116 bool replaced
= false;
1119 free((void *)nc
->usage
);
1122 nc
->usage
= strdup(usage
);
1124 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1126 LOG_DEBUG("added '%s' usage text", cmd_name
);
1131 COMMAND_HANDLER(handle_help_add_command
)
1135 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1136 return ERROR_INVALID_ARGUMENTS
;
1139 // save help text and remove it from argument list
1140 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1141 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1142 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1143 if (!help
&& !usage
)
1145 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1146 return ERROR_INVALID_ARGUMENTS
;
1148 // likewise for the leaf command name
1149 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1151 struct command
*c
= NULL
;
1154 c
= CMD_CTX
->commands
;
1155 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1156 if (ERROR_OK
!= retval
)
1159 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1162 /* sleep command sleeps for <n> miliseconds
1163 * this is useful in target startup scripts
1165 COMMAND_HANDLER(handle_sleep_command
)
1170 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1173 return ERROR_COMMAND_SYNTAX_ERROR
;
1175 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1176 return ERROR_COMMAND_SYNTAX_ERROR
;
1178 unsigned long duration
= 0;
1179 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1180 if (ERROR_OK
!= retval
)
1185 long long then
= timeval_ms();
1186 while (timeval_ms() - then
< (long long)duration
)
1188 target_call_timer_callbacks_now();
1193 busy_sleep(duration
);
1198 static const struct command_registration command_subcommand_handlers
[] = {
1201 .mode
= COMMAND_ANY
,
1202 .jim_handler
= &jim_command_mode
,
1203 .usage
= "[<name> ...]",
1204 .help
= "Returns the command modes allowed by a command:"
1205 "'any', 'config', or 'exec'. If no command is"
1206 "specified, returns the current command mode.",
1210 .mode
= COMMAND_ANY
,
1211 .jim_handler
= &jim_command_type
,
1212 .usage
= "<name> ...",
1213 .help
= "Returns the type of built-in command:"
1214 "'native', 'simple', 'group', or 'unknown'",
1216 COMMAND_REGISTRATION_DONE
1219 static const struct command_registration command_builtin_handlers
[] = {
1221 .name
= "add_help_text",
1222 .handler
= &handle_help_add_command
,
1223 .mode
= COMMAND_ANY
,
1224 .help
= "add new command help text",
1225 .usage
= "<command> [...] <help_text>]",
1228 .name
= "add_usage_text",
1229 .handler
= &handle_help_add_command
,
1230 .mode
= COMMAND_ANY
,
1231 .help
= "add new command usage text",
1232 .usage
= "<command> [...] <usage_text>]",
1236 .handler
= &handle_sleep_command
,
1237 .mode
= COMMAND_ANY
,
1238 .help
= "sleep for n milliseconds. "
1239 "\"busy\" will busy wait",
1240 .usage
= "<n> [busy]",
1244 .handler
= &handle_help_command
,
1245 .mode
= COMMAND_ANY
,
1246 .help
= "show full command help",
1247 .usage
= "[<command> ...]",
1251 .handler
= &handle_help_command
,
1252 .mode
= COMMAND_ANY
,
1253 .help
= "show basic command usage",
1254 .usage
= "[<command> ...]",
1259 .help
= "core command group (introspection)",
1260 .chain
= command_subcommand_handlers
,
1262 COMMAND_REGISTRATION_DONE
1265 struct command_context
* command_init(const char *startup_tcl
)
1267 struct command_context
* context
= malloc(sizeof(struct command_context
));
1270 context
->mode
= COMMAND_EXEC
;
1271 context
->commands
= NULL
;
1272 context
->current_target
= 0;
1273 context
->output_handler
= NULL
;
1274 context
->output_handler_priv
= NULL
;
1276 #if !BUILD_ECOSBOARD
1278 /* Create an interpreter */
1279 interp
= context
->interp
= Jim_CreateInterp();
1280 /* Add all the Jim core commands */
1281 Jim_RegisterCoreCommands(interp
);
1284 #if defined(_MSC_VER)
1285 /* WinXX - is generic, the forward
1286 * looking problem is this:
1288 * "win32" or "win64"
1290 * "winxx" is generic.
1293 #elif defined(__linux__)
1295 #elif defined(__DARWIN__)
1297 #elif defined(__CYGWIN__)
1299 #elif defined(__MINGW32__)
1301 #elif defined(__ECOS)
1304 #warn unrecognized host OS...
1307 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1308 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1310 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1311 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1312 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1314 /* Set Jim's STDIO */
1315 interp
->cookie_stdin
= interp
;
1316 interp
->cookie_stdout
= interp
;
1317 interp
->cookie_stderr
= interp
;
1318 interp
->cb_fwrite
= openocd_jim_fwrite
;
1319 interp
->cb_fread
= openocd_jim_fread
;
1320 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1321 interp
->cb_fflush
= openocd_jim_fflush
;
1322 interp
->cb_fgets
= openocd_jim_fgets
;
1324 register_commands(context
, NULL
, command_builtin_handlers
);
1326 #if !BUILD_ECOSBOARD
1327 Jim_EventLoopOnLoad(interp
);
1329 Jim_SetAssocData(interp
, "context", NULL
, context
);
1330 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1332 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1333 Jim_PrintErrorMessage(interp
);
1336 Jim_DeleteAssocData(interp
, "context");
1341 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1344 return ERROR_INVALID_ARGUMENTS
;
1346 cmd_ctx
->mode
= mode
;
1350 void process_jim_events(void)
1352 #if !BUILD_ECOSBOARD
1353 static int recursion
= 0;
1358 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1364 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1365 int parse##name(const char *str, type *ul) \
1369 LOG_ERROR("Invalid command argument"); \
1370 return ERROR_COMMAND_ARGUMENT_INVALID; \
1373 *ul = func(str, &end, 0); \
1376 LOG_ERROR("Invalid command argument"); \
1377 return ERROR_COMMAND_ARGUMENT_INVALID; \
1379 if ((max == *ul) && (ERANGE == errno)) \
1381 LOG_ERROR("Argument overflow"); \
1382 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1384 if (min && (min == *ul) && (ERANGE == errno)) \
1386 LOG_ERROR("Argument underflow"); \
1387 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1391 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1392 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1393 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1394 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1396 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1397 int parse##name(const char *str, type *ul) \
1400 int retval = parse##funcname(str, &n); \
1401 if (ERROR_OK != retval) \
1404 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1406 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1411 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1412 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1413 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1414 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1415 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1416 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1418 #define DEFINE_PARSE_LONG(name, type, min, max) \
1419 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1420 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1421 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1422 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1423 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1425 static int command_parse_bool(const char *in
, bool *out
,
1426 const char *on
, const char *off
)
1428 if (strcasecmp(in
, on
) == 0)
1430 else if (strcasecmp(in
, off
) == 0)
1433 return ERROR_COMMAND_SYNTAX_ERROR
;
1437 int command_parse_bool_arg(const char *in
, bool *out
)
1439 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1441 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1443 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1445 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1447 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1449 return ERROR_INVALID_ARGUMENTS
;
1452 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1456 const char *in
= CMD_ARGV
[0];
1457 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1459 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1460 return ERROR_INVALID_ARGUMENTS
;
1465 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1468 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)