git.gag.com Git - fw/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 bool command_can_run(struct command_context *cmd_ctx, struct command *c)
 529 {
 530         return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
 531 }
 532
 533 static int run_command(struct command_context *context,
 534                 struct command *c, const char *words[], unsigned num_words)
 535 {
 536         if (!command_can_run(context, c))
 537         {
 538                 /* Config commands can not run after the config stage */
 539                 LOG_ERROR("The '%s' command must be used before 'init'.", c->name);
 540                 return ERROR_FAIL;
 541         }
 542
 543         struct command_invocation cmd = {
 544                         .ctx = context,
 545                         .name = c->name,
 546                         .argc = num_words - 1,
 547                         .argv = words + 1,
 548                 };
 549         int retval = c->handler(&cmd);
 550         if (retval == ERROR_COMMAND_SYNTAX_ERROR)
 551         {
 552                 /* Print help for command */
 553                 char *full_name = command_name(c, ' ');
 554                 if (NULL != full_name) {
 555                         command_run_linef(context, "help %s", full_name);
 556                         free(full_name);
 557                 } else
 558                         retval = -ENOMEM;
 559         }
 560         else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
 561         {
 562                 /* just fall through for a shutdown request */
 563         }
 564         else if (retval != ERROR_OK)
 565         {
 566                 /* we do not print out an error message because the command *should*
 567                  * have printed out an error
 568                  */
 569                 LOG_DEBUG("Command failed with error code %d", retval);
 570         }
 571
 572         return retval;
 573 }
 574
 575 int command_run_line(struct command_context *context, char *line)
 576 {
 577         /* all the parent commands have been registered with the interpreter
 578          * so, can just evaluate the line as a script and check for
 579          * results
 580          */
 581         /* run the line thru a script engine */
 582         int retval = ERROR_FAIL;
 583         int retcode;
 584         /* Beware! This code needs to be reentrant. It is also possible
 585          * for OpenOCD commands to be invoked directly from Tcl. This would
 586          * happen when the Jim Tcl interpreter is provided by eCos for
 587          * instance.
 588          */
 589         Jim_DeleteAssocData(interp, "context");
 590         retcode = Jim_SetAssocData(interp, "context", NULL, context);
 591         if (retcode == JIM_OK)
 592         {
 593                 /* associated the return value */
 594                 Jim_DeleteAssocData(interp, "retval");
 595                 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
 596                 if (retcode == JIM_OK)
 597                 {
 598                         retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
 599
 600                         Jim_DeleteAssocData(interp, "retval");
 601                 }
 602                 Jim_DeleteAssocData(interp, "context");
 603         }
 604         if (retcode == JIM_ERR) {
 605                 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
 606                 {
 607                         /* We do not print the connection closed error message */
 608                         Jim_PrintErrorMessage(interp);
 609                 }
 610                 if (retval == ERROR_OK)
 611                 {
 612                         /* It wasn't a low level OpenOCD command that failed */
 613                         return ERROR_FAIL;
 614                 }
 615                 return retval;
 616         } else if (retcode == JIM_EXIT) {
 617                 /* ignore. */
 618                 /* exit(Jim_GetExitCode(interp)); */
 619         } else {
 620                 const char *result;
 621                 int reslen;
 622
 623                 result = Jim_GetString(Jim_GetResult(interp), &reslen);
 624                 if (reslen > 0)
 625                 {
 626                         int i;
 627                         char buff[256 + 1];
 628                         for (i = 0; i < reslen; i += 256)
 629                         {
 630                                 int chunk;
 631                                 chunk = reslen - i;
 632                                 if (chunk > 256)
 633                                         chunk = 256;
 634                                 strncpy(buff, result + i, chunk);
 635                                 buff[chunk] = 0;
 636                                 LOG_USER_N("%s", buff);
 637                         }
 638                         LOG_USER_N("%s", "\n");
 639                 }
 640                 retval = ERROR_OK;
 641         }
 642         return retval;
 643 }
 644
 645 int command_run_linef(struct command_context *context, const char *format, ...)
 646 {
 647         int retval = ERROR_FAIL;
 648         char *string;
 649         va_list ap;
 650         va_start(ap, format);
 651         string = alloc_vprintf(format, ap);
 652         if (string != NULL)
 653         {
 654                 retval = command_run_line(context, string);
 655         }
 656         va_end(ap);
 657         return retval;
 658 }
 659
 660 void command_set_output_handler(struct command_context* context,
 661                 command_output_handler_t output_handler, void *priv)
 662 {
 663         context->output_handler = output_handler;
 664         context->output_handler_priv = priv;
 665 }
 666
 667 struct command_context* copy_command_context(struct command_context* context)
 668 {
 669         struct command_context* copy_context = malloc(sizeof(struct command_context));
 670
 671         *copy_context = *context;
 672
 673         return copy_context;
 674 }
 675
 676 int command_done(struct command_context *context)
 677 {
 678         free(context);
 679         context = NULL;
 680
 681         return ERROR_OK;
 682 }
 683
 684 /* find full path to file */
 685 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 686 {
 687         if (argc != 2)
 688                 return JIM_ERR;
 689         const char *file = Jim_GetString(argv[1], NULL);
 690         char *full_path = find_file(file);
 691         if (full_path == NULL)
 692                 return JIM_ERR;
 693         Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
 694         free(full_path);
 695
 696         Jim_SetResult(interp, result);
 697         return JIM_OK;
 698 }
 699
 700 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 701 {
 702         if (argc != 2)
 703                 return JIM_ERR;
 704         const char *str = Jim_GetString(argv[1], NULL);
 705         LOG_USER("%s", str);
 706         return JIM_OK;
 707 }
 708
 709 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
 710 {
 711         size_t nbytes;
 712         const char *ptr;
 713         Jim_Interp *interp;
 714
 715         /* make it a char easier to read code */
 716         ptr = _ptr;
 717         interp = cookie;
 718         nbytes = size * n;
 719         if (ptr == NULL || interp == NULL || nbytes == 0) {
 720                 return 0;
 721         }
 722
 723         /* do we have to chunk it? */
 724         if (ptr[nbytes] == 0)
 725         {
 726                 /* no it is a C style string */
 727                 LOG_USER_N("%s", ptr);
 728                 return strlen(ptr);
 729         }
 730         /* GRR we must chunk - not null terminated */
 731         while (nbytes) {
 732                 char chunk[128 + 1];
 733                 int x;
 734
 735                 x = nbytes;
 736                 if (x > 128) {
 737                         x = 128;
 738                 }
 739                 /* copy it */
 740                 memcpy(chunk, ptr, x);
 741                 /* terminate it */
 742                 chunk[n] = 0;
 743                 /* output it */
 744                 LOG_USER_N("%s", chunk);
 745                 ptr += x;
 746                 nbytes -= x;
 747         }
 748
 749         return n;
 750 }
 751
 752 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
 753 {
 754         /* TCL wants to read... tell him no */
 755         return 0;
 756 }
 757
 758 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
 759 {
 760         char *cp;
 761         int n;
 762         Jim_Interp *interp;
 763
 764         n = -1;
 765         interp = cookie;
 766         if (interp == NULL)
 767                 return n;
 768
 769         cp = alloc_vprintf(fmt, ap);
 770         if (cp)
 771         {
 772                 LOG_USER_N("%s", cp);
 773                 n = strlen(cp);
 774                 free(cp);
 775         }
 776         return n;
 777 }
 778
 779 static int openocd_jim_fflush(void *cookie)
 780 {
 781         /* nothing to flush */
 782         return 0;
 783 }
 784
 785 static char* openocd_jim_fgets(char *s, int size, void *cookie)
 786 {
 787         /* not supported */
 788         errno = ENOTSUP;
 789         return NULL;
 790 }
 791
 792 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 793 {
 794         if (argc != 2)
 795                 return JIM_ERR;
 796
 797         Jim_Obj *tclOutput = command_log_capture_start(interp);
 798
 799         const char *str = Jim_GetString(argv[1], NULL);
 800         int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
 801
 802         command_log_capture_finish(interp, tclOutput);
 803
 804         return retcode;
 805 }
 806
 807 static COMMAND_HELPER(command_help_find, struct command *head,
 808                 struct command **out)
 809 {
 810         if (0 == CMD_ARGC)
 811                 return ERROR_INVALID_ARGUMENTS;
 812         *out = command_find(head, CMD_ARGV[0]);
 813         if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
 814                 *out = command_find(head, CMD_ARGV[0] + 4);
 815         if (NULL == *out)
 816                 return ERROR_INVALID_ARGUMENTS;
 817         if (--CMD_ARGC == 0)
 818                 return ERROR_OK;
 819         CMD_ARGV++;
 820         return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
 821 }
 822
 823 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 824                 bool show_help);
 825
 826 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
 827                 bool show_help)
 828 {
 829         for (struct command *c = head; NULL != c; c = c->next)
 830                 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help);
 831         return ERROR_OK;
 832 }
 833
 834 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
 835
 836 static void command_help_show_indent(unsigned n)
 837 {
 838         for (unsigned i = 0; i < n; i++)
 839                 LOG_USER_N("  ");
 840 }
 841 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
 842 {
 843         const char *cp = str, *last = str;
 844         while (*cp)
 845         {
 846                 const char *next = last;
 847                 do {
 848                         cp = next;
 849                         do {
 850                                 next++;
 851                         } while (*next != ' ' && *next != '\t' && *next != '\0');
 852                 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
 853                 if (next - last < HELP_LINE_WIDTH(n))
 854                         cp = next;
 855                 command_help_show_indent(n);
 856                 LOG_USER_N("%.*s", (int)(cp - last), last);
 857                 LOG_USER_N("\n");
 858                 last = cp + 1;
 859                 n = n2;
 860         }
 861 }
 862 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 863                 bool show_help)
 864 {
 865         char *cmd_name = command_name(c, ' ');
 866         if (NULL == cmd_name)
 867                 return -ENOMEM;
 868
 869         command_help_show_indent(n);
 870         LOG_USER_N("%s", cmd_name);
 871         free(cmd_name);
 872
 873         if (c->usage) {
 874                 LOG_USER_N(" ");
 875                 command_help_show_wrap(c->usage, 0, n + 5);
 876         }
 877         else
 878                 LOG_USER_N("\n");
 879
 880         if (show_help)
 881         {
 882                 const char *stage_msg;
 883                 switch (c->mode) {
 884                 case COMMAND_CONFIG: stage_msg = "CONFIG"; break;
 885                 case COMMAND_EXEC: stage_msg = "EXEC"; break;
 886                 case COMMAND_ANY: stage_msg = "CONFIG or EXEC"; break;
 887                 default: stage_msg = "***UNKNOWN***"; break;
 888                 }
 889                 char *msg = alloc_printf("%s%sValid Modes: %s",
 890                         c->help ? : "", c->help ? "  " : "", stage_msg);
 891                 if (NULL != msg)
 892                 {
 893                         command_help_show_wrap(msg, n + 3, n + 3);
 894                         free(msg);
 895                 } else
 896                         return -ENOMEM;
 897         }
 898
 899         if (++n >= 2)
 900                 return ERROR_OK;
 901
 902         return CALL_COMMAND_HANDLER(command_help_show_list,
 903                         c->children, n, show_help);
 904 }
 905 COMMAND_HANDLER(handle_help_command)
 906 {
 907         bool full = strcmp(CMD_NAME, "help") == 0;
 908
 909         struct command *c = CMD_CTX->commands;
 910
 911         if (0 == CMD_ARGC)
 912                 return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, full);
 913
 914         int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
 915         if (ERROR_OK != retval)
 916                 return retval;
 917
 918         return CALL_COMMAND_HANDLER(command_help_show, c, 0, full);
 919 }
 920
 921 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
 922                 struct command *head, struct command **out, bool top_level)
 923 {
 924         if (0 == argc)
 925                 return argc;
 926         const char *cmd_name = Jim_GetString(argv[0], NULL);
 927         struct command *c = command_find(head, cmd_name);
 928         if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
 929                 c = command_find(head, cmd_name + 4);
 930         if (NULL == c)
 931                 return argc;
 932         *out = c;
 933         return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
 934 }
 935
 936 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 937 {
 938         const char *cmd_name = Jim_GetString(argv[0], NULL);
 939         if (strcmp(cmd_name, "unknown") == 0)
 940         {
 941                 if (argc == 1)
 942                         return JIM_OK;
 943                 argc--;
 944                 argv++;
 945         }
 946         script_debug(interp, cmd_name, argc, argv);
 947
 948         struct command_context *cmd_ctx = current_command_context();
 949         struct command *c = cmd_ctx->commands;
 950         int remaining = command_unknown_find(argc, argv, c, &c, true);
 951         // if nothing could be consumed, then it's really an unknown command
 952         if (remaining == argc)
 953         {
 954                 const char *cmd = Jim_GetString(argv[0], NULL);
 955                 LOG_ERROR("Unknown command:\n  %s", cmd);
 956                 return JIM_OK;
 957         }
 958
 959         bool found = true;
 960         Jim_Obj *const *start;
 961         unsigned count;
 962         if (c->handler || c->jim_handler)
 963         {
 964                 // include the command name in the list
 965                 count = remaining + 1;
 966                 start = argv + (argc - remaining - 1);
 967         }
 968         else
 969         {
 970                 c = command_find(cmd_ctx->commands, "help");
 971                 if (NULL == c)
 972                 {
 973                         LOG_ERROR("unknown command, but help is missing too");
 974                         return JIM_ERR;
 975                 }
 976                 count = argc - remaining;
 977                 start = argv;
 978                 found = false;
 979         }
 980         // pass the command through to the intended handler
 981         if (c->jim_handler)
 982         {
 983                 interp->cmdPrivData = c->jim_handler_data;
 984                 return (*c->jim_handler)(interp, count, start);
 985         }
 986
 987         return script_command_run(interp, count, start, c, found);
 988 }
 989
 990 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 991 {
 992         struct command_context *cmd_ctx = current_command_context();
 993         enum command_mode mode;
 994         if (argc > 1)
 995         {
 996                 struct command *c = cmd_ctx->commands;
 997                 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
 998                 // if nothing could be consumed, then it's an unknown command
 999                 if (remaining == argc - 1)
1000                 {
1001                         Jim_SetResultString(interp, "unknown", -1);
1002                         return JIM_OK;
1003                 }
1004                 mode = c->mode;
1005         }
1006         else
1007                 mode = cmd_ctx->mode;
1008
1009         const char *mode_str;
1010         switch (mode) {
1011         case COMMAND_ANY: mode_str = "any"; break;
1012         case COMMAND_CONFIG: mode_str = "config"; break;
1013         case COMMAND_EXEC: mode_str = "exec"; break;
1014         default: mode_str = "unknown"; break;
1015         }
1016         Jim_SetResultString(interp, mode_str, -1);
1017         return JIM_OK;
1018 }
1019
1020 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1021 {
1022         if (1 == argc)
1023                 return JIM_ERR;
1024
1025         struct command_context *cmd_ctx = current_command_context();
1026         struct command *c = cmd_ctx->commands;
1027         int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1028         // if nothing could be consumed, then it's an unknown command
1029         if (remaining == argc - 1)
1030         {
1031                 Jim_SetResultString(interp, "unknown", -1);
1032                 return JIM_OK;
1033         }
1034
1035         if (c->jim_handler)
1036                 Jim_SetResultString(interp, "native", -1);
1037         else if (c->handler)
1038                 Jim_SetResultString(interp, "simple", -1);
1039         else
1040                 Jim_SetResultString(interp, "group", -1);
1041
1042         return JIM_OK;
1043 }
1044
1045 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1046                 const char *cmd_name, const char *help_text, const char *usage)
1047 {
1048         struct command **head = command_list_for_parent(cmd_ctx, parent);
1049         struct command *nc = command_find(*head, cmd_name);
1050         if (NULL == nc)
1051         {
1052                 // add a new command with help text
1053                 struct command_registration cr = {
1054                                 .name = cmd_name,
1055                                 .mode = COMMAND_ANY,
1056                                 .help = help_text,
1057                                 .usage = usage,
1058                         };
1059                 nc = register_command(cmd_ctx, parent, &cr);
1060                 if (NULL == nc)
1061                 {
1062                         LOG_ERROR("failed to add '%s' help text", cmd_name);
1063                         return ERROR_FAIL;
1064                 }
1065                 LOG_DEBUG("added '%s' help text", cmd_name);
1066                 return ERROR_OK;
1067         }
1068         if (help_text)
1069         {
1070                 bool replaced = false;
1071                 if (nc->help)
1072                 {
1073                         free((void *)nc->help);
1074                         replaced = true;
1075                 }
1076                 nc->help = strdup(help_text);
1077                 if (replaced)
1078                         LOG_INFO("replaced existing '%s' help", cmd_name);
1079                 else
1080                         LOG_DEBUG("added '%s' help text", cmd_name);
1081         }
1082         if (usage)
1083         {
1084                 bool replaced = false;
1085                 if (nc->usage)
1086                 {
1087                         free((void *)nc->usage);
1088                         replaced = true;
1089                 }
1090                 nc->usage = strdup(usage);
1091                 if (replaced)
1092                         LOG_INFO("replaced existing '%s' usage", cmd_name);
1093                 else
1094                         LOG_DEBUG("added '%s' usage text", cmd_name);
1095         }
1096         return ERROR_OK;
1097 }
1098
1099 COMMAND_HANDLER(handle_help_add_command)
1100 {
1101         if (CMD_ARGC < 2)
1102         {
1103                 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1104                 return ERROR_INVALID_ARGUMENTS;
1105         }
1106
1107         // save help text and remove it from argument list
1108         const char *str = CMD_ARGV[--CMD_ARGC];
1109         const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1110         const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1111         if (!help && !usage)
1112         {
1113                 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1114                 return ERROR_INVALID_ARGUMENTS;
1115         }
1116         // likewise for the leaf command name
1117         const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1118
1119         struct command *c = NULL;
1120         if (CMD_ARGC > 0)
1121         {
1122                 c = CMD_CTX->commands;
1123                 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1124                 if (ERROR_OK != retval)
1125                         return retval;
1126         }
1127         return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1128 }
1129
1130 /* sleep command sleeps for <n> miliseconds
1131  * this is useful in target startup scripts
1132  */
1133 COMMAND_HANDLER(handle_sleep_command)
1134 {
1135         bool busy = false;
1136         if (CMD_ARGC == 2)
1137         {
1138                 if (strcmp(CMD_ARGV[1], "busy") == 0)
1139                         busy = true;
1140                 else
1141                         return ERROR_COMMAND_SYNTAX_ERROR;
1142         }
1143         else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1144                 return ERROR_COMMAND_SYNTAX_ERROR;
1145
1146         unsigned long duration = 0;
1147         int retval = parse_ulong(CMD_ARGV[0], &duration);
1148         if (ERROR_OK != retval)
1149                 return retval;
1150
1151         if (!busy)
1152         {
1153                 long long then = timeval_ms();
1154                 while (timeval_ms() - then < (long long)duration)
1155                 {
1156                         target_call_timer_callbacks_now();
1157                         usleep(1000);
1158                 }
1159         }
1160         else
1161                 busy_sleep(duration);
1162
1163         return ERROR_OK;
1164 }
1165
1166 static const struct command_registration command_subcommand_handlers[] = {
1167         {
1168                 .name = "mode",
1169                 .mode = COMMAND_ANY,
1170                 .jim_handler = &jim_command_mode,
1171                 .usage = "[<name> ...]",
1172                 .help = "Returns the command modes allowed by a  command:"
1173                         "'any', 'config', or 'exec'.  If no command is"
1174                         "specified, returns the current command mode.",
1175         },
1176         {
1177                 .name = "type",
1178                 .mode = COMMAND_ANY,
1179                 .jim_handler = &jim_command_type,
1180                 .usage = "<name> ...",
1181                 .help = "Returns the type of built-in command:"
1182                         "'native', 'simple', 'group', or 'unknown'",
1183         },
1184         COMMAND_REGISTRATION_DONE
1185 };
1186
1187 static const struct command_registration command_builtin_handlers[] = {
1188         {
1189                 .name = "add_help_text",
1190                 .handler = &handle_help_add_command,
1191                 .mode = COMMAND_ANY,
1192                 .help = "add new command help text",
1193                 .usage = "<command> [...] <help_text>]",
1194         },
1195         {
1196                 .name = "add_usage_text",
1197                 .handler = &handle_help_add_command,
1198                 .mode = COMMAND_ANY,
1199                 .help = "add new command usage text",
1200                 .usage = "<command> [...] <usage_text>]",
1201         },
1202         {
1203                 .name = "sleep",
1204                 .handler = &handle_sleep_command,
1205                 .mode = COMMAND_ANY,
1206                 .help = "sleep for n milliseconds.  "
1207                         "\"busy\" will busy wait",
1208                 .usage = "<n> [busy]",
1209         },
1210         {
1211                 .name = "help",
1212                 .handler = &handle_help_command,
1213                 .mode = COMMAND_ANY,
1214                 .help = "show full command help",
1215                 .usage = "[<command> ...]",
1216         },
1217         {
1218                 .name = "usage",
1219                 .handler = &handle_help_command,
1220                 .mode = COMMAND_ANY,
1221                 .help = "show basic command usage",
1222                 .usage = "[<command> ...]",
1223         },
1224         {
1225                 .name = "command",
1226                 .mode= COMMAND_ANY,
1227                 .help = "core command group (introspection)",
1228                 .chain = command_subcommand_handlers,
1229         },
1230         COMMAND_REGISTRATION_DONE
1231 };
1232
1233 struct command_context* command_init(const char *startup_tcl)
1234 {
1235         struct command_context* context = malloc(sizeof(struct command_context));
1236         const char *HostOs;
1237
1238         context->mode = COMMAND_EXEC;
1239         context->commands = NULL;
1240         context->current_target = 0;
1241         context->output_handler = NULL;
1242         context->output_handler_priv = NULL;
1243
1244 #if !BUILD_ECOSBOARD
1245         Jim_InitEmbedded();
1246         /* Create an interpreter */
1247         interp = Jim_CreateInterp();
1248         /* Add all the Jim core commands */
1249         Jim_RegisterCoreCommands(interp);
1250 #endif
1251
1252 #if defined(_MSC_VER)
1253         /* WinXX - is generic, the forward
1254          * looking problem is this:
1255          *
1256          *   "win32" or "win64"
1257          *
1258          * "winxx" is generic.
1259          */
1260         HostOs = "winxx";
1261 #elif defined(__linux__)
1262         HostOs = "linux";
1263 #elif defined(__DARWIN__)
1264         HostOs = "darwin";
1265 #elif defined(__CYGWIN__)
1266         HostOs = "cygwin";
1267 #elif defined(__MINGW32__)
1268         HostOs = "mingw32";
1269 #elif defined(__ECOS)
1270         HostOs = "ecos";
1271 #else
1272 #warn unrecognized host OS...
1273         HostOs = "other";
1274 #endif
1275         Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1276                         Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1277
1278         Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1279         Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
1280         Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1281
1282         /* Set Jim's STDIO */
1283         interp->cookie_stdin = interp;
1284         interp->cookie_stdout = interp;
1285         interp->cookie_stderr = interp;
1286         interp->cb_fwrite = openocd_jim_fwrite;
1287         interp->cb_fread = openocd_jim_fread ;
1288         interp->cb_vfprintf = openocd_jim_vfprintf;
1289         interp->cb_fflush = openocd_jim_fflush;
1290         interp->cb_fgets = openocd_jim_fgets;
1291
1292         register_commands(context, NULL, command_builtin_handlers);
1293
1294 #if !BUILD_ECOSBOARD
1295         Jim_EventLoopOnLoad(interp);
1296 #endif
1297         Jim_SetAssocData(interp, "context", NULL, context);
1298         if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1299         {
1300                 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1301                 Jim_PrintErrorMessage(interp);
1302                 exit(-1);
1303         }
1304         Jim_DeleteAssocData(interp, "context");
1305
1306         return context;
1307 }
1308
1309 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1310 {
1311         if (!cmd_ctx)
1312                 return ERROR_INVALID_ARGUMENTS;
1313
1314         cmd_ctx->mode = mode;
1315         return ERROR_OK;
1316 }
1317
1318 void process_jim_events(void)
1319 {
1320 #if !BUILD_ECOSBOARD
1321         static int recursion = 0;
1322
1323         if (!recursion)
1324         {
1325                 recursion++;
1326                 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1327                 recursion--;
1328         }
1329 #endif
1330 }
1331
1332 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1333         int parse##name(const char *str, type *ul) \
1334         { \
1335                 if (!*str) \
1336                 { \
1337                         LOG_ERROR("Invalid command argument"); \
1338                         return ERROR_COMMAND_ARGUMENT_INVALID; \
1339                 } \
1340                 char *end; \
1341                 *ul = func(str, &end, 0); \
1342                 if (*end) \
1343                 { \
1344                         LOG_ERROR("Invalid command argument"); \
1345                         return ERROR_COMMAND_ARGUMENT_INVALID; \
1346                 } \
1347                 if ((max == *ul) && (ERANGE == errno)) \
1348                 { \
1349                         LOG_ERROR("Argument overflow"); \
1350                         return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1351                 } \
1352                 if (min && (min == *ul) && (ERANGE == errno)) \
1353                 { \
1354                         LOG_ERROR("Argument underflow"); \
1355                         return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1356                 } \
1357                 return ERROR_OK; \
1358         }
1359 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1360 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1361 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1362 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1363
1364 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1365         int parse##name(const char *str, type *ul) \
1366         { \
1367                 functype n; \
1368                 int retval = parse##funcname(str, &n); \
1369                 if (ERROR_OK != retval) \
1370                         return retval; \
1371                 if (n > max) \
1372                         return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1373                 if (min) \
1374                         return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1375                 *ul = n; \
1376                 return ERROR_OK; \
1377         }
1378
1379 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1380         DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1381 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1382 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1383 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1384 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1385
1386 #define DEFINE_PARSE_LONG(name, type, min, max) \
1387         DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1388 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1389 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1390 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1391 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1392
1393 static int command_parse_bool(const char *in, bool *out,
1394                 const char *on, const char *off)
1395 {
1396         if (strcasecmp(in, on) == 0)
1397                 *out = true;
1398         else if (strcasecmp(in, off) == 0)
1399                 *out = false;
1400         else
1401                 return ERROR_COMMAND_SYNTAX_ERROR;
1402         return  ERROR_OK;
1403 }
1404
1405 int command_parse_bool_arg(const char *in, bool *out)
1406 {
1407         if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1408                 return ERROR_OK;
1409         if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1410                 return ERROR_OK;
1411         if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1412                 return ERROR_OK;
1413         if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1414                 return ERROR_OK;
1415         if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1416                 return ERROR_OK;
1417         return ERROR_INVALID_ARGUMENTS;
1418 }
1419
1420 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1421 {
1422         switch (CMD_ARGC) {
1423         case 1: {
1424                 const char *in = CMD_ARGV[0];
1425                 if (command_parse_bool_arg(in, out) != ERROR_OK)
1426                 {
1427                         LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1428                         return ERROR_INVALID_ARGUMENTS;
1429                 }
1430                 // fall through
1431         }
1432         case 0:
1433                 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1434                 break;
1435         default:
1436                 return ERROR_INVALID_ARGUMENTS;
1437         }
1438         return ERROR_OK;
1439 }