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