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