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 Jim_Interp
*interp
= NULL
;
49 static int run_command(struct command_context
*context
,
50 struct command
*c
, const char *words
[], unsigned num_words
);
52 static void tcl_output(void *privData
, const char *file
, unsigned line
,
53 const char *function
, const char *string
)
55 Jim_Obj
*tclOutput
= (Jim_Obj
*)privData
;
56 Jim_AppendString(interp
, tclOutput
, string
, strlen(string
));
59 extern struct command_context
*global_cmd_ctx
;
61 void script_debug(Jim_Interp
*interp
, const char *name
,
62 unsigned argc
, Jim_Obj
*const *argv
)
64 LOG_DEBUG("command - %s", name
);
65 for (unsigned i
= 0; i
< argc
; i
++)
68 const char *w
= Jim_GetString(argv
[i
], &len
);
70 /* end of line comment? */
74 LOG_DEBUG("%s - argv[%d]=%s", name
, i
, w
);
78 static void script_command_args_free(const char **words
, unsigned nwords
)
80 for (unsigned i
= 0; i
< nwords
; i
++)
81 free((void *)words
[i
]);
84 static const char **script_command_args_alloc(
85 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
87 const char **words
= malloc(argc
* sizeof(char *));
92 for (i
= 0; i
< argc
; i
++)
95 const char *w
= Jim_GetString(argv
[i
], &len
);
96 /* a comment may end the line early */
100 words
[i
] = strdup(w
);
101 if (words
[i
] == NULL
)
103 script_command_args_free(words
, i
);
111 static struct command_context
*current_command_context(void)
113 /* grab the command context from the associated data */
114 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
117 /* Tcl can invoke commands directly instead of via command_run_line(). This would
118 * happen when the Jim Tcl interpreter is provided by eCos.
120 cmd_ctx
= global_cmd_ctx
;
125 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
127 /* the private data is stashed in the interp structure */
131 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
132 * get overwritten by running other Jim commands! Treat it as an
133 * emphemeral global variable that is used in lieu of an argument
134 * to the fn and fish it out manually.
136 c
= interp
->cmdPrivData
;
139 LOG_ERROR("BUG: interp->cmdPrivData == NULL");
142 target_call_timer_callbacks_now();
143 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
145 script_debug(interp
, c
->name
, argc
, argv
);
148 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
152 /* capture log output and return it */
153 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
154 /* a garbage collect can happen, so we need a reference count to this object */
155 Jim_IncrRefCount(tclOutput
);
157 log_add_callback(tcl_output
, tclOutput
);
159 struct command_context
*cmd_ctx
= current_command_context();
160 retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
162 log_remove_callback(tcl_output
, tclOutput
);
164 /* We dump output into this local variable */
165 Jim_SetResult(interp
, tclOutput
);
166 Jim_DecrRefCount(interp
, tclOutput
);
168 script_command_args_free(words
, nwords
);
170 int *return_retval
= Jim_GetAssocData(interp
, "retval");
171 if (return_retval
!= NULL
)
173 *return_retval
= retval
;
176 return (retval
== ERROR_OK
)?JIM_OK
:JIM_ERR
;
179 /* nice short description of source file */
180 #define __THIS__FILE__ "command.c"
183 * Find a command by name from a list of commands.
184 * @returns Returns the named command if it exists in the list.
185 * Returns NULL otherwise.
187 static struct command
*command_find(struct command
*head
, const char *name
)
189 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
191 if (strcmp(cc
->name
, name
) == 0)
196 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
199 return command_find(cmd_ctx
->commands
, name
);
201 struct command
*command_find_in_parent(struct command
*parent
,
204 return command_find(parent
->children
, name
);
208 * Add the command into the linked list, sorted by name.
209 * @param head Address to head of command list pointer, which may be
210 * updated if @c c gets inserted at the beginning of the list.
211 * @param c The command to add to the list pointed to by @c head.
213 static void command_add_child(struct command
**head
, struct command
*c
)
222 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
223 head
= &(*head
)->next
;
225 if (strcmp(c
->name
, (*head
)->name
) > 0) {
226 c
->next
= (*head
)->next
;
234 static struct command
**command_list_for_parent(
235 struct command_context
*cmd_ctx
, struct command
*parent
)
237 return parent
? &parent
->children
: &cmd_ctx
->commands
;
240 static struct command
*command_new(struct command_context
*cmd_ctx
,
241 struct command
*parent
, const struct command_registration
*cr
)
245 struct command
*c
= malloc(sizeof(struct command
));
246 memset(c
, 0, sizeof(struct command
));
248 c
->name
= strdup(cr
->name
);
250 c
->help
= strdup(cr
->help
);
252 c
->usage
= strdup(cr
->usage
);
254 c
->handler
= cr
->handler
;
255 c
->jim_handler
= cr
->jim_handler
;
256 c
->jim_handler_data
= cr
->jim_handler_data
;
259 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
263 static void command_free(struct command
*c
)
265 /// @todo if command has a handler, unregister its jim command!
267 while (NULL
!= c
->children
)
269 struct command
*tmp
= c
->children
;
270 c
->children
= tmp
->next
;
277 free((void*)c
->help
);
279 free((void*)c
->usage
);
283 static int register_command_handler(struct command
*c
)
285 int retval
= -ENOMEM
;
286 const char *full_name
= command_name(c
, '_');
287 if (NULL
== full_name
)
290 const char *ocd_name
= alloc_printf("ocd_%s", full_name
);
291 if (NULL
== full_name
)
294 Jim_CreateCommand(interp
, ocd_name
, script_command
, c
, NULL
);
295 free((void *)ocd_name
);
297 /* we now need to add an overrideable proc */
298 const char *override_name
= alloc_printf("proc %s {args} {"
299 "if {[catch {eval ocd_%s $args}] == 0} "
300 "{return \"\"} else {return -code error}}",
301 full_name
, full_name
);
302 if (NULL
== full_name
)
305 Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
306 free((void *)override_name
);
311 free((void *)full_name
);
315 struct command
* register_command(struct command_context
*context
,
316 struct command
*parent
, const struct command_registration
*cr
)
318 if (!context
|| !cr
->name
)
321 const char *name
= cr
->name
;
322 struct command
**head
= command_list_for_parent(context
, parent
);
323 struct command
*c
= command_find(*head
, name
);
326 LOG_ERROR("command '%s' is already registered in '%s' context",
327 name
, parent
? parent
->name
: "<global>");
331 c
= command_new(context
, parent
, cr
);
335 if (NULL
!= c
->handler
)
337 int retval
= register_command_handler(c
);
338 if (ERROR_OK
!= retval
)
340 unregister_command(context
, parent
, name
);
345 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
346 Jim_CreateCommand(interp
, cr
->name
, cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
351 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
352 const struct command_registration
*cmds
)
354 int retval
= ERROR_OK
;
356 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
358 const struct command_registration
*cr
= cmds
+ i
;
360 struct command
*c
= NULL
;
361 if (NULL
!= cr
->name
)
363 c
= register_command(cmd_ctx
, parent
, cr
);
370 if (NULL
!= cr
->chain
)
372 struct command
*p
= c
? : parent
;
373 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
374 if (ERROR_OK
!= retval
)
378 if (ERROR_OK
!= retval
)
380 for (unsigned j
= 0; j
< i
; j
++)
381 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
386 int unregister_all_commands(struct command_context
*context
,
387 struct command
*parent
)
392 struct command
**head
= command_list_for_parent(context
, parent
);
393 while (NULL
!= *head
)
395 struct command
*tmp
= *head
;
403 int unregister_command(struct command_context
*context
,
404 struct command
*parent
, const char *name
)
406 if ((!context
) || (!name
))
407 return ERROR_INVALID_ARGUMENTS
;
409 struct command
*p
= NULL
;
410 struct command
**head
= command_list_for_parent(context
, parent
);
411 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
413 if (strcmp(name
, c
->name
) != 0)
428 void command_output_text(struct command_context
*context
, const char *data
)
430 if (context
&& context
->output_handler
&& data
) {
431 context
->output_handler(context
, data
);
435 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
440 va_start(ap
, format
);
442 string
= alloc_vprintf(format
, ap
);
445 /* we want this collected in the log + we also want to pick it up as a tcl return
448 * The latter bit isn't precisely neat, but will do for now.
450 LOG_USER_N("%s", string
);
451 /* We already printed it above */
452 /* command_output_text(context, string); */
459 void command_print(struct command_context
*context
, const char *format
, ...)
464 va_start(ap
, format
);
466 string
= alloc_vprintf(format
, ap
);
469 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
470 /* we want this collected in the log + we also want to pick it up as a tcl return
473 * The latter bit isn't precisely neat, but will do for now.
475 LOG_USER_N("%s", string
);
476 /* We already printed it above */
477 /* command_output_text(context, string); */
484 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
487 unsigned len
= strlen(c
->name
);
488 if (NULL
== c
->parent
) {
489 // allocate enough for the name, child names, and '\0'
490 name
= malloc(len
+ extra
+ 1);
491 strcpy(name
, c
->name
);
493 // parent's extra must include both the space and name
494 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
495 char dstr
[2] = { delim
, 0 };
497 strcat(name
, c
->name
);
501 char *command_name(struct command
*c
, char delim
)
503 return __command_name(c
, delim
, 0);
506 static int run_command(struct command_context
*context
,
507 struct command
*c
, const char *words
[], unsigned num_words
)
509 if (!((context
->mode
== COMMAND_CONFIG
) || (c
->mode
== COMMAND_ANY
) || (c
->mode
== context
->mode
)))
511 /* Config commands can not run after the config stage */
512 LOG_ERROR("Command '%s' only runs during configuration stage", c
->name
);
516 struct command_invocation cmd
= {
519 .argc
= num_words
- 1,
522 int retval
= c
->handler(&cmd
);
523 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
525 /* Print help for command */
526 char *full_name
= command_name(c
, ' ');
527 if (NULL
!= full_name
) {
528 command_run_linef(context
, "help %s", full_name
);
533 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
535 /* just fall through for a shutdown request */
537 else if (retval
!= ERROR_OK
)
539 /* we do not print out an error message because the command *should*
540 * have printed out an error
542 LOG_DEBUG("Command failed with error code %d", retval
);
548 int command_run_line(struct command_context
*context
, char *line
)
550 /* all the parent commands have been registered with the interpreter
551 * so, can just evaluate the line as a script and check for
554 /* run the line thru a script engine */
555 int retval
= ERROR_FAIL
;
557 /* Beware! This code needs to be reentrant. It is also possible
558 * for OpenOCD commands to be invoked directly from Tcl. This would
559 * happen when the Jim Tcl interpreter is provided by eCos for
562 Jim_DeleteAssocData(interp
, "context");
563 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
564 if (retcode
== JIM_OK
)
566 /* associated the return value */
567 Jim_DeleteAssocData(interp
, "retval");
568 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
569 if (retcode
== JIM_OK
)
571 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
573 Jim_DeleteAssocData(interp
, "retval");
575 Jim_DeleteAssocData(interp
, "context");
577 if (retcode
== JIM_ERR
) {
578 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
580 /* We do not print the connection closed error message */
581 Jim_PrintErrorMessage(interp
);
583 if (retval
== ERROR_OK
)
585 /* It wasn't a low level OpenOCD command that failed */
589 } else if (retcode
== JIM_EXIT
) {
591 /* exit(Jim_GetExitCode(interp)); */
596 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
601 for (i
= 0; i
< reslen
; i
+= 256)
607 strncpy(buff
, result
+ i
, chunk
);
609 LOG_USER_N("%s", buff
);
611 LOG_USER_N("%s", "\n");
618 int command_run_linef(struct command_context
*context
, const char *format
, ...)
620 int retval
= ERROR_FAIL
;
623 va_start(ap
, format
);
624 string
= alloc_vprintf(format
, ap
);
627 retval
= command_run_line(context
, string
);
633 void command_set_output_handler(struct command_context
* context
,
634 command_output_handler_t output_handler
, void *priv
)
636 context
->output_handler
= output_handler
;
637 context
->output_handler_priv
= priv
;
640 struct command_context
* copy_command_context(struct command_context
* context
)
642 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
644 *copy_context
= *context
;
649 int command_done(struct command_context
*context
)
657 /* find full path to file */
658 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
662 const char *file
= Jim_GetString(argv
[1], NULL
);
663 char *full_path
= find_file(file
);
664 if (full_path
== NULL
)
666 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
669 Jim_SetResult(interp
, result
);
673 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
677 const char *str
= Jim_GetString(argv
[1], NULL
);
682 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
688 /* make it a char easier to read code */
692 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
696 /* do we have to chunk it? */
697 if (ptr
[nbytes
] == 0)
699 /* no it is a C style string */
700 LOG_USER_N("%s", ptr
);
703 /* GRR we must chunk - not null terminated */
713 memcpy(chunk
, ptr
, x
);
717 LOG_USER_N("%s", chunk
);
725 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
727 /* TCL wants to read... tell him no */
731 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
742 cp
= alloc_vprintf(fmt
, ap
);
745 LOG_USER_N("%s", cp
);
752 static int openocd_jim_fflush(void *cookie
)
754 /* nothing to flush */
758 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
765 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
770 const char *str
= Jim_GetString(argv
[1], NULL
);
772 /* capture log output and return it */
773 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
774 /* a garbage collect can happen, so we need a reference count to this object */
775 Jim_IncrRefCount(tclOutput
);
777 log_add_callback(tcl_output
, tclOutput
);
779 retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
781 log_remove_callback(tcl_output
, tclOutput
);
783 /* We dump output into this local variable */
784 Jim_SetResult(interp
, tclOutput
);
785 Jim_DecrRefCount(interp
, tclOutput
);
790 static COMMAND_HELPER(command_help_find
, struct command
*head
,
791 struct command
**out
)
794 return ERROR_INVALID_ARGUMENTS
;
795 *out
= command_find(head
, CMD_ARGV
[0]);
797 return ERROR_INVALID_ARGUMENTS
;
801 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
804 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
807 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
810 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
811 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
815 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
817 static void command_help_show_indent(unsigned n
)
819 for (unsigned i
= 0; i
< n
; i
++)
822 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
824 const char *cp
= str
, *last
= str
;
827 const char *next
= last
;
832 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
833 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
834 if (next
- last
< HELP_LINE_WIDTH(n
))
836 command_help_show_indent(n
);
837 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
843 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
846 command_help_show_indent(n
);
847 LOG_USER_N("%s", command_name(c
, ' '));
850 command_help_show_wrap(c
->usage
, 0, n
+ 5);
854 if (show_help
&& c
->help
)
855 command_help_show_wrap(c
->help
, n
+ 3, n
+ 3);
859 return CALL_COMMAND_HANDLER(command_help_show_list
,
860 c
->children
, n
, show_help
);
862 COMMAND_HANDLER(handle_help_command
)
864 struct command
*c
= CMD_CTX
->commands
;
867 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, true);
869 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
870 if (ERROR_OK
!= retval
)
873 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, true);
876 COMMAND_HANDLER(handle_usage_command
)
878 struct command
*c
= CMD_CTX
->commands
;
881 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, false);
883 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
884 if (ERROR_OK
!= retval
)
887 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, false);
890 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
891 struct command
*head
, struct command
**out
)
895 struct command
*c
= command_find(head
, Jim_GetString(argv
[0], NULL
));
899 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
902 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
904 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
905 script_debug(interp
, cmd_name
, argc
- 1, argv
+ 1);
907 struct command_context
*cmd_ctx
= current_command_context();
908 struct command
*c
= cmd_ctx
->commands
;
909 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
910 // if nothing could be consumed, then it's really an unknown command
911 if (remaining
== argc
- 1)
913 const char *cmd
= Jim_GetString(argv
[1], NULL
);
914 LOG_ERROR("Unknown command:\n %s", cmd
);
919 Jim_Obj
*const *start
;
921 if (c
->handler
|| c
->jim_handler
)
923 // include the command name in the list
924 count
= remaining
+ 1;
925 start
= argv
+ (argc
- remaining
- 1);
929 c
= command_find(cmd_ctx
->commands
, "help");
932 LOG_ERROR("unknown command, but help is missing too");
935 count
= argc
- remaining
;
939 // pass the command through to the intended handler
942 interp
->cmdPrivData
= c
->jim_handler_data
;
943 return (*c
->jim_handler
)(interp
, count
, start
);
947 const char **words
= script_command_args_alloc(count
, start
, &nwords
);
951 int retval
= run_command(cmd_ctx
, c
, words
, nwords
);
953 script_command_args_free(words
, nwords
);
955 if (!found
&& ERROR_OK
== retval
)
961 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
962 const char *cmd_name
, const char *help_text
, const char *usage
)
964 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
965 struct command
*nc
= command_find(*head
, cmd_name
);
968 // add a new command with help text
969 struct command_registration cr
= {
975 nc
= register_command(cmd_ctx
, parent
, &cr
);
978 LOG_ERROR("failed to add '%s' help text", cmd_name
);
981 LOG_DEBUG("added '%s' help text", cmd_name
);
986 bool replaced
= false;
989 free((void *)nc
->help
);
992 nc
->help
= strdup(help_text
);
994 LOG_INFO("replaced existing '%s' help", cmd_name
);
996 LOG_DEBUG("added '%s' help text", cmd_name
);
1000 bool replaced
= false;
1003 free((void *)nc
->usage
);
1006 nc
->usage
= strdup(usage
);
1008 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1010 LOG_DEBUG("added '%s' usage text", cmd_name
);
1015 COMMAND_HANDLER(handle_help_add_command
)
1019 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1020 return ERROR_INVALID_ARGUMENTS
;
1023 // save help text and remove it from argument list
1024 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1025 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1026 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1027 if (!help
&& !usage
)
1029 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1030 return ERROR_INVALID_ARGUMENTS
;
1032 // likewise for the leaf command name
1033 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1035 struct command
*c
= NULL
;
1038 c
= CMD_CTX
->commands
;
1039 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1040 if (ERROR_OK
!= retval
)
1043 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1046 /* sleep command sleeps for <n> miliseconds
1047 * this is useful in target startup scripts
1049 COMMAND_HANDLER(handle_sleep_command
)
1054 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1057 return ERROR_COMMAND_SYNTAX_ERROR
;
1059 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1060 return ERROR_COMMAND_SYNTAX_ERROR
;
1062 unsigned long duration
= 0;
1063 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1064 if (ERROR_OK
!= retval
)
1069 long long then
= timeval_ms();
1070 while (timeval_ms() - then
< (long long)duration
)
1072 target_call_timer_callbacks_now();
1077 busy_sleep(duration
);
1082 static const struct command_registration command_builtin_handlers
[] = {
1084 .name
= "add_help_text",
1085 .handler
= &handle_help_add_command
,
1086 .mode
= COMMAND_ANY
,
1087 .help
= "add new command help text",
1088 .usage
= "<command> [...] <help_text>]",
1091 .name
= "add_usage_text",
1092 .handler
= &handle_help_add_command
,
1093 .mode
= COMMAND_ANY
,
1094 .help
= "add new command usage text",
1095 .usage
= "<command> [...] <usage_text>]",
1099 .handler
= &handle_sleep_command
,
1100 .mode
= COMMAND_ANY
,
1101 .help
= "sleep for n milliseconds. "
1102 "\"busy\" will busy wait",
1103 .usage
= "<n> [busy]",
1107 .handler
= &handle_help_command
,
1108 .mode
= COMMAND_ANY
,
1109 .help
= "show built-in command help",
1110 .usage
= "[<command_name> ...]",
1114 .handler
= &handle_usage_command
,
1115 .mode
= COMMAND_ANY
,
1116 .help
= "show command usage",
1117 .usage
= "[<command_name> ...]",
1119 COMMAND_REGISTRATION_DONE
1122 struct command_context
* command_init(const char *startup_tcl
)
1124 struct command_context
* context
= malloc(sizeof(struct command_context
));
1127 context
->mode
= COMMAND_EXEC
;
1128 context
->commands
= NULL
;
1129 context
->current_target
= 0;
1130 context
->output_handler
= NULL
;
1131 context
->output_handler_priv
= NULL
;
1133 #if !BUILD_ECOSBOARD
1135 /* Create an interpreter */
1136 interp
= Jim_CreateInterp();
1137 /* Add all the Jim core commands */
1138 Jim_RegisterCoreCommands(interp
);
1141 #if defined(_MSC_VER)
1142 /* WinXX - is generic, the forward
1143 * looking problem is this:
1145 * "win32" or "win64"
1147 * "winxx" is generic.
1150 #elif defined(__linux__)
1152 #elif defined(__DARWIN__)
1154 #elif defined(__CYGWIN__)
1156 #elif defined(__MINGW32__)
1158 #elif defined(__ECOS)
1161 #warn unrecognized host OS...
1164 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1165 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1167 Jim_CreateCommand(interp
, "unknown", &command_unknown
, NULL
, NULL
);
1168 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1169 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1170 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1172 /* Set Jim's STDIO */
1173 interp
->cookie_stdin
= interp
;
1174 interp
->cookie_stdout
= interp
;
1175 interp
->cookie_stderr
= interp
;
1176 interp
->cb_fwrite
= openocd_jim_fwrite
;
1177 interp
->cb_fread
= openocd_jim_fread
;
1178 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1179 interp
->cb_fflush
= openocd_jim_fflush
;
1180 interp
->cb_fgets
= openocd_jim_fgets
;
1182 register_commands(context
, NULL
, command_builtin_handlers
);
1184 #if !BUILD_ECOSBOARD
1185 Jim_EventLoopOnLoad(interp
);
1187 Jim_SetAssocData(interp
, "context", NULL
, context
);
1188 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1190 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1191 Jim_PrintErrorMessage(interp
);
1194 Jim_DeleteAssocData(interp
, "context");
1199 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1202 return ERROR_INVALID_ARGUMENTS
;
1204 cmd_ctx
->mode
= mode
;
1208 void process_jim_events(void)
1210 #if !BUILD_ECOSBOARD
1211 static int recursion
= 0;
1216 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1222 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1223 int parse##name(const char *str, type *ul) \
1227 LOG_ERROR("Invalid command argument"); \
1228 return ERROR_COMMAND_ARGUMENT_INVALID; \
1231 *ul = func(str, &end, 0); \
1234 LOG_ERROR("Invalid command argument"); \
1235 return ERROR_COMMAND_ARGUMENT_INVALID; \
1237 if ((max == *ul) && (ERANGE == errno)) \
1239 LOG_ERROR("Argument overflow"); \
1240 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1242 if (min && (min == *ul) && (ERANGE == errno)) \
1244 LOG_ERROR("Argument underflow"); \
1245 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1249 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1250 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1251 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1252 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1254 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1255 int parse##name(const char *str, type *ul) \
1258 int retval = parse##funcname(str, &n); \
1259 if (ERROR_OK != retval) \
1262 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1264 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1269 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1270 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1271 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1272 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1273 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1274 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1276 #define DEFINE_PARSE_LONG(name, type, min, max) \
1277 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1278 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1279 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1280 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1281 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1283 static int command_parse_bool(const char *in
, bool *out
,
1284 const char *on
, const char *off
)
1286 if (strcasecmp(in
, on
) == 0)
1288 else if (strcasecmp(in
, off
) == 0)
1291 return ERROR_COMMAND_SYNTAX_ERROR
;
1295 int command_parse_bool_arg(const char *in
, bool *out
)
1297 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1299 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1301 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1303 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1305 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1307 return ERROR_INVALID_ARGUMENTS
;
1310 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1314 const char *in
= CMD_ARGV
[0];
1315 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1317 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1318 return ERROR_INVALID_ARGUMENTS
;
1323 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1326 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)