87a898f293eb9b868a3ea1287e7ce82c788f60c5
[openocd.git] / src / helper / command.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
10 * *
11 * part of this file is taken from libcli (libcli.sourceforge.net) *
12 * Copyright (C) David Parrish (david@dparrish.com) *
13 * *
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. *
18 * *
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. *
23 * *
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 ***************************************************************************/
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #if !BUILD_ECOSBOARD
34 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
35 #define JIM_EMBEDDED
36 #endif
37
38 // @todo the inclusion of target.h here is a layering violation
39 #include "target.h"
40 #include "command.h"
41 #include "configuration.h"
42 #include "log.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
45
46
47 Jim_Interp *interp = NULL;
48
49 static int run_command(struct command_context *context,
50 struct command *c, const char *words[], unsigned num_words);
51
52 static void tcl_output(void *privData, const char *file, unsigned line,
53 const char *function, const char *string)
54 {
55 Jim_Obj *tclOutput = (Jim_Obj *)privData;
56 Jim_AppendString(interp, tclOutput, string, strlen(string));
57 }
58
59 extern struct command_context *global_cmd_ctx;
60
61 void script_debug(Jim_Interp *interp, const char *name,
62 unsigned argc, Jim_Obj *const *argv)
63 {
64 LOG_DEBUG("command - %s", name);
65 for (unsigned i = 0; i < argc; i++)
66 {
67 int len;
68 const char *w = Jim_GetString(argv[i], &len);
69
70 /* end of line comment? */
71 if (*w == '#')
72 break;
73
74 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
75 }
76 }
77
78 static void script_command_args_free(const char **words, unsigned nwords)
79 {
80 for (unsigned i = 0; i < nwords; i++)
81 free((void *)words[i]);
82 free(words);
83 }
84 static const char **script_command_args_alloc(
85 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
86 {
87 const char **words = malloc(argc * sizeof(char *));
88 if (NULL == words)
89 return NULL;
90
91 unsigned i;
92 for (i = 0; i < argc; i++)
93 {
94 int len;
95 const char *w = Jim_GetString(argv[i], &len);
96 /* a comment may end the line early */
97 if (*w == '#')
98 break;
99
100 words[i] = strdup(w);
101 if (words[i] == NULL)
102 {
103 script_command_args_free(words, i);
104 return NULL;
105 }
106 }
107 *nwords = i;
108 return words;
109 }
110
111 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
112 {
113 /* the private data is stashed in the interp structure */
114 struct command *c;
115 struct command_context *context;
116 int retval;
117
118 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
119 * get overwritten by running other Jim commands! Treat it as an
120 * emphemeral global variable that is used in lieu of an argument
121 * to the fn and fish it out manually.
122 */
123 c = interp->cmdPrivData;
124 if (c == NULL)
125 {
126 LOG_ERROR("BUG: interp->cmdPrivData == NULL");
127 return JIM_ERR;
128 }
129 target_call_timer_callbacks_now();
130 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
131
132 script_debug(interp, c->name, argc, argv);
133
134 unsigned nwords;
135 const char **words = script_command_args_alloc(argc, argv, &nwords);
136 if (NULL == words)
137 return JIM_ERR;
138
139 /* grab the command context from the associated data */
140 context = Jim_GetAssocData(interp, "context");
141 if (context == NULL)
142 {
143 /* Tcl can invoke commands directly instead of via command_run_line(). This would
144 * happen when the Jim Tcl interpreter is provided by eCos.
145 */
146 context = global_cmd_ctx;
147 }
148
149 /* capture log output and return it */
150 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
151 /* a garbage collect can happen, so we need a reference count to this object */
152 Jim_IncrRefCount(tclOutput);
153
154 log_add_callback(tcl_output, tclOutput);
155
156 retval = run_command(context, c, (const char **)words, nwords);
157
158 log_remove_callback(tcl_output, tclOutput);
159
160 /* We dump output into this local variable */
161 Jim_SetResult(interp, tclOutput);
162 Jim_DecrRefCount(interp, tclOutput);
163
164 script_command_args_free(words, nwords);
165
166 int *return_retval = Jim_GetAssocData(interp, "retval");
167 if (return_retval != NULL)
168 {
169 *return_retval = retval;
170 }
171
172 return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
173 }
174
175 static Jim_Obj *command_name_list(struct command *c)
176 {
177 Jim_Obj *cmd_list = c->parent ?
178 command_name_list(c->parent) :
179 Jim_NewListObj(interp, NULL, 0);
180 Jim_ListAppendElement(interp, cmd_list,
181 Jim_NewStringObj(interp, c->name, -1));
182
183 return cmd_list;
184 }
185
186 static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
187 {
188 Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
189 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
190 Jim_ListAppendElement(interp, cmd_entry,
191 Jim_NewStringObj(interp, help ? : "", -1));
192
193 /* accumulate help text in Tcl helptext list. */
194 Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp,
195 "ocd_helptext", JIM_ERRMSG);
196 if (Jim_IsShared(helptext))
197 helptext = Jim_DuplicateObj(interp, helptext);
198 Jim_ListAppendElement(interp, helptext, cmd_entry);
199 }
200
201 /* nice short description of source file */
202 #define __THIS__FILE__ "command.c"
203
204 /**
205 * Find a command by name from a list of commands.
206 * @returns The named command if found, or NULL.
207 */
208 static struct command *command_find(struct command *head, const char *name)
209 {
210 for (struct command *cc = head; cc; cc = cc->next)
211 {
212 if (strcmp(cc->name, name) == 0)
213 return cc;
214 }
215 return NULL;
216 }
217
218 /**
219 * Add the command to the end of linked list.
220 * @returns Returns false if the named command already exists in the list.
221 * Returns true otherwise.
222 */
223 static void command_add_child(struct command **head, struct command *c)
224 {
225 assert(head);
226 if (NULL == *head)
227 {
228 *head = c;
229 return;
230 }
231 struct command *cc = *head;
232 while (cc->next) cc = cc->next;
233 cc->next = c;
234 }
235
236 static struct command **command_list_for_parent(
237 struct command_context *cmd_ctx, struct command *parent)
238 {
239 return parent ? &parent->children : &cmd_ctx->commands;
240 }
241
242 static struct command *command_new(struct command_context *cmd_ctx,
243 struct command *parent, const char *name,
244 command_handler_t handler, enum command_mode mode,
245 const char *help)
246 {
247 assert(name);
248
249 struct command *c = malloc(sizeof(struct command));
250 memset(c, 0, sizeof(struct command));
251
252 c->name = strdup(name);
253 c->parent = parent;
254 c->handler = handler;
255 c->mode = mode;
256
257 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
258
259 command_helptext_add(command_name_list(c), help);
260
261 return c;
262 }
263 static void command_free(struct command *c)
264 {
265 /// @todo if command has a handler, unregister its jim command!
266
267 while (NULL != c->children)
268 {
269 struct command *tmp = c->children;
270 c->children = tmp->next;
271 command_free(tmp);
272 }
273
274 if (c->name)
275 free(c->name);
276 free(c);
277 }
278
279 struct command* register_command(struct command_context *context,
280 struct command *parent, const char *name,
281 command_handler_t handler, enum command_mode mode,
282 const char *help)
283 {
284 if (!context || !name)
285 return NULL;
286
287 struct command **head = command_list_for_parent(context, parent);
288 struct command *c = command_find(*head, name);
289 if (NULL != c)
290 {
291 LOG_ERROR("command '%s' is already registered in '%s' context",
292 name, parent ? parent->name : "<global>");
293 return c;
294 }
295
296 c = command_new(context, parent, name, handler, mode, help);
297 /* if allocation failed or it is a placeholder (no handler), we're done */
298 if (NULL == c || NULL == c->handler)
299 return c;
300
301 const char *full_name = command_name(c, '_');
302
303 const char *ocd_name = alloc_printf("ocd_%s", full_name);
304 Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
305 free((void *)ocd_name);
306
307 /* we now need to add an overrideable proc */
308 const char *override_name = alloc_printf("proc %s {args} {"
309 "if {[catch {eval ocd_%s $args}] == 0} "
310 "{return \"\"} else {return -code error}}",
311 full_name, full_name);
312 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
313 free((void *)override_name);
314
315 free((void *)full_name);
316
317 return c;
318 }
319
320 int unregister_all_commands(struct command_context *context,
321 struct command *parent)
322 {
323 if (context == NULL)
324 return ERROR_OK;
325
326 struct command **head = command_list_for_parent(context, parent);
327 while (NULL != *head)
328 {
329 struct command *tmp = *head;
330 *head = tmp->next;
331 command_free(tmp);
332 }
333
334 return ERROR_OK;
335 }
336
337 int unregister_command(struct command_context *context,
338 struct command *parent, const char *name)
339 {
340 if ((!context) || (!name))
341 return ERROR_INVALID_ARGUMENTS;
342
343 struct command *p = NULL;
344 struct command **head = command_list_for_parent(context, parent);
345 for (struct command *c = *head; NULL != c; p = c, c = c->next)
346 {
347 if (strcmp(name, c->name) != 0)
348 continue;
349
350 if (p)
351 p->next = c->next;
352 else
353 *head = c->next;
354
355 command_free(c);
356 return ERROR_OK;
357 }
358
359 return ERROR_OK;
360 }
361
362 void command_output_text(struct command_context *context, const char *data)
363 {
364 if (context && context->output_handler && data) {
365 context->output_handler(context, data);
366 }
367 }
368
369 void command_print_sameline(struct command_context *context, const char *format, ...)
370 {
371 char *string;
372
373 va_list ap;
374 va_start(ap, format);
375
376 string = alloc_vprintf(format, ap);
377 if (string != NULL)
378 {
379 /* we want this collected in the log + we also want to pick it up as a tcl return
380 * value.
381 *
382 * The latter bit isn't precisely neat, but will do for now.
383 */
384 LOG_USER_N("%s", string);
385 /* We already printed it above */
386 /* command_output_text(context, string); */
387 free(string);
388 }
389
390 va_end(ap);
391 }
392
393 void command_print(struct command_context *context, const char *format, ...)
394 {
395 char *string;
396
397 va_list ap;
398 va_start(ap, format);
399
400 string = alloc_vprintf(format, ap);
401 if (string != NULL)
402 {
403 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
404 /* we want this collected in the log + we also want to pick it up as a tcl return
405 * value.
406 *
407 * The latter bit isn't precisely neat, but will do for now.
408 */
409 LOG_USER_N("%s", string);
410 /* We already printed it above */
411 /* command_output_text(context, string); */
412 free(string);
413 }
414
415 va_end(ap);
416 }
417
418 static char *__command_name(struct command *c, char delim, unsigned extra)
419 {
420 char *name;
421 unsigned len = strlen(c->name);
422 if (NULL == c->parent) {
423 // allocate enough for the name, child names, and '\0'
424 name = malloc(len + extra + 1);
425 strcpy(name, c->name);
426 } else {
427 // parent's extra must include both the space and name
428 name = __command_name(c->parent, delim, 1 + len + extra);
429 char dstr[2] = { delim, 0 };
430 strcat(name, dstr);
431 strcat(name, c->name);
432 }
433 return name;
434 }
435 char *command_name(struct command *c, char delim)
436 {
437 return __command_name(c, delim, 0);
438 }
439
440 static int run_command(struct command_context *context,
441 struct command *c, const char *words[], unsigned num_words)
442 {
443 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
444 {
445 /* Config commands can not run after the config stage */
446 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
447 return ERROR_FAIL;
448 }
449
450 struct command_invocation cmd = {
451 .ctx = context,
452 .name = c->name,
453 .argc = num_words - 1,
454 .argv = words + 1,
455 };
456 int retval = c->handler(&cmd);
457 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
458 {
459 /* Print help for command */
460 char *full_name = command_name(c, ' ');
461 if (NULL != full_name) {
462 command_run_linef(context, "help %s", full_name);
463 free(full_name);
464 } else
465 retval = -ENOMEM;
466 }
467 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
468 {
469 /* just fall through for a shutdown request */
470 }
471 else if (retval != ERROR_OK)
472 {
473 /* we do not print out an error message because the command *should*
474 * have printed out an error
475 */
476 LOG_DEBUG("Command failed with error code %d", retval);
477 }
478
479 return retval;
480 }
481
482 int command_run_line(struct command_context *context, char *line)
483 {
484 /* all the parent commands have been registered with the interpreter
485 * so, can just evaluate the line as a script and check for
486 * results
487 */
488 /* run the line thru a script engine */
489 int retval = ERROR_FAIL;
490 int retcode;
491 /* Beware! This code needs to be reentrant. It is also possible
492 * for OpenOCD commands to be invoked directly from Tcl. This would
493 * happen when the Jim Tcl interpreter is provided by eCos for
494 * instance.
495 */
496 Jim_DeleteAssocData(interp, "context");
497 retcode = Jim_SetAssocData(interp, "context", NULL, context);
498 if (retcode == JIM_OK)
499 {
500 /* associated the return value */
501 Jim_DeleteAssocData(interp, "retval");
502 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
503 if (retcode == JIM_OK)
504 {
505 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
506
507 Jim_DeleteAssocData(interp, "retval");
508 }
509 Jim_DeleteAssocData(interp, "context");
510 }
511 if (retcode == JIM_ERR) {
512 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
513 {
514 /* We do not print the connection closed error message */
515 Jim_PrintErrorMessage(interp);
516 }
517 if (retval == ERROR_OK)
518 {
519 /* It wasn't a low level OpenOCD command that failed */
520 return ERROR_FAIL;
521 }
522 return retval;
523 } else if (retcode == JIM_EXIT) {
524 /* ignore. */
525 /* exit(Jim_GetExitCode(interp)); */
526 } else {
527 const char *result;
528 int reslen;
529
530 result = Jim_GetString(Jim_GetResult(interp), &reslen);
531 if (reslen > 0)
532 {
533 int i;
534 char buff[256 + 1];
535 for (i = 0; i < reslen; i += 256)
536 {
537 int chunk;
538 chunk = reslen - i;
539 if (chunk > 256)
540 chunk = 256;
541 strncpy(buff, result + i, chunk);
542 buff[chunk] = 0;
543 LOG_USER_N("%s", buff);
544 }
545 LOG_USER_N("%s", "\n");
546 }
547 retval = ERROR_OK;
548 }
549 return retval;
550 }
551
552 int command_run_linef(struct command_context *context, const char *format, ...)
553 {
554 int retval = ERROR_FAIL;
555 char *string;
556 va_list ap;
557 va_start(ap, format);
558 string = alloc_vprintf(format, ap);
559 if (string != NULL)
560 {
561 retval = command_run_line(context, string);
562 }
563 va_end(ap);
564 return retval;
565 }
566
567 void command_set_output_handler(struct command_context* context,
568 command_output_handler_t output_handler, void *priv)
569 {
570 context->output_handler = output_handler;
571 context->output_handler_priv = priv;
572 }
573
574 struct command_context* copy_command_context(struct command_context* context)
575 {
576 struct command_context* copy_context = malloc(sizeof(struct command_context));
577
578 *copy_context = *context;
579
580 return copy_context;
581 }
582
583 int command_done(struct command_context *context)
584 {
585 free(context);
586 context = NULL;
587
588 return ERROR_OK;
589 }
590
591 /* find full path to file */
592 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
593 {
594 if (argc != 2)
595 return JIM_ERR;
596 const char *file = Jim_GetString(argv[1], NULL);
597 char *full_path = find_file(file);
598 if (full_path == NULL)
599 return JIM_ERR;
600 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
601 free(full_path);
602
603 Jim_SetResult(interp, result);
604 return JIM_OK;
605 }
606
607 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
608 {
609 if (argc != 2)
610 return JIM_ERR;
611 const char *str = Jim_GetString(argv[1], NULL);
612 LOG_USER("%s", str);
613 return JIM_OK;
614 }
615
616 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
617 {
618 size_t nbytes;
619 const char *ptr;
620 Jim_Interp *interp;
621
622 /* make it a char easier to read code */
623 ptr = _ptr;
624 interp = cookie;
625 nbytes = size * n;
626 if (ptr == NULL || interp == NULL || nbytes == 0) {
627 return 0;
628 }
629
630 /* do we have to chunk it? */
631 if (ptr[nbytes] == 0)
632 {
633 /* no it is a C style string */
634 LOG_USER_N("%s", ptr);
635 return strlen(ptr);
636 }
637 /* GRR we must chunk - not null terminated */
638 while (nbytes) {
639 char chunk[128 + 1];
640 int x;
641
642 x = nbytes;
643 if (x > 128) {
644 x = 128;
645 }
646 /* copy it */
647 memcpy(chunk, ptr, x);
648 /* terminate it */
649 chunk[n] = 0;
650 /* output it */
651 LOG_USER_N("%s", chunk);
652 ptr += x;
653 nbytes -= x;
654 }
655
656 return n;
657 }
658
659 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
660 {
661 /* TCL wants to read... tell him no */
662 return 0;
663 }
664
665 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
666 {
667 char *cp;
668 int n;
669 Jim_Interp *interp;
670
671 n = -1;
672 interp = cookie;
673 if (interp == NULL)
674 return n;
675
676 cp = alloc_vprintf(fmt, ap);
677 if (cp)
678 {
679 LOG_USER_N("%s", cp);
680 n = strlen(cp);
681 free(cp);
682 }
683 return n;
684 }
685
686 static int openocd_jim_fflush(void *cookie)
687 {
688 /* nothing to flush */
689 return 0;
690 }
691
692 static char* openocd_jim_fgets(char *s, int size, void *cookie)
693 {
694 /* not supported */
695 errno = ENOTSUP;
696 return NULL;
697 }
698
699 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
700 {
701 if (argc != 2)
702 return JIM_ERR;
703 int retcode;
704 const char *str = Jim_GetString(argv[1], NULL);
705
706 /* capture log output and return it */
707 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
708 /* a garbage collect can happen, so we need a reference count to this object */
709 Jim_IncrRefCount(tclOutput);
710
711 log_add_callback(tcl_output, tclOutput);
712
713 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
714
715 log_remove_callback(tcl_output, tclOutput);
716
717 /* We dump output into this local variable */
718 Jim_SetResult(interp, tclOutput);
719 Jim_DecrRefCount(interp, tclOutput);
720
721 return retcode;
722 }
723
724 /* sleep command sleeps for <n> miliseconds
725 * this is useful in target startup scripts
726 */
727 COMMAND_HANDLER(handle_sleep_command)
728 {
729 bool busy = false;
730 if (CMD_ARGC == 2)
731 {
732 if (strcmp(CMD_ARGV[1], "busy") == 0)
733 busy = true;
734 else
735 return ERROR_COMMAND_SYNTAX_ERROR;
736 }
737 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
738 return ERROR_COMMAND_SYNTAX_ERROR;
739
740 unsigned long duration = 0;
741 int retval = parse_ulong(CMD_ARGV[0], &duration);
742 if (ERROR_OK != retval)
743 return retval;
744
745 if (!busy)
746 {
747 long long then = timeval_ms();
748 while (timeval_ms() - then < (long long)duration)
749 {
750 target_call_timer_callbacks_now();
751 usleep(1000);
752 }
753 }
754 else
755 busy_sleep(duration);
756
757 return ERROR_OK;
758 }
759
760 struct command_context* command_init(const char *startup_tcl)
761 {
762 struct command_context* context = malloc(sizeof(struct command_context));
763 const char *HostOs;
764
765 context->mode = COMMAND_EXEC;
766 context->commands = NULL;
767 context->current_target = 0;
768 context->output_handler = NULL;
769 context->output_handler_priv = NULL;
770
771 #if !BUILD_ECOSBOARD
772 Jim_InitEmbedded();
773 /* Create an interpreter */
774 interp = Jim_CreateInterp();
775 /* Add all the Jim core commands */
776 Jim_RegisterCoreCommands(interp);
777 #endif
778
779 #if defined(_MSC_VER)
780 /* WinXX - is generic, the forward
781 * looking problem is this:
782 *
783 * "win32" or "win64"
784 *
785 * "winxx" is generic.
786 */
787 HostOs = "winxx";
788 #elif defined(__linux__)
789 HostOs = "linux";
790 #elif defined(__DARWIN__)
791 HostOs = "darwin";
792 #elif defined(__CYGWIN__)
793 HostOs = "cygwin";
794 #elif defined(__MINGW32__)
795 HostOs = "mingw32";
796 #elif defined(__ECOS)
797 HostOs = "ecos";
798 #else
799 #warn unrecognized host OS...
800 HostOs = "other";
801 #endif
802 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
803 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
804
805 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
806 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
807 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
808
809 /* Set Jim's STDIO */
810 interp->cookie_stdin = interp;
811 interp->cookie_stdout = interp;
812 interp->cookie_stderr = interp;
813 interp->cb_fwrite = openocd_jim_fwrite;
814 interp->cb_fread = openocd_jim_fread ;
815 interp->cb_vfprintf = openocd_jim_vfprintf;
816 interp->cb_fflush = openocd_jim_fflush;
817 interp->cb_fgets = openocd_jim_fgets;
818
819 #if !BUILD_ECOSBOARD
820 Jim_EventLoopOnLoad(interp);
821 #endif
822 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
823 {
824 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
825 Jim_PrintErrorMessage(interp);
826 exit(-1);
827 }
828
829 register_command(context, NULL, "sleep",
830 handle_sleep_command, COMMAND_ANY,
831 "<n> [busy] - sleep for n milliseconds. "
832 "\"busy\" means busy wait");
833
834 return context;
835 }
836
837 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
838 {
839 if (!cmd_ctx)
840 return ERROR_INVALID_ARGUMENTS;
841
842 cmd_ctx->mode = mode;
843 return ERROR_OK;
844 }
845
846 void process_jim_events(void)
847 {
848 #if !BUILD_ECOSBOARD
849 static int recursion = 0;
850
851 if (!recursion)
852 {
853 recursion++;
854 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
855 recursion--;
856 }
857 #endif
858 }
859
860 void register_jim(struct command_context *cmd_ctx, const char *name,
861 Jim_CmdProc cmd, const char *help)
862 {
863 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
864
865 Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
866 Jim_ListAppendElement(interp, cmd_list,
867 Jim_NewStringObj(interp, name, -1));
868
869 command_helptext_add(cmd_list, help);
870 }
871
872 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
873 int parse##name(const char *str, type *ul) \
874 { \
875 if (!*str) \
876 { \
877 LOG_ERROR("Invalid command argument"); \
878 return ERROR_COMMAND_ARGUMENT_INVALID; \
879 } \
880 char *end; \
881 *ul = func(str, &end, 0); \
882 if (*end) \
883 { \
884 LOG_ERROR("Invalid command argument"); \
885 return ERROR_COMMAND_ARGUMENT_INVALID; \
886 } \
887 if ((max == *ul) && (ERANGE == errno)) \
888 { \
889 LOG_ERROR("Argument overflow"); \
890 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
891 } \
892 if (min && (min == *ul) && (ERANGE == errno)) \
893 { \
894 LOG_ERROR("Argument underflow"); \
895 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
896 } \
897 return ERROR_OK; \
898 }
899 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
900 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
901 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
902 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
903
904 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
905 int parse##name(const char *str, type *ul) \
906 { \
907 functype n; \
908 int retval = parse##funcname(str, &n); \
909 if (ERROR_OK != retval) \
910 return retval; \
911 if (n > max) \
912 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
913 if (min) \
914 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
915 *ul = n; \
916 return ERROR_OK; \
917 }
918
919 #define DEFINE_PARSE_ULONG(name, type, min, max) \
920 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
921 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
922 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
923 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
924 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
925
926 #define DEFINE_PARSE_LONG(name, type, min, max) \
927 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
928 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
929 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
930 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
931 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
932
933 static int command_parse_bool(const char *in, bool *out,
934 const char *on, const char *off)
935 {
936 if (strcasecmp(in, on) == 0)
937 *out = true;
938 else if (strcasecmp(in, off) == 0)
939 *out = false;
940 else
941 return ERROR_COMMAND_SYNTAX_ERROR;
942 return ERROR_OK;
943 }
944
945 int command_parse_bool_arg(const char *in, bool *out)
946 {
947 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
948 return ERROR_OK;
949 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
950 return ERROR_OK;
951 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
952 return ERROR_OK;
953 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
954 return ERROR_OK;
955 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
956 return ERROR_OK;
957 return ERROR_INVALID_ARGUMENTS;
958 }
959
960 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
961 {
962 switch (CMD_ARGC) {
963 case 1: {
964 const char *in = CMD_ARGV[0];
965 if (command_parse_bool_arg(in, out) != ERROR_OK)
966 {
967 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
968 return ERROR_INVALID_ARGUMENTS;
969 }
970 // fall through
971 }
972 case 0:
973 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
974 break;
975 default:
976 return ERROR_INVALID_ARGUMENTS;
977 }
978 return ERROR_OK;
979 }
980
981