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
;
257 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
261 static void command_free(struct command
*c
)
263 /// @todo if command has a handler, unregister its jim command!
265 while (NULL
!= c
->children
)
267 struct command
*tmp
= c
->children
;
268 c
->children
= tmp
->next
;
275 free((void*)c
->help
);
277 free((void*)c
->usage
);
281 static int register_command_handler(struct command
*c
)
283 int retval
= -ENOMEM
;
284 const char *full_name
= command_name(c
, '_');
285 if (NULL
== full_name
)
288 const char *ocd_name
= alloc_printf("ocd_%s", full_name
);
289 if (NULL
== full_name
)
292 Jim_CreateCommand(interp
, ocd_name
, script_command
, c
, NULL
);
293 free((void *)ocd_name
);
295 /* we now need to add an overrideable proc */
296 const char *override_name
= alloc_printf("proc %s {args} {"
297 "if {[catch {eval ocd_%s $args}] == 0} "
298 "{return \"\"} else {return -code error}}",
299 full_name
, full_name
);
300 if (NULL
== full_name
)
303 Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
304 free((void *)override_name
);
309 free((void *)full_name
);
313 struct command
* register_command(struct command_context
*context
,
314 struct command
*parent
, const struct command_registration
*cr
)
316 if (!context
|| !cr
->name
)
319 const char *name
= cr
->name
;
320 struct command
**head
= command_list_for_parent(context
, parent
);
321 struct command
*c
= command_find(*head
, name
);
324 LOG_ERROR("command '%s' is already registered in '%s' context",
325 name
, parent
? parent
->name
: "<global>");
329 c
= command_new(context
, parent
, cr
);
330 /* if allocation failed or it is a placeholder (no handler), we're done */
331 if (NULL
== c
|| NULL
== c
->handler
)
334 int retval
= register_command_handler(c
);
335 if (ERROR_OK
!= retval
)
337 unregister_command(context
, parent
, name
);
343 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
344 const struct command_registration
*cmds
)
346 int retval
= ERROR_OK
;
348 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
350 const struct command_registration
*cr
= cmds
+ i
;
352 struct command
*c
= NULL
;
353 if (NULL
!= cr
->name
)
355 c
= register_command(cmd_ctx
, parent
, cr
);
362 if (NULL
!= cr
->chain
)
364 struct command
*p
= c
? : parent
;
365 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
366 if (ERROR_OK
!= retval
)
370 if (ERROR_OK
!= retval
)
372 for (unsigned j
= 0; j
< i
; j
++)
373 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
378 int unregister_all_commands(struct command_context
*context
,
379 struct command
*parent
)
384 struct command
**head
= command_list_for_parent(context
, parent
);
385 while (NULL
!= *head
)
387 struct command
*tmp
= *head
;
395 int unregister_command(struct command_context
*context
,
396 struct command
*parent
, const char *name
)
398 if ((!context
) || (!name
))
399 return ERROR_INVALID_ARGUMENTS
;
401 struct command
*p
= NULL
;
402 struct command
**head
= command_list_for_parent(context
, parent
);
403 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
405 if (strcmp(name
, c
->name
) != 0)
420 void command_output_text(struct command_context
*context
, const char *data
)
422 if (context
&& context
->output_handler
&& data
) {
423 context
->output_handler(context
, data
);
427 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
432 va_start(ap
, format
);
434 string
= alloc_vprintf(format
, ap
);
437 /* we want this collected in the log + we also want to pick it up as a tcl return
440 * The latter bit isn't precisely neat, but will do for now.
442 LOG_USER_N("%s", string
);
443 /* We already printed it above */
444 /* command_output_text(context, string); */
451 void command_print(struct command_context
*context
, const char *format
, ...)
456 va_start(ap
, format
);
458 string
= alloc_vprintf(format
, ap
);
461 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
462 /* we want this collected in the log + we also want to pick it up as a tcl return
465 * The latter bit isn't precisely neat, but will do for now.
467 LOG_USER_N("%s", string
);
468 /* We already printed it above */
469 /* command_output_text(context, string); */
476 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
479 unsigned len
= strlen(c
->name
);
480 if (NULL
== c
->parent
) {
481 // allocate enough for the name, child names, and '\0'
482 name
= malloc(len
+ extra
+ 1);
483 strcpy(name
, c
->name
);
485 // parent's extra must include both the space and name
486 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
487 char dstr
[2] = { delim
, 0 };
489 strcat(name
, c
->name
);
493 char *command_name(struct command
*c
, char delim
)
495 return __command_name(c
, delim
, 0);
498 static int run_command(struct command_context
*context
,
499 struct command
*c
, const char *words
[], unsigned num_words
)
501 if (!((context
->mode
== COMMAND_CONFIG
) || (c
->mode
== COMMAND_ANY
) || (c
->mode
== context
->mode
)))
503 /* Config commands can not run after the config stage */
504 LOG_ERROR("Command '%s' only runs during configuration stage", c
->name
);
508 struct command_invocation cmd
= {
511 .argc
= num_words
- 1,
514 int retval
= c
->handler(&cmd
);
515 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
517 /* Print help for command */
518 char *full_name
= command_name(c
, ' ');
519 if (NULL
!= full_name
) {
520 command_run_linef(context
, "help %s", full_name
);
525 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
527 /* just fall through for a shutdown request */
529 else if (retval
!= ERROR_OK
)
531 /* we do not print out an error message because the command *should*
532 * have printed out an error
534 LOG_DEBUG("Command failed with error code %d", retval
);
540 int command_run_line(struct command_context
*context
, char *line
)
542 /* all the parent commands have been registered with the interpreter
543 * so, can just evaluate the line as a script and check for
546 /* run the line thru a script engine */
547 int retval
= ERROR_FAIL
;
549 /* Beware! This code needs to be reentrant. It is also possible
550 * for OpenOCD commands to be invoked directly from Tcl. This would
551 * happen when the Jim Tcl interpreter is provided by eCos for
554 Jim_DeleteAssocData(interp
, "context");
555 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
556 if (retcode
== JIM_OK
)
558 /* associated the return value */
559 Jim_DeleteAssocData(interp
, "retval");
560 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
561 if (retcode
== JIM_OK
)
563 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
565 Jim_DeleteAssocData(interp
, "retval");
567 Jim_DeleteAssocData(interp
, "context");
569 if (retcode
== JIM_ERR
) {
570 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
572 /* We do not print the connection closed error message */
573 Jim_PrintErrorMessage(interp
);
575 if (retval
== ERROR_OK
)
577 /* It wasn't a low level OpenOCD command that failed */
581 } else if (retcode
== JIM_EXIT
) {
583 /* exit(Jim_GetExitCode(interp)); */
588 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
593 for (i
= 0; i
< reslen
; i
+= 256)
599 strncpy(buff
, result
+ i
, chunk
);
601 LOG_USER_N("%s", buff
);
603 LOG_USER_N("%s", "\n");
610 int command_run_linef(struct command_context
*context
, const char *format
, ...)
612 int retval
= ERROR_FAIL
;
615 va_start(ap
, format
);
616 string
= alloc_vprintf(format
, ap
);
619 retval
= command_run_line(context
, string
);
625 void command_set_output_handler(struct command_context
* context
,
626 command_output_handler_t output_handler
, void *priv
)
628 context
->output_handler
= output_handler
;
629 context
->output_handler_priv
= priv
;
632 struct command_context
* copy_command_context(struct command_context
* context
)
634 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
636 *copy_context
= *context
;
641 int command_done(struct command_context
*context
)
649 /* find full path to file */
650 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
654 const char *file
= Jim_GetString(argv
[1], NULL
);
655 char *full_path
= find_file(file
);
656 if (full_path
== NULL
)
658 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
661 Jim_SetResult(interp
, result
);
665 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
669 const char *str
= Jim_GetString(argv
[1], NULL
);
674 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
680 /* make it a char easier to read code */
684 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
688 /* do we have to chunk it? */
689 if (ptr
[nbytes
] == 0)
691 /* no it is a C style string */
692 LOG_USER_N("%s", ptr
);
695 /* GRR we must chunk - not null terminated */
705 memcpy(chunk
, ptr
, x
);
709 LOG_USER_N("%s", chunk
);
717 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
719 /* TCL wants to read... tell him no */
723 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
734 cp
= alloc_vprintf(fmt
, ap
);
737 LOG_USER_N("%s", cp
);
744 static int openocd_jim_fflush(void *cookie
)
746 /* nothing to flush */
750 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
757 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
762 const char *str
= Jim_GetString(argv
[1], NULL
);
764 /* capture log output and return it */
765 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
766 /* a garbage collect can happen, so we need a reference count to this object */
767 Jim_IncrRefCount(tclOutput
);
769 log_add_callback(tcl_output
, tclOutput
);
771 retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
773 log_remove_callback(tcl_output
, tclOutput
);
775 /* We dump output into this local variable */
776 Jim_SetResult(interp
, tclOutput
);
777 Jim_DecrRefCount(interp
, tclOutput
);
782 static COMMAND_HELPER(command_help_find
, struct command
*head
,
783 struct command
**out
)
786 return ERROR_INVALID_ARGUMENTS
;
787 *out
= command_find(head
, CMD_ARGV
[0]);
789 return ERROR_INVALID_ARGUMENTS
;
793 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
796 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
799 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
802 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
803 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
806 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
809 const char *usage
= c
->usage
? : "";
810 const char *help
= "";
811 const char *sep
= "";
812 if (show_help
&& c
->help
)
814 help
= c
->help
? : "";
815 sep
= c
->usage
? " | " : "";
817 command_run_linef(CMD_CTX
, "cmd_help {%s} {%s%s%s} %d",
818 command_name(c
, ' '), usage
, sep
, help
, n
);
823 return CALL_COMMAND_HANDLER(command_help_show_list
,
824 c
->children
, n
, show_help
);
826 COMMAND_HANDLER(handle_help_command
)
828 struct command
*c
= CMD_CTX
->commands
;
831 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, true);
833 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
834 if (ERROR_OK
!= retval
)
837 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, true);
840 COMMAND_HANDLER(handle_usage_command
)
842 struct command
*c
= CMD_CTX
->commands
;
845 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, false);
847 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
848 if (ERROR_OK
!= retval
)
851 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, false);
854 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
855 struct command
*head
, struct command
**out
)
859 struct command
*c
= command_find(head
, Jim_GetString(argv
[0], NULL
));
863 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
866 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
868 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
869 script_debug(interp
, cmd_name
, argc
- 1, argv
+ 1);
871 struct command_context
*cmd_ctx
= current_command_context();
872 struct command
*c
= cmd_ctx
->commands
;
873 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
874 // if nothing could be consumed, then it's really an unknown command
875 if (remaining
== argc
- 1)
877 const char *cmd
= Jim_GetString(argv
[1], NULL
);
878 LOG_ERROR("Unknown command:\n %s", cmd
);
883 Jim_Obj
*const *start
;
887 // include the command name in the list
888 count
= remaining
+ 1;
889 start
= argv
+ (argc
- remaining
- 1);
893 c
= command_find(cmd_ctx
->commands
, "help");
896 LOG_ERROR("unknown command, but help is missing too");
899 count
= argc
- remaining
;
905 const char **words
= script_command_args_alloc(count
, start
, &nwords
);
909 int retval
= run_command(cmd_ctx
, c
, words
, nwords
);
911 script_command_args_free(words
, nwords
);
913 if (!found
&& ERROR_OK
== retval
)
919 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
920 const char *cmd_name
, const char *help_text
, const char *usage
)
922 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
923 struct command
*nc
= command_find(*head
, cmd_name
);
926 // add a new command with help text
927 struct command_registration cr
= {
933 nc
= register_command(cmd_ctx
, parent
, &cr
);
936 LOG_ERROR("failed to add '%s' help text", cmd_name
);
939 LOG_DEBUG("added '%s' help text", cmd_name
);
943 bool replaced
= false;
946 free((void *)nc
->help
);
949 nc
->help
= strdup(help_text
);
952 LOG_INFO("replaced existing '%s' help", cmd_name
);
954 LOG_DEBUG("added '%s' help text", cmd_name
);
959 COMMAND_HANDLER(handle_help_add_command
)
963 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
964 return ERROR_INVALID_ARGUMENTS
;
967 // save help text and remove it from argument list
968 const char *help_text
= CMD_ARGV
[--CMD_ARGC
];
969 // likewise for the leaf command name
970 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
972 struct command
*c
= NULL
;
975 c
= CMD_CTX
->commands
;
976 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
977 if (ERROR_OK
!= retval
)
980 return help_add_command(CMD_CTX
, c
, cmd_name
, help_text
, NULL
);
983 /* sleep command sleeps for <n> miliseconds
984 * this is useful in target startup scripts
986 COMMAND_HANDLER(handle_sleep_command
)
991 if (strcmp(CMD_ARGV
[1], "busy") == 0)
994 return ERROR_COMMAND_SYNTAX_ERROR
;
996 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
997 return ERROR_COMMAND_SYNTAX_ERROR
;
999 unsigned long duration
= 0;
1000 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1001 if (ERROR_OK
!= retval
)
1006 long long then
= timeval_ms();
1007 while (timeval_ms() - then
< (long long)duration
)
1009 target_call_timer_callbacks_now();
1014 busy_sleep(duration
);
1019 static const struct command_registration command_builtin_handlers
[] = {
1021 .name
= "add_help_text",
1022 .handler
= &handle_help_add_command
,
1023 .mode
= COMMAND_ANY
,
1024 .help
= "add new command help text",
1025 .usage
= "<command> [...] <help_text>]",
1029 .handler
= &handle_sleep_command
,
1030 .mode
= COMMAND_ANY
,
1031 .help
= "sleep for n milliseconds. "
1032 "\"busy\" will busy wait",
1033 .usage
= "<n> [busy]",
1037 .handler
= &handle_help_command
,
1038 .mode
= COMMAND_ANY
,
1039 .help
= "show built-in command help",
1040 .usage
= "[<command_name> ...]",
1044 .handler
= &handle_usage_command
,
1045 .mode
= COMMAND_ANY
,
1046 .help
= "show command usage",
1047 .usage
= "[<command_name> ...]",
1049 COMMAND_REGISTRATION_DONE
1052 struct command_context
* command_init(const char *startup_tcl
)
1054 struct command_context
* context
= malloc(sizeof(struct command_context
));
1057 context
->mode
= COMMAND_EXEC
;
1058 context
->commands
= NULL
;
1059 context
->current_target
= 0;
1060 context
->output_handler
= NULL
;
1061 context
->output_handler_priv
= NULL
;
1063 #if !BUILD_ECOSBOARD
1065 /* Create an interpreter */
1066 interp
= Jim_CreateInterp();
1067 /* Add all the Jim core commands */
1068 Jim_RegisterCoreCommands(interp
);
1071 #if defined(_MSC_VER)
1072 /* WinXX - is generic, the forward
1073 * looking problem is this:
1075 * "win32" or "win64"
1077 * "winxx" is generic.
1080 #elif defined(__linux__)
1082 #elif defined(__DARWIN__)
1084 #elif defined(__CYGWIN__)
1086 #elif defined(__MINGW32__)
1088 #elif defined(__ECOS)
1091 #warn unrecognized host OS...
1094 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1095 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1097 Jim_CreateCommand(interp
, "unknown", &command_unknown
, NULL
, NULL
);
1098 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1099 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1100 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1102 /* Set Jim's STDIO */
1103 interp
->cookie_stdin
= interp
;
1104 interp
->cookie_stdout
= interp
;
1105 interp
->cookie_stderr
= interp
;
1106 interp
->cb_fwrite
= openocd_jim_fwrite
;
1107 interp
->cb_fread
= openocd_jim_fread
;
1108 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1109 interp
->cb_fflush
= openocd_jim_fflush
;
1110 interp
->cb_fgets
= openocd_jim_fgets
;
1112 register_commands(context
, NULL
, command_builtin_handlers
);
1114 #if !BUILD_ECOSBOARD
1115 Jim_EventLoopOnLoad(interp
);
1117 Jim_SetAssocData(interp
, "context", NULL
, context
);
1118 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1120 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1121 Jim_PrintErrorMessage(interp
);
1124 Jim_DeleteAssocData(interp
, "context");
1129 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1132 return ERROR_INVALID_ARGUMENTS
;
1134 cmd_ctx
->mode
= mode
;
1138 void process_jim_events(void)
1140 #if !BUILD_ECOSBOARD
1141 static int recursion
= 0;
1146 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1152 void register_jim(struct command_context
*cmd_ctx
, const char *name
,
1153 Jim_CmdProc cmd
, const char *help
)
1155 Jim_CreateCommand(interp
, name
, cmd
, NULL
, NULL
);
1157 Jim_Obj
*cmd_list
= Jim_NewListObj(interp
, NULL
, 0);
1158 Jim_ListAppendElement(interp
, cmd_list
,
1159 Jim_NewStringObj(interp
, name
, -1));
1161 help_add_command(cmd_ctx
, NULL
, name
, help
, NULL
);
1164 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1165 int parse##name(const char *str, type *ul) \
1169 LOG_ERROR("Invalid command argument"); \
1170 return ERROR_COMMAND_ARGUMENT_INVALID; \
1173 *ul = func(str, &end, 0); \
1176 LOG_ERROR("Invalid command argument"); \
1177 return ERROR_COMMAND_ARGUMENT_INVALID; \
1179 if ((max == *ul) && (ERANGE == errno)) \
1181 LOG_ERROR("Argument overflow"); \
1182 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1184 if (min && (min == *ul) && (ERANGE == errno)) \
1186 LOG_ERROR("Argument underflow"); \
1187 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1191 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1192 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1193 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1194 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1196 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1197 int parse##name(const char *str, type *ul) \
1200 int retval = parse##funcname(str, &n); \
1201 if (ERROR_OK != retval) \
1204 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1206 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1211 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1212 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1213 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1214 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1215 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1216 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1218 #define DEFINE_PARSE_LONG(name, type, min, max) \
1219 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1220 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1221 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1222 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1223 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1225 static int command_parse_bool(const char *in
, bool *out
,
1226 const char *on
, const char *off
)
1228 if (strcasecmp(in
, on
) == 0)
1230 else if (strcasecmp(in
, off
) == 0)
1233 return ERROR_COMMAND_SYNTAX_ERROR
;
1237 int command_parse_bool_arg(const char *in
, bool *out
)
1239 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1241 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1243 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1245 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1247 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1249 return ERROR_INVALID_ARGUMENTS
;
1252 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1256 const char *in
= CMD_ARGV
[0];
1257 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1259 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1260 return ERROR_INVALID_ARGUMENTS
;
1265 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1268 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)