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