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 #define INCLUDE_JTAG_MINIDRIVER_H
  32 #define INCLUDE_JTAG_INTERFACE_H
  33 #include "jtag.h"
  34
  35 #ifdef HAVE_STRINGS_H
  36 #include <strings.h>
  37 #endif
  38
  39
  40 int jtag_flush_queue_count; /* count # of flushes for profiling / debugging purposes */
  41
  42 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
  43                 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
  44
  45 /* note that this is not marked as static as it must be available from outside jtag.c for those
  46    that implement the jtag_xxx() minidriver layer
  47 */
  48 int jtag_error=ERROR_OK;
  49
  50 typedef struct cmd_queue_page_s
  51 {
  52         void *address;
  53         size_t used;
  54         struct cmd_queue_page_s *next;
  55 } cmd_queue_page_t;
  56
  57 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
  58 static cmd_queue_page_t *cmd_queue_pages = NULL;
  59
  60 char* jtag_event_strings[] =
  61 {
  62         "JTAG controller reset (RESET or TRST)"
  63 };
  64
  65 const Jim_Nvp nvp_jtag_tap_event[] = {
  66         { .value = JTAG_TAP_EVENT_ENABLE,       .name = "tap-enable" },
  67         { .value = JTAG_TAP_EVENT_DISABLE,      .name = "tap-disable" },
  68
  69         { .name = NULL, .value = -1 }
  70 };
  71
  72 int jtag_trst = 0;
  73 int jtag_srst = 0;
  74
  75 jtag_command_t *jtag_command_queue = NULL;
  76 static jtag_command_t **next_command_pointer = &jtag_command_queue;
  77 static jtag_tap_t *jtag_all_taps = NULL;
  78
  79 enum reset_types jtag_reset_config = RESET_NONE;
  80 tap_state_t cmd_queue_end_state = TAP_RESET;
  81 tap_state_t cmd_queue_cur_state = TAP_RESET;
  82
  83 int jtag_verify_capture_ir = 1;
  84 int jtag_verify = 1;
  85
  86 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
  87 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
  88 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
  89
  90 /* maximum number of JTAG devices expected in the chain
  91  */
  92 #define JTAG_MAX_CHAIN_SIZE 20
  93
  94 /* callbacks to inform high-level handlers about JTAG state changes */
  95 jtag_event_callback_t *jtag_event_callbacks;
  96
  97 /* speed in kHz*/
  98 static int speed_khz = 0;
  99 /* flag if the kHz speed was defined */
 100 static int hasKHz = 0;
 101
 102 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
 103  */
 104
 105 #if BUILD_ECOSBOARD == 1
 106         extern jtag_interface_t zy1000_interface;
 107 #endif
 108
 109 #if BUILD_PARPORT == 1
 110         extern jtag_interface_t parport_interface;
 111 #endif
 112
 113 #if BUILD_DUMMY == 1
 114         extern jtag_interface_t dummy_interface;
 115 #endif
 116
 117 #if BUILD_FT2232_FTD2XX == 1
 118         extern jtag_interface_t ft2232_interface;
 119 #endif
 120
 121 #if BUILD_FT2232_LIBFTDI == 1
 122         extern jtag_interface_t ft2232_interface;
 123 #endif
 124
 125 #if BUILD_AMTJTAGACCEL == 1
 126         extern jtag_interface_t amt_jtagaccel_interface;
 127 #endif
 128
 129 #if BUILD_EP93XX == 1
 130         extern jtag_interface_t ep93xx_interface;
 131 #endif
 132
 133 #if BUILD_AT91RM9200 == 1
 134         extern jtag_interface_t at91rm9200_interface;
 135 #endif
 136
 137 #if BUILD_GW16012 == 1
 138         extern jtag_interface_t gw16012_interface;
 139 #endif
 140
 141 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
 142         extern jtag_interface_t presto_interface;
 143 #endif
 144
 145 #if BUILD_USBPROG == 1
 146         extern jtag_interface_t usbprog_interface;
 147 #endif
 148
 149 #if BUILD_JLINK == 1
 150         extern jtag_interface_t jlink_interface;
 151 #endif
 152
 153 #if BUILD_VSLLINK == 1
 154         extern jtag_interface_t vsllink_interface;
 155 #endif
 156
 157 #if BUILD_RLINK == 1
 158         extern jtag_interface_t rlink_interface;
 159 #endif
 160
 161 #if BUILD_ARMJTAGEW == 1
 162         extern jtag_interface_t armjtagew_interface;
 163 #endif
 164
 165 jtag_interface_t *jtag_interfaces[] = {
 166 #if BUILD_ECOSBOARD == 1
 167         &zy1000_interface,
 168 #endif
 169 #if BUILD_PARPORT == 1
 170         &parport_interface,
 171 #endif
 172 #if BUILD_DUMMY == 1
 173         &dummy_interface,
 174 #endif
 175 #if BUILD_FT2232_FTD2XX == 1
 176         &ft2232_interface,
 177 #endif
 178 #if BUILD_FT2232_LIBFTDI == 1
 179         &ft2232_interface,
 180 #endif
 181 #if BUILD_AMTJTAGACCEL == 1
 182         &amt_jtagaccel_interface,
 183 #endif
 184 #if BUILD_EP93XX == 1
 185         &ep93xx_interface,
 186 #endif
 187 #if BUILD_AT91RM9200 == 1
 188         &at91rm9200_interface,
 189 #endif
 190 #if BUILD_GW16012 == 1
 191         &gw16012_interface,
 192 #endif
 193 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
 194         &presto_interface,
 195 #endif
 196 #if BUILD_USBPROG == 1
 197         &usbprog_interface,
 198 #endif
 199 #if BUILD_JLINK == 1
 200         &jlink_interface,
 201 #endif
 202 #if BUILD_VSLLINK == 1
 203         &vsllink_interface,
 204 #endif
 205 #if BUILD_RLINK == 1
 206         &rlink_interface,
 207 #endif
 208 #if BUILD_ARMJTAGEW == 1
 209         &armjtagew_interface,
 210 #endif
 211         NULL,
 212 };
 213
 214 struct jtag_interface_s *jtag = NULL;
 215
 216 /* configuration */
 217 static jtag_interface_t *jtag_interface = NULL;
 218 int jtag_speed = 0;
 219
 220 /* forward declarations */
 221 //void jtag_add_pathmove(int num_states, tap_state_t *path);
 222 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
 223 //void jtag_add_end_state(tap_state_t endstate);
 224 //void jtag_add_sleep(u32 us);
 225 //int jtag_execute_queue(void);
 226 static tap_state_t tap_state_by_name(const char *name);
 227
 228 /* jtag commands */
 229 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 230 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 231 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 232 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 233 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 234 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 235 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 236
 237 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 238
 239 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 240 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 241 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 242 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 243 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
 244 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
 245
 246 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 247 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 248 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 249
 250 jtag_tap_t *jtag_AllTaps(void)
 251 {
 252         return jtag_all_taps;
 253 };
 254
 255 int jtag_NumTotalTaps(void)
 256 {
 257         jtag_tap_t *t;
 258         int n;
 259
 260         n = 0;
 261         t = jtag_AllTaps();
 262         while(t){
 263                 n++;
 264                 t = t->next_tap;
 265         }
 266         return n;
 267 }
 268
 269 int jtag_NumEnabledTaps(void)
 270 {
 271         jtag_tap_t *t;
 272         int n;
 273
 274         n = 0;
 275         t = jtag_AllTaps();
 276         while(t){
 277                 if( t->enabled ){
 278                         n++;
 279                 }
 280                 t = t->next_tap;
 281         }
 282         return n;
 283 }
 284
 285 jtag_tap_t *jtag_TapByString( const char *s )
 286 {
 287         jtag_tap_t *t;
 288         char *cp;
 289
 290         t = jtag_AllTaps();
 291         /* try name first */
 292         while(t){
 293                 if( 0 == strcmp( t->dotted_name, s ) ){
 294                         break;
 295                 } else {
 296                         t = t->next_tap;
 297                 }
 298         }
 299         /* backup plan is by number */
 300         if( t == NULL ){
 301                 /* ok - is "s" a number? */
 302                 int n;
 303                 n = strtol( s, &cp, 0 );
 304                 if( (s != cp) && (*cp == 0) ){
 305                         /* Then it is... */
 306                         t = jtag_TapByAbsPosition(n);
 307                 }
 308         }
 309         return t;
 310 }
 311
 312 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
 313 {
 314         jtag_tap_t *t;
 315         const char *cp;
 316
 317         cp = Jim_GetString( o, NULL );
 318         if(cp == NULL){
 319                 cp = "(unknown)";
 320                 t = NULL;
 321         }  else {
 322                 t = jtag_TapByString( cp );
 323         }
 324         if( t == NULL ){
 325                 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
 326         }
 327         return t;
 328 }
 329
 330 /* returns a pointer to the n-th device in the scan chain */
 331 jtag_tap_t * jtag_TapByAbsPosition( int n )
 332 {
 333         int orig_n;
 334         jtag_tap_t *t;
 335
 336         orig_n = n;
 337         t = jtag_AllTaps();
 338
 339         while( t && (n > 0)) {
 340                 n--;
 341                 t = t->next_tap;
 342         }
 343         return t;
 344 }
 345
 346 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
 347 {
 348         jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
 349
 350         if (callback == NULL)
 351         {
 352                 return ERROR_INVALID_ARGUMENTS;
 353         }
 354
 355         if (*callbacks_p)
 356         {
 357                 while ((*callbacks_p)->next)
 358                         callbacks_p = &((*callbacks_p)->next);
 359                 callbacks_p = &((*callbacks_p)->next);
 360         }
 361
 362         (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
 363         (*callbacks_p)->callback = callback;
 364         (*callbacks_p)->priv = priv;
 365         (*callbacks_p)->next = NULL;
 366
 367         return ERROR_OK;
 368 }
 369
 370 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
 371 {
 372         jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
 373
 374         if (callback == NULL)
 375         {
 376                 return ERROR_INVALID_ARGUMENTS;
 377         }
 378
 379         while (*callbacks_p)
 380         {
 381                 jtag_event_callback_t **next = &((*callbacks_p)->next);
 382                 if ((*callbacks_p)->callback == callback)
 383                 {
 384                         free(*callbacks_p);
 385                         *callbacks_p = *next;
 386                 }
 387                 callbacks_p = next;
 388         }
 389
 390         return ERROR_OK;
 391 }
 392
 393 int jtag_call_event_callbacks(enum jtag_event event)
 394 {
 395         jtag_event_callback_t *callback = jtag_event_callbacks;
 396
 397         LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
 398
 399         while (callback)
 400         {
 401                 callback->callback(event, callback->priv);
 402                 callback = callback->next;
 403         }
 404
 405         return ERROR_OK;
 406 }
 407
 408 void jtag_queue_command(jtag_command_t * cmd)
 409 {
 410         // this command goes on the end, so ensure the queue terminates
 411         cmd->next = NULL;
 412
 413         jtag_command_t **last_cmd = next_command_pointer;
 414         assert(NULL != last_cmd);
 415         assert(NULL == *last_cmd);
 416         *last_cmd = cmd;
 417
 418         // store location where the next command pointer will be stored
 419         next_command_pointer = &cmd->next;
 420 }
 421
 422 void* cmd_queue_alloc(size_t size)
 423 {
 424         cmd_queue_page_t **p_page = &cmd_queue_pages;
 425         int offset;
 426         u8 *t;
 427
 428         /*
 429          * WARNING:
 430          *    We align/round the *SIZE* per below
 431          *    so that all pointers returned by
 432          *    this function are reasonably well
 433          *    aligned.
 434          *
 435          * If we did not, then an "odd-length" request would cause the
 436          * *next* allocation to be at an *odd* address, and because
 437          * this function has the same type of api as malloc() - we
 438          * must also return pointers that have the same type of
 439          * alignment.
 440          *
 441          * What I do not/have is a reasonable portable means
 442          * to align by...
 443          *
 444          * The solution here, is based on these suggestions.
 445          * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
 446          *
 447          */
 448         union worse_case_align {
 449                 int i;
 450                 long l;
 451                 float f;
 452                 void *v;
 453         };
 454 #define ALIGN_SIZE  (sizeof(union worse_case_align))
 455
 456         /* The alignment process. */
 457         size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
 458         /* Done... */
 459
 460         if (*p_page)
 461         {
 462                 while ((*p_page)->next)
 463                         p_page = &((*p_page)->next);
 464                 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
 465                         p_page = &((*p_page)->next);
 466         }
 467
 468         if (!*p_page)
 469         {
 470                 *p_page = malloc(sizeof(cmd_queue_page_t));
 471                 (*p_page)->used = 0;
 472                 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
 473                 (*p_page)->next = NULL;
 474         }
 475
 476         offset = (*p_page)->used;
 477         (*p_page)->used += size;
 478
 479         t=(u8 *)((*p_page)->address);
 480         return t + offset;
 481 }
 482
 483 void cmd_queue_free(void)
 484 {
 485         cmd_queue_page_t *page = cmd_queue_pages;
 486
 487         while (page)
 488         {
 489                 cmd_queue_page_t *last = page;
 490                 free(page->address);
 491                 page = page->next;
 492                 free(last);
 493         }
 494
 495         cmd_queue_pages = NULL;
 496 }
 497
 498 void jtag_command_queue_reset(void)
 499 {
 500         cmd_queue_free();
 501
 502         jtag_command_queue = NULL;
 503         next_command_pointer = &jtag_command_queue;
 504 }
 505
 506 static void jtag_prelude1(void)
 507 {
 508         if (jtag_trst == 1)
 509         {
 510                 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
 511                 jtag_error=ERROR_JTAG_TRST_ASSERTED;
 512                 return;
 513         }
 514
 515         if (cmd_queue_end_state == TAP_RESET)
 516                 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 517 }
 518
 519 static void jtag_prelude(tap_state_t state)
 520 {
 521         jtag_prelude1();
 522
 523         if (state != TAP_INVALID)
 524                 jtag_add_end_state(state);
 525
 526         cmd_queue_cur_state = cmd_queue_end_state;
 527 }
 528
 529 void jtag_add_ir_scan_noverify(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 530 {
 531         int retval;
 532         jtag_prelude(state);
 533
 534         retval=interface_jtag_add_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
 535         if (retval!=ERROR_OK)
 536                 jtag_error=retval;
 537
 538 }
 539
 540
 541 /**
 542  * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
 543  *
 544  * If the input field list contains an instruction value for a TAP then that is used
 545  * otherwise the TAP is set to bypass.
 546  *
 547  * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
 548  *
 549  */
 550 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 551 {
 552         if (jtag_verify&&jtag_verify_capture_ir)
 553         {
 554                 /* 8 x 32 bit id's is enough for all invocations */
 555
 556                 for (int j = 0; j < in_num_fields; j++)
 557                 {
 558                         /* if we are to run a verification of the ir scan, we need to get the input back.
 559                          * We may have to allocate space if the caller didn't ask for the input back.
 560                          */
 561                         in_fields[j].check_value=in_fields[j].tap->expected;
 562                         in_fields[j].check_mask=in_fields[j].tap->expected_mask;
 563                 }
 564                 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
 565         } else
 566         {
 567                 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
 568         }
 569 }
 570
 571 /**
 572  * Duplicate the scan fields passed into the function into an IR SCAN command
 573  *
 574  * This function assumes that the caller handles extra fields for bypassed TAPs
 575  *
 576  */
 577 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 578 {
 579         int retval;
 580
 581         jtag_prelude(state);
 582
 583         retval=interface_jtag_add_plain_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
 584         if (retval!=ERROR_OK)
 585                 jtag_error=retval;
 586 }
 587
 588
 589
 590 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
 591
 592 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
 593 {
 594         return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
 595 }
 596
 597 #ifdef HAVE_JTAG_MINIDRIVER_H
 598 void interface_jtag_add_scan_check_alloc(scan_field_t *field)
 599 {
 600         /* We're executing this synchronously, so try to use local storage. */
 601         if (field->num_bits > 32)
 602         {
 603                 unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
 604                 field->in_value = (u8 *)malloc(num_bytes);
 605                 field->allocated = 1;
 606         }
 607         else
 608                 field->in_value = field->intmp;
 609 }
 610 #else
 611 void interface_jtag_add_scan_check_alloc(scan_field_t *field)
 612 {
 613         unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
 614         field->in_value = (u8 *)cmd_queue_alloc(num_bytes);
 615 }
 616 #endif
 617
 618 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
 619                 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 620 {
 621         for (int i = 0; i < in_num_fields; i++)
 622         {
 623                 struct scan_field_s *field = &in_fields[i];
 624                 field->allocated = 0;
 625                 field->modified = 0;
 626                 if (field->check_value || field->in_value)
 627                         continue;
 628                 interface_jtag_add_scan_check_alloc(field);
 629                 field->modified = 1;
 630         }
 631
 632         jtag_add_scan(in_num_fields, in_fields, state);
 633
 634         for (int i = 0; i < in_num_fields; i++)
 635         {
 636                 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
 637                 {
 638                         /* this is synchronous for a minidriver */
 639                         jtag_add_callback4(jtag_check_value_mask_callback, in_fields[i].in_value,
 640                                 (jtag_callback_data_t)in_fields[i].check_value,
 641                                 (jtag_callback_data_t)in_fields[i].check_mask,
 642                                 (jtag_callback_data_t)in_fields[i].num_bits);
 643                 }
 644                 if (in_fields[i].allocated)
 645                 {
 646                         free(in_fields[i].in_value);
 647                 }
 648                 if (in_fields[i].modified)
 649                 {
 650                         in_fields[i].in_value = NULL;
 651                 }
 652         }
 653 }
 654
 655 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 656 {
 657         if (jtag_verify)
 658         {
 659                 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
 660         } else
 661         {
 662                 jtag_add_dr_scan(in_num_fields, in_fields, state);
 663         }
 664 }
 665
 666
 667 /**
 668  * Generate a DR SCAN using the fields passed to the function
 669  *
 670  * For not bypassed TAPs the function checks in_fields and uses fields specified there.
 671  * For bypassed TAPs the function generates a dummy 1bit field.
 672  *
 673  * The bypass status of TAPs is set by jtag_add_ir_scan().
 674  *
 675  */
 676 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 677 {
 678         int retval;
 679
 680         jtag_prelude(state);
 681
 682         retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
 683         if (retval!=ERROR_OK)
 684                 jtag_error=retval;
 685 }
 686
 687
 688
 689 /**
 690  * Duplicate the scan fields passed into the function into a DR SCAN command
 691  *
 692  * This function assumes that the caller handles extra fields for bypassed TAPs
 693  *
 694  */
 695 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
 696 {
 697         int retval;
 698
 699         jtag_prelude(state);
 700
 701         retval=interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
 702         if (retval!=ERROR_OK)
 703                 jtag_error=retval;
 704 }
 705
 706
 707
 708 void jtag_add_tlr(void)
 709 {
 710         jtag_prelude(TAP_RESET);
 711
 712         int retval;
 713         retval=interface_jtag_add_tlr();
 714         if (retval!=ERROR_OK)
 715                 jtag_error=retval;
 716 }
 717
 718 void jtag_add_pathmove(int num_states, const tap_state_t *path)
 719 {
 720         tap_state_t cur_state = cmd_queue_cur_state;
 721         int i;
 722         int retval;
 723
 724         /* the last state has to be a stable state */
 725         if (!tap_is_state_stable(path[num_states - 1]))
 726         {
 727                 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
 728                 exit(-1);
 729         }
 730
 731         for (i=0; i<num_states; i++)
 732         {
 733                 if (path[i] == TAP_RESET)
 734                 {
 735                         LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
 736                         exit(-1);
 737                 }
 738
 739                 if ( tap_state_transition(cur_state, true)  != path[i]
 740                   && tap_state_transition(cur_state, false) != path[i])
 741                 {
 742                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
 743                         exit(-1);
 744                 }
 745                 cur_state = path[i];
 746         }
 747
 748         jtag_prelude1();
 749
 750         retval = interface_jtag_add_pathmove(num_states, path);
 751         cmd_queue_cur_state = path[num_states - 1];
 752         if (retval!=ERROR_OK)
 753                 jtag_error=retval;
 754 }
 755
 756 void jtag_add_runtest(int num_cycles, tap_state_t state)
 757 {
 758         int retval;
 759
 760         jtag_prelude(state);
 761
 762         /* executed by sw or hw fifo */
 763         retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
 764         if (retval!=ERROR_OK)
 765                 jtag_error=retval;
 766 }
 767
 768
 769 void jtag_add_clocks( int num_cycles )
 770 {
 771         int retval;
 772
 773         if( !tap_is_state_stable(cmd_queue_cur_state) )
 774         {
 775                  LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
 776                                  tap_state_name(cmd_queue_cur_state) );
 777                  jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
 778                  return;
 779         }
 780
 781         if( num_cycles > 0 )
 782         {
 783                 jtag_prelude1();
 784
 785                 retval = interface_jtag_add_clocks(num_cycles);
 786                 if (retval != ERROR_OK)
 787                         jtag_error=retval;
 788         }
 789 }
 790
 791 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
 792 {
 793         int trst_with_tlr = 0;
 794         int retval;
 795
 796         /* FIX!!! there are *many* different cases here. A better
 797          * approach is needed for legal combinations of transitions...
 798          */
 799         if ((jtag_reset_config & RESET_HAS_SRST)&&
 800                         (jtag_reset_config & RESET_HAS_TRST)&&
 801                         ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
 802         {
 803                 if (((req_tlr_or_trst&&!jtag_trst)||
 804                                 (!req_tlr_or_trst&&jtag_trst))&&
 805                                 ((req_srst&&!jtag_srst)||
 806                                                 (!req_srst&&jtag_srst)))
 807                 {
 808                         /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
 809                         //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
 810                 }
 811         }
 812
 813         /* Make sure that jtag_reset_config allows the requested reset */
 814         /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
 815         if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
 816         {
 817                 LOG_ERROR("BUG: requested reset would assert trst");
 818                 jtag_error=ERROR_FAIL;
 819                 return;
 820         }
 821
 822         /* if TRST pulls SRST, we reset with TAP T-L-R */
 823         if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
 824         {
 825                 trst_with_tlr = 1;
 826         }
 827
 828         if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
 829         {
 830                 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
 831                 jtag_error=ERROR_FAIL;
 832                 return;
 833         }
 834
 835         if (req_tlr_or_trst)
 836         {
 837                 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
 838                 {
 839                         jtag_trst = 1;
 840                 } else
 841                 {
 842                         trst_with_tlr = 1;
 843                 }
 844         } else
 845         {
 846                 jtag_trst = 0;
 847         }
 848
 849         jtag_srst = req_srst;
 850
 851         retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
 852         if (retval!=ERROR_OK)
 853         {
 854                 jtag_error=retval;
 855                 return;
 856         }
 857         jtag_execute_queue();
 858
 859         if (jtag_srst)
 860         {
 861                 LOG_DEBUG("SRST line asserted");
 862         }
 863         else
 864         {
 865                 LOG_DEBUG("SRST line released");
 866                 if (jtag_nsrst_delay)
 867                         jtag_add_sleep(jtag_nsrst_delay * 1000);
 868         }
 869
 870         if (trst_with_tlr)
 871         {
 872                 LOG_DEBUG("JTAG reset with RESET instead of TRST");
 873                 jtag_add_end_state(TAP_RESET);
 874                 jtag_add_tlr();
 875                 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 876                 return;
 877         }
 878
 879         if (jtag_trst)
 880         {
 881                 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
 882                  * and inform possible listeners about this
 883                  */
 884                 LOG_DEBUG("TRST line asserted");
 885                 tap_set_state(TAP_RESET);
 886                 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 887         }
 888         else
 889         {
 890                 if (jtag_ntrst_delay)
 891                         jtag_add_sleep(jtag_ntrst_delay * 1000);
 892         }
 893 }
 894
 895 void jtag_add_end_state(tap_state_t state)
 896 {
 897         cmd_queue_end_state = state;
 898         if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
 899         {
 900                 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
 901         }
 902 }
 903
 904 void jtag_add_sleep(u32 us)
 905 {
 906         keep_alive(); /* we might be running on a very slow JTAG clk */
 907         int retval=interface_jtag_add_sleep(us);
 908         if (retval!=ERROR_OK)
 909                 jtag_error=retval;
 910         return;
 911 }
 912
 913 int jtag_scan_size(const scan_command_t *cmd)
 914 {
 915         int bit_count = 0;
 916         int i;
 917
 918         /* count bits in scan command */
 919         for (i = 0; i < cmd->num_fields; i++)
 920         {
 921                 bit_count += cmd->fields[i].num_bits;
 922         }
 923
 924         return bit_count;
 925 }
 926
 927 int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
 928 {
 929         int bit_count = 0;
 930         int i;
 931
 932         bit_count = jtag_scan_size(cmd);
 933         *buffer = calloc(1,CEIL(bit_count, 8));
 934
 935         bit_count = 0;
 936
 937 #ifdef _DEBUG_JTAG_IO_
 938         LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
 939 #endif
 940
 941         for (i = 0; i < cmd->num_fields; i++)
 942         {
 943                 if (cmd->fields[i].out_value)
 944                 {
 945 #ifdef _DEBUG_JTAG_IO_
 946                         char* char_buf = buf_to_str(cmd->fields[i].out_value, (cmd->fields[i].num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : cmd->fields[i].num_bits, 16);
 947 #endif
 948                         buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
 949 #ifdef _DEBUG_JTAG_IO_
 950                         LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
 951                         free(char_buf);
 952 #endif
 953                 }
 954                 else
 955                 {
 956 #ifdef _DEBUG_JTAG_IO_
 957                         LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
 958 #endif
 959                 }
 960
 961                 bit_count += cmd->fields[i].num_bits;
 962         }
 963
 964 #ifdef _DEBUG_JTAG_IO_
 965         //LOG_DEBUG("bit_count totalling: %i",  bit_count );
 966 #endif
 967
 968         return bit_count;
 969 }
 970
 971 int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
 972 {
 973         int i;
 974         int bit_count = 0;
 975         int retval;
 976
 977         /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
 978         retval = ERROR_OK;
 979
 980         for (i = 0; i < cmd->num_fields; i++)
 981         {
 982                 /* if neither in_value nor in_handler
 983                  * are specified we don't have to examine this field
 984                  */
 985                 if (cmd->fields[i].in_value)
 986                 {
 987                         int num_bits = cmd->fields[i].num_bits;
 988                         u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
 989
 990 #ifdef _DEBUG_JTAG_IO_
 991                         char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 992                         LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
 993                         free(char_buf);
 994 #endif
 995
 996                         if (cmd->fields[i].in_value)
 997                         {
 998                                 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
 999                         }
1000
1001                         free(captured);
1002                 }
1003                 bit_count += cmd->fields[i].num_bits;
1004         }
1005
1006         return retval;
1007 }
1008
1009 static const char *jtag_tap_name(const jtag_tap_t *tap)
1010 {
1011         return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1012 }
1013
1014 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1015 {
1016         int retval = ERROR_OK;
1017
1018         int compare_failed = 0;
1019
1020         if (in_check_mask)
1021                 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1022         else
1023                 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1024
1025         if (compare_failed){
1026                 /* An error handler could have caught the failing check
1027                  * only report a problem when there wasn't a handler, or if the handler
1028                  * acknowledged the error
1029                  */
1030                 /*
1031                 LOG_WARNING("TAP %s:",
1032                                         jtag_tap_name(field->tap));
1033                                         */
1034                 if (compare_failed)
1035                 {
1036                         char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1037                         char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1038
1039                         if (in_check_mask)
1040                         {
1041                                 char *in_check_mask_char;
1042                                 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1043                                 LOG_WARNING("value captured during scan didn't pass the requested check:");
1044                                 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1045                                                         captured_char, in_check_value_char, in_check_mask_char);
1046                                 free(in_check_mask_char);
1047                         }
1048                         else
1049                         {
1050                                 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);
1051                         }
1052
1053                         free(captured_char);
1054                         free(in_check_value_char);
1055
1056                         retval = ERROR_JTAG_QUEUE_FAILED;
1057                 }
1058
1059         }
1060         return retval;
1061 }
1062
1063 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1064 {
1065         assert(field->in_value != NULL);
1066
1067         if (value==NULL)
1068         {
1069                 /* no checking to do */
1070                 return;
1071         }
1072
1073         jtag_execute_queue_noclear();
1074
1075         int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1076         jtag_set_error(retval);
1077 }
1078
1079
1080
1081 enum scan_type jtag_scan_type(const scan_command_t *cmd)
1082 {
1083         int i;
1084         int type = 0;
1085
1086         for (i = 0; i < cmd->num_fields; i++)
1087         {
1088                 if (cmd->fields[i].in_value)
1089                         type |= SCAN_IN;
1090                 if (cmd->fields[i].out_value)
1091                         type |= SCAN_OUT;
1092         }
1093
1094         return type;
1095 }
1096
1097 int default_interface_jtag_execute_queue(void)
1098 {
1099         if (NULL == jtag)
1100         {
1101                 LOG_ERROR("No JTAG interface configured yet.  "
1102                         "Issue 'init' command in startup scripts "
1103                         "before communicating with targets.");
1104                 return ERROR_FAIL;
1105         }
1106
1107         return jtag->execute_queue();
1108 }
1109
1110 void jtag_execute_queue_noclear(void)
1111 {
1112         /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1113          * E.g. a JTAG over TCP/IP or USB....
1114          */
1115         jtag_flush_queue_count++;
1116
1117         int retval=interface_jtag_execute_queue();
1118         /* we keep the first error */
1119         if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1120         {
1121                 jtag_error=retval;
1122         }
1123 }
1124
1125 int jtag_execute_queue(void)
1126 {
1127         int retval;
1128         jtag_execute_queue_noclear();
1129         retval=jtag_error;
1130         jtag_error=ERROR_OK;
1131         return retval;
1132 }
1133
1134 int jtag_reset_callback(enum jtag_event event, void *priv)
1135 {
1136         jtag_tap_t *tap = priv;
1137
1138         LOG_DEBUG("-");
1139
1140         if (event == JTAG_TRST_ASSERTED)
1141         {
1142                 buf_set_ones(tap->cur_instr, tap->ir_length);
1143                 tap->bypass = 1;
1144         }
1145
1146         return ERROR_OK;
1147 }
1148
1149 void jtag_sleep(u32 us)
1150 {
1151         alive_sleep(us/1000);
1152 }
1153
1154 /* Try to examine chain layout according to IEEE 1149.1 §12
1155  */
1156 int jtag_examine_chain(void)
1157 {
1158         jtag_tap_t *tap;
1159         scan_field_t field;
1160         u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1161         int i;
1162         int bit_count;
1163         int device_count = 0;
1164         u8 zero_check = 0x0;
1165         u8 one_check = 0xff;
1166
1167         field.tap = NULL;
1168         field.num_bits = sizeof(idcode_buffer) * 8;
1169         field.out_value = idcode_buffer;
1170
1171         field.in_value = idcode_buffer;
1172
1173
1174
1175
1176         for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1177         {
1178                 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1179         }
1180
1181         jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1182         jtag_execute_queue();
1183
1184         for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1185         {
1186                 zero_check |= idcode_buffer[i];
1187                 one_check &= idcode_buffer[i];
1188         }
1189
1190         /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1191         if ((zero_check == 0x00) || (one_check == 0xff))
1192         {
1193                 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1194                 return ERROR_JTAG_INIT_FAILED;
1195         }
1196
1197         /* point at the 1st tap */
1198         tap = jtag_NextEnabledTap(NULL);
1199         if( tap == NULL ){
1200                 LOG_ERROR("JTAG: No taps enabled?");
1201                 return ERROR_JTAG_INIT_FAILED;
1202         }
1203
1204         for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1205         {
1206                 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1207                 if ((idcode & 1) == 0)
1208                 {
1209                         /* LSB must not be 0, this indicates a device in bypass */
1210                         LOG_WARNING("Tap/Device does not have IDCODE");
1211                         idcode=0;
1212
1213                         bit_count += 1;
1214                 }
1215                 else
1216                 {
1217                         u32 manufacturer;
1218                         u32 part;
1219                         u32 version;
1220
1221                         /* some devices, such as AVR will output all 1's instead of TDI
1222                         input value at end of chain. */
1223                         if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1224                         {
1225                                 int unexpected=0;
1226                                 /* End of chain (invalid manufacturer ID)
1227                                  *
1228                                  * The JTAG examine is the very first thing that happens
1229                                  *
1230                                  * A single JTAG device requires only 64 bits to be read back correctly.
1231                                  *
1232                                  * The code below adds a check that the rest of the data scanned (640 bits)
1233                                  * are all as expected. This helps diagnose/catch problems with the JTAG chain
1234                                  *
1235                                  * earlier and gives more helpful/explicit error messages.
1236                                  */
1237                                 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1238                                 {
1239                                         idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1240                                         if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1241                                         {
1242                                                 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1243                                                 unexpected = 1;
1244                                         }
1245                                 }
1246
1247                                 break;
1248                         }
1249
1250 #define EXTRACT_MFG(X)  (((X) & 0xffe) >> 1)
1251                         manufacturer = EXTRACT_MFG(idcode);
1252 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1253                         part = EXTRACT_PART(idcode);
1254 #define EXTRACT_VER(X)  (((X) & 0xf0000000) >> 28)
1255                         version = EXTRACT_VER(idcode);
1256
1257                         LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1258                                          ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1259                                 idcode, manufacturer, part, version);
1260
1261                         bit_count += 32;
1262                 }
1263                 if (tap)
1264                 {
1265                         tap->idcode = idcode;
1266
1267                         if (tap->expected_ids_cnt > 0) {
1268                                 /* Loop over the expected identification codes and test for a match */
1269                                 u8 ii;
1270                                 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1271                                         if( tap->idcode == tap->expected_ids[ii] ){
1272                                                 break;
1273                                         }
1274                                 }
1275
1276                                 /* If none of the expected ids matched, log an error */
1277                                 if (ii == tap->expected_ids_cnt) {
1278                                         LOG_ERROR("JTAG tap: %s             got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1279                                                           tap->dotted_name,
1280                                                           idcode,
1281                                                           EXTRACT_MFG( tap->idcode ),
1282                                                           EXTRACT_PART( tap->idcode ),
1283                                                           EXTRACT_VER( tap->idcode ) );
1284                                         for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1285                                                 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1286                                                                   tap->dotted_name,
1287                                                                   ii + 1,
1288                                                                   tap->expected_ids_cnt,
1289                                                                   tap->expected_ids[ii],
1290                                                                   EXTRACT_MFG( tap->expected_ids[ii] ),
1291                                                                   EXTRACT_PART( tap->expected_ids[ii] ),
1292                                                                   EXTRACT_VER( tap->expected_ids[ii] ) );
1293                                         }
1294
1295                                         return ERROR_JTAG_INIT_FAILED;
1296                                 } else {
1297                                         LOG_INFO("JTAG Tap/device matched");
1298                                 }
1299                         } else {
1300 #if 0
1301                                 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1302                                                  tap->idcode);
1303 #endif
1304                         }
1305                         tap = jtag_NextEnabledTap(tap);
1306                 }
1307                 device_count++;
1308         }
1309
1310         /* see if number of discovered devices matches configuration */
1311         if (device_count != jtag_NumEnabledTaps())
1312         {
1313                 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1314                                   device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1315                 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1316                 return ERROR_JTAG_INIT_FAILED;
1317         }
1318
1319         return ERROR_OK;
1320 }
1321
1322 int jtag_validate_chain(void)
1323 {
1324         jtag_tap_t *tap;
1325         int total_ir_length = 0;
1326         u8 *ir_test = NULL;
1327         scan_field_t field;
1328         int chain_pos = 0;
1329
1330         tap = NULL;
1331         total_ir_length = 0;
1332         for(;;){
1333                 tap = jtag_NextEnabledTap(tap);
1334                 if( tap == NULL ){
1335                         break;
1336                 }
1337                 total_ir_length += tap->ir_length;
1338         }
1339
1340         total_ir_length += 2;
1341         ir_test = malloc(CEIL(total_ir_length, 8));
1342         buf_set_ones(ir_test, total_ir_length);
1343
1344         field.tap = NULL;
1345         field.num_bits = total_ir_length;
1346         field.out_value = ir_test;
1347         field.in_value = ir_test;
1348
1349
1350         jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1351         jtag_execute_queue();
1352
1353         tap = NULL;
1354         chain_pos = 0;
1355         int val;
1356         for(;;){
1357                 tap = jtag_NextEnabledTap(tap);
1358                 if( tap == NULL ){
1359                         break;
1360                 }
1361
1362                 val = buf_get_u32(ir_test, chain_pos, 2);
1363                 if (val != 0x1)
1364                 {
1365                         char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1366                         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);
1367                         free(cbuf);
1368                         free(ir_test);
1369                         return ERROR_JTAG_INIT_FAILED;
1370                 }
1371                 chain_pos += tap->ir_length;
1372         }
1373
1374         val = buf_get_u32(ir_test, chain_pos, 2);
1375         if (val != 0x3)
1376         {
1377                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1378                 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);
1379                 free(cbuf);
1380                 free(ir_test);
1381                 return ERROR_JTAG_INIT_FAILED;
1382         }
1383
1384         free(ir_test);
1385
1386         return ERROR_OK;
1387 }
1388
1389 enum jtag_tap_cfg_param {
1390         JCFG_EVENT
1391 };
1392
1393 static Jim_Nvp nvp_config_opts[] = {
1394         { .name = "-event",      .value = JCFG_EVENT },
1395
1396         { .name = NULL,          .value = -1 }
1397 };
1398
1399 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1400 {
1401         Jim_Nvp *n;
1402         Jim_Obj *o;
1403         int e;
1404
1405         /* parse config or cget options */
1406         while (goi->argc > 0) {
1407                 Jim_SetEmptyResult (goi->interp);
1408
1409                 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1410                 if (e != JIM_OK) {
1411                         Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1412                         return e;
1413                 }
1414
1415                 switch (n->value) {
1416                         case JCFG_EVENT:
1417                                 if (goi->argc == 0) {
1418                                         Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1419                                         return JIM_ERR;
1420                                 }
1421
1422                                 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1423                                 if (e != JIM_OK) {
1424                                         Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1425                                         return e;
1426                                 }
1427
1428                                 if (goi->isconfigure) {
1429                                         if (goi->argc != 1) {
1430                                                 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1431                                                 return JIM_ERR;
1432                                         }
1433                                 } else {
1434                                         if (goi->argc != 0) {
1435                                                 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1436                                                 return JIM_ERR;
1437                                         }
1438                                 }
1439
1440                                 {
1441                                         jtag_tap_event_action_t *jteap;
1442
1443                                         jteap = tap->event_action;
1444                                         /* replace existing? */
1445                                         while (jteap) {
1446                                                 if (jteap->event == (enum jtag_tap_event)n->value) {
1447                                                         break;
1448                                                 }
1449                                                 jteap = jteap->next;
1450                                         }
1451
1452                                         if (goi->isconfigure) {
1453                                                 if (jteap == NULL) {
1454                                                         /* create new */
1455                                                         jteap = calloc(1, sizeof (*jteap));
1456                                                 }
1457                                                 jteap->event = n->value;
1458                                                 Jim_GetOpt_Obj( goi, &o);
1459                                                 if (jteap->body) {
1460                                                         Jim_DecrRefCount(interp, jteap->body);
1461                                                 }
1462                                                 jteap->body = Jim_DuplicateObj(goi->interp, o);
1463                                                 Jim_IncrRefCount(jteap->body);
1464
1465                                                 /* add to head of event list */
1466                                                 jteap->next = tap->event_action;
1467                                                 tap->event_action = jteap;
1468                                                 Jim_SetEmptyResult(goi->interp);
1469                                         } else {
1470                                                 /* get */
1471                                                 if (jteap == NULL) {
1472                                                         Jim_SetEmptyResult(goi->interp);
1473                                                 } else {
1474                                                         Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1475                                                 }
1476                                         }
1477                                 }
1478                                 /* loop for more */
1479                                 break;
1480                 }
1481         } /* while (goi->argc) */
1482
1483         return JIM_OK;
1484 }
1485
1486 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1487 {
1488         jtag_tap_t *pTap;
1489         jtag_tap_t **ppTap;
1490         jim_wide w;
1491         int x;
1492         int e;
1493         int reqbits;
1494         Jim_Nvp *n;
1495         char *cp;
1496         const Jim_Nvp opts[] = {
1497 #define NTAP_OPT_IRLEN     0
1498                 { .name = "-irlen"                      ,       .value = NTAP_OPT_IRLEN },
1499 #define NTAP_OPT_IRMASK    1
1500                 { .name = "-irmask"                     ,       .value = NTAP_OPT_IRMASK },
1501 #define NTAP_OPT_IRCAPTURE 2
1502                 { .name = "-ircapture"          ,       .value = NTAP_OPT_IRCAPTURE },
1503 #define NTAP_OPT_ENABLED   3
1504                 { .name = "-enable"                     ,       .value = NTAP_OPT_ENABLED },
1505 #define NTAP_OPT_DISABLED  4
1506                 { .name = "-disable"            ,       .value = NTAP_OPT_DISABLED },
1507 #define NTAP_OPT_EXPECTED_ID 5
1508                 { .name = "-expected-id"        ,       .value = NTAP_OPT_EXPECTED_ID },
1509                 { .name = NULL                          ,       .value = -1 },
1510         };
1511
1512         pTap = malloc( sizeof(jtag_tap_t) );
1513         memset( pTap, 0, sizeof(*pTap) );
1514         if( !pTap ){
1515                 Jim_SetResult_sprintf( goi->interp, "no memory");
1516                 return JIM_ERR;
1517         }
1518         /*
1519          * we expect CHIP + TAP + OPTIONS
1520          * */
1521         if( goi->argc < 3 ){
1522                 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1523                 return JIM_ERR;
1524         }
1525         Jim_GetOpt_String( goi, &cp, NULL );
1526         pTap->chip = strdup(cp);
1527
1528         Jim_GetOpt_String( goi, &cp, NULL );
1529         pTap->tapname = strdup(cp);
1530
1531         /* name + dot + name + null */
1532         x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1533         cp = malloc( x );
1534         sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1535         pTap->dotted_name = cp;
1536
1537         LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1538                           pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1539
1540         /* default is enabled */
1541         pTap->enabled = 1;
1542
1543         /* deal with options */
1544 #define NTREQ_IRLEN      1
1545 #define NTREQ_IRCAPTURE  2
1546 #define NTREQ_IRMASK     4
1547
1548         /* clear them as we find them */
1549         reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1550
1551         while( goi->argc ){
1552                 e = Jim_GetOpt_Nvp( goi, opts, &n );
1553                 if( e != JIM_OK ){
1554                         Jim_GetOpt_NvpUnknown( goi, opts, 0 );
1555                         return e;
1556                 }
1557                 LOG_DEBUG("Processing option: %s", n->name );
1558                 switch( n->value ){
1559                 case NTAP_OPT_ENABLED:
1560                         pTap->enabled = 1;
1561                         break;
1562                 case NTAP_OPT_DISABLED:
1563                         pTap->enabled = 0;
1564                         break;
1565                 case NTAP_OPT_EXPECTED_ID:
1566                 {
1567                         u32 *new_expected_ids;
1568
1569                         e = Jim_GetOpt_Wide( goi, &w );
1570                         if( e != JIM_OK) {
1571                                 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
1572                                 return e;
1573                         }
1574
1575                         new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
1576                         if (new_expected_ids == NULL) {
1577                                 Jim_SetResult_sprintf( goi->interp, "no memory");
1578                                 return JIM_ERR;
1579                         }
1580
1581                         memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
1582
1583                         new_expected_ids[pTap->expected_ids_cnt] = w;
1584
1585                         free(pTap->expected_ids);
1586                         pTap->expected_ids = new_expected_ids;
1587                         pTap->expected_ids_cnt++;
1588                         break;
1589                 }
1590                 case NTAP_OPT_IRLEN:
1591                 case NTAP_OPT_IRMASK:
1592                 case NTAP_OPT_IRCAPTURE:
1593                         e = Jim_GetOpt_Wide( goi, &w );
1594                         if( e != JIM_OK ){
1595                                 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
1596                                 return e;
1597                         }
1598                         if( (w < 0) || (w > 0xffff) ){
1599                                 /* wacky value */
1600                                 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
1601                                                                            n->name, (int)(w), (int)(w));
1602                                 return JIM_ERR;
1603                         }
1604                         switch(n->value){
1605                         case NTAP_OPT_IRLEN:
1606                                 pTap->ir_length = w;
1607                                 reqbits &= (~(NTREQ_IRLEN));
1608                                 break;
1609                         case NTAP_OPT_IRMASK:
1610                                 pTap->ir_capture_mask = w;
1611                                 reqbits &= (~(NTREQ_IRMASK));
1612                                 break;
1613                         case NTAP_OPT_IRCAPTURE:
1614                                 pTap->ir_capture_value = w;
1615                                 reqbits &= (~(NTREQ_IRCAPTURE));
1616                                 break;
1617                         }
1618                 } /* switch(n->value) */
1619         } /* while( goi->argc ) */
1620
1621         /* Did we get all the options? */
1622         if( reqbits ){
1623                 // no
1624                 Jim_SetResult_sprintf( goi->interp,
1625                                                            "newtap: %s missing required parameters",
1626                                                            pTap->dotted_name);
1627                 /* TODO: Tell user what is missing :-( */
1628                 /* no memory leaks pelase */
1629                 free(((void *)(pTap->expected_ids)));
1630                 free(((void *)(pTap->chip)));
1631                 free(((void *)(pTap->tapname)));
1632                 free(((void *)(pTap->dotted_name)));
1633                 free(((void *)(pTap)));
1634                 return JIM_ERR;
1635         }
1636
1637         pTap->expected      = malloc( pTap->ir_length );
1638         pTap->expected_mask = malloc( pTap->ir_length );
1639         pTap->cur_instr     = malloc( pTap->ir_length );
1640
1641         buf_set_u32( pTap->expected,
1642                                  0,
1643                                  pTap->ir_length,
1644                                  pTap->ir_capture_value );
1645         buf_set_u32( pTap->expected_mask,
1646                                  0,
1647                                  pTap->ir_length,
1648                                  pTap->ir_capture_mask );
1649         buf_set_ones( pTap->cur_instr,
1650                                   pTap->ir_length );
1651
1652         pTap->bypass = 1;
1653
1654         jtag_register_event_callback(jtag_reset_callback, pTap );
1655
1656         ppTap = &(jtag_all_taps);
1657         while( (*ppTap) != NULL ){
1658                 ppTap = &((*ppTap)->next_tap);
1659         }
1660         *ppTap = pTap;
1661         {
1662                 static int n_taps = 0;
1663                 pTap->abs_chain_position = n_taps++;
1664         }
1665         LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
1666                                 (*ppTap)->dotted_name,
1667                                 (*ppTap)->abs_chain_position,
1668                                 (*ppTap)->ir_length,
1669                                 (*ppTap)->ir_capture_value,
1670                                 (*ppTap)->ir_capture_mask );
1671
1672         return ERROR_OK;
1673 }
1674
1675 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
1676 {
1677         Jim_GetOptInfo goi;
1678         int e;
1679         Jim_Nvp *n;
1680         Jim_Obj *o;
1681         struct command_context_s *context;
1682
1683         enum {
1684                 JTAG_CMD_INTERFACE,
1685                 JTAG_CMD_INIT_RESET,
1686                 JTAG_CMD_NEWTAP,
1687                 JTAG_CMD_TAPENABLE,
1688                 JTAG_CMD_TAPDISABLE,
1689                 JTAG_CMD_TAPISENABLED,
1690                 JTAG_CMD_CONFIGURE,
1691                 JTAG_CMD_CGET
1692         };
1693
1694         const Jim_Nvp jtag_cmds[] = {
1695                 { .name = "interface"     , .value = JTAG_CMD_INTERFACE },
1696                 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
1697                 { .name = "newtap"        , .value = JTAG_CMD_NEWTAP },
1698                 { .name = "tapisenabled"     , .value = JTAG_CMD_TAPISENABLED },
1699                 { .name = "tapenable"     , .value = JTAG_CMD_TAPENABLE },
1700                 { .name = "tapdisable"    , .value = JTAG_CMD_TAPDISABLE },
1701                 { .name = "configure"     , .value = JTAG_CMD_CONFIGURE },
1702                 { .name = "cget"          , .value = JTAG_CMD_CGET },
1703
1704                 { .name = NULL, .value = -1 },
1705         };
1706
1707         context = Jim_GetAssocData(interp, "context");
1708         /* go past the command */
1709         Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
1710
1711         e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
1712         if( e != JIM_OK ){
1713                 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
1714                 return e;
1715         }
1716                 Jim_SetEmptyResult( goi.interp );
1717         switch( n->value ){
1718         case JTAG_CMD_INTERFACE:
1719                 /* return the name of the interface */
1720                 /* TCL code might need to know the exact type... */
1721                 /* FUTURE: we allow this as a means to "set" the interface. */
1722                 if( goi.argc != 0 ){
1723                         Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1724                         return JIM_ERR;
1725                 }
1726                 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
1727                 return JIM_OK;
1728         case JTAG_CMD_INIT_RESET:
1729                 if( goi.argc != 0 ){
1730                         Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1731                         return JIM_ERR;
1732                 }
1733                 e = jtag_init_reset(context);
1734                 if( e != ERROR_OK ){
1735                         Jim_SetResult_sprintf( goi.interp, "error: %d", e);
1736                         return JIM_ERR;
1737                 }
1738                 return JIM_OK;
1739         case JTAG_CMD_NEWTAP:
1740                 return jim_newtap_cmd( &goi );
1741                 break;
1742         case JTAG_CMD_TAPISENABLED:
1743         case JTAG_CMD_TAPENABLE:
1744         case JTAG_CMD_TAPDISABLE:
1745                 if( goi.argc != 1 ){
1746                         Jim_SetResultString( goi.interp, "Too many parameters",-1 );
1747                         return JIM_ERR;
1748                 }
1749
1750                 {
1751                         jtag_tap_t *t;
1752                         t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
1753                         if( t == NULL ){
1754                                 return JIM_ERR;
1755                         }
1756                         switch( n->value ){
1757                         case JTAG_CMD_TAPISENABLED:
1758                                 e = t->enabled;
1759                                 break;
1760                         case JTAG_CMD_TAPENABLE:
1761                                 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
1762                                 e = 1;
1763                                 t->enabled = e;
1764                                 break;
1765                         case JTAG_CMD_TAPDISABLE:
1766                                 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
1767                                 e = 0;
1768                                 t->enabled = e;
1769                                 break;
1770                         }
1771                         Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
1772                         return JIM_OK;
1773                 }
1774                 break;
1775
1776         case JTAG_CMD_CGET:
1777                 if( goi.argc < 2 ){
1778                         Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
1779                         return JIM_ERR;
1780                 }
1781
1782                 {
1783                         jtag_tap_t *t;
1784
1785                         Jim_GetOpt_Obj(&goi, &o);
1786                         t = jtag_TapByJimObj( goi.interp, o );
1787                         if( t == NULL ){
1788                                 return JIM_ERR;
1789                         }
1790
1791                         goi.isconfigure = 0;
1792                         return jtag_tap_configure_cmd( &goi, t);
1793                 }
1794                 break;
1795
1796         case JTAG_CMD_CONFIGURE:
1797                 if( goi.argc < 3 ){
1798                         Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
1799                         return JIM_ERR;
1800                 }
1801
1802                 {
1803                         jtag_tap_t *t;
1804
1805                         Jim_GetOpt_Obj(&goi, &o);
1806                         t = jtag_TapByJimObj( goi.interp, o );
1807                         if( t == NULL ){
1808                                 return JIM_ERR;
1809                         }
1810
1811                         goi.isconfigure = 1;
1812                         return jtag_tap_configure_cmd( &goi, t);
1813                 }
1814         }
1815
1816         return JIM_ERR;
1817 }
1818
1819 int jtag_register_commands(struct command_context_s *cmd_ctx)
1820 {
1821         register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
1822
1823         register_command(cmd_ctx, NULL, "interface", handle_interface_command,
1824                 COMMAND_CONFIG, "try to configure interface");
1825         register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
1826                 COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
1827         register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
1828                 COMMAND_ANY, "set maximum jtag speed (if supported); "
1829                 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1830         register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
1831                 COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1832         register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
1833                 COMMAND_ANY,
1834                 "[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]");
1835         register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
1836                 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1837         register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
1838                 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1839
1840         register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
1841                 COMMAND_EXEC, "print current scan chain configuration");
1842
1843         register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
1844                 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
1845         register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
1846                 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
1847         register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
1848                 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
1849         register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
1850                 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1851         register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1852         register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
1853
1854         register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
1855                 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
1856         register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
1857                 COMMAND_ANY, "verify value capture <enable|disable>");
1858         register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
1859                 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
1860         return ERROR_OK;
1861 }
1862
1863 int jtag_interface_init(struct command_context_s *cmd_ctx)
1864 {
1865         if (jtag)
1866                 return ERROR_OK;
1867
1868         if (!jtag_interface)
1869         {
1870                 /* nothing was previously specified by "interface" command */
1871                 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1872                 return ERROR_JTAG_INVALID_INTERFACE;
1873         }
1874         if(hasKHz)
1875         {
1876                 jtag_interface->khz(speed_khz, &jtag_speed);
1877                 hasKHz = 0;
1878         }
1879
1880         if (jtag_interface->init() != ERROR_OK)
1881                 return ERROR_JTAG_INIT_FAILED;
1882
1883         jtag = jtag_interface;
1884         return ERROR_OK;
1885 }
1886
1887 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1888 {
1889         jtag_tap_t *tap;
1890         int retval;
1891
1892         LOG_DEBUG("Init JTAG chain");
1893
1894         tap = jtag_NextEnabledTap(NULL);
1895         if( tap == NULL ){
1896                 LOG_ERROR("There are no enabled taps?");
1897                 return ERROR_JTAG_INIT_FAILED;
1898         }
1899
1900         jtag_add_tlr();
1901         if ((retval=jtag_execute_queue())!=ERROR_OK)
1902                 return retval;
1903
1904         /* examine chain first, as this could discover the real chain layout */
1905         if (jtag_examine_chain() != ERROR_OK)
1906         {
1907                 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1908         }
1909
1910         if (jtag_validate_chain() != ERROR_OK)
1911         {
1912                 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1913         }
1914
1915         return ERROR_OK;
1916 }
1917
1918 int jtag_interface_quit(void)
1919 {
1920         if (!jtag || !jtag->quit)
1921                 return ERROR_OK;
1922
1923         // close the JTAG interface
1924         int result = jtag->quit();
1925         if (ERROR_OK != result)
1926                 LOG_ERROR("failed: %d", result);
1927
1928         return ERROR_OK;
1929 }
1930
1931
1932 int jtag_init_reset(struct command_context_s *cmd_ctx)
1933 {
1934         int retval;
1935
1936         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1937                 return retval;
1938
1939         LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1940
1941         /* Reset can happen after a power cycle.
1942          *
1943          * Ideally we would only assert TRST or run RESET before the target reset.
1944          *
1945          * However w/srst_pulls_trst, trst is asserted together with the target
1946          * reset whether we want it or not.
1947          *
1948          * NB! Some targets have JTAG circuitry disabled until a
1949          * trst & srst has been asserted.
1950          *
1951          * NB! here we assume nsrst/ntrst delay are sufficient!
1952          *
1953          * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1954          *
1955          */
1956         jtag_add_reset(1, 0); /* RESET or TRST */
1957         if (jtag_reset_config & RESET_HAS_SRST)
1958         {
1959                 jtag_add_reset(1, 1);
1960                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
1961                         jtag_add_reset(0, 1);
1962         }
1963         jtag_add_reset(0, 0);
1964         if ((retval = jtag_execute_queue()) != ERROR_OK)
1965                 return retval;
1966
1967         /* Check that we can communication on the JTAG chain + eventually we want to
1968          * be able to perform enumeration only after OpenOCD has started
1969          * telnet and GDB server
1970          *
1971          * That would allow users to more easily perform any magic they need to before
1972          * reset happens.
1973          */
1974         return jtag_init_inner(cmd_ctx);
1975 }
1976
1977 int jtag_init(struct command_context_s *cmd_ctx)
1978 {
1979         int retval;
1980         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1981                 return retval;
1982         if (jtag_init_inner(cmd_ctx)==ERROR_OK)
1983         {
1984                 return ERROR_OK;
1985         }
1986         return jtag_init_reset(cmd_ctx);
1987 }
1988
1989 static int default_khz(int khz, int *jtag_speed)
1990 {
1991         LOG_ERROR("Translation from khz to jtag_speed not implemented");
1992         return ERROR_FAIL;
1993 }
1994
1995 static int default_speed_div(int speed, int *khz)
1996 {
1997         LOG_ERROR("Translation from jtag_speed to khz not implemented");
1998         return ERROR_FAIL;
1999 }
2000
2001 static int default_power_dropout(int *dropout)
2002 {
2003         *dropout=0; /* by default we can't detect power dropout */
2004         return ERROR_OK;
2005 }
2006
2007 static int default_srst_asserted(int *srst_asserted)
2008 {
2009         *srst_asserted=0; /* by default we can't detect srst asserted */
2010         return ERROR_OK;
2011 }
2012
2013 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2014 {
2015         int i;
2016         int retval;
2017
2018         /* check whether the interface is already configured */
2019         if (jtag_interface)
2020         {
2021                 LOG_WARNING("Interface already configured, ignoring");
2022                 return ERROR_OK;
2023         }
2024
2025         /* interface name is a mandatory argument */
2026         if (argc < 1 || args[0][0] == '\0')
2027         {
2028                 return ERROR_COMMAND_SYNTAX_ERROR;
2029         }
2030
2031         for (i=0; jtag_interfaces[i]; i++)
2032         {
2033                 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2034                 {
2035                         if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2036                         {
2037                                 return retval;
2038                         }
2039
2040                         jtag_interface = jtag_interfaces[i];
2041
2042                         if (jtag_interface->khz == NULL)
2043                         {
2044                                 jtag_interface->khz = default_khz;
2045                         }
2046                         if (jtag_interface->speed_div == NULL)
2047                         {
2048                                 jtag_interface->speed_div = default_speed_div;
2049                         }
2050                         if (jtag_interface->power_dropout == NULL)
2051                         {
2052                                 jtag_interface->power_dropout = default_power_dropout;
2053                         }
2054                         if (jtag_interface->srst_asserted == NULL)
2055                         {
2056                                 jtag_interface->srst_asserted = default_srst_asserted;
2057                         }
2058
2059                         return ERROR_OK;
2060                 }
2061         }
2062
2063         /* no valid interface was found (i.e. the configuration option,
2064          * didn't match one of the compiled-in interfaces
2065          */
2066         LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2067         LOG_ERROR("compiled-in jtag interfaces:");
2068         for (i = 0; jtag_interfaces[i]; i++)
2069         {
2070                 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2071         }
2072
2073         return ERROR_JTAG_INVALID_INTERFACE;
2074 }
2075
2076 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2077 {
2078         int e;
2079         char buf[1024];
2080         Jim_Obj *newargs[ 10 ];
2081         /*
2082          * CONVERT SYNTAX
2083          * argv[-1] = command
2084          * argv[ 0] = ir length
2085          * argv[ 1] = ir capture
2086          * argv[ 2] = ir mask
2087          * argv[ 3] = not actually used by anything but in the docs
2088          */
2089
2090         if( argc < 4 ){
2091                 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2092                 return ERROR_OK;
2093         }
2094         command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2095         command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2096                                    args[0],
2097                                    args[1],
2098                                    args[2] );
2099         command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2100         command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2101         command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2102         command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2103
2104         newargs[0] = Jim_NewStringObj( interp, "jtag", -1   );
2105         newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2106         sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2107         newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2108         sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2109         newargs[3] = Jim_NewStringObj( interp, buf, -1  );
2110         newargs[4] = Jim_NewStringObj( interp, "-irlen", -1  );
2111         newargs[5] = Jim_NewStringObj( interp, args[0], -1  );
2112         newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1  );
2113         newargs[7] = Jim_NewStringObj( interp, args[1], -1  );
2114         newargs[8] = Jim_NewStringObj( interp, "-irmask", -1  );
2115         newargs[9] = Jim_NewStringObj( interp, args[2], -1  );
2116
2117         command_print( cmd_ctx, "NEW COMMAND:");
2118         sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2119                          Jim_GetString( newargs[0], NULL ),
2120                          Jim_GetString( newargs[1], NULL ),
2121                          Jim_GetString( newargs[2], NULL ),
2122                          Jim_GetString( newargs[3], NULL ),
2123                          Jim_GetString( newargs[4], NULL ),
2124                          Jim_GetString( newargs[5], NULL ),
2125                          Jim_GetString( newargs[6], NULL ),
2126                          Jim_GetString( newargs[7], NULL ),
2127                          Jim_GetString( newargs[8], NULL ),
2128                          Jim_GetString( newargs[9], NULL ) );
2129
2130         e = jim_jtag_command( interp, 10, newargs );
2131         if( e != JIM_OK ){
2132                 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2133         }
2134         return e;
2135 }
2136
2137 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2138 {
2139         jtag_tap_t *tap;
2140
2141         tap = jtag_all_taps;
2142         command_print(cmd_ctx, "     TapName            | Enabled |   IdCode      Expected    IrLen IrCap  IrMask Instr     ");
2143         command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2144
2145         while( tap ){
2146                 u32 expected, expected_mask, cur_instr, ii;
2147                 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2148                 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2149                 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2150
2151                 command_print(cmd_ctx,
2152                                           "%2d | %-18s |    %c    | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2153                                           tap->abs_chain_position,
2154                                           tap->dotted_name,
2155                                           tap->enabled ? 'Y' : 'n',
2156                                           tap->idcode,
2157                                           (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2158                                           tap->ir_length,
2159                                           expected,
2160                                           expected_mask,
2161                                           cur_instr);
2162
2163                 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2164                         command_print(cmd_ctx, "   |                    |         |            | 0x%08x |      |      |      |         ",
2165                                                   tap->expected_ids[ii]);
2166                 }
2167
2168                 tap = tap->next_tap;
2169         }
2170
2171         return ERROR_OK;
2172 }
2173
2174 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2175 {
2176         int new_cfg = 0;
2177         int mask = 0;
2178
2179         if (argc < 1)
2180                 return ERROR_COMMAND_SYNTAX_ERROR;
2181
2182         /* Original versions cared about the order of these tokens:
2183          *   reset_config signals [combination [trst_type [srst_type]]]
2184          * They also clobbered the previous configuration even on error.
2185          *
2186          * Here we don't care about the order, and only change values
2187          * which have been explicitly specified.
2188          */
2189         for (; argc; argc--, args++) {
2190                 int tmp = 0;
2191                 int m;
2192
2193                 /* signals */
2194                 m = RESET_HAS_TRST | RESET_HAS_SRST;
2195                 if (strcmp(*args, "none") == 0)
2196                         tmp = RESET_NONE;
2197                 else if (strcmp(*args, "trst_only") == 0)
2198                         tmp = RESET_HAS_TRST;
2199                 else if (strcmp(*args, "srst_only") == 0)
2200                         tmp = RESET_HAS_SRST;
2201                 else if (strcmp(*args, "trst_and_srst") == 0)
2202                         tmp = RESET_HAS_TRST | RESET_HAS_SRST;
2203                 else
2204                         m = 0;
2205                 if (mask & m) {
2206                         LOG_ERROR("extra reset_config %s spec (%s)",
2207                                         "signal", *args);
2208                         return ERROR_INVALID_ARGUMENTS;
2209                 }
2210                 if (m)
2211                         goto next;
2212
2213                 /* combination (options for broken wiring) */
2214                 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2215                 if (strcmp(*args, "separate") == 0)
2216                         /* separate reset lines - default */;
2217                 else if (strcmp(*args, "srst_pulls_trst") == 0)
2218                         tmp |= RESET_SRST_PULLS_TRST;
2219                 else if (strcmp(*args, "trst_pulls_srst") == 0)
2220                         tmp |= RESET_TRST_PULLS_SRST;
2221                 else if (strcmp(*args, "combined") == 0)
2222                         tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2223                 else
2224                         m = 0;
2225                 if (mask & m) {
2226                         LOG_ERROR("extra reset_config %s spec (%s)",
2227                                         "combination", *args);
2228                         return ERROR_INVALID_ARGUMENTS;
2229                 }
2230                 if (m)
2231                         goto next;
2232
2233                 /* trst_type (NOP without HAS_TRST) */
2234                 m = RESET_TRST_OPEN_DRAIN;
2235                 if (strcmp(*args, "trst_open_drain") == 0)
2236                         tmp |= RESET_TRST_OPEN_DRAIN;
2237                 else if (strcmp(*args, "trst_push_pull") == 0)
2238                         /* push/pull from adapter - default */;
2239                 else
2240                         m = 0;
2241                 if (mask & m) {
2242                         LOG_ERROR("extra reset_config %s spec (%s)",
2243                                         "trst_type", *args);
2244                         return ERROR_INVALID_ARGUMENTS;
2245                 }
2246                 if (m)
2247                         goto next;
2248
2249                 /* srst_type (NOP without HAS_SRST) */
2250                 m |= RESET_SRST_PUSH_PULL;
2251                 if (strcmp(*args, "srst_push_pull") == 0)
2252                         tmp |= RESET_SRST_PUSH_PULL;
2253                 else if (strcmp(*args, "srst_open_drain") == 0)
2254                         /* open drain from adapter - default */;
2255                 else
2256                         m = 0;
2257                 if (mask & m) {
2258                         LOG_ERROR("extra reset_config %s spec (%s)",
2259                                         "srst_type", *args);
2260                         return ERROR_INVALID_ARGUMENTS;
2261                 }
2262                 if (m)
2263                         goto next;
2264
2265                 /* caller provided nonsense; fail */
2266                 LOG_ERROR("unknown reset_config flag (%s)", *args);
2267                 return ERROR_INVALID_ARGUMENTS;
2268
2269 next:
2270                 /* Remember the bits which were specified (mask)
2271                  * and their new values (new_cfg).
2272                  */
2273                 mask |= m;
2274                 new_cfg |= tmp;
2275         }
2276
2277         /* clear previous values of those bits, save new values */
2278         jtag_reset_config &= ~mask;
2279         jtag_reset_config |= new_cfg;
2280
2281         return ERROR_OK;
2282 }
2283
2284 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2285 {
2286         if (argc < 1)
2287         {
2288                 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2289                 exit(-1);
2290         }
2291         else
2292         {
2293                 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2294         }
2295
2296         return ERROR_OK;
2297 }
2298
2299 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2300 {
2301         if (argc < 1)
2302         {
2303                 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2304                 exit(-1);
2305         }
2306         else
2307         {
2308                 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2309         }
2310
2311         return ERROR_OK;
2312 }
2313
2314 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2315 {
2316         int retval=ERROR_OK;
2317
2318         if (argc == 1)
2319         {
2320                 LOG_DEBUG("handle jtag speed");
2321
2322                 int cur_speed = 0;
2323                 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2324
2325                 /* this command can be called during CONFIG,
2326                  * in which case jtag isn't initialized */
2327                 if (jtag)
2328                 {
2329                         retval=jtag->speed(cur_speed);
2330                 }
2331         } else if (argc == 0)
2332         {
2333         } else
2334         {
2335                 return ERROR_COMMAND_SYNTAX_ERROR;
2336         }
2337         command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2338
2339         return retval;
2340 }
2341
2342 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2343 {
2344         int retval=ERROR_OK;
2345         LOG_DEBUG("handle jtag khz");
2346
2347         if(argc == 1)
2348         {
2349                 speed_khz = strtoul(args[0], NULL, 0);
2350                 if (jtag != NULL)
2351                 {
2352                         int cur_speed = 0;
2353                         LOG_DEBUG("have interface set up");
2354                         int speed_div1;
2355                         if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2356                         {
2357                                 speed_khz = 0;
2358                                 return retval;
2359                         }
2360
2361                         cur_speed = jtag_speed = speed_div1;
2362
2363                         retval=jtag->speed(cur_speed);
2364                 } else
2365                 {
2366                         hasKHz = 1;
2367                 }
2368         } else if (argc==0)
2369         {
2370         } else
2371         {
2372                 return ERROR_COMMAND_SYNTAX_ERROR;
2373         }
2374
2375         if (jtag!=NULL)
2376         {
2377                 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2378                         return retval;
2379         }
2380
2381         if (speed_khz==0)
2382         {
2383                 command_print(cmd_ctx, "RCLK - adaptive");
2384         } else
2385         {
2386                 command_print(cmd_ctx, "%d kHz", speed_khz);
2387         }
2388         return retval;
2389
2390 }
2391
2392 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2393 {
2394         tap_state_t state;
2395
2396         if (argc < 1)
2397         {
2398                 return ERROR_COMMAND_SYNTAX_ERROR;
2399         }
2400         else
2401         {
2402                 state = tap_state_by_name( args[0] );
2403                 if( state < 0 ){
2404                         command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2405                         return ERROR_COMMAND_SYNTAX_ERROR;
2406                 }
2407                 jtag_add_end_state(state);
2408                 jtag_execute_queue();
2409         }
2410         command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2411
2412         return ERROR_OK;
2413 }
2414
2415 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2416 {
2417         int trst = -1;
2418         int srst = -1;
2419
2420         if (argc < 2)
2421         {
2422                 return ERROR_COMMAND_SYNTAX_ERROR;
2423         }
2424
2425         if (args[0][0] == '1')
2426                 trst = 1;
2427         else if (args[0][0] == '0')
2428                 trst = 0;
2429         else
2430         {
2431                 return ERROR_COMMAND_SYNTAX_ERROR;
2432         }
2433
2434         if (args[1][0] == '1')
2435                 srst = 1;
2436         else if (args[1][0] == '0')
2437                 srst = 0;
2438         else
2439         {
2440                 return ERROR_COMMAND_SYNTAX_ERROR;
2441         }
2442
2443         if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2444                 return ERROR_JTAG_INIT_FAILED;
2445
2446         jtag_add_reset(trst, srst);
2447         jtag_execute_queue();
2448
2449         return ERROR_OK;
2450 }
2451
2452 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2453 {
2454         if (argc < 1)
2455         {
2456                 return ERROR_COMMAND_SYNTAX_ERROR;
2457         }
2458
2459         jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2460         jtag_execute_queue();
2461
2462         return ERROR_OK;
2463
2464 }
2465
2466 /*
2467  * For "irscan" or "drscan" commands, the "end" (really, "next") state
2468  * should be stable ... and *NOT* a shift state, otherwise free-running
2469  * jtag clocks could change the values latched by the update state.
2470  */
2471 static bool scan_is_safe(tap_state_t state)
2472 {
2473         switch (state)
2474         {
2475         case TAP_RESET:
2476         case TAP_IDLE:
2477         case TAP_DRPAUSE:
2478         case TAP_IRPAUSE:
2479                 return true;
2480         default:
2481                 return false;
2482         }
2483 }
2484
2485
2486 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2487 {
2488         int i;
2489         scan_field_t *fields;
2490         jtag_tap_t *tap;
2491         tap_state_t endstate;
2492
2493         if ((argc < 2) || (argc % 2))
2494         {
2495                 return ERROR_COMMAND_SYNTAX_ERROR;
2496         }
2497
2498         /* optional "-endstate" "statename" at the end of the arguments,
2499          * so that e.g. IRPAUSE can let us load the data register before
2500          * entering RUN/IDLE to execute the instruction we load here.
2501          */
2502         endstate = TAP_IDLE;
2503
2504         if( argc >= 4 ){
2505                 /* have at least one pair of numbers. */
2506                 /* is last pair the magic text? */
2507                 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2508                         const char *cpA;
2509                         const char *cpS;
2510                         cpA = args[ argc-1 ];
2511                         for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2512                                 cpS = tap_state_name( endstate );
2513                                 if( 0 == strcmp( cpA, cpS ) ){
2514                                         break;
2515                                 }
2516                         }
2517                         if( endstate >= TAP_NUM_STATES ){
2518                                 return ERROR_COMMAND_SYNTAX_ERROR;
2519                         } else {
2520                                 if (!scan_is_safe(endstate))
2521                                         LOG_WARNING("irscan with unsafe "
2522                                                         "endstate \"%s\"", cpA);
2523                                 /* found - remove the last 2 args */
2524                                 argc -= 2;
2525                         }
2526                 }
2527         }
2528
2529         int num_fields = argc / 2;
2530
2531         fields = malloc(sizeof(scan_field_t) * num_fields);
2532
2533         for (i = 0; i < num_fields; i++)
2534         {
2535                 tap = jtag_TapByString( args[i*2] );
2536                 if (tap==NULL)
2537                 {
2538                         command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2539                         return ERROR_FAIL;
2540                 }
2541                 int field_size = tap->ir_length;
2542                 fields[i].tap = tap;
2543                 fields[i].num_bits = field_size;
2544                 fields[i].out_value = malloc(CEIL(field_size, 8));
2545                 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2546                 fields[i].in_value = NULL;
2547         }
2548
2549         /* did we have an endstate? */
2550         jtag_add_ir_scan(num_fields, fields, endstate);
2551
2552         int retval=jtag_execute_queue();
2553
2554         for (i = 0; i < num_fields; i++)
2555                 free(fields[i].out_value);
2556
2557         free (fields);
2558
2559         return retval;
2560 }
2561
2562 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2563 {
2564         int retval;
2565         scan_field_t *fields;
2566         int num_fields;
2567         int field_count = 0;
2568         int i, e;
2569         jtag_tap_t *tap;
2570         tap_state_t endstate;
2571
2572         /* args[1] = device
2573          * args[2] = num_bits
2574          * args[3] = hex string
2575          * ... repeat num bits and hex string ...
2576          *
2577          * .. optionally:
2578         *     args[N-2] = "-endstate"
2579          *     args[N-1] = statename
2580          */
2581         if ((argc < 4) || ((argc % 2)!=0))
2582         {
2583                 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2584                 return JIM_ERR;
2585         }
2586
2587         endstate = TAP_IDLE;
2588
2589         /* validate arguments as numbers */
2590         e = JIM_OK;
2591         for (i = 2; i < argc; i+=2)
2592         {
2593                 long bits;
2594                 const char *cp;
2595
2596                 e = Jim_GetLong(interp, args[i], &bits);
2597                 /* If valid - try next arg */
2598                 if( e == JIM_OK ){
2599                         continue;
2600                 }
2601
2602                 /* Not valid.. are we at the end? */
2603                 if ( ((i+2) != argc) ){
2604                         /* nope, then error */
2605                         return e;
2606                 }
2607
2608                 /* it could be: "-endstate FOO"
2609                  * e.g. DRPAUSE so we can issue more instructions
2610                  * before entering RUN/IDLE and executing them.
2611                  */
2612
2613                 /* get arg as a string. */
2614                 cp = Jim_GetString( args[i], NULL );
2615                 /* is it the magic? */
2616                 if( 0 == strcmp( "-endstate", cp ) ){
2617                         /* is the statename valid? */
2618                         cp = Jim_GetString( args[i+1], NULL );
2619
2620                         /* see if it is a valid state name */
2621                         endstate = tap_state_by_name(cp);
2622                         if( endstate < 0 ){
2623                                 /* update the error message */
2624                                 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2625                         } else {
2626                                 if (!scan_is_safe(endstate))
2627                                         LOG_WARNING("drscan with unsafe "
2628                                                         "endstate \"%s\"", cp);
2629
2630                                 /* valid - so clear the error */
2631                                 e = JIM_OK;
2632                                 /* and remove the last 2 args */
2633                                 argc -= 2;
2634                         }
2635                 }
2636
2637                 /* Still an error? */
2638                 if( e != JIM_OK ){
2639                         return e; /* too bad */
2640                 }
2641         } /* validate args */
2642
2643         tap = jtag_TapByJimObj( interp, args[1] );
2644         if( tap == NULL ){
2645                 return JIM_ERR;
2646         }
2647
2648         num_fields=(argc-2)/2;
2649         fields = malloc(sizeof(scan_field_t) * num_fields);
2650         for (i = 2; i < argc; i+=2)
2651         {
2652                 long bits;
2653                 int len;
2654                 const char *str;
2655
2656                 Jim_GetLong(interp, args[i], &bits);
2657                 str = Jim_GetString(args[i+1], &len);
2658
2659                 fields[field_count].tap = tap;
2660                 fields[field_count].num_bits = bits;
2661                 fields[field_count].out_value = malloc(CEIL(bits, 8));
2662                 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
2663                 fields[field_count].in_value = fields[field_count].out_value;
2664                 field_count++;
2665         }
2666
2667         jtag_add_dr_scan(num_fields, fields, endstate);
2668
2669         retval = jtag_execute_queue();
2670         if (retval != ERROR_OK)
2671         {
2672                 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
2673                 return JIM_ERR;
2674         }
2675
2676         field_count=0;
2677         Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
2678         for (i = 2; i < argc; i+=2)
2679         {
2680                 long bits;
2681                 char *str;
2682
2683                 Jim_GetLong(interp, args[i], &bits);
2684                 str = buf_to_str(fields[field_count].in_value, bits, 16);
2685                 free(fields[field_count].out_value);
2686
2687                 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
2688                 free(str);
2689                 field_count++;
2690         }
2691
2692         Jim_SetResult(interp, list);
2693
2694         free(fields);
2695
2696         return JIM_OK;
2697 }
2698
2699
2700 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2701 {
2702         Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
2703
2704         return JIM_OK;
2705 }
2706
2707
2708 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2709 {
2710         if (argc == 1)
2711         {
2712                 if (strcmp(args[0], "enable") == 0)
2713                 {
2714                         jtag_verify_capture_ir = 1;
2715                 }
2716                 else if (strcmp(args[0], "disable") == 0)
2717                 {
2718                         jtag_verify_capture_ir = 0;
2719                 } else
2720                 {
2721                         return ERROR_COMMAND_SYNTAX_ERROR;
2722                 }
2723         } else if (argc != 0)
2724         {
2725                 return ERROR_COMMAND_SYNTAX_ERROR;
2726         }
2727
2728         command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
2729
2730         return ERROR_OK;
2731 }
2732
2733 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2734 {
2735         if (argc == 1)
2736         {
2737                 if (strcmp(args[0], "enable") == 0)
2738                 {
2739                         jtag_verify = 1;
2740                 }
2741                 else if (strcmp(args[0], "disable") == 0)
2742                 {
2743                         jtag_verify = 0;
2744                 } else
2745                 {
2746                         return ERROR_COMMAND_SYNTAX_ERROR;
2747                 }
2748         } else if (argc != 0)
2749         {
2750                 return ERROR_COMMAND_SYNTAX_ERROR;
2751         }
2752
2753         command_print(cmd_ctx, "verify jtag capture is %s", (jtag_verify) ? "enabled": "disabled");
2754
2755         return ERROR_OK;
2756 }
2757
2758
2759 int jtag_power_dropout(int *dropout)
2760 {
2761         return jtag->power_dropout(dropout);
2762 }
2763
2764 int jtag_srst_asserted(int *srst_asserted)
2765 {
2766         return jtag->srst_asserted(srst_asserted);
2767 }
2768
2769 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
2770 {
2771         jtag_tap_event_action_t * jteap;
2772         int done;
2773
2774         jteap = tap->event_action;
2775
2776         done = 0;
2777         while (jteap) {
2778                 if (jteap->event == e) {
2779                         done = 1;
2780                         LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2781                                         tap->dotted_name,
2782                                         e,
2783                                         Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
2784                                         Jim_GetString(jteap->body, NULL) );
2785                         if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
2786                                 Jim_PrintErrorMessage(interp);
2787                         }
2788                 }
2789
2790                 jteap = jteap->next;
2791         }
2792
2793         if (!done) {
2794                 LOG_DEBUG( "event %d %s - no action",
2795                                 e,
2796                                 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
2797         }
2798 }
2799
2800 /*-----<Cable Helper API>---------------------------------------*/
2801
2802 /*  these Cable Helper API functions are all documented in the jtag.h header file,
2803         using a Doxygen format.  And since Doxygen's configuration file "Doxyfile",
2804         is setup to prefer its docs in the header file, no documentation is here, for
2805         if it were, it would have to be doubly maintained.
2806 */
2807
2808 /**
2809  * @see tap_set_state() and tap_get_state() accessors.
2810  * Actual name is not important since accessors hide it.
2811  */
2812 static tap_state_t state_follower = TAP_RESET;
2813
2814 void tap_set_state_impl( tap_state_t new_state )
2815 {
2816         /* this is the state we think the TAPs are in now, was cur_state */
2817         state_follower = new_state;
2818 }
2819
2820 tap_state_t tap_get_state()
2821 {
2822         return state_follower;
2823 }
2824
2825 /**
2826  * @see tap_set_end_state() and tap_get_end_state() accessors.
2827  * Actual name is not important because accessors hide it.
2828  */
2829 static tap_state_t end_state_follower = TAP_RESET;
2830
2831 void tap_set_end_state( tap_state_t new_end_state )
2832 {
2833         /* this is the state we think the TAPs will be in at completion of the
2834            current TAP operation, was end_state
2835         */
2836         end_state_follower = new_end_state;
2837 }
2838
2839 tap_state_t tap_get_end_state()
2840 {
2841         return end_state_follower;
2842 }
2843
2844
2845 int tap_move_ndx( tap_state_t astate )
2846 {
2847         /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
2848
2849         int ndx;
2850
2851         switch( astate )
2852         {
2853         case TAP_RESET:         ndx = 0;                        break;
2854         case TAP_DRSHIFT:       ndx = 2;                        break;
2855         case TAP_DRPAUSE:       ndx = 3;                        break;
2856         case TAP_IDLE:          ndx = 1;                        break;
2857         case TAP_IRSHIFT:       ndx = 4;                        break;
2858         case TAP_IRPAUSE:       ndx = 5;                        break;
2859         default:
2860                 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
2861                 exit(1);
2862         }
2863
2864         return ndx;
2865 }
2866
2867
2868 /* tap_move[i][j]: tap movement command to go from state i to state j
2869  * 0: Test-Logic-Reset
2870  * 1: Run-Test/Idle
2871  * 2: Shift-DR
2872  * 3: Pause-DR
2873  * 4: Shift-IR
2874  * 5: Pause-IR
2875  *
2876  * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
2877  */
2878 struct tms_sequences
2879 {
2880         u8      bits;
2881         u8      bit_count;
2882
2883 };
2884
2885 /*
2886  * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
2887  * Read the bits from LSBit first to MSBit last (right-to-left).
2888  */
2889 #define HEX__(n) 0x##n##LU
2890
2891 #define B8__(x) \
2892          (((x) & 0x0000000FLU)?(1<<0):0) \
2893         +(((x) & 0x000000F0LU)?(1<<1):0) \
2894         +(((x) & 0x00000F00LU)?(1<<2):0) \
2895         +(((x) & 0x0000F000LU)?(1<<3):0) \
2896         +(((x) & 0x000F0000LU)?(1<<4):0) \
2897         +(((x) & 0x00F00000LU)?(1<<5):0) \
2898         +(((x) & 0x0F000000LU)?(1<<6):0) \
2899         +(((x) & 0xF0000000LU)?(1<<7):0)
2900
2901 #define B8(bits,count)          { ((u8)B8__(HEX__(bits))), (count) }
2902
2903 static const struct tms_sequences old_tms_seqs[6][6] =          /*  [from_state_ndx][to_state_ndx] */
2904 {
2905         /* value clocked to TMS to move from one of six stable states to another.
2906          * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
2907          * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
2908          * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
2909          * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
2910          */
2911
2912
2913
2914         /* to state: */
2915         /*      RESET                   IDLE                    DRSHIFT                 DRPAUSE                 IRSHIFT                 IRPAUSE         */              /* from state: */
2916         {       B8(1111111,7),  B8(0000000,7),  B8(0010111,7),  B8(0001010,7),  B8(0011011,7),  B8(0010110,7) },        /* RESET */
2917         {       B8(1111111,7),  B8(0000000,7),  B8(0100101,7),  B8(0000101,7),  B8(0101011,7),  B8(0001011,7) },        /* IDLE */
2918         {       B8(1111111,7),  B8(0110001,7),  B8(0000000,7),  B8(0000001,7),  B8(0001111,7),  B8(0101111,7) },        /* DRSHIFT */
2919         {       B8(1111111,7),  B8(0110000,7),  B8(0100000,7),  B8(0010111,7),  B8(0011110,7),  B8(0101111,7) },        /* DRPAUSE */
2920         {       B8(1111111,7),  B8(0110001,7),  B8(0000111,7),  B8(0010111,7),  B8(0000000,7),  B8(0000001,7) },        /* IRSHIFT */
2921         {       B8(1111111,7),  B8(0110000,7),  B8(0011100,7),  B8(0010111,7),  B8(0011110,7),  B8(0101111,7) },        /* IRPAUSE */
2922 };
2923
2924
2925
2926 static const struct tms_sequences short_tms_seqs[6][6] =                /*  [from_state_ndx][to_state_ndx] */
2927 {
2928         /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
2929
2930                 OK, I added Peter's version of the state table, and it works OK for
2931                 me on MC1322x. I've recreated the jlink portion of patch with this
2932                 new state table. His changes to my state table are pretty minor in
2933                 terms of total transitions, but Peter feels that his version fixes
2934                 some long-standing problems.
2935                 Jeff
2936
2937                 I added the bit count into the table, reduced RESET column to 7 bits from 8.
2938                 Dick
2939
2940                 state specific comments:
2941                 ------------------------
2942                 *->RESET                   tried the 5 bit reset and it gave me problems, 7 bits seems to
2943                                            work better on ARM9 with ft2232 driver.  (Dick)
2944
2945                 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
2946                                                 needed on ARM9 with ft2232 driver.  (Dick)
2947
2948                 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
2949                                                 needed on ARM9 with ft2232 driver.  (Dick)
2950         */
2951
2952         /* to state: */
2953         /*      RESET                   IDLE                            DRSHIFT                 DRPAUSE                 IRSHIFT                 IRPAUSE */                      /* from state: */
2954         {       B8(1111111,7),  B8(0000000,7),  B8(0010111,7),          B8(0001010,7),  B8(0011011,7),  B8(0010110,7) },        /* RESET */
2955         {       B8(1111111,7),  B8(0000000,7),  B8(001,3),                      B8(0101,4),             B8(0011,4),     B8(01011,5) },          /* IDLE */
2956         {       B8(1111111,7),  B8(011,3),              B8(00111,5),            B8(01,2),               B8(001111,6),   B8(0101111,7) },        /* DRSHIFT */
2957         {       B8(1111111,7),  B8(011,3),              B8(01,2),               B8(0,1),                B8(001111,6),   B8(0101111,7) },        /* DRPAUSE */
2958         {       B8(1111111,7),  B8(011,3),              B8(00111,5),            B8(010111,6),   B8(001111,6),   B8(01,2) },                     /* IRSHIFT */
2959         {       B8(1111111,7),  B8(011,3),              B8(00111,5),            B8(010111,6),   B8(01,2),               B8(0,1) }                       /* IRPAUSE */
2960
2961 };
2962
2963 typedef const struct tms_sequences tms_table[6][6];
2964
2965 static tms_table *tms_seqs=&short_tms_seqs;
2966
2967 int tap_get_tms_path( tap_state_t from, tap_state_t to )
2968 {
2969         return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bits;
2970 }
2971
2972
2973 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
2974 {
2975         return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
2976 }
2977
2978
2979 bool tap_is_state_stable(tap_state_t astate)
2980 {
2981         bool is_stable;
2982
2983         /*      A switch() is used because it is symbol dependent
2984                 (not value dependent like an array), and can also check bounds.
2985         */
2986         switch( astate )
2987         {
2988         case TAP_RESET:
2989         case TAP_IDLE:
2990         case TAP_DRSHIFT:
2991         case TAP_DRPAUSE:
2992         case TAP_IRSHIFT:
2993         case TAP_IRPAUSE:
2994                 is_stable = true;
2995                 break;
2996         default:
2997                 is_stable = false;
2998         }
2999
3000         return is_stable;
3001 }
3002
3003 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3004 {
3005         tap_state_t new_state;
3006
3007         /*      A switch is used because it is symbol dependent and not value dependent
3008                 like an array.  Also it can check for out of range conditions.
3009         */
3010
3011         if (tms)
3012         {
3013                 switch (cur_state)
3014                 {
3015                 case TAP_RESET:
3016                         new_state = cur_state;
3017                         break;
3018                 case TAP_IDLE:
3019                 case TAP_DRUPDATE:
3020                 case TAP_IRUPDATE:
3021                         new_state = TAP_DRSELECT;
3022                         break;
3023                 case TAP_DRSELECT:
3024                         new_state = TAP_IRSELECT;
3025                         break;
3026                 case TAP_DRCAPTURE:
3027                 case TAP_DRSHIFT:
3028                         new_state = TAP_DREXIT1;
3029                         break;
3030                 case TAP_DREXIT1:
3031                 case TAP_DREXIT2:
3032                         new_state = TAP_DRUPDATE;
3033                         break;
3034                 case TAP_DRPAUSE:
3035                         new_state = TAP_DREXIT2;
3036                         break;
3037                 case TAP_IRSELECT:
3038                         new_state = TAP_RESET;
3039                         break;
3040                 case TAP_IRCAPTURE:
3041                 case TAP_IRSHIFT:
3042                         new_state = TAP_IREXIT1;
3043                         break;
3044                 case TAP_IREXIT1:
3045                 case TAP_IREXIT2:
3046                         new_state = TAP_IRUPDATE;
3047                         break;
3048                 case TAP_IRPAUSE:
3049                         new_state = TAP_IREXIT2;
3050                         break;
3051                 default:
3052                         LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3053                         exit(1);
3054                         break;
3055                 }
3056         }
3057         else
3058         {
3059                 switch (cur_state)
3060                 {
3061                 case TAP_RESET:
3062                 case TAP_IDLE:
3063                 case TAP_DRUPDATE:
3064                 case TAP_IRUPDATE:
3065                         new_state = TAP_IDLE;
3066                         break;
3067                 case TAP_DRSELECT:
3068                         new_state = TAP_DRCAPTURE;
3069                         break;
3070                 case TAP_DRCAPTURE:
3071                 case TAP_DRSHIFT:
3072                 case TAP_DREXIT2:
3073                         new_state = TAP_DRSHIFT;
3074                         break;
3075                 case TAP_DREXIT1:
3076                 case TAP_DRPAUSE:
3077                         new_state = TAP_DRPAUSE;
3078                         break;
3079                 case TAP_IRSELECT:
3080                         new_state = TAP_IRCAPTURE;
3081                         break;
3082                 case TAP_IRCAPTURE:
3083                 case TAP_IRSHIFT:
3084                 case TAP_IREXIT2:
3085                         new_state = TAP_IRSHIFT;
3086                         break;
3087                 case TAP_IREXIT1:
3088                 case TAP_IRPAUSE:
3089                         new_state = TAP_IRPAUSE;
3090                         break;
3091                 default:
3092                         LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3093                         exit(1);
3094                         break;
3095                 }
3096         }
3097
3098         return new_state;
3099 }
3100
3101 const char* tap_state_name(tap_state_t state)
3102 {
3103         const char* ret;
3104
3105         switch( state )
3106         {
3107         case TAP_RESET:         ret = "RESET";                  break;
3108         case TAP_IDLE:          ret = "RUN/IDLE";               break;
3109         case TAP_DRSELECT:      ret = "DRSELECT";               break;
3110         case TAP_DRCAPTURE: ret = "DRCAPTURE";          break;
3111         case TAP_DRSHIFT:       ret = "DRSHIFT";                        break;
3112         case TAP_DREXIT1:       ret = "DREXIT1";                        break;
3113         case TAP_DRPAUSE:       ret = "DRPAUSE";                        break;
3114         case TAP_DREXIT2:       ret = "DREXIT2";                        break;
3115         case TAP_DRUPDATE:      ret = "DRUPDATE";               break;
3116         case TAP_IRSELECT:      ret = "IRSELECT";               break;
3117         case TAP_IRCAPTURE: ret = "IRCAPTURE";          break;
3118         case TAP_IRSHIFT:       ret = "IRSHIFT";                        break;
3119         case TAP_IREXIT1:       ret = "IREXIT1";                        break;
3120         case TAP_IRPAUSE:       ret = "IRPAUSE";                        break;
3121         case TAP_IREXIT2:       ret = "IREXIT2";                        break;
3122         case TAP_IRUPDATE:      ret = "IRUPDATE";               break;
3123         default:                                ret = "???";
3124         }
3125
3126         return ret;
3127 }
3128
3129 static tap_state_t tap_state_by_name( const char *name )
3130 {
3131         tap_state_t x;
3132
3133         for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3134                 /* be nice to the human */
3135                 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3136                         return x;
3137                 }
3138         }
3139         /* not found */
3140         return TAP_INVALID;
3141 }
3142
3143 #ifdef _DEBUG_JTAG_IO_
3144
3145 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3146                 do { buf[len] = bit ? '1' : '0'; } while(0)
3147 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3148                 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3149                         tap_state_name(a), tap_state_name(b), astr, bstr)
3150
3151 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3152                 unsigned tap_bits, tap_state_t next_state)
3153 {
3154         const u8 *tms_buffer;
3155         const u8 *tdi_buffer;
3156         unsigned tap_bytes;
3157         unsigned cur_byte;
3158         unsigned cur_bit;
3159
3160         unsigned tap_out_bits;
3161         char tms_str[33];
3162         char tdi_str[33];
3163
3164         tap_state_t last_state;
3165
3166         // set startstate (and possibly last, if tap_bits == 0)
3167         last_state = next_state;
3168         DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3169
3170         tms_buffer = (const u8 *)tms_buf;
3171         tdi_buffer = (const u8 *)tdi_buf;
3172
3173         tap_bytes = TAP_SCAN_BYTES(tap_bits);
3174         DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3175
3176         tap_out_bits = 0;
3177         for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3178         {
3179                 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3180                 {
3181                         // make sure we do not run off the end of the buffers
3182                         unsigned tap_bit = cur_byte * 8 + cur_bit;
3183                         if (tap_bit == tap_bits)
3184                                 break;
3185
3186                         // check and save TMS bit
3187                         tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3188                         JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3189
3190                         // use TMS bit to find the next TAP state
3191                         next_state = tap_state_transition(last_state, tap_bit);
3192
3193                         // check and store TDI bit
3194                         tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3195                         JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3196
3197                         // increment TAP bits
3198                         tap_out_bits++;
3199
3200                         // Only show TDO bits on state transitions, or
3201                         // after some number of bits in the same state.
3202                         if ((next_state == last_state) && (tap_out_bits < 32))
3203                                 continue;
3204
3205                         // terminate strings and display state transition
3206                         tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3207                         JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3208
3209                         // reset state
3210                         last_state = next_state;
3211                         tap_out_bits = 0;
3212                 }
3213         }
3214
3215         if (tap_out_bits)
3216         {
3217                 // terminate strings and display state transition
3218                 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3219                 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3220         }
3221
3222         DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3223
3224         return next_state;
3225 }
3226 #endif // _DEBUG_JTAG_IO_
3227
3228 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3229 {
3230         if (argc == 1)
3231         {
3232                 if (strcmp(args[0], "short") == 0)
3233                 {
3234                         tms_seqs=&short_tms_seqs;
3235                 }
3236                 else if (strcmp(args[0], "long") == 0)
3237                 {
3238                         tms_seqs=&old_tms_seqs;
3239                 } else
3240                 {
3241                         return ERROR_COMMAND_SYNTAX_ERROR;
3242                 }
3243         } else if (argc != 0)
3244         {
3245                 return ERROR_COMMAND_SYNTAX_ERROR;
3246         }
3247
3248         command_print(cmd_ctx, "tms sequence is  %s", (tms_seqs==&short_tms_seqs) ? "short": "long");
3249
3250         return ERROR_OK;
3251 }
3252
3253 /*-----</Cable Helper API>--------------------------------------*/
3254
3255
3256 /**
3257  * Function jtag_add_statemove
3258  * moves from the current state to the goal \a state. This needs
3259  * to be handled according to the xsvf spec, see the XSTATE command
3260  * description.
3261  */
3262 int jtag_add_statemove(tap_state_t goal_state)
3263 {
3264         int retval = ERROR_OK;
3265
3266         tap_state_t moves[8];
3267         tap_state_t cur_state = cmd_queue_cur_state;
3268         int i;
3269         int tms_bits;
3270         int     tms_count;
3271
3272         LOG_DEBUG( "cur_state=%s goal_state=%s",
3273                 tap_state_name(cur_state),
3274                 tap_state_name(goal_state) );
3275
3276
3277         /*      From the XSVF spec, pertaining to XSTATE:
3278
3279                 For special states known as stable states (Test-Logic-Reset,
3280                 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
3281                 predefined TAP state paths when the starting state is a stable state and
3282                 when the XSTATE specifies a new stable state (see the STATE command in
3283                 the [Ref 5] for the TAP state paths between stable states). For
3284                 non-stable states, XSTATE should specify a state that is only one TAP
3285                 state transition distance from the current TAP state to avoid undefined
3286                 TAP state paths. A sequence of multiple XSTATE commands can be issued to
3287                 transition the TAP through a specific state path.
3288         */
3289
3290         if (goal_state==cur_state )
3291                 ;       /* nothing to do */
3292
3293         else if( goal_state==TAP_RESET )
3294         {
3295                 jtag_add_tlr();
3296         }
3297
3298         else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
3299         {
3300                 /*      note: unless tms_bits holds a path that agrees with [Ref 5] in above
3301                         spec, then this code is not fully conformant to the xsvf spec.  This
3302                         puts a burden on tap_get_tms_path() function from the xsvf spec.
3303                         If in doubt, you should confirm that that burden is being met.
3304                 */
3305
3306                 tms_bits  = tap_get_tms_path(cur_state, goal_state);
3307                 tms_count = tap_get_tms_path_len(cur_state, goal_state);
3308
3309                 assert( (unsigned) tms_count < DIM(moves) );
3310
3311                 for (i=0;   i<tms_count;   i++, tms_bits>>=1)
3312                 {
3313                         bool bit = tms_bits & 1;
3314
3315                         cur_state = tap_state_transition(cur_state, bit);
3316                         moves[i] = cur_state;
3317                 }
3318
3319                 jtag_add_pathmove(tms_count, moves);
3320         }
3321
3322         /*      else state must be immediately reachable in one clock cycle, and does not
3323                 need to be a stable state.
3324         */
3325         else if( tap_state_transition(cur_state, true)  == goal_state
3326                 ||   tap_state_transition(cur_state, false) == goal_state )
3327         {
3328                 /* move a single state */
3329                 moves[0] = goal_state;
3330                 jtag_add_pathmove( 1, moves );
3331         }
3332
3333         else
3334         {
3335                 retval = ERROR_FAIL;
3336         }
3337
3338         return retval;
3339 }
3340