git.gag.com Git - fw/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 = 0;
 589         int new_trst = 0;
 590
 591         /* Without SRST, we must use target-specific JTAG operations
 592          * on each target; callers should not be requesting SRST when
 593          * that signal doesn't exist.
 594          *
 595          * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
 596          * can kick in even if the JTAG adapter can't drive TRST.
 597          */
 598         if (req_srst) {
 599                 if (!(jtag_reset_config & RESET_HAS_SRST)) {
 600                         LOG_ERROR("BUG: can't assert SRST");
 601                         jtag_set_error(ERROR_FAIL);
 602                         return;
 603                 }
 604                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
 605                                 && !req_tlr_or_trst) {
 606                         LOG_ERROR("BUG: can't assert only SRST");
 607                         jtag_set_error(ERROR_FAIL);
 608                         return;
 609                 }
 610                 new_srst = 1;
 611         }
 612
 613         /* JTAG reset (entry to TAP_RESET state) can always be achieved
 614          * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
 615          * state first.  TRST accelerates it, and bypasses those states.
 616          *
 617          * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
 618          * can kick in even if the JTAG adapter can't drive SRST.
 619          */
 620         if (req_tlr_or_trst) {
 621                 if (!(jtag_reset_config & RESET_HAS_TRST))
 622                         trst_with_tlr = 1;
 623                 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
 624                                 && !req_srst)
 625                         trst_with_tlr = 1;
 626                 else
 627                         new_trst = 1;
 628         }
 629
 630         /* Maybe change TRST and/or SRST signal state */
 631         if (jtag_srst != new_srst || jtag_trst != new_trst) {
 632                 int retval;
 633
 634                 retval = interface_jtag_add_reset(new_trst, new_srst);
 635                 if (retval != ERROR_OK)
 636                         jtag_set_error(retval);
 637                 else
 638                         retval = jtag_execute_queue();
 639
 640                 if (retval != ERROR_OK) {
 641                         LOG_ERROR("TRST/SRST error %d", retval);
 642                         return;
 643                 }
 644         }
 645
 646         /* SRST resets everything hooked up to that signal */
 647         if (jtag_srst != new_srst) {
 648                 jtag_srst = new_srst;
 649                 if (jtag_srst)
 650                         LOG_DEBUG("SRST line asserted");
 651                 else {
 652                         LOG_DEBUG("SRST line released");
 653                         if (jtag_nsrst_delay)
 654                                 jtag_add_sleep(jtag_nsrst_delay * 1000);
 655                 }
 656         }
 657
 658         /* Maybe enter the JTAG TAP_RESET state ...
 659          *  - using only TMS, TCK, and the JTAG state machine
 660          *  - or else more directly, using TRST
 661          *
 662          * TAP_RESET should be invisible to non-debug parts of the system.
 663          */
 664         if (trst_with_tlr) {
 665                 LOG_DEBUG("JTAG reset with TLR instead of TRST");
 666                 jtag_set_end_state(TAP_RESET);
 667                 jtag_add_tlr();
 668
 669         } else if (jtag_trst != new_trst) {
 670                 jtag_trst = new_trst;
 671                 if (jtag_trst) {
 672                         /* we just asserted nTRST, so we're now in TAP_RESET;
 673                          * inform possible listeners about this
 674                          *
 675                          * REVISIT asserting TRST is less significant than
 676                          * being in TAP_RESET ... both entries (TRST, TLR)
 677                          * should trigger a callback.
 678                          */
 679                         LOG_DEBUG("TRST line asserted");
 680                         tap_set_state(TAP_RESET);
 681                         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
 682                 } else {
 683                         LOG_DEBUG("TRST line released");
 684                         if (jtag_ntrst_delay)
 685                                 jtag_add_sleep(jtag_ntrst_delay * 1000);
 686                 }
 687         }
 688 }
 689
 690 tap_state_t jtag_set_end_state(tap_state_t state)
 691 {
 692         if ((state == TAP_DRSHIFT)||(state == TAP_IRSHIFT))
 693         {
 694                 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
 695         }
 696
 697         if (state != TAP_INVALID)
 698                 cmd_queue_end_state = state;
 699         return cmd_queue_end_state;
 700 }
 701
 702 tap_state_t jtag_get_end_state(void)
 703 {
 704         return cmd_queue_end_state;
 705 }
 706
 707 void jtag_add_sleep(uint32_t us)
 708 {
 709         /// @todo Here, keep_alive() appears to be a layering violation!!!
 710         keep_alive();
 711         jtag_set_error(interface_jtag_add_sleep(us));
 712 }
 713
 714 int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value, uint8_t *in_check_mask, int num_bits)
 715 {
 716         int retval = ERROR_OK;
 717
 718         int compare_failed = 0;
 719
 720         if (in_check_mask)
 721                 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
 722         else
 723                 compare_failed = buf_cmp(captured, in_check_value, num_bits);
 724
 725         if (compare_failed) {
 726                 /* An error handler could have caught the failing check
 727                  * only report a problem when there wasn't a handler, or if the handler
 728                  * acknowledged the error
 729                  */
 730                 /*
 731                 LOG_WARNING("TAP %s:",
 732                                         jtag_tap_name(field->tap));
 733                                         */
 734                 if (compare_failed)
 735                 {
 736                         char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 737                         char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 738
 739                         if (in_check_mask)
 740                         {
 741                                 char *in_check_mask_char;
 742                                 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
 743                                 LOG_WARNING("value captured during scan didn't pass the requested check:");
 744                                 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
 745                                                         captured_char, in_check_value_char, in_check_mask_char);
 746                                 free(in_check_mask_char);
 747                         }
 748                         else
 749                         {
 750                                 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);
 751                         }
 752
 753                         free(captured_char);
 754                         free(in_check_value_char);
 755
 756                         retval = ERROR_JTAG_QUEUE_FAILED;
 757                 }
 758
 759         }
 760         return retval;
 761 }
 762
 763 void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask)
 764 {
 765         assert(field->in_value != NULL);
 766
 767         if (value == NULL)
 768         {
 769                 /* no checking to do */
 770                 return;
 771         }
 772
 773         jtag_execute_queue_noclear();
 774
 775         int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
 776         jtag_set_error(retval);
 777 }
 778
 779
 780
 781 int default_interface_jtag_execute_queue(void)
 782 {
 783         if (NULL == jtag)
 784         {
 785                 LOG_ERROR("No JTAG interface configured yet.  "
 786                         "Issue 'init' command in startup scripts "
 787                         "before communicating with targets.");
 788                 return ERROR_FAIL;
 789         }
 790
 791         return jtag->execute_queue();
 792 }
 793
 794 void jtag_execute_queue_noclear(void)
 795 {
 796         jtag_flush_queue_count++;
 797         jtag_set_error(interface_jtag_execute_queue());
 798 }
 799
 800 int jtag_get_flush_queue_count(void)
 801 {
 802         return jtag_flush_queue_count;
 803 }
 804
 805 int jtag_execute_queue(void)
 806 {
 807         jtag_execute_queue_noclear();
 808         return jtag_error_clear();
 809 }
 810
 811 static int jtag_reset_callback(enum jtag_event event, void *priv)
 812 {
 813         jtag_tap_t *tap = priv;
 814
 815         LOG_DEBUG("-");
 816
 817         if (event == JTAG_TRST_ASSERTED)
 818         {
 819                 tap->enabled = !tap->disabled_after_reset;
 820
 821                 /* current instruction is either BYPASS or IDCODE */
 822                 buf_set_ones(tap->cur_instr, tap->ir_length);
 823                 tap->bypass = 1;
 824         }
 825
 826         return ERROR_OK;
 827 }
 828
 829 void jtag_sleep(uint32_t us)
 830 {
 831         alive_sleep(us/1000);
 832 }
 833
 834 /// maximum number of JTAG devices expected in the chain
 835 #define JTAG_MAX_CHAIN_SIZE 20
 836
 837 #define EXTRACT_MFG(X)  (((X) & 0xffe) >> 1)
 838 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
 839 #define EXTRACT_VER(X)  (((X) & 0xf0000000) >> 28)
 840
 841 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
 842 {
 843         scan_field_t field = {
 844                         .tap = NULL,
 845                         .num_bits = num_idcode * 32,
 846                         .out_value = idcode_buffer,
 847                         .in_value = idcode_buffer,
 848                 };
 849
 850         // initialize to the end of chain ID value
 851         for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
 852                 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
 853
 854         jtag_add_plain_dr_scan(1, &field, TAP_RESET);
 855         return jtag_execute_queue();
 856 }
 857
 858 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
 859 {
 860         uint8_t zero_check = 0x0;
 861         uint8_t one_check = 0xff;
 862
 863         for (unsigned i = 0; i < count * 4; i++)
 864         {
 865                 zero_check |= idcodes[i];
 866                 one_check &= idcodes[i];
 867         }
 868
 869         /* if there wasn't a single non-zero bit or if all bits were one,
 870          * the scan is not valid */
 871         if (zero_check == 0x00 || one_check == 0xff)
 872         {
 873                 LOG_ERROR("JTAG communication failure: check connection, "
 874                         "JTAG interface, target power etc.");
 875                 return false;
 876         }
 877         return true;
 878 }
 879
 880 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
 881                 const char *name, uint32_t idcode)
 882 {
 883         log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
 884                                   "JTAG tap: %s %16.16s: 0x%08x "
 885                                   "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
 886                                   name, msg,
 887                                   (unsigned int)idcode,
 888                                   (unsigned int)EXTRACT_MFG(idcode),
 889                                   (unsigned int)EXTRACT_PART(idcode),
 890                                   (unsigned int)EXTRACT_VER(idcode));
 891 }
 892
 893 static bool jtag_idcode_is_final(uint32_t idcode)
 894 {
 895                 return idcode == 0x000000FF || idcode == 0xFFFFFFFF;
 896 }
 897
 898 /**
 899  * This helper checks that remaining bits in the examined chain data are
 900  * all as expected, but a single JTAG device requires only 64 bits to be
 901  * read back correctly.  This can help identify and diagnose problems
 902  * with the JTAG chain earlier, gives more helpful/explicit error messages.
 903  */
 904 static void jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
 905 {
 906         bool triggered = false;
 907         for (; count < max - 31; count += 32)
 908         {
 909                 uint32_t idcode = buf_get_u32(idcodes, count, 32);
 910                 // do not trigger the warning if the data looks good
 911                 if (!triggered && jtag_idcode_is_final(idcode))
 912                         continue;
 913                 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
 914                                         count, (unsigned int)idcode);
 915                 triggered = true;
 916         }
 917 }
 918
 919 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s *tap)
 920 {
 921         if (0 == tap->expected_ids_cnt)
 922         {
 923                 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
 924 #if 0
 925                 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap->idcode)
 926                 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
 927 #endif
 928                 return true;
 929         }
 930
 931         /* Loop over the expected identification codes and test for a match */
 932         uint8_t ii;
 933         for (ii = 0; ii < tap->expected_ids_cnt; ii++)
 934         {
 935                 if (tap->idcode == tap->expected_ids[ii])
 936                         break;
 937         }
 938
 939         /* If none of the expected ids matched, log an error */
 940         if (ii != tap->expected_ids_cnt)
 941         {
 942                 LOG_INFO("JTAG Tap/device matched");
 943                 return true;
 944         }
 945         jtag_examine_chain_display(LOG_LVL_ERROR, "got",
 946                         tap->dotted_name, tap->idcode);
 947         for (ii = 0; ii < tap->expected_ids_cnt; ii++)
 948         {
 949                 char msg[32];
 950                 snprintf(msg, sizeof(msg), "expected %hhu of %hhu",
 951                                 ii + 1, tap->expected_ids_cnt);
 952                 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
 953                                 tap->dotted_name, tap->expected_ids[ii]);
 954         }
 955         return false;
 956 }
 957
 958 /* Try to examine chain layout according to IEEE 1149.1 §12
 959  */
 960 int jtag_examine_chain(void)
 961 {
 962         uint8_t idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
 963         unsigned device_count = 0;
 964
 965         jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
 966
 967         if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
 968                 return ERROR_JTAG_INIT_FAILED;
 969
 970         /* point at the 1st tap */
 971         jtag_tap_t *tap = jtag_tap_next_enabled(NULL);
 972         if (tap == NULL)
 973         {
 974                 LOG_ERROR("JTAG: No taps enabled?");
 975                 return ERROR_JTAG_INIT_FAILED;
 976         }
 977
 978         for (unsigned bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
 979         {
 980                 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
 981                 if ((idcode & 1) == 0)
 982                 {
 983                         /* LSB must not be 0, this indicates a device in bypass */
 984                         LOG_WARNING("Tap/Device does not have IDCODE");
 985                         idcode = 0;
 986
 987                         bit_count += 1;
 988                 }
 989                 else
 990                 {
 991                         /*
 992                          * End of chain (invalid manufacturer ID) some devices, such
 993                          * as AVR will output all 1's instead of TDI input value at
 994                          * end of chain.
 995                          */
 996                         if (jtag_idcode_is_final(idcode))
 997                         {
 998                                 jtag_examine_chain_end(idcode_buffer,
 999                                                 bit_count + 32, JTAG_MAX_CHAIN_SIZE * 32);
1000                                 break;
1001                         }
1002
1003                         jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found",
1004                                         tap ? tap->dotted_name : "(not-named)",
1005                                         idcode);
1006
1007                         bit_count += 32;
1008                 }
1009                 device_count++;
1010                 if (!tap)
1011                         continue;
1012
1013                 tap->idcode = idcode;
1014
1015                 // ensure the TAP ID does matches what was expected
1016                 if (!jtag_examine_chain_match_tap(tap))
1017                         return ERROR_JTAG_INIT_FAILED;
1018
1019                 tap = jtag_tap_next_enabled(tap);
1020         }
1021
1022         /* see if number of discovered devices matches configuration */
1023         if (device_count != jtag_tap_count_enabled())
1024         {
1025                 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1026                                 "does not match (enabled) configuration (%i), total taps: %d",
1027                                 device_count, jtag_tap_count_enabled(), jtag_tap_count());
1028                 LOG_ERROR("check the config file and ensure proper JTAG communication"
1029                                 " (connections, speed, ...)");
1030                 return ERROR_JTAG_INIT_FAILED;
1031         }
1032
1033         return ERROR_OK;
1034 }
1035
1036 int jtag_validate_chain(void)
1037 {
1038         jtag_tap_t *tap;
1039         int total_ir_length = 0;
1040         uint8_t *ir_test = NULL;
1041         scan_field_t field;
1042         int chain_pos = 0;
1043
1044         tap = NULL;
1045         total_ir_length = 0;
1046         for (;;) {
1047                 tap = jtag_tap_next_enabled(tap);
1048                 if (tap == NULL) {
1049                         break;
1050                 }
1051                 total_ir_length += tap->ir_length;
1052         }
1053
1054         total_ir_length += 2;
1055         ir_test = malloc(CEIL(total_ir_length, 8));
1056         buf_set_ones(ir_test, total_ir_length);
1057
1058         field.tap = NULL;
1059         field.num_bits = total_ir_length;
1060         field.out_value = ir_test;
1061         field.in_value = ir_test;
1062
1063
1064         jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1065         jtag_execute_queue();
1066
1067         tap = NULL;
1068         chain_pos = 0;
1069         int val;
1070         for (;;) {
1071                 tap = jtag_tap_next_enabled(tap);
1072                 if (tap == NULL) {
1073                         break;
1074                 }
1075
1076                 val = buf_get_u32(ir_test, chain_pos, 2);
1077                 if (val != 0x1)
1078                 {
1079                         char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1080                         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);
1081                         free(cbuf);
1082                         free(ir_test);
1083                         return ERROR_JTAG_INIT_FAILED;
1084                 }
1085                 chain_pos += tap->ir_length;
1086         }
1087
1088         val = buf_get_u32(ir_test, chain_pos, 2);
1089         if (val != 0x3)
1090         {
1091                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1092                 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);
1093                 free(cbuf);
1094                 free(ir_test);
1095                 return ERROR_JTAG_INIT_FAILED;
1096         }
1097
1098         free(ir_test);
1099
1100         return ERROR_OK;
1101 }
1102
1103
1104 void jtag_tap_init(jtag_tap_t *tap)
1105 {
1106         assert(0 != tap->ir_length);
1107
1108         tap->expected = malloc(tap->ir_length);
1109         tap->expected_mask = malloc(tap->ir_length);
1110         tap->cur_instr = malloc(tap->ir_length);
1111
1112         /// @todo cope sanely with ir_length bigger than 32 bits
1113         buf_set_u32(tap->expected, 0, tap->ir_length, tap->ir_capture_value);
1114         buf_set_u32(tap->expected_mask, 0, tap->ir_length, tap->ir_capture_mask);
1115         buf_set_ones(tap->cur_instr, tap->ir_length);
1116
1117         // place TAP in bypass mode
1118         tap->bypass = 1;
1119         // register the reset callback for the TAP
1120         jtag_register_event_callback(&jtag_reset_callback, tap);
1121
1122         LOG_DEBUG("Created Tap: %s @ abs position %d, "
1123                         "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1124                                 tap->abs_chain_position, tap->ir_length,
1125                           (unsigned int)(tap->ir_capture_value), (unsigned int)(tap->ir_capture_mask));
1126         jtag_tap_add(tap);
1127 }
1128
1129 void jtag_tap_free(jtag_tap_t *tap)
1130 {
1131         jtag_unregister_event_callback(&jtag_reset_callback, tap);
1132
1133         /// @todo is anything missing? no memory leaks please
1134         free((void *)tap->expected_ids);
1135         free((void *)tap->chip);
1136         free((void *)tap->tapname);
1137         free((void *)tap->dotted_name);
1138         free(tap);
1139 }
1140
1141 int jtag_interface_init(struct command_context_s *cmd_ctx)
1142 {
1143         if (jtag)
1144                 return ERROR_OK;
1145
1146         if (!jtag_interface)
1147         {
1148                 /* nothing was previously specified by "interface" command */
1149                 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1150                 return ERROR_JTAG_INVALID_INTERFACE;
1151         }
1152
1153         jtag = jtag_interface;
1154         if (jtag_interface->init() != ERROR_OK)
1155         {
1156                 jtag = NULL;
1157                 return ERROR_JTAG_INIT_FAILED;
1158         }
1159
1160         int requested_khz = jtag_get_speed_khz();
1161         int actual_khz = requested_khz;
1162         int retval = jtag_get_speed_readable(&actual_khz);
1163         if (ERROR_OK != retval)
1164                 LOG_INFO("interface specific clock speed value %d", jtag_get_speed());
1165         else if (actual_khz)
1166         {
1167                 if ((CLOCK_MODE_RCLK == clock_mode)
1168                         || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
1169                 {
1170                         LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1171                                 , actual_khz);
1172                 }
1173                 else
1174                         LOG_INFO("clock speed %d kHz", actual_khz);
1175         }
1176         else
1177                 LOG_INFO("RCLK (adaptive clock speed)");
1178
1179         return ERROR_OK;
1180 }
1181
1182 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1183 {
1184         jtag_tap_t *tap;
1185         int retval;
1186
1187         LOG_DEBUG("Init JTAG chain");
1188
1189         tap = jtag_tap_next_enabled(NULL);
1190         if (tap == NULL) {
1191                 LOG_ERROR("There are no enabled taps?");
1192                 return ERROR_JTAG_INIT_FAILED;
1193         }
1194
1195         jtag_add_tlr();
1196         if ((retval = jtag_execute_queue()) != ERROR_OK)
1197                 return retval;
1198
1199         /* examine chain first, as this could discover the real chain layout */
1200         if (jtag_examine_chain() != ERROR_OK)
1201         {
1202                 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1203         }
1204
1205         if (jtag_validate_chain() != ERROR_OK)
1206         {
1207                 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1208         }
1209
1210         return ERROR_OK;
1211 }
1212
1213 int jtag_interface_quit(void)
1214 {
1215         if (!jtag || !jtag->quit)
1216                 return ERROR_OK;
1217
1218         // close the JTAG interface
1219         int result = jtag->quit();
1220         if (ERROR_OK != result)
1221                 LOG_ERROR("failed: %d", result);
1222
1223         return ERROR_OK;
1224 }
1225
1226
1227 int jtag_init_reset(struct command_context_s *cmd_ctx)
1228 {
1229         int retval;
1230
1231         if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
1232                 return retval;
1233
1234         LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1235
1236         /* Reset can happen after a power cycle.
1237          *
1238          * Ideally we would only assert TRST or run TLR before the target reset.
1239          *
1240          * However w/srst_pulls_trst, trst is asserted together with the target
1241          * reset whether we want it or not.
1242          *
1243          * NB! Some targets have JTAG circuitry disabled until a
1244          * trst & srst has been asserted.
1245          *
1246          * NB! here we assume nsrst/ntrst delay are sufficient!
1247          *
1248          * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1249          *
1250          */
1251         jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1252         if (jtag_reset_config & RESET_HAS_SRST)
1253         {
1254                 jtag_add_reset(1, 1);
1255                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1256                         jtag_add_reset(0, 1);
1257         }
1258         jtag_add_reset(0, 0);
1259         if ((retval = jtag_execute_queue()) != ERROR_OK)
1260                 return retval;
1261
1262         /* Check that we can communication on the JTAG chain + eventually we want to
1263          * be able to perform enumeration only after OpenOCD has started
1264          * telnet and GDB server
1265          *
1266          * That would allow users to more easily perform any magic they need to before
1267          * reset happens.
1268          */
1269         return jtag_init_inner(cmd_ctx);
1270 }
1271
1272 int jtag_init(struct command_context_s *cmd_ctx)
1273 {
1274         int retval;
1275         if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
1276                 return retval;
1277         if (jtag_init_inner(cmd_ctx) == ERROR_OK)
1278         {
1279                 return ERROR_OK;
1280         }
1281         return jtag_init_reset(cmd_ctx);
1282 }
1283
1284 unsigned jtag_get_speed_khz(void)
1285 {
1286         return speed_khz;
1287 }
1288
1289 static int jtag_khz_to_speed(unsigned khz, int* speed)
1290 {
1291         LOG_DEBUG("convert khz to interface specific speed value");
1292         speed_khz = khz;
1293         if (jtag != NULL)
1294         {
1295                 LOG_DEBUG("have interface set up");
1296                 int speed_div1;
1297                 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1298                 if (ERROR_OK != retval)
1299                 {
1300                         return retval;
1301                 }
1302                 *speed = speed_div1;
1303         }
1304         return ERROR_OK;
1305 }
1306
1307 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int* speed)
1308 {
1309         int retval = jtag_khz_to_speed(0, speed);
1310         if ((ERROR_OK != retval) && fallback_speed_khz)
1311         {
1312                 LOG_DEBUG("trying fallback speed...");
1313                 retval = jtag_khz_to_speed(fallback_speed_khz, speed);
1314         }
1315         return retval;
1316 }
1317
1318 static int jtag_set_speed(int speed)
1319 {
1320         jtag_speed = speed;
1321         /* this command can be called during CONFIG,
1322          * in which case jtag isn't initialized */
1323         return jtag ? jtag->speed(speed) : ERROR_OK;
1324 }
1325
1326 int jtag_config_speed(int speed)
1327 {
1328         LOG_DEBUG("handle jtag speed");
1329         clock_mode = CLOCK_MODE_SPEED;
1330         return jtag_set_speed(speed);
1331 }
1332
1333 int jtag_config_khz(unsigned khz)
1334 {
1335         LOG_DEBUG("handle jtag khz");
1336         clock_mode = CLOCK_MODE_KHZ;
1337         int speed = 0;
1338         int retval = jtag_khz_to_speed(khz, &speed);
1339         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1340 }
1341
1342 int jtag_config_rclk(unsigned fallback_speed_khz)
1343 {
1344         LOG_DEBUG("handle jtag rclk");
1345         clock_mode = CLOCK_MODE_RCLK;
1346         rclk_fallback_speed_khz = fallback_speed_khz;
1347         int speed = 0;
1348         int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1349         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1350 }
1351
1352 int jtag_get_speed(void)
1353 {
1354         int speed;
1355         switch(clock_mode)
1356         {
1357                 case CLOCK_MODE_SPEED:
1358                         speed = jtag_speed;
1359                         break;
1360                 case CLOCK_MODE_KHZ:
1361                         jtag_khz_to_speed(jtag_get_speed_khz(), &speed);
1362                         break;
1363                 case CLOCK_MODE_RCLK:
1364                         jtag_rclk_to_speed(rclk_fallback_speed_khz, &speed);
1365                         break;
1366                 default:
1367                         LOG_ERROR("BUG: unknown jtag clock mode");
1368                         speed = 0;
1369                         break;
1370         }
1371         return speed;
1372 }
1373
1374 int jtag_get_speed_readable(int *khz)
1375 {
1376         return jtag ? jtag->speed_div(jtag_get_speed(), khz) : ERROR_OK;
1377 }
1378
1379 void jtag_set_verify(bool enable)
1380 {
1381         jtag_verify = enable;
1382 }
1383
1384 bool jtag_will_verify()
1385 {
1386         return jtag_verify;
1387 }
1388
1389 void jtag_set_verify_capture_ir(bool enable)
1390 {
1391         jtag_verify_capture_ir = enable;
1392 }
1393
1394 bool jtag_will_verify_capture_ir()
1395 {
1396         return jtag_verify_capture_ir;
1397 }
1398
1399 int jtag_power_dropout(int *dropout)
1400 {
1401         return jtag->power_dropout(dropout);
1402 }
1403
1404 int jtag_srst_asserted(int *srst_asserted)
1405 {
1406         return jtag->srst_asserted(srst_asserted);
1407 }
1408
1409 enum reset_types jtag_get_reset_config(void)
1410 {
1411         return jtag_reset_config;
1412 }
1413 void jtag_set_reset_config(enum reset_types type)
1414 {
1415         jtag_reset_config = type;
1416 }
1417
1418 int jtag_get_trst(void)
1419 {
1420         return jtag_trst;
1421 }
1422 int jtag_get_srst(void)
1423 {
1424         return jtag_srst;
1425 }
1426
1427 void jtag_set_nsrst_delay(unsigned delay)
1428 {
1429         jtag_nsrst_delay = delay;
1430 }
1431 unsigned jtag_get_nsrst_delay(void)
1432 {
1433         return jtag_nsrst_delay;
1434 }
1435 void jtag_set_ntrst_delay(unsigned delay)
1436 {
1437         jtag_ntrst_delay = delay;
1438 }
1439 unsigned jtag_get_ntrst_delay(void)
1440 {
1441         return jtag_ntrst_delay;
1442 }