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)
198 * Add the command into the linked list, sorted by name.
199 * @param head Address to head of command list pointer, which may be
200 * updated if @c c gets inserted at the beginning of the list.
201 * @param c The command to add to the list pointed to by @c head.
203 static void command_add_child(struct command
**head
, struct command
*c
)
212 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
213 head
= &(*head
)->next
;
215 if (strcmp(c
->name
, (*head
)->name
) > 0) {
216 c
->next
= (*head
)->next
;
224 static struct command
**command_list_for_parent(
225 struct command_context
*cmd_ctx
, struct command
*parent
)
227 return parent
? &parent
->children
: &cmd_ctx
->commands
;
230 static struct command
*command_new(struct command_context
*cmd_ctx
,
231 struct command
*parent
, const char *name
,
232 command_handler_t handler
, enum command_mode mode
,
233 const char *help
, const char *usage
)
237 struct command
*c
= malloc(sizeof(struct command
));
238 memset(c
, 0, sizeof(struct command
));
240 c
->name
= strdup(name
);
242 c
->help
= strdup(help
);
244 c
->usage
= strdup(usage
);
246 c
->handler
= handler
;
249 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
253 static void command_free(struct command
*c
)
255 /// @todo if command has a handler, unregister its jim command!
257 while (NULL
!= c
->children
)
259 struct command
*tmp
= c
->children
;
260 c
->children
= tmp
->next
;
267 free((void*)c
->help
);
269 free((void*)c
->usage
);
273 static int register_command_handler(struct command
*c
)
275 int retval
= -ENOMEM
;
276 const char *full_name
= command_name(c
, '_');
277 if (NULL
== full_name
)
280 const char *ocd_name
= alloc_printf("ocd_%s", full_name
);
281 if (NULL
== full_name
)
284 Jim_CreateCommand(interp
, ocd_name
, script_command
, c
, NULL
);
285 free((void *)ocd_name
);
287 /* we now need to add an overrideable proc */
288 const char *override_name
= alloc_printf("proc %s {args} {"
289 "if {[catch {eval ocd_%s $args}] == 0} "
290 "{return \"\"} else {return -code error}}",
291 full_name
, full_name
);
292 if (NULL
== full_name
)
295 Jim_Eval_Named(interp
, override_name
, __THIS__FILE__
, __LINE__
);
296 free((void *)override_name
);
301 free((void *)full_name
);
305 struct command
* register_command(struct command_context
*context
,
306 struct command
*parent
, const struct command_registration
*cr
)
308 if (!context
|| !cr
->name
)
311 const char *name
= cr
->name
;
312 struct command
**head
= command_list_for_parent(context
, parent
);
313 struct command
*c
= command_find(*head
, name
);
316 LOG_ERROR("command '%s' is already registered in '%s' context",
317 name
, parent
? parent
->name
: "<global>");
321 c
= command_new(context
, parent
, name
, cr
->handler
, cr
->mode
, cr
->help
, cr
->usage
);
322 /* if allocation failed or it is a placeholder (no handler), we're done */
323 if (NULL
== c
|| NULL
== c
->handler
)
326 int retval
= register_command_handler(c
);
327 if (ERROR_OK
!= retval
)
329 unregister_command(context
, parent
, name
);
335 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
336 const struct command_registration
*cmds
)
338 int retval
= ERROR_OK
;
340 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
342 const struct command_registration
*cr
= cmds
+ i
;
344 struct command
*c
= NULL
;
345 if (NULL
!= cr
->name
)
347 c
= register_command(cmd_ctx
, parent
, cr
);
354 if (NULL
!= cr
->chain
)
356 struct command
*p
= c
? : parent
;
357 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
358 if (ERROR_OK
!= retval
)
362 if (ERROR_OK
!= retval
)
364 for (unsigned j
= 0; j
< i
; j
++)
365 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
370 int unregister_all_commands(struct command_context
*context
,
371 struct command
*parent
)
376 struct command
**head
= command_list_for_parent(context
, parent
);
377 while (NULL
!= *head
)
379 struct command
*tmp
= *head
;
387 int unregister_command(struct command_context
*context
,
388 struct command
*parent
, const char *name
)
390 if ((!context
) || (!name
))
391 return ERROR_INVALID_ARGUMENTS
;
393 struct command
*p
= NULL
;
394 struct command
**head
= command_list_for_parent(context
, parent
);
395 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
397 if (strcmp(name
, c
->name
) != 0)
412 void command_output_text(struct command_context
*context
, const char *data
)
414 if (context
&& context
->output_handler
&& data
) {
415 context
->output_handler(context
, data
);
419 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
424 va_start(ap
, format
);
426 string
= alloc_vprintf(format
, ap
);
429 /* we want this collected in the log + we also want to pick it up as a tcl return
432 * The latter bit isn't precisely neat, but will do for now.
434 LOG_USER_N("%s", string
);
435 /* We already printed it above */
436 /* command_output_text(context, string); */
443 void command_print(struct command_context
*context
, const char *format
, ...)
448 va_start(ap
, format
);
450 string
= alloc_vprintf(format
, ap
);
453 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
454 /* we want this collected in the log + we also want to pick it up as a tcl return
457 * The latter bit isn't precisely neat, but will do for now.
459 LOG_USER_N("%s", string
);
460 /* We already printed it above */
461 /* command_output_text(context, string); */
468 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
471 unsigned len
= strlen(c
->name
);
472 if (NULL
== c
->parent
) {
473 // allocate enough for the name, child names, and '\0'
474 name
= malloc(len
+ extra
+ 1);
475 strcpy(name
, c
->name
);
477 // parent's extra must include both the space and name
478 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
479 char dstr
[2] = { delim
, 0 };
481 strcat(name
, c
->name
);
485 char *command_name(struct command
*c
, char delim
)
487 return __command_name(c
, delim
, 0);
490 static int run_command(struct command_context
*context
,
491 struct command
*c
, const char *words
[], unsigned num_words
)
493 if (!((context
->mode
== COMMAND_CONFIG
) || (c
->mode
== COMMAND_ANY
) || (c
->mode
== context
->mode
)))
495 /* Config commands can not run after the config stage */
496 LOG_ERROR("Command '%s' only runs during configuration stage", c
->name
);
500 struct command_invocation cmd
= {
503 .argc
= num_words
- 1,
506 int retval
= c
->handler(&cmd
);
507 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
)
509 /* Print help for command */
510 char *full_name
= command_name(c
, ' ');
511 if (NULL
!= full_name
) {
512 command_run_linef(context
, "help %s", full_name
);
517 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
519 /* just fall through for a shutdown request */
521 else if (retval
!= ERROR_OK
)
523 /* we do not print out an error message because the command *should*
524 * have printed out an error
526 LOG_DEBUG("Command failed with error code %d", retval
);
532 int command_run_line(struct command_context
*context
, char *line
)
534 /* all the parent commands have been registered with the interpreter
535 * so, can just evaluate the line as a script and check for
538 /* run the line thru a script engine */
539 int retval
= ERROR_FAIL
;
541 /* Beware! This code needs to be reentrant. It is also possible
542 * for OpenOCD commands to be invoked directly from Tcl. This would
543 * happen when the Jim Tcl interpreter is provided by eCos for
546 Jim_DeleteAssocData(interp
, "context");
547 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
548 if (retcode
== JIM_OK
)
550 /* associated the return value */
551 Jim_DeleteAssocData(interp
, "retval");
552 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
553 if (retcode
== JIM_OK
)
555 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
557 Jim_DeleteAssocData(interp
, "retval");
559 Jim_DeleteAssocData(interp
, "context");
561 if (retcode
== JIM_ERR
) {
562 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
564 /* We do not print the connection closed error message */
565 Jim_PrintErrorMessage(interp
);
567 if (retval
== ERROR_OK
)
569 /* It wasn't a low level OpenOCD command that failed */
573 } else if (retcode
== JIM_EXIT
) {
575 /* exit(Jim_GetExitCode(interp)); */
580 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
585 for (i
= 0; i
< reslen
; i
+= 256)
591 strncpy(buff
, result
+ i
, chunk
);
593 LOG_USER_N("%s", buff
);
595 LOG_USER_N("%s", "\n");
602 int command_run_linef(struct command_context
*context
, const char *format
, ...)
604 int retval
= ERROR_FAIL
;
607 va_start(ap
, format
);
608 string
= alloc_vprintf(format
, ap
);
611 retval
= command_run_line(context
, string
);
617 void command_set_output_handler(struct command_context
* context
,
618 command_output_handler_t output_handler
, void *priv
)
620 context
->output_handler
= output_handler
;
621 context
->output_handler_priv
= priv
;
624 struct command_context
* copy_command_context(struct command_context
* context
)
626 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
628 *copy_context
= *context
;
633 int command_done(struct command_context
*context
)
641 /* find full path to file */
642 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
646 const char *file
= Jim_GetString(argv
[1], NULL
);
647 char *full_path
= find_file(file
);
648 if (full_path
== NULL
)
650 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
653 Jim_SetResult(interp
, result
);
657 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
661 const char *str
= Jim_GetString(argv
[1], NULL
);
666 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
672 /* make it a char easier to read code */
676 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
680 /* do we have to chunk it? */
681 if (ptr
[nbytes
] == 0)
683 /* no it is a C style string */
684 LOG_USER_N("%s", ptr
);
687 /* GRR we must chunk - not null terminated */
697 memcpy(chunk
, ptr
, x
);
701 LOG_USER_N("%s", chunk
);
709 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
711 /* TCL wants to read... tell him no */
715 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
726 cp
= alloc_vprintf(fmt
, ap
);
729 LOG_USER_N("%s", cp
);
736 static int openocd_jim_fflush(void *cookie
)
738 /* nothing to flush */
742 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
749 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
754 const char *str
= Jim_GetString(argv
[1], NULL
);
756 /* capture log output and return it */
757 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
758 /* a garbage collect can happen, so we need a reference count to this object */
759 Jim_IncrRefCount(tclOutput
);
761 log_add_callback(tcl_output
, tclOutput
);
763 retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
765 log_remove_callback(tcl_output
, tclOutput
);
767 /* We dump output into this local variable */
768 Jim_SetResult(interp
, tclOutput
);
769 Jim_DecrRefCount(interp
, tclOutput
);
774 static COMMAND_HELPER(command_help_find
, struct command
*head
,
775 struct command
**out
)
778 return ERROR_INVALID_ARGUMENTS
;
779 *out
= command_find(head
, CMD_ARGV
[0]);
781 return ERROR_INVALID_ARGUMENTS
;
785 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
788 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
791 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
794 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
795 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
798 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
801 const char *usage
= c
->usage
? : "";
802 const char *help
= "";
803 const char *sep
= "";
804 if (show_help
&& c
->help
)
806 help
= c
->help
? : "";
807 sep
= c
->usage
? " | " : "";
809 command_run_linef(CMD_CTX
, "cmd_help {%s} {%s%s%s} %d",
810 command_name(c
, ' '), usage
, sep
, help
, n
);
815 return CALL_COMMAND_HANDLER(command_help_show_list
,
816 c
->children
, n
, show_help
);
818 COMMAND_HANDLER(handle_help_command
)
820 struct command
*c
= CMD_CTX
->commands
;
823 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, true);
825 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
826 if (ERROR_OK
!= retval
)
829 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, true);
832 COMMAND_HANDLER(handle_usage_command
)
834 struct command
*c
= CMD_CTX
->commands
;
837 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, false);
839 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
840 if (ERROR_OK
!= retval
)
843 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, false);
847 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
848 const char *cmd_name
, const char *help_text
, const char *usage
)
850 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
851 struct command
*nc
= command_find(*head
, cmd_name
);
854 // add a new command with help text
855 struct command_registration cr
= {
861 nc
= register_command(cmd_ctx
, parent
, &cr
);
864 LOG_ERROR("failed to add '%s' help text", cmd_name
);
867 LOG_DEBUG("added '%s' help text", cmd_name
);
871 bool replaced
= false;
874 free((void *)nc
->help
);
877 nc
->help
= strdup(help_text
);
880 LOG_INFO("replaced existing '%s' help", cmd_name
);
882 LOG_DEBUG("added '%s' help text", cmd_name
);
887 COMMAND_HANDLER(handle_help_add_command
)
891 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
892 return ERROR_INVALID_ARGUMENTS
;
895 // save help text and remove it from argument list
896 const char *help_text
= CMD_ARGV
[--CMD_ARGC
];
897 // likewise for the leaf command name
898 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
900 struct command
*c
= NULL
;
903 c
= CMD_CTX
->commands
;
904 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
905 if (ERROR_OK
!= retval
)
908 return help_add_command(CMD_CTX
, c
, cmd_name
, help_text
, NULL
);
911 /* sleep command sleeps for <n> miliseconds
912 * this is useful in target startup scripts
914 COMMAND_HANDLER(handle_sleep_command
)
919 if (strcmp(CMD_ARGV
[1], "busy") == 0)
922 return ERROR_COMMAND_SYNTAX_ERROR
;
924 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
925 return ERROR_COMMAND_SYNTAX_ERROR
;
927 unsigned long duration
= 0;
928 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
929 if (ERROR_OK
!= retval
)
934 long long then
= timeval_ms();
935 while (timeval_ms() - then
< (long long)duration
)
937 target_call_timer_callbacks_now();
942 busy_sleep(duration
);
947 static const struct command_registration command_builtin_handlers
[] = {
949 .name
= "add_help_text",
950 .handler
= &handle_help_add_command
,
952 .help
= "add new command help text",
953 .usage
= "<command> [...] <help_text>]",
957 .handler
= &handle_sleep_command
,
959 .help
= "sleep for n milliseconds. "
960 "\"busy\" will busy wait",
961 .usage
= "<n> [busy]",
965 .handler
= &handle_help_command
,
967 .help
= "show built-in command help",
968 .usage
= "[<command_name> ...]",
972 .handler
= &handle_usage_command
,
974 .help
= "show command usage",
975 .usage
= "[<command_name> ...]",
977 COMMAND_REGISTRATION_DONE
980 struct command_context
* command_init(const char *startup_tcl
)
982 struct command_context
* context
= malloc(sizeof(struct command_context
));
985 context
->mode
= COMMAND_EXEC
;
986 context
->commands
= NULL
;
987 context
->current_target
= 0;
988 context
->output_handler
= NULL
;
989 context
->output_handler_priv
= NULL
;
993 /* Create an interpreter */
994 interp
= Jim_CreateInterp();
995 /* Add all the Jim core commands */
996 Jim_RegisterCoreCommands(interp
);
999 #if defined(_MSC_VER)
1000 /* WinXX - is generic, the forward
1001 * looking problem is this:
1003 * "win32" or "win64"
1005 * "winxx" is generic.
1008 #elif defined(__linux__)
1010 #elif defined(__DARWIN__)
1012 #elif defined(__CYGWIN__)
1014 #elif defined(__MINGW32__)
1016 #elif defined(__ECOS)
1019 #warn unrecognized host OS...
1022 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1023 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1025 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1026 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1027 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1029 /* Set Jim's STDIO */
1030 interp
->cookie_stdin
= interp
;
1031 interp
->cookie_stdout
= interp
;
1032 interp
->cookie_stderr
= interp
;
1033 interp
->cb_fwrite
= openocd_jim_fwrite
;
1034 interp
->cb_fread
= openocd_jim_fread
;
1035 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1036 interp
->cb_fflush
= openocd_jim_fflush
;
1037 interp
->cb_fgets
= openocd_jim_fgets
;
1039 register_commands(context
, NULL
, command_builtin_handlers
);
1041 #if !BUILD_ECOSBOARD
1042 Jim_EventLoopOnLoad(interp
);
1044 Jim_SetAssocData(interp
, "context", NULL
, context
);
1045 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1047 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1048 Jim_PrintErrorMessage(interp
);
1051 Jim_DeleteAssocData(interp
, "context");
1056 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1059 return ERROR_INVALID_ARGUMENTS
;
1061 cmd_ctx
->mode
= mode
;
1065 void process_jim_events(void)
1067 #if !BUILD_ECOSBOARD
1068 static int recursion
= 0;
1073 Jim_ProcessEvents (interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1079 void register_jim(struct command_context
*cmd_ctx
, const char *name
,
1080 Jim_CmdProc cmd
, const char *help
)
1082 Jim_CreateCommand(interp
, name
, cmd
, NULL
, NULL
);
1084 Jim_Obj
*cmd_list
= Jim_NewListObj(interp
, NULL
, 0);
1085 Jim_ListAppendElement(interp
, cmd_list
,
1086 Jim_NewStringObj(interp
, name
, -1));
1088 help_add_command(cmd_ctx
, NULL
, name
, help
, NULL
);
1091 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1092 int parse##name(const char *str, type *ul) \
1096 LOG_ERROR("Invalid command argument"); \
1097 return ERROR_COMMAND_ARGUMENT_INVALID; \
1100 *ul = func(str, &end, 0); \
1103 LOG_ERROR("Invalid command argument"); \
1104 return ERROR_COMMAND_ARGUMENT_INVALID; \
1106 if ((max == *ul) && (ERANGE == errno)) \
1108 LOG_ERROR("Argument overflow"); \
1109 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1111 if (min && (min == *ul) && (ERANGE == errno)) \
1113 LOG_ERROR("Argument underflow"); \
1114 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1118 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1119 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1120 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1121 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1123 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1124 int parse##name(const char *str, type *ul) \
1127 int retval = parse##funcname(str, &n); \
1128 if (ERROR_OK != retval) \
1131 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1133 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1138 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1139 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1140 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1141 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1142 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1143 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1145 #define DEFINE_PARSE_LONG(name, type, min, max) \
1146 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1147 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1148 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1149 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1150 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1152 static int command_parse_bool(const char *in
, bool *out
,
1153 const char *on
, const char *off
)
1155 if (strcasecmp(in
, on
) == 0)
1157 else if (strcasecmp(in
, off
) == 0)
1160 return ERROR_COMMAND_SYNTAX_ERROR
;
1164 int command_parse_bool_arg(const char *in
, bool *out
)
1166 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1168 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1170 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1172 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1174 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1176 return ERROR_INVALID_ARGUMENTS
;
1179 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1183 const char *in
= CMD_ARGV
[0];
1184 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1186 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1187 return ERROR_INVALID_ARGUMENTS
;
1192 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1195 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)