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