initial "transport" framework
[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 "interface.h"
36 #include "transport.h"
37
38 #ifdef HAVE_STRINGS_H
39 #include <strings.h>
40 #endif
41
42 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
43 #include "svf/svf.h"
44 #include "xsvf/xsvf.h"
45
46 /// The number of JTAG queue flushes (for profiling and debugging purposes).
47 static int jtag_flush_queue_count;
48
49 static void jtag_add_scan_check(struct jtag_tap *active,
50 void (*jtag_add_scan)(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields, tap_state_t state),
51 int in_num_fields, struct scan_field *in_fields, tap_state_t state);
52
53 /**
54 * The jtag_error variable is set when an error occurs while executing
55 * the queue. Application code may set this using jtag_set_error(),
56 * when an error occurs during processing that should be reported during
57 * jtag_execute_queue().
58 *
59 * The value is set and cleared, but never read by normal application code.
60 *
61 * This value is returned (and cleared) by jtag_execute_queue().
62 */
63 static int jtag_error = ERROR_OK;
64
65 static const char *jtag_event_strings[] =
66 {
67 [JTAG_TRST_ASSERTED] = "TAP reset",
68 [JTAG_TAP_EVENT_SETUP] = "TAP setup",
69 [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
70 [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
71 };
72
73 /*
74 * JTAG adapters must initialize with TRST and SRST de-asserted
75 * (they're negative logic, so that means *high*). But some
76 * hardware doesn't necessarily work that way ... so set things
77 * up so that jtag_init() always forces that state.
78 */
79 static int jtag_trst = -1;
80 static int jtag_srst = -1;
81
82 /**
83 * List all TAPs that have been created.
84 */
85 static struct jtag_tap *__jtag_all_taps = NULL;
86 /**
87 * The number of TAPs in the __jtag_all_taps list, used to track the
88 * assigned chain position to new TAPs
89 */
90 static unsigned jtag_num_taps = 0;
91
92 static enum reset_types jtag_reset_config = RESET_NONE;
93 tap_state_t cmd_queue_cur_state = TAP_RESET;
94
95 static bool jtag_verify_capture_ir = true;
96 static int jtag_verify = 1;
97
98 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
99 static int adapter_nsrst_delay = 0; /* default to no nSRST delay */
100 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
101 static int adapter_nsrst_assert_width = 0; /* width of assertion */
102 static int jtag_ntrst_assert_width = 0; /* width of assertion */
103
104 /**
105 * Contains a single callback along with a pointer that will be passed
106 * when an event occurs.
107 */
108 struct jtag_event_callback {
109 /// a event callback
110 jtag_event_handler_t callback;
111 /// the private data to pass to the callback
112 void* priv;
113 /// the next callback
114 struct jtag_event_callback* next;
115 };
116
117 /* callbacks to inform high-level handlers about JTAG state changes */
118 static struct jtag_event_callback *jtag_event_callbacks;
119
120 /* speed in kHz*/
121 static int speed_khz = 0;
122 /* speed to fallback to when RCLK is requested but not supported */
123 static int rclk_fallback_speed_khz = 0;
124 static enum {CLOCK_MODE_SPEED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
125 static int jtag_speed = 0;
126
127 static struct jtag_interface *jtag = NULL;
128
129 /* configuration */
130 struct jtag_interface *jtag_interface = NULL;
131
132 void jtag_set_error(int error)
133 {
134 if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
135 return;
136 jtag_error = error;
137 }
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 (adapter_nsrst_assert_width)
703 jtag_add_sleep(adapter_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_add_tlr();
721
722 } else if (jtag_trst != new_trst) {
723 jtag_trst = new_trst;
724 if (jtag_trst) {
725 LOG_DEBUG("TRST line asserted");
726 tap_set_state(TAP_RESET);
727 if (jtag_ntrst_assert_width)
728 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
729 } else {
730 LOG_DEBUG("TRST line released");
731 if (jtag_ntrst_delay)
732 jtag_add_sleep(jtag_ntrst_delay * 1000);
733
734 /* We just asserted nTRST, so we're now in TAP_RESET.
735 * Inform possible listeners about this, now that
736 * JTAG instructions and data can be shifted. This
737 * sequence must match jtag_add_tlr().
738 */
739 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
740 jtag_notify_event(JTAG_TRST_ASSERTED);
741 }
742 }
743 }
744
745 void jtag_add_sleep(uint32_t us)
746 {
747 /// @todo Here, keep_alive() appears to be a layering violation!!!
748 keep_alive();
749 jtag_set_error(interface_jtag_add_sleep(us));
750 }
751
752 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
753 uint8_t *in_check_mask, int num_bits)
754 {
755 int retval = ERROR_OK;
756 int compare_failed;
757
758 if (in_check_mask)
759 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
760 else
761 compare_failed = buf_cmp(captured, in_check_value, num_bits);
762
763 if (compare_failed) {
764 char *captured_str, *in_check_value_str;
765 int bits = (num_bits > DEBUG_JTAG_IOZ)
766 ? DEBUG_JTAG_IOZ
767 : num_bits;
768
769 /* NOTE: we've lost diagnostic context here -- 'which tap' */
770
771 captured_str = buf_to_str(captured, bits, 16);
772 in_check_value_str = buf_to_str(in_check_value, bits, 16);
773
774 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
775 captured_str);
776 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
777
778 free(captured_str);
779 free(in_check_value_str);
780
781 if (in_check_mask) {
782 char *in_check_mask_str;
783
784 in_check_mask_str = buf_to_str(in_check_mask, bits, 16);
785 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
786 free(in_check_mask_str);
787 }
788
789 retval = ERROR_JTAG_QUEUE_FAILED;
790 }
791 return retval;
792 }
793
794 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask)
795 {
796 assert(field->in_value != NULL);
797
798 if (value == NULL)
799 {
800 /* no checking to do */
801 return;
802 }
803
804 jtag_execute_queue_noclear();
805
806 int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
807 jtag_set_error(retval);
808 }
809
810
811
812 int default_interface_jtag_execute_queue(void)
813 {
814 if (NULL == jtag)
815 {
816 LOG_ERROR("No JTAG interface configured yet. "
817 "Issue 'init' command in startup scripts "
818 "before communicating with targets.");
819 return ERROR_FAIL;
820 }
821
822 return jtag->execute_queue();
823 }
824
825 void jtag_execute_queue_noclear(void)
826 {
827 jtag_flush_queue_count++;
828 jtag_set_error(interface_jtag_execute_queue());
829 }
830
831 int jtag_get_flush_queue_count(void)
832 {
833 return jtag_flush_queue_count;
834 }
835
836 int jtag_execute_queue(void)
837 {
838 jtag_execute_queue_noclear();
839 return jtag_error_clear();
840 }
841
842 static int jtag_reset_callback(enum jtag_event event, void *priv)
843 {
844 struct jtag_tap *tap = priv;
845
846 if (event == JTAG_TRST_ASSERTED)
847 {
848 tap->enabled = !tap->disabled_after_reset;
849
850 /* current instruction is either BYPASS or IDCODE */
851 buf_set_ones(tap->cur_instr, tap->ir_length);
852 tap->bypass = 1;
853 }
854
855 return ERROR_OK;
856 }
857
858 void jtag_sleep(uint32_t us)
859 {
860 alive_sleep(us/1000);
861 }
862
863 /* Maximum number of enabled JTAG devices we expect in the scan chain,
864 * plus one (to detect garbage at the end). Devices that don't support
865 * IDCODE take up fewer bits, possibly allowing a few more devices.
866 */
867 #define JTAG_MAX_CHAIN_SIZE 20
868
869 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
870 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
871 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
872
873 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
874 * know that no valid TAP will have it as an IDCODE value.
875 */
876 #define END_OF_CHAIN_FLAG 0x000000ff
877
878 /* a larger IR length than we ever expect to autoprobe */
879 #define JTAG_IRLEN_MAX 60
880
881 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
882 {
883 struct scan_field field = {
884 .num_bits = num_idcode * 32,
885 .out_value = idcode_buffer,
886 .in_value = idcode_buffer,
887 };
888
889 // initialize to the end of chain ID value
890 for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
891 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
892
893 jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, TAP_DRPAUSE);
894 jtag_add_tlr();
895 return jtag_execute_queue();
896 }
897
898 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
899 {
900 uint8_t zero_check = 0x0;
901 uint8_t one_check = 0xff;
902
903 for (unsigned i = 0; i < count * 4; i++)
904 {
905 zero_check |= idcodes[i];
906 one_check &= idcodes[i];
907 }
908
909 /* if there wasn't a single non-zero bit or if all bits were one,
910 * the scan is not valid. We wrote a mix of both values; either
911 *
912 * - There's a hardware issue (almost certainly):
913 * + all-zeroes can mean a target stuck in JTAG reset
914 * + all-ones tends to mean no target
915 * - The scan chain is WAY longer than we can handle, *AND* either
916 * + there are several hundreds of TAPs in bypass, or
917 * + at least a few dozen TAPs all have an all-ones IDCODE
918 */
919 if (zero_check == 0x00 || one_check == 0xff)
920 {
921 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
922 (zero_check == 0x00) ? "zeroes" : "ones");
923 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
924 return false;
925 }
926 return true;
927 }
928
929 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
930 const char *name, uint32_t idcode)
931 {
932 log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
933 "JTAG tap: %s %16.16s: 0x%08x "
934 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
935 name, msg,
936 (unsigned int)idcode,
937 (unsigned int)EXTRACT_MFG(idcode),
938 (unsigned int)EXTRACT_PART(idcode),
939 (unsigned int)EXTRACT_VER(idcode));
940 }
941
942 static bool jtag_idcode_is_final(uint32_t idcode)
943 {
944 /*
945 * Some devices, such as AVR8, will output all 1's instead
946 * of TDI input value at end of chain. Allow those values
947 * instead of failing.
948 */
949 return idcode == END_OF_CHAIN_FLAG || idcode == 0xFFFFFFFF;
950 }
951
952 /**
953 * This helper checks that remaining bits in the examined chain data are
954 * all as expected, but a single JTAG device requires only 64 bits to be
955 * read back correctly. This can help identify and diagnose problems
956 * with the JTAG chain earlier, gives more helpful/explicit error messages.
957 * Returns TRUE iff garbage was found.
958 */
959 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
960 {
961 bool triggered = false;
962 for (; count < max - 31; count += 32)
963 {
964 uint32_t idcode = buf_get_u32(idcodes, count, 32);
965
966 /* do not trigger the warning if the data looks good */
967 if (jtag_idcode_is_final(idcode))
968 continue;
969 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
970 count, (unsigned int)idcode);
971 triggered = true;
972 }
973 return triggered;
974 }
975
976 static bool jtag_examine_chain_match_tap(const struct jtag_tap *tap)
977 {
978 uint32_t idcode = tap->idcode;
979
980 /* ignore expected BYPASS codes; warn otherwise */
981 if (0 == tap->expected_ids_cnt && !idcode)
982 return true;
983
984 /* optionally ignore the JTAG version field */
985 uint32_t mask = tap->ignore_version ? ~(0xff << 24) : ~0;
986
987 idcode &= mask;
988
989 /* Loop over the expected identification codes and test for a match */
990 unsigned ii, limit = tap->expected_ids_cnt;
991
992 for (ii = 0; ii < limit; ii++)
993 {
994 uint32_t expected = tap->expected_ids[ii] & mask;
995
996 if (idcode == expected)
997 return true;
998
999 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1000 if (0 == tap->expected_ids[ii])
1001 return true;
1002 }
1003
1004 /* If none of the expected ids matched, warn */
1005 jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
1006 tap->dotted_name, tap->idcode);
1007 for (ii = 0; ii < limit; ii++)
1008 {
1009 char msg[32];
1010
1011 snprintf(msg, sizeof(msg), "expected %u of %u", ii + 1, limit);
1012 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
1013 tap->dotted_name, tap->expected_ids[ii]);
1014 }
1015 return false;
1016 }
1017
1018 /* Try to examine chain layout according to IEEE 1149.1 §12
1019 * This is called a "blind interrogation" of the scan chain.
1020 */
1021 static int jtag_examine_chain(void)
1022 {
1023 uint8_t idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1024 unsigned bit_count;
1025 int retval;
1026 int tapcount = 0;
1027 bool autoprobe = false;
1028
1029 /* DR scan to collect BYPASS or IDCODE register contents.
1030 * Then make sure the scan data has both ones and zeroes.
1031 */
1032 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1033 retval = jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
1034 if (retval != ERROR_OK)
1035 return retval;
1036 if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
1037 return ERROR_JTAG_INIT_FAILED;
1038
1039 /* point at the 1st tap */
1040 struct jtag_tap *tap = jtag_tap_next_enabled(NULL);
1041
1042 if (!tap)
1043 autoprobe = true;
1044
1045 for (bit_count = 0;
1046 tap && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;
1047 tap = jtag_tap_next_enabled(tap))
1048 {
1049 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1050
1051 if ((idcode & 1) == 0)
1052 {
1053 /* Zero for LSB indicates a device in bypass */
1054 LOG_INFO("TAP %s does not have IDCODE",
1055 tap->dotted_name);
1056 idcode = 0;
1057 tap->hasidcode = false;
1058
1059 bit_count += 1;
1060 }
1061 else
1062 {
1063 /* Friendly devices support IDCODE */
1064 tap->hasidcode = true;
1065 jtag_examine_chain_display(LOG_LVL_INFO,
1066 "tap/device found",
1067 tap->dotted_name, idcode);
1068
1069 bit_count += 32;
1070 }
1071 tap->idcode = idcode;
1072
1073 /* ensure the TAP ID matches what was expected */
1074 if (!jtag_examine_chain_match_tap(tap))
1075 retval = ERROR_JTAG_INIT_SOFT_FAIL;
1076 }
1077
1078 /* Fail if too many TAPs were enabled for us to verify them all. */
1079 if (tap) {
1080 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1081 tap->dotted_name);
1082 return ERROR_JTAG_INIT_FAILED;
1083 }
1084
1085 /* if autoprobing, the tap list is still empty ... populate it! */
1086 while (autoprobe && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31) {
1087 uint32_t idcode;
1088 char buf[12];
1089
1090 /* Is there another TAP? */
1091 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1092 if (jtag_idcode_is_final(idcode))
1093 break;
1094
1095 /* Default everything in this TAP except IR length.
1096 *
1097 * REVISIT create a jtag_alloc(chip, tap) routine, and
1098 * share it with jim_newtap_cmd().
1099 */
1100 tap = calloc(1, sizeof *tap);
1101 if (!tap)
1102 return ERROR_FAIL;
1103
1104 sprintf(buf, "auto%d", tapcount++);
1105 tap->chip = strdup(buf);
1106 tap->tapname = strdup("tap");
1107
1108 sprintf(buf, "%s.%s", tap->chip, tap->tapname);
1109 tap->dotted_name = strdup(buf);
1110
1111 /* tap->ir_length == 0 ... signifying irlen autoprobe */
1112 tap->ir_capture_mask = 0x03;
1113 tap->ir_capture_value = 0x01;
1114
1115 tap->enabled = true;
1116
1117 if ((idcode & 1) == 0) {
1118 bit_count += 1;
1119 tap->hasidcode = false;
1120 } else {
1121 bit_count += 32;
1122 tap->hasidcode = true;
1123 tap->idcode = idcode;
1124
1125 tap->expected_ids_cnt = 1;
1126 tap->expected_ids = malloc(sizeof(uint32_t));
1127 tap->expected_ids[0] = idcode;
1128 }
1129
1130 LOG_WARNING("AUTO %s - use \"jtag newtap "
1131 "%s %s -expected-id 0x%8.8" PRIx32 " ...\"",
1132 tap->dotted_name, tap->chip, tap->tapname,
1133 tap->idcode);
1134
1135 jtag_tap_init(tap);
1136 }
1137
1138 /* After those IDCODE or BYPASS register values should be
1139 * only the data we fed into the scan chain.
1140 */
1141 if (jtag_examine_chain_end(idcode_buffer, bit_count,
1142 8 * sizeof(idcode_buffer))) {
1143 LOG_ERROR("double-check your JTAG setup (interface, "
1144 "speed, missing TAPs, ...)");
1145 return ERROR_JTAG_INIT_FAILED;
1146 }
1147
1148 /* Return success or, for backwards compatibility if only
1149 * some IDCODE values mismatched, a soft/continuable fault.
1150 */
1151 return retval;
1152 }
1153
1154 /*
1155 * Validate the date loaded by entry to the Capture-IR state, to help
1156 * find errors related to scan chain configuration (wrong IR lengths)
1157 * or communication.
1158 *
1159 * Entry state can be anything. On non-error exit, all TAPs are in
1160 * bypass mode. On error exits, the scan chain is reset.
1161 */
1162 static int jtag_validate_ircapture(void)
1163 {
1164 struct jtag_tap *tap;
1165 int total_ir_length = 0;
1166 uint8_t *ir_test = NULL;
1167 struct scan_field field;
1168 int val;
1169 int chain_pos = 0;
1170 int retval;
1171
1172 /* when autoprobing, accomodate huge IR lengths */
1173 for (tap = NULL, total_ir_length = 0;
1174 (tap = jtag_tap_next_enabled(tap)) != NULL;
1175 total_ir_length += tap->ir_length) {
1176 if (tap->ir_length == 0)
1177 total_ir_length += JTAG_IRLEN_MAX;
1178 }
1179
1180 /* increase length to add 2 bit sentinel after scan */
1181 total_ir_length += 2;
1182
1183 ir_test = malloc(DIV_ROUND_UP(total_ir_length, 8));
1184 if (ir_test == NULL)
1185 return ERROR_FAIL;
1186
1187 /* after this scan, all TAPs will capture BYPASS instructions */
1188 buf_set_ones(ir_test, total_ir_length);
1189
1190 field.num_bits = total_ir_length;
1191 field.out_value = ir_test;
1192 field.in_value = ir_test;
1193
1194 jtag_add_plain_ir_scan(field.num_bits, field.out_value, field.in_value, TAP_IDLE);
1195
1196 LOG_DEBUG("IR capture validation scan");
1197 retval = jtag_execute_queue();
1198 if (retval != ERROR_OK)
1199 goto done;
1200
1201 tap = NULL;
1202 chain_pos = 0;
1203
1204 for (;;) {
1205 tap = jtag_tap_next_enabled(tap);
1206 if (tap == NULL) {
1207 break;
1208 }
1209
1210 /* If we're autoprobing, guess IR lengths. They must be at
1211 * least two bits. Guessing will fail if (a) any TAP does
1212 * not conform to the JTAG spec; or (b) when the upper bits
1213 * captured from some conforming TAP are nonzero. Or if
1214 * (c) an IR length is longer than 32 bits -- which is only
1215 * an implementation limit, which could someday be raised.
1216 *
1217 * REVISIT optimization: if there's a *single* TAP we can
1218 * lift restrictions (a) and (b) by scanning a recognizable
1219 * pattern before the all-ones BYPASS. Check for where the
1220 * pattern starts in the result, instead of an 0...01 value.
1221 *
1222 * REVISIT alternative approach: escape to some tcl code
1223 * which could provide more knowledge, based on IDCODE; and
1224 * only guess when that has no success.
1225 */
1226 if (tap->ir_length == 0) {
1227 tap->ir_length = 2;
1228 while ((val = buf_get_u32(ir_test, chain_pos,
1229 tap->ir_length + 1)) == 1
1230 && tap->ir_length <= 32) {
1231 tap->ir_length++;
1232 }
1233 LOG_WARNING("AUTO %s - use \"... -irlen %d\"",
1234 jtag_tap_name(tap), tap->ir_length);
1235 }
1236
1237 /* Validate the two LSBs, which must be 01 per JTAG spec.
1238 *
1239 * Or ... more bits could be provided by TAP declaration.
1240 * Plus, some taps (notably in i.MX series chips) violate
1241 * this part of the JTAG spec, so their capture mask/value
1242 * attributes might disable this test.
1243 */
1244 val = buf_get_u32(ir_test, chain_pos, tap->ir_length);
1245 if ((val & tap->ir_capture_mask) != tap->ir_capture_value) {
1246 LOG_ERROR("%s: IR capture error; saw 0x%0*x not 0x%0*x",
1247 jtag_tap_name(tap),
1248 (tap->ir_length + 7) / tap->ir_length,
1249 val,
1250 (tap->ir_length + 7) / tap->ir_length,
1251 (unsigned) tap->ir_capture_value);
1252
1253 retval = ERROR_JTAG_INIT_FAILED;
1254 goto done;
1255 }
1256 LOG_DEBUG("%s: IR capture 0x%0*x", jtag_tap_name(tap),
1257 (tap->ir_length + 7) / tap->ir_length, val);
1258 chain_pos += tap->ir_length;
1259 }
1260
1261 /* verify the '11' sentinel we wrote is returned at the end */
1262 val = buf_get_u32(ir_test, chain_pos, 2);
1263 if (val != 0x3)
1264 {
1265 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1266
1267 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1268 chain_pos, cbuf);
1269 free(cbuf);
1270 retval = ERROR_JTAG_INIT_FAILED;
1271 }
1272
1273 done:
1274 free(ir_test);
1275 if (retval != ERROR_OK) {
1276 jtag_add_tlr();
1277 jtag_execute_queue();
1278 }
1279 return retval;
1280 }
1281
1282
1283 void jtag_tap_init(struct jtag_tap *tap)
1284 {
1285 unsigned ir_len_bits;
1286 unsigned ir_len_bytes;
1287
1288 /* if we're autoprobing, cope with potentially huge ir_length */
1289 ir_len_bits = tap->ir_length ? : JTAG_IRLEN_MAX;
1290 ir_len_bytes = DIV_ROUND_UP(ir_len_bits, 8);
1291
1292 tap->expected = calloc(1, ir_len_bytes);
1293 tap->expected_mask = calloc(1, ir_len_bytes);
1294 tap->cur_instr = malloc(ir_len_bytes);
1295
1296 /// @todo cope better with ir_length bigger than 32 bits
1297 if (ir_len_bits > 32)
1298 ir_len_bits = 32;
1299
1300 buf_set_u32(tap->expected, 0, ir_len_bits, tap->ir_capture_value);
1301 buf_set_u32(tap->expected_mask, 0, ir_len_bits, tap->ir_capture_mask);
1302
1303 // TAP will be in bypass mode after jtag_validate_ircapture()
1304 tap->bypass = 1;
1305 buf_set_ones(tap->cur_instr, tap->ir_length);
1306
1307 // register the reset callback for the TAP
1308 jtag_register_event_callback(&jtag_reset_callback, tap);
1309
1310 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1311 "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1312 tap->abs_chain_position, tap->ir_length,
1313 (unsigned) tap->ir_capture_value,
1314 (unsigned) tap->ir_capture_mask);
1315 jtag_tap_add(tap);
1316 }
1317
1318 void jtag_tap_free(struct jtag_tap *tap)
1319 {
1320 jtag_unregister_event_callback(&jtag_reset_callback, tap);
1321
1322 /// @todo is anything missing? no memory leaks please
1323 free((void *)tap->expected);
1324 free((void *)tap->expected_ids);
1325 free((void *)tap->chip);
1326 free((void *)tap->tapname);
1327 free((void *)tap->dotted_name);
1328 free(tap);
1329 }
1330
1331 /**
1332 * Do low-level setup like initializing registers, output signals,
1333 * and clocking.
1334 */
1335 int adapter_init(struct command_context *cmd_ctx)
1336 {
1337 if (jtag)
1338 return ERROR_OK;
1339
1340 if (!jtag_interface)
1341 {
1342 /* nothing was previously specified by "interface" command */
1343 LOG_ERROR("Debug Adapter has to be specified, "
1344 "see \"interface\" command");
1345 return ERROR_JTAG_INVALID_INTERFACE;
1346 }
1347
1348 jtag = jtag_interface;
1349 if (jtag_interface->init() != ERROR_OK)
1350 {
1351 jtag = NULL;
1352 return ERROR_JTAG_INIT_FAILED;
1353 }
1354
1355 /* LEGACY SUPPORT ... adapter drivers must declare what
1356 * transports they allow. Until they all do so, assume
1357 * the legacy drivers are JTAG-only
1358 */
1359 if (!transports_are_declared()) {
1360 static const char *jtag_only[] = { "jtag", NULL, };
1361 LOG_ERROR("Adapter driver '%s' did not declare "
1362 "which transports it allows; assuming"
1363 "JTAG-only", jtag->name);
1364 int retval = allow_transports(cmd_ctx, jtag_only);
1365 if (retval != ERROR_OK)
1366 return retval;
1367 }
1368
1369
1370 int requested_khz = jtag_get_speed_khz();
1371 int actual_khz = requested_khz;
1372 int retval = jtag_get_speed_readable(&actual_khz);
1373 if (ERROR_OK != retval)
1374 LOG_INFO("adapter-specific clock speed value %d", jtag_get_speed());
1375 else if (actual_khz)
1376 {
1377 /* Adaptive clocking -- JTAG-specific */
1378 if ((CLOCK_MODE_RCLK == clock_mode)
1379 || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
1380 {
1381 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1382 , actual_khz);
1383 }
1384 else
1385 LOG_INFO("clock speed %d kHz", actual_khz);
1386 }
1387 else
1388 LOG_INFO("RCLK (adaptive clock speed)");
1389
1390 return ERROR_OK;
1391 }
1392
1393 int jtag_init_inner(struct command_context *cmd_ctx)
1394 {
1395 struct jtag_tap *tap;
1396 int retval;
1397 bool issue_setup = true;
1398
1399 LOG_DEBUG("Init JTAG chain");
1400
1401 tap = jtag_tap_next_enabled(NULL);
1402 if (tap == NULL) {
1403 /* Once JTAG itself is properly set up, and the scan chain
1404 * isn't absurdly large, IDCODE autoprobe should work fine.
1405 *
1406 * But ... IRLEN autoprobe can fail even on systems which
1407 * are fully conformant to JTAG. Also, JTAG setup can be
1408 * quite finicky on some systems.
1409 *
1410 * REVISIT: if TAP autoprobe works OK, then in many cases
1411 * we could escape to tcl code and set up targets based on
1412 * the TAP's IDCODE values.
1413 */
1414 LOG_WARNING("There are no enabled taps. "
1415 "AUTO PROBING MIGHT NOT WORK!!");
1416
1417 /* REVISIT default clock will often be too fast ... */
1418 }
1419
1420 jtag_add_tlr();
1421 if ((retval = jtag_execute_queue()) != ERROR_OK)
1422 return retval;
1423
1424 /* Examine DR values first. This discovers problems which will
1425 * prevent communication ... hardware issues like TDO stuck, or
1426 * configuring the wrong number of (enabled) TAPs.
1427 */
1428 retval = jtag_examine_chain();
1429 switch (retval) {
1430 case ERROR_OK:
1431 /* complete success */
1432 break;
1433 case ERROR_JTAG_INIT_SOFT_FAIL:
1434 /* For backward compatibility reasons, try coping with
1435 * configuration errors involving only ID mismatches.
1436 * We might be able to talk to the devices.
1437 */
1438 LOG_ERROR("Trying to use configured scan chain anyway...");
1439 issue_setup = false;
1440 break;
1441 default:
1442 /* some hard error; already issued diagnostics */
1443 return retval;
1444 }
1445
1446 /* Now look at IR values. Problems here will prevent real
1447 * communication. They mostly mean that the IR length is
1448 * wrong ... or that the IR capture value is wrong. (The
1449 * latter is uncommon, but easily worked around: provide
1450 * ircapture/irmask values during TAP setup.)
1451 */
1452 retval = jtag_validate_ircapture();
1453 if (retval != ERROR_OK)
1454 return retval;
1455
1456 if (issue_setup)
1457 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1458 else
1459 LOG_WARNING("Bypassing JTAG setup events due to errors");
1460
1461
1462 return ERROR_OK;
1463 }
1464
1465 int adapter_quit(void)
1466 {
1467 if (!jtag || !jtag->quit)
1468 return ERROR_OK;
1469
1470 // close the JTAG interface
1471 int result = jtag->quit();
1472 if (ERROR_OK != result)
1473 LOG_ERROR("failed: %d", result);
1474
1475 return ERROR_OK;
1476 }
1477
1478
1479 int jtag_init_reset(struct command_context *cmd_ctx)
1480 {
1481 int retval;
1482
1483 if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
1484 return retval;
1485
1486 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1487
1488 /*
1489 * This procedure is used by default when OpenOCD triggers a reset.
1490 * It's now done through an overridable Tcl "init_reset" wrapper.
1491 *
1492 * This started out as a more powerful "get JTAG working" reset than
1493 * jtag_init_inner(), applying TRST because some chips won't activate
1494 * JTAG without a TRST cycle (presumed to be async, though some of
1495 * those chips synchronize JTAG activation using TCK).
1496 *
1497 * But some chips only activate JTAG as part of an SRST cycle; SRST
1498 * got mixed in. So it became a hard reset routine, which got used
1499 * in more places, and which coped with JTAG reset being forced as
1500 * part of SRST (srst_pulls_trst).
1501 *
1502 * And even more corner cases started to surface: TRST and/or SRST
1503 * assertion timings matter; some chips need other JTAG operations;
1504 * TRST/SRST sequences can need to be different from these, etc.
1505 *
1506 * Systems should override that wrapper to support system-specific
1507 * requirements that this not-fully-generic code doesn't handle.
1508 *
1509 * REVISIT once Tcl code can read the reset_config modes, this won't
1510 * need to be a C routine at all...
1511 */
1512 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1513 if (jtag_reset_config & RESET_HAS_SRST)
1514 {
1515 jtag_add_reset(1, 1);
1516 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1517 jtag_add_reset(0, 1);
1518 }
1519 jtag_add_reset(0, 0);
1520 if ((retval = jtag_execute_queue()) != ERROR_OK)
1521 return retval;
1522
1523 /* Check that we can communication on the JTAG chain + eventually we want to
1524 * be able to perform enumeration only after OpenOCD has started
1525 * telnet and GDB server
1526 *
1527 * That would allow users to more easily perform any magic they need to before
1528 * reset happens.
1529 */
1530 return jtag_init_inner(cmd_ctx);
1531 }
1532
1533 int jtag_init(struct command_context *cmd_ctx)
1534 {
1535 int retval;
1536
1537 if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
1538 return retval;
1539
1540 /* guard against oddball hardware: force resets to be inactive */
1541 jtag_add_reset(0, 0);
1542 if ((retval = jtag_execute_queue()) != ERROR_OK)
1543 return retval;
1544
1545 if (Jim_Eval_Named(cmd_ctx->interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1546 return ERROR_FAIL;
1547
1548 return ERROR_OK;
1549 }
1550
1551 unsigned jtag_get_speed_khz(void)
1552 {
1553 return speed_khz;
1554 }
1555
1556 static int adapter_khz_to_speed(unsigned khz, int* speed)
1557 {
1558 LOG_DEBUG("convert khz to interface specific speed value");
1559 speed_khz = khz;
1560 if (jtag != NULL)
1561 {
1562 LOG_DEBUG("have interface set up");
1563 int speed_div1;
1564 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1565 if (ERROR_OK != retval)
1566 {
1567 return retval;
1568 }
1569 *speed = speed_div1;
1570 }
1571 return ERROR_OK;
1572 }
1573
1574 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int* speed)
1575 {
1576 int retval = adapter_khz_to_speed(0, speed);
1577 if ((ERROR_OK != retval) && fallback_speed_khz)
1578 {
1579 LOG_DEBUG("trying fallback speed...");
1580 retval = adapter_khz_to_speed(fallback_speed_khz, speed);
1581 }
1582 return retval;
1583 }
1584
1585 static int jtag_set_speed(int speed)
1586 {
1587 jtag_speed = speed;
1588 /* this command can be called during CONFIG,
1589 * in which case jtag isn't initialized */
1590 return jtag ? jtag->speed(speed) : ERROR_OK;
1591 }
1592
1593 int jtag_config_khz(unsigned khz)
1594 {
1595 LOG_DEBUG("handle jtag khz");
1596 clock_mode = CLOCK_MODE_KHZ;
1597 int speed = 0;
1598 int retval = adapter_khz_to_speed(khz, &speed);
1599 return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1600 }
1601
1602 int jtag_config_rclk(unsigned fallback_speed_khz)
1603 {
1604 LOG_DEBUG("handle jtag rclk");
1605 clock_mode = CLOCK_MODE_RCLK;
1606 rclk_fallback_speed_khz = fallback_speed_khz;
1607 int speed = 0;
1608 int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1609 return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1610 }
1611
1612 int jtag_get_speed(void)
1613 {
1614 int speed;
1615 switch(clock_mode)
1616 {
1617 case CLOCK_MODE_SPEED:
1618 speed = jtag_speed;
1619 break;
1620 case CLOCK_MODE_KHZ:
1621 adapter_khz_to_speed(jtag_get_speed_khz(), &speed);
1622 break;
1623 case CLOCK_MODE_RCLK:
1624 jtag_rclk_to_speed(rclk_fallback_speed_khz, &speed);
1625 break;
1626 default:
1627 LOG_ERROR("BUG: unknown jtag clock mode");
1628 speed = 0;
1629 break;
1630 }
1631 return speed;
1632 }
1633
1634 int jtag_get_speed_readable(int *khz)
1635 {
1636 return jtag ? jtag->speed_div(jtag_get_speed(), khz) : ERROR_OK;
1637 }
1638
1639 void jtag_set_verify(bool enable)
1640 {
1641 jtag_verify = enable;
1642 }
1643
1644 bool jtag_will_verify()
1645 {
1646 return jtag_verify;
1647 }
1648
1649 void jtag_set_verify_capture_ir(bool enable)
1650 {
1651 jtag_verify_capture_ir = enable;
1652 }
1653
1654 bool jtag_will_verify_capture_ir()
1655 {
1656 return jtag_verify_capture_ir;
1657 }
1658
1659 int jtag_power_dropout(int *dropout)
1660 {
1661 if (jtag == NULL)
1662 {
1663 /* TODO: as the jtag interface is not valid all
1664 * we can do at the moment is exit OpenOCD */
1665 LOG_ERROR("No Valid JTAG Interface Configured.");
1666 exit(-1);
1667 }
1668 return jtag->power_dropout(dropout);
1669 }
1670
1671 int jtag_srst_asserted(int *srst_asserted)
1672 {
1673 return jtag->srst_asserted(srst_asserted);
1674 }
1675
1676 enum reset_types jtag_get_reset_config(void)
1677 {
1678 return jtag_reset_config;
1679 }
1680 void jtag_set_reset_config(enum reset_types type)
1681 {
1682 jtag_reset_config = type;
1683 }
1684
1685 int jtag_get_trst(void)
1686 {
1687 return jtag_trst;
1688 }
1689 int jtag_get_srst(void)
1690 {
1691 return jtag_srst;
1692 }
1693
1694 void jtag_set_nsrst_delay(unsigned delay)
1695 {
1696 adapter_nsrst_delay = delay;
1697 }
1698 unsigned jtag_get_nsrst_delay(void)
1699 {
1700 return adapter_nsrst_delay;
1701 }
1702 void jtag_set_ntrst_delay(unsigned delay)
1703 {
1704 jtag_ntrst_delay = delay;
1705 }
1706 unsigned jtag_get_ntrst_delay(void)
1707 {
1708 return jtag_ntrst_delay;
1709 }
1710
1711
1712 void jtag_set_nsrst_assert_width(unsigned delay)
1713 {
1714 adapter_nsrst_assert_width = delay;
1715 }
1716 unsigned jtag_get_nsrst_assert_width(void)
1717 {
1718 return adapter_nsrst_assert_width;
1719 }
1720 void jtag_set_ntrst_assert_width(unsigned delay)
1721 {
1722 jtag_ntrst_assert_width = delay;
1723 }
1724 unsigned jtag_get_ntrst_assert_width(void)
1725 {
1726 return jtag_ntrst_assert_width;
1727 }
1728
1729 static int jtag_select(struct command_context *ctx)
1730 {
1731 int retval;
1732
1733 /* NOTE: interface init must already have been done.
1734 * That works with only C code ... no Tcl glue required.
1735 */
1736
1737
1738 retval = jtag_register_commands(ctx);
1739
1740 if (retval != ERROR_OK)
1741 return retval;
1742
1743 retval = svf_register_commands(ctx);
1744
1745 if (retval != ERROR_OK)
1746 return retval;
1747
1748 return xsvf_register_commands(ctx);
1749 }
1750
1751 static struct transport jtag_transport = {
1752 .name = "jtag",
1753 .select = jtag_select,
1754 .init = jtag_init,
1755 };
1756
1757 static void jtag_constructor(void) __attribute__((constructor));
1758 static void jtag_constructor(void)
1759 {
1760 transport_register(&jtag_transport);
1761 }
1762
1763 /** Returns true if the current debug session
1764 * is using JTAG as its transport.
1765 */
1766 bool transport_is_jtag(void)
1767 {
1768 return get_current_transport() == &jtag_transport;
1769 }