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