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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
29 ***************************************************************************/
37 #include "interface.h"
38 #include <transport/transport.h>
44 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
46 #include "xsvf/xsvf.h"
48 /** The number of JTAG queue flushes (for profiling and debugging purposes). */
49 static int jtag_flush_queue_count
;
51 /* Sleep this # of ms after flushing the queue */
52 static int jtag_flush_queue_sleep
;
54 static void jtag_add_scan_check(struct jtag_tap
*active
,
55 void (*jtag_add_scan
)(struct jtag_tap
*active
,
57 const struct scan_field
*in_fields
,
59 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
);
62 * The jtag_error variable is set when an error occurs while executing
63 * the queue. Application code may set this using jtag_set_error(),
64 * when an error occurs during processing that should be reported during
65 * jtag_execute_queue().
67 * The value is set and cleared, but never read by normal application code.
69 * This value is returned (and cleared) by jtag_execute_queue().
71 static int jtag_error
= ERROR_OK
;
73 static const char *jtag_event_strings
[] = {
74 [JTAG_TRST_ASSERTED
] = "TAP reset",
75 [JTAG_TAP_EVENT_SETUP
] = "TAP setup",
76 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
77 [JTAG_TAP_EVENT_DISABLE
] = "TAP disabled",
81 * JTAG adapters must initialize with TRST and SRST de-asserted
82 * (they're negative logic, so that means *high*). But some
83 * hardware doesn't necessarily work that way ... so set things
84 * up so that jtag_init() always forces that state.
86 static int jtag_trst
= -1;
87 static int jtag_srst
= -1;
90 * List all TAPs that have been created.
92 static struct jtag_tap
*__jtag_all_taps
;
94 * The number of TAPs in the __jtag_all_taps list, used to track the
95 * assigned chain position to new TAPs
97 static unsigned jtag_num_taps
;
99 static enum reset_types jtag_reset_config
= RESET_NONE
;
100 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
102 static bool jtag_verify_capture_ir
= true;
103 static int jtag_verify
= 1;
105 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines
106 *deasserted (in ms) */
107 static int adapter_nsrst_delay
; /* default to no nSRST delay */
108 static int jtag_ntrst_delay
;/* default to no nTRST delay */
109 static int adapter_nsrst_assert_width
; /* width of assertion */
110 static int jtag_ntrst_assert_width
; /* width of assertion */
113 * Contains a single callback along with a pointer that will be passed
114 * when an event occurs.
116 struct jtag_event_callback
{
117 /** a event callback */
118 jtag_event_handler_t callback
;
119 /** the private data to pass to the callback */
121 /** the next callback */
122 struct jtag_event_callback
*next
;
125 /* callbacks to inform high-level handlers about JTAG state changes */
126 static struct jtag_event_callback
*jtag_event_callbacks
;
129 static int speed_khz
;
130 /* speed to fallback to when RCLK is requested but not supported */
131 static int rclk_fallback_speed_khz
;
132 static enum {CLOCK_MODE_UNSELECTED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
133 static int jtag_speed
;
135 static struct jtag_interface
*jtag
;
138 struct jtag_interface
*jtag_interface
;
140 void jtag_set_flush_queue_sleep(int ms
)
142 jtag_flush_queue_sleep
= ms
;
145 void jtag_set_error(int error
)
147 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
152 int jtag_error_clear(void)
154 int temp
= jtag_error
;
155 jtag_error
= ERROR_OK
;
161 static bool jtag_poll
= 1;
163 bool is_jtag_poll_safe(void)
165 /* Polling can be disabled explicitly with set_enabled(false).
166 * It is also implicitly disabled while TRST is active and
167 * while SRST is gating the JTAG clock.
169 if (!transport_is_jtag())
172 if (!jtag_poll
|| jtag_trst
!= 0)
174 return jtag_srst
== 0 || (jtag_reset_config
& RESET_SRST_NO_GATING
);
177 bool jtag_poll_get_enabled(void)
182 void jtag_poll_set_enabled(bool value
)
189 struct jtag_tap
*jtag_all_taps(void)
191 return __jtag_all_taps
;
194 unsigned jtag_tap_count(void)
196 return jtag_num_taps
;
199 unsigned jtag_tap_count_enabled(void)
201 struct jtag_tap
*t
= jtag_all_taps();
211 /** Append a new TAP to the chain of all taps. */
212 void jtag_tap_add(struct jtag_tap
*t
)
214 t
->abs_chain_position
= jtag_num_taps
++;
216 struct jtag_tap
**tap
= &__jtag_all_taps
;
218 tap
= &(*tap
)->next_tap
;
222 /* returns a pointer to the n-th device in the scan chain */
223 struct jtag_tap
*jtag_tap_by_position(unsigned n
)
225 struct jtag_tap
*t
= jtag_all_taps();
233 struct jtag_tap
*jtag_tap_by_string(const char *s
)
235 /* try by name first */
236 struct jtag_tap
*t
= jtag_all_taps();
239 if (0 == strcmp(t
->dotted_name
, s
))
244 /* no tap found by name, so try to parse the name as a number */
246 if (parse_uint(s
, &n
) != ERROR_OK
)
249 /* FIXME remove this numeric fallback code late June 2010, along
250 * with all info in the User's Guide that TAPs have numeric IDs.
251 * Also update "scan_chain" output to not display the numbers.
253 t
= jtag_tap_by_position(n
);
255 LOG_WARNING("Specify TAP '%s' by name, not number %u",
261 struct jtag_tap
*jtag_tap_next_enabled(struct jtag_tap
*p
)
263 p
= p
? p
->next_tap
: jtag_all_taps();
272 const char *jtag_tap_name(const struct jtag_tap
*tap
)
274 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
278 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
280 struct jtag_event_callback
**callbacks_p
= &jtag_event_callbacks
;
282 if (callback
== NULL
)
283 return ERROR_COMMAND_SYNTAX_ERROR
;
286 while ((*callbacks_p
)->next
)
287 callbacks_p
= &((*callbacks_p
)->next
);
288 callbacks_p
= &((*callbacks_p
)->next
);
291 (*callbacks_p
) = malloc(sizeof(struct jtag_event_callback
));
292 (*callbacks_p
)->callback
= callback
;
293 (*callbacks_p
)->priv
= priv
;
294 (*callbacks_p
)->next
= NULL
;
299 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
301 struct jtag_event_callback
**p
= &jtag_event_callbacks
, *temp
;
303 if (callback
== NULL
)
304 return ERROR_COMMAND_SYNTAX_ERROR
;
307 if (((*p
)->priv
!= priv
) || ((*p
)->callback
!= callback
)) {
320 int jtag_call_event_callbacks(enum jtag_event event
)
322 struct jtag_event_callback
*callback
= jtag_event_callbacks
;
324 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
327 struct jtag_event_callback
*next
;
329 /* callback may remove itself */
330 next
= callback
->next
;
331 callback
->callback(event
, callback
->priv
);
338 static void jtag_checks(void)
340 assert(jtag_trst
== 0);
343 static void jtag_prelude(tap_state_t state
)
347 assert(state
!= TAP_INVALID
);
349 cmd_queue_cur_state
= state
;
352 void jtag_add_ir_scan_noverify(struct jtag_tap
*active
, const struct scan_field
*in_fields
,
357 int retval
= interface_jtag_add_ir_scan(active
, in_fields
, state
);
358 jtag_set_error(retval
);
361 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap
*active
,
363 const struct scan_field
*in_fields
,
366 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
369 /* If fields->in_value is filled out, then the captured IR value will be checked */
370 void jtag_add_ir_scan(struct jtag_tap
*active
, struct scan_field
*in_fields
, tap_state_t state
)
372 assert(state
!= TAP_RESET
);
374 if (jtag_verify
&& jtag_verify_capture_ir
) {
375 /* 8 x 32 bit id's is enough for all invocations */
377 /* if we are to run a verification of the ir scan, we need to get the input back.
378 * We may have to allocate space if the caller didn't ask for the input back.
380 in_fields
->check_value
= active
->expected
;
381 in_fields
->check_mask
= active
->expected_mask
;
382 jtag_add_scan_check(active
, jtag_add_ir_scan_noverify_callback
, 1, in_fields
,
385 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
388 void jtag_add_plain_ir_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
391 assert(out_bits
!= NULL
);
392 assert(state
!= TAP_RESET
);
396 int retval
= interface_jtag_add_plain_ir_scan(
397 num_bits
, out_bits
, in_bits
, state
);
398 jtag_set_error(retval
);
401 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
402 uint8_t *in_check_mask
, int num_bits
);
404 static int jtag_check_value_mask_callback(jtag_callback_data_t data0
,
405 jtag_callback_data_t data1
,
406 jtag_callback_data_t data2
,
407 jtag_callback_data_t data3
)
409 return jtag_check_value_inner((uint8_t *)data0
,
415 static void jtag_add_scan_check(struct jtag_tap
*active
, void (*jtag_add_scan
)(
416 struct jtag_tap
*active
,
418 const struct scan_field
*in_fields
,
420 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
)
422 jtag_add_scan(active
, in_num_fields
, in_fields
, state
);
424 for (int i
= 0; i
< in_num_fields
; i
++) {
425 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
)) {
426 /* this is synchronous for a minidriver */
427 jtag_add_callback4(jtag_check_value_mask_callback
,
428 (jtag_callback_data_t
)in_fields
[i
].in_value
,
429 (jtag_callback_data_t
)in_fields
[i
].check_value
,
430 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
431 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
436 void jtag_add_dr_scan_check(struct jtag_tap
*active
,
438 struct scan_field
*in_fields
,
442 jtag_add_scan_check(active
, jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
444 jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
448 void jtag_add_dr_scan(struct jtag_tap
*active
,
450 const struct scan_field
*in_fields
,
453 assert(state
!= TAP_RESET
);
458 retval
= interface_jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
459 jtag_set_error(retval
);
462 void jtag_add_plain_dr_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
465 assert(out_bits
!= NULL
);
466 assert(state
!= TAP_RESET
);
471 retval
= interface_jtag_add_plain_dr_scan(num_bits
, out_bits
, in_bits
, state
);
472 jtag_set_error(retval
);
475 void jtag_add_tlr(void)
477 jtag_prelude(TAP_RESET
);
478 jtag_set_error(interface_jtag_add_tlr());
480 /* NOTE: order here matches TRST path in jtag_add_reset() */
481 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
482 jtag_notify_event(JTAG_TRST_ASSERTED
);
486 * If supported by the underlying adapter, this clocks a raw bit sequence
487 * onto TMS for switching betwen JTAG and SWD modes.
489 * DO NOT use this to bypass the integrity checks and logging provided
490 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
492 * @param nbits How many bits to clock out.
493 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
494 * @param state The JTAG tap state to record on completion. Use
495 * TAP_INVALID to represent being in in SWD mode.
497 * @todo Update naming conventions to stop assuming everything is JTAG.
499 int jtag_add_tms_seq(unsigned nbits
, const uint8_t *seq
, enum tap_state state
)
503 if (!(jtag
->supported
& DEBUG_CAP_TMS_SEQ
))
504 return ERROR_JTAG_NOT_IMPLEMENTED
;
507 cmd_queue_cur_state
= state
;
509 retval
= interface_add_tms_seq(nbits
, seq
, state
);
510 jtag_set_error(retval
);
514 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
516 tap_state_t cur_state
= cmd_queue_cur_state
;
518 /* the last state has to be a stable state */
519 if (!tap_is_state_stable(path
[num_states
- 1])) {
520 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
521 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
525 for (int i
= 0; i
< num_states
; i
++) {
526 if (path
[i
] == TAP_RESET
) {
527 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
528 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
532 if (tap_state_transition(cur_state
, true) != path
[i
] &&
533 tap_state_transition(cur_state
, false) != path
[i
]) {
534 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
535 tap_state_name(cur_state
), tap_state_name(path
[i
]));
536 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
544 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
545 cmd_queue_cur_state
= path
[num_states
- 1];
548 int jtag_add_statemove(tap_state_t goal_state
)
550 tap_state_t cur_state
= cmd_queue_cur_state
;
552 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
)
566 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
)) {
567 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
568 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
569 tap_state_t moves
[8];
570 assert(tms_count
< ARRAY_SIZE(moves
));
572 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1) {
573 bool bit
= tms_bits
& 1;
575 cur_state
= tap_state_transition(cur_state
, bit
);
576 moves
[i
] = cur_state
;
579 jtag_add_pathmove(tms_count
, moves
);
580 } else if (tap_state_transition(cur_state
, true) == goal_state
581 || tap_state_transition(cur_state
, false) == goal_state
)
582 jtag_add_pathmove(1, &goal_state
);
589 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
592 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
596 void jtag_add_clocks(int num_cycles
)
598 if (!tap_is_state_stable(cmd_queue_cur_state
)) {
599 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
600 tap_state_name(cmd_queue_cur_state
));
601 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
605 if (num_cycles
> 0) {
607 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
611 void swd_add_reset(int req_srst
)
614 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
615 LOG_ERROR("BUG: can't assert SRST");
616 jtag_set_error(ERROR_FAIL
);
622 /* Maybe change SRST signal state */
623 if (jtag_srst
!= req_srst
) {
626 retval
= interface_jtag_add_reset(0, req_srst
);
627 if (retval
!= ERROR_OK
)
628 jtag_set_error(retval
);
630 retval
= jtag_execute_queue();
632 if (retval
!= ERROR_OK
) {
633 LOG_ERROR("TRST/SRST error");
637 /* SRST resets everything hooked up to that signal */
638 jtag_srst
= req_srst
;
640 LOG_DEBUG("SRST line asserted");
641 if (adapter_nsrst_assert_width
)
642 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
644 LOG_DEBUG("SRST line released");
645 if (adapter_nsrst_delay
)
646 jtag_add_sleep(adapter_nsrst_delay
* 1000);
651 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
653 int trst_with_tlr
= 0;
657 /* Without SRST, we must use target-specific JTAG operations
658 * on each target; callers should not be requesting SRST when
659 * that signal doesn't exist.
661 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
662 * can kick in even if the JTAG adapter can't drive TRST.
665 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
666 LOG_ERROR("BUG: can't assert SRST");
667 jtag_set_error(ERROR_FAIL
);
670 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
671 && !req_tlr_or_trst
) {
672 LOG_ERROR("BUG: can't assert only SRST");
673 jtag_set_error(ERROR_FAIL
);
679 /* JTAG reset (entry to TAP_RESET state) can always be achieved
680 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
681 * state first. TRST accelerates it, and bypasses those states.
683 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
684 * can kick in even if the JTAG adapter can't drive SRST.
686 if (req_tlr_or_trst
) {
687 if (!(jtag_reset_config
& RESET_HAS_TRST
))
689 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
696 /* Maybe change TRST and/or SRST signal state */
697 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
700 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
701 if (retval
!= ERROR_OK
)
702 jtag_set_error(retval
);
704 retval
= jtag_execute_queue();
706 if (retval
!= ERROR_OK
) {
707 LOG_ERROR("TRST/SRST error");
712 /* SRST resets everything hooked up to that signal */
713 if (jtag_srst
!= new_srst
) {
714 jtag_srst
= new_srst
;
716 LOG_DEBUG("SRST line asserted");
717 if (adapter_nsrst_assert_width
)
718 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
720 LOG_DEBUG("SRST line released");
721 if (adapter_nsrst_delay
)
722 jtag_add_sleep(adapter_nsrst_delay
* 1000);
726 /* Maybe enter the JTAG TAP_RESET state ...
727 * - using only TMS, TCK, and the JTAG state machine
728 * - or else more directly, using TRST
730 * TAP_RESET should be invisible to non-debug parts of the system.
733 LOG_DEBUG("JTAG reset with TLR instead of TRST");
736 } else if (jtag_trst
!= new_trst
) {
737 jtag_trst
= new_trst
;
739 LOG_DEBUG("TRST line asserted");
740 tap_set_state(TAP_RESET
);
741 if (jtag_ntrst_assert_width
)
742 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
744 LOG_DEBUG("TRST line released");
745 if (jtag_ntrst_delay
)
746 jtag_add_sleep(jtag_ntrst_delay
* 1000);
748 /* We just asserted nTRST, so we're now in TAP_RESET.
749 * Inform possible listeners about this, now that
750 * JTAG instructions and data can be shifted. This
751 * sequence must match jtag_add_tlr().
753 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
754 jtag_notify_event(JTAG_TRST_ASSERTED
);
759 void jtag_add_sleep(uint32_t us
)
761 /** @todo Here, keep_alive() appears to be a layering violation!!! */
763 jtag_set_error(interface_jtag_add_sleep(us
));
766 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
767 uint8_t *in_check_mask
, int num_bits
)
769 int retval
= ERROR_OK
;
773 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
775 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
777 if (compare_failed
) {
778 char *captured_str
, *in_check_value_str
;
779 int bits
= (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
;
781 /* NOTE: we've lost diagnostic context here -- 'which tap' */
783 captured_str
= buf_to_str(captured
, bits
, 16);
784 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
786 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
788 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
791 free(in_check_value_str
);
794 char *in_check_mask_str
;
796 in_check_mask_str
= buf_to_str(in_check_mask
, bits
, 16);
797 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
798 free(in_check_mask_str
);
801 retval
= ERROR_JTAG_QUEUE_FAILED
;
806 void jtag_check_value_mask(struct scan_field
*field
, uint8_t *value
, uint8_t *mask
)
808 assert(field
->in_value
!= NULL
);
811 /* no checking to do */
815 jtag_execute_queue_noclear();
817 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
818 jtag_set_error(retval
);
821 int default_interface_jtag_execute_queue(void)
824 LOG_ERROR("No JTAG interface configured yet. "
825 "Issue 'init' command in startup scripts "
826 "before communicating with targets.");
830 return jtag
->execute_queue();
833 void jtag_execute_queue_noclear(void)
835 jtag_flush_queue_count
++;
836 jtag_set_error(interface_jtag_execute_queue());
838 if (jtag_flush_queue_sleep
> 0) {
839 /* For debug purposes it can be useful to test performance
840 * or behavior when delaying after flushing the queue,
841 * e.g. to simulate long roundtrip times.
843 usleep(jtag_flush_queue_sleep
* 1000);
847 int jtag_get_flush_queue_count(void)
849 return jtag_flush_queue_count
;
852 int jtag_execute_queue(void)
854 jtag_execute_queue_noclear();
855 return jtag_error_clear();
858 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
860 struct jtag_tap
*tap
= priv
;
862 if (event
== JTAG_TRST_ASSERTED
) {
863 tap
->enabled
= !tap
->disabled_after_reset
;
865 /* current instruction is either BYPASS or IDCODE */
866 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
873 /* sleep at least us microseconds. When we sleep more than 1000ms we
874 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
875 * GDB if we slept for <1000ms many times.
877 void jtag_sleep(uint32_t us
)
882 alive_sleep((us
+999)/1000);
885 /* Maximum number of enabled JTAG devices we expect in the scan chain,
886 * plus one (to detect garbage at the end). Devices that don't support
887 * IDCODE take up fewer bits, possibly allowing a few more devices.
889 #define JTAG_MAX_CHAIN_SIZE 20
891 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
892 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
893 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
895 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
896 * know that no valid TAP will have it as an IDCODE value.
898 #define END_OF_CHAIN_FLAG 0xffffffff
900 /* a larger IR length than we ever expect to autoprobe */
901 #define JTAG_IRLEN_MAX 60
903 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
905 struct scan_field field
= {
906 .num_bits
= num_idcode
* 32,
907 .out_value
= idcode_buffer
,
908 .in_value
= idcode_buffer
,
911 /* initialize to the end of chain ID value */
912 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
913 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
915 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
917 return jtag_execute_queue();
920 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
922 uint8_t zero_check
= 0x0;
923 uint8_t one_check
= 0xff;
925 for (unsigned i
= 0; i
< count
* 4; i
++) {
926 zero_check
|= idcodes
[i
];
927 one_check
&= idcodes
[i
];
930 /* if there wasn't a single non-zero bit or if all bits were one,
931 * the scan is not valid. We wrote a mix of both values; either
933 * - There's a hardware issue (almost certainly):
934 * + all-zeroes can mean a target stuck in JTAG reset
935 * + all-ones tends to mean no target
936 * - The scan chain is WAY longer than we can handle, *AND* either
937 * + there are several hundreds of TAPs in bypass, or
938 * + at least a few dozen TAPs all have an all-ones IDCODE
940 if (zero_check
== 0x00 || one_check
== 0xff) {
941 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
942 (zero_check
== 0x00) ? "zeroes" : "ones");
943 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
949 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
950 const char *name
, uint32_t idcode
)
952 log_printf_lf(level
, __FILE__
, __LINE__
, __func__
,
953 "JTAG tap: %s %16.16s: 0x%08x "
954 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
956 (unsigned int)idcode
,
957 (unsigned int)EXTRACT_MFG(idcode
),
958 (unsigned int)EXTRACT_PART(idcode
),
959 (unsigned int)EXTRACT_VER(idcode
));
962 static bool jtag_idcode_is_final(uint32_t idcode
)
965 * Some devices, such as AVR8, will output all 1's instead
966 * of TDI input value at end of chain. Allow those values
967 * instead of failing.
969 return idcode
== END_OF_CHAIN_FLAG
;
973 * This helper checks that remaining bits in the examined chain data are
974 * all as expected, but a single JTAG device requires only 64 bits to be
975 * read back correctly. This can help identify and diagnose problems
976 * with the JTAG chain earlier, gives more helpful/explicit error messages.
977 * Returns TRUE iff garbage was found.
979 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
981 bool triggered
= false;
982 for (; count
< max
- 31; count
+= 32) {
983 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
985 /* do not trigger the warning if the data looks good */
986 if (jtag_idcode_is_final(idcode
))
988 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
989 count
, (unsigned int)idcode
);
995 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
997 uint32_t idcode
= tap
->idcode
;
999 /* ignore expected BYPASS codes; warn otherwise */
1000 if (0 == tap
->expected_ids_cnt
&& !idcode
)
1003 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1004 uint32_t mask
= tap
->ignore_version
? ~(0xf << 28) : ~0;
1008 /* Loop over the expected identification codes and test for a match */
1009 unsigned ii
, limit
= tap
->expected_ids_cnt
;
1011 for (ii
= 0; ii
< limit
; ii
++) {
1012 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
1014 if (idcode
== expected
)
1017 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1018 if (0 == tap
->expected_ids
[ii
])
1022 /* If none of the expected ids matched, warn */
1023 jtag_examine_chain_display(LOG_LVL_WARNING
, "UNEXPECTED",
1024 tap
->dotted_name
, tap
->idcode
);
1025 for (ii
= 0; ii
< limit
; ii
++) {
1028 snprintf(msg
, sizeof(msg
), "expected %u of %u", ii
+ 1, limit
);
1029 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1030 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1035 /* Try to examine chain layout according to IEEE 1149.1 §12
1036 * This is called a "blind interrogation" of the scan chain.
1038 static int jtag_examine_chain(void)
1040 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1044 bool autoprobe
= false;
1046 /* DR scan to collect BYPASS or IDCODE register contents.
1047 * Then make sure the scan data has both ones and zeroes.
1049 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1050 retval
= jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1051 if (retval
!= ERROR_OK
)
1053 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1054 return ERROR_JTAG_INIT_FAILED
;
1056 /* point at the 1st tap */
1057 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1063 tap
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;
1064 tap
= jtag_tap_next_enabled(tap
)) {
1065 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1067 if ((idcode
& 1) == 0) {
1068 /* Zero for LSB indicates a device in bypass */
1069 LOG_INFO("TAP %s does not have IDCODE",
1072 tap
->hasidcode
= false;
1076 /* Friendly devices support IDCODE */
1077 tap
->hasidcode
= true;
1078 jtag_examine_chain_display(LOG_LVL_INFO
,
1080 tap
->dotted_name
, idcode
);
1084 tap
->idcode
= idcode
;
1086 /* ensure the TAP ID matches what was expected */
1087 if (!jtag_examine_chain_match_tap(tap
))
1088 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1091 /* Fail if too many TAPs were enabled for us to verify them all. */
1093 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1095 return ERROR_JTAG_INIT_FAILED
;
1098 /* if autoprobing, the tap list is still empty ... populate it! */
1099 while (autoprobe
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31) {
1103 /* Is there another TAP? */
1104 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1105 if (jtag_idcode_is_final(idcode
))
1108 /* Default everything in this TAP except IR length.
1110 * REVISIT create a jtag_alloc(chip, tap) routine, and
1111 * share it with jim_newtap_cmd().
1113 tap
= calloc(1, sizeof *tap
);
1117 sprintf(buf
, "auto%d", tapcount
++);
1118 tap
->chip
= strdup(buf
);
1119 tap
->tapname
= strdup("tap");
1121 sprintf(buf
, "%s.%s", tap
->chip
, tap
->tapname
);
1122 tap
->dotted_name
= strdup(buf
);
1124 /* tap->ir_length == 0 ... signifying irlen autoprobe */
1125 tap
->ir_capture_mask
= 0x03;
1126 tap
->ir_capture_value
= 0x01;
1128 tap
->enabled
= true;
1130 if ((idcode
& 1) == 0) {
1132 tap
->hasidcode
= false;
1135 tap
->hasidcode
= true;
1136 tap
->idcode
= idcode
;
1138 tap
->expected_ids_cnt
= 1;
1139 tap
->expected_ids
= malloc(sizeof(uint32_t));
1140 tap
->expected_ids
[0] = idcode
;
1143 LOG_WARNING("AUTO %s - use \"jtag newtap "
1144 "%s %s -expected-id 0x%8.8" PRIx32
" ...\"",
1145 tap
->dotted_name
, tap
->chip
, tap
->tapname
,
1151 /* After those IDCODE or BYPASS register values should be
1152 * only the data we fed into the scan chain.
1154 if (jtag_examine_chain_end(idcode_buffer
, bit_count
,
1155 8 * sizeof(idcode_buffer
))) {
1156 LOG_ERROR("double-check your JTAG setup (interface, "
1157 "speed, missing TAPs, ...)");
1158 return ERROR_JTAG_INIT_FAILED
;
1161 /* Return success or, for backwards compatibility if only
1162 * some IDCODE values mismatched, a soft/continuable fault.
1168 * Validate the date loaded by entry to the Capture-IR state, to help
1169 * find errors related to scan chain configuration (wrong IR lengths)
1172 * Entry state can be anything. On non-error exit, all TAPs are in
1173 * bypass mode. On error exits, the scan chain is reset.
1175 static int jtag_validate_ircapture(void)
1177 struct jtag_tap
*tap
;
1178 int total_ir_length
= 0;
1179 uint8_t *ir_test
= NULL
;
1180 struct scan_field field
;
1185 /* when autoprobing, accomodate huge IR lengths */
1186 for (tap
= NULL
, total_ir_length
= 0;
1187 (tap
= jtag_tap_next_enabled(tap
)) != NULL
;
1188 total_ir_length
+= tap
->ir_length
) {
1189 if (tap
->ir_length
== 0)
1190 total_ir_length
+= JTAG_IRLEN_MAX
;
1193 /* increase length to add 2 bit sentinel after scan */
1194 total_ir_length
+= 2;
1196 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1197 if (ir_test
== NULL
)
1200 /* after this scan, all TAPs will capture BYPASS instructions */
1201 buf_set_ones(ir_test
, total_ir_length
);
1203 field
.num_bits
= total_ir_length
;
1204 field
.out_value
= ir_test
;
1205 field
.in_value
= ir_test
;
1207 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1209 LOG_DEBUG("IR capture validation scan");
1210 retval
= jtag_execute_queue();
1211 if (retval
!= ERROR_OK
)
1218 tap
= jtag_tap_next_enabled(tap
);
1222 /* If we're autoprobing, guess IR lengths. They must be at
1223 * least two bits. Guessing will fail if (a) any TAP does
1224 * not conform to the JTAG spec; or (b) when the upper bits
1225 * captured from some conforming TAP are nonzero. Or if
1226 * (c) an IR length is longer than 32 bits -- which is only
1227 * an implementation limit, which could someday be raised.
1229 * REVISIT optimization: if there's a *single* TAP we can
1230 * lift restrictions (a) and (b) by scanning a recognizable
1231 * pattern before the all-ones BYPASS. Check for where the
1232 * pattern starts in the result, instead of an 0...01 value.
1234 * REVISIT alternative approach: escape to some tcl code
1235 * which could provide more knowledge, based on IDCODE; and
1236 * only guess when that has no success.
1238 if (tap
->ir_length
== 0) {
1240 while ((val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
+ 1)) == 1
1241 && tap
->ir_length
<= 64) {
1244 LOG_WARNING("AUTO %s - use \"... -irlen %d\"",
1245 jtag_tap_name(tap
), tap
->ir_length
);
1248 /* Validate the two LSBs, which must be 01 per JTAG spec.
1250 * Or ... more bits could be provided by TAP declaration.
1251 * Plus, some taps (notably in i.MX series chips) violate
1252 * this part of the JTAG spec, so their capture mask/value
1253 * attributes might disable this test.
1255 val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
);
1256 if ((val
& tap
->ir_capture_mask
) != tap
->ir_capture_value
) {
1257 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64
" not 0x%0*" PRIx32
,
1259 (tap
->ir_length
+ 7) / tap
->ir_length
, val
,
1260 (tap
->ir_length
+ 7) / tap
->ir_length
, tap
->ir_capture_value
);
1262 retval
= ERROR_JTAG_INIT_FAILED
;
1265 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64
, jtag_tap_name(tap
),
1266 (tap
->ir_length
+ 7) / tap
->ir_length
, val
);
1267 chain_pos
+= tap
->ir_length
;
1270 /* verify the '11' sentinel we wrote is returned at the end */
1271 val
= buf_get_u64(ir_test
, chain_pos
, 2);
1273 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1275 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1278 retval
= ERROR_JTAG_INIT_FAILED
;
1283 if (retval
!= ERROR_OK
) {
1285 jtag_execute_queue();
1290 void jtag_tap_init(struct jtag_tap
*tap
)
1292 unsigned ir_len_bits
;
1293 unsigned ir_len_bytes
;
1295 /* if we're autoprobing, cope with potentially huge ir_length */
1296 ir_len_bits
= tap
->ir_length
? : JTAG_IRLEN_MAX
;
1297 ir_len_bytes
= DIV_ROUND_UP(ir_len_bits
, 8);
1299 tap
->expected
= calloc(1, ir_len_bytes
);
1300 tap
->expected_mask
= calloc(1, ir_len_bytes
);
1301 tap
->cur_instr
= malloc(ir_len_bytes
);
1303 /** @todo cope better with ir_length bigger than 32 bits */
1304 if (ir_len_bits
> 32)
1307 buf_set_u32(tap
->expected
, 0, ir_len_bits
, tap
->ir_capture_value
);
1308 buf_set_u32(tap
->expected_mask
, 0, ir_len_bits
, tap
->ir_capture_mask
);
1310 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1312 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1314 /* register the reset callback for the TAP */
1315 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1318 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1319 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1320 tap
->abs_chain_position
, tap
->ir_length
,
1321 (unsigned) tap
->ir_capture_value
,
1322 (unsigned) tap
->ir_capture_mask
);
1325 void jtag_tap_free(struct jtag_tap
*tap
)
1327 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1329 free(tap
->expected
);
1330 free(tap
->expected_mask
);
1331 free(tap
->expected_ids
);
1332 free(tap
->cur_instr
);
1335 free(tap
->dotted_name
);
1340 * Do low-level setup like initializing registers, output signals,
1343 int adapter_init(struct command_context
*cmd_ctx
)
1348 if (!jtag_interface
) {
1349 /* nothing was previously specified by "interface" command */
1350 LOG_ERROR("Debug Adapter has to be specified, "
1351 "see \"interface\" command");
1352 return ERROR_JTAG_INVALID_INTERFACE
;
1356 retval
= jtag_interface
->init();
1357 if (retval
!= ERROR_OK
)
1359 jtag
= jtag_interface
;
1361 /* LEGACY SUPPORT ... adapter drivers must declare what
1362 * transports they allow. Until they all do so, assume
1363 * the legacy drivers are JTAG-only
1365 if (!transports_are_declared()) {
1366 LOG_ERROR("Adapter driver '%s' did not declare "
1367 "which transports it allows; assuming "
1368 "JTAG-only", jtag
->name
);
1369 retval
= allow_transports(cmd_ctx
, jtag_only
);
1370 if (retval
!= ERROR_OK
)
1374 if (jtag
->speed
== NULL
) {
1375 LOG_INFO("This adapter doesn't support configurable speed");
1379 if (CLOCK_MODE_UNSELECTED
== clock_mode
) {
1380 LOG_ERROR("An adapter speed is not selected in the init script."
1381 " Insert a call to adapter_khz or jtag_rclk to proceed.");
1382 return ERROR_JTAG_INIT_FAILED
;
1385 int requested_khz
= jtag_get_speed_khz();
1386 int actual_khz
= requested_khz
;
1387 int jtag_speed_var
= 0;
1388 retval
= jtag_get_speed(&jtag_speed_var
);
1389 if (retval
!= ERROR_OK
)
1391 retval
= jtag
->speed(jtag_speed_var
);
1392 if (retval
!= ERROR_OK
)
1394 retval
= jtag_get_speed_readable(&actual_khz
);
1395 if (ERROR_OK
!= retval
)
1396 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1397 else if (actual_khz
) {
1398 /* Adaptive clocking -- JTAG-specific */
1399 if ((CLOCK_MODE_RCLK
== clock_mode
)
1400 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
)) {
1401 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1404 LOG_INFO("clock speed %d kHz", actual_khz
);
1406 LOG_INFO("RCLK (adaptive clock speed)");
1411 int jtag_init_inner(struct command_context
*cmd_ctx
)
1413 struct jtag_tap
*tap
;
1415 bool issue_setup
= true;
1417 LOG_DEBUG("Init JTAG chain");
1419 tap
= jtag_tap_next_enabled(NULL
);
1421 /* Once JTAG itself is properly set up, and the scan chain
1422 * isn't absurdly large, IDCODE autoprobe should work fine.
1424 * But ... IRLEN autoprobe can fail even on systems which
1425 * are fully conformant to JTAG. Also, JTAG setup can be
1426 * quite finicky on some systems.
1428 * REVISIT: if TAP autoprobe works OK, then in many cases
1429 * we could escape to tcl code and set up targets based on
1430 * the TAP's IDCODE values.
1432 LOG_WARNING("There are no enabled taps. "
1433 "AUTO PROBING MIGHT NOT WORK!!");
1435 /* REVISIT default clock will often be too fast ... */
1439 retval
= jtag_execute_queue();
1440 if (retval
!= ERROR_OK
)
1443 /* Examine DR values first. This discovers problems which will
1444 * prevent communication ... hardware issues like TDO stuck, or
1445 * configuring the wrong number of (enabled) TAPs.
1447 retval
= jtag_examine_chain();
1450 /* complete success */
1453 /* For backward compatibility reasons, try coping with
1454 * configuration errors involving only ID mismatches.
1455 * We might be able to talk to the devices.
1457 * Also the device might be powered down during startup.
1459 * After OpenOCD starts, we can try to power on the device
1462 LOG_ERROR("Trying to use configured scan chain anyway...");
1463 issue_setup
= false;
1467 /* Now look at IR values. Problems here will prevent real
1468 * communication. They mostly mean that the IR length is
1469 * wrong ... or that the IR capture value is wrong. (The
1470 * latter is uncommon, but easily worked around: provide
1471 * ircapture/irmask values during TAP setup.)
1473 retval
= jtag_validate_ircapture();
1474 if (retval
!= ERROR_OK
) {
1475 /* The target might be powered down. The user
1476 * can power it up and reset it after firing
1479 issue_setup
= false;
1483 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1485 LOG_WARNING("Bypassing JTAG setup events due to errors");
1491 int adapter_quit(void)
1493 if (!jtag
|| !jtag
->quit
)
1496 /* close the JTAG interface */
1497 int result
= jtag
->quit();
1498 if (ERROR_OK
!= result
)
1499 LOG_ERROR("failed: %d", result
);
1504 int swd_init_reset(struct command_context
*cmd_ctx
)
1506 int retval
= adapter_init(cmd_ctx
);
1507 if (retval
!= ERROR_OK
)
1510 LOG_DEBUG("Initializing with hard SRST reset");
1512 if (jtag_reset_config
& RESET_HAS_SRST
)
1515 retval
= jtag_execute_queue();
1519 int jtag_init_reset(struct command_context
*cmd_ctx
)
1521 int retval
= adapter_init(cmd_ctx
);
1522 if (retval
!= ERROR_OK
)
1525 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1528 * This procedure is used by default when OpenOCD triggers a reset.
1529 * It's now done through an overridable Tcl "init_reset" wrapper.
1531 * This started out as a more powerful "get JTAG working" reset than
1532 * jtag_init_inner(), applying TRST because some chips won't activate
1533 * JTAG without a TRST cycle (presumed to be async, though some of
1534 * those chips synchronize JTAG activation using TCK).
1536 * But some chips only activate JTAG as part of an SRST cycle; SRST
1537 * got mixed in. So it became a hard reset routine, which got used
1538 * in more places, and which coped with JTAG reset being forced as
1539 * part of SRST (srst_pulls_trst).
1541 * And even more corner cases started to surface: TRST and/or SRST
1542 * assertion timings matter; some chips need other JTAG operations;
1543 * TRST/SRST sequences can need to be different from these, etc.
1545 * Systems should override that wrapper to support system-specific
1546 * requirements that this not-fully-generic code doesn't handle.
1548 * REVISIT once Tcl code can read the reset_config modes, this won't
1549 * need to be a C routine at all...
1551 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1552 if (jtag_reset_config
& RESET_HAS_SRST
) {
1553 jtag_add_reset(1, 1);
1554 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1555 jtag_add_reset(0, 1);
1558 /* some targets enable us to connect with srst asserted */
1559 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1560 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1561 jtag_add_reset(0, 1);
1563 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1564 jtag_add_reset(0, 0);
1567 jtag_add_reset(0, 0);
1568 retval
= jtag_execute_queue();
1569 if (retval
!= ERROR_OK
)
1572 /* Check that we can communication on the JTAG chain + eventually we want to
1573 * be able to perform enumeration only after OpenOCD has started
1574 * telnet and GDB server
1576 * That would allow users to more easily perform any magic they need to before
1579 return jtag_init_inner(cmd_ctx
);
1582 int jtag_init(struct command_context
*cmd_ctx
)
1584 int retval
= adapter_init(cmd_ctx
);
1585 if (retval
!= ERROR_OK
)
1588 /* guard against oddball hardware: force resets to be inactive */
1589 jtag_add_reset(0, 0);
1591 /* some targets enable us to connect with srst asserted */
1592 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1593 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1594 jtag_add_reset(0, 1);
1596 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1598 retval
= jtag_execute_queue();
1599 if (retval
!= ERROR_OK
)
1602 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1608 unsigned jtag_get_speed_khz(void)
1613 static int adapter_khz_to_speed(unsigned khz
, int *speed
)
1615 LOG_DEBUG("convert khz to interface specific speed value");
1618 LOG_DEBUG("have interface set up");
1620 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1621 if (ERROR_OK
!= retval
)
1623 *speed
= speed_div1
;
1628 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int *speed
)
1630 int retval
= adapter_khz_to_speed(0, speed
);
1631 if ((ERROR_OK
!= retval
) && fallback_speed_khz
) {
1632 LOG_DEBUG("trying fallback speed...");
1633 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1638 static int jtag_set_speed(int speed
)
1641 /* this command can be called during CONFIG,
1642 * in which case jtag isn't initialized */
1643 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1646 int jtag_config_khz(unsigned khz
)
1648 LOG_DEBUG("handle jtag khz");
1649 clock_mode
= CLOCK_MODE_KHZ
;
1651 int retval
= adapter_khz_to_speed(khz
, &speed
);
1652 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1655 int jtag_config_rclk(unsigned fallback_speed_khz
)
1657 LOG_DEBUG("handle jtag rclk");
1658 clock_mode
= CLOCK_MODE_RCLK
;
1659 rclk_fallback_speed_khz
= fallback_speed_khz
;
1661 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1662 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1665 int jtag_get_speed(int *speed
)
1667 switch (clock_mode
) {
1668 case CLOCK_MODE_KHZ
:
1669 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1671 case CLOCK_MODE_RCLK
:
1672 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1675 LOG_ERROR("BUG: unknown jtag clock mode");
1681 int jtag_get_speed_readable(int *khz
)
1683 int jtag_speed_var
= 0;
1684 int retval
= jtag_get_speed(&jtag_speed_var
);
1685 if (retval
!= ERROR_OK
)
1687 return jtag
? jtag
->speed_div(jtag_speed_var
, khz
) : ERROR_OK
;
1690 void jtag_set_verify(bool enable
)
1692 jtag_verify
= enable
;
1695 bool jtag_will_verify()
1700 void jtag_set_verify_capture_ir(bool enable
)
1702 jtag_verify_capture_ir
= enable
;
1705 bool jtag_will_verify_capture_ir()
1707 return jtag_verify_capture_ir
;
1710 int jtag_power_dropout(int *dropout
)
1713 /* TODO: as the jtag interface is not valid all
1714 * we can do at the moment is exit OpenOCD */
1715 LOG_ERROR("No Valid JTAG Interface Configured.");
1718 return jtag
->power_dropout(dropout
);
1721 int jtag_srst_asserted(int *srst_asserted
)
1723 return jtag
->srst_asserted(srst_asserted
);
1726 enum reset_types
jtag_get_reset_config(void)
1728 return jtag_reset_config
;
1730 void jtag_set_reset_config(enum reset_types type
)
1732 jtag_reset_config
= type
;
1735 int jtag_get_trst(void)
1739 int jtag_get_srst(void)
1744 void jtag_set_nsrst_delay(unsigned delay
)
1746 adapter_nsrst_delay
= delay
;
1748 unsigned jtag_get_nsrst_delay(void)
1750 return adapter_nsrst_delay
;
1752 void jtag_set_ntrst_delay(unsigned delay
)
1754 jtag_ntrst_delay
= delay
;
1756 unsigned jtag_get_ntrst_delay(void)
1758 return jtag_ntrst_delay
;
1762 void jtag_set_nsrst_assert_width(unsigned delay
)
1764 adapter_nsrst_assert_width
= delay
;
1766 unsigned jtag_get_nsrst_assert_width(void)
1768 return adapter_nsrst_assert_width
;
1770 void jtag_set_ntrst_assert_width(unsigned delay
)
1772 jtag_ntrst_assert_width
= delay
;
1774 unsigned jtag_get_ntrst_assert_width(void)
1776 return jtag_ntrst_assert_width
;
1779 static int jtag_select(struct command_context
*ctx
)
1783 /* NOTE: interface init must already have been done.
1784 * That works with only C code ... no Tcl glue required.
1787 retval
= jtag_register_commands(ctx
);
1789 if (retval
!= ERROR_OK
)
1792 retval
= svf_register_commands(ctx
);
1794 if (retval
!= ERROR_OK
)
1797 return xsvf_register_commands(ctx
);
1800 static struct transport jtag_transport
= {
1802 .select
= jtag_select
,
1806 static void jtag_constructor(void) __attribute__((constructor
));
1807 static void jtag_constructor(void)
1809 transport_register(&jtag_transport
);
1812 /** Returns true if the current debug session
1813 * is using JTAG as its transport.
1815 bool transport_is_jtag(void)
1817 return get_current_transport() == &jtag_transport
;
1820 void adapter_assert_reset(void)
1822 if (transport_is_jtag()) {
1823 if (jtag_reset_config
& RESET_SRST_PULLS_TRST
)
1824 jtag_add_reset(1, 1);
1826 jtag_add_reset(0, 1);
1827 } else if (transport_is_swd())
1829 else if (transport_is_cmsis_dap())
1830 swd_add_reset(1); /* FIXME */
1831 else if (get_current_transport() != NULL
)
1832 LOG_ERROR("reset is not supported on %s",
1833 get_current_transport()->name
);
1835 LOG_ERROR("transport is not selected");
1838 void adapter_deassert_reset(void)
1840 if (transport_is_jtag())
1841 jtag_add_reset(0, 0);
1842 else if (transport_is_swd())
1844 else if (transport_is_cmsis_dap())
1845 swd_add_reset(0); /* FIXME */
1846 else if (get_current_transport() != NULL
)
1847 LOG_ERROR("reset is not supported on %s",
1848 get_current_transport()->name
);
1850 LOG_ERROR("transport is not selected");
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)