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