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, see <http://www.gnu.org/licenses/>. *
27 ***************************************************************************/
35 #include "interface.h"
36 #include <transport/transport.h>
37 #include <helper/jep106.h>
43 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
45 #include "xsvf/xsvf.h"
47 /** The number of JTAG queue flushes (for profiling and debugging purposes). */
48 static int jtag_flush_queue_count
;
50 /* Sleep this # of ms after flushing the queue */
51 static int jtag_flush_queue_sleep
;
53 static void jtag_add_scan_check(struct jtag_tap
*active
,
54 void (*jtag_add_scan
)(struct jtag_tap
*active
,
56 const struct scan_field
*in_fields
,
58 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
);
61 * The jtag_error variable is set when an error occurs while executing
62 * the queue. Application code may set this using jtag_set_error(),
63 * when an error occurs during processing that should be reported during
64 * jtag_execute_queue().
66 * The value is set and cleared, but never read by normal application code.
68 * This value is returned (and cleared) by jtag_execute_queue().
70 static int jtag_error
= ERROR_OK
;
72 static const char *jtag_event_strings
[] = {
73 [JTAG_TRST_ASSERTED
] = "TAP reset",
74 [JTAG_TAP_EVENT_SETUP
] = "TAP setup",
75 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
76 [JTAG_TAP_EVENT_DISABLE
] = "TAP disabled",
80 * JTAG adapters must initialize with TRST and SRST de-asserted
81 * (they're negative logic, so that means *high*). But some
82 * hardware doesn't necessarily work that way ... so set things
83 * up so that jtag_init() always forces that state.
85 static int jtag_trst
= -1;
86 static int jtag_srst
= -1;
89 * List all TAPs that have been created.
91 static struct jtag_tap
*__jtag_all_taps
;
93 static enum reset_types jtag_reset_config
= RESET_NONE
;
94 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
96 static bool jtag_verify_capture_ir
= true;
97 static int jtag_verify
= 1;
99 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines
100 *deasserted (in ms) */
101 static int adapter_nsrst_delay
; /* default to no nSRST delay */
102 static int jtag_ntrst_delay
;/* default to no nTRST delay */
103 static int adapter_nsrst_assert_width
; /* width of assertion */
104 static int jtag_ntrst_assert_width
; /* width of assertion */
107 * Contains a single callback along with a pointer that will be passed
108 * when an event occurs.
110 struct jtag_event_callback
{
111 /** a event callback */
112 jtag_event_handler_t callback
;
113 /** the private data to pass to the callback */
115 /** the next callback */
116 struct jtag_event_callback
*next
;
119 /* callbacks to inform high-level handlers about JTAG state changes */
120 static struct jtag_event_callback
*jtag_event_callbacks
;
123 static int speed_khz
;
124 /* speed to fallback to when RCLK is requested but not supported */
125 static int rclk_fallback_speed_khz
;
126 static enum {CLOCK_MODE_UNSELECTED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
127 static int jtag_speed
;
129 /* FIXME: change name to this variable, it is not anymore JTAG only */
130 static struct adapter_driver
*jtag
;
132 extern struct adapter_driver
*adapter_driver
;
134 void jtag_set_flush_queue_sleep(int ms
)
136 jtag_flush_queue_sleep
= ms
;
139 void jtag_set_error(int error
)
141 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
146 int jtag_error_clear(void)
148 int temp
= jtag_error
;
149 jtag_error
= ERROR_OK
;
155 static bool jtag_poll
= 1;
157 bool is_jtag_poll_safe(void)
159 /* Polling can be disabled explicitly with set_enabled(false).
160 * It is also implicitly disabled while TRST is active and
161 * while SRST is gating the JTAG clock.
163 if (!transport_is_jtag())
166 if (!jtag_poll
|| jtag_trst
!= 0)
168 return jtag_srst
== 0 || (jtag_reset_config
& RESET_SRST_NO_GATING
);
171 bool jtag_poll_get_enabled(void)
176 void jtag_poll_set_enabled(bool value
)
183 struct jtag_tap
*jtag_all_taps(void)
185 return __jtag_all_taps
;
188 unsigned jtag_tap_count(void)
190 struct jtag_tap
*t
= jtag_all_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 static void jtag_tap_add(struct jtag_tap
*t
)
214 unsigned jtag_num_taps
= 0;
216 struct jtag_tap
**tap
= &__jtag_all_taps
;
217 while (*tap
!= NULL
) {
219 tap
= &(*tap
)->next_tap
;
222 t
->abs_chain_position
= jtag_num_taps
;
225 /* returns a pointer to the n-th device in the scan chain */
226 struct jtag_tap
*jtag_tap_by_position(unsigned n
)
228 struct jtag_tap
*t
= jtag_all_taps();
236 struct jtag_tap
*jtag_tap_by_string(const char *s
)
238 /* try by name first */
239 struct jtag_tap
*t
= jtag_all_taps();
242 if (0 == strcmp(t
->dotted_name
, s
))
247 /* no tap found by name, so try to parse the name as a number */
249 if (parse_uint(s
, &n
) != ERROR_OK
)
252 /* FIXME remove this numeric fallback code late June 2010, along
253 * with all info in the User's Guide that TAPs have numeric IDs.
254 * Also update "scan_chain" output to not display the numbers.
256 t
= jtag_tap_by_position(n
);
258 LOG_WARNING("Specify TAP '%s' by name, not number %u",
264 struct jtag_tap
*jtag_tap_next_enabled(struct jtag_tap
*p
)
266 p
= p
? p
->next_tap
: jtag_all_taps();
275 const char *jtag_tap_name(const struct jtag_tap
*tap
)
277 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
281 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
283 struct jtag_event_callback
**callbacks_p
= &jtag_event_callbacks
;
285 if (callback
== NULL
)
286 return ERROR_COMMAND_SYNTAX_ERROR
;
289 while ((*callbacks_p
)->next
)
290 callbacks_p
= &((*callbacks_p
)->next
);
291 callbacks_p
= &((*callbacks_p
)->next
);
294 (*callbacks_p
) = malloc(sizeof(struct jtag_event_callback
));
295 (*callbacks_p
)->callback
= callback
;
296 (*callbacks_p
)->priv
= priv
;
297 (*callbacks_p
)->next
= NULL
;
302 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
304 struct jtag_event_callback
**p
= &jtag_event_callbacks
, *temp
;
306 if (callback
== NULL
)
307 return ERROR_COMMAND_SYNTAX_ERROR
;
310 if (((*p
)->priv
!= priv
) || ((*p
)->callback
!= callback
)) {
323 int jtag_call_event_callbacks(enum jtag_event event
)
325 struct jtag_event_callback
*callback
= jtag_event_callbacks
;
327 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
330 struct jtag_event_callback
*next
;
332 /* callback may remove itself */
333 next
= callback
->next
;
334 callback
->callback(event
, callback
->priv
);
341 static void jtag_checks(void)
343 assert(jtag_trst
== 0);
346 static void jtag_prelude(tap_state_t state
)
350 assert(state
!= TAP_INVALID
);
352 cmd_queue_cur_state
= state
;
355 void jtag_add_ir_scan_noverify(struct jtag_tap
*active
, const struct scan_field
*in_fields
,
360 int retval
= interface_jtag_add_ir_scan(active
, in_fields
, state
);
361 jtag_set_error(retval
);
364 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap
*active
,
366 const struct scan_field
*in_fields
,
369 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
372 /* If fields->in_value is filled out, then the captured IR value will be checked */
373 void jtag_add_ir_scan(struct jtag_tap
*active
, struct scan_field
*in_fields
, tap_state_t state
)
375 assert(state
!= TAP_RESET
);
377 if (jtag_verify
&& jtag_verify_capture_ir
) {
378 /* 8 x 32 bit id's is enough for all invocations */
380 /* if we are to run a verification of the ir scan, we need to get the input back.
381 * We may have to allocate space if the caller didn't ask for the input back.
383 in_fields
->check_value
= active
->expected
;
384 in_fields
->check_mask
= active
->expected_mask
;
385 jtag_add_scan_check(active
, jtag_add_ir_scan_noverify_callback
, 1, in_fields
,
388 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
391 void jtag_add_plain_ir_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
394 assert(out_bits
!= NULL
);
395 assert(state
!= TAP_RESET
);
399 int retval
= interface_jtag_add_plain_ir_scan(
400 num_bits
, out_bits
, in_bits
, state
);
401 jtag_set_error(retval
);
404 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
405 uint8_t *in_check_mask
, int num_bits
);
407 static int jtag_check_value_mask_callback(jtag_callback_data_t data0
,
408 jtag_callback_data_t data1
,
409 jtag_callback_data_t data2
,
410 jtag_callback_data_t data3
)
412 return jtag_check_value_inner((uint8_t *)data0
,
418 static void jtag_add_scan_check(struct jtag_tap
*active
, void (*jtag_add_scan
)(
419 struct jtag_tap
*active
,
421 const struct scan_field
*in_fields
,
423 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
)
425 jtag_add_scan(active
, in_num_fields
, in_fields
, state
);
427 for (int i
= 0; i
< in_num_fields
; i
++) {
428 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
)) {
429 jtag_add_callback4(jtag_check_value_mask_callback
,
430 (jtag_callback_data_t
)in_fields
[i
].in_value
,
431 (jtag_callback_data_t
)in_fields
[i
].check_value
,
432 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
433 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
438 void jtag_add_dr_scan_check(struct jtag_tap
*active
,
440 struct scan_field
*in_fields
,
444 jtag_add_scan_check(active
, jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
446 jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
450 void jtag_add_dr_scan(struct jtag_tap
*active
,
452 const struct scan_field
*in_fields
,
455 assert(state
!= TAP_RESET
);
460 retval
= interface_jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
461 jtag_set_error(retval
);
464 void jtag_add_plain_dr_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
467 assert(out_bits
!= NULL
);
468 assert(state
!= TAP_RESET
);
473 retval
= interface_jtag_add_plain_dr_scan(num_bits
, out_bits
, in_bits
, state
);
474 jtag_set_error(retval
);
477 void jtag_add_tlr(void)
479 jtag_prelude(TAP_RESET
);
480 jtag_set_error(interface_jtag_add_tlr());
482 /* NOTE: order here matches TRST path in jtag_add_reset() */
483 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
484 jtag_notify_event(JTAG_TRST_ASSERTED
);
488 * If supported by the underlying adapter, this clocks a raw bit sequence
489 * onto TMS for switching betwen JTAG and SWD modes.
491 * DO NOT use this to bypass the integrity checks and logging provided
492 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
494 * @param nbits How many bits to clock out.
495 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
496 * @param state The JTAG tap state to record on completion. Use
497 * TAP_INVALID to represent being in in SWD mode.
499 * @todo Update naming conventions to stop assuming everything is JTAG.
501 int jtag_add_tms_seq(unsigned nbits
, const uint8_t *seq
, enum tap_state state
)
505 if (!(jtag
->jtag_ops
->supported
& DEBUG_CAP_TMS_SEQ
))
506 return ERROR_JTAG_NOT_IMPLEMENTED
;
509 cmd_queue_cur_state
= state
;
511 retval
= interface_add_tms_seq(nbits
, seq
, state
);
512 jtag_set_error(retval
);
516 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
518 tap_state_t cur_state
= cmd_queue_cur_state
;
520 /* the last state has to be a stable state */
521 if (!tap_is_state_stable(path
[num_states
- 1])) {
522 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
523 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
527 for (int i
= 0; i
< num_states
; i
++) {
528 if (path
[i
] == TAP_RESET
) {
529 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
530 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
534 if (tap_state_transition(cur_state
, true) != path
[i
] &&
535 tap_state_transition(cur_state
, false) != path
[i
]) {
536 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
537 tap_state_name(cur_state
), tap_state_name(path
[i
]));
538 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
546 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
547 cmd_queue_cur_state
= path
[num_states
- 1];
550 int jtag_add_statemove(tap_state_t goal_state
)
552 tap_state_t cur_state
= cmd_queue_cur_state
;
554 if (goal_state
!= cur_state
) {
555 LOG_DEBUG("cur_state=%s goal_state=%s",
556 tap_state_name(cur_state
),
557 tap_state_name(goal_state
));
560 /* If goal is RESET, be paranoid and force that that transition
561 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
563 if (goal_state
== TAP_RESET
)
565 else if (goal_state
== cur_state
)
568 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
)) {
569 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
570 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
571 tap_state_t moves
[8];
572 assert(tms_count
< ARRAY_SIZE(moves
));
574 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
);
582 } else if (tap_state_transition(cur_state
, true) == goal_state
583 || tap_state_transition(cur_state
, false) == goal_state
)
584 jtag_add_pathmove(1, &goal_state
);
591 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
594 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
598 void jtag_add_clocks(int num_cycles
)
600 if (!tap_is_state_stable(cmd_queue_cur_state
)) {
601 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
602 tap_state_name(cmd_queue_cur_state
));
603 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
607 if (num_cycles
> 0) {
609 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
613 static int adapter_system_reset(int req_srst
)
618 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
619 LOG_ERROR("BUG: can't assert SRST");
625 /* Maybe change SRST signal state */
626 if (jtag_srst
!= req_srst
) {
627 retval
= jtag
->reset(0, req_srst
);
628 if (retval
!= ERROR_OK
) {
629 LOG_ERROR("SRST error");
632 jtag_srst
= req_srst
;
635 LOG_DEBUG("SRST line asserted");
636 if (adapter_nsrst_assert_width
)
637 jtag_sleep(adapter_nsrst_assert_width
* 1000);
639 LOG_DEBUG("SRST line released");
640 if (adapter_nsrst_delay
)
641 jtag_sleep(adapter_nsrst_delay
* 1000);
648 static void legacy_jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
650 int trst_with_tlr
= 0;
654 /* Without SRST, we must use target-specific JTAG operations
655 * on each target; callers should not be requesting SRST when
656 * that signal doesn't exist.
658 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
659 * can kick in even if the JTAG adapter can't drive TRST.
662 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
663 LOG_ERROR("BUG: can't assert SRST");
664 jtag_set_error(ERROR_FAIL
);
667 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
668 && !req_tlr_or_trst
) {
669 LOG_ERROR("BUG: can't assert only SRST");
670 jtag_set_error(ERROR_FAIL
);
676 /* JTAG reset (entry to TAP_RESET state) can always be achieved
677 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
678 * state first. TRST accelerates it, and bypasses those states.
680 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
681 * can kick in even if the JTAG adapter can't drive SRST.
683 if (req_tlr_or_trst
) {
684 if (!(jtag_reset_config
& RESET_HAS_TRST
))
686 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
693 /* Maybe change TRST and/or SRST signal state */
694 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
697 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
698 if (retval
!= ERROR_OK
)
699 jtag_set_error(retval
);
701 retval
= jtag_execute_queue();
703 if (retval
!= ERROR_OK
) {
704 LOG_ERROR("TRST/SRST error");
709 /* SRST resets everything hooked up to that signal */
710 if (jtag_srst
!= new_srst
) {
711 jtag_srst
= new_srst
;
713 LOG_DEBUG("SRST line asserted");
714 if (adapter_nsrst_assert_width
)
715 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
717 LOG_DEBUG("SRST line released");
718 if (adapter_nsrst_delay
)
719 jtag_add_sleep(adapter_nsrst_delay
* 1000);
723 /* Maybe enter the JTAG TAP_RESET state ...
724 * - using only TMS, TCK, and the JTAG state machine
725 * - or else more directly, using TRST
727 * TAP_RESET should be invisible to non-debug parts of the system.
730 LOG_DEBUG("JTAG reset with TLR instead of TRST");
733 } else if (jtag_trst
!= new_trst
) {
734 jtag_trst
= new_trst
;
736 LOG_DEBUG("TRST line asserted");
737 tap_set_state(TAP_RESET
);
738 if (jtag_ntrst_assert_width
)
739 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
741 LOG_DEBUG("TRST line released");
742 if (jtag_ntrst_delay
)
743 jtag_add_sleep(jtag_ntrst_delay
* 1000);
745 /* We just asserted nTRST, so we're now in TAP_RESET.
746 * Inform possible listeners about this, now that
747 * JTAG instructions and data can be shifted. This
748 * sequence must match jtag_add_tlr().
750 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
751 jtag_notify_event(JTAG_TRST_ASSERTED
);
756 /* FIXME: name is misleading; we do not plan to "add" reset into jtag queue */
757 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
760 int trst_with_tlr
= 0;
765 legacy_jtag_add_reset(req_tlr_or_trst
, req_srst
);
769 /* Without SRST, we must use target-specific JTAG operations
770 * on each target; callers should not be requesting SRST when
771 * that signal doesn't exist.
773 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
774 * can kick in even if the JTAG adapter can't drive TRST.
777 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
778 LOG_ERROR("BUG: can't assert SRST");
779 jtag_set_error(ERROR_FAIL
);
782 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
783 && !req_tlr_or_trst
) {
784 LOG_ERROR("BUG: can't assert only SRST");
785 jtag_set_error(ERROR_FAIL
);
791 /* JTAG reset (entry to TAP_RESET state) can always be achieved
792 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
793 * state first. TRST accelerates it, and bypasses those states.
795 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
796 * can kick in even if the JTAG adapter can't drive SRST.
798 if (req_tlr_or_trst
) {
799 if (!(jtag_reset_config
& RESET_HAS_TRST
))
801 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
808 /* Maybe change TRST and/or SRST signal state */
809 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
810 /* guarantee jtag queue empty before changing reset status */
811 jtag_execute_queue();
813 retval
= jtag
->reset(new_trst
, new_srst
);
814 if (retval
!= ERROR_OK
) {
815 jtag_set_error(retval
);
816 LOG_ERROR("TRST/SRST error");
821 /* SRST resets everything hooked up to that signal */
822 if (jtag_srst
!= new_srst
) {
823 jtag_srst
= new_srst
;
825 LOG_DEBUG("SRST line asserted");
826 if (adapter_nsrst_assert_width
)
827 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
829 LOG_DEBUG("SRST line released");
830 if (adapter_nsrst_delay
)
831 jtag_add_sleep(adapter_nsrst_delay
* 1000);
835 /* Maybe enter the JTAG TAP_RESET state ...
836 * - using only TMS, TCK, and the JTAG state machine
837 * - or else more directly, using TRST
839 * TAP_RESET should be invisible to non-debug parts of the system.
842 LOG_DEBUG("JTAG reset with TLR instead of TRST");
844 jtag_execute_queue();
846 } else if (jtag_trst
!= new_trst
) {
847 jtag_trst
= new_trst
;
849 LOG_DEBUG("TRST line asserted");
850 tap_set_state(TAP_RESET
);
851 if (jtag_ntrst_assert_width
)
852 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
854 LOG_DEBUG("TRST line released");
855 if (jtag_ntrst_delay
)
856 jtag_add_sleep(jtag_ntrst_delay
* 1000);
858 /* We just asserted nTRST, so we're now in TAP_RESET.
859 * Inform possible listeners about this, now that
860 * JTAG instructions and data can be shifted. This
861 * sequence must match jtag_add_tlr().
863 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
864 jtag_notify_event(JTAG_TRST_ASSERTED
);
869 void jtag_add_sleep(uint32_t us
)
871 /** @todo Here, keep_alive() appears to be a layering violation!!! */
873 jtag_set_error(interface_jtag_add_sleep(us
));
876 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
877 uint8_t *in_check_mask
, int num_bits
)
879 int retval
= ERROR_OK
;
883 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
885 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
887 if (compare_failed
) {
888 char *captured_str
, *in_check_value_str
;
889 int bits
= (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
;
891 /* NOTE: we've lost diagnostic context here -- 'which tap' */
893 captured_str
= buf_to_hex_str(captured
, bits
);
894 in_check_value_str
= buf_to_hex_str(in_check_value
, bits
);
896 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
898 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
901 free(in_check_value_str
);
904 char *in_check_mask_str
;
906 in_check_mask_str
= buf_to_hex_str(in_check_mask
, bits
);
907 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
908 free(in_check_mask_str
);
911 retval
= ERROR_JTAG_QUEUE_FAILED
;
916 void jtag_check_value_mask(struct scan_field
*field
, uint8_t *value
, uint8_t *mask
)
918 assert(field
->in_value
!= NULL
);
921 /* no checking to do */
925 jtag_execute_queue_noclear();
927 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
928 jtag_set_error(retval
);
931 int default_interface_jtag_execute_queue(void)
934 LOG_ERROR("No JTAG interface configured yet. "
935 "Issue 'init' command in startup scripts "
936 "before communicating with targets.");
940 if (!transport_is_jtag()) {
942 * FIXME: This should not happen!
943 * There could be old code that queues jtag commands with non jtag interfaces so, for
944 * the moment simply highlight it by log an error and return on empty execute_queue.
945 * We should fix it quitting with assert(0) because it is an internal error.
946 * The fix can be applied immediately after next release (v0.11.0 ?)
948 LOG_ERROR("JTAG API jtag_execute_queue() called on non JTAG interface");
949 if (!jtag
->jtag_ops
|| !jtag
->jtag_ops
->execute_queue
)
953 int result
= jtag
->jtag_ops
->execute_queue();
955 struct jtag_command
*cmd
= jtag_command_queue
;
956 while (debug_level
>= LOG_LVL_DEBUG_IO
&& cmd
) {
959 LOG_DEBUG_IO("JTAG %s SCAN to %s",
960 cmd
->cmd
.scan
->ir_scan
? "IR" : "DR",
961 tap_state_name(cmd
->cmd
.scan
->end_state
));
962 for (int i
= 0; i
< cmd
->cmd
.scan
->num_fields
; i
++) {
963 struct scan_field
*field
= cmd
->cmd
.scan
->fields
+ i
;
964 if (field
->out_value
) {
965 char *str
= buf_to_hex_str(field
->out_value
, field
->num_bits
);
966 LOG_DEBUG_IO(" %db out: %s", field
->num_bits
, str
);
969 if (field
->in_value
) {
970 char *str
= buf_to_hex_str(field
->in_value
, field
->num_bits
);
971 LOG_DEBUG_IO(" %db in: %s", field
->num_bits
, str
);
977 LOG_DEBUG_IO("JTAG TLR RESET to %s",
978 tap_state_name(cmd
->cmd
.statemove
->end_state
));
981 LOG_DEBUG_IO("JTAG RUNTEST %d cycles to %s",
982 cmd
->cmd
.runtest
->num_cycles
,
983 tap_state_name(cmd
->cmd
.runtest
->end_state
));
987 const char *reset_str
[3] = {
988 "leave", "deassert", "assert"
990 LOG_DEBUG_IO("JTAG RESET %s TRST, %s SRST",
991 reset_str
[cmd
->cmd
.reset
->trst
+ 1],
992 reset_str
[cmd
->cmd
.reset
->srst
+ 1]);
996 LOG_DEBUG_IO("JTAG PATHMOVE (TODO)");
999 LOG_DEBUG_IO("JTAG SLEEP (TODO)");
1001 case JTAG_STABLECLOCKS
:
1002 LOG_DEBUG_IO("JTAG STABLECLOCKS (TODO)");
1005 LOG_DEBUG_IO("JTAG TMS (TODO)");
1008 LOG_ERROR("Unknown JTAG command: %d", cmd
->type
);
1017 void jtag_execute_queue_noclear(void)
1019 jtag_flush_queue_count
++;
1020 jtag_set_error(interface_jtag_execute_queue());
1022 if (jtag_flush_queue_sleep
> 0) {
1023 /* For debug purposes it can be useful to test performance
1024 * or behavior when delaying after flushing the queue,
1025 * e.g. to simulate long roundtrip times.
1027 usleep(jtag_flush_queue_sleep
* 1000);
1031 int jtag_get_flush_queue_count(void)
1033 return jtag_flush_queue_count
;
1036 int jtag_execute_queue(void)
1038 jtag_execute_queue_noclear();
1039 return jtag_error_clear();
1042 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
1044 struct jtag_tap
*tap
= priv
;
1046 if (event
== JTAG_TRST_ASSERTED
) {
1047 tap
->enabled
= !tap
->disabled_after_reset
;
1049 /* current instruction is either BYPASS or IDCODE */
1050 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1057 /* sleep at least us microseconds. When we sleep more than 1000ms we
1058 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
1059 * GDB if we slept for <1000ms many times.
1061 void jtag_sleep(uint32_t us
)
1066 alive_sleep((us
+999)/1000);
1069 #define JTAG_MAX_AUTO_TAPS 20
1071 #define EXTRACT_JEP106_BANK(X) (((X) & 0xf00) >> 8)
1072 #define EXTRACT_JEP106_ID(X) (((X) & 0xfe) >> 1)
1073 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1074 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1075 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1077 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
1078 * know that no valid TAP will have it as an IDCODE value.
1080 #define END_OF_CHAIN_FLAG 0xffffffff
1082 /* a larger IR length than we ever expect to autoprobe */
1083 #define JTAG_IRLEN_MAX 60
1085 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
1087 struct scan_field field
= {
1088 .num_bits
= num_idcode
* 32,
1089 .out_value
= idcode_buffer
,
1090 .in_value
= idcode_buffer
,
1093 /* initialize to the end of chain ID value */
1094 for (unsigned i
= 0; i
< num_idcode
; i
++)
1095 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
1097 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
1099 return jtag_execute_queue();
1102 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
1104 uint8_t zero_check
= 0x0;
1105 uint8_t one_check
= 0xff;
1107 for (unsigned i
= 0; i
< count
* 4; i
++) {
1108 zero_check
|= idcodes
[i
];
1109 one_check
&= idcodes
[i
];
1112 /* if there wasn't a single non-zero bit or if all bits were one,
1113 * the scan is not valid. We wrote a mix of both values; either
1115 * - There's a hardware issue (almost certainly):
1116 * + all-zeroes can mean a target stuck in JTAG reset
1117 * + all-ones tends to mean no target
1118 * - The scan chain is WAY longer than we can handle, *AND* either
1119 * + there are several hundreds of TAPs in bypass, or
1120 * + at least a few dozen TAPs all have an all-ones IDCODE
1122 if (zero_check
== 0x00 || one_check
== 0xff) {
1123 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
1124 (zero_check
== 0x00) ? "zeroes" : "ones");
1125 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
1131 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
1132 const char *name
, uint32_t idcode
)
1134 log_printf_lf(level
, __FILE__
, __LINE__
, __func__
,
1135 "JTAG tap: %s %16.16s: 0x%08x "
1136 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
1138 (unsigned int)idcode
,
1139 (unsigned int)EXTRACT_MFG(idcode
),
1140 jep106_manufacturer(EXTRACT_JEP106_BANK(idcode
), EXTRACT_JEP106_ID(idcode
)),
1141 (unsigned int)EXTRACT_PART(idcode
),
1142 (unsigned int)EXTRACT_VER(idcode
));
1145 static bool jtag_idcode_is_final(uint32_t idcode
)
1148 * Some devices, such as AVR8, will output all 1's instead
1149 * of TDI input value at end of chain. Allow those values
1150 * instead of failing.
1152 return idcode
== END_OF_CHAIN_FLAG
;
1156 * This helper checks that remaining bits in the examined chain data are
1157 * all as expected, but a single JTAG device requires only 64 bits to be
1158 * read back correctly. This can help identify and diagnose problems
1159 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1160 * Returns TRUE iff garbage was found.
1162 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
1164 bool triggered
= false;
1165 for (; count
< max
- 31; count
+= 32) {
1166 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
1168 /* do not trigger the warning if the data looks good */
1169 if (jtag_idcode_is_final(idcode
))
1171 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1172 count
, (unsigned int)idcode
);
1178 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
1181 if (tap
->expected_ids_cnt
== 0 || !tap
->hasidcode
)
1184 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1185 uint32_t mask
= tap
->ignore_version
? ~(0xfU
<< 28) : ~0U;
1186 uint32_t idcode
= tap
->idcode
& mask
;
1188 /* Loop over the expected identification codes and test for a match */
1189 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1190 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
1192 if (idcode
== expected
)
1195 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1196 if (0 == tap
->expected_ids
[ii
])
1200 /* If none of the expected ids matched, warn */
1201 jtag_examine_chain_display(LOG_LVL_WARNING
, "UNEXPECTED",
1202 tap
->dotted_name
, tap
->idcode
);
1203 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1206 snprintf(msg
, sizeof(msg
), "expected %u of %u", ii
+ 1, tap
->expected_ids_cnt
);
1207 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1208 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1213 /* Try to examine chain layout according to IEEE 1149.1 §12
1214 * This is called a "blind interrogation" of the scan chain.
1216 static int jtag_examine_chain(void)
1219 unsigned max_taps
= jtag_tap_count();
1221 /* Autoprobe up to this many. */
1222 if (max_taps
< JTAG_MAX_AUTO_TAPS
)
1223 max_taps
= JTAG_MAX_AUTO_TAPS
;
1225 /* Add room for end-of-chain marker. */
1228 uint8_t *idcode_buffer
= calloc(4, max_taps
);
1229 if (idcode_buffer
== NULL
)
1230 return ERROR_JTAG_INIT_FAILED
;
1232 /* DR scan to collect BYPASS or IDCODE register contents.
1233 * Then make sure the scan data has both ones and zeroes.
1235 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1236 retval
= jtag_examine_chain_execute(idcode_buffer
, max_taps
);
1237 if (retval
!= ERROR_OK
)
1239 if (!jtag_examine_chain_check(idcode_buffer
, max_taps
)) {
1240 retval
= ERROR_JTAG_INIT_FAILED
;
1244 /* Point at the 1st predefined tap, if any */
1245 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1247 unsigned bit_count
= 0;
1248 unsigned autocount
= 0;
1249 for (unsigned i
= 0; i
< max_taps
; i
++) {
1250 assert(bit_count
< max_taps
* 32);
1251 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1253 /* No predefined TAP? Auto-probe. */
1255 /* Is there another TAP? */
1256 if (jtag_idcode_is_final(idcode
))
1259 /* Default everything in this TAP except IR length.
1261 * REVISIT create a jtag_alloc(chip, tap) routine, and
1262 * share it with jim_newtap_cmd().
1264 tap
= calloc(1, sizeof(*tap
));
1266 retval
= ERROR_FAIL
;
1270 tap
->chip
= alloc_printf("auto%u", autocount
++);
1271 tap
->tapname
= strdup("tap");
1272 tap
->dotted_name
= alloc_printf("%s.%s", tap
->chip
, tap
->tapname
);
1274 tap
->ir_length
= 0; /* ... signifying irlen autoprobe */
1275 tap
->ir_capture_mask
= 0x03;
1276 tap
->ir_capture_value
= 0x01;
1278 tap
->enabled
= true;
1283 if ((idcode
& 1) == 0) {
1284 /* Zero for LSB indicates a device in bypass */
1285 LOG_INFO("TAP %s does not have valid IDCODE (idcode=0x%" PRIx32
")",
1286 tap
->dotted_name
, idcode
);
1287 tap
->hasidcode
= false;
1292 /* Friendly devices support IDCODE */
1293 tap
->hasidcode
= true;
1294 tap
->idcode
= idcode
;
1295 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found", tap
->dotted_name
, idcode
);
1300 /* ensure the TAP ID matches what was expected */
1301 if (!jtag_examine_chain_match_tap(tap
))
1302 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1304 tap
= jtag_tap_next_enabled(tap
);
1307 /* After those IDCODE or BYPASS register values should be
1308 * only the data we fed into the scan chain.
1310 if (jtag_examine_chain_end(idcode_buffer
, bit_count
, max_taps
* 32)) {
1311 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1312 retval
= ERROR_JTAG_INIT_FAILED
;
1316 /* Return success or, for backwards compatibility if only
1317 * some IDCODE values mismatched, a soft/continuable fault.
1320 free(idcode_buffer
);
1325 * Validate the date loaded by entry to the Capture-IR state, to help
1326 * find errors related to scan chain configuration (wrong IR lengths)
1329 * Entry state can be anything. On non-error exit, all TAPs are in
1330 * bypass mode. On error exits, the scan chain is reset.
1332 static int jtag_validate_ircapture(void)
1334 struct jtag_tap
*tap
;
1335 int total_ir_length
= 0;
1336 uint8_t *ir_test
= NULL
;
1337 struct scan_field field
;
1342 /* when autoprobing, accomodate huge IR lengths */
1343 for (tap
= NULL
, total_ir_length
= 0;
1344 (tap
= jtag_tap_next_enabled(tap
)) != NULL
;
1345 total_ir_length
+= tap
->ir_length
) {
1346 if (tap
->ir_length
== 0)
1347 total_ir_length
+= JTAG_IRLEN_MAX
;
1350 /* increase length to add 2 bit sentinel after scan */
1351 total_ir_length
+= 2;
1353 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1354 if (ir_test
== NULL
)
1357 /* after this scan, all TAPs will capture BYPASS instructions */
1358 buf_set_ones(ir_test
, total_ir_length
);
1360 field
.num_bits
= total_ir_length
;
1361 field
.out_value
= ir_test
;
1362 field
.in_value
= ir_test
;
1364 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1366 LOG_DEBUG("IR capture validation scan");
1367 retval
= jtag_execute_queue();
1368 if (retval
!= ERROR_OK
)
1375 tap
= jtag_tap_next_enabled(tap
);
1379 /* If we're autoprobing, guess IR lengths. They must be at
1380 * least two bits. Guessing will fail if (a) any TAP does
1381 * not conform to the JTAG spec; or (b) when the upper bits
1382 * captured from some conforming TAP are nonzero. Or if
1383 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1384 * an implementation limit, which could someday be raised.
1386 * REVISIT optimization: if there's a *single* TAP we can
1387 * lift restrictions (a) and (b) by scanning a recognizable
1388 * pattern before the all-ones BYPASS. Check for where the
1389 * pattern starts in the result, instead of an 0...01 value.
1391 * REVISIT alternative approach: escape to some tcl code
1392 * which could provide more knowledge, based on IDCODE; and
1393 * only guess when that has no success.
1395 if (tap
->ir_length
== 0) {
1397 while ((val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
+ 1)) == 1
1398 && tap
->ir_length
< JTAG_IRLEN_MAX
) {
1401 LOG_WARNING("AUTO %s - use \"jtag newtap %s %s -irlen %d "
1402 "-expected-id 0x%08" PRIx32
"\"",
1403 tap
->dotted_name
, tap
->chip
, tap
->tapname
, tap
->ir_length
, tap
->idcode
);
1406 /* Validate the two LSBs, which must be 01 per JTAG spec.
1408 * Or ... more bits could be provided by TAP declaration.
1409 * Plus, some taps (notably in i.MX series chips) violate
1410 * this part of the JTAG spec, so their capture mask/value
1411 * attributes might disable this test.
1413 val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
);
1414 if ((val
& tap
->ir_capture_mask
) != tap
->ir_capture_value
) {
1415 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64
" not 0x%0*" PRIx32
,
1417 (tap
->ir_length
+ 7) / tap
->ir_length
, val
,
1418 (tap
->ir_length
+ 7) / tap
->ir_length
, tap
->ir_capture_value
);
1420 retval
= ERROR_JTAG_INIT_FAILED
;
1423 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64
, jtag_tap_name(tap
),
1424 (tap
->ir_length
+ 7) / tap
->ir_length
, val
);
1425 chain_pos
+= tap
->ir_length
;
1428 /* verify the '11' sentinel we wrote is returned at the end */
1429 val
= buf_get_u64(ir_test
, chain_pos
, 2);
1431 char *cbuf
= buf_to_hex_str(ir_test
, total_ir_length
);
1433 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1436 retval
= ERROR_JTAG_INIT_FAILED
;
1441 if (retval
!= ERROR_OK
) {
1443 jtag_execute_queue();
1448 void jtag_tap_init(struct jtag_tap
*tap
)
1450 unsigned ir_len_bits
;
1451 unsigned ir_len_bytes
;
1453 /* if we're autoprobing, cope with potentially huge ir_length */
1454 ir_len_bits
= tap
->ir_length
? : JTAG_IRLEN_MAX
;
1455 ir_len_bytes
= DIV_ROUND_UP(ir_len_bits
, 8);
1457 tap
->expected
= calloc(1, ir_len_bytes
);
1458 tap
->expected_mask
= calloc(1, ir_len_bytes
);
1459 tap
->cur_instr
= malloc(ir_len_bytes
);
1461 /** @todo cope better with ir_length bigger than 32 bits */
1462 if (ir_len_bits
> 32)
1465 buf_set_u32(tap
->expected
, 0, ir_len_bits
, tap
->ir_capture_value
);
1466 buf_set_u32(tap
->expected_mask
, 0, ir_len_bits
, tap
->ir_capture_mask
);
1468 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1470 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1472 /* register the reset callback for the TAP */
1473 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1476 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1477 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1478 tap
->abs_chain_position
, tap
->ir_length
,
1479 (unsigned) tap
->ir_capture_value
,
1480 (unsigned) tap
->ir_capture_mask
);
1483 void jtag_tap_free(struct jtag_tap
*tap
)
1485 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1487 struct jtag_tap_event_action
*jteap
= tap
->event_action
;
1489 struct jtag_tap_event_action
*next
= jteap
->next
;
1490 Jim_DecrRefCount(jteap
->interp
, jteap
->body
);
1495 free(tap
->expected
);
1496 free(tap
->expected_mask
);
1497 free(tap
->expected_ids
);
1498 free(tap
->cur_instr
);
1501 free(tap
->dotted_name
);
1506 * Do low-level setup like initializing registers, output signals,
1509 int adapter_init(struct command_context
*cmd_ctx
)
1514 if (!adapter_driver
) {
1515 /* nothing was previously specified by "adapter driver" command */
1516 LOG_ERROR("Debug Adapter has to be specified, "
1517 "see \"adapter driver\" command");
1518 return ERROR_JTAG_INVALID_INTERFACE
;
1522 retval
= adapter_driver
->init();
1523 if (retval
!= ERROR_OK
)
1525 jtag
= adapter_driver
;
1527 if (jtag
->speed
== NULL
) {
1528 LOG_INFO("This adapter doesn't support configurable speed");
1532 if (CLOCK_MODE_UNSELECTED
== clock_mode
) {
1533 LOG_ERROR("An adapter speed is not selected in the init script."
1534 " Insert a call to \"adapter speed\" or \"jtag_rclk\" to proceed.");
1535 return ERROR_JTAG_INIT_FAILED
;
1538 int requested_khz
= jtag_get_speed_khz();
1539 int actual_khz
= requested_khz
;
1540 int jtag_speed_var
= 0;
1541 retval
= jtag_get_speed(&jtag_speed_var
);
1542 if (retval
!= ERROR_OK
)
1544 retval
= jtag
->speed(jtag_speed_var
);
1545 if (retval
!= ERROR_OK
)
1547 retval
= jtag_get_speed_readable(&actual_khz
);
1548 if (ERROR_OK
!= retval
)
1549 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1550 else if (actual_khz
) {
1551 /* Adaptive clocking -- JTAG-specific */
1552 if ((CLOCK_MODE_RCLK
== clock_mode
)
1553 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
)) {
1554 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1557 LOG_INFO("clock speed %d kHz", actual_khz
);
1559 LOG_INFO("RCLK (adaptive clock speed)");
1564 int jtag_init_inner(struct command_context
*cmd_ctx
)
1566 struct jtag_tap
*tap
;
1568 bool issue_setup
= true;
1570 LOG_DEBUG("Init JTAG chain");
1572 tap
= jtag_tap_next_enabled(NULL
);
1574 /* Once JTAG itself is properly set up, and the scan chain
1575 * isn't absurdly large, IDCODE autoprobe should work fine.
1577 * But ... IRLEN autoprobe can fail even on systems which
1578 * are fully conformant to JTAG. Also, JTAG setup can be
1579 * quite finicky on some systems.
1581 * REVISIT: if TAP autoprobe works OK, then in many cases
1582 * we could escape to tcl code and set up targets based on
1583 * the TAP's IDCODE values.
1585 LOG_WARNING("There are no enabled taps. "
1586 "AUTO PROBING MIGHT NOT WORK!!");
1588 /* REVISIT default clock will often be too fast ... */
1592 retval
= jtag_execute_queue();
1593 if (retval
!= ERROR_OK
)
1596 /* Examine DR values first. This discovers problems which will
1597 * prevent communication ... hardware issues like TDO stuck, or
1598 * configuring the wrong number of (enabled) TAPs.
1600 retval
= jtag_examine_chain();
1603 /* complete success */
1606 /* For backward compatibility reasons, try coping with
1607 * configuration errors involving only ID mismatches.
1608 * We might be able to talk to the devices.
1610 * Also the device might be powered down during startup.
1612 * After OpenOCD starts, we can try to power on the device
1615 LOG_ERROR("Trying to use configured scan chain anyway...");
1616 issue_setup
= false;
1620 /* Now look at IR values. Problems here will prevent real
1621 * communication. They mostly mean that the IR length is
1622 * wrong ... or that the IR capture value is wrong. (The
1623 * latter is uncommon, but easily worked around: provide
1624 * ircapture/irmask values during TAP setup.)
1626 retval
= jtag_validate_ircapture();
1627 if (retval
!= ERROR_OK
) {
1628 /* The target might be powered down. The user
1629 * can power it up and reset it after firing
1632 issue_setup
= false;
1636 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1638 LOG_WARNING("Bypassing JTAG setup events due to errors");
1644 int adapter_quit(void)
1646 if (jtag
&& jtag
->quit
) {
1647 /* close the JTAG interface */
1648 int result
= jtag
->quit();
1649 if (ERROR_OK
!= result
)
1650 LOG_ERROR("failed: %d", result
);
1653 struct jtag_tap
*t
= jtag_all_taps();
1655 struct jtag_tap
*n
= t
->next_tap
;
1663 int swd_init_reset(struct command_context
*cmd_ctx
)
1665 int retval
, retval1
;
1667 retval
= adapter_init(cmd_ctx
);
1668 if (retval
!= ERROR_OK
)
1671 LOG_DEBUG("Initializing with hard SRST reset");
1673 if (jtag_reset_config
& RESET_HAS_SRST
)
1674 retval
= adapter_system_reset(1);
1675 retval1
= adapter_system_reset(0);
1677 return (retval
== ERROR_OK
) ? retval1
: retval
;
1680 int jtag_init_reset(struct command_context
*cmd_ctx
)
1682 int retval
= adapter_init(cmd_ctx
);
1683 if (retval
!= ERROR_OK
)
1686 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1689 * This procedure is used by default when OpenOCD triggers a reset.
1690 * It's now done through an overridable Tcl "init_reset" wrapper.
1692 * This started out as a more powerful "get JTAG working" reset than
1693 * jtag_init_inner(), applying TRST because some chips won't activate
1694 * JTAG without a TRST cycle (presumed to be async, though some of
1695 * those chips synchronize JTAG activation using TCK).
1697 * But some chips only activate JTAG as part of an SRST cycle; SRST
1698 * got mixed in. So it became a hard reset routine, which got used
1699 * in more places, and which coped with JTAG reset being forced as
1700 * part of SRST (srst_pulls_trst).
1702 * And even more corner cases started to surface: TRST and/or SRST
1703 * assertion timings matter; some chips need other JTAG operations;
1704 * TRST/SRST sequences can need to be different from these, etc.
1706 * Systems should override that wrapper to support system-specific
1707 * requirements that this not-fully-generic code doesn't handle.
1709 * REVISIT once Tcl code can read the reset_config modes, this won't
1710 * need to be a C routine at all...
1712 if (jtag_reset_config
& RESET_HAS_SRST
) {
1713 jtag_add_reset(1, 1);
1714 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1715 jtag_add_reset(0, 1);
1717 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1720 /* some targets enable us to connect with srst asserted */
1721 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1722 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1723 jtag_add_reset(0, 1);
1725 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1726 jtag_add_reset(0, 0);
1729 jtag_add_reset(0, 0);
1730 retval
= jtag_execute_queue();
1731 if (retval
!= ERROR_OK
)
1734 /* Check that we can communication on the JTAG chain + eventually we want to
1735 * be able to perform enumeration only after OpenOCD has started
1736 * telnet and GDB server
1738 * That would allow users to more easily perform any magic they need to before
1741 return jtag_init_inner(cmd_ctx
);
1744 int jtag_init(struct command_context
*cmd_ctx
)
1746 int retval
= adapter_init(cmd_ctx
);
1747 if (retval
!= ERROR_OK
)
1750 /* guard against oddball hardware: force resets to be inactive */
1751 jtag_add_reset(0, 0);
1753 /* some targets enable us to connect with srst asserted */
1754 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1755 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1756 jtag_add_reset(0, 1);
1758 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1760 retval
= jtag_execute_queue();
1761 if (retval
!= ERROR_OK
)
1764 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1770 unsigned jtag_get_speed_khz(void)
1775 static int adapter_khz_to_speed(unsigned khz
, int *speed
)
1777 LOG_DEBUG("convert khz to interface specific speed value");
1781 LOG_DEBUG("have interface set up");
1783 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1787 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1788 if (ERROR_OK
!= retval
)
1790 *speed
= speed_div1
;
1794 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int *speed
)
1796 int retval
= adapter_khz_to_speed(0, speed
);
1797 if ((ERROR_OK
!= retval
) && fallback_speed_khz
) {
1798 LOG_DEBUG("trying fallback speed...");
1799 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1804 static int jtag_set_speed(int speed
)
1807 /* this command can be called during CONFIG,
1808 * in which case jtag isn't initialized */
1809 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1812 int jtag_config_khz(unsigned khz
)
1814 LOG_DEBUG("handle jtag khz");
1815 clock_mode
= CLOCK_MODE_KHZ
;
1817 int retval
= adapter_khz_to_speed(khz
, &speed
);
1818 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1821 int jtag_config_rclk(unsigned fallback_speed_khz
)
1823 LOG_DEBUG("handle jtag rclk");
1824 clock_mode
= CLOCK_MODE_RCLK
;
1825 rclk_fallback_speed_khz
= fallback_speed_khz
;
1827 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1828 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1831 int jtag_get_speed(int *speed
)
1833 switch (clock_mode
) {
1834 case CLOCK_MODE_KHZ
:
1835 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1837 case CLOCK_MODE_RCLK
:
1838 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1841 LOG_ERROR("BUG: unknown jtag clock mode");
1847 int jtag_get_speed_readable(int *khz
)
1849 int jtag_speed_var
= 0;
1850 int retval
= jtag_get_speed(&jtag_speed_var
);
1851 if (retval
!= ERROR_OK
)
1855 if (!jtag
->speed_div
) {
1856 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1859 return jtag
->speed_div(jtag_speed_var
, khz
);
1862 void jtag_set_verify(bool enable
)
1864 jtag_verify
= enable
;
1867 bool jtag_will_verify(void)
1872 void jtag_set_verify_capture_ir(bool enable
)
1874 jtag_verify_capture_ir
= enable
;
1877 bool jtag_will_verify_capture_ir(void)
1879 return jtag_verify_capture_ir
;
1882 int jtag_power_dropout(int *dropout
)
1885 /* TODO: as the jtag interface is not valid all
1886 * we can do at the moment is exit OpenOCD */
1887 LOG_ERROR("No Valid JTAG Interface Configured.");
1890 if (jtag
->power_dropout
)
1891 return jtag
->power_dropout(dropout
);
1893 *dropout
= 0; /* by default we can't detect power dropout */
1897 int jtag_srst_asserted(int *srst_asserted
)
1899 if (jtag
->srst_asserted
)
1900 return jtag
->srst_asserted(srst_asserted
);
1902 *srst_asserted
= 0; /* by default we can't detect srst asserted */
1906 enum reset_types
jtag_get_reset_config(void)
1908 return jtag_reset_config
;
1910 void jtag_set_reset_config(enum reset_types type
)
1912 jtag_reset_config
= type
;
1915 int jtag_get_trst(void)
1917 return jtag_trst
== 1;
1919 int jtag_get_srst(void)
1921 return jtag_srst
== 1;
1924 void jtag_set_nsrst_delay(unsigned delay
)
1926 adapter_nsrst_delay
= delay
;
1928 unsigned jtag_get_nsrst_delay(void)
1930 return adapter_nsrst_delay
;
1932 void jtag_set_ntrst_delay(unsigned delay
)
1934 jtag_ntrst_delay
= delay
;
1936 unsigned jtag_get_ntrst_delay(void)
1938 return jtag_ntrst_delay
;
1942 void jtag_set_nsrst_assert_width(unsigned delay
)
1944 adapter_nsrst_assert_width
= delay
;
1946 unsigned jtag_get_nsrst_assert_width(void)
1948 return adapter_nsrst_assert_width
;
1950 void jtag_set_ntrst_assert_width(unsigned delay
)
1952 jtag_ntrst_assert_width
= delay
;
1954 unsigned jtag_get_ntrst_assert_width(void)
1956 return jtag_ntrst_assert_width
;
1959 static int jtag_select(struct command_context
*ctx
)
1963 /* NOTE: interface init must already have been done.
1964 * That works with only C code ... no Tcl glue required.
1967 retval
= jtag_register_commands(ctx
);
1969 if (retval
!= ERROR_OK
)
1972 retval
= svf_register_commands(ctx
);
1974 if (retval
!= ERROR_OK
)
1977 return xsvf_register_commands(ctx
);
1980 static struct transport jtag_transport
= {
1982 .select
= jtag_select
,
1986 static void jtag_constructor(void) __attribute__((constructor
));
1987 static void jtag_constructor(void)
1989 transport_register(&jtag_transport
);
1992 /** Returns true if the current debug session
1993 * is using JTAG as its transport.
1995 bool transport_is_jtag(void)
1997 return get_current_transport() == &jtag_transport
;
2000 int adapter_resets(int trst
, int srst
)
2002 if (get_current_transport() == NULL
) {
2003 LOG_ERROR("transport is not selected");
2007 if (transport_is_jtag()) {
2008 if (srst
== SRST_ASSERT
&& !(jtag_reset_config
& RESET_HAS_SRST
)) {
2009 LOG_ERROR("adapter has no srst signal");
2013 /* adapters without trst signal will eventually use tlr sequence */
2014 jtag_add_reset(trst
, srst
);
2016 * The jtag queue is still used for reset by some adapter. Flush it!
2017 * FIXME: To be removed when all adapter drivers will be updated!
2019 jtag_execute_queue();
2021 } else if (transport_is_swd() || transport_is_hla() ||
2022 transport_is_dapdirect_swd() || transport_is_dapdirect_jtag() ||
2023 transport_is_swim()) {
2024 if (trst
== TRST_ASSERT
) {
2025 LOG_ERROR("transport %s has no trst signal",
2026 get_current_transport()->name
);
2030 if (srst
== SRST_ASSERT
&& !(jtag_reset_config
& RESET_HAS_SRST
)) {
2031 LOG_ERROR("adapter has no srst signal");
2034 adapter_system_reset(srst
);
2038 if (trst
== TRST_DEASSERT
&& srst
== SRST_DEASSERT
)
2041 LOG_ERROR("reset is not supported on transport %s",
2042 get_current_transport()->name
);
2047 int adapter_assert_reset(void)
2049 if (transport_is_jtag()) {
2050 if (jtag_reset_config
& RESET_SRST_PULLS_TRST
)
2051 jtag_add_reset(1, 1);
2053 jtag_add_reset(0, 1);
2055 } else if (transport_is_swd() || transport_is_hla() ||
2056 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2057 transport_is_swim())
2058 return adapter_system_reset(1);
2059 else if (get_current_transport() != NULL
)
2060 LOG_ERROR("reset is not supported on %s",
2061 get_current_transport()->name
);
2063 LOG_ERROR("transport is not selected");
2067 int adapter_deassert_reset(void)
2069 if (transport_is_jtag()) {
2070 jtag_add_reset(0, 0);
2072 } else if (transport_is_swd() || transport_is_hla() ||
2073 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2074 transport_is_swim())
2075 return adapter_system_reset(0);
2076 else if (get_current_transport() != NULL
)
2077 LOG_ERROR("reset is not supported on %s",
2078 get_current_transport()->name
);
2080 LOG_ERROR("transport is not selected");
2084 int adapter_config_trace(bool enabled
, enum tpiu_pin_protocol pin_protocol
,
2085 uint32_t port_size
, unsigned int *trace_freq
,
2086 unsigned int traceclkin_freq
, uint16_t *prescaler
)
2088 if (jtag
->config_trace
) {
2089 return jtag
->config_trace(enabled
, pin_protocol
, port_size
, trace_freq
,
2090 traceclkin_freq
, prescaler
);
2091 } else if (enabled
) {
2092 LOG_ERROR("The selected interface does not support tracing");
2099 int adapter_poll_trace(uint8_t *buf
, size_t *size
)
2101 if (jtag
->poll_trace
)
2102 return jtag
->poll_trace(buf
, size
);
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)