change command_find helper interface
[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 struct command* register_command(struct command_context *context,
237 struct command *parent, char *name, command_handler_t handler,
238 enum command_mode mode, char *help)
239 {
240 if (!context || !name)
241 return NULL;
242
243 struct command **head = parent ? &parent->children : &context->commands;
244 struct command *c = command_find(*head, name);
245 if (NULL != c)
246 return c;
247
248 c = malloc(sizeof(struct command));
249
250 c->name = strdup(name);
251 c->parent = parent;
252 c->children = NULL;
253 c->handler = handler;
254 c->mode = mode;
255 c->next = NULL;
256
257 command_add_child(head, c);
258
259 command_helptext_add(command_name_list(c), help);
260
261 /* just a placeholder, no handler */
262 if (c->handler == NULL)
263 return c;
264
265 const char *full_name = command_name(c, '_');
266
267 const char *ocd_name = alloc_printf("ocd_%s", full_name);
268 Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
269 free((void *)ocd_name);
270
271 /* we now need to add an overrideable proc */
272 const char *override_name = alloc_printf("proc %s {args} {"
273 "if {[catch {eval ocd_%s $args}] == 0} "
274 "{return \"\"} else {return -code error}}",
275 full_name, full_name);
276 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
277 free((void *)override_name);
278
279 free((void *)full_name);
280
281 return c;
282 }
283
284 int unregister_all_commands(struct command_context *context)
285 {
286 struct command *c, *c2;
287
288 if (context == NULL)
289 return ERROR_OK;
290
291 while (NULL != context->commands)
292 {
293 c = context->commands;
294
295 while (NULL != c->children)
296 {
297 c2 = c->children;
298 c->children = c->children->next;
299 free(c2->name);
300 c2->name = NULL;
301 free(c2);
302 c2 = NULL;
303 }
304
305 context->commands = context->commands->next;
306
307 free(c->name);
308 c->name = NULL;
309 free(c);
310 c = NULL;
311 }
312
313 return ERROR_OK;
314 }
315
316 int unregister_command(struct command_context *context, char *name)
317 {
318 struct command *c, *p = NULL, *c2;
319
320 if ((!context) || (!name))
321 return ERROR_INVALID_ARGUMENTS;
322
323 /* find command */
324 c = context->commands;
325
326 while (NULL != c)
327 {
328 if (strcmp(name, c->name) == 0)
329 {
330 /* unlink command */
331 if (p)
332 {
333 p->next = c->next;
334 }
335 else
336 {
337 /* first element in command list */
338 context->commands = c->next;
339 }
340
341 /* unregister children */
342 while (NULL != c->children)
343 {
344 c2 = c->children;
345 c->children = c->children->next;
346 free(c2->name);
347 c2->name = NULL;
348 free(c2);
349 c2 = NULL;
350 }
351
352 /* delete command */
353 free(c->name);
354 c->name = NULL;
355 free(c);
356 c = NULL;
357 return ERROR_OK;
358 }
359
360 /* remember the last command for unlinking */
361 p = c;
362 c = c->next;
363 }
364
365 return ERROR_OK;
366 }
367
368 void command_output_text(struct command_context *context, const char *data)
369 {
370 if (context && context->output_handler && data) {
371 context->output_handler(context, data);
372 }
373 }
374
375 void command_print_sameline(struct command_context *context, const char *format, ...)
376 {
377 char *string;
378
379 va_list ap;
380 va_start(ap, format);
381
382 string = alloc_vprintf(format, ap);
383 if (string != NULL)
384 {
385 /* we want this collected in the log + we also want to pick it up as a tcl return
386 * value.
387 *
388 * The latter bit isn't precisely neat, but will do for now.
389 */
390 LOG_USER_N("%s", string);
391 /* We already printed it above */
392 /* command_output_text(context, string); */
393 free(string);
394 }
395
396 va_end(ap);
397 }
398
399 void command_print(struct command_context *context, const char *format, ...)
400 {
401 char *string;
402
403 va_list ap;
404 va_start(ap, format);
405
406 string = alloc_vprintf(format, ap);
407 if (string != NULL)
408 {
409 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
410 /* we want this collected in the log + we also want to pick it up as a tcl return
411 * value.
412 *
413 * The latter bit isn't precisely neat, but will do for now.
414 */
415 LOG_USER_N("%s", string);
416 /* We already printed it above */
417 /* command_output_text(context, string); */
418 free(string);
419 }
420
421 va_end(ap);
422 }
423
424 static char *__command_name(struct command *c, char delim, unsigned extra)
425 {
426 char *name;
427 unsigned len = strlen(c->name);
428 if (NULL == c->parent) {
429 // allocate enough for the name, child names, and '\0'
430 name = malloc(len + extra + 1);
431 strcpy(name, c->name);
432 } else {
433 // parent's extra must include both the space and name
434 name = __command_name(c->parent, delim, 1 + len + extra);
435 char dstr[2] = { delim, 0 };
436 strcat(name, dstr);
437 strcat(name, c->name);
438 }
439 return name;
440 }
441 char *command_name(struct command *c, char delim)
442 {
443 return __command_name(c, delim, 0);
444 }
445
446 static int run_command(struct command_context *context,
447 struct command *c, const char *words[], unsigned num_words)
448 {
449 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
450 {
451 /* Config commands can not run after the config stage */
452 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
453 return ERROR_FAIL;
454 }
455
456 struct command_invocation cmd = {
457 .ctx = context,
458 .name = c->name,
459 .argc = num_words - 1,
460 .argv = words + 1,
461 };
462 int retval = c->handler(&cmd);
463 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
464 {
465 /* Print help for command */
466 char *full_name = command_name(c, ' ');
467 if (NULL != full_name) {
468 command_run_linef(context, "help %s", full_name);
469 free(full_name);
470 } else
471 retval = -ENOMEM;
472 }
473 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
474 {
475 /* just fall through for a shutdown request */
476 }
477 else if (retval != ERROR_OK)
478 {
479 /* we do not print out an error message because the command *should*
480 * have printed out an error
481 */
482 LOG_DEBUG("Command failed with error code %d", retval);
483 }
484
485 return retval;
486 }
487
488 int command_run_line(struct command_context *context, char *line)
489 {
490 /* all the parent commands have been registered with the interpreter
491 * so, can just evaluate the line as a script and check for
492 * results
493 */
494 /* run the line thru a script engine */
495 int retval = ERROR_FAIL;
496 int retcode;
497 /* Beware! This code needs to be reentrant. It is also possible
498 * for OpenOCD commands to be invoked directly from Tcl. This would
499 * happen when the Jim Tcl interpreter is provided by eCos for
500 * instance.
501 */
502 Jim_DeleteAssocData(interp, "context");
503 retcode = Jim_SetAssocData(interp, "context", NULL, context);
504 if (retcode == JIM_OK)
505 {
506 /* associated the return value */
507 Jim_DeleteAssocData(interp, "retval");
508 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
509 if (retcode == JIM_OK)
510 {
511 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
512
513 Jim_DeleteAssocData(interp, "retval");
514 }
515 Jim_DeleteAssocData(interp, "context");
516 }
517 if (retcode == JIM_ERR) {
518 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
519 {
520 /* We do not print the connection closed error message */
521 Jim_PrintErrorMessage(interp);
522 }
523 if (retval == ERROR_OK)
524 {
525 /* It wasn't a low level OpenOCD command that failed */
526 return ERROR_FAIL;
527 }
528 return retval;
529 } else if (retcode == JIM_EXIT) {
530 /* ignore. */
531 /* exit(Jim_GetExitCode(interp)); */
532 } else {
533 const char *result;
534 int reslen;
535
536 result = Jim_GetString(Jim_GetResult(interp), &reslen);
537 if (reslen > 0)
538 {
539 int i;
540 char buff[256 + 1];
541 for (i = 0; i < reslen; i += 256)
542 {
543 int chunk;
544 chunk = reslen - i;
545 if (chunk > 256)
546 chunk = 256;
547 strncpy(buff, result + i, chunk);
548 buff[chunk] = 0;
549 LOG_USER_N("%s", buff);
550 }
551 LOG_USER_N("%s", "\n");
552 }
553 retval = ERROR_OK;
554 }
555 return retval;
556 }
557
558 int command_run_linef(struct command_context *context, const char *format, ...)
559 {
560 int retval = ERROR_FAIL;
561 char *string;
562 va_list ap;
563 va_start(ap, format);
564 string = alloc_vprintf(format, ap);
565 if (string != NULL)
566 {
567 retval = command_run_line(context, string);
568 }
569 va_end(ap);
570 return retval;
571 }
572
573 void command_set_output_handler(struct command_context* context,
574 command_output_handler_t output_handler, void *priv)
575 {
576 context->output_handler = output_handler;
577 context->output_handler_priv = priv;
578 }
579
580 struct command_context* copy_command_context(struct command_context* context)
581 {
582 struct command_context* copy_context = malloc(sizeof(struct command_context));
583
584 *copy_context = *context;
585
586 return copy_context;
587 }
588
589 int command_done(struct command_context *context)
590 {
591 free(context);
592 context = NULL;
593
594 return ERROR_OK;
595 }
596
597 /* find full path to file */
598 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
599 {
600 if (argc != 2)
601 return JIM_ERR;
602 const char *file = Jim_GetString(argv[1], NULL);
603 char *full_path = find_file(file);
604 if (full_path == NULL)
605 return JIM_ERR;
606 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
607 free(full_path);
608
609 Jim_SetResult(interp, result);
610 return JIM_OK;
611 }
612
613 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
614 {
615 if (argc != 2)
616 return JIM_ERR;
617 const char *str = Jim_GetString(argv[1], NULL);
618 LOG_USER("%s", str);
619 return JIM_OK;
620 }
621
622 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
623 {
624 size_t nbytes;
625 const char *ptr;
626 Jim_Interp *interp;
627
628 /* make it a char easier to read code */
629 ptr = _ptr;
630 interp = cookie;
631 nbytes = size * n;
632 if (ptr == NULL || interp == NULL || nbytes == 0) {
633 return 0;
634 }
635
636 /* do we have to chunk it? */
637 if (ptr[nbytes] == 0)
638 {
639 /* no it is a C style string */
640 LOG_USER_N("%s", ptr);
641 return strlen(ptr);
642 }
643 /* GRR we must chunk - not null terminated */
644 while (nbytes) {
645 char chunk[128 + 1];
646 int x;
647
648 x = nbytes;
649 if (x > 128) {
650 x = 128;
651 }
652 /* copy it */
653 memcpy(chunk, ptr, x);
654 /* terminate it */
655 chunk[n] = 0;
656 /* output it */
657 LOG_USER_N("%s", chunk);
658 ptr += x;
659 nbytes -= x;
660 }
661
662 return n;
663 }
664
665 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
666 {
667 /* TCL wants to read... tell him no */
668 return 0;
669 }
670
671 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
672 {
673 char *cp;
674 int n;
675 Jim_Interp *interp;
676
677 n = -1;
678 interp = cookie;
679 if (interp == NULL)
680 return n;
681
682 cp = alloc_vprintf(fmt, ap);
683 if (cp)
684 {
685 LOG_USER_N("%s", cp);
686 n = strlen(cp);
687 free(cp);
688 }
689 return n;
690 }
691
692 static int openocd_jim_fflush(void *cookie)
693 {
694 /* nothing to flush */
695 return 0;
696 }
697
698 static char* openocd_jim_fgets(char *s, int size, void *cookie)
699 {
700 /* not supported */
701 errno = ENOTSUP;
702 return NULL;
703 }
704
705 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
706 {
707 if (argc != 2)
708 return JIM_ERR;
709 int retcode;
710 const char *str = Jim_GetString(argv[1], NULL);
711
712 /* capture log output and return it */
713 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
714 /* a garbage collect can happen, so we need a reference count to this object */
715 Jim_IncrRefCount(tclOutput);
716
717 log_add_callback(tcl_output, tclOutput);
718
719 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
720
721 log_remove_callback(tcl_output, tclOutput);
722
723 /* We dump output into this local variable */
724 Jim_SetResult(interp, tclOutput);
725 Jim_DecrRefCount(interp, tclOutput);
726
727 return retcode;
728 }
729
730 /* sleep command sleeps for <n> miliseconds
731 * this is useful in target startup scripts
732 */
733 COMMAND_HANDLER(handle_sleep_command)
734 {
735 bool busy = false;
736 if (CMD_ARGC == 2)
737 {
738 if (strcmp(CMD_ARGV[1], "busy") == 0)
739 busy = true;
740 else
741 return ERROR_COMMAND_SYNTAX_ERROR;
742 }
743 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
744 return ERROR_COMMAND_SYNTAX_ERROR;
745
746 unsigned long duration = 0;
747 int retval = parse_ulong(CMD_ARGV[0], &duration);
748 if (ERROR_OK != retval)
749 return retval;
750
751 if (!busy)
752 {
753 long long then = timeval_ms();
754 while (timeval_ms() - then < (long long)duration)
755 {
756 target_call_timer_callbacks_now();
757 usleep(1000);
758 }
759 }
760 else
761 busy_sleep(duration);
762
763 return ERROR_OK;
764 }
765
766 struct command_context* command_init(const char *startup_tcl)
767 {
768 struct command_context* context = malloc(sizeof(struct command_context));
769 const char *HostOs;
770
771 context->mode = COMMAND_EXEC;
772 context->commands = NULL;
773 context->current_target = 0;
774 context->output_handler = NULL;
775 context->output_handler_priv = NULL;
776
777 #if !BUILD_ECOSBOARD
778 Jim_InitEmbedded();
779 /* Create an interpreter */
780 interp = Jim_CreateInterp();
781 /* Add all the Jim core commands */
782 Jim_RegisterCoreCommands(interp);
783 #endif
784
785 #if defined(_MSC_VER)
786 /* WinXX - is generic, the forward
787 * looking problem is this:
788 *
789 * "win32" or "win64"
790 *
791 * "winxx" is generic.
792 */
793 HostOs = "winxx";
794 #elif defined(__linux__)
795 HostOs = "linux";
796 #elif defined(__DARWIN__)
797 HostOs = "darwin";
798 #elif defined(__CYGWIN__)
799 HostOs = "cygwin";
800 #elif defined(__MINGW32__)
801 HostOs = "mingw32";
802 #elif defined(__ECOS)
803 HostOs = "ecos";
804 #else
805 #warn unrecognized host OS...
806 HostOs = "other";
807 #endif
808 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
809 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
810
811 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
812 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
813 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
814
815 /* Set Jim's STDIO */
816 interp->cookie_stdin = interp;
817 interp->cookie_stdout = interp;
818 interp->cookie_stderr = interp;
819 interp->cb_fwrite = openocd_jim_fwrite;
820 interp->cb_fread = openocd_jim_fread ;
821 interp->cb_vfprintf = openocd_jim_vfprintf;
822 interp->cb_fflush = openocd_jim_fflush;
823 interp->cb_fgets = openocd_jim_fgets;
824
825 #if !BUILD_ECOSBOARD
826 Jim_EventLoopOnLoad(interp);
827 #endif
828 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
829 {
830 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
831 Jim_PrintErrorMessage(interp);
832 exit(-1);
833 }
834
835 register_command(context, NULL, "sleep",
836 handle_sleep_command, COMMAND_ANY,
837 "<n> [busy] - sleep for n milliseconds. "
838 "\"busy\" means busy wait");
839
840 return context;
841 }
842
843 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
844 {
845 if (!cmd_ctx)
846 return ERROR_INVALID_ARGUMENTS;
847
848 cmd_ctx->mode = mode;
849 return ERROR_OK;
850 }
851
852 void process_jim_events(void)
853 {
854 #if !BUILD_ECOSBOARD
855 static int recursion = 0;
856
857 if (!recursion)
858 {
859 recursion++;
860 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
861 recursion--;
862 }
863 #endif
864 }
865
866 void register_jim(struct command_context *cmd_ctx, const char *name,
867 Jim_CmdProc cmd, const char *help)
868 {
869 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
870
871 Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
872 Jim_ListAppendElement(interp, cmd_list,
873 Jim_NewStringObj(interp, name, -1));
874
875 command_helptext_add(cmd_list, help);
876 }
877
878 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
879 int parse##name(const char *str, type *ul) \
880 { \
881 if (!*str) \
882 { \
883 LOG_ERROR("Invalid command argument"); \
884 return ERROR_COMMAND_ARGUMENT_INVALID; \
885 } \
886 char *end; \
887 *ul = func(str, &end, 0); \
888 if (*end) \
889 { \
890 LOG_ERROR("Invalid command argument"); \
891 return ERROR_COMMAND_ARGUMENT_INVALID; \
892 } \
893 if ((max == *ul) && (ERANGE == errno)) \
894 { \
895 LOG_ERROR("Argument overflow"); \
896 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
897 } \
898 if (min && (min == *ul) && (ERANGE == errno)) \
899 { \
900 LOG_ERROR("Argument underflow"); \
901 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
902 } \
903 return ERROR_OK; \
904 }
905 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
906 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
907 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
908 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
909
910 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
911 int parse##name(const char *str, type *ul) \
912 { \
913 functype n; \
914 int retval = parse##funcname(str, &n); \
915 if (ERROR_OK != retval) \
916 return retval; \
917 if (n > max) \
918 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
919 if (min) \
920 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
921 *ul = n; \
922 return ERROR_OK; \
923 }
924
925 #define DEFINE_PARSE_ULONG(name, type, min, max) \
926 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
927 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
928 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
929 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
930 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
931
932 #define DEFINE_PARSE_LONG(name, type, min, max) \
933 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
934 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
935 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
936 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
937 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
938
939 static int command_parse_bool(const char *in, bool *out,
940 const char *on, const char *off)
941 {
942 if (strcasecmp(in, on) == 0)
943 *out = true;
944 else if (strcasecmp(in, off) == 0)
945 *out = false;
946 else
947 return ERROR_COMMAND_SYNTAX_ERROR;
948 return ERROR_OK;
949 }
950
951 int command_parse_bool_arg(const char *in, bool *out)
952 {
953 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
954 return ERROR_OK;
955 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
956 return ERROR_OK;
957 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
958 return ERROR_OK;
959 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
960 return ERROR_OK;
961 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
962 return ERROR_OK;
963 return ERROR_INVALID_ARGUMENTS;
964 }
965
966 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
967 {
968 switch (CMD_ARGC) {
969 case 1: {
970 const char *in = CMD_ARGV[0];
971 if (command_parse_bool_arg(in, out) != ERROR_OK)
972 {
973 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
974 return ERROR_INVALID_ARGUMENTS;
975 }
976 // fall through
977 }
978 case 0:
979 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
980 break;
981 default:
982 return ERROR_INVALID_ARGUMENTS;
983 }
984 return ERROR_OK;
985 }
986
987