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