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