1ff4e01a7d1a5d51c4cf1cd26ed8d394bec43eb8
[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, see <http://www.gnu.org/licenses/>. *
26 ***************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
33 #define JIM_EMBEDDED
34
35 /* @todo the inclusion of target.h here is a layering violation */
36 #include <jtag/jtag.h>
37 #include <target/target.h>
38 #include "command.h"
39 #include "configuration.h"
40 #include "log.h"
41 #include "time_support.h"
42 #include "jim-eventloop.h"
43
44 /* nice short description of source file */
45 #define __THIS__FILE__ "command.c"
46
47 static int run_command(struct command_context *context,
48 struct command *c, const char *words[], unsigned num_words);
49
50 struct log_capture_state {
51 Jim_Interp *interp;
52 Jim_Obj *output;
53 };
54
55 static void tcl_output(void *privData, const char *file, unsigned line,
56 const char *function, const char *string)
57 {
58 struct log_capture_state *state = privData;
59 Jim_AppendString(state->interp, state->output, string, strlen(string));
60 }
61
62 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
63 {
64 /* capture log output and return it. A garbage collect can
65 * happen, so we need a reference count to this object */
66 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
67 if (NULL == tclOutput)
68 return NULL;
69
70 struct log_capture_state *state = malloc(sizeof(*state));
71 if (NULL == state)
72 return NULL;
73
74 state->interp = interp;
75 Jim_IncrRefCount(tclOutput);
76 state->output = tclOutput;
77
78 log_add_callback(tcl_output, state);
79
80 return state;
81 }
82
83 /* Classic openocd commands provide progress output which we
84 * will capture and return as a Tcl return value.
85 *
86 * However, if a non-openocd command has been invoked, then it
87 * makes sense to return the tcl return value from that command.
88 *
89 * The tcl return value is empty for openocd commands that provide
90 * progress output.
91 *
92 * Therefore we set the tcl return value only if we actually
93 * captured output.
94 */
95 static void command_log_capture_finish(struct log_capture_state *state)
96 {
97 if (NULL == state)
98 return;
99
100 log_remove_callback(tcl_output, state);
101
102 int length;
103 Jim_GetString(state->output, &length);
104
105 if (length > 0)
106 Jim_SetResult(state->interp, state->output);
107 else {
108 /* No output captured, use tcl return value (which could
109 * be empty too). */
110 }
111 Jim_DecrRefCount(state->interp, state->output);
112
113 free(state);
114 }
115
116 static int command_retval_set(Jim_Interp *interp, int retval)
117 {
118 int *return_retval = Jim_GetAssocData(interp, "retval");
119 if (return_retval != NULL)
120 *return_retval = retval;
121
122 return (retval == ERROR_OK) ? JIM_OK : retval;
123 }
124
125 extern struct command_context *global_cmd_ctx;
126
127 /* dump a single line to the log for the command.
128 * Do nothing in case we are not at debug level 3 */
129 void script_debug(Jim_Interp *interp, const char *name,
130 unsigned argc, Jim_Obj * const *argv)
131 {
132 if (debug_level < LOG_LVL_DEBUG)
133 return;
134
135 char *dbg = alloc_printf("command - %s", name);
136 for (unsigned i = 0; i < argc; i++) {
137 int len;
138 const char *w = Jim_GetString(argv[i], &len);
139 char *t = alloc_printf("%s %s", dbg, w);
140 free(dbg);
141 dbg = t;
142 }
143 LOG_DEBUG("%s", dbg);
144 free(dbg);
145 }
146
147 static void script_command_args_free(char **words, unsigned nwords)
148 {
149 for (unsigned i = 0; i < nwords; i++)
150 free(words[i]);
151 free(words);
152 }
153
154 static char **script_command_args_alloc(
155 unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
156 {
157 char **words = malloc(argc * sizeof(char *));
158 if (NULL == words)
159 return NULL;
160
161 unsigned i;
162 for (i = 0; i < argc; i++) {
163 int len;
164 const char *w = Jim_GetString(argv[i], &len);
165 words[i] = strdup(w);
166 if (words[i] == NULL) {
167 script_command_args_free(words, i);
168 return NULL;
169 }
170 }
171 *nwords = i;
172 return words;
173 }
174
175 struct command_context *current_command_context(Jim_Interp *interp)
176 {
177 /* grab the command context from the associated data */
178 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
179 if (NULL == cmd_ctx) {
180 /* Tcl can invoke commands directly instead of via command_run_line(). This would
181 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
182 * commands in a startup script.
183 *
184 * A telnet or gdb server would provide a non-default command context to
185 * handle piping of error output, have a separate current target, etc.
186 */
187 cmd_ctx = global_cmd_ctx;
188 }
189 return cmd_ctx;
190 }
191
192 static int script_command_run(Jim_Interp *interp,
193 int argc, Jim_Obj * const *argv, struct command *c, bool capture)
194 {
195 target_call_timer_callbacks_now();
196 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
197
198 unsigned nwords;
199 char **words = script_command_args_alloc(argc, argv, &nwords);
200 if (NULL == words)
201 return JIM_ERR;
202
203 struct log_capture_state *state = NULL;
204 if (capture)
205 state = command_log_capture_start(interp);
206
207 struct command_context *cmd_ctx = current_command_context(interp);
208 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
209
210 command_log_capture_finish(state);
211
212 script_command_args_free(words, nwords);
213 return command_retval_set(interp, retval);
214 }
215
216 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
217 {
218 /* the private data is stashed in the interp structure */
219
220 struct command *c = interp->cmdPrivData;
221 assert(c);
222 script_debug(interp, c->name, argc, argv);
223 return script_command_run(interp, argc, argv, c, true);
224 }
225
226 static struct command *command_root(struct command *c)
227 {
228 while (NULL != c->parent)
229 c = c->parent;
230 return c;
231 }
232
233 /**
234 * Find a command by name from a list of commands.
235 * @returns Returns the named command if it exists in the list.
236 * Returns NULL otherwise.
237 */
238 static struct command *command_find(struct command *head, const char *name)
239 {
240 for (struct command *cc = head; cc; cc = cc->next) {
241 if (strcmp(cc->name, name) == 0)
242 return cc;
243 }
244 return NULL;
245 }
246
247 struct command *command_find_in_context(struct command_context *cmd_ctx,
248 const char *name)
249 {
250 return command_find(cmd_ctx->commands, name);
251 }
252 struct command *command_find_in_parent(struct command *parent,
253 const char *name)
254 {
255 return command_find(parent->children, name);
256 }
257
258 /**
259 * Add the command into the linked list, sorted by name.
260 * @param head Address to head of command list pointer, which may be
261 * updated if @c c gets inserted at the beginning of the list.
262 * @param c The command to add to the list pointed to by @c head.
263 */
264 static void command_add_child(struct command **head, struct command *c)
265 {
266 assert(head);
267 if (NULL == *head) {
268 *head = c;
269 return;
270 }
271
272 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
273 head = &(*head)->next;
274
275 if (strcmp(c->name, (*head)->name) > 0) {
276 c->next = (*head)->next;
277 (*head)->next = c;
278 } else {
279 c->next = *head;
280 *head = c;
281 }
282 }
283
284 static struct command **command_list_for_parent(
285 struct command_context *cmd_ctx, struct command *parent)
286 {
287 return parent ? &parent->children : &cmd_ctx->commands;
288 }
289
290 static void command_free(struct command *c)
291 {
292 /** @todo if command has a handler, unregister its jim command! */
293
294 while (NULL != c->children) {
295 struct command *tmp = c->children;
296 c->children = tmp->next;
297 command_free(tmp);
298 }
299
300 free(c->name);
301 free(c->help);
302 free(c->usage);
303 free(c);
304 }
305
306 static struct command *command_new(struct command_context *cmd_ctx,
307 struct command *parent, const struct command_registration *cr)
308 {
309 assert(cr->name);
310
311 /*
312 * If it is a non-jim command with no .usage specified,
313 * log an error.
314 *
315 * strlen(.usage) == 0 means that the command takes no
316 * arguments.
317 */
318 if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
319 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
320 "'.usage' field filled out",
321 parent && parent->name ? parent->name : "",
322 parent && parent->name ? " " : "",
323 cr->name);
324 }
325
326 struct command *c = calloc(1, sizeof(struct command));
327 if (NULL == c)
328 return NULL;
329
330 c->name = strdup(cr->name);
331 if (cr->help)
332 c->help = strdup(cr->help);
333 if (cr->usage)
334 c->usage = strdup(cr->usage);
335
336 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
337 goto command_new_error;
338
339 c->parent = parent;
340 c->handler = cr->handler;
341 c->jim_handler = cr->jim_handler;
342 c->jim_handler_data = cr->jim_handler_data;
343 c->mode = cr->mode;
344
345 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
346
347 return c;
348
349 command_new_error:
350 command_free(c);
351 return NULL;
352 }
353
354 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
355
356 static int register_command_handler(struct command_context *cmd_ctx,
357 struct command *c)
358 {
359 Jim_Interp *interp = cmd_ctx->interp;
360 char *ocd_name = alloc_printf("ocd_%s", c->name);
361 if (NULL == ocd_name)
362 return JIM_ERR;
363
364 LOG_DEBUG("registering '%s'...", ocd_name);
365
366 Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
367 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
368 free(ocd_name);
369 if (JIM_OK != retval)
370 return retval;
371
372 /* we now need to add an overrideable proc */
373 char *override_name = alloc_printf(
374 "proc %s {args} {eval ocd_bouncer %s $args}",
375 c->name, c->name);
376 if (NULL == override_name)
377 return JIM_ERR;
378
379 retval = Jim_Eval_Named(interp, override_name, 0, 0);
380 free(override_name);
381
382 return retval;
383 }
384
385 struct command *register_command(struct command_context *context,
386 struct command *parent, const struct command_registration *cr)
387 {
388 if (!context || !cr->name)
389 return NULL;
390
391 const char *name = cr->name;
392 struct command **head = command_list_for_parent(context, parent);
393 struct command *c = command_find(*head, name);
394 if (NULL != c) {
395 /* TODO: originally we treated attempting to register a cmd twice as an error
396 * Sometimes we need this behaviour, such as with flash banks.
397 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
398 LOG_DEBUG("command '%s' is already registered in '%s' context",
399 name, parent ? parent->name : "<global>");
400 return c;
401 }
402
403 c = command_new(context, parent, cr);
404 if (NULL == c)
405 return NULL;
406
407 int retval = ERROR_OK;
408 if (NULL != cr->jim_handler && NULL == parent) {
409 retval = Jim_CreateCommand(context->interp, cr->name,
410 cr->jim_handler, cr->jim_handler_data, NULL);
411 } else if (NULL != cr->handler || NULL != parent)
412 retval = register_command_handler(context, command_root(c));
413
414 if (ERROR_OK != retval) {
415 unregister_command(context, parent, name);
416 c = NULL;
417 }
418 return c;
419 }
420
421 int register_commands(struct command_context *cmd_ctx, struct command *parent,
422 const struct command_registration *cmds)
423 {
424 int retval = ERROR_OK;
425 unsigned i;
426 for (i = 0; cmds[i].name || cmds[i].chain; i++) {
427 const struct command_registration *cr = cmds + i;
428
429 struct command *c = NULL;
430 if (NULL != cr->name) {
431 c = register_command(cmd_ctx, parent, cr);
432 if (NULL == c) {
433 retval = ERROR_FAIL;
434 break;
435 }
436 }
437 if (NULL != cr->chain) {
438 struct command *p = c ? : parent;
439 retval = register_commands(cmd_ctx, p, cr->chain);
440 if (ERROR_OK != retval)
441 break;
442 }
443 }
444 if (ERROR_OK != retval) {
445 for (unsigned j = 0; j < i; j++)
446 unregister_command(cmd_ctx, parent, cmds[j].name);
447 }
448 return retval;
449 }
450
451 int unregister_all_commands(struct command_context *context,
452 struct command *parent)
453 {
454 if (context == NULL)
455 return ERROR_OK;
456
457 struct command **head = command_list_for_parent(context, parent);
458 while (NULL != *head) {
459 struct command *tmp = *head;
460 *head = tmp->next;
461 command_free(tmp);
462 }
463
464 return ERROR_OK;
465 }
466
467 int unregister_command(struct command_context *context,
468 struct command *parent, const char *name)
469 {
470 if ((!context) || (!name))
471 return ERROR_COMMAND_SYNTAX_ERROR;
472
473 struct command *p = NULL;
474 struct command **head = command_list_for_parent(context, parent);
475 for (struct command *c = *head; NULL != c; p = c, c = c->next) {
476 if (strcmp(name, c->name) != 0)
477 continue;
478
479 if (p)
480 p->next = c->next;
481 else
482 *head = c->next;
483
484 command_free(c);
485 return ERROR_OK;
486 }
487
488 return ERROR_OK;
489 }
490
491 void command_set_handler_data(struct command *c, void *p)
492 {
493 if (NULL != c->handler || NULL != c->jim_handler)
494 c->jim_handler_data = p;
495 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
496 command_set_handler_data(cc, p);
497 }
498
499 void command_output_text(struct command_context *context, const char *data)
500 {
501 if (context && context->output_handler && data)
502 context->output_handler(context, data);
503 }
504
505 void command_print_sameline(struct command_context *context, const char *format, ...)
506 {
507 char *string;
508
509 va_list ap;
510 va_start(ap, format);
511
512 string = alloc_vprintf(format, ap);
513 if (string != NULL) {
514 /* we want this collected in the log + we also want to pick it up as a tcl return
515 * value.
516 *
517 * The latter bit isn't precisely neat, but will do for now.
518 */
519 LOG_USER_N("%s", string);
520 /* We already printed it above
521 * command_output_text(context, string); */
522 free(string);
523 }
524
525 va_end(ap);
526 }
527
528 void command_print(struct command_context *context, const char *format, ...)
529 {
530 char *string;
531
532 va_list ap;
533 va_start(ap, format);
534
535 string = alloc_vprintf(format, ap);
536 if (string != NULL) {
537 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
538 *char longer */
539 /* we want this collected in the log + we also want to pick it up as a tcl return
540 * value.
541 *
542 * The latter bit isn't precisely neat, but will do for now.
543 */
544 LOG_USER_N("%s", string);
545 /* We already printed it above
546 * command_output_text(context, string); */
547 free(string);
548 }
549
550 va_end(ap);
551 }
552
553 static char *__command_name(struct command *c, char delim, unsigned extra)
554 {
555 char *name;
556 unsigned len = strlen(c->name);
557 if (NULL == c->parent) {
558 /* allocate enough for the name, child names, and '\0' */
559 name = malloc(len + extra + 1);
560 if (!name) {
561 LOG_ERROR("Out of memory");
562 return NULL;
563 }
564 strcpy(name, c->name);
565 } else {
566 /* parent's extra must include both the space and name */
567 name = __command_name(c->parent, delim, 1 + len + extra);
568 char dstr[2] = { delim, 0 };
569 strcat(name, dstr);
570 strcat(name, c->name);
571 }
572 return name;
573 }
574
575 char *command_name(struct command *c, char delim)
576 {
577 return __command_name(c, delim, 0);
578 }
579
580 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
581 {
582 return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
583 }
584
585 static int run_command(struct command_context *context,
586 struct command *c, const char *words[], unsigned num_words)
587 {
588 if (!command_can_run(context, c)) {
589 /* Many commands may be run only before/after 'init' */
590 const char *when;
591 switch (c->mode) {
592 case COMMAND_CONFIG:
593 when = "before";
594 break;
595 case COMMAND_EXEC:
596 when = "after";
597 break;
598 /* handle the impossible with humor; it guarantees a bug report! */
599 default:
600 when = "if Cthulhu is summoned by";
601 break;
602 }
603 LOG_ERROR("The '%s' command must be used %s 'init'.",
604 c->name, when);
605 return ERROR_FAIL;
606 }
607
608 struct command_invocation cmd = {
609 .ctx = context,
610 .current = c,
611 .name = c->name,
612 .argc = num_words - 1,
613 .argv = words + 1,
614 };
615 /* Black magic of overridden current target:
616 * If the command we are going to handle has a target prefix,
617 * override the current target temporarily for the time
618 * of processing the command.
619 * current_target_override is used also for event handlers
620 * therefore we prevent touching it if command has no prefix.
621 * Previous override is saved and restored back to ensure
622 * correct work when run_command() is re-entered. */
623 struct target *saved_target_override = context->current_target_override;
624 if (c->jim_handler_data)
625 context->current_target_override = c->jim_handler_data;
626
627 int retval = c->handler(&cmd);
628
629 if (c->jim_handler_data)
630 context->current_target_override = saved_target_override;
631
632 if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
633 /* Print help for command */
634 char *full_name = command_name(c, ' ');
635 if (NULL != full_name) {
636 command_run_linef(context, "usage %s", full_name);
637 free(full_name);
638 }
639 } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
640 /* just fall through for a shutdown request */
641 } else if (retval != ERROR_OK) {
642 /* we do not print out an error message because the command *should*
643 * have printed out an error
644 */
645 char *full_name = command_name(c, ' ');
646 LOG_DEBUG("Command '%s' failed with error code %d",
647 full_name ? full_name : c->name, retval);
648 free(full_name);
649 }
650
651 return retval;
652 }
653
654 int command_run_line(struct command_context *context, char *line)
655 {
656 /* all the parent commands have been registered with the interpreter
657 * so, can just evaluate the line as a script and check for
658 * results
659 */
660 /* run the line thru a script engine */
661 int retval = ERROR_FAIL;
662 int retcode;
663 /* Beware! This code needs to be reentrant. It is also possible
664 * for OpenOCD commands to be invoked directly from Tcl. This would
665 * happen when the Jim Tcl interpreter is provided by eCos for
666 * instance.
667 */
668 context->current_target_override = NULL;
669
670 Jim_Interp *interp = context->interp;
671 Jim_DeleteAssocData(interp, "context");
672 retcode = Jim_SetAssocData(interp, "context", NULL, context);
673 if (retcode == JIM_OK) {
674 /* associated the return value */
675 Jim_DeleteAssocData(interp, "retval");
676 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
677 if (retcode == JIM_OK) {
678 retcode = Jim_Eval_Named(interp, line, 0, 0);
679
680 Jim_DeleteAssocData(interp, "retval");
681 }
682 Jim_DeleteAssocData(interp, "context");
683 }
684 if (retcode == JIM_OK) {
685 const char *result;
686 int reslen;
687
688 result = Jim_GetString(Jim_GetResult(interp), &reslen);
689 if (reslen > 0) {
690 int i;
691 char buff[256 + 1];
692 for (i = 0; i < reslen; i += 256) {
693 int chunk;
694 chunk = reslen - i;
695 if (chunk > 256)
696 chunk = 256;
697 strncpy(buff, result + i, chunk);
698 buff[chunk] = 0;
699 LOG_USER_N("%s", buff);
700 }
701 LOG_USER_N("\n");
702 }
703 retval = ERROR_OK;
704 } else if (retcode == JIM_EXIT) {
705 /* ignore.
706 * exit(Jim_GetExitCode(interp)); */
707 } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
708 return retcode;
709 } else {
710 Jim_MakeErrorMessage(interp);
711 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
712
713 if (retval == ERROR_OK) {
714 /* It wasn't a low level OpenOCD command that failed */
715 return ERROR_FAIL;
716 }
717 return retval;
718 }
719
720 return retval;
721 }
722
723 int command_run_linef(struct command_context *context, const char *format, ...)
724 {
725 int retval = ERROR_FAIL;
726 char *string;
727 va_list ap;
728 va_start(ap, format);
729 string = alloc_vprintf(format, ap);
730 if (string != NULL) {
731 retval = command_run_line(context, string);
732 free(string);
733 }
734 va_end(ap);
735 return retval;
736 }
737
738 void command_set_output_handler(struct command_context *context,
739 command_output_handler_t output_handler, void *priv)
740 {
741 context->output_handler = output_handler;
742 context->output_handler_priv = priv;
743 }
744
745 struct command_context *copy_command_context(struct command_context *context)
746 {
747 struct command_context *copy_context = malloc(sizeof(struct command_context));
748
749 *copy_context = *context;
750
751 return copy_context;
752 }
753
754 void command_done(struct command_context *cmd_ctx)
755 {
756 if (NULL == cmd_ctx)
757 return;
758
759 free(cmd_ctx);
760 }
761
762 /* find full path to file */
763 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
764 {
765 if (argc != 2)
766 return JIM_ERR;
767 const char *file = Jim_GetString(argv[1], NULL);
768 char *full_path = find_file(file);
769 if (full_path == NULL)
770 return JIM_ERR;
771 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
772 free(full_path);
773
774 Jim_SetResult(interp, result);
775 return JIM_OK;
776 }
777
778 COMMAND_HANDLER(jim_echo)
779 {
780 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
781 LOG_USER_N("%s", CMD_ARGV[1]);
782 return JIM_OK;
783 }
784 if (CMD_ARGC != 1)
785 return JIM_ERR;
786 LOG_USER("%s", CMD_ARGV[0]);
787 return JIM_OK;
788 }
789
790 /* Capture progress output and return as tcl return value. If the
791 * progress output was empty, return tcl return value.
792 */
793 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
794 {
795 if (argc != 2)
796 return JIM_ERR;
797
798 struct log_capture_state *state = command_log_capture_start(interp);
799
800 /* disable polling during capture. This avoids capturing output
801 * from polling.
802 *
803 * This is necessary in order to avoid accidentally getting a non-empty
804 * string for tcl fn's.
805 */
806 bool save_poll = jtag_poll_get_enabled();
807
808 jtag_poll_set_enabled(false);
809
810 const char *str = Jim_GetString(argv[1], NULL);
811 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
812
813 jtag_poll_set_enabled(save_poll);
814
815 command_log_capture_finish(state);
816
817 return retcode;
818 }
819
820 static COMMAND_HELPER(command_help_find, struct command *head,
821 struct command **out)
822 {
823 if (0 == CMD_ARGC)
824 return ERROR_COMMAND_SYNTAX_ERROR;
825 *out = command_find(head, CMD_ARGV[0]);
826 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
827 *out = command_find(head, CMD_ARGV[0] + 4);
828 if (NULL == *out)
829 return ERROR_COMMAND_SYNTAX_ERROR;
830 if (--CMD_ARGC == 0)
831 return ERROR_OK;
832 CMD_ARGV++;
833 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
834 }
835
836 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
837 bool show_help, const char *cmd_match);
838
839 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
840 bool show_help, const char *cmd_match)
841 {
842 for (struct command *c = head; NULL != c; c = c->next)
843 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, cmd_match);
844 return ERROR_OK;
845 }
846
847 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
848
849 static void command_help_show_indent(unsigned n)
850 {
851 for (unsigned i = 0; i < n; i++)
852 LOG_USER_N(" ");
853 }
854 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
855 {
856 const char *cp = str, *last = str;
857 while (*cp) {
858 const char *next = last;
859 do {
860 cp = next;
861 do {
862 next++;
863 } while (*next != ' ' && *next != '\t' && *next != '\0');
864 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
865 if (next - last < HELP_LINE_WIDTH(n))
866 cp = next;
867 command_help_show_indent(n);
868 LOG_USER("%.*s", (int)(cp - last), last);
869 last = cp + 1;
870 n = n2;
871 }
872 }
873
874 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
875 bool show_help, const char *cmd_match)
876 {
877 char *cmd_name = command_name(c, ' ');
878 if (NULL == cmd_name)
879 return ERROR_FAIL;
880
881 /* If the match string occurs anywhere, we print out
882 * stuff for this command. */
883 bool is_match = (strstr(cmd_name, cmd_match) != NULL) ||
884 ((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) ||
885 ((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
886
887 if (is_match) {
888 command_help_show_indent(n);
889 LOG_USER_N("%s", cmd_name);
890 }
891 free(cmd_name);
892
893 if (is_match) {
894 if (c->usage && strlen(c->usage) > 0) {
895 LOG_USER_N(" ");
896 command_help_show_wrap(c->usage, 0, n + 5);
897 } else
898 LOG_USER_N("\n");
899 }
900
901 if (is_match && show_help) {
902 char *msg;
903
904 /* Normal commands are runtime-only; highlight exceptions */
905 if (c->mode != COMMAND_EXEC) {
906 const char *stage_msg = "";
907
908 switch (c->mode) {
909 case COMMAND_CONFIG:
910 stage_msg = " (configuration command)";
911 break;
912 case COMMAND_ANY:
913 stage_msg = " (command valid any time)";
914 break;
915 default:
916 stage_msg = " (?mode error?)";
917 break;
918 }
919 msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
920 } else
921 msg = alloc_printf("%s", c->help ? : "");
922
923 if (NULL != msg) {
924 command_help_show_wrap(msg, n + 3, n + 3);
925 free(msg);
926 } else
927 return -ENOMEM;
928 }
929
930 if (++n > 5) {
931 LOG_ERROR("command recursion exceeded");
932 return ERROR_FAIL;
933 }
934
935 return CALL_COMMAND_HANDLER(command_help_show_list,
936 c->children, n, show_help, cmd_match);
937 }
938
939 COMMAND_HANDLER(handle_help_command)
940 {
941 bool full = strcmp(CMD_NAME, "help") == 0;
942 int retval;
943 struct command *c = CMD_CTX->commands;
944 char *cmd_match = NULL;
945
946 if (CMD_ARGC == 0)
947 cmd_match = "";
948 else if (CMD_ARGC >= 1) {
949 unsigned i;
950
951 for (i = 0; i < CMD_ARGC; ++i) {
952 if (NULL != cmd_match) {
953 char *prev = cmd_match;
954
955 cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]);
956 free(prev);
957 if (NULL == cmd_match) {
958 LOG_ERROR("unable to build search string");
959 return -ENOMEM;
960 }
961 } else {
962 cmd_match = alloc_printf("%s", CMD_ARGV[i]);
963 if (NULL == cmd_match) {
964 LOG_ERROR("unable to build search string");
965 return -ENOMEM;
966 }
967 }
968 }
969 } else
970 return ERROR_COMMAND_SYNTAX_ERROR;
971
972 retval = CALL_COMMAND_HANDLER(command_help_show_list,
973 c, 0, full, cmd_match);
974
975 if (CMD_ARGC >= 1)
976 free(cmd_match);
977 return retval;
978 }
979
980 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
981 struct command *head, struct command **out, bool top_level)
982 {
983 if (0 == argc)
984 return argc;
985 const char *cmd_name = Jim_GetString(argv[0], NULL);
986 struct command *c = command_find(head, cmd_name);
987 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
988 c = command_find(head, cmd_name + 4);
989 if (NULL == c)
990 return argc;
991 *out = c;
992 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
993 }
994
995 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
996 {
997 const char *cmd_name = Jim_GetString(argv[0], NULL);
998 if (strcmp(cmd_name, "unknown") == 0) {
999 if (argc == 1)
1000 return JIM_OK;
1001 argc--;
1002 argv++;
1003 }
1004 script_debug(interp, cmd_name, argc, argv);
1005
1006 struct command_context *cmd_ctx = current_command_context(interp);
1007 struct command *c = cmd_ctx->commands;
1008 int remaining = command_unknown_find(argc, argv, c, &c, true);
1009 /* if nothing could be consumed, then it's really an unknown command */
1010 if (remaining == argc) {
1011 const char *cmd = Jim_GetString(argv[0], NULL);
1012 LOG_ERROR("Unknown command:\n %s", cmd);
1013 return JIM_OK;
1014 }
1015
1016 bool found = true;
1017 Jim_Obj *const *start;
1018 unsigned count;
1019 if (c->handler || c->jim_handler) {
1020 /* include the command name in the list */
1021 count = remaining + 1;
1022 start = argv + (argc - remaining - 1);
1023 } else {
1024 c = command_find(cmd_ctx->commands, "usage");
1025 if (NULL == c) {
1026 LOG_ERROR("unknown command, but usage is missing too");
1027 return JIM_ERR;
1028 }
1029 count = argc - remaining;
1030 start = argv;
1031 found = false;
1032 }
1033 /* pass the command through to the intended handler */
1034 if (c->jim_handler) {
1035 interp->cmdPrivData = c->jim_handler_data;
1036 return (*c->jim_handler)(interp, count, start);
1037 }
1038
1039 return script_command_run(interp, count, start, c, found);
1040 }
1041
1042 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1043 {
1044 struct command_context *cmd_ctx = current_command_context(interp);
1045 enum command_mode mode;
1046
1047 if (argc > 1) {
1048 struct command *c = cmd_ctx->commands;
1049 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1050 /* if nothing could be consumed, then it's an unknown command */
1051 if (remaining == argc - 1) {
1052 Jim_SetResultString(interp, "unknown", -1);
1053 return JIM_OK;
1054 }
1055 mode = c->mode;
1056 } else
1057 mode = cmd_ctx->mode;
1058
1059 const char *mode_str;
1060 switch (mode) {
1061 case COMMAND_ANY:
1062 mode_str = "any";
1063 break;
1064 case COMMAND_CONFIG:
1065 mode_str = "config";
1066 break;
1067 case COMMAND_EXEC:
1068 mode_str = "exec";
1069 break;
1070 default:
1071 mode_str = "unknown";
1072 break;
1073 }
1074 Jim_SetResultString(interp, mode_str, -1);
1075 return JIM_OK;
1076 }
1077
1078 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1079 {
1080 if (1 == argc)
1081 return JIM_ERR;
1082
1083 struct command_context *cmd_ctx = current_command_context(interp);
1084 struct command *c = cmd_ctx->commands;
1085 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1086 /* if nothing could be consumed, then it's an unknown command */
1087 if (remaining == argc - 1) {
1088 Jim_SetResultString(interp, "unknown", -1);
1089 return JIM_OK;
1090 }
1091
1092 if (c->jim_handler)
1093 Jim_SetResultString(interp, "native", -1);
1094 else if (c->handler)
1095 Jim_SetResultString(interp, "simple", -1);
1096 else if (remaining == 0)
1097 Jim_SetResultString(interp, "group", -1);
1098 else
1099 Jim_SetResultString(interp, "unknown", -1);
1100
1101 return JIM_OK;
1102 }
1103
1104 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1105 const char *cmd_name, const char *help_text, const char *usage)
1106 {
1107 struct command **head = command_list_for_parent(cmd_ctx, parent);
1108 struct command *nc = command_find(*head, cmd_name);
1109 if (NULL == nc) {
1110 /* add a new command with help text */
1111 struct command_registration cr = {
1112 .name = cmd_name,
1113 .mode = COMMAND_ANY,
1114 .help = help_text,
1115 .usage = usage,
1116 };
1117 nc = register_command(cmd_ctx, parent, &cr);
1118 if (NULL == nc) {
1119 LOG_ERROR("failed to add '%s' help text", cmd_name);
1120 return ERROR_FAIL;
1121 }
1122 LOG_DEBUG("added '%s' help text", cmd_name);
1123 return ERROR_OK;
1124 }
1125 if (help_text) {
1126 bool replaced = false;
1127 if (nc->help) {
1128 free(nc->help);
1129 replaced = true;
1130 }
1131 nc->help = strdup(help_text);
1132 if (replaced)
1133 LOG_INFO("replaced existing '%s' help", cmd_name);
1134 else
1135 LOG_DEBUG("added '%s' help text", cmd_name);
1136 }
1137 if (usage) {
1138 bool replaced = false;
1139 if (nc->usage) {
1140 free(nc->usage);
1141 replaced = true;
1142 }
1143 nc->usage = strdup(usage);
1144 if (replaced)
1145 LOG_INFO("replaced existing '%s' usage", cmd_name);
1146 else
1147 LOG_DEBUG("added '%s' usage text", cmd_name);
1148 }
1149 return ERROR_OK;
1150 }
1151
1152 COMMAND_HANDLER(handle_help_add_command)
1153 {
1154 if (CMD_ARGC < 2) {
1155 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1156 return ERROR_COMMAND_SYNTAX_ERROR;
1157 }
1158
1159 /* save help text and remove it from argument list */
1160 const char *str = CMD_ARGV[--CMD_ARGC];
1161 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1162 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1163 if (!help && !usage) {
1164 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1165 return ERROR_COMMAND_SYNTAX_ERROR;
1166 }
1167 /* likewise for the leaf command name */
1168 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1169
1170 struct command *c = NULL;
1171 if (CMD_ARGC > 0) {
1172 c = CMD_CTX->commands;
1173 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1174 if (ERROR_OK != retval)
1175 return retval;
1176 }
1177 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1178 }
1179
1180 /* sleep command sleeps for <n> milliseconds
1181 * this is useful in target startup scripts
1182 */
1183 COMMAND_HANDLER(handle_sleep_command)
1184 {
1185 bool busy = false;
1186 if (CMD_ARGC == 2) {
1187 if (strcmp(CMD_ARGV[1], "busy") == 0)
1188 busy = true;
1189 else
1190 return ERROR_COMMAND_SYNTAX_ERROR;
1191 } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1192 return ERROR_COMMAND_SYNTAX_ERROR;
1193
1194 unsigned long duration = 0;
1195 int retval = parse_ulong(CMD_ARGV[0], &duration);
1196 if (ERROR_OK != retval)
1197 return retval;
1198
1199 if (!busy) {
1200 int64_t then = timeval_ms();
1201 while (timeval_ms() - then < (int64_t)duration) {
1202 target_call_timer_callbacks_now();
1203 usleep(1000);
1204 }
1205 } else
1206 busy_sleep(duration);
1207
1208 return ERROR_OK;
1209 }
1210
1211 static const struct command_registration command_subcommand_handlers[] = {
1212 {
1213 .name = "mode",
1214 .mode = COMMAND_ANY,
1215 .jim_handler = jim_command_mode,
1216 .usage = "[command_name ...]",
1217 .help = "Returns the command modes allowed by a command:"
1218 "'any', 'config', or 'exec'. If no command is"
1219 "specified, returns the current command mode. "
1220 "Returns 'unknown' if an unknown command is given. "
1221 "Command can be multiple tokens.",
1222 },
1223 {
1224 .name = "type",
1225 .mode = COMMAND_ANY,
1226 .jim_handler = jim_command_type,
1227 .usage = "command_name [...]",
1228 .help = "Returns the type of built-in command:"
1229 "'native', 'simple', 'group', or 'unknown'. "
1230 "Command can be multiple tokens.",
1231 },
1232 COMMAND_REGISTRATION_DONE
1233 };
1234
1235 static const struct command_registration command_builtin_handlers[] = {
1236 {
1237 .name = "echo",
1238 .handler = jim_echo,
1239 .mode = COMMAND_ANY,
1240 .help = "Logs a message at \"user\" priority. "
1241 "Output message to stdout. "
1242 "Option \"-n\" suppresses trailing newline",
1243 .usage = "[-n] string",
1244 },
1245 {
1246 .name = "add_help_text",
1247 .handler = handle_help_add_command,
1248 .mode = COMMAND_ANY,
1249 .help = "Add new command help text; "
1250 "Command can be multiple tokens.",
1251 .usage = "command_name helptext_string",
1252 },
1253 {
1254 .name = "add_usage_text",
1255 .handler = handle_help_add_command,
1256 .mode = COMMAND_ANY,
1257 .help = "Add new command usage text; "
1258 "command can be multiple tokens.",
1259 .usage = "command_name usage_string",
1260 },
1261 {
1262 .name = "sleep",
1263 .handler = handle_sleep_command,
1264 .mode = COMMAND_ANY,
1265 .help = "Sleep for specified number of milliseconds. "
1266 "\"busy\" will busy wait instead (avoid this).",
1267 .usage = "milliseconds ['busy']",
1268 },
1269 {
1270 .name = "help",
1271 .handler = handle_help_command,
1272 .mode = COMMAND_ANY,
1273 .help = "Show full command help; "
1274 "command can be multiple tokens.",
1275 .usage = "[command_name]",
1276 },
1277 {
1278 .name = "usage",
1279 .handler = handle_help_command,
1280 .mode = COMMAND_ANY,
1281 .help = "Show basic command usage; "
1282 "command can be multiple tokens.",
1283 .usage = "[command_name]",
1284 },
1285 {
1286 .name = "command",
1287 .mode = COMMAND_ANY,
1288 .help = "core command group (introspection)",
1289 .chain = command_subcommand_handlers,
1290 },
1291 COMMAND_REGISTRATION_DONE
1292 };
1293
1294 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
1295 {
1296 struct command_context *context = calloc(1, sizeof(struct command_context));
1297 const char *HostOs;
1298
1299 context->mode = COMMAND_EXEC;
1300
1301 /* Create a jim interpreter if we were not handed one */
1302 if (interp == NULL) {
1303 /* Create an interpreter */
1304 interp = Jim_CreateInterp();
1305 /* Add all the Jim core commands */
1306 Jim_RegisterCoreCommands(interp);
1307 Jim_InitStaticExtensions(interp);
1308 }
1309
1310 context->interp = interp;
1311
1312 /* Stick to lowercase for HostOS strings. */
1313 #if defined(_MSC_VER)
1314 /* WinXX - is generic, the forward
1315 * looking problem is this:
1316 *
1317 * "win32" or "win64"
1318 *
1319 * "winxx" is generic.
1320 */
1321 HostOs = "winxx";
1322 #elif defined(__linux__)
1323 HostOs = "linux";
1324 #elif defined(__APPLE__) || defined(__DARWIN__)
1325 HostOs = "darwin";
1326 #elif defined(__CYGWIN__)
1327 HostOs = "cygwin";
1328 #elif defined(__MINGW32__)
1329 HostOs = "mingw32";
1330 #elif defined(__ECOS)
1331 HostOs = "ecos";
1332 #elif defined(__FreeBSD__)
1333 HostOs = "freebsd";
1334 #elif defined(__NetBSD__)
1335 HostOs = "netbsd";
1336 #elif defined(__OpenBSD__)
1337 HostOs = "openbsd";
1338 #else
1339 #warning "Unrecognized host OS..."
1340 HostOs = "other";
1341 #endif
1342 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1343 Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
1344
1345 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1346 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1347
1348 register_commands(context, NULL, command_builtin_handlers);
1349
1350 Jim_SetAssocData(interp, "context", NULL, context);
1351 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
1352 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1353 Jim_MakeErrorMessage(interp);
1354 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1355 exit(-1);
1356 }
1357 Jim_DeleteAssocData(interp, "context");
1358
1359 return context;
1360 }
1361
1362 void command_exit(struct command_context *context)
1363 {
1364 if (!context)
1365 return;
1366
1367 Jim_FreeInterp(context->interp);
1368 command_done(context);
1369 }
1370
1371 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1372 {
1373 if (!cmd_ctx)
1374 return ERROR_COMMAND_SYNTAX_ERROR;
1375
1376 cmd_ctx->mode = mode;
1377 return ERROR_OK;
1378 }
1379
1380 void process_jim_events(struct command_context *cmd_ctx)
1381 {
1382 static int recursion;
1383 if (recursion)
1384 return;
1385
1386 recursion++;
1387 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1388 recursion--;
1389 }
1390
1391 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1392 int parse ## name(const char *str, type * ul) \
1393 { \
1394 if (!*str) { \
1395 LOG_ERROR("Invalid command argument"); \
1396 return ERROR_COMMAND_ARGUMENT_INVALID; \
1397 } \
1398 char *end; \
1399 *ul = func(str, &end, 0); \
1400 if (*end) { \
1401 LOG_ERROR("Invalid command argument"); \
1402 return ERROR_COMMAND_ARGUMENT_INVALID; \
1403 } \
1404 if ((max == *ul) && (ERANGE == errno)) { \
1405 LOG_ERROR("Argument overflow"); \
1406 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1407 } \
1408 if (min && (min == *ul) && (ERANGE == errno)) { \
1409 LOG_ERROR("Argument underflow"); \
1410 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1411 } \
1412 return ERROR_OK; \
1413 }
1414 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
1415 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1416 DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
1417 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1418
1419 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1420 int parse ## name(const char *str, type * ul) \
1421 { \
1422 functype n; \
1423 int retval = parse ## funcname(str, &n); \
1424 if (ERROR_OK != retval) \
1425 return retval; \
1426 if (n > max) \
1427 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1428 if (min) \
1429 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1430 *ul = n; \
1431 return ERROR_OK; \
1432 }
1433
1434 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1435 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1436 DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
1437 DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
1438 DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
1439 DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
1440 DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
1441
1442 DEFINE_PARSE_ULONGLONG(_target_addr, target_addr_t, 0, TARGET_ADDR_MAX)
1443
1444 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1445 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1446 DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
1447 DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
1448 DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1449 DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1450 DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1451
1452 static int command_parse_bool(const char *in, bool *out,
1453 const char *on, const char *off)
1454 {
1455 if (strcasecmp(in, on) == 0)
1456 *out = true;
1457 else if (strcasecmp(in, off) == 0)
1458 *out = false;
1459 else
1460 return ERROR_COMMAND_SYNTAX_ERROR;
1461 return ERROR_OK;
1462 }
1463
1464 int command_parse_bool_arg(const char *in, bool *out)
1465 {
1466 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1467 return ERROR_OK;
1468 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1469 return ERROR_OK;
1470 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1471 return ERROR_OK;
1472 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1473 return ERROR_OK;
1474 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1475 return ERROR_OK;
1476 return ERROR_COMMAND_SYNTAX_ERROR;
1477 }
1478
1479 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1480 {
1481 switch (CMD_ARGC) {
1482 case 1: {
1483 const char *in = CMD_ARGV[0];
1484 if (command_parse_bool_arg(in, out) != ERROR_OK) {
1485 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1486 return ERROR_COMMAND_SYNTAX_ERROR;
1487 }
1488 }
1489 /* fallthrough */
1490 case 0:
1491 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1492 break;
1493 default:
1494 return ERROR_COMMAND_SYNTAX_ERROR;
1495 }
1496 return ERROR_OK;
1497 }