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