1 /***************************************************************************
2 * Copyright (C) 2009 Zachary T Welch *
3 * zw@superlucidity.net *
5 * Copyright (C) 2007,2008,2009 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2005 by Dominic Rath *
13 * Dominic.Rath@gmx.de *
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. *
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. *
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 ***************************************************************************/
35 #include "interface.h"
36 #include <transport/transport.h>
42 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
44 #include "xsvf/xsvf.h"
46 /// The number of JTAG queue flushes (for profiling and debugging purposes).
47 static int jtag_flush_queue_count
;
49 // Sleep this # of ms after flushing the queue
50 static int jtag_flush_queue_sleep
= 0;
52 static void jtag_add_scan_check(struct jtag_tap
*active
,
53 void (*jtag_add_scan
)(struct jtag_tap
*active
, int in_num_fields
, const struct scan_field
*in_fields
, tap_state_t state
),
54 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
);
57 * The jtag_error variable is set when an error occurs while executing
58 * the queue. Application code may set this using jtag_set_error(),
59 * when an error occurs during processing that should be reported during
60 * jtag_execute_queue().
62 * The value is set and cleared, but never read by normal application code.
64 * This value is returned (and cleared) by jtag_execute_queue().
66 static int jtag_error
= ERROR_OK
;
68 static const char *jtag_event_strings
[] =
70 [JTAG_TRST_ASSERTED
] = "TAP reset",
71 [JTAG_TAP_EVENT_SETUP
] = "TAP setup",
72 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
73 [JTAG_TAP_EVENT_DISABLE
] = "TAP disabled",
77 * JTAG adapters must initialize with TRST and SRST de-asserted
78 * (they're negative logic, so that means *high*). But some
79 * hardware doesn't necessarily work that way ... so set things
80 * up so that jtag_init() always forces that state.
82 static int jtag_trst
= -1;
83 static int jtag_srst
= -1;
86 * List all TAPs that have been created.
88 static struct jtag_tap
*__jtag_all_taps
= NULL
;
90 * The number of TAPs in the __jtag_all_taps list, used to track the
91 * assigned chain position to new TAPs
93 static unsigned jtag_num_taps
= 0;
95 static enum reset_types jtag_reset_config
= RESET_NONE
;
96 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
98 static bool jtag_verify_capture_ir
= true;
99 static int jtag_verify
= 1;
101 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
102 static int adapter_nsrst_delay
= 0; /* default to no nSRST delay */
103 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
104 static int adapter_nsrst_assert_width
= 0; /* width of assertion */
105 static int jtag_ntrst_assert_width
= 0; /* width of assertion */
108 * Contains a single callback along with a pointer that will be passed
109 * when an event occurs.
111 struct jtag_event_callback
{
113 jtag_event_handler_t callback
;
114 /// the private data to pass to the callback
116 /// the next callback
117 struct jtag_event_callback
* next
;
120 /* callbacks to inform high-level handlers about JTAG state changes */
121 static struct jtag_event_callback
*jtag_event_callbacks
;
124 static int speed_khz
= 0;
125 /* speed to fallback to when RCLK is requested but not supported */
126 static int rclk_fallback_speed_khz
= 0;
127 static enum {CLOCK_MODE_UNSELECTED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
128 static int jtag_speed
= 0;
130 static struct jtag_interface
*jtag
= NULL
;
133 const struct swd_driver
*swd
= NULL
;
136 struct jtag_interface
*jtag_interface
= NULL
;
138 void jtag_set_flush_queue_sleep(int ms
)
140 jtag_flush_queue_sleep
= ms
;
143 void jtag_set_error(int error
)
145 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
150 int jtag_error_clear(void)
152 int temp
= jtag_error
;
153 jtag_error
= ERROR_OK
;
159 static bool jtag_poll
= 1;
161 bool is_jtag_poll_safe(void)
163 /* Polling can be disabled explicitly with set_enabled(false).
164 * It is also implicitly disabled while TRST is active and
165 * while SRST is gating the JTAG clock.
167 if (!jtag_poll
|| jtag_trst
!= 0)
169 return jtag_srst
== 0 || (jtag_reset_config
& RESET_SRST_NO_GATING
);
172 bool jtag_poll_get_enabled(void)
177 void jtag_poll_set_enabled(bool value
)
184 struct jtag_tap
*jtag_all_taps(void)
186 return __jtag_all_taps
;
189 unsigned jtag_tap_count(void)
191 return jtag_num_taps
;
194 unsigned jtag_tap_count_enabled(void)
196 struct jtag_tap
*t
= jtag_all_taps();
207 /// Append a new TAP to the chain of all taps.
208 void jtag_tap_add(struct jtag_tap
*t
)
210 t
->abs_chain_position
= jtag_num_taps
++;
212 struct jtag_tap
**tap
= &__jtag_all_taps
;
214 tap
= &(*tap
)->next_tap
;
218 /* returns a pointer to the n-th device in the scan chain */
219 struct jtag_tap
*jtag_tap_by_position(unsigned n
)
221 struct jtag_tap
*t
= jtag_all_taps();
229 struct jtag_tap
*jtag_tap_by_string(const char *s
)
231 /* try by name first */
232 struct jtag_tap
*t
= jtag_all_taps();
236 if (0 == strcmp(t
->dotted_name
, s
))
241 /* no tap found by name, so try to parse the name as a number */
243 if (parse_uint(s
, &n
) != ERROR_OK
)
246 /* FIXME remove this numeric fallback code late June 2010, along
247 * with all info in the User's Guide that TAPs have numeric IDs.
248 * Also update "scan_chain" output to not display the numbers.
250 t
= jtag_tap_by_position(n
);
252 LOG_WARNING("Specify TAP '%s' by name, not number %u",
258 struct jtag_tap
* jtag_tap_next_enabled(struct jtag_tap
* p
)
260 p
= p
? p
->next_tap
: jtag_all_taps();
270 const char *jtag_tap_name(const struct jtag_tap
*tap
)
272 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
276 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
278 struct jtag_event_callback
**callbacks_p
= &jtag_event_callbacks
;
280 if (callback
== NULL
)
282 return ERROR_INVALID_ARGUMENTS
;
287 while ((*callbacks_p
)->next
)
288 callbacks_p
= &((*callbacks_p
)->next
);
289 callbacks_p
= &((*callbacks_p
)->next
);
292 (*callbacks_p
) = malloc(sizeof(struct jtag_event_callback
));
293 (*callbacks_p
)->callback
= callback
;
294 (*callbacks_p
)->priv
= priv
;
295 (*callbacks_p
)->next
= NULL
;
300 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
302 struct jtag_event_callback
**p
= &jtag_event_callbacks
, *temp
;
304 if (callback
== NULL
)
306 return ERROR_INVALID_ARGUMENTS
;
311 if (((*p
)->priv
!= priv
) || ((*p
)->callback
!= callback
))
325 int jtag_call_event_callbacks(enum jtag_event event
)
327 struct jtag_event_callback
*callback
= jtag_event_callbacks
;
329 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
333 struct jtag_event_callback
*next
;
335 /* callback may remove itself */
336 next
= callback
->next
;
337 callback
->callback(event
, callback
->priv
);
344 static void jtag_checks(void)
346 assert(jtag_trst
== 0);
349 static void jtag_prelude(tap_state_t state
)
353 assert(state
!= TAP_INVALID
);
355 cmd_queue_cur_state
= state
;
358 void jtag_add_ir_scan_noverify(struct jtag_tap
*active
, const struct scan_field
*in_fields
,
363 int retval
= interface_jtag_add_ir_scan(active
, in_fields
, state
);
364 jtag_set_error(retval
);
367 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap
*active
, int dummy
, const struct scan_field
*in_fields
,
370 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
373 /* If fields->in_value is filled out, then the captured IR value will be checked */
374 void jtag_add_ir_scan(struct jtag_tap
*active
, struct scan_field
*in_fields
, tap_state_t state
)
376 assert(state
!= TAP_RESET
);
378 if (jtag_verify
&& jtag_verify_capture_ir
)
380 /* 8 x 32 bit id's is enough for all invocations */
382 /* if we are to run a verification of the ir scan, we need to get the input back.
383 * We may have to allocate space if the caller didn't ask for the input back.
385 in_fields
->check_value
= active
->expected
;
386 in_fields
->check_mask
= active
->expected_mask
;
387 jtag_add_scan_check(active
, jtag_add_ir_scan_noverify_callback
, 1, in_fields
, state
);
390 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
394 void jtag_add_plain_ir_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
397 assert(out_bits
!= NULL
);
398 assert(state
!= TAP_RESET
);
402 int retval
= interface_jtag_add_plain_ir_scan(
403 num_bits
, out_bits
, in_bits
, state
);
404 jtag_set_error(retval
);
407 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
408 uint8_t *in_check_mask
, int num_bits
);
410 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
)
412 return jtag_check_value_inner((uint8_t *)data0
, (uint8_t *)data1
, (uint8_t *)data2
, (int)data3
);
415 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
),
416 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
)
418 jtag_add_scan(active
, in_num_fields
, in_fields
, state
);
420 for (int i
= 0; i
< in_num_fields
; i
++)
422 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
424 /* this is synchronous for a minidriver */
425 jtag_add_callback4(jtag_check_value_mask_callback
, (jtag_callback_data_t
)in_fields
[i
].in_value
,
426 (jtag_callback_data_t
)in_fields
[i
].check_value
,
427 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
428 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
433 void jtag_add_dr_scan_check(struct jtag_tap
*active
, int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
)
437 jtag_add_scan_check(active
, jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
440 jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
445 void jtag_add_dr_scan(struct jtag_tap
*active
, int in_num_fields
, const struct scan_field
*in_fields
,
448 assert(state
!= TAP_RESET
);
453 retval
= interface_jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
454 jtag_set_error(retval
);
457 void jtag_add_plain_dr_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
460 assert(out_bits
!= NULL
);
461 assert(state
!= TAP_RESET
);
466 retval
= interface_jtag_add_plain_dr_scan(num_bits
, out_bits
, in_bits
, state
);
467 jtag_set_error(retval
);
470 void jtag_add_tlr(void)
472 jtag_prelude(TAP_RESET
);
473 jtag_set_error(interface_jtag_add_tlr());
475 /* NOTE: order here matches TRST path in jtag_add_reset() */
476 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
477 jtag_notify_event(JTAG_TRST_ASSERTED
);
481 * If supported by the underlying adapter, this clocks a raw bit sequence
482 * onto TMS for switching betwen JTAG and SWD modes.
484 * DO NOT use this to bypass the integrity checks and logging provided
485 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
487 * @param nbits How many bits to clock out.
488 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
489 * @param state The JTAG tap state to record on completion. Use
490 * TAP_INVALID to represent being in in SWD mode.
492 * @todo Update naming conventions to stop assuming everything is JTAG.
494 int jtag_add_tms_seq(unsigned nbits
, const uint8_t *seq
, enum tap_state state
)
498 if (!(jtag
->supported
& DEBUG_CAP_TMS_SEQ
))
499 return ERROR_JTAG_NOT_IMPLEMENTED
;
502 cmd_queue_cur_state
= state
;
504 retval
= interface_add_tms_seq(nbits
, seq
, state
);
505 jtag_set_error(retval
);
509 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
511 tap_state_t cur_state
= cmd_queue_cur_state
;
513 /* the last state has to be a stable state */
514 if (!tap_is_state_stable(path
[num_states
- 1]))
516 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
517 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
521 for (int i
= 0; i
< num_states
; i
++)
523 if (path
[i
] == TAP_RESET
)
525 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
526 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
530 if (tap_state_transition(cur_state
, true) != path
[i
]
531 && tap_state_transition(cur_state
, false) != path
[i
])
533 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
534 tap_state_name(cur_state
), tap_state_name(path
[i
]));
535 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
543 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
544 cmd_queue_cur_state
= path
[num_states
- 1];
547 int jtag_add_statemove(tap_state_t goal_state
)
549 tap_state_t cur_state
= cmd_queue_cur_state
;
551 if (goal_state
!= cur_state
)
553 LOG_DEBUG("cur_state=%s goal_state=%s",
554 tap_state_name(cur_state
),
555 tap_state_name(goal_state
));
558 /* If goal is RESET, be paranoid and force that that transition
559 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
561 if (goal_state
== TAP_RESET
)
563 else if (goal_state
== cur_state
)
564 /* nothing to do */ ;
566 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
))
568 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
569 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
570 tap_state_t moves
[8];
571 assert(tms_count
< ARRAY_SIZE(moves
));
573 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1)
575 bool bit
= tms_bits
& 1;
577 cur_state
= tap_state_transition(cur_state
, bit
);
578 moves
[i
] = cur_state
;
581 jtag_add_pathmove(tms_count
, moves
);
583 else if (tap_state_transition(cur_state
, true) == goal_state
584 || tap_state_transition(cur_state
, false) == goal_state
)
586 jtag_add_pathmove(1, &goal_state
);
595 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
598 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
602 void jtag_add_clocks(int num_cycles
)
604 if (!tap_is_state_stable(cmd_queue_cur_state
))
606 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
607 tap_state_name(cmd_queue_cur_state
));
608 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
615 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
619 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
621 int trst_with_tlr
= 0;
625 /* Without SRST, we must use target-specific JTAG operations
626 * on each target; callers should not be requesting SRST when
627 * that signal doesn't exist.
629 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
630 * can kick in even if the JTAG adapter can't drive TRST.
633 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
634 LOG_ERROR("BUG: can't assert SRST");
635 jtag_set_error(ERROR_FAIL
);
638 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
639 && !req_tlr_or_trst
) {
640 LOG_ERROR("BUG: can't assert only SRST");
641 jtag_set_error(ERROR_FAIL
);
647 /* JTAG reset (entry to TAP_RESET state) can always be achieved
648 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
649 * state first. TRST accelerates it, and bypasses those states.
651 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
652 * can kick in even if the JTAG adapter can't drive SRST.
654 if (req_tlr_or_trst
) {
655 if (!(jtag_reset_config
& RESET_HAS_TRST
))
657 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
664 /* Maybe change TRST and/or SRST signal state */
665 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
668 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
669 if (retval
!= ERROR_OK
)
670 jtag_set_error(retval
);
672 retval
= jtag_execute_queue();
674 if (retval
!= ERROR_OK
) {
675 LOG_ERROR("TRST/SRST error");
680 /* SRST resets everything hooked up to that signal */
681 if (jtag_srst
!= new_srst
) {
682 jtag_srst
= new_srst
;
685 LOG_DEBUG("SRST line asserted");
686 if (adapter_nsrst_assert_width
)
687 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
690 LOG_DEBUG("SRST line released");
691 if (adapter_nsrst_delay
)
692 jtag_add_sleep(adapter_nsrst_delay
* 1000);
696 /* Maybe enter the JTAG TAP_RESET state ...
697 * - using only TMS, TCK, and the JTAG state machine
698 * - or else more directly, using TRST
700 * TAP_RESET should be invisible to non-debug parts of the system.
703 LOG_DEBUG("JTAG reset with TLR instead of TRST");
706 } else if (jtag_trst
!= new_trst
) {
707 jtag_trst
= new_trst
;
709 LOG_DEBUG("TRST line asserted");
710 tap_set_state(TAP_RESET
);
711 if (jtag_ntrst_assert_width
)
712 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
714 LOG_DEBUG("TRST line released");
715 if (jtag_ntrst_delay
)
716 jtag_add_sleep(jtag_ntrst_delay
* 1000);
718 /* We just asserted nTRST, so we're now in TAP_RESET.
719 * Inform possible listeners about this, now that
720 * JTAG instructions and data can be shifted. This
721 * sequence must match jtag_add_tlr().
723 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
724 jtag_notify_event(JTAG_TRST_ASSERTED
);
729 void jtag_add_sleep(uint32_t us
)
731 /// @todo Here, keep_alive() appears to be a layering violation!!!
733 jtag_set_error(interface_jtag_add_sleep(us
));
736 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
737 uint8_t *in_check_mask
, int num_bits
)
739 int retval
= ERROR_OK
;
743 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
745 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
747 if (compare_failed
) {
748 char *captured_str
, *in_check_value_str
;
749 int bits
= (num_bits
> DEBUG_JTAG_IOZ
)
753 /* NOTE: we've lost diagnostic context here -- 'which tap' */
755 captured_str
= buf_to_str(captured
, bits
, 16);
756 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
758 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
760 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
763 free(in_check_value_str
);
766 char *in_check_mask_str
;
768 in_check_mask_str
= buf_to_str(in_check_mask
, bits
, 16);
769 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
770 free(in_check_mask_str
);
773 retval
= ERROR_JTAG_QUEUE_FAILED
;
778 void jtag_check_value_mask(struct scan_field
*field
, uint8_t *value
, uint8_t *mask
)
780 assert(field
->in_value
!= NULL
);
784 /* no checking to do */
788 jtag_execute_queue_noclear();
790 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
791 jtag_set_error(retval
);
796 int default_interface_jtag_execute_queue(void)
800 LOG_ERROR("No JTAG interface configured yet. "
801 "Issue 'init' command in startup scripts "
802 "before communicating with targets.");
806 return jtag
->execute_queue();
809 void jtag_execute_queue_noclear(void)
811 jtag_flush_queue_count
++;
812 jtag_set_error(interface_jtag_execute_queue());
814 if (jtag_flush_queue_sleep
> 0)
816 /* For debug purposes it can be useful to test performance
817 * or behavior when delaying after flushing the queue,
818 * e.g. to simulate long roundtrip times.
820 usleep(jtag_flush_queue_sleep
* 1000);
824 int jtag_get_flush_queue_count(void)
826 return jtag_flush_queue_count
;
829 int jtag_execute_queue(void)
831 jtag_execute_queue_noclear();
832 return jtag_error_clear();
835 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
837 struct jtag_tap
*tap
= priv
;
839 if (event
== JTAG_TRST_ASSERTED
)
841 tap
->enabled
= !tap
->disabled_after_reset
;
843 /* current instruction is either BYPASS or IDCODE */
844 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
851 /* sleep at least us microseconds. When we sleep more than 1000ms we
852 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
853 * GDB if we slept for <1000ms many times.
855 void jtag_sleep(uint32_t us
)
860 alive_sleep((us
+999)/1000);
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.
867 #define JTAG_MAX_CHAIN_SIZE 20
869 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
870 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
871 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
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.
876 #define END_OF_CHAIN_FLAG 0x000000ff
878 /* a larger IR length than we ever expect to autoprobe */
879 #define JTAG_IRLEN_MAX 60
881 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
883 struct scan_field field
= {
884 .num_bits
= num_idcode
* 32,
885 .out_value
= idcode_buffer
,
886 .in_value
= idcode_buffer
,
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
);
893 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
895 return jtag_execute_queue();
898 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
900 uint8_t zero_check
= 0x0;
901 uint8_t one_check
= 0xff;
903 for (unsigned i
= 0; i
< count
* 4; i
++)
905 zero_check
|= idcodes
[i
];
906 one_check
&= idcodes
[i
];
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
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
919 if (zero_check
== 0x00 || one_check
== 0xff)
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.");
929 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
930 const char *name
, uint32_t idcode
)
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)",
936 (unsigned int)idcode
,
937 (unsigned int)EXTRACT_MFG(idcode
),
938 (unsigned int)EXTRACT_PART(idcode
),
939 (unsigned int)EXTRACT_VER(idcode
));
942 static bool jtag_idcode_is_final(uint32_t idcode
)
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.
949 return idcode
== END_OF_CHAIN_FLAG
|| idcode
== 0xFFFFFFFF;
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.
959 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
961 bool triggered
= false;
962 for (; count
< max
- 31; count
+= 32)
964 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
966 /* do not trigger the warning if the data looks good */
967 if (jtag_idcode_is_final(idcode
))
969 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
970 count
, (unsigned int)idcode
);
976 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
978 uint32_t idcode
= tap
->idcode
;
980 /* ignore expected BYPASS codes; warn otherwise */
981 if (0 == tap
->expected_ids_cnt
&& !idcode
)
984 /* optionally ignore the JTAG version field */
985 uint32_t mask
= tap
->ignore_version
? ~(0xff << 24) : ~0;
989 /* Loop over the expected identification codes and test for a match */
990 unsigned ii
, limit
= tap
->expected_ids_cnt
;
992 for (ii
= 0; ii
< limit
; ii
++)
994 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
996 if (idcode
== expected
)
999 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1000 if (0 == tap
->expected_ids
[ii
])
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
++)
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
]);
1018 /* Try to examine chain layout according to IEEE 1149.1 §12
1019 * This is called a "blind interrogation" of the scan chain.
1021 static int jtag_examine_chain(void)
1023 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1027 bool autoprobe
= false;
1029 /* DR scan to collect BYPASS or IDCODE register contents.
1030 * Then make sure the scan data has both ones and zeroes.
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
)
1036 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1037 return ERROR_JTAG_INIT_FAILED
;
1039 /* point at the 1st tap */
1040 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1046 tap
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;
1047 tap
= jtag_tap_next_enabled(tap
))
1049 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1051 if ((idcode
& 1) == 0)
1053 /* Zero for LSB indicates a device in bypass */
1054 LOG_INFO("TAP %s does not have IDCODE",
1057 tap
->hasidcode
= false;
1063 /* Friendly devices support IDCODE */
1064 tap
->hasidcode
= true;
1065 jtag_examine_chain_display(LOG_LVL_INFO
,
1067 tap
->dotted_name
, idcode
);
1071 tap
->idcode
= idcode
;
1073 /* ensure the TAP ID matches what was expected */
1074 if (!jtag_examine_chain_match_tap(tap
))
1075 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1078 /* Fail if too many TAPs were enabled for us to verify them all. */
1080 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1082 return ERROR_JTAG_INIT_FAILED
;
1085 /* if autoprobing, the tap list is still empty ... populate it! */
1086 while (autoprobe
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31) {
1090 /* Is there another TAP? */
1091 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1092 if (jtag_idcode_is_final(idcode
))
1095 /* Default everything in this TAP except IR length.
1097 * REVISIT create a jtag_alloc(chip, tap) routine, and
1098 * share it with jim_newtap_cmd().
1100 tap
= calloc(1, sizeof *tap
);
1104 sprintf(buf
, "auto%d", tapcount
++);
1105 tap
->chip
= strdup(buf
);
1106 tap
->tapname
= strdup("tap");
1108 sprintf(buf
, "%s.%s", tap
->chip
, tap
->tapname
);
1109 tap
->dotted_name
= strdup(buf
);
1111 /* tap->ir_length == 0 ... signifying irlen autoprobe */
1112 tap
->ir_capture_mask
= 0x03;
1113 tap
->ir_capture_value
= 0x01;
1115 tap
->enabled
= true;
1117 if ((idcode
& 1) == 0) {
1119 tap
->hasidcode
= false;
1122 tap
->hasidcode
= true;
1123 tap
->idcode
= idcode
;
1125 tap
->expected_ids_cnt
= 1;
1126 tap
->expected_ids
= malloc(sizeof(uint32_t));
1127 tap
->expected_ids
[0] = idcode
;
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
,
1138 /* After those IDCODE or BYPASS register values should be
1139 * only the data we fed into the scan chain.
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
;
1148 /* Return success or, for backwards compatibility if only
1149 * some IDCODE values mismatched, a soft/continuable fault.
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)
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.
1162 static int jtag_validate_ircapture(void)
1164 struct jtag_tap
*tap
;
1165 int total_ir_length
= 0;
1166 uint8_t *ir_test
= NULL
;
1167 struct scan_field field
;
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
;
1180 /* increase length to add 2 bit sentinel after scan */
1181 total_ir_length
+= 2;
1183 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1184 if (ir_test
== NULL
)
1187 /* after this scan, all TAPs will capture BYPASS instructions */
1188 buf_set_ones(ir_test
, total_ir_length
);
1190 field
.num_bits
= total_ir_length
;
1191 field
.out_value
= ir_test
;
1192 field
.in_value
= ir_test
;
1194 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1196 LOG_DEBUG("IR capture validation scan");
1197 retval
= jtag_execute_queue();
1198 if (retval
!= ERROR_OK
)
1205 tap
= jtag_tap_next_enabled(tap
);
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.
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.
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.
1226 if (tap
->ir_length
== 0) {
1228 while ((val
= buf_get_u32(ir_test
, chain_pos
,
1229 tap
->ir_length
+ 1)) == 1
1230 && tap
->ir_length
<= 32) {
1233 LOG_WARNING("AUTO %s - use \"... -irlen %d\"",
1234 jtag_tap_name(tap
), tap
->ir_length
);
1237 /* Validate the two LSBs, which must be 01 per JTAG spec.
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.
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",
1248 (tap
->ir_length
+ 7) / tap
->ir_length
,
1250 (tap
->ir_length
+ 7) / tap
->ir_length
,
1251 (unsigned) tap
->ir_capture_value
);
1253 retval
= ERROR_JTAG_INIT_FAILED
;
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
;
1261 /* verify the '11' sentinel we wrote is returned at the end */
1262 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1265 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1267 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1270 retval
= ERROR_JTAG_INIT_FAILED
;
1275 if (retval
!= ERROR_OK
) {
1277 jtag_execute_queue();
1283 void jtag_tap_init(struct jtag_tap
*tap
)
1285 unsigned ir_len_bits
;
1286 unsigned ir_len_bytes
;
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);
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
);
1296 /// @todo cope better with ir_length bigger than 32 bits
1297 if (ir_len_bits
> 32)
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
);
1303 // TAP will be in bypass mode after jtag_validate_ircapture()
1305 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1307 // register the reset callback for the TAP
1308 jtag_register_event_callback(&jtag_reset_callback
, tap
);
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
);
1318 void jtag_tap_free(struct jtag_tap
*tap
)
1320 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
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
);
1332 * Do low-level setup like initializing registers, output signals,
1335 int adapter_init(struct command_context
*cmd_ctx
)
1340 if (!jtag_interface
)
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
;
1349 retval
= jtag_interface
->init();
1350 if (retval
!= ERROR_OK
)
1354 jtag
= jtag_interface
;
1356 /* LEGACY SUPPORT ... adapter drivers must declare what
1357 * transports they allow. Until they all do so, assume
1358 * the legacy drivers are JTAG-only
1360 if (!transports_are_declared()) {
1361 LOG_ERROR("Adapter driver '%s' did not declare "
1362 "which transports it allows; assuming "
1363 "JTAG-only", jtag
->name
);
1364 retval
= allow_transports(cmd_ctx
, jtag_only
);
1365 if (retval
!= ERROR_OK
)
1369 if (CLOCK_MODE_UNSELECTED
== clock_mode
)
1371 LOG_ERROR("An adapter speed is not selected in the init script."
1372 " Insert a call to adapter_khz or jtag_rclk to proceed.");
1373 return ERROR_JTAG_INIT_FAILED
;
1376 int requested_khz
= jtag_get_speed_khz();
1377 int actual_khz
= requested_khz
;
1378 int jtag_speed_var
= 0;
1379 retval
= jtag_get_speed(&jtag_speed_var
);
1380 if (retval
!= ERROR_OK
)
1382 retval
= jtag
->speed(jtag_speed_var
);
1383 if (retval
!= ERROR_OK
)
1385 retval
= jtag_get_speed_readable(&actual_khz
);
1386 if (ERROR_OK
!= retval
)
1387 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1388 else if (actual_khz
)
1390 /* Adaptive clocking -- JTAG-specific */
1391 if ((CLOCK_MODE_RCLK
== clock_mode
)
1392 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
))
1394 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1398 LOG_INFO("clock speed %d kHz", actual_khz
);
1401 LOG_INFO("RCLK (adaptive clock speed)");
1406 int jtag_init_inner(struct command_context
*cmd_ctx
)
1408 struct jtag_tap
*tap
;
1410 bool issue_setup
= true;
1412 LOG_DEBUG("Init JTAG chain");
1414 tap
= jtag_tap_next_enabled(NULL
);
1416 /* Once JTAG itself is properly set up, and the scan chain
1417 * isn't absurdly large, IDCODE autoprobe should work fine.
1419 * But ... IRLEN autoprobe can fail even on systems which
1420 * are fully conformant to JTAG. Also, JTAG setup can be
1421 * quite finicky on some systems.
1423 * REVISIT: if TAP autoprobe works OK, then in many cases
1424 * we could escape to tcl code and set up targets based on
1425 * the TAP's IDCODE values.
1427 LOG_WARNING("There are no enabled taps. "
1428 "AUTO PROBING MIGHT NOT WORK!!");
1430 /* REVISIT default clock will often be too fast ... */
1434 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1437 /* Examine DR values first. This discovers problems which will
1438 * prevent communication ... hardware issues like TDO stuck, or
1439 * configuring the wrong number of (enabled) TAPs.
1441 retval
= jtag_examine_chain();
1444 /* complete success */
1447 /* For backward compatibility reasons, try coping with
1448 * configuration errors involving only ID mismatches.
1449 * We might be able to talk to the devices.
1451 * Also the device might be powered down during startup.
1453 * After OpenOCD starts, we can try to power on the device
1456 LOG_ERROR("Trying to use configured scan chain anyway...");
1457 issue_setup
= false;
1461 /* Now look at IR values. Problems here will prevent real
1462 * communication. They mostly mean that the IR length is
1463 * wrong ... or that the IR capture value is wrong. (The
1464 * latter is uncommon, but easily worked around: provide
1465 * ircapture/irmask values during TAP setup.)
1467 retval
= jtag_validate_ircapture();
1468 if (retval
!= ERROR_OK
)
1470 /* The target might be powered down. The user
1471 * can power it up and reset it after firing
1474 issue_setup
= false;
1478 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1480 LOG_WARNING("Bypassing JTAG setup events due to errors");
1486 int adapter_quit(void)
1488 if (!jtag
|| !jtag
->quit
)
1491 // close the JTAG interface
1492 int result
= jtag
->quit();
1493 if (ERROR_OK
!= result
)
1494 LOG_ERROR("failed: %d", result
);
1500 int jtag_init_reset(struct command_context
*cmd_ctx
)
1504 if ((retval
= adapter_init(cmd_ctx
)) != ERROR_OK
)
1507 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1510 * This procedure is used by default when OpenOCD triggers a reset.
1511 * It's now done through an overridable Tcl "init_reset" wrapper.
1513 * This started out as a more powerful "get JTAG working" reset than
1514 * jtag_init_inner(), applying TRST because some chips won't activate
1515 * JTAG without a TRST cycle (presumed to be async, though some of
1516 * those chips synchronize JTAG activation using TCK).
1518 * But some chips only activate JTAG as part of an SRST cycle; SRST
1519 * got mixed in. So it became a hard reset routine, which got used
1520 * in more places, and which coped with JTAG reset being forced as
1521 * part of SRST (srst_pulls_trst).
1523 * And even more corner cases started to surface: TRST and/or SRST
1524 * assertion timings matter; some chips need other JTAG operations;
1525 * TRST/SRST sequences can need to be different from these, etc.
1527 * Systems should override that wrapper to support system-specific
1528 * requirements that this not-fully-generic code doesn't handle.
1530 * REVISIT once Tcl code can read the reset_config modes, this won't
1531 * need to be a C routine at all...
1533 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1534 if (jtag_reset_config
& RESET_HAS_SRST
)
1536 jtag_add_reset(1, 1);
1537 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1538 jtag_add_reset(0, 1);
1540 jtag_add_reset(0, 0);
1541 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1544 /* Check that we can communication on the JTAG chain + eventually we want to
1545 * be able to perform enumeration only after OpenOCD has started
1546 * telnet and GDB server
1548 * That would allow users to more easily perform any magic they need to before
1551 return jtag_init_inner(cmd_ctx
);
1554 int jtag_init(struct command_context
*cmd_ctx
)
1558 if ((retval
= adapter_init(cmd_ctx
)) != ERROR_OK
)
1561 /* guard against oddball hardware: force resets to be inactive */
1562 jtag_add_reset(0, 0);
1563 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1566 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1572 unsigned jtag_get_speed_khz(void)
1577 static int adapter_khz_to_speed(unsigned khz
, int* speed
)
1579 LOG_DEBUG("convert khz to interface specific speed value");
1583 LOG_DEBUG("have interface set up");
1585 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1586 if (ERROR_OK
!= retval
)
1590 *speed
= speed_div1
;
1595 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int* speed
)
1597 int retval
= adapter_khz_to_speed(0, speed
);
1598 if ((ERROR_OK
!= retval
) && fallback_speed_khz
)
1600 LOG_DEBUG("trying fallback speed...");
1601 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1606 static int jtag_set_speed(int speed
)
1609 /* this command can be called during CONFIG,
1610 * in which case jtag isn't initialized */
1611 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1614 int jtag_config_khz(unsigned khz
)
1616 LOG_DEBUG("handle jtag khz");
1617 clock_mode
= CLOCK_MODE_KHZ
;
1619 int retval
= adapter_khz_to_speed(khz
, &speed
);
1620 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1623 int jtag_config_rclk(unsigned fallback_speed_khz
)
1625 LOG_DEBUG("handle jtag rclk");
1626 clock_mode
= CLOCK_MODE_RCLK
;
1627 rclk_fallback_speed_khz
= fallback_speed_khz
;
1629 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1630 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1633 int jtag_get_speed(int *speed
)
1637 case CLOCK_MODE_KHZ
:
1638 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1640 case CLOCK_MODE_RCLK
:
1641 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1644 LOG_ERROR("BUG: unknown jtag clock mode");
1650 int jtag_get_speed_readable(int *khz
)
1652 int jtag_speed_var
= 0;
1653 int retval
= jtag_get_speed(&jtag_speed_var
);
1654 if (retval
!= ERROR_OK
)
1656 return jtag
? jtag
->speed_div(jtag_speed_var
, khz
) : ERROR_OK
;
1659 void jtag_set_verify(bool enable
)
1661 jtag_verify
= enable
;
1664 bool jtag_will_verify()
1669 void jtag_set_verify_capture_ir(bool enable
)
1671 jtag_verify_capture_ir
= enable
;
1674 bool jtag_will_verify_capture_ir()
1676 return jtag_verify_capture_ir
;
1679 int jtag_power_dropout(int *dropout
)
1683 /* TODO: as the jtag interface is not valid all
1684 * we can do at the moment is exit OpenOCD */
1685 LOG_ERROR("No Valid JTAG Interface Configured.");
1688 return jtag
->power_dropout(dropout
);
1691 int jtag_srst_asserted(int *srst_asserted
)
1693 return jtag
->srst_asserted(srst_asserted
);
1696 enum reset_types
jtag_get_reset_config(void)
1698 return jtag_reset_config
;
1700 void jtag_set_reset_config(enum reset_types type
)
1702 jtag_reset_config
= type
;
1705 int jtag_get_trst(void)
1709 int jtag_get_srst(void)
1714 void jtag_set_nsrst_delay(unsigned delay
)
1716 adapter_nsrst_delay
= delay
;
1718 unsigned jtag_get_nsrst_delay(void)
1720 return adapter_nsrst_delay
;
1722 void jtag_set_ntrst_delay(unsigned delay
)
1724 jtag_ntrst_delay
= delay
;
1726 unsigned jtag_get_ntrst_delay(void)
1728 return jtag_ntrst_delay
;
1732 void jtag_set_nsrst_assert_width(unsigned delay
)
1734 adapter_nsrst_assert_width
= delay
;
1736 unsigned jtag_get_nsrst_assert_width(void)
1738 return adapter_nsrst_assert_width
;
1740 void jtag_set_ntrst_assert_width(unsigned delay
)
1742 jtag_ntrst_assert_width
= delay
;
1744 unsigned jtag_get_ntrst_assert_width(void)
1746 return jtag_ntrst_assert_width
;
1749 static int jtag_select(struct command_context
*ctx
)
1753 /* NOTE: interface init must already have been done.
1754 * That works with only C code ... no Tcl glue required.
1757 retval
= jtag_register_commands(ctx
);
1759 if (retval
!= ERROR_OK
)
1762 retval
= svf_register_commands(ctx
);
1764 if (retval
!= ERROR_OK
)
1767 return xsvf_register_commands(ctx
);
1770 static struct transport jtag_transport
= {
1772 .select
= jtag_select
,
1776 static void jtag_constructor(void) __attribute__((constructor
));
1777 static void jtag_constructor(void)
1779 transport_register(&jtag_transport
);
1782 /** Returns true if the current debug session
1783 * is using JTAG as its transport.
1785 bool transport_is_jtag(void)
1787 return get_current_transport() == &jtag_transport
;