git.sur5r.net Git - openocd/blob - src/jtag/jtag.c

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