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 (0 == tap->expected_ids_cnt)
1062                 {
1063                         // @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1064 #if 0
1065                         LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap->idcode)
1066                         LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1067 #endif
1068                         tap = jtag_tap_next_enabled(tap);
1069                         continue;
1070                 }
1071                         /* Loop over the expected identification codes and test for a match */
1072                 u8 ii;
1073                 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1074                         if (tap->idcode == tap->expected_ids[ii]) {
1075                                 break;
1076                         }
1077                 }
1078
1079                 /* If none of the expected ids matched, log an error */
1080                 if (ii == tap->expected_ids_cnt) {
1081                         LOG_ERROR("JTAG tap: %s             got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1082                                           tap->dotted_name,
1083                                           idcode,
1084                                           EXTRACT_MFG( tap->idcode ),
1085                                           EXTRACT_PART( tap->idcode ),
1086                                           EXTRACT_VER( tap->idcode ) );
1087                         for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1088                                 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1089                                                   tap->dotted_name,
1090                                                   ii + 1,
1091                                                   tap->expected_ids_cnt,
1092                                                   tap->expected_ids[ii],
1093                                                   EXTRACT_MFG( tap->expected_ids[ii] ),
1094                                                   EXTRACT_PART( tap->expected_ids[ii] ),
1095                                                   EXTRACT_VER( tap->expected_ids[ii] ) );
1096                         }
1097
1098                         return ERROR_JTAG_INIT_FAILED;
1099                 } else {
1100                         LOG_INFO("JTAG Tap/device matched");
1101                 }
1102
1103                 tap = jtag_tap_next_enabled(tap);
1104         }
1105
1106         /* see if number of discovered devices matches configuration */
1107         if (device_count != jtag_tap_count_enabled())
1108         {
1109                 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1110                                   device_count, jtag_tap_count_enabled(), jtag_tap_count());
1111                 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1112                 return ERROR_JTAG_INIT_FAILED;
1113         }
1114
1115         return ERROR_OK;
1116 }
1117
1118 static int jtag_validate_chain(void)
1119 {
1120         jtag_tap_t *tap;
1121         int total_ir_length = 0;
1122         u8 *ir_test = NULL;
1123         scan_field_t field;
1124         int chain_pos = 0;
1125
1126         tap = NULL;
1127         total_ir_length = 0;
1128         for(;;){
1129                 tap = jtag_tap_next_enabled(tap);
1130                 if( tap == NULL ){
1131                         break;
1132                 }
1133                 total_ir_length += tap->ir_length;
1134         }
1135
1136         total_ir_length += 2;
1137         ir_test = malloc(CEIL(total_ir_length, 8));
1138         buf_set_ones(ir_test, total_ir_length);
1139
1140         field.tap = NULL;
1141         field.num_bits = total_ir_length;
1142         field.out_value = ir_test;
1143         field.in_value = ir_test;
1144
1145
1146         jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1147         jtag_execute_queue();
1148
1149         tap = NULL;
1150         chain_pos = 0;
1151         int val;
1152         for(;;){
1153                 tap = jtag_tap_next_enabled(tap);
1154                 if( tap == NULL ){
1155                         break;
1156                 }
1157
1158                 val = buf_get_u32(ir_test, chain_pos, 2);
1159                 if (val != 0x1)
1160                 {
1161                         char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1162                         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);
1163                         free(cbuf);
1164                         free(ir_test);
1165                         return ERROR_JTAG_INIT_FAILED;
1166                 }
1167                 chain_pos += tap->ir_length;
1168         }
1169
1170         val = buf_get_u32(ir_test, chain_pos, 2);
1171         if (val != 0x3)
1172         {
1173                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1174                 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);
1175                 free(cbuf);
1176                 free(ir_test);
1177                 return ERROR_JTAG_INIT_FAILED;
1178         }
1179
1180         free(ir_test);
1181
1182         return ERROR_OK;
1183 }
1184
1185 enum jtag_tap_cfg_param {
1186         JCFG_EVENT
1187 };
1188
1189 static Jim_Nvp nvp_config_opts[] = {
1190         { .name = "-event",      .value = JCFG_EVENT },
1191
1192         { .name = NULL,          .value = -1 }
1193 };
1194
1195 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1196 {
1197         Jim_Nvp *n;
1198         Jim_Obj *o;
1199         int e;
1200
1201         /* parse config or cget options */
1202         while (goi->argc > 0) {
1203                 Jim_SetEmptyResult (goi->interp);
1204
1205                 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1206                 if (e != JIM_OK) {
1207                         Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1208                         return e;
1209                 }
1210
1211                 switch (n->value) {
1212                         case JCFG_EVENT:
1213                                 if (goi->argc == 0) {
1214                                         Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1215                                         return JIM_ERR;
1216                                 }
1217
1218                                 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1219                                 if (e != JIM_OK) {
1220                                         Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1221                                         return e;
1222                                 }
1223
1224                                 if (goi->isconfigure) {
1225                                         if (goi->argc != 1) {
1226                                                 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1227                                                 return JIM_ERR;
1228                                         }
1229                                 } else {
1230                                         if (goi->argc != 0) {
1231                                                 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1232                                                 return JIM_ERR;
1233                                         }
1234                                 }
1235
1236                                 {
1237                                         jtag_tap_event_action_t *jteap;
1238
1239                                         jteap = tap->event_action;
1240                                         /* replace existing? */
1241                                         while (jteap) {
1242                                                 if (jteap->event == (enum jtag_tap_event)n->value) {
1243                                                         break;
1244                                                 }
1245                                                 jteap = jteap->next;
1246                                         }
1247
1248                                         if (goi->isconfigure) {
1249                                                 if (jteap == NULL) {
1250                                                         /* create new */
1251                                                         jteap = calloc(1, sizeof (*jteap));
1252                                                 }
1253                                                 jteap->event = n->value;
1254                                                 Jim_GetOpt_Obj( goi, &o);
1255                                                 if (jteap->body) {
1256                                                         Jim_DecrRefCount(interp, jteap->body);
1257                                                 }
1258                                                 jteap->body = Jim_DuplicateObj(goi->interp, o);
1259                                                 Jim_IncrRefCount(jteap->body);
1260
1261                                                 /* add to head of event list */
1262                                                 jteap->next = tap->event_action;
1263                                                 tap->event_action = jteap;
1264                                                 Jim_SetEmptyResult(goi->interp);
1265                                         } else {
1266                                                 /* get */
1267                                                 if (jteap == NULL) {
1268                                                         Jim_SetEmptyResult(goi->interp);
1269                                                 } else {
1270                                                         Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1271                                                 }
1272                                         }
1273                                 }
1274                                 /* loop for more */
1275                                 break;
1276                 }
1277         } /* while (goi->argc) */
1278
1279         return JIM_OK;
1280 }
1281
1282
1283 static void jtag_tap_init(jtag_tap_t *tap)
1284 {
1285         assert(0 != tap->ir_length);
1286
1287         tap->expected = malloc(tap->ir_length);
1288         tap->expected_mask = malloc(tap->ir_length);
1289         tap->cur_instr = malloc(tap->ir_length);
1290
1291         buf_set_u32(tap->expected, 0, tap->ir_length, tap->ir_capture_value);
1292         buf_set_u32(tap->expected_mask, 0, tap->ir_length, tap->ir_capture_mask);
1293         buf_set_ones(tap->cur_instr, tap->ir_length);
1294
1295         // place TAP in bypass mode
1296         tap->bypass = 1;
1297         // register the reset callback for the TAP
1298         jtag_register_event_callback(&jtag_reset_callback, tap);
1299
1300         LOG_DEBUG("Created Tap: %s @ abs position %d, "
1301                         "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1302                                 tap->abs_chain_position, tap->ir_length,
1303                                 tap->ir_capture_value, tap->ir_capture_mask);
1304         jtag_tap_add(tap);
1305 }
1306
1307 static void jtag_tap_free(jtag_tap_t *tap)
1308 {
1309         /// @todo is anything missing? no memory leaks please
1310         free((void *)tap->expected_ids);
1311         free((void *)tap->chip);
1312         free((void *)tap->tapname);
1313         free((void *)tap->dotted_name);
1314         free(tap);
1315 }
1316
1317 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1318 {
1319         jtag_tap_t *pTap;
1320         jim_wide w;
1321         int x;
1322         int e;
1323         int reqbits;
1324         Jim_Nvp *n;
1325         char *cp;
1326         const Jim_Nvp opts[] = {
1327 #define NTAP_OPT_IRLEN     0
1328                 { .name = "-irlen"                      ,       .value = NTAP_OPT_IRLEN },
1329 #define NTAP_OPT_IRMASK    1
1330                 { .name = "-irmask"                     ,       .value = NTAP_OPT_IRMASK },
1331 #define NTAP_OPT_IRCAPTURE 2
1332                 { .name = "-ircapture"          ,       .value = NTAP_OPT_IRCAPTURE },
1333 #define NTAP_OPT_ENABLED   3
1334                 { .name = "-enable"                     ,       .value = NTAP_OPT_ENABLED },
1335 #define NTAP_OPT_DISABLED  4
1336                 { .name = "-disable"            ,       .value = NTAP_OPT_DISABLED },
1337 #define NTAP_OPT_EXPECTED_ID 5
1338                 { .name = "-expected-id"        ,       .value = NTAP_OPT_EXPECTED_ID },
1339                 { .name = NULL                          ,       .value = -1 },
1340         };
1341
1342         pTap = malloc( sizeof(jtag_tap_t) );
1343         memset( pTap, 0, sizeof(*pTap) );
1344         if( !pTap ){
1345                 Jim_SetResult_sprintf( goi->interp, "no memory");
1346                 return JIM_ERR;
1347         }
1348         /*
1349          * we expect CHIP + TAP + OPTIONS
1350          * */
1351         if( goi->argc < 3 ){
1352                 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1353                 return JIM_ERR;
1354         }
1355         Jim_GetOpt_String( goi, &cp, NULL );
1356         pTap->chip = strdup(cp);
1357
1358         Jim_GetOpt_String( goi, &cp, NULL );
1359         pTap->tapname = strdup(cp);
1360
1361         /* name + dot + name + null */
1362         x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1363         cp = malloc( x );
1364         sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1365         pTap->dotted_name = cp;
1366
1367         LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1368                           pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1369
1370         /* default is enabled */
1371         pTap->enabled = 1;
1372
1373         /* deal with options */
1374 #define NTREQ_IRLEN      1
1375 #define NTREQ_IRCAPTURE  2
1376 #define NTREQ_IRMASK     4
1377
1378         /* clear them as we find them */
1379         reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1380
1381         while( goi->argc ){
1382                 e = Jim_GetOpt_Nvp( goi, opts, &n );
1383                 if( e != JIM_OK ){
1384                         Jim_GetOpt_NvpUnknown( goi, opts, 0 );
1385                         return e;
1386                 }
1387                 LOG_DEBUG("Processing option: %s", n->name );
1388                 switch( n->value ){
1389                 case NTAP_OPT_ENABLED:
1390                         pTap->enabled = 1;
1391                         break;
1392                 case NTAP_OPT_DISABLED:
1393                         pTap->enabled = 0;
1394                         break;
1395                 case NTAP_OPT_EXPECTED_ID:
1396                 {
1397                         u32 *new_expected_ids;
1398
1399                         e = Jim_GetOpt_Wide( goi, &w );
1400                         if( e != JIM_OK) {
1401                                 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
1402                                 return e;
1403                         }
1404
1405                         new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
1406                         if (new_expected_ids == NULL) {
1407                                 Jim_SetResult_sprintf( goi->interp, "no memory");
1408                                 return JIM_ERR;
1409                         }
1410
1411                         memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
1412
1413                         new_expected_ids[pTap->expected_ids_cnt] = w;
1414
1415                         free(pTap->expected_ids);
1416                         pTap->expected_ids = new_expected_ids;
1417                         pTap->expected_ids_cnt++;
1418                         break;
1419                 }
1420                 case NTAP_OPT_IRLEN:
1421                 case NTAP_OPT_IRMASK:
1422                 case NTAP_OPT_IRCAPTURE:
1423                         e = Jim_GetOpt_Wide( goi, &w );
1424                         if( e != JIM_OK ){
1425                                 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
1426                                 return e;
1427                         }
1428                         if( (w < 0) || (w > 0xffff) ){
1429                                 /* wacky value */
1430                                 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
1431                                                                            n->name, (int)(w), (int)(w));
1432                                 return JIM_ERR;
1433                         }
1434                         switch(n->value){
1435                         case NTAP_OPT_IRLEN:
1436                                 pTap->ir_length = w;
1437                                 reqbits &= (~(NTREQ_IRLEN));
1438                                 break;
1439                         case NTAP_OPT_IRMASK:
1440                                 pTap->ir_capture_mask = w;
1441                                 reqbits &= (~(NTREQ_IRMASK));
1442                                 break;
1443                         case NTAP_OPT_IRCAPTURE:
1444                                 pTap->ir_capture_value = w;
1445                                 reqbits &= (~(NTREQ_IRCAPTURE));
1446                                 break;
1447                         }
1448                 } /* switch(n->value) */
1449         } /* while( goi->argc ) */
1450
1451         /* Did all the required option bits get cleared? */
1452         if (0 == reqbits)
1453         {
1454                 jtag_tap_init(pTap);
1455                 return ERROR_OK;
1456         }
1457
1458         Jim_SetResult_sprintf(goi->interp,
1459                         "newtap: %s missing required parameters",
1460                         pTap->dotted_name);
1461         jtag_tap_free(pTap);
1462         return JIM_ERR;
1463 }
1464
1465 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
1466 {
1467         Jim_GetOptInfo goi;
1468         int e;
1469         Jim_Nvp *n;
1470         Jim_Obj *o;
1471         struct command_context_s *context;
1472
1473         enum {
1474                 JTAG_CMD_INTERFACE,
1475                 JTAG_CMD_INIT_RESET,
1476                 JTAG_CMD_NEWTAP,
1477                 JTAG_CMD_TAPENABLE,
1478                 JTAG_CMD_TAPDISABLE,
1479                 JTAG_CMD_TAPISENABLED,
1480                 JTAG_CMD_CONFIGURE,
1481                 JTAG_CMD_CGET
1482         };
1483
1484         const Jim_Nvp jtag_cmds[] = {
1485                 { .name = "interface"     , .value = JTAG_CMD_INTERFACE },
1486                 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
1487                 { .name = "newtap"        , .value = JTAG_CMD_NEWTAP },
1488                 { .name = "tapisenabled"     , .value = JTAG_CMD_TAPISENABLED },
1489                 { .name = "tapenable"     , .value = JTAG_CMD_TAPENABLE },
1490                 { .name = "tapdisable"    , .value = JTAG_CMD_TAPDISABLE },
1491                 { .name = "configure"     , .value = JTAG_CMD_CONFIGURE },
1492                 { .name = "cget"          , .value = JTAG_CMD_CGET },
1493
1494                 { .name = NULL, .value = -1 },
1495         };
1496
1497         context = Jim_GetAssocData(interp, "context");
1498         /* go past the command */
1499         Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
1500
1501         e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
1502         if( e != JIM_OK ){
1503                 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
1504                 return e;
1505         }
1506                 Jim_SetEmptyResult( goi.interp );
1507         switch( n->value ){
1508         case JTAG_CMD_INTERFACE:
1509                 /* return the name of the interface */
1510                 /* TCL code might need to know the exact type... */
1511                 /* FUTURE: we allow this as a means to "set" the interface. */
1512                 if( goi.argc != 0 ){
1513                         Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1514                         return JIM_ERR;
1515                 }
1516                 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
1517                 return JIM_OK;
1518         case JTAG_CMD_INIT_RESET:
1519                 if( goi.argc != 0 ){
1520                         Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1521                         return JIM_ERR;
1522                 }
1523                 e = jtag_init_reset(context);
1524                 if( e != ERROR_OK ){
1525                         Jim_SetResult_sprintf( goi.interp, "error: %d", e);
1526                         return JIM_ERR;
1527                 }
1528                 return JIM_OK;
1529         case JTAG_CMD_NEWTAP:
1530                 return jim_newtap_cmd( &goi );
1531                 break;
1532         case JTAG_CMD_TAPISENABLED:
1533         case JTAG_CMD_TAPENABLE:
1534         case JTAG_CMD_TAPDISABLE:
1535                 if( goi.argc != 1 ){
1536                         Jim_SetResultString( goi.interp, "Too many parameters",-1 );
1537                         return JIM_ERR;
1538                 }
1539
1540                 {
1541                         jtag_tap_t *t;
1542                         t = jtag_tap_by_jim_obj( goi.interp, goi.argv[0] );
1543                         if( t == NULL ){
1544                                 return JIM_ERR;
1545                         }
1546                         switch( n->value ){
1547                         case JTAG_CMD_TAPISENABLED:
1548                                 e = t->enabled;
1549                                 break;
1550                         case JTAG_CMD_TAPENABLE:
1551                                 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
1552                                 e = 1;
1553                                 t->enabled = e;
1554                                 break;
1555                         case JTAG_CMD_TAPDISABLE:
1556                                 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
1557                                 e = 0;
1558                                 t->enabled = e;
1559                                 break;
1560                         }
1561                         Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
1562                         return JIM_OK;
1563                 }
1564                 break;
1565
1566         case JTAG_CMD_CGET:
1567                 if( goi.argc < 2 ){
1568                         Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
1569                         return JIM_ERR;
1570                 }
1571
1572                 {
1573                         jtag_tap_t *t;
1574
1575                         Jim_GetOpt_Obj(&goi, &o);
1576                         t = jtag_tap_by_jim_obj( goi.interp, o );
1577                         if( t == NULL ){
1578                                 return JIM_ERR;
1579                         }
1580
1581                         goi.isconfigure = 0;
1582                         return jtag_tap_configure_cmd( &goi, t);
1583                 }
1584                 break;
1585
1586         case JTAG_CMD_CONFIGURE:
1587                 if( goi.argc < 3 ){
1588                         Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
1589                         return JIM_ERR;
1590                 }
1591
1592                 {
1593                         jtag_tap_t *t;
1594
1595                         Jim_GetOpt_Obj(&goi, &o);
1596                         t = jtag_tap_by_jim_obj( goi.interp, o );
1597                         if( t == NULL ){
1598                                 return JIM_ERR;
1599                         }
1600
1601                         goi.isconfigure = 1;
1602                         return jtag_tap_configure_cmd( &goi, t);
1603                 }
1604         }
1605
1606         return JIM_ERR;
1607 }
1608
1609 int jtag_register_commands(struct command_context_s *cmd_ctx)
1610 {
1611         register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
1612
1613         register_command(cmd_ctx, NULL, "interface", handle_interface_command,
1614                 COMMAND_CONFIG, "try to configure interface");
1615         register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
1616                 COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
1617         register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
1618                 COMMAND_ANY, "set maximum jtag speed (if supported); "
1619                 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1620         register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
1621                 COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1622         register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
1623                 COMMAND_ANY,
1624                 "[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]");
1625         register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
1626                 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1627         register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
1628                 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1629
1630         register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
1631                 COMMAND_EXEC, "print current scan chain configuration");
1632
1633         register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
1634                 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
1635         register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
1636                 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
1637         register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
1638                 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
1639         register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
1640                 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1641         register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1642         register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
1643
1644         register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
1645                 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
1646         register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
1647                 COMMAND_ANY, "verify value capture <enable|disable>");
1648         register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
1649                 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
1650         return ERROR_OK;
1651 }
1652
1653 int jtag_interface_init(struct command_context_s *cmd_ctx)
1654 {
1655         if (jtag)
1656                 return ERROR_OK;
1657
1658         if (!jtag_interface)
1659         {
1660                 /* nothing was previously specified by "interface" command */
1661                 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1662                 return ERROR_JTAG_INVALID_INTERFACE;
1663         }
1664         if(hasKHz)
1665         {
1666                 jtag_interface->khz(jtag_get_speed_khz(), &jtag_speed);
1667                 hasKHz = false;
1668         }
1669
1670         if (jtag_interface->init() != ERROR_OK)
1671                 return ERROR_JTAG_INIT_FAILED;
1672
1673         jtag = jtag_interface;
1674         return ERROR_OK;
1675 }
1676
1677 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1678 {
1679         jtag_tap_t *tap;
1680         int retval;
1681
1682         LOG_DEBUG("Init JTAG chain");
1683
1684         tap = jtag_tap_next_enabled(NULL);
1685         if( tap == NULL ){
1686                 LOG_ERROR("There are no enabled taps?");
1687                 return ERROR_JTAG_INIT_FAILED;
1688         }
1689
1690         jtag_add_tlr();
1691         if ((retval=jtag_execute_queue())!=ERROR_OK)
1692                 return retval;
1693
1694         /* examine chain first, as this could discover the real chain layout */
1695         if (jtag_examine_chain() != ERROR_OK)
1696         {
1697                 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1698         }
1699
1700         if (jtag_validate_chain() != ERROR_OK)
1701         {
1702                 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1703         }
1704
1705         return ERROR_OK;
1706 }
1707
1708 int jtag_interface_quit(void)
1709 {
1710         if (!jtag || !jtag->quit)
1711                 return ERROR_OK;
1712
1713         // close the JTAG interface
1714         int result = jtag->quit();
1715         if (ERROR_OK != result)
1716                 LOG_ERROR("failed: %d", result);
1717
1718         return ERROR_OK;
1719 }
1720
1721
1722 int jtag_init_reset(struct command_context_s *cmd_ctx)
1723 {
1724         int retval;
1725
1726         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1727                 return retval;
1728
1729         LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1730
1731         /* Reset can happen after a power cycle.
1732          *
1733          * Ideally we would only assert TRST or run RESET before the target reset.
1734          *
1735          * However w/srst_pulls_trst, trst is asserted together with the target
1736          * reset whether we want it or not.
1737          *
1738          * NB! Some targets have JTAG circuitry disabled until a
1739          * trst & srst has been asserted.
1740          *
1741          * NB! here we assume nsrst/ntrst delay are sufficient!
1742          *
1743          * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1744          *
1745          */
1746         jtag_add_reset(1, 0); /* RESET or TRST */
1747         if (jtag_reset_config & RESET_HAS_SRST)
1748         {
1749                 jtag_add_reset(1, 1);
1750                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
1751                         jtag_add_reset(0, 1);
1752         }
1753         jtag_add_reset(0, 0);
1754         if ((retval = jtag_execute_queue()) != ERROR_OK)
1755                 return retval;
1756
1757         /* Check that we can communication on the JTAG chain + eventually we want to
1758          * be able to perform enumeration only after OpenOCD has started
1759          * telnet and GDB server
1760          *
1761          * That would allow users to more easily perform any magic they need to before
1762          * reset happens.
1763          */
1764         return jtag_init_inner(cmd_ctx);
1765 }
1766
1767 int jtag_init(struct command_context_s *cmd_ctx)
1768 {
1769         int retval;
1770         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1771                 return retval;
1772         if (jtag_init_inner(cmd_ctx)==ERROR_OK)
1773         {
1774                 return ERROR_OK;
1775         }
1776         return jtag_init_reset(cmd_ctx);
1777 }
1778
1779 void jtag_set_speed_khz(unsigned khz)
1780 {
1781         speed_khz = khz;
1782 }
1783 unsigned jtag_get_speed_khz(void)
1784 {
1785         return speed_khz;
1786 }
1787
1788 static int default_khz(int khz, int *jtag_speed)
1789 {
1790         LOG_ERROR("Translation from khz to jtag_speed not implemented");
1791         return ERROR_FAIL;
1792 }
1793
1794 static int default_speed_div(int speed, int *khz)
1795 {
1796         LOG_ERROR("Translation from jtag_speed to khz not implemented");
1797         return ERROR_FAIL;
1798 }
1799
1800 static int default_power_dropout(int *dropout)
1801 {
1802         *dropout=0; /* by default we can't detect power dropout */
1803         return ERROR_OK;
1804 }
1805
1806 static int default_srst_asserted(int *srst_asserted)
1807 {
1808         *srst_asserted=0; /* by default we can't detect srst asserted */
1809         return ERROR_OK;
1810 }
1811
1812 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1813 {
1814         int i;
1815         int retval;
1816
1817         /* check whether the interface is already configured */
1818         if (jtag_interface)
1819         {
1820                 LOG_WARNING("Interface already configured, ignoring");
1821                 return ERROR_OK;
1822         }
1823
1824         /* interface name is a mandatory argument */
1825         if (argc < 1 || args[0][0] == '\0')
1826         {
1827                 return ERROR_COMMAND_SYNTAX_ERROR;
1828         }
1829
1830         for (i=0; jtag_interfaces[i]; i++)
1831         {
1832                 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
1833                 {
1834                         if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
1835                         {
1836                                 return retval;
1837                         }
1838
1839                         jtag_interface = jtag_interfaces[i];
1840
1841                         if (jtag_interface->khz == NULL)
1842                         {
1843                                 jtag_interface->khz = default_khz;
1844                         }
1845                         if (jtag_interface->speed_div == NULL)
1846                         {
1847                                 jtag_interface->speed_div = default_speed_div;
1848                         }
1849                         if (jtag_interface->power_dropout == NULL)
1850                         {
1851                                 jtag_interface->power_dropout = default_power_dropout;
1852                         }
1853                         if (jtag_interface->srst_asserted == NULL)
1854                         {
1855                                 jtag_interface->srst_asserted = default_srst_asserted;
1856                         }
1857
1858                         return ERROR_OK;
1859                 }
1860         }
1861
1862         /* no valid interface was found (i.e. the configuration option,
1863          * didn't match one of the compiled-in interfaces
1864          */
1865         LOG_ERROR("No valid jtag interface found (%s)", args[0]);
1866         LOG_ERROR("compiled-in jtag interfaces:");
1867         for (i = 0; jtag_interfaces[i]; i++)
1868         {
1869                 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
1870         }
1871
1872         return ERROR_JTAG_INVALID_INTERFACE;
1873 }
1874
1875 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1876 {
1877         int e;
1878         char buf[1024];
1879         Jim_Obj *newargs[ 10 ];
1880         /*
1881          * CONVERT SYNTAX
1882          * argv[-1] = command
1883          * argv[ 0] = ir length
1884          * argv[ 1] = ir capture
1885          * argv[ 2] = ir mask
1886          * argv[ 3] = not actually used by anything but in the docs
1887          */
1888
1889         if( argc < 4 ){
1890                 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1891                 return ERROR_OK;
1892         }
1893         command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1894         command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1895                                    args[0],
1896                                    args[1],
1897                                    args[2] );
1898         command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1899         command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1900         command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1901         command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
1902
1903         newargs[0] = Jim_NewStringObj( interp, "jtag", -1   );
1904         newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
1905         sprintf( buf, "chip%d", jtag_tap_count() );
1906         newargs[2] = Jim_NewStringObj( interp, buf, -1 );
1907         sprintf( buf, "tap%d", jtag_tap_count() );
1908         newargs[3] = Jim_NewStringObj( interp, buf, -1  );
1909         newargs[4] = Jim_NewStringObj( interp, "-irlen", -1  );
1910         newargs[5] = Jim_NewStringObj( interp, args[0], -1  );
1911         newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1  );
1912         newargs[7] = Jim_NewStringObj( interp, args[1], -1  );
1913         newargs[8] = Jim_NewStringObj( interp, "-irmask", -1  );
1914         newargs[9] = Jim_NewStringObj( interp, args[2], -1  );
1915
1916         command_print( cmd_ctx, "NEW COMMAND:");
1917         sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
1918                          Jim_GetString( newargs[0], NULL ),
1919                          Jim_GetString( newargs[1], NULL ),
1920                          Jim_GetString( newargs[2], NULL ),
1921                          Jim_GetString( newargs[3], NULL ),
1922                          Jim_GetString( newargs[4], NULL ),
1923                          Jim_GetString( newargs[5], NULL ),
1924                          Jim_GetString( newargs[6], NULL ),
1925                          Jim_GetString( newargs[7], NULL ),
1926                          Jim_GetString( newargs[8], NULL ),
1927                          Jim_GetString( newargs[9], NULL ) );
1928
1929         e = jim_jtag_command( interp, 10, newargs );
1930         if( e != JIM_OK ){
1931                 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
1932         }
1933         return e;
1934 }
1935
1936 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1937 {
1938         jtag_tap_t *tap;
1939
1940         tap = jtag_all_taps();
1941         command_print(cmd_ctx, "     TapName            | Enabled |   IdCode      Expected    IrLen IrCap  IrMask Instr     ");
1942         command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
1943
1944         while( tap ){
1945                 u32 expected, expected_mask, cur_instr, ii;
1946                 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
1947                 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
1948                 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
1949
1950                 command_print(cmd_ctx,
1951                                           "%2d | %-18s |    %c    | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1952                                           tap->abs_chain_position,
1953                                           tap->dotted_name,
1954                                           tap->enabled ? 'Y' : 'n',
1955                                           tap->idcode,
1956                                           (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
1957                                           tap->ir_length,
1958                                           expected,
1959                                           expected_mask,
1960                                           cur_instr);
1961
1962                 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
1963                         command_print(cmd_ctx, "   |                    |         |            | 0x%08x |      |      |      |         ",
1964                                                   tap->expected_ids[ii]);
1965                 }
1966
1967                 tap = tap->next_tap;
1968         }
1969
1970         return ERROR_OK;
1971 }
1972
1973 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1974 {
1975         int new_cfg = 0;
1976         int mask = 0;
1977
1978         if (argc < 1)
1979                 return ERROR_COMMAND_SYNTAX_ERROR;
1980
1981         /* Original versions cared about the order of these tokens:
1982          *   reset_config signals [combination [trst_type [srst_type]]]
1983          * They also clobbered the previous configuration even on error.
1984          *
1985          * Here we don't care about the order, and only change values
1986          * which have been explicitly specified.
1987          */
1988         for (; argc; argc--, args++) {
1989                 int tmp = 0;
1990                 int m;
1991
1992                 /* signals */
1993                 m = RESET_HAS_TRST | RESET_HAS_SRST;
1994                 if (strcmp(*args, "none") == 0)
1995                         tmp = RESET_NONE;
1996                 else if (strcmp(*args, "trst_only") == 0)
1997                         tmp = RESET_HAS_TRST;
1998                 else if (strcmp(*args, "srst_only") == 0)
1999                         tmp = RESET_HAS_SRST;
2000                 else if (strcmp(*args, "trst_and_srst") == 0)
2001                         tmp = RESET_HAS_TRST | RESET_HAS_SRST;
2002                 else
2003                         m = 0;
2004                 if (mask & m) {
2005                         LOG_ERROR("extra reset_config %s spec (%s)",
2006                                         "signal", *args);
2007                         return ERROR_INVALID_ARGUMENTS;
2008                 }
2009                 if (m)
2010                         goto next;
2011
2012                 /* combination (options for broken wiring) */
2013                 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2014                 if (strcmp(*args, "separate") == 0)
2015                         /* separate reset lines - default */;
2016                 else if (strcmp(*args, "srst_pulls_trst") == 0)
2017                         tmp |= RESET_SRST_PULLS_TRST;
2018                 else if (strcmp(*args, "trst_pulls_srst") == 0)
2019                         tmp |= RESET_TRST_PULLS_SRST;
2020                 else if (strcmp(*args, "combined") == 0)
2021                         tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2022                 else
2023                         m = 0;
2024                 if (mask & m) {
2025                         LOG_ERROR("extra reset_config %s spec (%s)",
2026                                         "combination", *args);
2027                         return ERROR_INVALID_ARGUMENTS;
2028                 }
2029                 if (m)
2030                         goto next;
2031
2032                 /* trst_type (NOP without HAS_TRST) */
2033                 m = RESET_TRST_OPEN_DRAIN;
2034                 if (strcmp(*args, "trst_open_drain") == 0)
2035                         tmp |= RESET_TRST_OPEN_DRAIN;
2036                 else if (strcmp(*args, "trst_push_pull") == 0)
2037                         /* push/pull from adapter - default */;
2038                 else
2039                         m = 0;
2040                 if (mask & m) {
2041                         LOG_ERROR("extra reset_config %s spec (%s)",
2042                                         "trst_type", *args);
2043                         return ERROR_INVALID_ARGUMENTS;
2044                 }
2045                 if (m)
2046                         goto next;
2047
2048                 /* srst_type (NOP without HAS_SRST) */
2049                 m |= RESET_SRST_PUSH_PULL;
2050                 if (strcmp(*args, "srst_push_pull") == 0)
2051                         tmp |= RESET_SRST_PUSH_PULL;
2052                 else if (strcmp(*args, "srst_open_drain") == 0)
2053                         /* open drain from adapter - default */;
2054                 else
2055                         m = 0;
2056                 if (mask & m) {
2057                         LOG_ERROR("extra reset_config %s spec (%s)",
2058                                         "srst_type", *args);
2059                         return ERROR_INVALID_ARGUMENTS;
2060                 }
2061                 if (m)
2062                         goto next;
2063
2064                 /* caller provided nonsense; fail */
2065                 LOG_ERROR("unknown reset_config flag (%s)", *args);
2066                 return ERROR_INVALID_ARGUMENTS;
2067
2068 next:
2069                 /* Remember the bits which were specified (mask)
2070                  * and their new values (new_cfg).
2071                  */
2072                 mask |= m;
2073                 new_cfg |= tmp;
2074         }
2075
2076         /* clear previous values of those bits, save new values */
2077         jtag_reset_config &= ~mask;
2078         jtag_reset_config |= new_cfg;
2079
2080         return ERROR_OK;
2081 }
2082
2083 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2084 {
2085         if (argc < 1)
2086         {
2087                 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2088                 exit(-1);
2089         }
2090         else
2091         {
2092                 jtag_set_nsrst_delay(strtoul(args[0], NULL, 0));
2093         }
2094
2095         return ERROR_OK;
2096 }
2097
2098 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2099 {
2100         if (argc < 1)
2101         {
2102                 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2103                 exit(-1);
2104         }
2105         else
2106         {
2107                 jtag_set_ntrst_delay(strtoul(args[0], NULL, 0));
2108         }
2109
2110         return ERROR_OK;
2111 }
2112
2113
2114 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2115 {
2116         int retval=ERROR_OK;
2117
2118         if (argc == 1)
2119         {
2120                 LOG_DEBUG("handle jtag speed");
2121
2122                 int cur_speed = 0;
2123                 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2124
2125                 /* this command can be called during CONFIG,
2126                  * in which case jtag isn't initialized */
2127                 if (jtag)
2128                 {
2129                         retval=jtag->speed(cur_speed);
2130                 }
2131         } else if (argc == 0)
2132         {
2133         } else
2134         {
2135                 return ERROR_COMMAND_SYNTAX_ERROR;
2136         }
2137         command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2138
2139         return retval;
2140 }
2141
2142 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2143 {
2144         int retval=ERROR_OK;
2145         LOG_DEBUG("handle jtag khz");
2146
2147         int cur_speed = 0;
2148         if(argc == 1)
2149         {
2150                 jtag_set_speed_khz(strtoul(args[0], NULL, 0));
2151                 if (jtag != NULL)
2152                 {
2153                         LOG_DEBUG("have interface set up");
2154                         int speed_div1;
2155                         if ((retval=jtag->khz(jtag_get_speed_khz(), &speed_div1))!=ERROR_OK)
2156                         {
2157                                 jtag_set_speed_khz(0);
2158                                 return retval;
2159                         }
2160
2161                         cur_speed = jtag_speed = speed_div1;
2162
2163                         retval=jtag->speed(cur_speed);
2164                 } else
2165                 {
2166                         hasKHz = true;
2167                 }
2168         } else if (argc==0)
2169         {
2170         } else
2171         {
2172                 return ERROR_COMMAND_SYNTAX_ERROR;
2173         }
2174         cur_speed = jtag_get_speed_khz();
2175
2176         if (jtag!=NULL)
2177         {
2178                 if ((retval=jtag->speed_div(jtag_speed, &cur_speed))!=ERROR_OK)
2179                         return retval;
2180         }
2181
2182         if (cur_speed)
2183                 command_print(cmd_ctx, "%d kHz", cur_speed);
2184         else
2185                 command_print(cmd_ctx, "RCLK - adaptive");
2186         return retval;
2187
2188 }
2189
2190 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2191 {
2192         if (argc < 1)
2193                 return ERROR_COMMAND_SYNTAX_ERROR;
2194
2195         tap_state_t state = tap_state_by_name(args[0]);
2196         if (state < 0)
2197         {
2198                 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2199                 return ERROR_COMMAND_SYNTAX_ERROR;
2200         }
2201         jtag_set_end_state(state);
2202         jtag_execute_queue();
2203
2204         command_print(cmd_ctx, "current endstate: %s",
2205                         tap_state_name(cmd_queue_end_state));
2206
2207         return ERROR_OK;
2208 }
2209
2210 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2211 {
2212         int trst = -1;
2213         int srst = -1;
2214
2215         if (argc < 2)
2216         {
2217                 return ERROR_COMMAND_SYNTAX_ERROR;
2218         }
2219
2220         if (args[0][0] == '1')
2221                 trst = 1;
2222         else if (args[0][0] == '0')
2223                 trst = 0;
2224         else
2225         {
2226                 return ERROR_COMMAND_SYNTAX_ERROR;
2227         }
2228
2229         if (args[1][0] == '1')
2230                 srst = 1;
2231         else if (args[1][0] == '0')
2232                 srst = 0;
2233         else
2234         {
2235                 return ERROR_COMMAND_SYNTAX_ERROR;
2236         }
2237
2238         if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2239                 return ERROR_JTAG_INIT_FAILED;
2240
2241         jtag_add_reset(trst, srst);
2242         jtag_execute_queue();
2243
2244         return ERROR_OK;
2245 }
2246
2247 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2248 {
2249         if (argc < 1)
2250         {
2251                 return ERROR_COMMAND_SYNTAX_ERROR;
2252         }
2253
2254         jtag_add_runtest(strtol(args[0], NULL, 0), jtag_get_end_state());
2255         jtag_execute_queue();
2256
2257         return ERROR_OK;
2258
2259 }
2260
2261 /*
2262  * For "irscan" or "drscan" commands, the "end" (really, "next") state
2263  * should be stable ... and *NOT* a shift state, otherwise free-running
2264  * jtag clocks could change the values latched by the update state.
2265  */
2266 static bool scan_is_safe(tap_state_t state)
2267 {
2268         switch (state)
2269         {
2270         case TAP_RESET:
2271         case TAP_IDLE:
2272         case TAP_DRPAUSE:
2273         case TAP_IRPAUSE:
2274                 return true;
2275         default:
2276                 return false;
2277         }
2278 }
2279
2280
2281 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2282 {
2283         int i;
2284         scan_field_t *fields;
2285         jtag_tap_t *tap;
2286         tap_state_t endstate;
2287
2288         if ((argc < 2) || (argc % 2))
2289         {
2290                 return ERROR_COMMAND_SYNTAX_ERROR;
2291         }
2292
2293         /* optional "-endstate" "statename" at the end of the arguments,
2294          * so that e.g. IRPAUSE can let us load the data register before
2295          * entering RUN/IDLE to execute the instruction we load here.
2296          */
2297         endstate = TAP_IDLE;
2298
2299         if( argc >= 4 ){
2300                 /* have at least one pair of numbers. */
2301                 /* is last pair the magic text? */
2302                 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2303                         const char *cpA;
2304                         const char *cpS;
2305                         cpA = args[ argc-1 ];
2306                         for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2307                                 cpS = tap_state_name( endstate );
2308                                 if( 0 == strcmp( cpA, cpS ) ){
2309                                         break;
2310                                 }
2311                         }
2312                         if( endstate >= TAP_NUM_STATES ){
2313                                 return ERROR_COMMAND_SYNTAX_ERROR;
2314                         } else {
2315                                 if (!scan_is_safe(endstate))
2316                                         LOG_WARNING("irscan with unsafe "
2317                                                         "endstate \"%s\"", cpA);
2318                                 /* found - remove the last 2 args */
2319                                 argc -= 2;
2320                         }
2321                 }
2322         }
2323
2324         int num_fields = argc / 2;
2325
2326         fields = malloc(sizeof(scan_field_t) * num_fields);
2327
2328         for (i = 0; i < num_fields; i++)
2329         {
2330                 tap = jtag_tap_by_string( args[i*2] );
2331                 if (tap==NULL)
2332                 {
2333                         command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2334                         return ERROR_FAIL;
2335                 }
2336                 int field_size = tap->ir_length;
2337                 fields[i].tap = tap;
2338                 fields[i].num_bits = field_size;
2339                 fields[i].out_value = malloc(CEIL(field_size, 8));
2340                 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2341                 fields[i].in_value = NULL;
2342         }
2343
2344         /* did we have an endstate? */
2345         jtag_add_ir_scan(num_fields, fields, endstate);
2346
2347         int retval=jtag_execute_queue();
2348
2349         for (i = 0; i < num_fields; i++)
2350                 free(fields[i].out_value);
2351
2352         free (fields);
2353
2354         return retval;
2355 }
2356
2357 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2358 {
2359         int retval;
2360         scan_field_t *fields;
2361         int num_fields;
2362         int field_count = 0;
2363         int i, e;
2364         jtag_tap_t *tap;
2365         tap_state_t endstate;
2366
2367         /* args[1] = device
2368          * args[2] = num_bits
2369          * args[3] = hex string
2370          * ... repeat num bits and hex string ...
2371          *
2372          * .. optionally:
2373         *     args[N-2] = "-endstate"
2374          *     args[N-1] = statename
2375          */
2376         if ((argc < 4) || ((argc % 2)!=0))
2377         {
2378                 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2379                 return JIM_ERR;
2380         }
2381
2382         endstate = TAP_IDLE;
2383
2384         /* validate arguments as numbers */
2385         e = JIM_OK;
2386         for (i = 2; i < argc; i+=2)
2387         {
2388                 long bits;
2389                 const char *cp;
2390
2391                 e = Jim_GetLong(interp, args[i], &bits);
2392                 /* If valid - try next arg */
2393                 if( e == JIM_OK ){
2394                         continue;
2395                 }
2396
2397                 /* Not valid.. are we at the end? */
2398                 if ( ((i+2) != argc) ){
2399                         /* nope, then error */
2400                         return e;
2401                 }
2402
2403                 /* it could be: "-endstate FOO"
2404                  * e.g. DRPAUSE so we can issue more instructions
2405                  * before entering RUN/IDLE and executing them.
2406                  */
2407
2408                 /* get arg as a string. */
2409                 cp = Jim_GetString( args[i], NULL );
2410                 /* is it the magic? */
2411                 if( 0 == strcmp( "-endstate", cp ) ){
2412                         /* is the statename valid? */
2413                         cp = Jim_GetString( args[i+1], NULL );
2414
2415                         /* see if it is a valid state name */
2416                         endstate = tap_state_by_name(cp);
2417                         if( endstate < 0 ){
2418                                 /* update the error message */
2419                                 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2420                         } else {
2421                                 if (!scan_is_safe(endstate))
2422                                         LOG_WARNING("drscan with unsafe "
2423                                                         "endstate \"%s\"", cp);
2424
2425                                 /* valid - so clear the error */
2426                                 e = JIM_OK;
2427                                 /* and remove the last 2 args */
2428                                 argc -= 2;
2429                         }
2430                 }
2431
2432                 /* Still an error? */
2433                 if( e != JIM_OK ){
2434                         return e; /* too bad */
2435                 }
2436         } /* validate args */
2437
2438         tap = jtag_tap_by_jim_obj( interp, args[1] );
2439         if( tap == NULL ){
2440                 return JIM_ERR;
2441         }
2442
2443         num_fields=(argc-2)/2;
2444         fields = malloc(sizeof(scan_field_t) * num_fields);
2445         for (i = 2; i < argc; i+=2)
2446         {
2447                 long bits;
2448                 int len;
2449                 const char *str;
2450
2451                 Jim_GetLong(interp, args[i], &bits);
2452                 str = Jim_GetString(args[i+1], &len);
2453
2454                 fields[field_count].tap = tap;
2455                 fields[field_count].num_bits = bits;
2456                 fields[field_count].out_value = malloc(CEIL(bits, 8));
2457                 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
2458                 fields[field_count].in_value = fields[field_count].out_value;
2459                 field_count++;
2460         }
2461
2462         jtag_add_dr_scan(num_fields, fields, endstate);
2463
2464         retval = jtag_execute_queue();
2465         if (retval != ERROR_OK)
2466         {
2467                 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
2468                 return JIM_ERR;
2469         }
2470
2471         field_count=0;
2472         Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
2473         for (i = 2; i < argc; i+=2)
2474         {
2475                 long bits;
2476                 char *str;
2477
2478                 Jim_GetLong(interp, args[i], &bits);
2479                 str = buf_to_str(fields[field_count].in_value, bits, 16);
2480                 free(fields[field_count].out_value);
2481
2482                 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
2483                 free(str);
2484                 field_count++;
2485         }
2486
2487         Jim_SetResult(interp, list);
2488
2489         free(fields);
2490
2491         return JIM_OK;
2492 }
2493
2494
2495 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2496 {
2497         Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_get_flush_queue_count()));
2498
2499         return JIM_OK;
2500 }
2501
2502
2503 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2504 {
2505         if (argc == 1)
2506         {
2507                 if (strcmp(args[0], "enable") == 0)
2508                 {
2509                         jtag_verify_capture_ir = 1;
2510                 }
2511                 else if (strcmp(args[0], "disable") == 0)
2512                 {
2513                         jtag_verify_capture_ir = 0;
2514                 } else
2515                 {
2516                         return ERROR_COMMAND_SYNTAX_ERROR;
2517                 }
2518         } else if (argc != 0)
2519         {
2520                 return ERROR_COMMAND_SYNTAX_ERROR;
2521         }
2522
2523         command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
2524
2525         return ERROR_OK;
2526 }
2527
2528 void jtag_set_verify(bool enable)
2529 {
2530         jtag_verify = enable;
2531 }
2532
2533 bool jtag_will_verify()
2534 {
2535         return jtag_verify;
2536 }
2537
2538 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2539 {
2540         if (argc > 1)
2541                 return ERROR_COMMAND_SYNTAX_ERROR;
2542
2543         if (argc == 1)
2544         {
2545                 if (strcmp(args[0], "enable") == 0)
2546                         jtag_set_verify(true);
2547                 else if (strcmp(args[0], "disable") == 0)
2548                         jtag_set_verify(false);
2549                 else
2550                         return ERROR_COMMAND_SYNTAX_ERROR;
2551         }
2552
2553         const char *status = jtag_will_verify() ? "enabled": "disabled";
2554         command_print(cmd_ctx, "verify jtag capture is %s", status);
2555
2556         return ERROR_OK;
2557 }
2558
2559
2560 int jtag_power_dropout(int *dropout)
2561 {
2562         return jtag->power_dropout(dropout);
2563 }
2564
2565 int jtag_srst_asserted(int *srst_asserted)
2566 {
2567         return jtag->srst_asserted(srst_asserted);
2568 }
2569
2570 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
2571 {
2572         jtag_tap_event_action_t * jteap;
2573         int done;
2574
2575         jteap = tap->event_action;
2576
2577         done = 0;
2578         while (jteap) {
2579                 if (jteap->event == e) {
2580                         done = 1;
2581                         LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2582                                         tap->dotted_name,
2583                                         e,
2584                                         Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
2585                                         Jim_GetString(jteap->body, NULL) );
2586                         if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
2587                                 Jim_PrintErrorMessage(interp);
2588                         }
2589                 }
2590
2591                 jteap = jteap->next;
2592         }
2593
2594         if (!done) {
2595                 LOG_DEBUG( "event %d %s - no action",
2596                                 e,
2597                                 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
2598         }
2599 }
2600
2601 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2602 {
2603         if (argc > 1)
2604                 return ERROR_COMMAND_SYNTAX_ERROR;
2605
2606         if (argc == 1)
2607         {
2608                 bool use_new_table;
2609                 if (strcmp(args[0], "short") == 0)
2610                         use_new_table = true;
2611                 else if (strcmp(args[0], "long") == 0)
2612                         use_new_table = false;
2613                 else
2614                         return ERROR_COMMAND_SYNTAX_ERROR;
2615
2616                 tap_use_new_tms_table(use_new_table);
2617         }
2618
2619         command_print(cmd_ctx, "tms sequence is  %s",
2620                         tap_uses_new_tms_table() ? "short": "long");
2621
2622         return ERROR_OK;
2623 }
2624
2625 /**
2626  * Function jtag_add_statemove
2627  * moves from the current state to the goal \a state. This needs
2628  * to be handled according to the xsvf spec, see the XSTATE command
2629  * description.
2630  */
2631 int jtag_add_statemove(tap_state_t goal_state)
2632 {
2633         int retval = ERROR_OK;
2634
2635         tap_state_t moves[8];
2636         tap_state_t cur_state = cmd_queue_cur_state;
2637         int i;
2638         int tms_bits;
2639         int     tms_count;
2640
2641         LOG_DEBUG( "cur_state=%s goal_state=%s",
2642                 tap_state_name(cur_state),
2643                 tap_state_name(goal_state) );
2644
2645
2646         /*      From the XSVF spec, pertaining to XSTATE:
2647
2648                 For special states known as stable states (Test-Logic-Reset,
2649                 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2650                 predefined TAP state paths when the starting state is a stable state and
2651                 when the XSTATE specifies a new stable state (see the STATE command in
2652                 the [Ref 5] for the TAP state paths between stable states). For
2653                 non-stable states, XSTATE should specify a state that is only one TAP
2654                 state transition distance from the current TAP state to avoid undefined
2655                 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2656                 transition the TAP through a specific state path.
2657         */
2658
2659         if (goal_state==cur_state )
2660                 ;       /* nothing to do */
2661
2662         else if( goal_state==TAP_RESET )
2663         {
2664                 jtag_add_tlr();
2665         }
2666
2667         else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
2668         {
2669                 /*      note: unless tms_bits holds a path that agrees with [Ref 5] in above
2670                         spec, then this code is not fully conformant to the xsvf spec.  This
2671                         puts a burden on tap_get_tms_path() function from the xsvf spec.
2672                         If in doubt, you should confirm that that burden is being met.
2673                 */
2674
2675                 tms_bits  = tap_get_tms_path(cur_state, goal_state);
2676                 tms_count = tap_get_tms_path_len(cur_state, goal_state);
2677
2678                 assert( (unsigned) tms_count < DIM(moves) );
2679
2680                 for (i=0;   i<tms_count;   i++, tms_bits>>=1)
2681                 {
2682                         bool bit = tms_bits & 1;
2683
2684                         cur_state = tap_state_transition(cur_state, bit);
2685                         moves[i] = cur_state;
2686                 }
2687
2688                 jtag_add_pathmove(tms_count, moves);
2689         }
2690
2691         /*      else state must be immediately reachable in one clock cycle, and does not
2692                 need to be a stable state.
2693         */
2694         else if( tap_state_transition(cur_state, true)  == goal_state
2695                 ||   tap_state_transition(cur_state, false) == goal_state )
2696         {
2697                 /* move a single state */
2698                 moves[0] = goal_state;
2699                 jtag_add_pathmove( 1, moves );
2700         }
2701
2702         else
2703         {
2704                 retval = ERROR_FAIL;
2705         }
2706
2707         return retval;
2708 }
2709
2710 void jtag_set_nsrst_delay(unsigned delay)
2711 {
2712         jtag_nsrst_delay = delay;
2713 }
2714 void jtag_set_ntrst_delay(unsigned delay)
2715 {
2716         jtag_ntrst_delay = delay;
2717 }
2718
2719