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 register_command_handler(struct command
*c
)
301 int retval
= -ENOMEM
;
302 const char *full_name
= command_name(c
, '_');
303 if (NULL
== full_name
)
306 if (NULL
!= c
->handler
)
308 const char *ocd_name
= alloc_printf("ocd_%s", full_name
);
309 if (NULL
== full_name
)
312 Jim_CreateCommand(interp
, ocd_name
, script_command
, c
, NULL
);
313 free((void *)ocd_name
);
316 /* we now need to add an overrideable proc */
317 const char *override_name
= alloc_printf(
318 "proc %s {args} {eval ocd_bouncer %s $args}",
319 full_name
, full_name
);
320 if (NULL
== override_name
)
323 Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
324 free((void *)override_name
);
329 free((void *)full_name
);
333 struct command
* register_command(struct command_context
*context
,
334 struct command
*parent
, const struct command_registration
*cr
)
336 if (!context
|| !cr
->name
)
339 const char *name
= cr
->name
;
340 struct command
**head
= command_list_for_parent(context
, parent
);
341 struct command
*c
= command_find(*head
, name
);
344 LOG_ERROR("command '%s' is already registered in '%s' context",
345 name
, parent
? parent
->name
: "<global>");
349 c
= command_new(context
, parent
, cr
);
353 if (NULL
!= c
->handler
)
355 int retval
= register_command_handler(command_root(c
));
356 if (ERROR_OK
!= retval
)
358 unregister_command(context
, parent
, name
);
363 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
364 Jim_CreateCommand(interp
, cr
->name
, cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
369 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
370 const struct command_registration
*cmds
)
372 int retval
= ERROR_OK
;
374 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
376 const struct command_registration
*cr
= cmds
+ i
;
378 struct command
*c
= NULL
;
379 if (NULL
!= cr
->name
)
381 c
= register_command(cmd_ctx
, parent
, cr
);
388 if (NULL
!= cr
->chain
)
390 struct command
*p
= c
? : parent
;
391 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
392 if (ERROR_OK
!= retval
)
396 if (ERROR_OK
!= retval
)
398 for (unsigned j
= 0; j
< i
; j
++)
399 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
404 int unregister_all_commands(struct command_context
*context
,
405 struct command
*parent
)
410 struct command
**head
= command_list_for_parent(context
, parent
);
411 while (NULL
!= *head
)
413 struct command
*tmp
= *head
;
421 int unregister_command(struct command_context
*context
,
422 struct command
*parent
, const char *name
)
424 if ((!context
) || (!name
))
425 return ERROR_INVALID_ARGUMENTS
;
427 struct command
*p
= NULL
;
428 struct command
**head
= command_list_for_parent(context
, parent
);
429 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
431 if (strcmp(name
, c
->name
) != 0)
446 void command_output_text(struct command_context
*context
, const char *data
)
448 if (context
&& context
->output_handler
&& data
) {
449 context
->output_handler(context
, data
);
453 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
458 va_start(ap
, format
);
460 string
= alloc_vprintf(format
, ap
);
463 /* we want this collected in the log + we also want to pick it up as a tcl return
466 * The latter bit isn't precisely neat, but will do for now.
468 LOG_USER_N("%s", string
);
469 /* We already printed it above */
470 /* command_output_text(context, string); */
477 void command_print(struct command_context
*context
, const char *format
, ...)
482 va_start(ap
, format
);
484 string
= alloc_vprintf(format
, ap
);
487 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
488 /* we want this collected in the log + we also want to pick it up as a tcl return
491 * The latter bit isn't precisely neat, but will do for now.
493 LOG_USER_N("%s", string
);
494 /* We already printed it above */
495 /* command_output_text(context, string); */
502 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
505 unsigned len
= strlen(c
->name
);
506 if (NULL
== c
->parent
) {
507 // allocate enough for the name, child names, and '\0'
508 name
= malloc(len
+ extra
+ 1);
509 strcpy(name
, c
->name
);
511 // parent's extra must include both the space and name
512 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
513 char dstr
[2] = { delim
, 0 };
515 strcat(name
, c
->name
);
519 char *command_name(struct command
*c
, char delim
)
521 return __command_name(c
, delim
, 0);
524 static int run_command(struct command_context
*context
,
525 struct command
*c
, const char *words
[], unsigned num_words
)
527 if (!((context
->mode
== COMMAND_CONFIG
) || (c
->mode
== COMMAND_ANY
) || (c
->mode
== context
->mode
)))
529 /* Config commands can not run after the config stage */
530 LOG_ERROR("Command '%s' only runs during configuration stage", c
->name
);
534 struct command_invocation cmd
= {
537 .argc
= num_words
- 1,
540 int retval
= c
->handler(&cmd
);
541 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
543 /* Print help for command */
544 char *full_name
= command_name(c
, ' ');
545 if (NULL
!= full_name
) {
546 command_run_linef(context
, "help %s", full_name
);
551 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
553 /* just fall through for a shutdown request */
555 else if (retval
!= ERROR_OK
)
557 /* we do not print out an error message because the command *should*
558 * have printed out an error
560 LOG_DEBUG("Command failed with error code %d", retval
);
566 int command_run_line(struct command_context
*context
, char *line
)
568 /* all the parent commands have been registered with the interpreter
569 * so, can just evaluate the line as a script and check for
572 /* run the line thru a script engine */
573 int retval
= ERROR_FAIL
;
575 /* Beware! This code needs to be reentrant. It is also possible
576 * for OpenOCD commands to be invoked directly from Tcl. This would
577 * happen when the Jim Tcl interpreter is provided by eCos for
580 Jim_DeleteAssocData(interp
, "context");
581 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
582 if (retcode
== JIM_OK
)
584 /* associated the return value */
585 Jim_DeleteAssocData(interp
, "retval");
586 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
587 if (retcode
== JIM_OK
)
589 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
591 Jim_DeleteAssocData(interp
, "retval");
593 Jim_DeleteAssocData(interp
, "context");
595 if (retcode
== JIM_ERR
) {
596 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
598 /* We do not print the connection closed error message */
599 Jim_PrintErrorMessage(interp
);
601 if (retval
== ERROR_OK
)
603 /* It wasn't a low level OpenOCD command that failed */
607 } else if (retcode
== JIM_EXIT
) {
609 /* exit(Jim_GetExitCode(interp)); */
614 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
619 for (i
= 0; i
< reslen
; i
+= 256)
625 strncpy(buff
, result
+ i
, chunk
);
627 LOG_USER_N("%s", buff
);
629 LOG_USER_N("%s", "\n");
636 int command_run_linef(struct command_context
*context
, const char *format
, ...)
638 int retval
= ERROR_FAIL
;
641 va_start(ap
, format
);
642 string
= alloc_vprintf(format
, ap
);
645 retval
= command_run_line(context
, string
);
651 void command_set_output_handler(struct command_context
* context
,
652 command_output_handler_t output_handler
, void *priv
)
654 context
->output_handler
= output_handler
;
655 context
->output_handler_priv
= priv
;
658 struct command_context
* copy_command_context(struct command_context
* context
)
660 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
662 *copy_context
= *context
;
667 int command_done(struct command_context
*context
)
675 /* find full path to file */
676 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
680 const char *file
= Jim_GetString(argv
[1], NULL
);
681 char *full_path
= find_file(file
);
682 if (full_path
== NULL
)
684 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
687 Jim_SetResult(interp
, result
);
691 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
695 const char *str
= Jim_GetString(argv
[1], NULL
);
700 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
706 /* make it a char easier to read code */
710 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
714 /* do we have to chunk it? */
715 if (ptr
[nbytes
] == 0)
717 /* no it is a C style string */
718 LOG_USER_N("%s", ptr
);
721 /* GRR we must chunk - not null terminated */
731 memcpy(chunk
, ptr
, x
);
735 LOG_USER_N("%s", chunk
);
743 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
745 /* TCL wants to read... tell him no */
749 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
760 cp
= alloc_vprintf(fmt
, ap
);
763 LOG_USER_N("%s", cp
);
770 static int openocd_jim_fflush(void *cookie
)
772 /* nothing to flush */
776 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
783 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
788 Jim_Obj
*tclOutput
= command_log_capture_start(interp
);
790 const char *str
= Jim_GetString(argv
[1], NULL
);
791 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
793 command_log_capture_finish(interp
, tclOutput
);
798 static COMMAND_HELPER(command_help_find
, struct command
*head
,
799 struct command
**out
)
802 return ERROR_INVALID_ARGUMENTS
;
803 *out
= command_find(head
, CMD_ARGV
[0]);
804 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
805 *out
= command_find(head
, CMD_ARGV
[0] + 4);
807 return ERROR_INVALID_ARGUMENTS
;
811 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
814 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
817 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
820 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
821 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
825 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
827 static void command_help_show_indent(unsigned n
)
829 for (unsigned i
= 0; i
< n
; i
++)
832 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
834 const char *cp
= str
, *last
= str
;
837 const char *next
= last
;
842 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
843 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
844 if (next
- last
< HELP_LINE_WIDTH(n
))
846 command_help_show_indent(n
);
847 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
853 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
856 command_help_show_indent(n
);
857 LOG_USER_N("%s", command_name(c
, ' '));
860 command_help_show_wrap(c
->usage
, 0, n
+ 5);
864 if (show_help
&& c
->help
)
865 command_help_show_wrap(c
->help
, n
+ 3, n
+ 3);
869 return CALL_COMMAND_HANDLER(command_help_show_list
,
870 c
->children
, n
, show_help
);
872 COMMAND_HANDLER(handle_help_command
)
874 bool full
= strcmp(CMD_NAME
, "help") == 0;
876 struct command
*c
= CMD_CTX
->commands
;
879 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, full
);
881 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
882 if (ERROR_OK
!= retval
)
885 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, full
);
888 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
889 struct command
*head
, struct command
**out
, bool top_level
)
893 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
894 struct command
*c
= command_find(head
, cmd_name
);
895 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
896 c
= command_find(head
, cmd_name
+ 4);
900 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
903 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
905 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
906 script_debug(interp
, cmd_name
, argc
- 1, argv
+ 1);
908 struct command_context
*cmd_ctx
= current_command_context();
909 struct command
*c
= cmd_ctx
->commands
;
910 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
911 // if nothing could be consumed, then it's really an unknown command
912 if (remaining
== argc
- 1)
914 const char *cmd
= Jim_GetString(argv
[1], NULL
);
915 LOG_ERROR("Unknown command:\n %s", cmd
);
920 Jim_Obj
*const *start
;
922 if (c
->handler
|| c
->jim_handler
)
924 // include the command name in the list
925 count
= remaining
+ 1;
926 start
= argv
+ (argc
- remaining
- 1);
930 c
= command_find(cmd_ctx
->commands
, "help");
933 LOG_ERROR("unknown command, but help is missing too");
936 count
= argc
- remaining
;
940 // pass the command through to the intended handler
943 interp
->cmdPrivData
= c
->jim_handler_data
;
944 return (*c
->jim_handler
)(interp
, count
, start
);
947 return script_command_run(interp
, count
, start
, c
, found
);
950 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
955 struct command_context
*cmd_ctx
= current_command_context();
956 struct command
*c
= cmd_ctx
->commands
;
957 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
958 // if nothing could be consumed, then it's an unknown command
959 if (remaining
== argc
- 1)
961 Jim_SetResultString(interp
, "unknown", -1);
966 Jim_SetResultString(interp
, "native", -1);
968 Jim_SetResultString(interp
, "simple", -1);
970 Jim_SetResultString(interp
, "group", -1);
975 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
976 const char *cmd_name
, const char *help_text
, const char *usage
)
978 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
979 struct command
*nc
= command_find(*head
, cmd_name
);
982 // add a new command with help text
983 struct command_registration cr
= {
989 nc
= register_command(cmd_ctx
, parent
, &cr
);
992 LOG_ERROR("failed to add '%s' help text", cmd_name
);
995 LOG_DEBUG("added '%s' help text", cmd_name
);
1000 bool replaced
= false;
1003 free((void *)nc
->help
);
1006 nc
->help
= strdup(help_text
);
1008 LOG_INFO("replaced existing '%s' help", cmd_name
);
1010 LOG_DEBUG("added '%s' help text", cmd_name
);
1014 bool replaced
= false;
1017 free((void *)nc
->usage
);
1020 nc
->usage
= strdup(usage
);
1022 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1024 LOG_DEBUG("added '%s' usage text", cmd_name
);
1029 COMMAND_HANDLER(handle_help_add_command
)
1033 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1034 return ERROR_INVALID_ARGUMENTS
;
1037 // save help text and remove it from argument list
1038 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1039 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1040 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1041 if (!help
&& !usage
)
1043 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1044 return ERROR_INVALID_ARGUMENTS
;
1046 // likewise for the leaf command name
1047 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1049 struct command
*c
= NULL
;
1052 c
= CMD_CTX
->commands
;
1053 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1054 if (ERROR_OK
!= retval
)
1057 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1060 /* sleep command sleeps for <n> miliseconds
1061 * this is useful in target startup scripts
1063 COMMAND_HANDLER(handle_sleep_command
)
1068 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1071 return ERROR_COMMAND_SYNTAX_ERROR
;
1073 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1074 return ERROR_COMMAND_SYNTAX_ERROR
;
1076 unsigned long duration
= 0;
1077 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1078 if (ERROR_OK
!= retval
)
1083 long long then
= timeval_ms();
1084 while (timeval_ms() - then
< (long long)duration
)
1086 target_call_timer_callbacks_now();
1091 busy_sleep(duration
);
1096 static const struct command_registration command_subcommand_handlers
[] = {
1099 .mode
= COMMAND_ANY
,
1100 .jim_handler
= &jim_command_type
,
1101 .usage
= "<name> ...",
1102 .help
= "Returns the type of built-in command:"
1103 "'native', 'simple', 'group', or 'unknown'",
1105 COMMAND_REGISTRATION_DONE
1108 static const struct command_registration command_builtin_handlers
[] = {
1110 .name
= "add_help_text",
1111 .handler
= &handle_help_add_command
,
1112 .mode
= COMMAND_ANY
,
1113 .help
= "add new command help text",
1114 .usage
= "<command> [...] <help_text>]",
1117 .name
= "add_usage_text",
1118 .handler
= &handle_help_add_command
,
1119 .mode
= COMMAND_ANY
,
1120 .help
= "add new command usage text",
1121 .usage
= "<command> [...] <usage_text>]",
1125 .handler
= &handle_sleep_command
,
1126 .mode
= COMMAND_ANY
,
1127 .help
= "sleep for n milliseconds. "
1128 "\"busy\" will busy wait",
1129 .usage
= "<n> [busy]",
1133 .handler
= &handle_help_command
,
1134 .mode
= COMMAND_ANY
,
1135 .help
= "show full command help",
1136 .usage
= "[<command> ...]",
1140 .handler
= &handle_help_command
,
1141 .mode
= COMMAND_ANY
,
1142 .help
= "show basic command usage",
1143 .usage
= "[<command> ...]",
1148 .help
= "core command group (introspection)",
1149 .chain
= command_subcommand_handlers
,
1151 COMMAND_REGISTRATION_DONE
1154 struct command_context
* command_init(const char *startup_tcl
)
1156 struct command_context
* context
= malloc(sizeof(struct command_context
));
1159 context
->mode
= COMMAND_EXEC
;
1160 context
->commands
= NULL
;
1161 context
->current_target
= 0;
1162 context
->output_handler
= NULL
;
1163 context
->output_handler_priv
= NULL
;
1165 #if !BUILD_ECOSBOARD
1167 /* Create an interpreter */
1168 interp
= Jim_CreateInterp();
1169 /* Add all the Jim core commands */
1170 Jim_RegisterCoreCommands(interp
);
1173 #if defined(_MSC_VER)
1174 /* WinXX - is generic, the forward
1175 * looking problem is this:
1177 * "win32" or "win64"
1179 * "winxx" is generic.
1182 #elif defined(__linux__)
1184 #elif defined(__DARWIN__)
1186 #elif defined(__CYGWIN__)
1188 #elif defined(__MINGW32__)
1190 #elif defined(__ECOS)
1193 #warn unrecognized host OS...
1196 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1197 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1199 Jim_CreateCommand(interp
, "unknown", &command_unknown
, NULL
, NULL
);
1200 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1201 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1202 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1204 /* Set Jim's STDIO */
1205 interp
->cookie_stdin
= interp
;
1206 interp
->cookie_stdout
= interp
;
1207 interp
->cookie_stderr
= interp
;
1208 interp
->cb_fwrite
= openocd_jim_fwrite
;
1209 interp
->cb_fread
= openocd_jim_fread
;
1210 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1211 interp
->cb_fflush
= openocd_jim_fflush
;
1212 interp
->cb_fgets
= openocd_jim_fgets
;
1214 register_commands(context
, NULL
, command_builtin_handlers
);
1216 #if !BUILD_ECOSBOARD
1217 Jim_EventLoopOnLoad(interp
);
1219 Jim_SetAssocData(interp
, "context", NULL
, context
);
1220 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1222 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1223 Jim_PrintErrorMessage(interp
);
1226 Jim_DeleteAssocData(interp
, "context");
1231 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1234 return ERROR_INVALID_ARGUMENTS
;
1236 cmd_ctx
->mode
= mode
;
1240 void process_jim_events(void)
1242 #if !BUILD_ECOSBOARD
1243 static int recursion
= 0;
1248 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1254 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1255 int parse##name(const char *str, type *ul) \
1259 LOG_ERROR("Invalid command argument"); \
1260 return ERROR_COMMAND_ARGUMENT_INVALID; \
1263 *ul = func(str, &end, 0); \
1266 LOG_ERROR("Invalid command argument"); \
1267 return ERROR_COMMAND_ARGUMENT_INVALID; \
1269 if ((max == *ul) && (ERANGE == errno)) \
1271 LOG_ERROR("Argument overflow"); \
1272 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1274 if (min && (min == *ul) && (ERANGE == errno)) \
1276 LOG_ERROR("Argument underflow"); \
1277 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1281 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1282 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1283 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1284 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1286 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1287 int parse##name(const char *str, type *ul) \
1290 int retval = parse##funcname(str, &n); \
1291 if (ERROR_OK != retval) \
1294 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1296 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1301 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1302 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1303 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1304 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1305 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1306 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1308 #define DEFINE_PARSE_LONG(name, type, min, max) \
1309 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1310 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1311 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1312 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1313 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1315 static int command_parse_bool(const char *in
, bool *out
,
1316 const char *on
, const char *off
)
1318 if (strcasecmp(in
, on
) == 0)
1320 else if (strcasecmp(in
, off
) == 0)
1323 return ERROR_COMMAND_SYNTAX_ERROR
;
1327 int command_parse_bool_arg(const char *in
, bool *out
)
1329 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1331 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1333 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1335 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1337 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1339 return ERROR_INVALID_ARGUMENTS
;
1342 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1346 const char *in
= CMD_ARGV
[0];
1347 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1349 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1350 return ERROR_INVALID_ARGUMENTS
;
1355 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1358 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)