git.gag.com Git - fw/openocd/blob - src/jtag/jtag.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) 2009 SoftPLC Corporation                                *
   9  *       http://softplc.com                                                *
  10  *   dick@softplc.com                                                      *
  11  *                                                                         *
  12  *   This program is free software; you can redistribute it and/or modify  *
  13  *   it under the terms of the GNU General Public License as published by  *
  14  *   the Free Software Foundation; either version 2 of the License, or     *
  15  *   (at your option) any later version.                                   *
  16  *                                                                         *
  17  *   This program is distributed in the hope that it will be useful,       *
  18  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  19  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  20  *   GNU General Public License for more details.                          *
  21  *                                                                         *
  22  *   You should have received a copy of the GNU General Public License     *
  23  *   along with this program; if not, write to the                         *
  24  *   Free Software Foundation, Inc.,                                       *
  25  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  26  ***************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include "jtag.h"
  32 #include "minidriver.h"
  33 #include "interface.h"
  34
  35 #ifdef HAVE_STRINGS_H
  36 #include <strings.h>
  37 #endif
  38
  39
  40 /// The number of JTAG queue flushes (for profiling and debugging purposes).
  41 static int jtag_flush_queue_count;
  42
  43 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
  44                 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
  45
  46 /* note that this is not marked as static as it must be available from outside jtag.c for those
  47    that implement the jtag_xxx() minidriver layer
  48 */
  49 int jtag_error=ERROR_OK;
  50
  51 char* jtag_event_strings[] =
  52 {
  53         "JTAG controller reset (RESET or TRST)"
  54 };
  55
  56 const Jim_Nvp nvp_jtag_tap_event[] = {
  57         { .value = JTAG_TAP_EVENT_ENABLE,       .name = "tap-enable" },
  58         { .value = JTAG_TAP_EVENT_DISABLE,      .name = "tap-disable" },
  59
  60         { .name = NULL, .value = -1 }
  61 };
  62
  63 int jtag_trst = 0;
  64 int jtag_srst = 0;
  65
  66 /**
  67  * List all TAPs that have been created.
  68  */
  69 static jtag_tap_t *__jtag_all_taps = NULL;
  70 /**
  71  * The number of TAPs in the __jtag_all_taps list, used to track the
  72  * assigned chain position to new TAPs
  73  */
  74 static int jtag_num_taps = 0;
  75
  76 enum reset_types jtag_reset_config = RESET_NONE;
  77 tap_state_t cmd_queue_end_state = TAP_RESET;
  78 tap_state_t cmd_queue_cur_state = TAP_RESET;
  79
  80 int jtag_verify_capture_ir = 1;
  81 int jtag_verify = 1;
  82
  83 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
  84 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
  85 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
  86
  87 /* callbacks to inform high-level handlers about JTAG state changes */
  88 jtag_event_callback_t *jtag_event_callbacks;
  89
  90 /* speed in kHz*/
  91 static int speed_khz = 0;
  92 /* flag if the kHz speed was defined */
  93 static bool hasKHz = false;
  94
  95 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
  96  */
  97
  98 #if BUILD_ECOSBOARD == 1
  99         extern jtag_interface_t zy1000_interface;
 100 #endif
 101
 102 #if BUILD_PARPORT == 1
 103         extern jtag_interface_t parport_interface;
 104 #endif
 105
 106 #if BUILD_DUMMY == 1
 107         extern jtag_interface_t dummy_interface;
 108 #endif
 109
 110 #if BUILD_FT2232_FTD2XX == 1
 111         extern jtag_interface_t ft2232_interface;
 112 #endif
 113
 114 #if BUILD_FT2232_LIBFTDI == 1
 115         extern jtag_interface_t ft2232_interface;
 116 #endif
 117
 118 #if BUILD_AMTJTAGACCEL == 1
 119         extern jtag_interface_t amt_jtagaccel_interface;
 120 #endif
 121
 122 #if BUILD_EP93XX == 1
 123         extern jtag_interface_t ep93xx_interface;
 124 #endif
 125
 126 #if BUILD_AT91RM9200 == 1
 127         extern jtag_interface_t at91rm9200_interface;
 128 #endif
 129
 130 #if BUILD_GW16012 == 1
 131         extern jtag_interface_t gw16012_interface;
 132 #endif
 133
 134 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
 135         extern jtag_interface_t presto_interface;
 136 #endif
 137
 138 #if BUILD_USBPROG == 1
 139         extern jtag_interface_t usbprog_interface;
 140 #endif
 141
 142 #if BUILD_JLINK == 1
 143         extern jtag_interface_t jlink_interface;
 144 #endif
 145
 146 #if BUILD_VSLLINK == 1
 147         extern jtag_interface_t vsllink_interface;
 148 #endif
 149
 150 #if BUILD_RLINK == 1
 151         extern jtag_interface_t rlink_interface;
 152 #endif
 153
 154 #if BUILD_ARMJTAGEW == 1
 155         extern jtag_interface_t armjtagew_interface;
 156 #endif
 157
 158 jtag_interface_t *jtag_interfaces[] = {
 159 #if BUILD_ECOSBOARD == 1
 160         &zy1000_interface,
 161 #endif
 162 #if BUILD_PARPORT == 1
 163         &parport_interface,
 164 #endif
 165 #if BUILD_DUMMY == 1
 166         &dummy_interface,
 167 #endif
 168 #if BUILD_FT2232_FTD2XX == 1
 169         &ft2232_interface,
 170 #endif
 171 #if BUILD_FT2232_LIBFTDI == 1
 172         &ft2232_interface,
 173 #endif
 174 #if BUILD_AMTJTAGACCEL == 1
 175         &amt_jtagaccel_interface,
 176 #endif
 177 #if BUILD_EP93XX == 1
 178         &ep93xx_interface,
 179 #endif
 180 #if BUILD_AT91RM9200 == 1
 181         &at91rm9200_interface,
 182 #endif
 183 #if BUILD_GW16012 == 1
 184         &gw16012_interface,
 185 #endif
 186 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
 187         &presto_interface,
 188 #endif
 189 #if BUILD_USBPROG == 1
 190         &usbprog_interface,
 191 #endif
 192 #if BUILD_JLINK == 1
 193         &jlink_interface,
 194 #endif
 195 #if BUILD_VSLLINK == 1
 196         &vsllink_interface,
 197 #endif
 198 #if BUILD_RLINK == 1
 199         &rlink_interface,
 200 #endif
 201 #if BUILD_ARMJTAGEW == 1
 202         &armjtagew_interface,
 203 #endif
 204         NULL,
 205 };
 206
 207 struct jtag_interface_s *jtag = NULL;
 208
 209 /* configuration */
 210 static jtag_interface_t *jtag_interface = NULL;
 211 int jtag_speed = 0;
 212
 213 /* jtag commands */
 214 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 215 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 216 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 217 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 218 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 219 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 220 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 221
 222 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 223
 224 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 225 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 226 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 227 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 228 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
 229 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
 230
 231 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 232 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 233 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 234
 235 jtag_tap_t *jtag_all_taps(void)
 236 {
 237         return __jtag_all_taps;
 238 };
 239
 240 int jtag_tap_count(void)
 241 {
 242         return jtag_num_taps;
 243 }
 244
 245 int jtag_tap_count_enabled(void)
 246 {
 247         jtag_tap_t *t;
 248         int n;
 249
 250         n = 0;
 251         t = jtag_all_taps();
 252         while(t){
 253                 if( t->enabled ){
 254                         n++;
 255                 }
 256                 t = t->next_tap;
 257         }
 258         return n;
 259 }
 260
 261 /// Append a new TAP to the chain of all taps.
 262 static void jtag_tap_add(struct jtag_tap_s *t)
 263 {
 264         t->abs_chain_position = jtag_num_taps++;
 265
 266         jtag_tap_t **tap = &__jtag_all_taps;
 267         while(*tap != NULL)
 268                 tap = &(*tap)->next_tap;
 269         *tap = t;
 270 }
 271
 272 jtag_tap_t *jtag_tap_by_string( const char *s )
 273 {
 274         jtag_tap_t *t;
 275         char *cp;
 276
 277         t = jtag_all_taps();
 278         /* try name first */
 279         while(t){
 280                 if( 0 == strcmp( t->dotted_name, s ) ){
 281                         break;
 282                 } else {
 283                         t = t->next_tap;
 284                 }
 285         }
 286         /* backup plan is by number */
 287         if( t == NULL ){
 288                 /* ok - is "s" a number? */
 289                 int n;
 290                 n = strtol( s, &cp, 0 );
 291                 if( (s != cp) && (*cp == 0) ){
 292                         /* Then it is... */
 293                         t = jtag_tap_by_abs_position(n);
 294                 }
 295         }
 296         return t;
 297 }
 298
 299 jtag_tap_t * jtag_tap_by_jim_obj( Jim_Interp *interp, Jim_Obj *o )
 300 {
 301         jtag_tap_t *t;
 302         const char *cp;
 303
 304         cp = Jim_GetString( o, NULL );
 305         if(cp == NULL){
 306                 cp = "(unknown)";
 307                 t = NULL;
 308         }  else {
 309                 t = jtag_tap_by_string( cp );
 310         }
 311         if( t == NULL ){
 312                 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
 313         }
 314         return t;
 315 }
 316
 317 /* returns a pointer to the n-th device in the scan chain */
 318 jtag_tap_t * jtag_tap_by_abs_position( int n )
 319 {
 320         int orig_n;
 321         jtag_tap_t *t;
 322
 323         orig_n = n;
 324         t = jtag_all_taps();
 325
 326         while( t && (n > 0)) {
 327                 n--;
 328                 t = t->next_tap;
 329         }
 330         return t;
 331 }
 332
 333 const char *jtag_tap_name(const jtag_tap_t *tap)
 334 {
 335         return (tap == NULL) ? "(unknown)" : tap->dotted_name;
 336 }
 337
 338
 339 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
 340 {
 341         jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
 342
 343         if (callback == NULL)
 344         {
 345                 return ERROR_INVALID_ARGUMENTS;
 346         }
 347
 348         if (*callbacks_p)
 349         {
 350                 while ((*callbacks_p)->next)
 351                         callbacks_p = &((*callbacks_p)->next);
 352                 callbacks_p = &((*callbacks_p)->next);
 353         }
 354
 355         (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
 356         (*callbacks_p)->callback = callback;
 357         (*callbacks_p)->priv = priv;
 358         (*callbacks_p)->next = NULL;
 359
 360         return ERROR_OK;
 361 }
 362
 363 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
 364 {
 365         jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
 366
 367         if (callback == NULL)
 368         {
 369                 return ERROR_INVALID_ARGUMENTS;
 370         }
 371
 372         while (*callbacks_p)
 373         {
 374                 jtag_event_callback_t **next = &((*callbacks_p)->next);
 375                 if ((*callbacks_p)->callback == callback)
 376                 {
 377                         free(*callbacks_p);
 378                         *callbacks_p = *next;
 379                 }
 380                 callbacks_p = next;
 381         }
 382
 383         return ERROR_OK;
 384 }
 385
 386 int jtag_call_event_callbacks(enum jtag_event event)
 387 {
 388         jtag_event_callback_t *callback = jtag_event_callbacks;
 389
 390         LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
 391
 392         while (callback)
 393         {
 394                 callback->callback(event, callback->priv);
 395                 callback = callback->next;
 396         }
 397
 398         return ERROR_OK;
 399 }
 400
 401 static void jtag_checks(void)
 402 {
 403         assert(jtag_trst == 0);
 404 }
 405
 406 static void jtag_prelude(tap_state_t state)
 407 {
 408         jtag_checks();
 409
 410         assert(state!=TAP_INVALID);
 411
 412         cmd_queue_cur_state = state;
 413 }
 414
 415 void jtag_alloc_in_value32(scan_field_t *field)
 416 {
 417         interface_jtag_alloc_in_value32(field);
 418 }
 419
 420 void jtag_add_ir_scan_noverify(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 421 {
 422         int retval;
 423         jtag_prelude(state);
 424
 425         retval=interface_jtag_add_ir_scan(in_num_fields, in_fields, state);
 426         if (retval!=ERROR_OK)
 427                 jtag_error=retval;
 428
 429 }
 430
 431
 432 /**
 433  * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
 434  *
 435  * If the input field list contains an instruction value for a TAP then that is used
 436  * otherwise the TAP is set to bypass.
 437  *
 438  * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
 439  *
 440  */
 441 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 442 {
 443         if (jtag_verify&&jtag_verify_capture_ir)
 444         {
 445                 /* 8 x 32 bit id's is enough for all invocations */
 446
 447                 for (int j = 0; j < in_num_fields; j++)
 448                 {
 449                         /* if we are to run a verification of the ir scan, we need to get the input back.
 450                          * We may have to allocate space if the caller didn't ask for the input back.
 451                          */
 452                         in_fields[j].check_value=in_fields[j].tap->expected;
 453                         in_fields[j].check_mask=in_fields[j].tap->expected_mask;
 454                 }
 455                 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
 456         } else
 457         {
 458                 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
 459         }
 460 }
 461
 462 /**
 463  * Duplicate the scan fields passed into the function into an IR SCAN command
 464  *
 465  * This function assumes that the caller handles extra fields for bypassed TAPs
 466  *
 467  */
 468 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 469 {
 470         int retval;
 471
 472         jtag_prelude(state);
 473
 474         retval=interface_jtag_add_plain_ir_scan(in_num_fields, in_fields, state);
 475         if (retval!=ERROR_OK)
 476                 jtag_error=retval;
 477 }
 478
 479 void jtag_add_callback(jtag_callback1_t f, u8 *in)
 480 {
 481         interface_jtag_add_callback(f, in);
 482 }
 483
 484 void jtag_add_callback4(jtag_callback_t f, u8 *in,
 485                 jtag_callback_data_t data1, jtag_callback_data_t data2,
 486                 jtag_callback_data_t data3)
 487 {
 488         interface_jtag_add_callback4(f, in, data1, data2, data3);
 489 }
 490
 491 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
 492
 493 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
 494 {
 495         return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
 496 }
 497
 498 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
 499                 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 500 {
 501         for (int i = 0; i < in_num_fields; i++)
 502         {
 503                 struct scan_field_s *field = &in_fields[i];
 504                 field->allocated = 0;
 505                 field->modified = 0;
 506                 if (field->check_value || field->in_value)
 507                         continue;
 508                 interface_jtag_add_scan_check_alloc(field);
 509                 field->modified = 1;
 510         }
 511
 512         jtag_add_scan(in_num_fields, in_fields, state);
 513
 514         for (int i = 0; i < in_num_fields; i++)
 515         {
 516                 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
 517                 {
 518                         /* this is synchronous for a minidriver */
 519                         jtag_add_callback4(jtag_check_value_mask_callback, in_fields[i].in_value,
 520                                 (jtag_callback_data_t)in_fields[i].check_value,
 521                                 (jtag_callback_data_t)in_fields[i].check_mask,
 522                                 (jtag_callback_data_t)in_fields[i].num_bits);
 523                 }
 524                 if (in_fields[i].allocated)
 525                 {
 526                         free(in_fields[i].in_value);
 527                 }
 528                 if (in_fields[i].modified)
 529                 {
 530                         in_fields[i].in_value = NULL;
 531                 }
 532         }
 533 }
 534
 535 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 536 {
 537         if (jtag_verify)
 538         {
 539                 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
 540         } else
 541         {
 542                 jtag_add_dr_scan(in_num_fields, in_fields, state);
 543         }
 544 }
 545
 546
 547 /**
 548  * Generate a DR SCAN using the fields passed to the function
 549  *
 550  * For not bypassed TAPs the function checks in_fields and uses fields specified there.
 551  * For bypassed TAPs the function generates a dummy 1bit field.
 552  *
 553  * The bypass status of TAPs is set by jtag_add_ir_scan().
 554  *
 555  */
 556 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 557 {
 558         int retval;
 559
 560         jtag_prelude(state);
 561
 562         retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, state);
 563         if (retval!=ERROR_OK)
 564                 jtag_error=retval;
 565 }
 566
 567
 568
 569 /**
 570  * Duplicate the scan fields passed into the function into a DR SCAN command
 571  *
 572  * This function assumes that the caller handles extra fields for bypassed TAPs
 573  *
 574  */
 575 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 576 {
 577         int retval;
 578
 579         jtag_prelude(state);
 580
 581         retval=interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, state);
 582         if (retval!=ERROR_OK)
 583                 jtag_error=retval;
 584 }
 585
 586 void jtag_add_dr_out(jtag_tap_t* tap,
 587                 int num_fields, const int* num_bits, const u32* value,
 588                 tap_state_t end_state)
 589 {
 590         assert(end_state != TAP_INVALID);
 591
 592         cmd_queue_cur_state = end_state;
 593
 594         interface_jtag_add_dr_out(tap,
 595                         num_fields, num_bits, value,
 596                         end_state);
 597 }
 598
 599 void jtag_add_tlr(void)
 600 {
 601         jtag_prelude(TAP_RESET);
 602
 603         int retval;
 604         retval=interface_jtag_add_tlr();
 605         if (retval!=ERROR_OK)
 606                 jtag_error=retval;
 607
 608         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 609 }
 610
 611 void jtag_add_pathmove(int num_states, const tap_state_t *path)
 612 {
 613         tap_state_t cur_state = cmd_queue_cur_state;
 614         int i;
 615         int retval;
 616
 617         /* the last state has to be a stable state */
 618         if (!tap_is_state_stable(path[num_states - 1]))
 619         {
 620                 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
 621                 exit(-1);
 622         }
 623
 624         for (i=0; i<num_states; i++)
 625         {
 626                 if (path[i] == TAP_RESET)
 627                 {
 628                         LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
 629                         exit(-1);
 630                 }
 631
 632                 if ( tap_state_transition(cur_state, true)  != path[i]
 633                   && tap_state_transition(cur_state, false) != path[i])
 634                 {
 635                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
 636                         exit(-1);
 637                 }
 638                 cur_state = path[i];
 639         }
 640
 641         jtag_checks();
 642
 643         retval = interface_jtag_add_pathmove(num_states, path);
 644         cmd_queue_cur_state = path[num_states - 1];
 645         if (retval!=ERROR_OK)
 646                 jtag_error=retval;
 647 }
 648
 649 void jtag_add_runtest(int num_cycles, tap_state_t state)
 650 {
 651         int retval;
 652
 653         jtag_prelude(state);
 654
 655         /* executed by sw or hw fifo */
 656         retval=interface_jtag_add_runtest(num_cycles, state);
 657         if (retval!=ERROR_OK)
 658                 jtag_error=retval;
 659 }
 660
 661
 662 void jtag_add_clocks( int num_cycles )
 663 {
 664         int retval;
 665
 666         if( !tap_is_state_stable(cmd_queue_cur_state) )
 667         {
 668                  LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
 669                                  tap_state_name(cmd_queue_cur_state) );
 670                  jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
 671                  return;
 672         }
 673
 674         if( num_cycles > 0 )
 675         {
 676                 jtag_checks();
 677
 678                 retval = interface_jtag_add_clocks(num_cycles);
 679                 if (retval != ERROR_OK)
 680                         jtag_error=retval;
 681         }
 682 }
 683
 684 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
 685 {
 686         int trst_with_tlr = 0;
 687         int retval;
 688
 689         /* FIX!!! there are *many* different cases here. A better
 690          * approach is needed for legal combinations of transitions...
 691          */
 692         if ((jtag_reset_config & RESET_HAS_SRST)&&
 693                         (jtag_reset_config & RESET_HAS_TRST)&&
 694                         ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
 695         {
 696                 if (((req_tlr_or_trst&&!jtag_trst)||
 697                                 (!req_tlr_or_trst&&jtag_trst))&&
 698                                 ((req_srst&&!jtag_srst)||
 699                                                 (!req_srst&&jtag_srst)))
 700                 {
 701                         /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
 702                         //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
 703                 }
 704         }
 705
 706         /* Make sure that jtag_reset_config allows the requested reset */
 707         /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
 708         if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
 709         {
 710                 LOG_ERROR("BUG: requested reset would assert trst");
 711                 jtag_error=ERROR_FAIL;
 712                 return;
 713         }
 714
 715         /* if TRST pulls SRST, we reset with TAP T-L-R */
 716         if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
 717         {
 718                 trst_with_tlr = 1;
 719         }
 720
 721         if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
 722         {
 723                 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
 724                 jtag_error=ERROR_FAIL;
 725                 return;
 726         }
 727
 728         if (req_tlr_or_trst)
 729         {
 730                 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
 731                 {
 732                         jtag_trst = 1;
 733                 } else
 734                 {
 735                         trst_with_tlr = 1;
 736                 }
 737         } else
 738         {
 739                 jtag_trst = 0;
 740         }
 741
 742         jtag_srst = req_srst;
 743
 744         retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
 745         if (retval!=ERROR_OK)
 746         {
 747                 jtag_error=retval;
 748                 return;
 749         }
 750         jtag_execute_queue();
 751
 752         if (jtag_srst)
 753         {
 754                 LOG_DEBUG("SRST line asserted");
 755         }
 756         else
 757         {
 758                 LOG_DEBUG("SRST line released");
 759                 if (jtag_nsrst_delay)
 760                         jtag_add_sleep(jtag_nsrst_delay * 1000);
 761         }
 762
 763         if (trst_with_tlr)
 764         {
 765                 LOG_DEBUG("JTAG reset with RESET instead of TRST");
 766                 jtag_set_end_state(TAP_RESET);
 767                 jtag_add_tlr();
 768                 return;
 769         }
 770
 771         if (jtag_trst)
 772         {
 773                 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
 774                  * and inform possible listeners about this
 775                  */
 776                 LOG_DEBUG("TRST line asserted");
 777                 tap_set_state(TAP_RESET);
 778                 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 779         }
 780         else
 781         {
 782                 if (jtag_ntrst_delay)
 783                         jtag_add_sleep(jtag_ntrst_delay * 1000);
 784         }
 785 }
 786
 787 tap_state_t jtag_set_end_state(tap_state_t state)
 788 {
 789         if ((state == TAP_DRSHIFT)||(state == TAP_IRSHIFT))
 790         {
 791                 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
 792         }
 793
 794         if (state!=TAP_INVALID)
 795                 cmd_queue_end_state = state;
 796         return cmd_queue_end_state;
 797 }
 798
 799 tap_state_t jtag_get_end_state(void)
 800 {
 801         return cmd_queue_end_state;
 802 }
 803
 804 void jtag_add_sleep(u32 us)
 805 {
 806         keep_alive(); /* we might be running on a very slow JTAG clk */
 807         int retval=interface_jtag_add_sleep(us);
 808         if (retval!=ERROR_OK)
 809                 jtag_error=retval;
 810         return;
 811 }
 812
 813 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
 814 {
 815         int retval = ERROR_OK;
 816
 817         int compare_failed = 0;
 818
 819         if (in_check_mask)
 820                 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
 821         else
 822                 compare_failed = buf_cmp(captured, in_check_value, num_bits);
 823
 824         if (compare_failed){
 825                 /* An error handler could have caught the failing check
 826                  * only report a problem when there wasn't a handler, or if the handler
 827                  * acknowledged the error
 828                  */
 829                 /*
 830                 LOG_WARNING("TAP %s:",
 831                                         jtag_tap_name(field->tap));
 832                                         */
 833                 if (compare_failed)
 834                 {
 835                         char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 836                         char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 837
 838                         if (in_check_mask)
 839                         {
 840                                 char *in_check_mask_char;
 841                                 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 842                                 LOG_WARNING("value captured during scan didn't pass the requested check:");
 843                                 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
 844                                                         captured_char, in_check_value_char, in_check_mask_char);
 845                                 free(in_check_mask_char);
 846                         }
 847                         else
 848                         {
 849                                 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s", captured_char, in_check_value_char);
 850                         }
 851
 852                         free(captured_char);
 853                         free(in_check_value_char);
 854
 855                         retval = ERROR_JTAG_QUEUE_FAILED;
 856                 }
 857
 858         }
 859         return retval;
 860 }
 861
 862 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
 863 {
 864         assert(field->in_value != NULL);
 865
 866         if (value==NULL)
 867         {
 868                 /* no checking to do */
 869                 return;
 870         }
 871
 872         jtag_execute_queue_noclear();
 873
 874         int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
 875         jtag_set_error(retval);
 876 }
 877
 878
 879
 880 int default_interface_jtag_execute_queue(void)
 881 {
 882         if (NULL == jtag)
 883         {
 884                 LOG_ERROR("No JTAG interface configured yet.  "
 885                         "Issue 'init' command in startup scripts "
 886                         "before communicating with targets.");
 887                 return ERROR_FAIL;
 888         }
 889
 890         return jtag->execute_queue();
 891 }
 892
 893 void jtag_execute_queue_noclear(void)
 894 {
 895         /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
 896          * E.g. a JTAG over TCP/IP or USB....
 897          */
 898         jtag_flush_queue_count++;
 899
 900         int retval=interface_jtag_execute_queue();
 901         /* we keep the first error */
 902         if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
 903         {
 904                 jtag_error=retval;
 905         }
 906 }
 907
 908 int jtag_get_flush_queue_count(void)
 909 {
 910         return jtag_flush_queue_count;
 911 }
 912
 913 int jtag_execute_queue(void)
 914 {
 915         int retval;
 916         jtag_execute_queue_noclear();
 917         retval=jtag_error;
 918         jtag_error=ERROR_OK;
 919         return retval;
 920 }
 921
 922 static int jtag_reset_callback(enum jtag_event event, void *priv)
 923 {
 924         jtag_tap_t *tap = priv;
 925
 926         LOG_DEBUG("-");
 927
 928         if (event == JTAG_TRST_ASSERTED)
 929         {
 930                 buf_set_ones(tap->cur_instr, tap->ir_length);
 931                 tap->bypass = 1;
 932         }
 933
 934         return ERROR_OK;
 935 }
 936
 937 void jtag_sleep(u32 us)
 938 {
 939         alive_sleep(us/1000);
 940 }
 941
 942 /// maximum number of JTAG devices expected in the chain
 943 #define JTAG_MAX_CHAIN_SIZE 20
 944
 945 #define EXTRACT_MFG(X)  (((X) & 0xffe) >> 1)
 946 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
 947 #define EXTRACT_VER(X)  (((X) & 0xf0000000) >> 28)
 948
 949 /* Try to examine chain layout according to IEEE 1149.1 §12
 950  */
 951 static int jtag_examine_chain(void)
 952 {
 953         jtag_tap_t *tap;
 954         scan_field_t field;
 955         u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
 956         int i;
 957         int bit_count;
 958         int device_count = 0;
 959         u8 zero_check = 0x0;
 960         u8 one_check = 0xff;
 961
 962         field.tap = NULL;
 963         field.num_bits = sizeof(idcode_buffer) * 8;
 964         field.out_value = idcode_buffer;
 965
 966         field.in_value = idcode_buffer;
 967
 968
 969
 970
 971         for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
 972         {
 973                 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
 974         }
 975
 976         jtag_add_plain_dr_scan(1, &field, TAP_RESET);
 977         jtag_execute_queue();
 978
 979         for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
 980         {
 981                 zero_check |= idcode_buffer[i];
 982                 one_check &= idcode_buffer[i];
 983         }
 984
 985         /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
 986         if ((zero_check == 0x00) || (one_check == 0xff))
 987         {
 988                 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
 989                 return ERROR_JTAG_INIT_FAILED;
 990         }
 991
 992         /* point at the 1st tap */
 993         tap = jtag_tap_next_enabled(NULL);
 994         if( tap == NULL ){
 995                 LOG_ERROR("JTAG: No taps enabled?");
 996                 return ERROR_JTAG_INIT_FAILED;
 997         }
 998
 999         for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1000         {
1001                 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1002                 if ((idcode & 1) == 0)
1003                 {
1004                         /* LSB must not be 0, this indicates a device in bypass */
1005                         LOG_WARNING("Tap/Device does not have IDCODE");
1006                         idcode=0;
1007
1008                         bit_count += 1;
1009                 }
1010                 else
1011                 {
1012                         u32 manufacturer;
1013                         u32 part;
1014                         u32 version;
1015
1016                         /* some devices, such as AVR will output all 1's instead of TDI
1017                         input value at end of chain. */
1018                         if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1019                         {
1020                                 int unexpected=0;
1021                                 /* End of chain (invalid manufacturer ID)
1022                                  *
1023                                  * The JTAG examine is the very first thing that happens
1024                                  *
1025                                  * A single JTAG device requires only 64 bits to be read back correctly.
1026                                  *
1027                                  * The code below adds a check that the rest of the data scanned (640 bits)
1028                                  * are all as expected. This helps diagnose/catch problems with the JTAG chain
1029                                  *
1030                                  * earlier and gives more helpful/explicit error messages.
1031                                  */
1032                                 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1033                                 {
1034                                         idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1035                                         if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1036                                         {
1037                                                 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1038                                                 unexpected = 1;
1039                                         }
1040                                 }
1041
1042                                 break;
1043                         }
1044
1045                         manufacturer = EXTRACT_MFG(idcode);
1046                         part = EXTRACT_PART(idcode);
1047                         version = EXTRACT_VER(idcode);
1048
1049                         LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1050                                          ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1051                                 idcode, manufacturer, part, version);
1052
1053                         bit_count += 32;
1054                 }
1055                 device_count++;
1056                 if (!tap)
1057                         continue;
1058
1059                 tap->idcode = idcode;
1060
1061                 if (tap->expected_ids_cnt > 0) {
1062                         /* Loop over the expected identification codes and test for a match */
1063                         u8 ii;
1064                         for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1065                                 if( tap->idcode == tap->expected_ids[ii] ){
1066                                         break;
1067                                 }
1068                         }
1069
1070                         /* If none of the expected ids matched, log an error */
1071                         if (ii == tap->expected_ids_cnt) {
1072                                 LOG_ERROR("JTAG tap: %s             got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1073                                                   tap->dotted_name,
1074                                                   idcode,
1075                                                   EXTRACT_MFG( tap->idcode ),
1076                                                   EXTRACT_PART( tap->idcode ),
1077                                                   EXTRACT_VER( tap->idcode ) );
1078                                 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1079                                         LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1080                                                           tap->dotted_name,
1081                                                           ii + 1,
1082                                                           tap->expected_ids_cnt,
1083                                                           tap->expected_ids[ii],
1084                                                           EXTRACT_MFG( tap->expected_ids[ii] ),
1085                                                           EXTRACT_PART( tap->expected_ids[ii] ),
1086                                                           EXTRACT_VER( tap->expected_ids[ii] ) );
1087                                 }
1088
1089                                 return ERROR_JTAG_INIT_FAILED;
1090                         } else {
1091                                 LOG_INFO("JTAG Tap/device matched");
1092                         }
1093                 } else {
1094 #if 0
1095                         LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1096                                          tap->idcode);
1097 #endif
1098                 }
1099                 tap = jtag_tap_next_enabled(tap);
1100         }
1101
1102         /* see if number of discovered devices matches configuration */
1103         if (device_count != jtag_tap_count_enabled())
1104         {
1105                 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1106                                   device_count, jtag_tap_count_enabled(), jtag_tap_count());
1107                 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1108                 return ERROR_JTAG_INIT_FAILED;
1109         }
1110
1111         return ERROR_OK;
1112 }
1113
1114 static int jtag_validate_chain(void)
1115 {
1116         jtag_tap_t *tap;
1117         int total_ir_length = 0;
1118         u8 *ir_test = NULL;
1119         scan_field_t field;
1120         int chain_pos = 0;
1121
1122         tap = NULL;
1123         total_ir_length = 0;
1124         for(;;){
1125                 tap = jtag_tap_next_enabled(tap);
1126                 if( tap == NULL ){
1127                         break;
1128                 }
1129                 total_ir_length += tap->ir_length;
1130         }
1131
1132         total_ir_length += 2;
1133         ir_test = malloc(CEIL(total_ir_length, 8));
1134         buf_set_ones(ir_test, total_ir_length);
1135
1136         field.tap = NULL;
1137         field.num_bits = total_ir_length;
1138         field.out_value = ir_test;
1139         field.in_value = ir_test;
1140
1141
1142         jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1143         jtag_execute_queue();
1144
1145         tap = NULL;
1146         chain_pos = 0;
1147         int val;
1148         for(;;){
1149                 tap = jtag_tap_next_enabled(tap);
1150                 if( tap == NULL ){
1151                         break;
1152                 }
1153
1154                 val = buf_get_u32(ir_test, chain_pos, 2);
1155                 if (val != 0x1)
1156                 {
1157                         char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1158                         LOG_ERROR("Could not validate JTAG scan chain, IR mismatch, scan returned 0x%s. tap=%s pos=%d expected 0x1 got %0x", cbuf, jtag_tap_name(tap), chain_pos, val);
1159                         free(cbuf);
1160                         free(ir_test);
1161                         return ERROR_JTAG_INIT_FAILED;
1162                 }
1163                 chain_pos += tap->ir_length;
1164         }
1165
1166         val = buf_get_u32(ir_test, chain_pos, 2);
1167         if (val != 0x3)
1168         {
1169                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1170                 LOG_ERROR("Could not validate end of JTAG scan chain, IR mismatch, scan returned 0x%s. pos=%d expected 0x3 got %0x", cbuf, chain_pos, val);
1171                 free(cbuf);
1172                 free(ir_test);
1173                 return ERROR_JTAG_INIT_FAILED;
1174         }
1175
1176         free(ir_test);
1177
1178         return ERROR_OK;
1179 }
1180
1181 enum jtag_tap_cfg_param {
1182         JCFG_EVENT
1183 };
1184
1185 static Jim_Nvp nvp_config_opts[] = {
1186         { .name = "-event",      .value = JCFG_EVENT },
1187
1188         { .name = NULL,          .value = -1 }
1189 };
1190
1191 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1192 {
1193         Jim_Nvp *n;
1194         Jim_Obj *o;
1195         int e;
1196
1197         /* parse config or cget options */
1198         while (goi->argc > 0) {
1199                 Jim_SetEmptyResult (goi->interp);
1200
1201                 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1202                 if (e != JIM_OK) {
1203                         Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1204                         return e;
1205                 }
1206
1207                 switch (n->value) {
1208                         case JCFG_EVENT:
1209                                 if (goi->argc == 0) {
1210                                         Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1211                                         return JIM_ERR;
1212                                 }
1213
1214                                 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1215                                 if (e != JIM_OK) {
1216                                         Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1217                                         return e;
1218                                 }
1219
1220                                 if (goi->isconfigure) {
1221                                         if (goi->argc != 1) {
1222                                                 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1223                                                 return JIM_ERR;
1224                                         }
1225                                 } else {
1226                                         if (goi->argc != 0) {
1227                                                 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1228                                                 return JIM_ERR;
1229                                         }
1230                                 }
1231
1232                                 {
1233                                         jtag_tap_event_action_t *jteap;
1234
1235                                         jteap = tap->event_action;
1236                                         /* replace existing? */
1237                                         while (jteap) {
1238                                                 if (jteap->event == (enum jtag_tap_event)n->value) {
1239                                                         break;
1240                                                 }
1241                                                 jteap = jteap->next;
1242                                         }
1243
1244                                         if (goi->isconfigure) {
1245                                                 if (jteap == NULL) {
1246                                                         /* create new */
1247                                                         jteap = calloc(1, sizeof (*jteap));
1248                                                 }
1249                                                 jteap->event = n->value;
1250                                                 Jim_GetOpt_Obj( goi, &o);
1251                                                 if (jteap->body) {
1252                                                         Jim_DecrRefCount(interp, jteap->body);
1253                                                 }
1254                                                 jteap->body = Jim_DuplicateObj(goi->interp, o);
1255                                                 Jim_IncrRefCount(jteap->body);
1256
1257                                                 /* add to head of event list */
1258                                                 jteap->next = tap->event_action;
1259                                                 tap->event_action = jteap;
1260                                                 Jim_SetEmptyResult(goi->interp);
1261                                         } else {
1262                                                 /* get */
1263                                                 if (jteap == NULL) {
1264                                                         Jim_SetEmptyResult(goi->interp);
1265                                                 } else {
1266                                                         Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1267                                                 }
1268                                         }
1269                                 }
1270                                 /* loop for more */
1271                                 break;
1272                 }
1273         } /* while (goi->argc) */
1274
1275         return JIM_OK;
1276 }
1277
1278
1279 static void jtag_tap_init(jtag_tap_t *tap)
1280 {
1281         assert(0 != tap->ir_length);
1282
1283         tap->expected = malloc(tap->ir_length);
1284         tap->expected_mask = malloc(tap->ir_length);
1285         tap->cur_instr = malloc(tap->ir_length);
1286
1287         buf_set_u32(tap->expected, 0, tap->ir_length, tap->ir_capture_value);
1288         buf_set_u32(tap->expected_mask, 0, tap->ir_length, tap->ir_capture_mask);
1289         buf_set_ones(tap->cur_instr, tap->ir_length);
1290
1291         // place TAP in bypass mode
1292         tap->bypass = 1;
1293         // register the reset callback for the TAP
1294         jtag_register_event_callback(&jtag_reset_callback, tap);
1295
1296         LOG_DEBUG("Created Tap: %s @ abs position %d, "
1297                         "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1298                                 tap->abs_chain_position, tap->ir_length,
1299                                 tap->ir_capture_value, tap->ir_capture_mask);
1300         jtag_tap_add(tap);
1301 }
1302
1303 static void jtag_tap_free(jtag_tap_t *tap)
1304 {
1305         /// @todo is anything missing? no memory leaks please
1306         free((void *)tap->expected_ids);
1307         free((void *)tap->chip);
1308         free((void *)tap->tapname);
1309         free((void *)tap->dotted_name);
1310         free(tap);
1311 }
1312
1313 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1314 {
1315         jtag_tap_t *pTap;
1316         jim_wide w;
1317         int x;
1318         int e;
1319         int reqbits;
1320         Jim_Nvp *n;
1321         char *cp;
1322         const Jim_Nvp opts[] = {
1323 #define NTAP_OPT_IRLEN     0
1324                 { .name = "-irlen"                      ,       .value = NTAP_OPT_IRLEN },
1325 #define NTAP_OPT_IRMASK    1
1326                 { .name = "-irmask"                     ,       .value = NTAP_OPT_IRMASK },
1327 #define NTAP_OPT_IRCAPTURE 2
1328                 { .name = "-ircapture"          ,       .value = NTAP_OPT_IRCAPTURE },
1329 #define NTAP_OPT_ENABLED   3
1330                 { .name = "-enable"                     ,       .value = NTAP_OPT_ENABLED },
1331 #define NTAP_OPT_DISABLED  4
1332                 { .name = "-disable"            ,       .value = NTAP_OPT_DISABLED },
1333 #define NTAP_OPT_EXPECTED_ID 5
1334                 { .name = "-expected-id"        ,       .value = NTAP_OPT_EXPECTED_ID },
1335                 { .name = NULL                          ,       .value = -1 },
1336         };
1337
1338         pTap = malloc( sizeof(jtag_tap_t) );
1339         memset( pTap, 0, sizeof(*pTap) );
1340         if( !pTap ){
1341                 Jim_SetResult_sprintf( goi->interp, "no memory");
1342                 return JIM_ERR;
1343         }
1344         /*
1345          * we expect CHIP + TAP + OPTIONS
1346          * */
1347         if( goi->argc < 3 ){
1348                 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1349                 return JIM_ERR;
1350         }
1351         Jim_GetOpt_String( goi, &cp, NULL );
1352         pTap->chip = strdup(cp);
1353
1354         Jim_GetOpt_String( goi, &cp, NULL );
1355         pTap->tapname = strdup(cp);
1356
1357         /* name + dot + name + null */
1358         x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1359         cp = malloc( x );
1360         sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1361         pTap->dotted_name = cp;
1362
1363         LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1364                           pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1365
1366         /* default is enabled */
1367         pTap->enabled = 1;
1368
1369         /* deal with options */
1370 #define NTREQ_IRLEN      1
1371 #define NTREQ_IRCAPTURE  2
1372 #define NTREQ_IRMASK     4
1373
1374         /* clear them as we find them */
1375         reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1376
1377         while( goi->argc ){
1378                 e = Jim_GetOpt_Nvp( goi, opts, &n );
1379                 if( e != JIM_OK ){
1380                         Jim_GetOpt_NvpUnknown( goi, opts, 0 );
1381                         return e;
1382                 }
1383                 LOG_DEBUG("Processing option: %s", n->name );
1384                 switch( n->value ){
1385                 case NTAP_OPT_ENABLED:
1386                         pTap->enabled = 1;
1387                         break;
1388                 case NTAP_OPT_DISABLED:
1389                         pTap->enabled = 0;
1390                         break;
1391                 case NTAP_OPT_EXPECTED_ID:
1392                 {
1393                         u32 *new_expected_ids;
1394
1395                         e = Jim_GetOpt_Wide( goi, &w );
1396                         if( e != JIM_OK) {
1397                                 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
1398                                 return e;
1399                         }
1400
1401                         new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
1402                         if (new_expected_ids == NULL) {
1403                                 Jim_SetResult_sprintf( goi->interp, "no memory");
1404                                 return JIM_ERR;
1405                         }
1406
1407                         memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
1408
1409                         new_expected_ids[pTap->expected_ids_cnt] = w;
1410
1411                         free(pTap->expected_ids);
1412                         pTap->expected_ids = new_expected_ids;
1413                         pTap->expected_ids_cnt++;
1414                         break;
1415                 }
1416                 case NTAP_OPT_IRLEN:
1417                 case NTAP_OPT_IRMASK:
1418                 case NTAP_OPT_IRCAPTURE:
1419                         e = Jim_GetOpt_Wide( goi, &w );
1420                         if( e != JIM_OK ){
1421                                 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
1422                                 return e;
1423                         }
1424                         if( (w < 0) || (w > 0xffff) ){
1425                                 /* wacky value */
1426                                 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
1427                                                                            n->name, (int)(w), (int)(w));
1428                                 return JIM_ERR;
1429                         }
1430                         switch(n->value){
1431                         case NTAP_OPT_IRLEN:
1432                                 pTap->ir_length = w;
1433                                 reqbits &= (~(NTREQ_IRLEN));
1434                                 break;
1435                         case NTAP_OPT_IRMASK:
1436                                 pTap->ir_capture_mask = w;
1437                                 reqbits &= (~(NTREQ_IRMASK));
1438                                 break;
1439                         case NTAP_OPT_IRCAPTURE:
1440                                 pTap->ir_capture_value = w;
1441                                 reqbits &= (~(NTREQ_IRCAPTURE));
1442                                 break;
1443                         }
1444                 } /* switch(n->value) */
1445         } /* while( goi->argc ) */
1446
1447         /* Did all the required option bits get cleared? */
1448         if (0 == reqbits)
1449         {
1450                 jtag_tap_init(pTap);
1451                 return ERROR_OK;
1452         }
1453
1454         Jim_SetResult_sprintf(goi->interp,
1455                         "newtap: %s missing required parameters",
1456                         pTap->dotted_name);
1457         jtag_tap_free(pTap);
1458         return JIM_ERR;
1459 }
1460
1461 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
1462 {
1463         Jim_GetOptInfo goi;
1464         int e;
1465         Jim_Nvp *n;
1466         Jim_Obj *o;
1467         struct command_context_s *context;
1468
1469         enum {
1470                 JTAG_CMD_INTERFACE,
1471                 JTAG_CMD_INIT_RESET,
1472                 JTAG_CMD_NEWTAP,
1473                 JTAG_CMD_TAPENABLE,
1474                 JTAG_CMD_TAPDISABLE,
1475                 JTAG_CMD_TAPISENABLED,
1476                 JTAG_CMD_CONFIGURE,
1477                 JTAG_CMD_CGET
1478         };
1479
1480         const Jim_Nvp jtag_cmds[] = {
1481                 { .name = "interface"     , .value = JTAG_CMD_INTERFACE },
1482                 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
1483                 { .name = "newtap"        , .value = JTAG_CMD_NEWTAP },
1484                 { .name = "tapisenabled"     , .value = JTAG_CMD_TAPISENABLED },
1485                 { .name = "tapenable"     , .value = JTAG_CMD_TAPENABLE },
1486                 { .name = "tapdisable"    , .value = JTAG_CMD_TAPDISABLE },
1487                 { .name = "configure"     , .value = JTAG_CMD_CONFIGURE },
1488                 { .name = "cget"          , .value = JTAG_CMD_CGET },
1489
1490                 { .name = NULL, .value = -1 },
1491         };
1492
1493         context = Jim_GetAssocData(interp, "context");
1494         /* go past the command */
1495         Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
1496
1497         e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
1498         if( e != JIM_OK ){
1499                 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
1500                 return e;
1501         }
1502                 Jim_SetEmptyResult( goi.interp );
1503         switch( n->value ){
1504         case JTAG_CMD_INTERFACE:
1505                 /* return the name of the interface */
1506                 /* TCL code might need to know the exact type... */
1507                 /* FUTURE: we allow this as a means to "set" the interface. */
1508                 if( goi.argc != 0 ){
1509                         Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1510                         return JIM_ERR;
1511                 }
1512                 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
1513                 return JIM_OK;
1514         case JTAG_CMD_INIT_RESET:
1515                 if( goi.argc != 0 ){
1516                         Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1517                         return JIM_ERR;
1518                 }
1519                 e = jtag_init_reset(context);
1520                 if( e != ERROR_OK ){
1521                         Jim_SetResult_sprintf( goi.interp, "error: %d", e);
1522                         return JIM_ERR;
1523                 }
1524                 return JIM_OK;
1525         case JTAG_CMD_NEWTAP:
1526                 return jim_newtap_cmd( &goi );
1527                 break;
1528         case JTAG_CMD_TAPISENABLED:
1529         case JTAG_CMD_TAPENABLE:
1530         case JTAG_CMD_TAPDISABLE:
1531                 if( goi.argc != 1 ){
1532                         Jim_SetResultString( goi.interp, "Too many parameters",-1 );
1533                         return JIM_ERR;
1534                 }
1535
1536                 {
1537                         jtag_tap_t *t;
1538                         t = jtag_tap_by_jim_obj( goi.interp, goi.argv[0] );
1539                         if( t == NULL ){
1540                                 return JIM_ERR;
1541                         }
1542                         switch( n->value ){
1543                         case JTAG_CMD_TAPISENABLED:
1544                                 e = t->enabled;
1545                                 break;
1546                         case JTAG_CMD_TAPENABLE:
1547                                 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
1548                                 e = 1;
1549                                 t->enabled = e;
1550                                 break;
1551                         case JTAG_CMD_TAPDISABLE:
1552                                 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
1553                                 e = 0;
1554                                 t->enabled = e;
1555                                 break;
1556                         }
1557                         Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
1558                         return JIM_OK;
1559                 }
1560                 break;
1561
1562         case JTAG_CMD_CGET:
1563                 if( goi.argc < 2 ){
1564                         Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
1565                         return JIM_ERR;
1566                 }
1567
1568                 {
1569                         jtag_tap_t *t;
1570
1571                         Jim_GetOpt_Obj(&goi, &o);
1572                         t = jtag_tap_by_jim_obj( goi.interp, o );
1573                         if( t == NULL ){
1574                                 return JIM_ERR;
1575                         }
1576
1577                         goi.isconfigure = 0;
1578                         return jtag_tap_configure_cmd( &goi, t);
1579                 }
1580                 break;
1581
1582         case JTAG_CMD_CONFIGURE:
1583                 if( goi.argc < 3 ){
1584                         Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
1585                         return JIM_ERR;
1586                 }
1587
1588                 {
1589                         jtag_tap_t *t;
1590
1591                         Jim_GetOpt_Obj(&goi, &o);
1592                         t = jtag_tap_by_jim_obj( goi.interp, o );
1593                         if( t == NULL ){
1594                                 return JIM_ERR;
1595                         }
1596
1597                         goi.isconfigure = 1;
1598                         return jtag_tap_configure_cmd( &goi, t);
1599                 }
1600         }
1601
1602         return JIM_ERR;
1603 }
1604
1605 int jtag_register_commands(struct command_context_s *cmd_ctx)
1606 {
1607         register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
1608
1609         register_command(cmd_ctx, NULL, "interface", handle_interface_command,
1610                 COMMAND_CONFIG, "try to configure interface");
1611         register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
1612                 COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
1613         register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
1614                 COMMAND_ANY, "set maximum jtag speed (if supported); "
1615                 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1616         register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
1617                 COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1618         register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
1619                 COMMAND_ANY,
1620                 "[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
1621         register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
1622                 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1623         register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
1624                 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1625
1626         register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
1627                 COMMAND_EXEC, "print current scan chain configuration");
1628
1629         register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
1630                 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
1631         register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
1632                 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
1633         register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
1634                 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
1635         register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
1636                 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1637         register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1638         register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
1639
1640         register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
1641                 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
1642         register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
1643                 COMMAND_ANY, "verify value capture <enable|disable>");
1644         register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
1645                 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
1646         return ERROR_OK;
1647 }
1648
1649 int jtag_interface_init(struct command_context_s *cmd_ctx)
1650 {
1651         if (jtag)
1652                 return ERROR_OK;
1653
1654         if (!jtag_interface)
1655         {
1656                 /* nothing was previously specified by "interface" command */
1657                 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1658                 return ERROR_JTAG_INVALID_INTERFACE;
1659         }
1660         if(hasKHz)
1661         {
1662                 jtag_interface->khz(jtag_get_speed_khz(), &jtag_speed);
1663                 hasKHz = false;
1664         }
1665
1666         if (jtag_interface->init() != ERROR_OK)
1667                 return ERROR_JTAG_INIT_FAILED;
1668
1669         jtag = jtag_interface;
1670         return ERROR_OK;
1671 }
1672
1673 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1674 {
1675         jtag_tap_t *tap;
1676         int retval;
1677
1678         LOG_DEBUG("Init JTAG chain");
1679
1680         tap = jtag_tap_next_enabled(NULL);
1681         if( tap == NULL ){
1682                 LOG_ERROR("There are no enabled taps?");
1683                 return ERROR_JTAG_INIT_FAILED;
1684         }
1685
1686         jtag_add_tlr();
1687         if ((retval=jtag_execute_queue())!=ERROR_OK)
1688                 return retval;
1689
1690         /* examine chain first, as this could discover the real chain layout */
1691         if (jtag_examine_chain() != ERROR_OK)
1692         {
1693                 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1694         }
1695
1696         if (jtag_validate_chain() != ERROR_OK)
1697         {
1698                 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1699         }
1700
1701         return ERROR_OK;
1702 }
1703
1704 int jtag_interface_quit(void)
1705 {
1706         if (!jtag || !jtag->quit)
1707                 return ERROR_OK;
1708
1709         // close the JTAG interface
1710         int result = jtag->quit();
1711         if (ERROR_OK != result)
1712                 LOG_ERROR("failed: %d", result);
1713
1714         return ERROR_OK;
1715 }
1716
1717
1718 int jtag_init_reset(struct command_context_s *cmd_ctx)
1719 {
1720         int retval;
1721
1722         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1723                 return retval;
1724
1725         LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1726
1727         /* Reset can happen after a power cycle.
1728          *
1729          * Ideally we would only assert TRST or run RESET before the target reset.
1730          *
1731          * However w/srst_pulls_trst, trst is asserted together with the target
1732          * reset whether we want it or not.
1733          *
1734          * NB! Some targets have JTAG circuitry disabled until a
1735          * trst & srst has been asserted.
1736          *
1737          * NB! here we assume nsrst/ntrst delay are sufficient!
1738          *
1739          * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1740          *
1741          */
1742         jtag_add_reset(1, 0); /* RESET or TRST */
1743         if (jtag_reset_config & RESET_HAS_SRST)
1744         {
1745                 jtag_add_reset(1, 1);
1746                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
1747                         jtag_add_reset(0, 1);
1748         }
1749         jtag_add_reset(0, 0);
1750         if ((retval = jtag_execute_queue()) != ERROR_OK)
1751                 return retval;
1752
1753         /* Check that we can communication on the JTAG chain + eventually we want to
1754          * be able to perform enumeration only after OpenOCD has started
1755          * telnet and GDB server
1756          *
1757          * That would allow users to more easily perform any magic they need to before
1758          * reset happens.
1759          */
1760         return jtag_init_inner(cmd_ctx);
1761 }
1762
1763 int jtag_init(struct command_context_s *cmd_ctx)
1764 {
1765         int retval;
1766         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1767                 return retval;
1768         if (jtag_init_inner(cmd_ctx)==ERROR_OK)
1769         {
1770                 return ERROR_OK;
1771         }
1772         return jtag_init_reset(cmd_ctx);
1773 }
1774
1775 void jtag_set_speed_khz(unsigned khz)
1776 {
1777         speed_khz = khz;
1778 }
1779 unsigned jtag_get_speed_khz(void)
1780 {
1781         return speed_khz;
1782 }
1783
1784 static int default_khz(int khz, int *jtag_speed)
1785 {
1786         LOG_ERROR("Translation from khz to jtag_speed not implemented");
1787         return ERROR_FAIL;
1788 }
1789
1790 static int default_speed_div(int speed, int *khz)
1791 {
1792         LOG_ERROR("Translation from jtag_speed to khz not implemented");
1793         return ERROR_FAIL;
1794 }
1795
1796 static int default_power_dropout(int *dropout)
1797 {
1798         *dropout=0; /* by default we can't detect power dropout */
1799         return ERROR_OK;
1800 }
1801
1802 static int default_srst_asserted(int *srst_asserted)
1803 {
1804         *srst_asserted=0; /* by default we can't detect srst asserted */
1805         return ERROR_OK;
1806 }
1807
1808 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1809 {
1810         int i;
1811         int retval;
1812
1813         /* check whether the interface is already configured */
1814         if (jtag_interface)
1815         {
1816                 LOG_WARNING("Interface already configured, ignoring");
1817                 return ERROR_OK;
1818         }
1819
1820         /* interface name is a mandatory argument */
1821         if (argc < 1 || args[0][0] == '\0')
1822         {
1823                 return ERROR_COMMAND_SYNTAX_ERROR;
1824         }
1825
1826         for (i=0; jtag_interfaces[i]; i++)
1827         {
1828                 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
1829                 {
1830                         if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
1831                         {
1832                                 return retval;
1833                         }
1834
1835                         jtag_interface = jtag_interfaces[i];
1836
1837                         if (jtag_interface->khz == NULL)
1838                         {
1839                                 jtag_interface->khz = default_khz;
1840                         }
1841                         if (jtag_interface->speed_div == NULL)
1842                         {
1843                                 jtag_interface->speed_div = default_speed_div;
1844                         }
1845                         if (jtag_interface->power_dropout == NULL)
1846                         {
1847                                 jtag_interface->power_dropout = default_power_dropout;
1848                         }
1849                         if (jtag_interface->srst_asserted == NULL)
1850                         {
1851                                 jtag_interface->srst_asserted = default_srst_asserted;
1852                         }
1853
1854                         return ERROR_OK;
1855                 }
1856         }
1857
1858         /* no valid interface was found (i.e. the configuration option,
1859          * didn't match one of the compiled-in interfaces
1860          */
1861         LOG_ERROR("No valid jtag interface found (%s)", args[0]);
1862         LOG_ERROR("compiled-in jtag interfaces:");
1863         for (i = 0; jtag_interfaces[i]; i++)
1864         {
1865                 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
1866         }
1867
1868         return ERROR_JTAG_INVALID_INTERFACE;
1869 }
1870
1871 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1872 {
1873         int e;
1874         char buf[1024];
1875         Jim_Obj *newargs[ 10 ];
1876         /*
1877          * CONVERT SYNTAX
1878          * argv[-1] = command
1879          * argv[ 0] = ir length
1880          * argv[ 1] = ir capture
1881          * argv[ 2] = ir mask
1882          * argv[ 3] = not actually used by anything but in the docs
1883          */
1884
1885         if( argc < 4 ){
1886                 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1887                 return ERROR_OK;
1888         }
1889         command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1890         command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1891                                    args[0],
1892                                    args[1],
1893                                    args[2] );
1894         command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1895         command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1896         command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1897         command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
1898
1899         newargs[0] = Jim_NewStringObj( interp, "jtag", -1   );
1900         newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
1901         sprintf( buf, "chip%d", jtag_tap_count() );
1902         newargs[2] = Jim_NewStringObj( interp, buf, -1 );
1903         sprintf( buf, "tap%d", jtag_tap_count() );
1904         newargs[3] = Jim_NewStringObj( interp, buf, -1  );
1905         newargs[4] = Jim_NewStringObj( interp, "-irlen", -1  );
1906         newargs[5] = Jim_NewStringObj( interp, args[0], -1  );
1907         newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1  );
1908         newargs[7] = Jim_NewStringObj( interp, args[1], -1  );
1909         newargs[8] = Jim_NewStringObj( interp, "-irmask", -1  );
1910         newargs[9] = Jim_NewStringObj( interp, args[2], -1  );
1911
1912         command_print( cmd_ctx, "NEW COMMAND:");
1913         sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
1914                          Jim_GetString( newargs[0], NULL ),
1915                          Jim_GetString( newargs[1], NULL ),
1916                          Jim_GetString( newargs[2], NULL ),
1917                          Jim_GetString( newargs[3], NULL ),
1918                          Jim_GetString( newargs[4], NULL ),
1919                          Jim_GetString( newargs[5], NULL ),
1920                          Jim_GetString( newargs[6], NULL ),
1921                          Jim_GetString( newargs[7], NULL ),
1922                          Jim_GetString( newargs[8], NULL ),
1923                          Jim_GetString( newargs[9], NULL ) );
1924
1925         e = jim_jtag_command( interp, 10, newargs );
1926         if( e != JIM_OK ){
1927                 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
1928         }
1929         return e;
1930 }
1931
1932 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1933 {
1934         jtag_tap_t *tap;
1935
1936         tap = jtag_all_taps();
1937         command_print(cmd_ctx, "     TapName            | Enabled |   IdCode      Expected    IrLen IrCap  IrMask Instr     ");
1938         command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
1939
1940         while( tap ){
1941                 u32 expected, expected_mask, cur_instr, ii;
1942                 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
1943                 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
1944                 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
1945
1946                 command_print(cmd_ctx,
1947                                           "%2d | %-18s |    %c    | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1948                                           tap->abs_chain_position,
1949                                           tap->dotted_name,
1950                                           tap->enabled ? 'Y' : 'n',
1951                                           tap->idcode,
1952                                           (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
1953                                           tap->ir_length,
1954                                           expected,
1955                                           expected_mask,
1956                                           cur_instr);
1957
1958                 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
1959                         command_print(cmd_ctx, "   |                    |         |            | 0x%08x |      |      |      |         ",
1960                                                   tap->expected_ids[ii]);
1961                 }
1962
1963                 tap = tap->next_tap;
1964         }
1965
1966         return ERROR_OK;
1967 }
1968
1969 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1970 {
1971         int new_cfg = 0;
1972         int mask = 0;
1973
1974         if (argc < 1)
1975                 return ERROR_COMMAND_SYNTAX_ERROR;
1976
1977         /* Original versions cared about the order of these tokens:
1978          *   reset_config signals [combination [trst_type [srst_type]]]
1979          * They also clobbered the previous configuration even on error.
1980          *
1981          * Here we don't care about the order, and only change values
1982          * which have been explicitly specified.
1983          */
1984         for (; argc; argc--, args++) {
1985                 int tmp = 0;
1986                 int m;
1987
1988                 /* signals */
1989                 m = RESET_HAS_TRST | RESET_HAS_SRST;
1990                 if (strcmp(*args, "none") == 0)
1991                         tmp = RESET_NONE;
1992                 else if (strcmp(*args, "trst_only") == 0)
1993                         tmp = RESET_HAS_TRST;
1994                 else if (strcmp(*args, "srst_only") == 0)
1995                         tmp = RESET_HAS_SRST;
1996                 else if (strcmp(*args, "trst_and_srst") == 0)
1997                         tmp = RESET_HAS_TRST | RESET_HAS_SRST;
1998                 else
1999                         m = 0;
2000                 if (mask & m) {
2001                         LOG_ERROR("extra reset_config %s spec (%s)",
2002                                         "signal", *args);
2003                         return ERROR_INVALID_ARGUMENTS;
2004                 }
2005                 if (m)
2006                         goto next;
2007
2008                 /* combination (options for broken wiring) */
2009                 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2010                 if (strcmp(*args, "separate") == 0)
2011                         /* separate reset lines - default */;
2012                 else if (strcmp(*args, "srst_pulls_trst") == 0)
2013                         tmp |= RESET_SRST_PULLS_TRST;
2014                 else if (strcmp(*args, "trst_pulls_srst") == 0)
2015                         tmp |= RESET_TRST_PULLS_SRST;
2016                 else if (strcmp(*args, "combined") == 0)
2017                         tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2018                 else
2019                         m = 0;
2020                 if (mask & m) {
2021                         LOG_ERROR("extra reset_config %s spec (%s)",
2022                                         "combination", *args);
2023                         return ERROR_INVALID_ARGUMENTS;
2024                 }
2025                 if (m)
2026                         goto next;
2027
2028                 /* trst_type (NOP without HAS_TRST) */
2029                 m = RESET_TRST_OPEN_DRAIN;
2030                 if (strcmp(*args, "trst_open_drain") == 0)
2031                         tmp |= RESET_TRST_OPEN_DRAIN;
2032                 else if (strcmp(*args, "trst_push_pull") == 0)
2033                         /* push/pull from adapter - default */;
2034                 else
2035                         m = 0;
2036                 if (mask & m) {
2037                         LOG_ERROR("extra reset_config %s spec (%s)",
2038                                         "trst_type", *args);
2039                         return ERROR_INVALID_ARGUMENTS;
2040                 }
2041                 if (m)
2042                         goto next;
2043
2044                 /* srst_type (NOP without HAS_SRST) */
2045                 m |= RESET_SRST_PUSH_PULL;
2046                 if (strcmp(*args, "srst_push_pull") == 0)
2047                         tmp |= RESET_SRST_PUSH_PULL;
2048                 else if (strcmp(*args, "srst_open_drain") == 0)
2049                         /* open drain from adapter - default */;
2050                 else
2051                         m = 0;
2052                 if (mask & m) {
2053                         LOG_ERROR("extra reset_config %s spec (%s)",
2054                                         "srst_type", *args);
2055                         return ERROR_INVALID_ARGUMENTS;
2056                 }
2057                 if (m)
2058                         goto next;
2059
2060                 /* caller provided nonsense; fail */
2061                 LOG_ERROR("unknown reset_config flag (%s)", *args);
2062                 return ERROR_INVALID_ARGUMENTS;
2063
2064 next:
2065                 /* Remember the bits which were specified (mask)
2066                  * and their new values (new_cfg).
2067                  */
2068                 mask |= m;
2069                 new_cfg |= tmp;
2070         }
2071
2072         /* clear previous values of those bits, save new values */
2073         jtag_reset_config &= ~mask;
2074         jtag_reset_config |= new_cfg;
2075
2076         return ERROR_OK;
2077 }
2078
2079 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2080 {
2081         if (argc < 1)
2082         {
2083                 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2084                 exit(-1);
2085         }
2086         else
2087         {
2088                 jtag_set_nsrst_delay(strtoul(args[0], NULL, 0));
2089         }
2090
2091         return ERROR_OK;
2092 }
2093
2094 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2095 {
2096         if (argc < 1)
2097         {
2098                 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2099                 exit(-1);
2100         }
2101         else
2102         {
2103                 jtag_set_ntrst_delay(strtoul(args[0], NULL, 0));
2104         }
2105
2106         return ERROR_OK;
2107 }
2108
2109
2110 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2111 {
2112         int retval=ERROR_OK;
2113
2114         if (argc == 1)
2115         {
2116                 LOG_DEBUG("handle jtag speed");
2117
2118                 int cur_speed = 0;
2119                 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2120
2121                 /* this command can be called during CONFIG,
2122                  * in which case jtag isn't initialized */
2123                 if (jtag)
2124                 {
2125                         retval=jtag->speed(cur_speed);
2126                 }
2127         } else if (argc == 0)
2128         {
2129         } else
2130         {
2131                 return ERROR_COMMAND_SYNTAX_ERROR;
2132         }
2133         command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2134
2135         return retval;
2136 }
2137
2138 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2139 {
2140         int retval=ERROR_OK;
2141         LOG_DEBUG("handle jtag khz");
2142
2143         int cur_speed = 0;
2144         if(argc == 1)
2145         {
2146                 jtag_set_speed_khz(strtoul(args[0], NULL, 0));
2147                 if (jtag != NULL)
2148                 {
2149                         LOG_DEBUG("have interface set up");
2150                         int speed_div1;
2151                         if ((retval=jtag->khz(jtag_get_speed_khz(), &speed_div1))!=ERROR_OK)
2152                         {
2153                                 jtag_set_speed_khz(0);
2154                                 return retval;
2155                         }
2156
2157                         cur_speed = jtag_speed = speed_div1;
2158
2159                         retval=jtag->speed(cur_speed);
2160                 } else
2161                 {
2162                         hasKHz = true;
2163                 }
2164         } else if (argc==0)
2165         {
2166         } else
2167         {
2168                 return ERROR_COMMAND_SYNTAX_ERROR;
2169         }
2170         cur_speed = jtag_get_speed_khz();
2171
2172         if (jtag!=NULL)
2173         {
2174                 if ((retval=jtag->speed_div(jtag_speed, &cur_speed))!=ERROR_OK)
2175                         return retval;
2176         }
2177
2178         if (cur_speed)
2179                 command_print(cmd_ctx, "%d kHz", cur_speed);
2180         else
2181                 command_print(cmd_ctx, "RCLK - adaptive");
2182         return retval;
2183
2184 }
2185
2186 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2187 {
2188         if (argc < 1)
2189                 return ERROR_COMMAND_SYNTAX_ERROR;
2190
2191         tap_state_t state = tap_state_by_name(args[0]);
2192         if (state < 0)
2193         {
2194                 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2195                 return ERROR_COMMAND_SYNTAX_ERROR;
2196         }
2197         jtag_set_end_state(state);
2198         jtag_execute_queue();
2199
2200         command_print(cmd_ctx, "current endstate: %s",
2201                         tap_state_name(cmd_queue_end_state));
2202
2203         return ERROR_OK;
2204 }
2205
2206 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2207 {
2208         int trst = -1;
2209         int srst = -1;
2210
2211         if (argc < 2)
2212         {
2213                 return ERROR_COMMAND_SYNTAX_ERROR;
2214         }
2215
2216         if (args[0][0] == '1')
2217                 trst = 1;
2218         else if (args[0][0] == '0')
2219                 trst = 0;
2220         else
2221         {
2222                 return ERROR_COMMAND_SYNTAX_ERROR;
2223         }
2224
2225         if (args[1][0] == '1')
2226                 srst = 1;
2227         else if (args[1][0] == '0')
2228                 srst = 0;
2229         else
2230         {
2231                 return ERROR_COMMAND_SYNTAX_ERROR;
2232         }
2233
2234         if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2235                 return ERROR_JTAG_INIT_FAILED;
2236
2237         jtag_add_reset(trst, srst);
2238         jtag_execute_queue();
2239
2240         return ERROR_OK;
2241 }
2242
2243 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2244 {
2245         if (argc < 1)
2246         {
2247                 return ERROR_COMMAND_SYNTAX_ERROR;
2248         }
2249
2250         jtag_add_runtest(strtol(args[0], NULL, 0), jtag_get_end_state());
2251         jtag_execute_queue();
2252
2253         return ERROR_OK;
2254
2255 }
2256
2257 /*
2258  * For "irscan" or "drscan" commands, the "end" (really, "next") state
2259  * should be stable ... and *NOT* a shift state, otherwise free-running
2260  * jtag clocks could change the values latched by the update state.
2261  */
2262 static bool scan_is_safe(tap_state_t state)
2263 {
2264         switch (state)
2265         {
2266         case TAP_RESET:
2267         case TAP_IDLE:
2268         case TAP_DRPAUSE:
2269         case TAP_IRPAUSE:
2270                 return true;
2271         default:
2272                 return false;
2273         }
2274 }
2275
2276
2277 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2278 {
2279         int i;
2280         scan_field_t *fields;
2281         jtag_tap_t *tap;
2282         tap_state_t endstate;
2283
2284         if ((argc < 2) || (argc % 2))
2285         {
2286                 return ERROR_COMMAND_SYNTAX_ERROR;
2287         }
2288
2289         /* optional "-endstate" "statename" at the end of the arguments,
2290          * so that e.g. IRPAUSE can let us load the data register before
2291          * entering RUN/IDLE to execute the instruction we load here.
2292          */
2293         endstate = TAP_IDLE;
2294
2295         if( argc >= 4 ){
2296                 /* have at least one pair of numbers. */
2297                 /* is last pair the magic text? */
2298                 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2299                         const char *cpA;
2300                         const char *cpS;
2301                         cpA = args[ argc-1 ];
2302                         for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2303                                 cpS = tap_state_name( endstate );
2304                                 if( 0 == strcmp( cpA, cpS ) ){
2305                                         break;
2306                                 }
2307                         }
2308                         if( endstate >= TAP_NUM_STATES ){
2309                                 return ERROR_COMMAND_SYNTAX_ERROR;
2310                         } else {
2311                                 if (!scan_is_safe(endstate))
2312                                         LOG_WARNING("irscan with unsafe "
2313                                                         "endstate \"%s\"", cpA);
2314                                 /* found - remove the last 2 args */
2315                                 argc -= 2;
2316                         }
2317                 }
2318         }
2319
2320         int num_fields = argc / 2;
2321
2322         fields = malloc(sizeof(scan_field_t) * num_fields);
2323
2324         for (i = 0; i < num_fields; i++)
2325         {
2326                 tap = jtag_tap_by_string( args[i*2] );
2327                 if (tap==NULL)
2328                 {
2329                         command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2330                         return ERROR_FAIL;
2331                 }
2332                 int field_size = tap->ir_length;
2333                 fields[i].tap = tap;
2334                 fields[i].num_bits = field_size;
2335                 fields[i].out_value = malloc(CEIL(field_size, 8));
2336                 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2337                 fields[i].in_value = NULL;
2338         }
2339
2340         /* did we have an endstate? */
2341         jtag_add_ir_scan(num_fields, fields, endstate);
2342
2343         int retval=jtag_execute_queue();
2344
2345         for (i = 0; i < num_fields; i++)
2346                 free(fields[i].out_value);
2347
2348         free (fields);
2349
2350         return retval;
2351 }
2352
2353 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2354 {
2355         int retval;
2356         scan_field_t *fields;
2357         int num_fields;
2358         int field_count = 0;
2359         int i, e;
2360         jtag_tap_t *tap;
2361         tap_state_t endstate;
2362
2363         /* args[1] = device
2364          * args[2] = num_bits
2365          * args[3] = hex string
2366          * ... repeat num bits and hex string ...
2367          *
2368          * .. optionally:
2369         *     args[N-2] = "-endstate"
2370          *     args[N-1] = statename
2371          */
2372         if ((argc < 4) || ((argc % 2)!=0))
2373         {
2374                 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2375                 return JIM_ERR;
2376         }
2377
2378         endstate = TAP_IDLE;
2379
2380         /* validate arguments as numbers */
2381         e = JIM_OK;
2382         for (i = 2; i < argc; i+=2)
2383         {
2384                 long bits;
2385                 const char *cp;
2386
2387                 e = Jim_GetLong(interp, args[i], &bits);
2388                 /* If valid - try next arg */
2389                 if( e == JIM_OK ){
2390                         continue;
2391                 }
2392
2393                 /* Not valid.. are we at the end? */
2394                 if ( ((i+2) != argc) ){
2395                         /* nope, then error */
2396                         return e;
2397                 }
2398
2399                 /* it could be: "-endstate FOO"
2400                  * e.g. DRPAUSE so we can issue more instructions
2401                  * before entering RUN/IDLE and executing them.
2402                  */
2403
2404                 /* get arg as a string. */
2405                 cp = Jim_GetString( args[i], NULL );
2406                 /* is it the magic? */
2407                 if( 0 == strcmp( "-endstate", cp ) ){
2408                         /* is the statename valid? */
2409                         cp = Jim_GetString( args[i+1], NULL );
2410
2411                         /* see if it is a valid state name */
2412                         endstate = tap_state_by_name(cp);
2413                         if( endstate < 0 ){
2414                                 /* update the error message */
2415                                 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2416                         } else {
2417                                 if (!scan_is_safe(endstate))
2418                                         LOG_WARNING("drscan with unsafe "
2419                                                         "endstate \"%s\"", cp);
2420
2421                                 /* valid - so clear the error */
2422                                 e = JIM_OK;
2423                                 /* and remove the last 2 args */
2424                                 argc -= 2;
2425                         }
2426                 }
2427
2428                 /* Still an error? */
2429                 if( e != JIM_OK ){
2430                         return e; /* too bad */
2431                 }
2432         } /* validate args */
2433
2434         tap = jtag_tap_by_jim_obj( interp, args[1] );
2435         if( tap == NULL ){
2436                 return JIM_ERR;
2437         }
2438
2439         num_fields=(argc-2)/2;
2440         fields = malloc(sizeof(scan_field_t) * num_fields);
2441         for (i = 2; i < argc; i+=2)
2442         {
2443                 long bits;
2444                 int len;
2445                 const char *str;
2446
2447                 Jim_GetLong(interp, args[i], &bits);
2448                 str = Jim_GetString(args[i+1], &len);
2449
2450                 fields[field_count].tap = tap;
2451                 fields[field_count].num_bits = bits;
2452                 fields[field_count].out_value = malloc(CEIL(bits, 8));
2453                 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
2454                 fields[field_count].in_value = fields[field_count].out_value;
2455                 field_count++;
2456         }
2457
2458         jtag_add_dr_scan(num_fields, fields, endstate);
2459
2460         retval = jtag_execute_queue();
2461         if (retval != ERROR_OK)
2462         {
2463                 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
2464                 return JIM_ERR;
2465         }
2466
2467         field_count=0;
2468         Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
2469         for (i = 2; i < argc; i+=2)
2470         {
2471                 long bits;
2472                 char *str;
2473
2474                 Jim_GetLong(interp, args[i], &bits);
2475                 str = buf_to_str(fields[field_count].in_value, bits, 16);
2476                 free(fields[field_count].out_value);
2477
2478                 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
2479                 free(str);
2480                 field_count++;
2481         }
2482
2483         Jim_SetResult(interp, list);
2484
2485         free(fields);
2486
2487         return JIM_OK;
2488 }
2489
2490
2491 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2492 {
2493         Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_get_flush_queue_count()));
2494
2495         return JIM_OK;
2496 }
2497
2498
2499 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2500 {
2501         if (argc == 1)
2502         {
2503                 if (strcmp(args[0], "enable") == 0)
2504                 {
2505                         jtag_verify_capture_ir = 1;
2506                 }
2507                 else if (strcmp(args[0], "disable") == 0)
2508                 {
2509                         jtag_verify_capture_ir = 0;
2510                 } else
2511                 {
2512                         return ERROR_COMMAND_SYNTAX_ERROR;
2513                 }
2514         } else if (argc != 0)
2515         {
2516                 return ERROR_COMMAND_SYNTAX_ERROR;
2517         }
2518
2519         command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
2520
2521         return ERROR_OK;
2522 }
2523
2524 void jtag_set_verify(bool enable)
2525 {
2526         jtag_verify = enable;
2527 }
2528
2529 bool jtag_will_verify()
2530 {
2531         return jtag_verify;
2532 }
2533
2534 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2535 {
2536         if (argc > 1)
2537                 return ERROR_COMMAND_SYNTAX_ERROR;
2538
2539         if (argc == 1)
2540         {
2541                 if (strcmp(args[0], "enable") == 0)
2542                         jtag_set_verify(true);
2543                 else if (strcmp(args[0], "disable") == 0)
2544                         jtag_set_verify(false);
2545                 else
2546                         return ERROR_COMMAND_SYNTAX_ERROR;
2547         }
2548
2549         const char *status = jtag_will_verify() ? "enabled": "disabled";
2550         command_print(cmd_ctx, "verify jtag capture is %s", status);
2551
2552         return ERROR_OK;
2553 }
2554
2555
2556 int jtag_power_dropout(int *dropout)
2557 {
2558         return jtag->power_dropout(dropout);
2559 }
2560
2561 int jtag_srst_asserted(int *srst_asserted)
2562 {
2563         return jtag->srst_asserted(srst_asserted);
2564 }
2565
2566 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
2567 {
2568         jtag_tap_event_action_t * jteap;
2569         int done;
2570
2571         jteap = tap->event_action;
2572
2573         done = 0;
2574         while (jteap) {
2575                 if (jteap->event == e) {
2576                         done = 1;
2577                         LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2578                                         tap->dotted_name,
2579                                         e,
2580                                         Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
2581                                         Jim_GetString(jteap->body, NULL) );
2582                         if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
2583                                 Jim_PrintErrorMessage(interp);
2584                         }
2585                 }
2586
2587                 jteap = jteap->next;
2588         }
2589
2590         if (!done) {
2591                 LOG_DEBUG( "event %d %s - no action",
2592                                 e,
2593                                 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
2594         }
2595 }
2596
2597 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2598 {
2599         if (argc > 1)
2600                 return ERROR_COMMAND_SYNTAX_ERROR;
2601
2602         if (argc == 1)
2603         {
2604                 bool use_new_table;
2605                 if (strcmp(args[0], "short") == 0)
2606                         use_new_table = true;
2607                 else if (strcmp(args[0], "long") == 0)
2608                         use_new_table = false;
2609                 else
2610                         return ERROR_COMMAND_SYNTAX_ERROR;
2611
2612                 tap_use_new_tms_table(use_new_table);
2613         }
2614
2615         command_print(cmd_ctx, "tms sequence is  %s",
2616                         tap_uses_new_tms_table() ? "short": "long");
2617
2618         return ERROR_OK;
2619 }
2620
2621 /**
2622  * Function jtag_add_statemove
2623  * moves from the current state to the goal \a state. This needs
2624  * to be handled according to the xsvf spec, see the XSTATE command
2625  * description.
2626  */
2627 int jtag_add_statemove(tap_state_t goal_state)
2628 {
2629         int retval = ERROR_OK;
2630
2631         tap_state_t moves[8];
2632         tap_state_t cur_state = cmd_queue_cur_state;
2633         int i;
2634         int tms_bits;
2635         int     tms_count;
2636
2637         LOG_DEBUG( "cur_state=%s goal_state=%s",
2638                 tap_state_name(cur_state),
2639                 tap_state_name(goal_state) );
2640
2641
2642         /*      From the XSVF spec, pertaining to XSTATE:
2643
2644                 For special states known as stable states (Test-Logic-Reset,
2645                 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2646                 predefined TAP state paths when the starting state is a stable state and
2647                 when the XSTATE specifies a new stable state (see the STATE command in
2648                 the [Ref 5] for the TAP state paths between stable states). For
2649                 non-stable states, XSTATE should specify a state that is only one TAP
2650                 state transition distance from the current TAP state to avoid undefined
2651                 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2652                 transition the TAP through a specific state path.
2653         */
2654
2655         if (goal_state==cur_state )
2656                 ;       /* nothing to do */
2657
2658         else if( goal_state==TAP_RESET )
2659         {
2660                 jtag_add_tlr();
2661         }
2662
2663         else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
2664         {
2665                 /*      note: unless tms_bits holds a path that agrees with [Ref 5] in above
2666                         spec, then this code is not fully conformant to the xsvf spec.  This
2667                         puts a burden on tap_get_tms_path() function from the xsvf spec.
2668                         If in doubt, you should confirm that that burden is being met.
2669                 */
2670
2671                 tms_bits  = tap_get_tms_path(cur_state, goal_state);
2672                 tms_count = tap_get_tms_path_len(cur_state, goal_state);
2673
2674                 assert( (unsigned) tms_count < DIM(moves) );
2675
2676                 for (i=0;   i<tms_count;   i++, tms_bits>>=1)
2677                 {
2678                         bool bit = tms_bits & 1;
2679
2680                         cur_state = tap_state_transition(cur_state, bit);
2681                         moves[i] = cur_state;
2682                 }
2683
2684                 jtag_add_pathmove(tms_count, moves);
2685         }
2686
2687         /*      else state must be immediately reachable in one clock cycle, and does not
2688                 need to be a stable state.
2689         */
2690         else if( tap_state_transition(cur_state, true)  == goal_state
2691                 ||   tap_state_transition(cur_state, false) == goal_state )
2692         {
2693                 /* move a single state */
2694                 moves[0] = goal_state;
2695                 jtag_add_pathmove( 1, moves );
2696         }
2697
2698         else
2699         {
2700                 retval = ERROR_FAIL;
2701         }
2702
2703         return retval;
2704 }
2705
2706 void jtag_set_nsrst_delay(unsigned delay)
2707 {
2708         jtag_nsrst_delay = delay;
2709 }
2710 void jtag_set_ntrst_delay(unsigned delay)
2711 {
2712         jtag_ntrst_delay = delay;
2713 }
2714
2715