src/helper/command.c

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