]> git.sur5r.net Git - openocd/blob - src/jtag/core.c
rename jtag_nsrst_delay as adapter_nsrst_delay
[openocd] / src / jtag / core.c
1 /***************************************************************************
2  *   Copyright (C) 2009 Zachary T Welch                                    *
3  *   zw@superlucidity.net                                                  *
4  *                                                                         *
5  *   Copyright (C) 2007,2008,2009 Ã˜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) 2005 by Dominic Rath                                    *
13  *   Dominic.Rath@gmx.de                                                   *
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 "interface.h"
36
37 #ifdef HAVE_STRINGS_H
38 #include <strings.h>
39 #endif
40
41
42 /// The number of JTAG queue flushes (for profiling and debugging purposes).
43 static int jtag_flush_queue_count;
44
45 static void jtag_add_scan_check(struct jtag_tap *active,
46                 void (*jtag_add_scan)(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields, tap_state_t state),
47                 int in_num_fields, struct scan_field *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] = "TAP reset",
64         [JTAG_TAP_EVENT_SETUP] = "TAP setup",
65         [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
66         [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
67 };
68
69 /*
70  * JTAG adapters must initialize with TRST and SRST de-asserted
71  * (they're negative logic, so that means *high*).  But some
72  * hardware doesn't necessarily work that way ... so set things
73  * up so that jtag_init() always forces that state.
74  */
75 static int jtag_trst = -1;
76 static int jtag_srst = -1;
77
78 /**
79  * List all TAPs that have been created.
80  */
81 static struct jtag_tap *__jtag_all_taps = NULL;
82 /**
83  * The number of TAPs in the __jtag_all_taps list, used to track the
84  * assigned chain position to new TAPs
85  */
86 static unsigned jtag_num_taps = 0;
87
88 static enum reset_types jtag_reset_config = RESET_NONE;
89 static tap_state_t cmd_queue_end_state = TAP_RESET;
90 tap_state_t cmd_queue_cur_state = TAP_RESET;
91
92 static bool jtag_verify_capture_ir = true;
93 static int jtag_verify = 1;
94
95 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
96 static int adapter_nsrst_delay = 0; /* default to no nSRST delay */
97 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
98 static int jtag_nsrst_assert_width = 0; /* width of assertion */
99 static int jtag_ntrst_assert_width = 0; /* width of assertion */
100
101 /**
102  * Contains a single callback along with a pointer that will be passed
103  * when an event occurs.
104  */
105 struct jtag_event_callback {
106         /// a event callback
107         jtag_event_handler_t callback;
108         /// the private data to pass to the callback
109         void* priv;
110         /// the next callback
111         struct jtag_event_callback* next;
112 };
113
114 /* callbacks to inform high-level handlers about JTAG state changes */
115 static struct jtag_event_callback *jtag_event_callbacks;
116
117 /* speed in kHz*/
118 static int speed_khz = 0;
119 /* speed to fallback to when RCLK is requested but not supported */
120 static int rclk_fallback_speed_khz = 0;
121 static enum {CLOCK_MODE_SPEED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
122 static int jtag_speed = 0;
123
124 static struct jtag_interface *jtag = NULL;
125
126 /* configuration */
127 struct jtag_interface *jtag_interface = NULL;
128
129 void jtag_set_error(int error)
130 {
131         if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
132                 return;
133         jtag_error = error;
134 }
135 int jtag_get_error(void)
136 {
137         return jtag_error;
138 }
139 int jtag_error_clear(void)
140 {
141         int temp = jtag_error;
142         jtag_error = ERROR_OK;
143         return temp;
144 }
145
146 /************/
147
148 static bool jtag_poll = 1;
149
150 bool is_jtag_poll_safe(void)
151 {
152         /* Polling can be disabled explicitly with set_enabled(false).
153          * It is also implicitly disabled while TRST is active and
154          * while SRST is gating the JTAG clock.
155          */
156         if (!jtag_poll || jtag_trst != 0)
157                 return false;
158         return jtag_srst == 0 || (jtag_reset_config & RESET_SRST_NO_GATING);
159 }
160
161 bool jtag_poll_get_enabled(void)
162 {
163         return jtag_poll;
164 }
165
166 void jtag_poll_set_enabled(bool value)
167 {
168         jtag_poll = value;
169 }
170
171 /************/
172
173 struct jtag_tap *jtag_all_taps(void)
174 {
175         return __jtag_all_taps;
176 };
177
178 unsigned jtag_tap_count(void)
179 {
180         return jtag_num_taps;
181 }
182
183 unsigned jtag_tap_count_enabled(void)
184 {
185         struct jtag_tap *t = jtag_all_taps();
186         unsigned n = 0;
187         while (t)
188         {
189                 if (t->enabled)
190                         n++;
191                 t = t->next_tap;
192         }
193         return n;
194 }
195
196 /// Append a new TAP to the chain of all taps.
197 void jtag_tap_add(struct jtag_tap *t)
198 {
199         t->abs_chain_position = jtag_num_taps++;
200
201         struct jtag_tap **tap = &__jtag_all_taps;
202         while (*tap != NULL)
203                 tap = &(*tap)->next_tap;
204         *tap = t;
205 }
206
207 /* returns a pointer to the n-th device in the scan chain */
208 static inline struct jtag_tap *jtag_tap_by_position(unsigned n)
209 {
210         struct jtag_tap *t = jtag_all_taps();
211
212         while (t && n-- > 0)
213                 t = t->next_tap;
214
215         return t;
216 }
217
218 struct jtag_tap *jtag_tap_by_string(const char *s)
219 {
220         /* try by name first */
221         struct jtag_tap *t = jtag_all_taps();
222
223         while (t)
224         {
225                 if (0 == strcmp(t->dotted_name, s))
226                         return t;
227                 t = t->next_tap;
228         }
229
230         /* no tap found by name, so try to parse the name as a number */
231         unsigned n;
232         if (parse_uint(s, &n) != ERROR_OK)
233                 return NULL;
234
235         /* FIXME remove this numeric fallback code late June 2010, along
236          * with all info in the User's Guide that TAPs have numeric IDs.
237          * Also update "scan_chain" output to not display the numbers.
238          */
239         t = jtag_tap_by_position(n);
240         if (t)
241                 LOG_WARNING("Specify TAP '%s' by name, not number %u",
242                         t->dotted_name, n);
243
244         return t;
245 }
246
247 struct jtag_tap* jtag_tap_next_enabled(struct jtag_tap* p)
248 {
249         p = p ? p->next_tap : jtag_all_taps();
250         while (p)
251         {
252                 if (p->enabled)
253                         return p;
254                 p = p->next_tap;
255         }
256         return NULL;
257 }
258
259 const char *jtag_tap_name(const struct jtag_tap *tap)
260 {
261         return (tap == NULL) ? "(unknown)" : tap->dotted_name;
262 }
263
264
265 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
266 {
267         struct jtag_event_callback **callbacks_p = &jtag_event_callbacks;
268
269         if (callback == NULL)
270         {
271                 return ERROR_INVALID_ARGUMENTS;
272         }
273
274         if (*callbacks_p)
275         {
276                 while ((*callbacks_p)->next)
277                         callbacks_p = &((*callbacks_p)->next);
278                 callbacks_p = &((*callbacks_p)->next);
279         }
280
281         (*callbacks_p) = malloc(sizeof(struct jtag_event_callback));
282         (*callbacks_p)->callback = callback;
283         (*callbacks_p)->priv = priv;
284         (*callbacks_p)->next = NULL;
285
286         return ERROR_OK;
287 }
288
289 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
290 {
291         struct jtag_event_callback **callbacks_p;
292         struct jtag_event_callback **next;
293
294         if (callback == NULL)
295         {
296                 return ERROR_INVALID_ARGUMENTS;
297         }
298
299         for (callbacks_p = &jtag_event_callbacks;
300                         *callbacks_p != NULL;
301                         callbacks_p = next)
302         {
303                 next = &((*callbacks_p)->next);
304
305                 if ((*callbacks_p)->priv != priv)
306                         continue;
307
308                 if ((*callbacks_p)->callback == callback)
309                 {
310                         free(*callbacks_p);
311                         *callbacks_p = *next;
312                 }
313         }
314
315         return ERROR_OK;
316 }
317
318 int jtag_call_event_callbacks(enum jtag_event event)
319 {
320         struct jtag_event_callback *callback = jtag_event_callbacks;
321
322         LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
323
324         while (callback)
325         {
326                 struct jtag_event_callback *next;
327
328                 /* callback may remove itself */
329                 next = callback->next;
330                 callback->callback(event, callback->priv);
331                 callback = next;
332         }
333
334         return ERROR_OK;
335 }
336
337 static void jtag_checks(void)
338 {
339         assert(jtag_trst == 0);
340 }
341
342 static void jtag_prelude(tap_state_t state)
343 {
344         jtag_checks();
345
346         assert(state != TAP_INVALID);
347
348         cmd_queue_cur_state = state;
349 }
350
351 void jtag_alloc_in_value32(struct scan_field *field)
352 {
353         interface_jtag_alloc_in_value32(field);
354 }
355
356 void jtag_add_ir_scan_noverify(struct jtag_tap *active, const struct scan_field *in_fields,
357                 tap_state_t state)
358 {
359         jtag_prelude(state);
360
361         int retval = interface_jtag_add_ir_scan(active, in_fields, state);
362         jtag_set_error(retval);
363 }
364
365 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap *active, int dummy, const struct scan_field *in_fields,
366                 tap_state_t state)
367 {
368         jtag_add_ir_scan_noverify(active, in_fields, state);
369 }
370
371 void jtag_add_ir_scan(struct jtag_tap *active, struct scan_field *in_fields, tap_state_t state)
372 {
373         assert(state != TAP_RESET);
374
375         if (jtag_verify && jtag_verify_capture_ir)
376         {
377                 /* 8 x 32 bit id's is enough for all invocations */
378
379                 /* if we are to run a verification of the ir scan, we need to get the input back.
380                  * We may have to allocate space if the caller didn't ask for the input back.
381                  */
382                 in_fields->check_value = active->expected;
383                 in_fields->check_mask = active->expected_mask;
384                 jtag_add_scan_check(active, jtag_add_ir_scan_noverify_callback, 1, in_fields, state);
385         } else
386         {
387                 jtag_add_ir_scan_noverify(active, in_fields, state);
388         }
389 }
390
391 void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
392                 tap_state_t state)
393 {
394         assert(out_bits != NULL);
395         assert(state != TAP_RESET);
396
397         jtag_prelude(state);
398
399         int retval = interface_jtag_add_plain_ir_scan(
400                         num_bits, out_bits, in_bits, state);
401         jtag_set_error(retval);
402 }
403
404 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
405                 uint8_t *in_check_mask, int num_bits);
406
407 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)
408 {
409         return jtag_check_value_inner((uint8_t *)data0, (uint8_t *)data1, (uint8_t *)data2, (int)data3);
410 }
411
412 static void jtag_add_scan_check(struct jtag_tap *active, void (*jtag_add_scan)(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields, tap_state_t state),
413                 int in_num_fields, struct scan_field *in_fields, tap_state_t state)
414 {
415         for (int i = 0; i < in_num_fields; i++)
416         {
417                 struct scan_field *field = &in_fields[i];
418                 field->allocated = 0;
419                 field->modified = 0;
420                 if (field->check_value || field->in_value)
421                         continue;
422                 interface_jtag_add_scan_check_alloc(field);
423                 field->modified = 1;
424         }
425
426         jtag_add_scan(active, in_num_fields, in_fields, state);
427
428         for (int i = 0; i < in_num_fields; i++)
429         {
430                 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
431                 {
432                         /* this is synchronous for a minidriver */
433                         jtag_add_callback4(jtag_check_value_mask_callback, (jtag_callback_data_t)in_fields[i].in_value,
434                                 (jtag_callback_data_t)in_fields[i].check_value,
435                                 (jtag_callback_data_t)in_fields[i].check_mask,
436                                 (jtag_callback_data_t)in_fields[i].num_bits);
437                 }
438                 if (in_fields[i].allocated)
439                 {
440                         free(in_fields[i].in_value);
441                 }
442                 if (in_fields[i].modified)
443                 {
444                         in_fields[i].in_value = NULL;
445                 }
446         }
447 }
448
449 void jtag_add_dr_scan_check(struct jtag_tap *active, int in_num_fields, struct scan_field *in_fields, tap_state_t state)
450 {
451         if (jtag_verify)
452         {
453                 jtag_add_scan_check(active, jtag_add_dr_scan, in_num_fields, in_fields, state);
454         } else
455         {
456                 jtag_add_dr_scan(active, in_num_fields, in_fields, state);
457         }
458 }
459
460
461 void jtag_add_dr_scan(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields,
462                 tap_state_t state)
463 {
464         assert(state != TAP_RESET);
465
466         jtag_prelude(state);
467
468         int retval;
469         retval = interface_jtag_add_dr_scan(active, in_num_fields, in_fields, state);
470         jtag_set_error(retval);
471 }
472
473 void jtag_add_plain_dr_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
474                 tap_state_t state)
475 {
476         assert(out_bits != NULL);
477         assert(state != TAP_RESET);
478
479         jtag_prelude(state);
480
481         int retval;
482         retval = interface_jtag_add_plain_dr_scan(num_bits, out_bits, in_bits, state);
483         jtag_set_error(retval);
484 }
485
486 void jtag_add_tlr(void)
487 {
488         jtag_prelude(TAP_RESET);
489         jtag_set_error(interface_jtag_add_tlr());
490
491         /* NOTE: order here matches TRST path in jtag_add_reset() */
492         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
493         jtag_notify_event(JTAG_TRST_ASSERTED);
494 }
495
496 /**
497  * If supported by the underlying adapter, this clocks a raw bit sequence
498  * onto TMS for switching betwen JTAG and SWD modes.
499  *
500  * DO NOT use this to bypass the integrity checks and logging provided
501  * by the jtag_add_pathmove() and jtag_add_statemove() calls.
502  *
503  * @param nbits How many bits to clock out.
504  * @param seq The bit sequence.  The LSB is bit 0 of seq[0].
505  * @param state The JTAG tap state to record on completion.  Use
506  *      TAP_INVALID to represent being in in SWD mode.
507  *
508  * @todo Update naming conventions to stop assuming everything is JTAG.
509  */
510 int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state state)
511 {
512         int retval;
513
514         if (!(jtag->supported & DEBUG_CAP_TMS_SEQ))
515                 return ERROR_JTAG_NOT_IMPLEMENTED;
516
517         jtag_checks();
518         cmd_queue_cur_state = state;
519
520         retval = interface_add_tms_seq(nbits, seq, state);
521         jtag_set_error(retval);
522         return retval;
523 }
524
525 void jtag_add_pathmove(int num_states, const tap_state_t *path)
526 {
527         tap_state_t cur_state = cmd_queue_cur_state;
528
529         /* the last state has to be a stable state */
530         if (!tap_is_state_stable(path[num_states - 1]))
531         {
532                 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
533                 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
534                 return;
535         }
536
537         for (int i = 0; i < num_states; i++)
538         {
539                 if (path[i] == TAP_RESET)
540                 {
541                         LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
542                         jtag_set_error(ERROR_JTAG_STATE_INVALID);
543                         return;
544                 }
545
546                 if (tap_state_transition(cur_state, true)  != path[i]
547                   && tap_state_transition(cur_state, false) != path[i])
548                 {
549                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
550                                         tap_state_name(cur_state), tap_state_name(path[i]));
551                         jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
552                         return;
553                 }
554                 cur_state = path[i];
555         }
556
557         jtag_checks();
558
559         jtag_set_error(interface_jtag_add_pathmove(num_states, path));
560         cmd_queue_cur_state = path[num_states - 1];
561 }
562
563 int jtag_add_statemove(tap_state_t goal_state)
564 {
565         tap_state_t cur_state = cmd_queue_cur_state;
566
567         if (goal_state != cur_state)
568         {
569                 LOG_DEBUG("cur_state=%s goal_state=%s",
570                         tap_state_name(cur_state),
571                         tap_state_name(goal_state));
572         }
573
574         /* If goal is RESET, be paranoid and force that that transition
575          * (e.g. five TCK cycles, TMS high).  Else trust "cur_state".
576          */
577         if (goal_state == TAP_RESET)
578                 jtag_add_tlr();
579         else if (goal_state == cur_state)
580                 /* nothing to do */ ;
581
582         else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state))
583         {
584                 unsigned tms_bits  = tap_get_tms_path(cur_state, goal_state);
585                 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
586                 tap_state_t moves[8];
587                 assert(tms_count < ARRAY_SIZE(moves));
588
589                 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1)
590                 {
591                         bool bit = tms_bits & 1;
592
593                         cur_state = tap_state_transition(cur_state, bit);
594                         moves[i] = cur_state;
595                 }
596
597                 jtag_add_pathmove(tms_count, moves);
598         }
599         else if (tap_state_transition(cur_state, true)  == goal_state
600                 ||   tap_state_transition(cur_state, false) == goal_state)
601         {
602                 jtag_add_pathmove(1, &goal_state);
603         }
604
605         else
606                 return ERROR_FAIL;
607
608         return ERROR_OK;
609 }
610
611 void jtag_add_runtest(int num_cycles, tap_state_t state)
612 {
613         jtag_prelude(state);
614         jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
615 }
616
617
618 void jtag_add_clocks(int num_cycles)
619 {
620         if (!tap_is_state_stable(cmd_queue_cur_state))
621         {
622                  LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
623                                  tap_state_name(cmd_queue_cur_state));
624                  jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
625                  return;
626         }
627
628         if (num_cycles > 0)
629         {
630                 jtag_checks();
631                 jtag_set_error(interface_jtag_add_clocks(num_cycles));
632         }
633 }
634
635 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
636 {
637         int trst_with_tlr = 0;
638         int new_srst = 0;
639         int new_trst = 0;
640
641         /* Without SRST, we must use target-specific JTAG operations
642          * on each target; callers should not be requesting SRST when
643          * that signal doesn't exist.
644          *
645          * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
646          * can kick in even if the JTAG adapter can't drive TRST.
647          */
648         if (req_srst) {
649                 if (!(jtag_reset_config & RESET_HAS_SRST)) {
650                         LOG_ERROR("BUG: can't assert SRST");
651                         jtag_set_error(ERROR_FAIL);
652                         return;
653                 }
654                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
655                                 && !req_tlr_or_trst) {
656                         LOG_ERROR("BUG: can't assert only SRST");
657                         jtag_set_error(ERROR_FAIL);
658                         return;
659                 }
660                 new_srst = 1;
661         }
662
663         /* JTAG reset (entry to TAP_RESET state) can always be achieved
664          * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
665          * state first.  TRST accelerates it, and bypasses those states.
666          *
667          * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
668          * can kick in even if the JTAG adapter can't drive SRST.
669          */
670         if (req_tlr_or_trst) {
671                 if (!(jtag_reset_config & RESET_HAS_TRST))
672                         trst_with_tlr = 1;
673                 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
674                                 && !req_srst)
675                         trst_with_tlr = 1;
676                 else
677                         new_trst = 1;
678         }
679
680         /* Maybe change TRST and/or SRST signal state */
681         if (jtag_srst != new_srst || jtag_trst != new_trst) {
682                 int retval;
683
684                 retval = interface_jtag_add_reset(new_trst, new_srst);
685                 if (retval != ERROR_OK)
686                         jtag_set_error(retval);
687                 else
688                         retval = jtag_execute_queue();
689
690                 if (retval != ERROR_OK) {
691                         LOG_ERROR("TRST/SRST error %d", retval);
692                         return;
693                 }
694         }
695
696         /* SRST resets everything hooked up to that signal */
697         if (jtag_srst != new_srst) {
698                 jtag_srst = new_srst;
699                 if (jtag_srst)
700                 {
701                         LOG_DEBUG("SRST line asserted");
702                         if (jtag_nsrst_assert_width)
703                                 jtag_add_sleep(jtag_nsrst_assert_width * 1000);
704                 }
705                 else {
706                         LOG_DEBUG("SRST line released");
707                         if (adapter_nsrst_delay)
708                                 jtag_add_sleep(adapter_nsrst_delay * 1000);
709                 }
710         }
711
712         /* Maybe enter the JTAG TAP_RESET state ...
713          *  - using only TMS, TCK, and the JTAG state machine
714          *  - or else more directly, using TRST
715          *
716          * TAP_RESET should be invisible to non-debug parts of the system.
717          */
718         if (trst_with_tlr) {
719                 LOG_DEBUG("JTAG reset with TLR instead of TRST");
720                 jtag_set_end_state(TAP_RESET);
721                 jtag_add_tlr();
722
723         } else if (jtag_trst != new_trst) {
724                 jtag_trst = new_trst;
725                 if (jtag_trst) {
726                         LOG_DEBUG("TRST line asserted");
727                         tap_set_state(TAP_RESET);
728                         if (jtag_ntrst_assert_width)
729                                 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
730                 } else {
731                         LOG_DEBUG("TRST line released");
732                         if (jtag_ntrst_delay)
733                                 jtag_add_sleep(jtag_ntrst_delay * 1000);
734
735                         /* We just asserted nTRST, so we're now in TAP_RESET.
736                          * Inform possible listeners about this, now that
737                          * JTAG instructions and data can be shifted.  This
738                          * sequence must match jtag_add_tlr().
739                          */
740                         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
741                         jtag_notify_event(JTAG_TRST_ASSERTED);
742                 }
743         }
744 }
745
746 tap_state_t jtag_set_end_state(tap_state_t state)
747 {
748         if ((state == TAP_DRSHIFT)||(state == TAP_IRSHIFT))
749         {
750                 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
751         }
752
753         if (state != TAP_INVALID)
754                 cmd_queue_end_state = state;
755         return cmd_queue_end_state;
756 }
757
758 tap_state_t jtag_get_end_state(void)
759 {
760         return cmd_queue_end_state;
761 }
762
763 void jtag_add_sleep(uint32_t us)
764 {
765         /// @todo Here, keep_alive() appears to be a layering violation!!!
766         keep_alive();
767         jtag_set_error(interface_jtag_add_sleep(us));
768 }
769
770 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
771                 uint8_t *in_check_mask, int num_bits)
772 {
773         int retval = ERROR_OK;
774         int compare_failed;
775
776         if (in_check_mask)
777                 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
778         else
779                 compare_failed = buf_cmp(captured, in_check_value, num_bits);
780
781         if (compare_failed) {
782                 char *captured_str, *in_check_value_str;
783                 int bits = (num_bits > DEBUG_JTAG_IOZ)
784                                 ? DEBUG_JTAG_IOZ
785                                 : num_bits;
786
787                 /* NOTE:  we've lost diagnostic context here -- 'which tap' */
788
789                 captured_str = buf_to_str(captured, bits, 16);
790                 in_check_value_str = buf_to_str(in_check_value, bits, 16);
791
792                 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
793                                 captured_str);
794                 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
795
796                 free(captured_str);
797                 free(in_check_value_str);
798
799                 if (in_check_mask) {
800                         char *in_check_mask_str;
801
802                         in_check_mask_str = buf_to_str(in_check_mask, bits, 16);
803                         LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
804                         free(in_check_mask_str);
805                 }
806
807                 retval = ERROR_JTAG_QUEUE_FAILED;
808         }
809         return retval;
810 }
811
812 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask)
813 {
814         assert(field->in_value != NULL);
815
816         if (value == NULL)
817         {
818                 /* no checking to do */
819                 return;
820         }
821
822         jtag_execute_queue_noclear();
823
824         int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
825         jtag_set_error(retval);
826 }
827
828
829
830 int default_interface_jtag_execute_queue(void)
831 {
832         if (NULL == jtag)
833         {
834                 LOG_ERROR("No JTAG interface configured yet.  "
835                         "Issue 'init' command in startup scripts "
836                         "before communicating with targets.");
837                 return ERROR_FAIL;
838         }
839
840         return jtag->execute_queue();
841 }
842
843 void jtag_execute_queue_noclear(void)
844 {
845         jtag_flush_queue_count++;
846         jtag_set_error(interface_jtag_execute_queue());
847 }
848
849 int jtag_get_flush_queue_count(void)
850 {
851         return jtag_flush_queue_count;
852 }
853
854 int jtag_execute_queue(void)
855 {
856         jtag_execute_queue_noclear();
857         return jtag_error_clear();
858 }
859
860 static int jtag_reset_callback(enum jtag_event event, void *priv)
861 {
862         struct jtag_tap *tap = priv;
863
864         if (event == JTAG_TRST_ASSERTED)
865         {
866                 tap->enabled = !tap->disabled_after_reset;
867
868                 /* current instruction is either BYPASS or IDCODE */
869                 buf_set_ones(tap->cur_instr, tap->ir_length);
870                 tap->bypass = 1;
871         }
872
873         return ERROR_OK;
874 }
875
876 void jtag_sleep(uint32_t us)
877 {
878         alive_sleep(us/1000);
879 }
880
881 /* Maximum number of enabled JTAG devices we expect in the scan chain,
882  * plus one (to detect garbage at the end).  Devices that don't support
883  * IDCODE take up fewer bits, possibly allowing a few more devices.
884  */
885 #define JTAG_MAX_CHAIN_SIZE 20
886
887 #define EXTRACT_MFG(X)  (((X) & 0xffe) >> 1)
888 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
889 #define EXTRACT_VER(X)  (((X) & 0xf0000000) >> 28)
890
891 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
892  * know that no valid TAP will have it as an IDCODE value.
893  */
894 #define END_OF_CHAIN_FLAG       0x000000ff
895
896 /* a larger IR length than we ever expect to autoprobe */
897 #define JTAG_IRLEN_MAX          60
898
899 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
900 {
901         struct scan_field field = {
902                         .num_bits = num_idcode * 32,
903                         .out_value = idcode_buffer,
904                         .in_value = idcode_buffer,
905                 };
906
907         // initialize to the end of chain ID value
908         for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
909                 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
910
911         jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, TAP_DRPAUSE);
912         jtag_add_tlr();
913         return jtag_execute_queue();
914 }
915
916 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
917 {
918         uint8_t zero_check = 0x0;
919         uint8_t one_check = 0xff;
920
921         for (unsigned i = 0; i < count * 4; i++)
922         {
923                 zero_check |= idcodes[i];
924                 one_check &= idcodes[i];
925         }
926
927         /* if there wasn't a single non-zero bit or if all bits were one,
928          * the scan is not valid.  We wrote a mix of both values; either
929          *
930          *  - There's a hardware issue (almost certainly):
931          *     + all-zeroes can mean a target stuck in JTAG reset
932          *     + all-ones tends to mean no target
933          *  - The scan chain is WAY longer than we can handle, *AND* either
934          *     + there are several hundreds of TAPs in bypass, or
935          *     + at least a few dozen TAPs all have an all-ones IDCODE
936          */
937         if (zero_check == 0x00 || one_check == 0xff)
938         {
939                 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
940                                 (zero_check == 0x00) ? "zeroes" : "ones");
941                 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
942                 return false;
943         }
944         return true;
945 }
946
947 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
948                 const char *name, uint32_t idcode)
949 {
950         log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
951                                   "JTAG tap: %s %16.16s: 0x%08x "
952                                   "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
953                                   name, msg,
954                                   (unsigned int)idcode,
955                                   (unsigned int)EXTRACT_MFG(idcode),
956                                   (unsigned int)EXTRACT_PART(idcode),
957                                   (unsigned int)EXTRACT_VER(idcode));
958 }
959
960 static bool jtag_idcode_is_final(uint32_t idcode)
961 {
962         /*
963          * Some devices, such as AVR8, will output all 1's instead
964          * of TDI input value at end of chain.  Allow those values
965          * instead of failing.
966          */
967         return idcode == END_OF_CHAIN_FLAG || idcode == 0xFFFFFFFF;
968 }
969
970 /**
971  * This helper checks that remaining bits in the examined chain data are
972  * all as expected, but a single JTAG device requires only 64 bits to be
973  * read back correctly.  This can help identify and diagnose problems
974  * with the JTAG chain earlier, gives more helpful/explicit error messages.
975  * Returns TRUE iff garbage was found.
976  */
977 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
978 {
979         bool triggered = false;
980         for (; count < max - 31; count += 32)
981         {
982                 uint32_t idcode = buf_get_u32(idcodes, count, 32);
983
984                 /* do not trigger the warning if the data looks good */
985                 if (jtag_idcode_is_final(idcode))
986                         continue;
987                 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
988                                         count, (unsigned int)idcode);
989                 triggered = true;
990         }
991         return triggered;
992 }
993
994 static bool jtag_examine_chain_match_tap(const struct jtag_tap *tap)
995 {
996         uint32_t idcode = tap->idcode;
997
998         /* ignore expected BYPASS codes; warn otherwise */
999         if (0 == tap->expected_ids_cnt && !idcode)
1000                 return true;
1001
1002         /* optionally ignore the JTAG version field */
1003         uint32_t mask = tap->ignore_version ? ~(0xff << 24) : ~0;
1004
1005         idcode &= mask;
1006
1007         /* Loop over the expected identification codes and test for a match */
1008         unsigned ii, limit = tap->expected_ids_cnt;
1009
1010         for (ii = 0; ii < limit; ii++)
1011         {
1012                 uint32_t expected = tap->expected_ids[ii] & mask;
1013
1014                 if (idcode == expected)
1015                         return true;
1016
1017                 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1018                 if (0 == tap->expected_ids[ii])
1019                         return true;
1020         }
1021
1022         /* If none of the expected ids matched, warn */
1023         jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
1024                         tap->dotted_name, tap->idcode);
1025         for (ii = 0; ii < limit; ii++)
1026         {
1027                 char msg[32];
1028
1029                 snprintf(msg, sizeof(msg), "expected %u of %u", ii + 1, limit);
1030                 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
1031                                 tap->dotted_name, tap->expected_ids[ii]);
1032         }
1033         return false;
1034 }
1035
1036 /* Try to examine chain layout according to IEEE 1149.1 Â§12
1037  * This is called a "blind interrogation" of the scan chain.
1038  */
1039 static int jtag_examine_chain(void)
1040 {
1041         uint8_t idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1042         unsigned bit_count;
1043         int retval;
1044         int tapcount = 0;
1045         bool autoprobe = false;
1046
1047         /* DR scan to collect BYPASS or IDCODE register contents.
1048          * Then make sure the scan data has both ones and zeroes.
1049          */
1050         LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1051         retval = jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
1052         if (retval != ERROR_OK)
1053                 return retval;
1054         if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
1055                 return ERROR_JTAG_INIT_FAILED;
1056
1057         /* point at the 1st tap */
1058         struct jtag_tap *tap = jtag_tap_next_enabled(NULL);
1059
1060         if (!tap)
1061                 autoprobe = true;
1062
1063         for (bit_count = 0;
1064                         tap && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;
1065                         tap = jtag_tap_next_enabled(tap))
1066         {
1067                 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1068
1069                 if ((idcode & 1) == 0)
1070                 {
1071                         /* Zero for LSB indicates a device in bypass */
1072                         LOG_INFO("TAP %s does not have IDCODE",
1073                                         tap->dotted_name);
1074                         idcode = 0;
1075                         tap->hasidcode = false;
1076
1077                         bit_count += 1;
1078                 }
1079                 else
1080                 {
1081                         /* Friendly devices support IDCODE */
1082                         tap->hasidcode = true;
1083                         jtag_examine_chain_display(LOG_LVL_INFO,
1084                                         "tap/device found",
1085                                         tap->dotted_name, idcode);
1086
1087                         bit_count += 32;
1088                 }
1089                 tap->idcode = idcode;
1090
1091                 /* ensure the TAP ID matches what was expected */
1092                 if (!jtag_examine_chain_match_tap(tap))
1093                         retval = ERROR_JTAG_INIT_SOFT_FAIL;
1094         }
1095
1096         /* Fail if too many TAPs were enabled for us to verify them all. */
1097         if (tap) {
1098                 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1099                                 tap->dotted_name);
1100                 return ERROR_JTAG_INIT_FAILED;
1101         }
1102
1103         /* if autoprobing, the tap list is still empty ... populate it! */
1104         while (autoprobe && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31) {
1105                 uint32_t idcode;
1106                 char buf[12];
1107
1108                 /* Is there another TAP? */
1109                 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1110                 if (jtag_idcode_is_final(idcode))
1111                         break;
1112
1113                 /* Default everything in this TAP except IR length.
1114                  *
1115                  * REVISIT create a jtag_alloc(chip, tap) routine, and
1116                  * share it with jim_newtap_cmd().
1117                  */
1118                 tap = calloc(1, sizeof *tap);
1119                 if (!tap)
1120                         return ERROR_FAIL;
1121
1122                 sprintf(buf, "auto%d", tapcount++);
1123                 tap->chip = strdup(buf);
1124                 tap->tapname = strdup("tap");
1125
1126                 sprintf(buf, "%s.%s", tap->chip, tap->tapname);
1127                 tap->dotted_name = strdup(buf);
1128
1129                 /* tap->ir_length == 0 ... signifying irlen autoprobe */
1130                 tap->ir_capture_mask = 0x03;
1131                 tap->ir_capture_value = 0x01;
1132
1133                 tap->enabled = true;
1134
1135                 if ((idcode & 1) == 0) {
1136                         bit_count += 1;
1137                         tap->hasidcode = false;
1138                 } else {
1139                         bit_count += 32;
1140                         tap->hasidcode = true;
1141                         tap->idcode = idcode;
1142
1143                         tap->expected_ids_cnt = 1;
1144                         tap->expected_ids = malloc(sizeof(uint32_t));
1145                         tap->expected_ids[0] = idcode;
1146                 }
1147
1148                 LOG_WARNING("AUTO %s - use \"jtag newtap "
1149                                 "%s %s -expected-id 0x%8.8" PRIx32 " ...\"",
1150                                 tap->dotted_name, tap->chip, tap->tapname,
1151                                 tap->idcode);
1152
1153                 jtag_tap_init(tap);
1154         }
1155
1156         /* After those IDCODE or BYPASS register values should be
1157          * only the data we fed into the scan chain.
1158          */
1159         if (jtag_examine_chain_end(idcode_buffer, bit_count,
1160                         8 * sizeof(idcode_buffer))) {
1161                 LOG_ERROR("double-check your JTAG setup (interface, "
1162                                 "speed, missing TAPs, ...)");
1163                 return ERROR_JTAG_INIT_FAILED;
1164         }
1165
1166         /* Return success or, for backwards compatibility if only
1167          * some IDCODE values mismatched, a soft/continuable fault.
1168          */
1169         return retval;
1170 }
1171
1172 /*
1173  * Validate the date loaded by entry to the Capture-IR state, to help
1174  * find errors related to scan chain configuration (wrong IR lengths)
1175  * or communication.
1176  *
1177  * Entry state can be anything.  On non-error exit, all TAPs are in
1178  * bypass mode.  On error exits, the scan chain is reset.
1179  */
1180 static int jtag_validate_ircapture(void)
1181 {
1182         struct jtag_tap *tap;
1183         int total_ir_length = 0;
1184         uint8_t *ir_test = NULL;
1185         struct scan_field field;
1186         int val;
1187         int chain_pos = 0;
1188         int retval;
1189
1190         /* when autoprobing, accomodate huge IR lengths */
1191         for (tap = NULL, total_ir_length = 0;
1192                         (tap = jtag_tap_next_enabled(tap)) != NULL;
1193                         total_ir_length += tap->ir_length) {
1194                 if (tap->ir_length == 0)
1195                         total_ir_length += JTAG_IRLEN_MAX;
1196         }
1197
1198         /* increase length to add 2 bit sentinel after scan */
1199         total_ir_length += 2;
1200
1201         ir_test = malloc(DIV_ROUND_UP(total_ir_length, 8));
1202         if (ir_test == NULL)
1203                 return ERROR_FAIL;
1204
1205         /* after this scan, all TAPs will capture BYPASS instructions */
1206         buf_set_ones(ir_test, total_ir_length);
1207
1208         field.num_bits = total_ir_length;
1209         field.out_value = ir_test;
1210         field.in_value = ir_test;
1211
1212         jtag_add_plain_ir_scan(field.num_bits, field.out_value, field.in_value, TAP_IDLE);
1213
1214         LOG_DEBUG("IR capture validation scan");
1215         retval = jtag_execute_queue();
1216         if (retval != ERROR_OK)
1217                 goto done;
1218
1219         tap = NULL;
1220         chain_pos = 0;
1221
1222         for (;;) {
1223                 tap = jtag_tap_next_enabled(tap);
1224                 if (tap == NULL) {
1225                         break;
1226                 }
1227
1228                 /* If we're autoprobing, guess IR lengths.  They must be at
1229                  * least two bits.  Guessing will fail if (a) any TAP does
1230                  * not conform to the JTAG spec; or (b) when the upper bits
1231                  * captured from some conforming TAP are nonzero.  Or if
1232                  * (c) an IR length is longer than 32 bits -- which is only
1233                  * an implementation limit, which could someday be raised.
1234                  *
1235                  * REVISIT optimization:  if there's a *single* TAP we can
1236                  * lift restrictions (a) and (b) by scanning a recognizable
1237                  * pattern before the all-ones BYPASS.  Check for where the
1238                  * pattern starts in the result, instead of an 0...01 value.
1239                  *
1240                  * REVISIT alternative approach: escape to some tcl code
1241                  * which could provide more knowledge, based on IDCODE; and
1242                  * only guess when that has no success.
1243                  */
1244                 if (tap->ir_length == 0) {
1245                         tap->ir_length = 2;
1246                         while ((val = buf_get_u32(ir_test, chain_pos,
1247                                                 tap->ir_length + 1)) == 1
1248                                         && tap->ir_length <= 32) {
1249                                 tap->ir_length++;
1250                         }
1251                         LOG_WARNING("AUTO %s - use \"... -irlen %d\"",
1252                                         jtag_tap_name(tap), tap->ir_length);
1253                 }
1254
1255                 /* Validate the two LSBs, which must be 01 per JTAG spec.
1256                  *
1257                  * Or ... more bits could be provided by TAP declaration.
1258                  * Plus, some taps (notably in i.MX series chips) violate
1259                  * this part of the JTAG spec, so their capture mask/value
1260                  * attributes might disable this test.
1261                  */
1262                 val = buf_get_u32(ir_test, chain_pos, tap->ir_length);
1263                 if ((val & tap->ir_capture_mask) != tap->ir_capture_value) {
1264                         LOG_ERROR("%s: IR capture error; saw 0x%0*x not 0x%0*x",
1265                                         jtag_tap_name(tap),
1266                                         (tap->ir_length + 7) / tap->ir_length,
1267                                         val,
1268                                         (tap->ir_length + 7) / tap->ir_length,
1269                                         (unsigned) tap->ir_capture_value);
1270
1271                         retval = ERROR_JTAG_INIT_FAILED;
1272                         goto done;
1273                 }
1274                 LOG_DEBUG("%s: IR capture 0x%0*x", jtag_tap_name(tap),
1275                                 (tap->ir_length + 7) / tap->ir_length, val);
1276                 chain_pos += tap->ir_length;
1277         }
1278
1279         /* verify the '11' sentinel we wrote is returned at the end */
1280         val = buf_get_u32(ir_test, chain_pos, 2);
1281         if (val != 0x3)
1282         {
1283                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1284
1285                 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1286                                 chain_pos, cbuf);
1287                 free(cbuf);
1288                 retval = ERROR_JTAG_INIT_FAILED;
1289         }
1290
1291 done:
1292         free(ir_test);
1293         if (retval != ERROR_OK) {
1294                 jtag_add_tlr();
1295                 jtag_execute_queue();
1296         }
1297         return retval;
1298 }
1299
1300
1301 void jtag_tap_init(struct jtag_tap *tap)
1302 {
1303         unsigned ir_len_bits;
1304         unsigned ir_len_bytes;
1305
1306         /* if we're autoprobing, cope with potentially huge ir_length */
1307         ir_len_bits = tap->ir_length ? : JTAG_IRLEN_MAX;
1308         ir_len_bytes = DIV_ROUND_UP(ir_len_bits, 8);
1309
1310         tap->expected = calloc(1, ir_len_bytes);
1311         tap->expected_mask = calloc(1, ir_len_bytes);
1312         tap->cur_instr = malloc(ir_len_bytes);
1313
1314         /// @todo cope better with ir_length bigger than 32 bits
1315         if (ir_len_bits > 32)
1316                 ir_len_bits = 32;
1317
1318         buf_set_u32(tap->expected, 0, ir_len_bits, tap->ir_capture_value);
1319         buf_set_u32(tap->expected_mask, 0, ir_len_bits, tap->ir_capture_mask);
1320
1321         // TAP will be in bypass mode after jtag_validate_ircapture()
1322         tap->bypass = 1;
1323         buf_set_ones(tap->cur_instr, tap->ir_length);
1324
1325         // register the reset callback for the TAP
1326         jtag_register_event_callback(&jtag_reset_callback, tap);
1327
1328         LOG_DEBUG("Created Tap: %s @ abs position %d, "
1329                         "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1330                                 tap->abs_chain_position, tap->ir_length,
1331                                 (unsigned) tap->ir_capture_value,
1332                                 (unsigned) tap->ir_capture_mask);
1333         jtag_tap_add(tap);
1334 }
1335
1336 void jtag_tap_free(struct jtag_tap *tap)
1337 {
1338         jtag_unregister_event_callback(&jtag_reset_callback, tap);
1339
1340         /// @todo is anything missing? no memory leaks please
1341         free((void *)tap->expected);
1342         free((void *)tap->expected_ids);
1343         free((void *)tap->chip);
1344         free((void *)tap->tapname);
1345         free((void *)tap->dotted_name);
1346         free(tap);
1347 }
1348
1349 /**
1350  * Do low-level setup like initializing registers, output signals,
1351  * and clocking.
1352  */
1353 int adapter_init(struct command_context *cmd_ctx)
1354 {
1355         if (jtag)
1356                 return ERROR_OK;
1357
1358         if (!jtag_interface)
1359         {
1360                 /* nothing was previously specified by "interface" command */
1361                 LOG_ERROR("Debug Adapter has to be specified, "
1362                         "see \"interface\" command");
1363                 return ERROR_JTAG_INVALID_INTERFACE;
1364         }
1365
1366         jtag = jtag_interface;
1367         if (jtag_interface->init() != ERROR_OK)
1368         {
1369                 jtag = NULL;
1370                 return ERROR_JTAG_INIT_FAILED;
1371         }
1372
1373         int requested_khz = jtag_get_speed_khz();
1374         int actual_khz = requested_khz;
1375         int retval = jtag_get_speed_readable(&actual_khz);
1376         if (ERROR_OK != retval)
1377                 LOG_INFO("adapter-specific clock speed value %d", jtag_get_speed());
1378         else if (actual_khz)
1379         {
1380                 /* Adaptive clocking -- JTAG-specific */
1381                 if ((CLOCK_MODE_RCLK == clock_mode)
1382                         || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
1383                 {
1384                         LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1385                                 , actual_khz);
1386                 }
1387                 else
1388                         LOG_INFO("clock speed %d kHz", actual_khz);
1389         }
1390         else
1391                 LOG_INFO("RCLK (adaptive clock speed)");
1392
1393         return ERROR_OK;
1394 }
1395
1396 int jtag_init_inner(struct command_context *cmd_ctx)
1397 {
1398         struct jtag_tap *tap;
1399         int retval;
1400         bool issue_setup = true;
1401
1402         LOG_DEBUG("Init JTAG chain");
1403
1404         tap = jtag_tap_next_enabled(NULL);
1405         if (tap == NULL) {
1406                 /* Once JTAG itself is properly set up, and the scan chain
1407                  * isn't absurdly large, IDCODE autoprobe should work fine.
1408                  *
1409                  * But ... IRLEN autoprobe can fail even on systems which
1410                  * are fully conformant to JTAG.  Also, JTAG setup can be
1411                  * quite finicky on some systems.
1412                  *
1413                  * REVISIT: if TAP autoprobe works OK, then in many cases
1414                  * we could escape to tcl code and set up targets based on
1415                  * the TAP's IDCODE values.
1416                  */
1417                 LOG_WARNING("There are no enabled taps.  "
1418                                 "AUTO PROBING MIGHT NOT WORK!!");
1419
1420                 /* REVISIT default clock will often be too fast ... */
1421         }
1422
1423         jtag_add_tlr();
1424         if ((retval = jtag_execute_queue()) != ERROR_OK)
1425                 return retval;
1426
1427         /* Examine DR values first.  This discovers problems which will
1428          * prevent communication ... hardware issues like TDO stuck, or
1429          * configuring the wrong number of (enabled) TAPs.
1430          */
1431         retval = jtag_examine_chain();
1432         switch (retval) {
1433         case ERROR_OK:
1434                 /* complete success */
1435                 break;
1436         case ERROR_JTAG_INIT_SOFT_FAIL:
1437                 /* For backward compatibility reasons, try coping with
1438                  * configuration errors involving only ID mismatches.
1439                  * We might be able to talk to the devices.
1440                  */
1441                 LOG_ERROR("Trying to use configured scan chain anyway...");
1442                 issue_setup = false;
1443                 break;
1444         default:
1445                 /* some hard error; already issued diagnostics */
1446                 return retval;
1447         }
1448
1449         /* Now look at IR values.  Problems here will prevent real
1450          * communication.  They mostly mean that the IR length is
1451          * wrong ... or that the IR capture value is wrong.  (The
1452          * latter is uncommon, but easily worked around:  provide
1453          * ircapture/irmask values during TAP setup.)
1454          */
1455         retval = jtag_validate_ircapture();
1456         if (retval != ERROR_OK)
1457                 return retval;
1458
1459         if (issue_setup)
1460                 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1461         else
1462                 LOG_WARNING("Bypassing JTAG setup events due to errors");
1463
1464
1465         return ERROR_OK;
1466 }
1467
1468 int adapter_quit(void)
1469 {
1470         if (!jtag || !jtag->quit)
1471                 return ERROR_OK;
1472
1473         // close the JTAG interface
1474         int result = jtag->quit();
1475         if (ERROR_OK != result)
1476                 LOG_ERROR("failed: %d", result);
1477
1478         return ERROR_OK;
1479 }
1480
1481
1482 int jtag_init_reset(struct command_context *cmd_ctx)
1483 {
1484         int retval;
1485
1486         if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
1487                 return retval;
1488
1489         LOG_DEBUG("Initializing with hard TRST+SRST reset");
1490
1491         /*
1492          * This procedure is used by default when OpenOCD triggers a reset.
1493          * It's now done through an overridable Tcl "init_reset" wrapper.
1494          *
1495          * This started out as a more powerful "get JTAG working" reset than
1496          * jtag_init_inner(), applying TRST because some chips won't activate
1497          * JTAG without a TRST cycle (presumed to be async, though some of
1498          * those chips synchronize JTAG activation using TCK).
1499          *
1500          * But some chips only activate JTAG as part of an SRST cycle; SRST
1501          * got mixed in.  So it became a hard reset routine, which got used
1502          * in more places, and which coped with JTAG reset being forced as
1503          * part of SRST (srst_pulls_trst).
1504          *
1505          * And even more corner cases started to surface:  TRST and/or SRST
1506          * assertion timings matter; some chips need other JTAG operations;
1507          * TRST/SRST sequences can need to be different from these, etc.
1508          *
1509          * Systems should override that wrapper to support system-specific
1510          * requirements that this not-fully-generic code doesn't handle.
1511          *
1512          * REVISIT once Tcl code can read the reset_config modes, this won't
1513          * need to be a C routine at all...
1514          */
1515         jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1516         if (jtag_reset_config & RESET_HAS_SRST)
1517         {
1518                 jtag_add_reset(1, 1);
1519                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1520                         jtag_add_reset(0, 1);
1521         }
1522         jtag_add_reset(0, 0);
1523         if ((retval = jtag_execute_queue()) != ERROR_OK)
1524                 return retval;
1525
1526         /* Check that we can communication on the JTAG chain + eventually we want to
1527          * be able to perform enumeration only after OpenOCD has started
1528          * telnet and GDB server
1529          *
1530          * That would allow users to more easily perform any magic they need to before
1531          * reset happens.
1532          */
1533         return jtag_init_inner(cmd_ctx);
1534 }
1535
1536 int jtag_init(struct command_context *cmd_ctx)
1537 {
1538         int retval;
1539
1540         if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
1541                 return retval;
1542
1543         /* guard against oddball hardware: force resets to be inactive */
1544         jtag_add_reset(0, 0);
1545         if ((retval = jtag_execute_queue()) != ERROR_OK)
1546                 return retval;
1547
1548         if (Jim_Eval_Named(cmd_ctx->interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1549                 return ERROR_FAIL;
1550
1551         return ERROR_OK;
1552 }
1553
1554 unsigned jtag_get_speed_khz(void)
1555 {
1556         return speed_khz;
1557 }
1558
1559 static int adapter_khz_to_speed(unsigned khz, int* speed)
1560 {
1561         LOG_DEBUG("convert khz to interface specific speed value");
1562         speed_khz = khz;
1563         if (jtag != NULL)
1564         {
1565                 LOG_DEBUG("have interface set up");
1566                 int speed_div1;
1567                 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1568                 if (ERROR_OK != retval)
1569                 {
1570                         return retval;
1571                 }
1572                 *speed = speed_div1;
1573         }
1574         return ERROR_OK;
1575 }
1576
1577 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int* speed)
1578 {
1579         int retval = adapter_khz_to_speed(0, speed);
1580         if ((ERROR_OK != retval) && fallback_speed_khz)
1581         {
1582                 LOG_DEBUG("trying fallback speed...");
1583                 retval = adapter_khz_to_speed(fallback_speed_khz, speed);
1584         }
1585         return retval;
1586 }
1587
1588 static int jtag_set_speed(int speed)
1589 {
1590         jtag_speed = speed;
1591         /* this command can be called during CONFIG,
1592          * in which case jtag isn't initialized */
1593         return jtag ? jtag->speed(speed) : ERROR_OK;
1594 }
1595
1596 int jtag_config_khz(unsigned khz)
1597 {
1598         LOG_DEBUG("handle jtag khz");
1599         clock_mode = CLOCK_MODE_KHZ;
1600         int speed = 0;
1601         int retval = adapter_khz_to_speed(khz, &speed);
1602         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1603 }
1604
1605 int jtag_config_rclk(unsigned fallback_speed_khz)
1606 {
1607         LOG_DEBUG("handle jtag rclk");
1608         clock_mode = CLOCK_MODE_RCLK;
1609         rclk_fallback_speed_khz = fallback_speed_khz;
1610         int speed = 0;
1611         int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1612         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1613 }
1614
1615 int jtag_get_speed(void)
1616 {
1617         int speed;
1618         switch(clock_mode)
1619         {
1620                 case CLOCK_MODE_SPEED:
1621                         speed = jtag_speed;
1622                         break;
1623                 case CLOCK_MODE_KHZ:
1624                         adapter_khz_to_speed(jtag_get_speed_khz(), &speed);
1625                         break;
1626                 case CLOCK_MODE_RCLK:
1627                         jtag_rclk_to_speed(rclk_fallback_speed_khz, &speed);
1628                         break;
1629                 default:
1630                         LOG_ERROR("BUG: unknown jtag clock mode");
1631                         speed = 0;
1632                         break;
1633         }
1634         return speed;
1635 }
1636
1637 int jtag_get_speed_readable(int *khz)
1638 {
1639         return jtag ? jtag->speed_div(jtag_get_speed(), khz) : ERROR_OK;
1640 }
1641
1642 void jtag_set_verify(bool enable)
1643 {
1644         jtag_verify = enable;
1645 }
1646
1647 bool jtag_will_verify()
1648 {
1649         return jtag_verify;
1650 }
1651
1652 void jtag_set_verify_capture_ir(bool enable)
1653 {
1654         jtag_verify_capture_ir = enable;
1655 }
1656
1657 bool jtag_will_verify_capture_ir()
1658 {
1659         return jtag_verify_capture_ir;
1660 }
1661
1662 int jtag_power_dropout(int *dropout)
1663 {
1664         if (jtag == NULL)
1665         {
1666                 /* TODO: as the jtag interface is not valid all
1667                  * we can do at the moment is exit OpenOCD */
1668                 LOG_ERROR("No Valid JTAG Interface Configured.");
1669                 exit(-1);
1670         }
1671         return jtag->power_dropout(dropout);
1672 }
1673
1674 int jtag_srst_asserted(int *srst_asserted)
1675 {
1676         return jtag->srst_asserted(srst_asserted);
1677 }
1678
1679 enum reset_types jtag_get_reset_config(void)
1680 {
1681         return jtag_reset_config;
1682 }
1683 void jtag_set_reset_config(enum reset_types type)
1684 {
1685         jtag_reset_config = type;
1686 }
1687
1688 int jtag_get_trst(void)
1689 {
1690         return jtag_trst;
1691 }
1692 int jtag_get_srst(void)
1693 {
1694         return jtag_srst;
1695 }
1696
1697 void jtag_set_nsrst_delay(unsigned delay)
1698 {
1699         adapter_nsrst_delay = delay;
1700 }
1701 unsigned jtag_get_nsrst_delay(void)
1702 {
1703         return adapter_nsrst_delay;
1704 }
1705 void jtag_set_ntrst_delay(unsigned delay)
1706 {
1707         jtag_ntrst_delay = delay;
1708 }
1709 unsigned jtag_get_ntrst_delay(void)
1710 {
1711         return jtag_ntrst_delay;
1712 }
1713
1714
1715 void jtag_set_nsrst_assert_width(unsigned delay)
1716 {
1717         jtag_nsrst_assert_width = delay;
1718 }
1719 unsigned jtag_get_nsrst_assert_width(void)
1720 {
1721         return jtag_nsrst_assert_width;
1722 }
1723 void jtag_set_ntrst_assert_width(unsigned delay)
1724 {
1725         jtag_ntrst_assert_width = delay;
1726 }
1727 unsigned jtag_get_ntrst_assert_width(void)
1728 {
1729         return jtag_ntrst_assert_width;
1730 }