git.sur5r.net Git - openocd/blob - src/jtag/core.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  *   Copyright (C) 2009 Zachary T Welch                                    *
  13  *   zw@superlucidity.net                                                  *
  14  *                                                                         *
  15  *   This program is free software; you can redistribute it and/or modify  *
  16  *   it under the terms of the GNU General Public License as published by  *
  17  *   the Free Software Foundation; either version 2 of the License, or     *
  18  *   (at your option) any later version.                                   *
  19  *                                                                         *
  20  *   This program is distributed in the hope that it will be useful,       *
  21  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  22  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  23  *   GNU General Public License for more details.                          *
  24  *                                                                         *
  25  *   You should have received a copy of the GNU General Public License     *
  26  *   along with this program; if not, write to the                         *
  27  *   Free Software Foundation, Inc.,                                       *
  28  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  29  ***************************************************************************/
  30 #ifdef HAVE_CONFIG_H
  31 #include "config.h"
  32 #endif
  33
  34 #include "jtag.h"
  35 #include "minidriver.h"
  36 #include "interface.h"
  37
  38 #ifdef HAVE_STRINGS_H
  39 #include <strings.h>
  40 #endif
  41
  42
  43 /// The number of JTAG queue flushes (for profiling and debugging purposes).
  44 static int jtag_flush_queue_count;
  45
  46 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
  47                 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
  48
  49 /**
  50  * The jtag_error variable is set when an error occurs while executing
  51  * the queue.  Application code may set this using jtag_set_error(),
  52  * when an error occurs during processing that should be reported during
  53  * jtag_execute_queue().
  54  *
  55  * Tts value may be checked with jtag_get_error() and cleared with
  56  * jtag_error_clear().  This value is returned (and cleared) by
  57  * jtag_execute_queue().
  58  */
  59 static int jtag_error = ERROR_OK;
  60
  61 static const char *jtag_event_strings[] =
  62 {
  63         [JTAG_TRST_ASSERTED] = "JTAG controller reset (TLR or TRST)",
  64         [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
  65         [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
  66 };
  67
  68 /*
  69  * JTAG adapters must initialize with TRST and SRST de-asserted
  70  * (they're negative logic, so that means *high*)
  71  */
  72 static int jtag_trst = 0;
  73 static int jtag_srst = 0;
  74
  75 /**
  76  * List all TAPs that have been created.
  77  */
  78 static jtag_tap_t *__jtag_all_taps = NULL;
  79 /**
  80  * The number of TAPs in the __jtag_all_taps list, used to track the
  81  * assigned chain position to new TAPs
  82  */
  83 static unsigned jtag_num_taps = 0;
  84
  85 static enum reset_types jtag_reset_config = RESET_NONE;
  86 static tap_state_t cmd_queue_end_state = TAP_RESET;
  87 tap_state_t cmd_queue_cur_state = TAP_RESET;
  88
  89 static bool jtag_verify_capture_ir = true;
  90 static int jtag_verify = 1;
  91
  92 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
  93 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
  94 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
  95
  96 typedef struct jtag_event_callback_s
  97 {
  98         jtag_event_handler_t          callback;
  99         void*                         priv;
 100         struct jtag_event_callback_s* next;
 101 } jtag_event_callback_t;
 102
 103 /* callbacks to inform high-level handlers about JTAG state changes */
 104 static jtag_event_callback_t *jtag_event_callbacks;
 105
 106 /* speed in kHz*/
 107 static int speed_khz = 0;
 108 /* speed to fallback to when RCLK is requested but not supported */
 109 static int rclk_fallback_speed_khz = 0;
 110 static enum {CLOCK_MODE_SPEED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
 111 static int jtag_speed = 0;
 112
 113 static struct jtag_interface_s *jtag = NULL;
 114
 115 /* configuration */
 116 jtag_interface_t *jtag_interface = NULL;
 117
 118 void jtag_set_error(int error)
 119 {
 120         if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
 121                 return;
 122         jtag_error = error;
 123 }
 124 int jtag_get_error(void)
 125 {
 126         return jtag_error;
 127 }
 128 int jtag_error_clear(void)
 129 {
 130         int temp = jtag_error;
 131         jtag_error = ERROR_OK;
 132         return temp;
 133 }
 134
 135
 136 jtag_tap_t *jtag_all_taps(void)
 137 {
 138         return __jtag_all_taps;
 139 };
 140
 141 unsigned jtag_tap_count(void)
 142 {
 143         return jtag_num_taps;
 144 }
 145
 146 unsigned jtag_tap_count_enabled(void)
 147 {
 148         jtag_tap_t *t = jtag_all_taps();
 149         unsigned n = 0;
 150         while (t)
 151         {
 152                 if (t->enabled)
 153                         n++;
 154                 t = t->next_tap;
 155         }
 156         return n;
 157 }
 158
 159 /// Append a new TAP to the chain of all taps.
 160 void jtag_tap_add(struct jtag_tap_s *t)
 161 {
 162         t->abs_chain_position = jtag_num_taps++;
 163
 164         jtag_tap_t **tap = &__jtag_all_taps;
 165         while (*tap != NULL)
 166                 tap = &(*tap)->next_tap;
 167         *tap = t;
 168 }
 169
 170 /* returns a pointer to the n-th device in the scan chain */
 171 static inline jtag_tap_t *jtag_tap_by_position(unsigned n)
 172 {
 173         jtag_tap_t *t = jtag_all_taps();
 174
 175         while (t && n-- > 0)
 176                 t = t->next_tap;
 177
 178         return t;
 179 }
 180
 181 jtag_tap_t *jtag_tap_by_string(const char *s)
 182 {
 183         /* try by name first */
 184         jtag_tap_t *t = jtag_all_taps();
 185
 186         while (t)
 187         {
 188                 if (0 == strcmp(t->dotted_name, s))
 189                         return t;
 190                 t = t->next_tap;
 191         }
 192
 193         /* no tap found by name, so try to parse the name as a number */
 194         unsigned n;
 195         if (parse_uint(s, &n) != ERROR_OK)
 196                 return NULL;
 197
 198         /* FIXME remove this numeric fallback code late June 2010, along
 199          * with all info in the User's Guide that TAPs have numeric IDs.
 200          * Also update "scan_chain" output to not display the numbers.
 201          */
 202         t = jtag_tap_by_position(n);
 203         if (t)
 204                 LOG_WARNING("Specify TAP '%s' by name, not number %u",
 205                         t->dotted_name, n);
 206
 207         return t;
 208 }
 209
 210 jtag_tap_t *jtag_tap_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
 211 {
 212         const char *cp = Jim_GetString(o, NULL);
 213         jtag_tap_t *t = cp ? jtag_tap_by_string(cp) : NULL;
 214         if (NULL == cp)
 215                 cp = "(unknown)";
 216         if (NULL == t)
 217                 Jim_SetResult_sprintf(interp, "Tap '%s' could not be found", cp);
 218         return t;
 219 }
 220
 221 jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p)
 222 {
 223         p = p ? p->next_tap : jtag_all_taps();
 224         while (p)
 225         {
 226                 if (p->enabled)
 227                         return p;
 228                 p = p->next_tap;
 229         }
 230         return NULL;
 231 }
 232
 233 const char *jtag_tap_name(const jtag_tap_t *tap)
 234 {
 235         return (tap == NULL) ? "(unknown)" : tap->dotted_name;
 236 }
 237
 238
 239 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
 240 {
 241         jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
 242
 243         if (callback == NULL)
 244         {
 245                 return ERROR_INVALID_ARGUMENTS;
 246         }
 247
 248         if (*callbacks_p)
 249         {
 250                 while ((*callbacks_p)->next)
 251                         callbacks_p = &((*callbacks_p)->next);
 252                 callbacks_p = &((*callbacks_p)->next);
 253         }
 254
 255         (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
 256         (*callbacks_p)->callback = callback;
 257         (*callbacks_p)->priv = priv;
 258         (*callbacks_p)->next = NULL;
 259
 260         return ERROR_OK;
 261 }
 262
 263 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
 264 {
 265         jtag_event_callback_t **callbacks_p;
 266         jtag_event_callback_t **next;
 267
 268         if (callback == NULL)
 269         {
 270                 return ERROR_INVALID_ARGUMENTS;
 271         }
 272
 273         for (callbacks_p = &jtag_event_callbacks;
 274                         *callbacks_p != NULL;
 275                         callbacks_p = next)
 276         {
 277                 next = &((*callbacks_p)->next);
 278
 279                 if ((*callbacks_p)->priv != priv)
 280                         continue;
 281
 282                 if ((*callbacks_p)->callback == callback)
 283                 {
 284                         free(*callbacks_p);
 285                         *callbacks_p = *next;
 286                 }
 287         }
 288
 289         return ERROR_OK;
 290 }
 291
 292 int jtag_call_event_callbacks(enum jtag_event event)
 293 {
 294         jtag_event_callback_t *callback = jtag_event_callbacks;
 295
 296         LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
 297
 298         while (callback)
 299         {
 300                 jtag_event_callback_t *next;
 301
 302                 /* callback may remove itself */
 303                 next = callback->next;
 304                 callback->callback(event, callback->priv);
 305                 callback = next;
 306         }
 307
 308         return ERROR_OK;
 309 }
 310
 311 static void jtag_checks(void)
 312 {
 313         assert(jtag_trst == 0);
 314 }
 315
 316 static void jtag_prelude(tap_state_t state)
 317 {
 318         jtag_checks();
 319
 320         assert(state != TAP_INVALID);
 321
 322         cmd_queue_cur_state = state;
 323 }
 324
 325 void jtag_alloc_in_value32(scan_field_t *field)
 326 {
 327         interface_jtag_alloc_in_value32(field);
 328 }
 329
 330 void jtag_add_ir_scan_noverify(int in_count, const scan_field_t *in_fields,
 331                 tap_state_t state)
 332 {
 333         jtag_prelude(state);
 334
 335         int retval = interface_jtag_add_ir_scan(in_count, in_fields, state);
 336         jtag_set_error(retval);
 337 }
 338
 339
 340 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 341 {
 342         if (jtag_verify && jtag_verify_capture_ir)
 343         {
 344                 /* 8 x 32 bit id's is enough for all invocations */
 345
 346                 for (int j = 0; j < in_num_fields; j++)
 347                 {
 348                         /* if we are to run a verification of the ir scan, we need to get the input back.
 349                          * We may have to allocate space if the caller didn't ask for the input back.
 350                          */
 351                         in_fields[j].check_value = in_fields[j].tap->expected;
 352                         in_fields[j].check_mask = in_fields[j].tap->expected_mask;
 353                 }
 354                 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
 355         } else
 356         {
 357                 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
 358         }
 359 }
 360
 361 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields,
 362                 tap_state_t state)
 363 {
 364         jtag_prelude(state);
 365
 366         int retval = interface_jtag_add_plain_ir_scan(
 367                         in_num_fields, in_fields, state);
 368         jtag_set_error(retval);
 369 }
 370
 371 void jtag_add_callback(jtag_callback1_t f, jtag_callback_data_t data0)
 372 {
 373         interface_jtag_add_callback(f, data0);
 374 }
 375
 376 void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
 377                 jtag_callback_data_t data1, jtag_callback_data_t data2,
 378                 jtag_callback_data_t data3)
 379 {
 380         interface_jtag_add_callback4(f, data0, data1, data2, data3);
 381 }
 382
 383 int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value, uint8_t *in_check_mask, int num_bits);
 384
 385 static int jtag_check_value_mask_callback(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
 386 {
 387         return jtag_check_value_inner((uint8_t *)data0, (uint8_t *)data1, (uint8_t *)data2, (int)data3);
 388 }
 389
 390 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
 391                 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 392 {
 393         for (int i = 0; i < in_num_fields; i++)
 394         {
 395                 struct scan_field_s *field = &in_fields[i];
 396                 field->allocated = 0;
 397                 field->modified = 0;
 398                 if (field->check_value || field->in_value)
 399                         continue;
 400                 interface_jtag_add_scan_check_alloc(field);
 401                 field->modified = 1;
 402         }
 403
 404         jtag_add_scan(in_num_fields, in_fields, state);
 405
 406         for (int i = 0; i < in_num_fields; i++)
 407         {
 408                 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
 409                 {
 410                         /* this is synchronous for a minidriver */
 411                         jtag_add_callback4(jtag_check_value_mask_callback, (jtag_callback_data_t)in_fields[i].in_value,
 412                                 (jtag_callback_data_t)in_fields[i].check_value,
 413                                 (jtag_callback_data_t)in_fields[i].check_mask,
 414                                 (jtag_callback_data_t)in_fields[i].num_bits);
 415                 }
 416                 if (in_fields[i].allocated)
 417                 {
 418                         free(in_fields[i].in_value);
 419                 }
 420                 if (in_fields[i].modified)
 421                 {
 422                         in_fields[i].in_value = NULL;
 423                 }
 424         }
 425 }
 426
 427 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
 428 {
 429         if (jtag_verify)
 430         {
 431                 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
 432         } else
 433         {
 434                 jtag_add_dr_scan(in_num_fields, in_fields, state);
 435         }
 436 }
 437
 438
 439 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields,
 440                 tap_state_t state)
 441 {
 442         jtag_prelude(state);
 443
 444         int retval;
 445         retval = interface_jtag_add_dr_scan(in_num_fields, in_fields, state);
 446         jtag_set_error(retval);
 447 }
 448
 449 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields,
 450                 tap_state_t state)
 451 {
 452         jtag_prelude(state);
 453
 454         int retval;
 455         retval = interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, state);
 456         jtag_set_error(retval);
 457 }
 458
 459 void jtag_add_dr_out(jtag_tap_t* tap,
 460                 int num_fields, const int* num_bits, const uint32_t* value,
 461                 tap_state_t end_state)
 462 {
 463         assert(end_state != TAP_INVALID);
 464
 465         cmd_queue_cur_state = end_state;
 466
 467         interface_jtag_add_dr_out(tap,
 468                         num_fields, num_bits, value,
 469                         end_state);
 470 }
 471
 472 void jtag_add_tlr(void)
 473 {
 474         jtag_prelude(TAP_RESET);
 475         jtag_set_error(interface_jtag_add_tlr());
 476         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 477 }
 478
 479 void jtag_add_pathmove(int num_states, const tap_state_t *path)
 480 {
 481         tap_state_t cur_state = cmd_queue_cur_state;
 482
 483         /* the last state has to be a stable state */
 484         if (!tap_is_state_stable(path[num_states - 1]))
 485         {
 486                 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
 487                 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
 488                 return;
 489         }
 490
 491         for (int i = 0; i < num_states; i++)
 492         {
 493                 if (path[i] == TAP_RESET)
 494                 {
 495                         LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
 496                         jtag_set_error(ERROR_JTAG_STATE_INVALID);
 497                         return;
 498                 }
 499
 500                 if (tap_state_transition(cur_state, true)  != path[i]
 501                   && tap_state_transition(cur_state, false) != path[i])
 502                 {
 503                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
 504                                         tap_state_name(cur_state), tap_state_name(path[i]));
 505                         jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
 506                         return;
 507                 }
 508                 cur_state = path[i];
 509         }
 510
 511         jtag_checks();
 512
 513         jtag_set_error(interface_jtag_add_pathmove(num_states, path));
 514         cmd_queue_cur_state = path[num_states - 1];
 515 }
 516
 517 int jtag_add_statemove(tap_state_t goal_state)
 518 {
 519         tap_state_t cur_state = cmd_queue_cur_state;
 520
 521         LOG_DEBUG("cur_state=%s goal_state=%s",
 522                 tap_state_name(cur_state),
 523                 tap_state_name(goal_state));
 524
 525
 526         if (goal_state == cur_state)
 527                 ;       /* nothing to do */
 528         else if (goal_state == TAP_RESET)
 529         {
 530                 jtag_add_tlr();
 531         }
 532         else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state))
 533         {
 534                 unsigned tms_bits  = tap_get_tms_path(cur_state, goal_state);
 535                 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
 536                 tap_state_t moves[8];
 537                 assert(tms_count < DIM(moves));
 538
 539                 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1)
 540                 {
 541                         bool bit = tms_bits & 1;
 542
 543                         cur_state = tap_state_transition(cur_state, bit);
 544                         moves[i] = cur_state;
 545                 }
 546
 547                 jtag_add_pathmove(tms_count, moves);
 548         }
 549         else if (tap_state_transition(cur_state, true)  == goal_state
 550                 ||   tap_state_transition(cur_state, false) == goal_state)
 551         {
 552                 jtag_add_pathmove(1, &goal_state);
 553         }
 554
 555         else
 556                 return ERROR_FAIL;
 557
 558         return ERROR_OK;
 559 }
 560
 561 void jtag_add_runtest(int num_cycles, tap_state_t state)
 562 {
 563         jtag_prelude(state);
 564         jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
 565 }
 566
 567
 568 void jtag_add_clocks(int num_cycles)
 569 {
 570         if (!tap_is_state_stable(cmd_queue_cur_state))
 571         {
 572                  LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
 573                                  tap_state_name(cmd_queue_cur_state));
 574                  jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
 575                  return;
 576         }
 577
 578         if (num_cycles > 0)
 579         {
 580                 jtag_checks();
 581                 jtag_set_error(interface_jtag_add_clocks(num_cycles));
 582         }
 583 }
 584
 585 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
 586 {
 587         int trst_with_tlr = 0;
 588         int new_srst;
 589         int new_trst = 0;
 590
 591         /* FIX!!! there are *many* different cases here. A better
 592          * approach is needed for legal combinations of transitions...
 593          */
 594         if ((jtag_reset_config & RESET_HAS_SRST)&&
 595                         (jtag_reset_config & RESET_HAS_TRST)&&
 596                         ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0))
 597         {
 598                 if (((req_tlr_or_trst&&!jtag_trst)||
 599                                 (!req_tlr_or_trst && jtag_trst))&&
 600                                 ((req_srst&&!jtag_srst)||
 601                                                 (!req_srst && jtag_srst)))
 602                 {
 603                         /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
 604                         //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
 605                 }
 606         }
 607
 608         /* Make sure that jtag_reset_config allows the requested reset */
 609         /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
 610         if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
 611         {
 612                 LOG_ERROR("BUG: requested reset would assert trst");
 613                 jtag_set_error(ERROR_FAIL);
 614                 return;
 615         }
 616
 617         /* if TRST pulls SRST, we reset with TAP T-L-R */
 618         if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
 619         {
 620                 trst_with_tlr = 1;
 621         }
 622
 623         if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
 624         {
 625                 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
 626                 jtag_set_error(ERROR_FAIL);
 627                 return;
 628         }
 629
 630         if (req_tlr_or_trst)
 631         {
 632                 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
 633                 {
 634                         new_trst = 1;
 635                 } else
 636                 {
 637                         trst_with_tlr = 1;
 638                 }
 639         }
 640
 641         new_srst = req_srst;
 642
 643         /* Maybe change TRST and/or SRST signal state */
 644         if (jtag_srst != new_srst || jtag_trst != new_trst) {
 645                 int retval;
 646
 647                 retval = interface_jtag_add_reset(new_trst, new_srst);
 648                 if (retval != ERROR_OK)
 649                         jtag_set_error(retval);
 650                 else
 651                         retval = jtag_execute_queue();
 652
 653                 if (retval != ERROR_OK) {
 654                         LOG_ERROR("TRST/SRST error %d", retval);
 655                         return;
 656                 }
 657         }
 658
 659         /* SRST resets everything hooked up to that signal */
 660         if (jtag_srst != new_srst) {
 661                 jtag_srst = new_srst;
 662                 if (jtag_srst)
 663                         LOG_DEBUG("SRST line asserted");
 664                 else {
 665                         LOG_DEBUG("SRST line released");
 666                         if (jtag_nsrst_delay)
 667                                 jtag_add_sleep(jtag_nsrst_delay * 1000);
 668                 }
 669         }
 670
 671         /* Maybe enter the JTAG TAP_RESET state ...
 672          *  - using only TMS, TCK, and the JTAG state machine
 673          *  - or else more directly, using TRST
 674          *
 675          * TAP_RESET should be invisible to non-debug parts of the system.
 676          */
 677         if (trst_with_tlr) {
 678                 LOG_DEBUG("JTAG reset with TLR instead of TRST");
 679                 jtag_set_end_state(TAP_RESET);
 680                 jtag_add_tlr();
 681
 682         } else if (jtag_trst != new_trst) {
 683                 jtag_trst = new_trst;
 684                 if (jtag_trst) {
 685                         /* we just asserted nTRST, so we're now in TAP_RESET;
 686                          * inform possible listeners about this
 687                          *
 688                          * REVISIT asserting TRST is less significant than
 689                          * being in TAP_RESET ... both entries (TRST, TLR)
 690                          * should trigger a callback.
 691                          */
 692                         LOG_DEBUG("TRST line asserted");
 693                         tap_set_state(TAP_RESET);
 694                         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 695                 } else {
 696                         LOG_DEBUG("TRST line released");
 697                         if (jtag_ntrst_delay)
 698                                 jtag_add_sleep(jtag_ntrst_delay * 1000);
 699                 }
 700         }
 701 }
 702
 703 tap_state_t jtag_set_end_state(tap_state_t state)
 704 {
 705         if ((state == TAP_DRSHIFT)||(state == TAP_IRSHIFT))
 706         {
 707                 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
 708         }
 709
 710         if (state != TAP_INVALID)
 711                 cmd_queue_end_state = state;
 712         return cmd_queue_end_state;
 713 }
 714
 715 tap_state_t jtag_get_end_state(void)
 716 {
 717         return cmd_queue_end_state;
 718 }
 719
 720 void jtag_add_sleep(uint32_t us)
 721 {
 722         /// @todo Here, keep_alive() appears to be a layering violation!!!
 723         keep_alive();
 724         jtag_set_error(interface_jtag_add_sleep(us));
 725 }
 726
 727 int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value, uint8_t *in_check_mask, int num_bits)
 728 {
 729         int retval = ERROR_OK;
 730
 731         int compare_failed = 0;
 732
 733         if (in_check_mask)
 734                 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
 735         else
 736                 compare_failed = buf_cmp(captured, in_check_value, num_bits);
 737
 738         if (compare_failed) {
 739                 /* An error handler could have caught the failing check
 740                  * only report a problem when there wasn't a handler, or if the handler
 741                  * acknowledged the error
 742                  */
 743                 /*
 744                 LOG_WARNING("TAP %s:",
 745                                         jtag_tap_name(field->tap));
 746                                         */
 747                 if (compare_failed)
 748                 {
 749                         char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 750                         char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 751
 752                         if (in_check_mask)
 753                         {
 754                                 char *in_check_mask_char;
 755                                 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 756                                 LOG_WARNING("value captured during scan didn't pass the requested check:");
 757                                 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
 758                                                         captured_char, in_check_value_char, in_check_mask_char);
 759                                 free(in_check_mask_char);
 760                         }
 761                         else
 762                         {
 763                                 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);
 764                         }
 765
 766                         free(captured_char);
 767                         free(in_check_value_char);
 768
 769                         retval = ERROR_JTAG_QUEUE_FAILED;
 770                 }
 771
 772         }
 773         return retval;
 774 }
 775
 776 void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask)
 777 {
 778         assert(field->in_value != NULL);
 779
 780         if (value == NULL)
 781         {
 782                 /* no checking to do */
 783                 return;
 784         }
 785
 786         jtag_execute_queue_noclear();
 787
 788         int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
 789         jtag_set_error(retval);
 790 }
 791
 792
 793
 794 int default_interface_jtag_execute_queue(void)
 795 {
 796         if (NULL == jtag)
 797         {
 798                 LOG_ERROR("No JTAG interface configured yet.  "
 799                         "Issue 'init' command in startup scripts "
 800                         "before communicating with targets.");
 801                 return ERROR_FAIL;
 802         }
 803
 804         return jtag->execute_queue();
 805 }
 806
 807 void jtag_execute_queue_noclear(void)
 808 {
 809         jtag_flush_queue_count++;
 810         jtag_set_error(interface_jtag_execute_queue());
 811 }
 812
 813 int jtag_get_flush_queue_count(void)
 814 {
 815         return jtag_flush_queue_count;
 816 }
 817
 818 int jtag_execute_queue(void)
 819 {
 820         jtag_execute_queue_noclear();
 821         return jtag_error_clear();
 822 }
 823
 824 static int jtag_reset_callback(enum jtag_event event, void *priv)
 825 {
 826         jtag_tap_t *tap = priv;
 827
 828         LOG_DEBUG("-");
 829
 830         if (event == JTAG_TRST_ASSERTED)
 831         {
 832                 tap->enabled = !tap->disabled_after_reset;
 833
 834                 buf_set_ones(tap->cur_instr, tap->ir_length);
 835                 tap->bypass = 1;
 836         }
 837
 838         return ERROR_OK;
 839 }
 840
 841 void jtag_sleep(uint32_t us)
 842 {
 843         alive_sleep(us/1000);
 844 }
 845
 846 /// maximum number of JTAG devices expected in the chain
 847 #define JTAG_MAX_CHAIN_SIZE 20
 848
 849 #define EXTRACT_MFG(X)  (((X) & 0xffe) >> 1)
 850 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
 851 #define EXTRACT_VER(X)  (((X) & 0xf0000000) >> 28)
 852
 853 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
 854 {
 855         scan_field_t field = {
 856                         .tap = NULL,
 857                         .num_bits = num_idcode * 32,
 858                         .out_value = idcode_buffer,
 859                         .in_value = idcode_buffer,
 860                 };
 861
 862         // initialize to the end of chain ID value
 863         for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
 864                 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
 865
 866         jtag_add_plain_dr_scan(1, &field, TAP_RESET);
 867         return jtag_execute_queue();
 868 }
 869
 870 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
 871 {
 872         uint8_t zero_check = 0x0;
 873         uint8_t one_check = 0xff;
 874
 875         for (unsigned i = 0; i < count * 4; i++)
 876         {
 877                 zero_check |= idcodes[i];
 878                 one_check &= idcodes[i];
 879         }
 880
 881         /* if there wasn't a single non-zero bit or if all bits were one,
 882          * the scan is not valid */
 883         if (zero_check == 0x00 || one_check == 0xff)
 884         {
 885                 LOG_ERROR("JTAG communication failure: check connection, "
 886                         "JTAG interface, target power etc.");
 887                 return false;
 888         }
 889         return true;
 890 }
 891
 892 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
 893                 const char *name, uint32_t idcode)
 894 {
 895         log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
 896                                   "JTAG tap: %s %16.16s: 0x%08x "
 897                                   "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
 898                                   name, msg,
 899                                   (unsigned int)idcode,
 900                                   (unsigned int)EXTRACT_MFG(idcode),
 901                                   (unsigned int)EXTRACT_PART(idcode),
 902                                   (unsigned int)EXTRACT_VER(idcode));
 903 }
 904
 905 static bool jtag_idcode_is_final(uint32_t idcode)
 906 {
 907                 return idcode == 0x000000FF || idcode == 0xFFFFFFFF;
 908 }
 909
 910 /**
 911  * This helper checks that remaining bits in the examined chain data are
 912  * all as expected, but a single JTAG device requires only 64 bits to be
 913  * read back correctly.  This can help identify and diagnose problems
 914  * with the JTAG chain earlier, gives more helpful/explicit error messages.
 915  */
 916 static void jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
 917 {
 918         bool triggered = false;
 919         for (; count < max - 31; count += 32)
 920         {
 921                 uint32_t idcode = buf_get_u32(idcodes, count, 32);
 922                 // do not trigger the warning if the data looks good
 923                 if (!triggered && jtag_idcode_is_final(idcode))
 924                         continue;
 925                 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
 926                                         count, (unsigned int)idcode);
 927                 triggered = true;
 928         }
 929 }
 930
 931 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s *tap)
 932 {
 933         if (0 == tap->expected_ids_cnt)
 934         {
 935                 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
 936 #if 0
 937                 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap->idcode)
 938                 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
 939 #endif
 940                 return true;
 941         }
 942
 943         /* Loop over the expected identification codes and test for a match */
 944         uint8_t ii;
 945         for (ii = 0; ii < tap->expected_ids_cnt; ii++)
 946         {
 947                 if (tap->idcode == tap->expected_ids[ii])
 948                         break;
 949         }
 950
 951         /* If none of the expected ids matched, log an error */
 952         if (ii != tap->expected_ids_cnt)
 953         {
 954                 LOG_INFO("JTAG Tap/device matched");
 955                 return true;
 956         }
 957         jtag_examine_chain_display(LOG_LVL_ERROR, "got",
 958                         tap->dotted_name, tap->idcode);
 959         for (ii = 0; ii < tap->expected_ids_cnt; ii++)
 960         {
 961                 char msg[32];
 962                 snprintf(msg, sizeof(msg), "expected %hhu of %hhu",
 963                                 ii + 1, tap->expected_ids_cnt);
 964                 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
 965                                 tap->dotted_name, tap->expected_ids[ii]);
 966         }
 967         return false;
 968 }
 969
 970 /* Try to examine chain layout according to IEEE 1149.1 §12
 971  */
 972 int jtag_examine_chain(void)
 973 {
 974         uint8_t idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
 975         unsigned device_count = 0;
 976
 977         jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
 978
 979         if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
 980                 return ERROR_JTAG_INIT_FAILED;
 981
 982         /* point at the 1st tap */
 983         jtag_tap_t *tap = jtag_tap_next_enabled(NULL);
 984         if (tap == NULL)
 985         {
 986                 LOG_ERROR("JTAG: No taps enabled?");
 987                 return ERROR_JTAG_INIT_FAILED;
 988         }
 989
 990         for (unsigned bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
 991         {
 992                 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
 993                 if ((idcode & 1) == 0)
 994                 {
 995                         /* LSB must not be 0, this indicates a device in bypass */
 996                         LOG_WARNING("Tap/Device does not have IDCODE");
 997                         idcode = 0;
 998
 999                         bit_count += 1;
1000                 }
1001                 else
1002                 {
1003                         /*
1004                          * End of chain (invalid manufacturer ID) some devices, such
1005                          * as AVR will output all 1's instead of TDI input value at
1006                          * end of chain.
1007                          */
1008                         if (jtag_idcode_is_final(idcode))
1009                         {
1010                                 jtag_examine_chain_end(idcode_buffer,
1011                                                 bit_count + 32, JTAG_MAX_CHAIN_SIZE * 32);
1012                                 break;
1013                         }
1014
1015                         jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found",
1016                                         tap ? tap->dotted_name : "(not-named)",
1017                                         idcode);
1018
1019                         bit_count += 32;
1020                 }
1021                 device_count++;
1022                 if (!tap)
1023                         continue;
1024
1025                 tap->idcode = idcode;
1026
1027                 // ensure the TAP ID does matches what was expected
1028                 if (!jtag_examine_chain_match_tap(tap))
1029                         return ERROR_JTAG_INIT_FAILED;
1030
1031                 tap = jtag_tap_next_enabled(tap);
1032         }
1033
1034         /* see if number of discovered devices matches configuration */
1035         if (device_count != jtag_tap_count_enabled())
1036         {
1037                 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1038                                 "does not match (enabled) configuration (%i), total taps: %d",
1039                                 device_count, jtag_tap_count_enabled(), jtag_tap_count());
1040                 LOG_ERROR("check the config file and ensure proper JTAG communication"
1041                                 " (connections, speed, ...)");
1042                 return ERROR_JTAG_INIT_FAILED;
1043         }
1044
1045         return ERROR_OK;
1046 }
1047
1048 int jtag_validate_chain(void)
1049 {
1050         jtag_tap_t *tap;
1051         int total_ir_length = 0;
1052         uint8_t *ir_test = NULL;
1053         scan_field_t field;
1054         int chain_pos = 0;
1055
1056         tap = NULL;
1057         total_ir_length = 0;
1058         for (;;) {
1059                 tap = jtag_tap_next_enabled(tap);
1060                 if (tap == NULL) {
1061                         break;
1062                 }
1063                 total_ir_length += tap->ir_length;
1064         }
1065
1066         total_ir_length += 2;
1067         ir_test = malloc(CEIL(total_ir_length, 8));
1068         buf_set_ones(ir_test, total_ir_length);
1069
1070         field.tap = NULL;
1071         field.num_bits = total_ir_length;
1072         field.out_value = ir_test;
1073         field.in_value = ir_test;
1074
1075
1076         jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1077         jtag_execute_queue();
1078
1079         tap = NULL;
1080         chain_pos = 0;
1081         int val;
1082         for (;;) {
1083                 tap = jtag_tap_next_enabled(tap);
1084                 if (tap == NULL) {
1085                         break;
1086                 }
1087
1088                 val = buf_get_u32(ir_test, chain_pos, 2);
1089                 if (val != 0x1)
1090                 {
1091                         char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1092                         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);
1093                         free(cbuf);
1094                         free(ir_test);
1095                         return ERROR_JTAG_INIT_FAILED;
1096                 }
1097                 chain_pos += tap->ir_length;
1098         }
1099
1100         val = buf_get_u32(ir_test, chain_pos, 2);
1101         if (val != 0x3)
1102         {
1103                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1104                 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);
1105                 free(cbuf);
1106                 free(ir_test);
1107                 return ERROR_JTAG_INIT_FAILED;
1108         }
1109
1110         free(ir_test);
1111
1112         return ERROR_OK;
1113 }
1114
1115
1116 void jtag_tap_init(jtag_tap_t *tap)
1117 {
1118         assert(0 != tap->ir_length);
1119
1120         tap->expected = malloc(tap->ir_length);
1121         tap->expected_mask = malloc(tap->ir_length);
1122         tap->cur_instr = malloc(tap->ir_length);
1123
1124         /// @todo cope sanely with ir_length bigger than 32 bits
1125         buf_set_u32(tap->expected, 0, tap->ir_length, tap->ir_capture_value);
1126         buf_set_u32(tap->expected_mask, 0, tap->ir_length, tap->ir_capture_mask);
1127         buf_set_ones(tap->cur_instr, tap->ir_length);
1128
1129         // place TAP in bypass mode
1130         tap->bypass = 1;
1131         // register the reset callback for the TAP
1132         jtag_register_event_callback(&jtag_reset_callback, tap);
1133
1134         LOG_DEBUG("Created Tap: %s @ abs position %d, "
1135                         "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1136                                 tap->abs_chain_position, tap->ir_length,
1137                           (unsigned int)(tap->ir_capture_value), (unsigned int)(tap->ir_capture_mask));
1138         jtag_tap_add(tap);
1139 }
1140
1141 void jtag_tap_free(jtag_tap_t *tap)
1142 {
1143         jtag_unregister_event_callback(&jtag_reset_callback, tap);
1144
1145         /// @todo is anything missing? no memory leaks please
1146         free((void *)tap->expected_ids);
1147         free((void *)tap->chip);
1148         free((void *)tap->tapname);
1149         free((void *)tap->dotted_name);
1150         free(tap);
1151 }
1152
1153 int jtag_interface_init(struct command_context_s *cmd_ctx)
1154 {
1155         if (jtag)
1156                 return ERROR_OK;
1157
1158         if (!jtag_interface)
1159         {
1160                 /* nothing was previously specified by "interface" command */
1161                 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1162                 return ERROR_JTAG_INVALID_INTERFACE;
1163         }
1164
1165         jtag = jtag_interface;
1166         if (jtag_interface->init() != ERROR_OK)
1167         {
1168                 jtag = NULL;
1169                 return ERROR_JTAG_INIT_FAILED;
1170         }
1171
1172         int requested_khz = jtag_get_speed_khz();
1173         int actual_khz = requested_khz;
1174         int retval = jtag_get_speed_readable(&actual_khz);
1175         if (ERROR_OK != retval)
1176                 LOG_INFO("interface specific clock speed value %d", jtag_get_speed());
1177         else if (actual_khz)
1178         {
1179                 if ((CLOCK_MODE_RCLK == clock_mode)
1180                         || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
1181                 {
1182                         LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1183                                 , actual_khz);
1184                 }
1185                 else
1186                         LOG_INFO("clock speed %d kHz", actual_khz);
1187         }
1188         else
1189                 LOG_INFO("RCLK (adaptive clock speed)");
1190
1191         return ERROR_OK;
1192 }
1193
1194 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1195 {
1196         jtag_tap_t *tap;
1197         int retval;
1198
1199         LOG_DEBUG("Init JTAG chain");
1200
1201         tap = jtag_tap_next_enabled(NULL);
1202         if (tap == NULL) {
1203                 LOG_ERROR("There are no enabled taps?");
1204                 return ERROR_JTAG_INIT_FAILED;
1205         }
1206
1207         jtag_add_tlr();
1208         if ((retval = jtag_execute_queue()) != ERROR_OK)
1209                 return retval;
1210
1211         /* examine chain first, as this could discover the real chain layout */
1212         if (jtag_examine_chain() != ERROR_OK)
1213         {
1214                 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1215         }
1216
1217         if (jtag_validate_chain() != ERROR_OK)
1218         {
1219                 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1220         }
1221
1222         return ERROR_OK;
1223 }
1224
1225 int jtag_interface_quit(void)
1226 {
1227         if (!jtag || !jtag->quit)
1228                 return ERROR_OK;
1229
1230         // close the JTAG interface
1231         int result = jtag->quit();
1232         if (ERROR_OK != result)
1233                 LOG_ERROR("failed: %d", result);
1234
1235         return ERROR_OK;
1236 }
1237
1238
1239 int jtag_init_reset(struct command_context_s *cmd_ctx)
1240 {
1241         int retval;
1242
1243         if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
1244                 return retval;
1245
1246         LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1247
1248         /* Reset can happen after a power cycle.
1249          *
1250          * Ideally we would only assert TRST or run TLR before the target reset.
1251          *
1252          * However w/srst_pulls_trst, trst is asserted together with the target
1253          * reset whether we want it or not.
1254          *
1255          * NB! Some targets have JTAG circuitry disabled until a
1256          * trst & srst has been asserted.
1257          *
1258          * NB! here we assume nsrst/ntrst delay are sufficient!
1259          *
1260          * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1261          *
1262          */
1263         jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1264         if (jtag_reset_config & RESET_HAS_SRST)
1265         {
1266                 jtag_add_reset(1, 1);
1267                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1268                         jtag_add_reset(0, 1);
1269         }
1270         jtag_add_reset(0, 0);
1271         if ((retval = jtag_execute_queue()) != ERROR_OK)
1272                 return retval;
1273
1274         /* Check that we can communication on the JTAG chain + eventually we want to
1275          * be able to perform enumeration only after OpenOCD has started
1276          * telnet and GDB server
1277          *
1278          * That would allow users to more easily perform any magic they need to before
1279          * reset happens.
1280          */
1281         return jtag_init_inner(cmd_ctx);
1282 }
1283
1284 int jtag_init(struct command_context_s *cmd_ctx)
1285 {
1286         int retval;
1287         if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
1288                 return retval;
1289         if (jtag_init_inner(cmd_ctx) == ERROR_OK)
1290         {
1291                 return ERROR_OK;
1292         }
1293         return jtag_init_reset(cmd_ctx);
1294 }
1295
1296 unsigned jtag_get_speed_khz(void)
1297 {
1298         return speed_khz;
1299 }
1300
1301 static int jtag_khz_to_speed(unsigned khz, int* speed)
1302 {
1303         LOG_DEBUG("convert khz to interface specific speed value");
1304         speed_khz = khz;
1305         if (jtag != NULL)
1306         {
1307                 LOG_DEBUG("have interface set up");
1308                 int speed_div1;
1309                 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1310                 if (ERROR_OK != retval)
1311                 {
1312                         return retval;
1313                 }
1314                 *speed = speed_div1;
1315         }
1316         return ERROR_OK;
1317 }
1318
1319 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int* speed)
1320 {
1321         int retval = jtag_khz_to_speed(0, speed);
1322         if ((ERROR_OK != retval) && fallback_speed_khz)
1323         {
1324                 LOG_DEBUG("trying fallback speed...");
1325                 retval = jtag_khz_to_speed(fallback_speed_khz, speed);
1326         }
1327         return retval;
1328 }
1329
1330 static int jtag_set_speed(int speed)
1331 {
1332         jtag_speed = speed;
1333         /* this command can be called during CONFIG,
1334          * in which case jtag isn't initialized */
1335         return jtag ? jtag->speed(speed) : ERROR_OK;
1336 }
1337
1338 int jtag_config_speed(int speed)
1339 {
1340         LOG_DEBUG("handle jtag speed");
1341         clock_mode = CLOCK_MODE_SPEED;
1342         return jtag_set_speed(speed);
1343 }
1344
1345 int jtag_config_khz(unsigned khz)
1346 {
1347         LOG_DEBUG("handle jtag khz");
1348         clock_mode = CLOCK_MODE_KHZ;
1349         int speed = 0;
1350         int retval = jtag_khz_to_speed(khz, &speed);
1351         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1352 }
1353
1354 int jtag_config_rclk(unsigned fallback_speed_khz)
1355 {
1356         LOG_DEBUG("handle jtag rclk");
1357         clock_mode = CLOCK_MODE_RCLK;
1358         rclk_fallback_speed_khz = fallback_speed_khz;
1359         int speed = 0;
1360         int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1361         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1362 }
1363
1364 int jtag_get_speed(void)
1365 {
1366         int speed;
1367         switch(clock_mode)
1368         {
1369                 case CLOCK_MODE_SPEED:
1370                         speed = jtag_speed;
1371                         break;
1372                 case CLOCK_MODE_KHZ:
1373                         jtag_khz_to_speed(jtag_get_speed_khz(), &speed);
1374                         break;
1375                 case CLOCK_MODE_RCLK:
1376                         jtag_rclk_to_speed(rclk_fallback_speed_khz, &speed);
1377                         break;
1378                 default:
1379                         LOG_ERROR("BUG: unknown jtag clock mode");
1380                         speed = 0;
1381                         break;
1382         }
1383         return speed;
1384 }
1385
1386 int jtag_get_speed_readable(int *khz)
1387 {
1388         return jtag ? jtag->speed_div(jtag_get_speed(), khz) : ERROR_OK;
1389 }
1390
1391 void jtag_set_verify(bool enable)
1392 {
1393         jtag_verify = enable;
1394 }
1395
1396 bool jtag_will_verify()
1397 {
1398         return jtag_verify;
1399 }
1400
1401 void jtag_set_verify_capture_ir(bool enable)
1402 {
1403         jtag_verify_capture_ir = enable;
1404 }
1405
1406 bool jtag_will_verify_capture_ir()
1407 {
1408         return jtag_verify_capture_ir;
1409 }
1410
1411 int jtag_power_dropout(int *dropout)
1412 {
1413         return jtag->power_dropout(dropout);
1414 }
1415
1416 int jtag_srst_asserted(int *srst_asserted)
1417 {
1418         return jtag->srst_asserted(srst_asserted);
1419 }
1420
1421 enum reset_types jtag_get_reset_config(void)
1422 {
1423         return jtag_reset_config;
1424 }
1425 void jtag_set_reset_config(enum reset_types type)
1426 {
1427         jtag_reset_config = type;
1428 }
1429
1430 int jtag_get_trst(void)
1431 {
1432         return jtag_trst;
1433 }
1434 int jtag_get_srst(void)
1435 {
1436         return jtag_srst;
1437 }
1438
1439 void jtag_set_nsrst_delay(unsigned delay)
1440 {
1441         jtag_nsrst_delay = delay;
1442 }
1443 unsigned jtag_get_nsrst_delay(void)
1444 {
1445         return jtag_nsrst_delay;
1446 }
1447 void jtag_set_ntrst_delay(unsigned delay)
1448 {
1449         jtag_ntrst_delay = delay;
1450 }
1451 unsigned jtag_get_ntrst_delay(void)
1452 {
1453         return jtag_ntrst_delay;
1454 }