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