git.gag.com Git - fw/openocd/blob - src/helper/command.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008, Duane Ellis                                       *
   9  *   openocd@duaneeellis.com                                               *
  10  *                                                                         *
  11  *   part of this file is taken from libcli (libcli.sourceforge.net)       *
  12  *   Copyright (C) David Parrish (david@dparrish.com)                      *
  13  *                                                                         *
  14  *   This program is free software; you can redistribute it and/or modify  *
  15  *   it under the terms of the GNU General Public License as published by  *
  16  *   the Free Software Foundation; either version 2 of the License, or     *
  17  *   (at your option) any later version.                                   *
  18  *                                                                         *
  19  *   This program is distributed in the hope that it will be useful,       *
  20  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  21  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  22  *   GNU General Public License for more details.                          *
  23  *                                                                         *
  24  *   You should have received a copy of the GNU General Public License     *
  25  *   along with this program; if not, write to the                         *
  26  *   Free Software Foundation, Inc.,                                       *
  27  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  28  ***************************************************************************/
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #include "replacements.h"
  34 #include "target.h"
  35 #include "command.h"
  36 #include "configuration.h"
  37
  38 #include "log.h"
  39 #include "time_support.h"
  40 #include "jim-eventloop.h"
  41
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <ctype.h>
  45 #include <stdarg.h>
  46 #include <stdio.h>
  47 #include <unistd.h>
  48 #include <errno.h>
  49
  50 int fast_and_dangerous = 0;
  51 Jim_Interp *interp = NULL;
  52
  53 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
  54 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
  55
  56 int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
  57
  58 static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
  59 {
  60         Jim_Obj *tclOutput=(Jim_Obj *)privData;
  61
  62         Jim_AppendString(interp, tclOutput, string, strlen(string));
  63 }
  64
  65 extern command_context_t *global_cmd_ctx;
  66
  67 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  68 {
  69         /* the private data is stashed in the interp structure */
  70         command_t *c;
  71         command_context_t *context;
  72         int retval;
  73         int i;
  74         int nwords;
  75         char **words;
  76
  77         /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
  78          * get overwritten by running other Jim commands! Treat it as an
  79          * emphemeral global variable that is used in lieu of an argument
  80          * to the fn and fish it out manually.
  81          */
  82         c = interp->cmdPrivData;
  83         if (c==NULL)
  84         {
  85                 LOG_ERROR("BUG: interp->cmdPrivData==NULL");
  86                 return JIM_ERR;
  87         }
  88         target_call_timer_callbacks_now();
  89         LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
  90
  91         LOG_DEBUG("script_command - %s", c->name);
  92
  93         words = malloc(sizeof(char *) * argc);
  94         for (i = 0; i < argc; i++)
  95         {
  96                 int len;
  97                 const char *w=Jim_GetString(argv[i], &len);
  98                 if (*w=='#')
  99                 {
 100                         /* hit an end of line comment */
 101                         break;
 102                 }
 103                 words[i] = strdup(w);
 104                 if (words[i] == NULL)
 105                 {
 106                         return JIM_ERR;
 107                 }
 108                 LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
 109         }
 110         nwords = i;
 111
 112         /* grab the command context from the associated data */
 113         context = Jim_GetAssocData(interp, "context");
 114         if (context == NULL)
 115         {
 116                 /* Tcl can invoke commands directly instead of via command_run_line(). This would
 117                  * happen when the Jim Tcl interpreter is provided by eCos.
 118                  */
 119                 context = global_cmd_ctx;
 120         }
 121
 122         /* capture log output and return it */
 123         Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
 124         /* a garbage collect can happen, so we need a reference count to this object */
 125         Jim_IncrRefCount(tclOutput);
 126
 127         log_add_callback(tcl_output, tclOutput);
 128
 129         retval = run_command(context, c, words, nwords);
 130
 131         log_remove_callback(tcl_output, tclOutput);
 132
 133         /* We dump output into this local variable */
 134         Jim_SetResult(interp, tclOutput);
 135         Jim_DecrRefCount(interp, tclOutput);
 136
 137         for (i = 0; i < nwords; i++)
 138                 free(words[i]);
 139         free(words);
 140
 141         int *return_retval = Jim_GetAssocData(interp, "retval");
 142         if (return_retval != NULL)
 143         {
 144                 *return_retval = retval;
 145         }
 146
 147         return (retval==ERROR_OK)?JIM_OK:JIM_ERR;
 148 }
 149
 150 /* nice short description of source file */
 151 #define __THIS__FILE__ "command.c"
 152
 153 command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
 154 {
 155         command_t *c, *p;
 156
 157         if (!context || !name)
 158                 return NULL;
 159
 160         c = malloc(sizeof(command_t));
 161
 162         c->name = strdup(name);
 163         c->parent = parent;
 164         c->children = NULL;
 165         c->handler = handler;
 166         c->mode = mode;
 167         if (!help)
 168                 help="";
 169         c->next = NULL;
 170
 171         /* place command in tree */
 172         if (parent)
 173         {
 174                 if (parent->children)
 175                 {
 176                         /* find last child */
 177                         for (p = parent->children; p && p->next; p = p->next);
 178                         if (p)
 179                                 p->next = c;
 180                 }
 181                 else
 182                 {
 183                         parent->children = c;
 184                 }
 185         }
 186         else
 187         {
 188                 if (context->commands)
 189                 {
 190                         /* find last command */
 191                         for (p = context->commands; p && p->next; p = p->next);
 192                         if (p)
 193                                 p->next = c;
 194                 }
 195                 else
 196                 {
 197                         context->commands = c;
 198                 }
 199         }
 200
 201         /* just a placeholder, no handler */
 202         if (c->handler==NULL)
 203                 return c;
 204
 205         /* If this is a two level command, e.g. "flash banks", then the
 206          * "unknown" proc in startup.tcl must redirect to  this command.
 207          *
 208          * "flash banks" is translated by "unknown" to "flash_banks"
 209          * if such a proc exists
 210          */
 211         /* Print help for command */
 212         const char *t1="";
 213         const char *t2="";
 214         const char *t3="";
 215         /* maximum of two levels :-) */
 216         if (c->parent!=NULL)
 217         {
 218                 t1=c->parent->name;
 219                 t2="_";
 220         }
 221         t3=c->name;
 222         const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3);
 223         Jim_CreateCommand(interp, full_name, script_command, c, NULL);
 224         free((void *)full_name);
 225
 226         /* we now need to add an overrideable proc */
 227         const char *override_name=alloc_printf("proc %s%s%s {args} {if {[catch {eval \"ocd_%s%s%s $args\"}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3);
 228         Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__ );
 229         free((void *)override_name);
 230
 231         /* accumulate help text in Tcl helptext list.  */
 232     Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
 233     if (Jim_IsShared(helptext))
 234         helptext = Jim_DuplicateObj(interp, helptext);
 235         Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
 236
 237         Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
 238
 239         /* maximum of two levels :-) */
 240         if (c->parent!=NULL)
 241         {
 242                 Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
 243         }
 244         Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
 245
 246         Jim_ListAppendElement(interp, cmd_entry, cmd_list);
 247         Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
 248         Jim_ListAppendElement(interp, helptext, cmd_entry);
 249         return c;
 250 }
 251
 252 int unregister_all_commands(command_context_t *context)
 253 {
 254         command_t *c, *c2;
 255
 256         if (context == NULL)
 257                 return ERROR_OK;
 258
 259         while(NULL != context->commands)
 260         {
 261                 c = context->commands;
 262
 263                 while(NULL != c->children)
 264                 {
 265                         c2 = c->children;
 266                         c->children = c->children->next;
 267                         free(c2->name);
 268                         c2->name = NULL;
 269                         free(c2);
 270                         c2 = NULL;
 271                 }
 272
 273                 context->commands = context->commands->next;
 274
 275                 free(c->name);
 276                 c->name = NULL;
 277                 free(c);
 278                 c = NULL;
 279         }
 280
 281         return ERROR_OK;
 282 }
 283
 284 int unregister_command(command_context_t *context, char *name)
 285 {
 286         command_t *c, *p = NULL, *c2;
 287
 288         if ((!context) || (!name))
 289                 return ERROR_INVALID_ARGUMENTS;
 290
 291         /* find command */
 292         for (c = context->commands; c; c = c->next)
 293         {
 294                 if (strcmp(name, c->name) == 0)
 295                 {
 296                         /* unlink command */
 297                         if (p)
 298                         {
 299                                 p->next = c->next;
 300                         }
 301                         else
 302                         {
 303                                 context->commands = c->next;
 304                         }
 305
 306                         /* unregister children */
 307                         if (c->children)
 308                         {
 309                                 for (c2 = c->children; c2; c2 = c2->next)
 310                                 {
 311                                         free(c2->name);
 312                                         free(c2);
 313                                 }
 314                         }
 315
 316                         /* delete command */
 317                         free(c->name);
 318                         free(c);
 319                 }
 320
 321                 /* remember the last command for unlinking */
 322                 p = c;
 323         }
 324
 325         return ERROR_OK;
 326 }
 327
 328 void command_output_text(command_context_t *context, const char *data)
 329 {
 330         if( context && context->output_handler && data  ){
 331                 context->output_handler( context, data );
 332         }
 333 }
 334
 335 void command_print_n(command_context_t *context, char *format, ...)
 336 {
 337         char *string;
 338
 339         va_list ap;
 340         va_start(ap, format);
 341
 342         string = alloc_vprintf(format, ap);
 343         if (string != NULL)
 344         {
 345                 /* we want this collected in the log + we also want to pick it up as a tcl return
 346                  * value.
 347                  *
 348                  * The latter bit isn't precisely neat, but will do for now.
 349                  */
 350                 LOG_USER_N("%s", string);
 351                 // We already printed it above
 352                 //command_output_text(context, string);
 353                 free(string);
 354         }
 355
 356         va_end(ap);
 357 }
 358
 359 void command_print(command_context_t *context, char *format, ...)
 360 {
 361         char *string;
 362
 363         va_list ap;
 364         va_start(ap, format);
 365
 366         string = alloc_vprintf(format, ap);
 367         if (string != NULL)
 368         {
 369                 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
 370                 /* we want this collected in the log + we also want to pick it up as a tcl return
 371                  * value.
 372                  *
 373                  * The latter bit isn't precisely neat, but will do for now.
 374                  */
 375                 LOG_USER_N("%s", string);
 376                 // We already printed it above
 377                 //command_output_text(context, string);
 378                 free(string);
 379         }
 380
 381         va_end(ap);
 382 }
 383
 384 int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
 385 {
 386         int start_word=0;
 387         if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
 388         {
 389                 /* Config commands can not run after the config stage */
 390                 LOG_ERROR("Illegal mode for command");
 391                 return ERROR_FAIL;
 392         }
 393
 394         int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
 395         if (retval == ERROR_COMMAND_SYNTAX_ERROR)
 396         {
 397                 /* Print help for command */
 398                 const char *t1="";
 399                 const char *t2="";
 400                 const char *t3="";
 401                 /* maximum of two levels :-) */
 402                 if (c->parent!=NULL)
 403                 {
 404                         t1=c->parent->name;
 405                         t2=" ";
 406                 }
 407                 t3=c->name;
 408                 command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
 409         }
 410         else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
 411         {
 412                 /* just fall through for a shutdown request */
 413         }
 414         else if (retval != ERROR_OK)
 415         {
 416                 /* we do not print out an error message because the command *should*
 417                  * have printed out an error
 418                  */
 419                 LOG_DEBUG("Command failed with error code %d", retval);
 420         }
 421
 422         return retval;
 423 }
 424
 425 int command_run_line(command_context_t *context, char *line)
 426 {
 427         /* all the parent commands have been registered with the interpreter
 428          * so, can just evaluate the line as a script and check for
 429          * results
 430          */
 431         /* run the line thru a script engine */
 432         int retval=ERROR_FAIL;
 433         int retcode;
 434         /* Beware! This code needs to be reentrant. It is also possible
 435          * for OpenOCD commands to be invoked directly from Tcl. This would
 436          * happen when the Jim Tcl interpreter is provided by eCos for
 437          * instance.
 438          */
 439         Jim_DeleteAssocData(interp, "context");
 440         retcode = Jim_SetAssocData(interp, "context", NULL, context);
 441         if (retcode == JIM_OK)
 442         {
 443                 /* associated the return value */
 444                 Jim_DeleteAssocData(interp, "retval");
 445                 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
 446                 if (retcode == JIM_OK)
 447                 {
 448                         retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ );
 449
 450                         Jim_DeleteAssocData(interp, "retval");
 451                 }
 452                 Jim_DeleteAssocData(interp, "context");
 453         }
 454         if (retcode == JIM_ERR) {
 455                 if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
 456                 {
 457                         /* We do not print the connection closed error message */
 458                         Jim_PrintErrorMessage(interp);
 459                 }
 460                 if (retval==ERROR_OK)
 461                 {
 462                         /* It wasn't a low level OpenOCD command that failed */
 463                         return ERROR_FAIL;
 464                 }
 465                 return retval;
 466         } else if (retcode == JIM_EXIT) {
 467                 /* ignore. */
 468                 /* exit(Jim_GetExitCode(interp)); */
 469         } else {
 470                 const char *result;
 471                 int reslen;
 472
 473                 result = Jim_GetString(Jim_GetResult(interp), &reslen);
 474                 if (reslen) {
 475                         int i;
 476                         char buff[256+1];
 477                         for (i = 0; i < reslen; i += 256)
 478                         {
 479                                 int chunk;
 480                                 chunk = reslen - i;
 481                                 if (chunk > 256)
 482                                         chunk = 256;
 483                                 strncpy(buff, result+i, chunk);
 484                                 buff[chunk] = 0;
 485                                 LOG_USER_N("%s", buff);
 486                         }
 487                         LOG_USER_N("%s", "\n");
 488                 }
 489         }
 490         return retval;
 491 }
 492
 493 int command_run_linef(command_context_t *context, char *format, ...)
 494 {
 495         int retval=ERROR_FAIL;
 496         char *string;
 497         va_list ap;
 498         va_start(ap, format);
 499         string = alloc_vprintf(format, ap);
 500         if (string!=NULL)
 501         {
 502                 retval=command_run_line(context, string);
 503         }
 504         va_end(ap);
 505         return retval;
 506 }
 507
 508 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
 509 {
 510         context->output_handler = output_handler;
 511         context->output_handler_priv = priv;
 512 }
 513
 514 command_context_t* copy_command_context(command_context_t* context)
 515 {
 516         command_context_t* copy_context = malloc(sizeof(command_context_t));
 517
 518         *copy_context = *context;
 519
 520         return copy_context;
 521 }
 522
 523 int command_done(command_context_t *context)
 524 {
 525         free(context);
 526         context = NULL;
 527
 528         return ERROR_OK;
 529 }
 530
 531 /* find full path to file */
 532 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 533 {
 534         if (argc != 2)
 535                 return JIM_ERR;
 536         const char *file = Jim_GetString(argv[1], NULL);
 537         char *full_path = find_file(file);
 538         if (full_path == NULL)
 539                 return JIM_ERR;
 540         Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
 541         free(full_path);
 542
 543         Jim_SetResult(interp, result);
 544         return JIM_OK;
 545 }
 546
 547 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 548 {
 549         if (argc != 2)
 550                 return JIM_ERR;
 551         const char *str = Jim_GetString(argv[1], NULL);
 552         LOG_USER("%s", str);
 553         return JIM_OK;
 554 }
 555
 556 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
 557 {
 558         size_t nbytes;
 559         const char *ptr;
 560         Jim_Interp *interp;
 561
 562         /* make it a char easier to read code */
 563         ptr = _ptr;
 564         interp = cookie;
 565         nbytes = size * n;
 566         if (ptr == NULL || interp == NULL || nbytes == 0) {
 567                 return 0;
 568         }
 569
 570         /* do we have to chunk it? */
 571         if (ptr[nbytes] == 0)
 572         {
 573                 /* no it is a C style string */
 574                 LOG_USER_N("%s", ptr);
 575                 return strlen(ptr);
 576         }
 577         /* GRR we must chunk - not null terminated */
 578         while (nbytes) {
 579                 char chunk[128+1];
 580                 int x;
 581
 582                 x = nbytes;
 583                 if (x > 128) {
 584                         x = 128;
 585                 }
 586                 /* copy it */
 587                 memcpy(chunk, ptr, x);
 588                 /* terminate it */
 589                 chunk[n] = 0;
 590                 /* output it */
 591                 LOG_USER_N("%s", chunk);
 592                 ptr += x;
 593                 nbytes -= x;
 594         }
 595
 596         return n;
 597 }
 598
 599 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
 600 {
 601         /* TCL wants to read... tell him no */
 602         return 0;
 603 }
 604
 605 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
 606 {
 607         char *cp;
 608         int n;
 609         Jim_Interp *interp;
 610
 611         n = -1;
 612         interp = cookie;
 613         if (interp == NULL)
 614                 return n;
 615
 616         cp = alloc_vprintf(fmt, ap);
 617         if (cp)
 618         {
 619                 LOG_USER_N("%s", cp);
 620                 n = strlen(cp);
 621                 free(cp);
 622         }
 623         return n;
 624 }
 625
 626 static int openocd_jim_fflush(void *cookie)
 627 {
 628         /* nothing to flush */
 629         return 0;
 630 }
 631
 632 static char* openocd_jim_fgets(char *s, int size, void *cookie)
 633 {
 634         /* not supported */
 635         errno = ENOTSUP;
 636         return NULL;
 637 }
 638
 639
 640 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 641 {
 642         if (argc != 2)
 643                 return JIM_ERR;
 644         int retcode;
 645         const char *str = Jim_GetString(argv[1], NULL);
 646
 647         /* capture log output and return it */
 648         Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
 649         /* a garbage collect can happen, so we need a reference count to this object */
 650         Jim_IncrRefCount(tclOutput);
 651
 652         log_add_callback(tcl_output, tclOutput);
 653
 654         retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__ );
 655
 656         log_remove_callback(tcl_output, tclOutput);
 657
 658         /* We dump output into this local variable */
 659         Jim_SetResult(interp, tclOutput);
 660         Jim_DecrRefCount(interp, tclOutput);
 661
 662         return retcode;
 663 }
 664
 665 command_context_t* command_init()
 666 {
 667         command_context_t* context = malloc(sizeof(command_context_t));
 668         extern const char startup_tcl[];
 669
 670         context->mode = COMMAND_EXEC;
 671         context->commands = NULL;
 672         context->current_target = 0;
 673         context->output_handler = NULL;
 674         context->output_handler_priv = NULL;
 675
 676 #ifdef JIM_EMBEDDED
 677         Jim_InitEmbedded();
 678         /* Create an interpreter */
 679         interp = Jim_CreateInterp();
 680         /* Add all the Jim core commands */
 681         Jim_RegisterCoreCommands(interp);
 682 #endif
 683
 684         Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
 685         Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
 686         Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
 687
 688         /* Set Jim's STDIO */
 689         interp->cookie_stdin = interp;
 690         interp->cookie_stdout = interp;
 691         interp->cookie_stderr = interp;
 692         interp->cb_fwrite = openocd_jim_fwrite;
 693         interp->cb_fread = openocd_jim_fread ;
 694         interp->cb_vfprintf = openocd_jim_vfprintf;
 695         interp->cb_fflush = openocd_jim_fflush;
 696         interp->cb_fgets = openocd_jim_fgets;
 697
 698         add_default_dirs();
 699
 700 #ifdef JIM_EMBEDDED
 701         Jim_EventLoopOnLoad(interp);
 702 #endif
 703         if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR)
 704         {
 705                 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
 706                 Jim_PrintErrorMessage(interp);
 707                 exit(-1);
 708         }
 709
 710         register_command(context, NULL, "sleep", handle_sleep_command,
 711                                          COMMAND_ANY, "<n> [busy] - sleep for n milliseconds. \"busy\" means busy wait");
 712
 713         register_command(context, NULL, "fast", handle_fast_command,
 714                                          COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
 715
 716         return context;
 717 }
 718
 719 int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
 720 {
 721         if (!cmd_ctx)
 722                 return ERROR_INVALID_ARGUMENTS;
 723
 724         cmd_ctx->mode = mode;
 725         return ERROR_OK;
 726 }
 727
 728 /* sleep command sleeps for <n> miliseconds
 729  * this is useful in target startup scripts
 730  */
 731 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 732 {
 733         unsigned long duration = 0;
 734         int busy = 0;
 735
 736         if (argc==1)
 737         {
 738
 739         } else if (argc==2)
 740         {
 741                 if (strcmp(args[1], "busy")!=0)
 742                         return ERROR_COMMAND_SYNTAX_ERROR;
 743                 busy = 1;
 744         } else
 745         {
 746                 return ERROR_COMMAND_SYNTAX_ERROR;
 747         }
 748
 749         duration = strtoul(args[0], NULL, 0);
 750
 751         if (busy)
 752         {
 753                 busy_sleep(duration);
 754         } else
 755         {
 756                 long long then=timeval_ms();
 757                 while ((timeval_ms()-then)<duration)
 758                 {
 759                         target_call_timer_callbacks_now();
 760                         usleep(1000);
 761                 }
 762         }
 763
 764         return ERROR_OK;
 765 }
 766
 767 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 768 {
 769         if (argc!=1)
 770                 return ERROR_COMMAND_SYNTAX_ERROR;
 771
 772         fast_and_dangerous = strcmp("enable", args[0])==0;
 773
 774         return ERROR_OK;
 775 }
 776
 777 void process_jim_events(void)
 778 {
 779 #ifdef JIM_EMBEDDED
 780         static int recursion = 0;
 781
 782         if (!recursion)
 783         {
 784                 recursion++;
 785                 Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT);
 786                 recursion--;
 787         }
 788 #endif
 789 }
 790
 791 void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
 792 {
 793         Jim_CreateCommand(interp, name, cmd, NULL, NULL);
 794
 795         /* FIX!!! it would be prettier to invoke add_help_text...
 796            accumulate help text in Tcl helptext list.  */
 797         Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
 798         if (Jim_IsShared(helptext))
 799                 helptext = Jim_DuplicateObj(interp, helptext);
 800
 801         Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
 802
 803         Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
 804         Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
 805
 806         Jim_ListAppendElement(interp, cmd_entry, cmd_list);
 807         Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
 808         Jim_ListAppendElement(interp, helptext, cmd_entry);
 809 }
 810
 811
 812 /* return global variable long value or 0 upon failure */
 813 long jim_global_long(const char *variable)
 814 {
 815         Jim_Obj *objPtr=Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
 816         long t;
 817         if (Jim_GetLong(interp, objPtr, &t)==JIM_OK)
 818         {
 819                 return t;
 820         }
 821         return 0;
 822 }