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>
38 #include "helper/system.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 static enum reset_types jtag_reset_config
= RESET_NONE
;
95 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
97 static bool jtag_verify_capture_ir
= true;
98 static int jtag_verify
= 1;
100 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines
101 *deasserted (in ms) */
102 static int adapter_nsrst_delay
; /* default to no nSRST delay */
103 static int jtag_ntrst_delay
;/* default to no nTRST delay */
104 static int adapter_nsrst_assert_width
; /* width of assertion */
105 static int jtag_ntrst_assert_width
; /* width of assertion */
108 * Contains a single callback along with a pointer that will be passed
109 * when an event occurs.
111 struct jtag_event_callback
{
112 /** a event callback */
113 jtag_event_handler_t callback
;
114 /** the private data to pass to the callback */
116 /** the next callback */
117 struct jtag_event_callback
*next
;
120 /* callbacks to inform high-level handlers about JTAG state changes */
121 static struct jtag_event_callback
*jtag_event_callbacks
;
124 static int speed_khz
;
125 /* speed to fallback to when RCLK is requested but not supported */
126 static int rclk_fallback_speed_khz
;
127 static enum {CLOCK_MODE_UNSELECTED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
128 static int jtag_speed
;
130 /* FIXME: change name to this variable, it is not anymore JTAG only */
131 static struct adapter_driver
*jtag
;
133 extern struct adapter_driver
*adapter_driver
;
135 void jtag_set_flush_queue_sleep(int ms
)
137 jtag_flush_queue_sleep
= ms
;
140 void jtag_set_error(int error
)
142 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
147 int jtag_error_clear(void)
149 int temp
= jtag_error
;
150 jtag_error
= ERROR_OK
;
156 static bool jtag_poll
= 1;
158 bool is_jtag_poll_safe(void)
160 /* Polling can be disabled explicitly with set_enabled(false).
161 * It is also implicitly disabled while TRST is active and
162 * while SRST is gating the JTAG clock.
164 if (!transport_is_jtag())
167 if (!jtag_poll
|| jtag_trst
!= 0)
169 return jtag_srst
== 0 || (jtag_reset_config
& RESET_SRST_NO_GATING
);
172 bool jtag_poll_get_enabled(void)
177 void jtag_poll_set_enabled(bool value
)
184 struct jtag_tap
*jtag_all_taps(void)
186 return __jtag_all_taps
;
189 unsigned jtag_tap_count(void)
191 struct jtag_tap
*t
= jtag_all_taps();
200 unsigned jtag_tap_count_enabled(void)
202 struct jtag_tap
*t
= jtag_all_taps();
212 /** Append a new TAP to the chain of all taps. */
213 static void jtag_tap_add(struct jtag_tap
*t
)
215 unsigned jtag_num_taps
= 0;
217 struct jtag_tap
**tap
= &__jtag_all_taps
;
218 while (*tap
!= NULL
) {
220 tap
= &(*tap
)->next_tap
;
223 t
->abs_chain_position
= jtag_num_taps
;
226 /* returns a pointer to the n-th device in the scan chain */
227 struct jtag_tap
*jtag_tap_by_position(unsigned n
)
229 struct jtag_tap
*t
= jtag_all_taps();
237 struct jtag_tap
*jtag_tap_by_string(const char *s
)
239 /* try by name first */
240 struct jtag_tap
*t
= jtag_all_taps();
243 if (0 == strcmp(t
->dotted_name
, s
))
248 /* no tap found by name, so try to parse the name as a number */
250 if (parse_uint(s
, &n
) != ERROR_OK
)
253 /* FIXME remove this numeric fallback code late June 2010, along
254 * with all info in the User's Guide that TAPs have numeric IDs.
255 * Also update "scan_chain" output to not display the numbers.
257 t
= jtag_tap_by_position(n
);
259 LOG_WARNING("Specify TAP '%s' by name, not number %u",
265 struct jtag_tap
*jtag_tap_next_enabled(struct jtag_tap
*p
)
267 p
= p
? p
->next_tap
: jtag_all_taps();
276 const char *jtag_tap_name(const struct jtag_tap
*tap
)
278 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
282 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
284 struct jtag_event_callback
**callbacks_p
= &jtag_event_callbacks
;
286 if (callback
== NULL
)
287 return ERROR_COMMAND_SYNTAX_ERROR
;
290 while ((*callbacks_p
)->next
)
291 callbacks_p
= &((*callbacks_p
)->next
);
292 callbacks_p
= &((*callbacks_p
)->next
);
295 (*callbacks_p
) = malloc(sizeof(struct jtag_event_callback
));
296 (*callbacks_p
)->callback
= callback
;
297 (*callbacks_p
)->priv
= priv
;
298 (*callbacks_p
)->next
= NULL
;
303 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
305 struct jtag_event_callback
**p
= &jtag_event_callbacks
, *temp
;
307 if (callback
== NULL
)
308 return ERROR_COMMAND_SYNTAX_ERROR
;
311 if (((*p
)->priv
!= priv
) || ((*p
)->callback
!= callback
)) {
324 int jtag_call_event_callbacks(enum jtag_event event
)
326 struct jtag_event_callback
*callback
= jtag_event_callbacks
;
328 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
331 struct jtag_event_callback
*next
;
333 /* callback may remove itself */
334 next
= callback
->next
;
335 callback
->callback(event
, callback
->priv
);
342 static void jtag_checks(void)
344 assert(jtag_trst
== 0);
347 static void jtag_prelude(tap_state_t state
)
351 assert(state
!= TAP_INVALID
);
353 cmd_queue_cur_state
= state
;
356 void jtag_add_ir_scan_noverify(struct jtag_tap
*active
, const struct scan_field
*in_fields
,
361 int retval
= interface_jtag_add_ir_scan(active
, in_fields
, state
);
362 jtag_set_error(retval
);
365 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap
*active
,
367 const struct scan_field
*in_fields
,
370 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
373 /* If fields->in_value is filled out, then the captured IR value will be checked */
374 void jtag_add_ir_scan(struct jtag_tap
*active
, struct scan_field
*in_fields
, tap_state_t state
)
376 assert(state
!= TAP_RESET
);
378 if (jtag_verify
&& jtag_verify_capture_ir
) {
379 /* 8 x 32 bit id's is enough for all invocations */
381 /* if we are to run a verification of the ir scan, we need to get the input back.
382 * We may have to allocate space if the caller didn't ask for the input back.
384 in_fields
->check_value
= active
->expected
;
385 in_fields
->check_mask
= active
->expected_mask
;
386 jtag_add_scan_check(active
, jtag_add_ir_scan_noverify_callback
, 1, in_fields
,
389 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
392 void jtag_add_plain_ir_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
395 assert(out_bits
!= NULL
);
396 assert(state
!= TAP_RESET
);
400 int retval
= interface_jtag_add_plain_ir_scan(
401 num_bits
, out_bits
, in_bits
, state
);
402 jtag_set_error(retval
);
405 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
406 uint8_t *in_check_mask
, int num_bits
);
408 static int jtag_check_value_mask_callback(jtag_callback_data_t data0
,
409 jtag_callback_data_t data1
,
410 jtag_callback_data_t data2
,
411 jtag_callback_data_t data3
)
413 return jtag_check_value_inner((uint8_t *)data0
,
419 static void jtag_add_scan_check(struct jtag_tap
*active
, void (*jtag_add_scan
)(
420 struct jtag_tap
*active
,
422 const struct scan_field
*in_fields
,
424 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
)
426 jtag_add_scan(active
, in_num_fields
, in_fields
, state
);
428 for (int i
= 0; i
< in_num_fields
; i
++) {
429 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
)) {
430 jtag_add_callback4(jtag_check_value_mask_callback
,
431 (jtag_callback_data_t
)in_fields
[i
].in_value
,
432 (jtag_callback_data_t
)in_fields
[i
].check_value
,
433 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
434 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
439 void jtag_add_dr_scan_check(struct jtag_tap
*active
,
441 struct scan_field
*in_fields
,
445 jtag_add_scan_check(active
, jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
447 jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
451 void jtag_add_dr_scan(struct jtag_tap
*active
,
453 const struct scan_field
*in_fields
,
456 assert(state
!= TAP_RESET
);
461 retval
= interface_jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
462 jtag_set_error(retval
);
465 void jtag_add_plain_dr_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
468 assert(out_bits
!= NULL
);
469 assert(state
!= TAP_RESET
);
474 retval
= interface_jtag_add_plain_dr_scan(num_bits
, out_bits
, in_bits
, state
);
475 jtag_set_error(retval
);
478 void jtag_add_tlr(void)
480 jtag_prelude(TAP_RESET
);
481 jtag_set_error(interface_jtag_add_tlr());
483 /* NOTE: order here matches TRST path in jtag_add_reset() */
484 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
485 jtag_notify_event(JTAG_TRST_ASSERTED
);
489 * If supported by the underlying adapter, this clocks a raw bit sequence
490 * onto TMS for switching betwen JTAG and SWD modes.
492 * DO NOT use this to bypass the integrity checks and logging provided
493 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
495 * @param nbits How many bits to clock out.
496 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
497 * @param state The JTAG tap state to record on completion. Use
498 * TAP_INVALID to represent being in in SWD mode.
500 * @todo Update naming conventions to stop assuming everything is JTAG.
502 int jtag_add_tms_seq(unsigned nbits
, const uint8_t *seq
, enum tap_state state
)
506 if (!(jtag
->jtag_ops
->supported
& DEBUG_CAP_TMS_SEQ
))
507 return ERROR_JTAG_NOT_IMPLEMENTED
;
510 cmd_queue_cur_state
= state
;
512 retval
= interface_add_tms_seq(nbits
, seq
, state
);
513 jtag_set_error(retval
);
517 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
519 tap_state_t cur_state
= cmd_queue_cur_state
;
521 /* the last state has to be a stable state */
522 if (!tap_is_state_stable(path
[num_states
- 1])) {
523 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
524 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
528 for (int i
= 0; i
< num_states
; i
++) {
529 if (path
[i
] == TAP_RESET
) {
530 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
531 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
535 if (tap_state_transition(cur_state
, true) != path
[i
] &&
536 tap_state_transition(cur_state
, false) != path
[i
]) {
537 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
538 tap_state_name(cur_state
), tap_state_name(path
[i
]));
539 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
547 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
548 cmd_queue_cur_state
= path
[num_states
- 1];
551 int jtag_add_statemove(tap_state_t goal_state
)
553 tap_state_t cur_state
= cmd_queue_cur_state
;
555 if (goal_state
!= cur_state
) {
556 LOG_DEBUG("cur_state=%s goal_state=%s",
557 tap_state_name(cur_state
),
558 tap_state_name(goal_state
));
561 /* If goal is RESET, be paranoid and force that that transition
562 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
564 if (goal_state
== TAP_RESET
)
566 else if (goal_state
== cur_state
)
569 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
)) {
570 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
571 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
572 tap_state_t moves
[8];
573 assert(tms_count
< ARRAY_SIZE(moves
));
575 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1) {
576 bool bit
= tms_bits
& 1;
578 cur_state
= tap_state_transition(cur_state
, bit
);
579 moves
[i
] = cur_state
;
582 jtag_add_pathmove(tms_count
, moves
);
583 } else if (tap_state_transition(cur_state
, true) == goal_state
584 || tap_state_transition(cur_state
, false) == goal_state
)
585 jtag_add_pathmove(1, &goal_state
);
592 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
595 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
599 void jtag_add_clocks(int num_cycles
)
601 if (!tap_is_state_stable(cmd_queue_cur_state
)) {
602 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
603 tap_state_name(cmd_queue_cur_state
));
604 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
608 if (num_cycles
> 0) {
610 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
614 static int adapter_system_reset(int req_srst
)
619 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
620 LOG_ERROR("BUG: can't assert SRST");
626 /* Maybe change SRST signal state */
627 if (jtag_srst
!= req_srst
) {
628 retval
= jtag
->reset(0, req_srst
);
629 if (retval
!= ERROR_OK
) {
630 LOG_ERROR("SRST error");
633 jtag_srst
= req_srst
;
636 LOG_DEBUG("SRST line asserted");
637 if (adapter_nsrst_assert_width
)
638 jtag_sleep(adapter_nsrst_assert_width
* 1000);
640 LOG_DEBUG("SRST line released");
641 if (adapter_nsrst_delay
)
642 jtag_sleep(adapter_nsrst_delay
* 1000);
649 static void legacy_jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
651 int trst_with_tlr
= 0;
655 /* Without SRST, we must use target-specific JTAG operations
656 * on each target; callers should not be requesting SRST when
657 * that signal doesn't exist.
659 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
660 * can kick in even if the JTAG adapter can't drive TRST.
663 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
664 LOG_ERROR("BUG: can't assert SRST");
665 jtag_set_error(ERROR_FAIL
);
668 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
669 && !req_tlr_or_trst
) {
670 LOG_ERROR("BUG: can't assert only SRST");
671 jtag_set_error(ERROR_FAIL
);
677 /* JTAG reset (entry to TAP_RESET state) can always be achieved
678 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
679 * state first. TRST accelerates it, and bypasses those states.
681 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
682 * can kick in even if the JTAG adapter can't drive SRST.
684 if (req_tlr_or_trst
) {
685 if (!(jtag_reset_config
& RESET_HAS_TRST
))
687 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
694 /* Maybe change TRST and/or SRST signal state */
695 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
698 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
699 if (retval
!= ERROR_OK
)
700 jtag_set_error(retval
);
702 retval
= jtag_execute_queue();
704 if (retval
!= ERROR_OK
) {
705 LOG_ERROR("TRST/SRST error");
710 /* SRST resets everything hooked up to that signal */
711 if (jtag_srst
!= new_srst
) {
712 jtag_srst
= new_srst
;
714 LOG_DEBUG("SRST line asserted");
715 if (adapter_nsrst_assert_width
)
716 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
718 LOG_DEBUG("SRST line released");
719 if (adapter_nsrst_delay
)
720 jtag_add_sleep(adapter_nsrst_delay
* 1000);
724 /* Maybe enter the JTAG TAP_RESET state ...
725 * - using only TMS, TCK, and the JTAG state machine
726 * - or else more directly, using TRST
728 * TAP_RESET should be invisible to non-debug parts of the system.
731 LOG_DEBUG("JTAG reset with TLR instead of TRST");
734 } else if (jtag_trst
!= new_trst
) {
735 jtag_trst
= new_trst
;
737 LOG_DEBUG("TRST line asserted");
738 tap_set_state(TAP_RESET
);
739 if (jtag_ntrst_assert_width
)
740 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
742 LOG_DEBUG("TRST line released");
743 if (jtag_ntrst_delay
)
744 jtag_add_sleep(jtag_ntrst_delay
* 1000);
746 /* We just asserted nTRST, so we're now in TAP_RESET.
747 * Inform possible listeners about this, now that
748 * JTAG instructions and data can be shifted. This
749 * sequence must match jtag_add_tlr().
751 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
752 jtag_notify_event(JTAG_TRST_ASSERTED
);
757 /* FIXME: name is misleading; we do not plan to "add" reset into jtag queue */
758 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
761 int trst_with_tlr
= 0;
766 legacy_jtag_add_reset(req_tlr_or_trst
, req_srst
);
770 /* Without SRST, we must use target-specific JTAG operations
771 * on each target; callers should not be requesting SRST when
772 * that signal doesn't exist.
774 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
775 * can kick in even if the JTAG adapter can't drive TRST.
778 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
779 LOG_ERROR("BUG: can't assert SRST");
780 jtag_set_error(ERROR_FAIL
);
783 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
784 && !req_tlr_or_trst
) {
785 LOG_ERROR("BUG: can't assert only SRST");
786 jtag_set_error(ERROR_FAIL
);
792 /* JTAG reset (entry to TAP_RESET state) can always be achieved
793 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
794 * state first. TRST accelerates it, and bypasses those states.
796 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
797 * can kick in even if the JTAG adapter can't drive SRST.
799 if (req_tlr_or_trst
) {
800 if (!(jtag_reset_config
& RESET_HAS_TRST
))
802 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
809 /* Maybe change TRST and/or SRST signal state */
810 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
811 /* guarantee jtag queue empty before changing reset status */
812 jtag_execute_queue();
814 retval
= jtag
->reset(new_trst
, new_srst
);
815 if (retval
!= ERROR_OK
) {
816 jtag_set_error(retval
);
817 LOG_ERROR("TRST/SRST error");
822 /* SRST resets everything hooked up to that signal */
823 if (jtag_srst
!= new_srst
) {
824 jtag_srst
= new_srst
;
826 LOG_DEBUG("SRST line asserted");
827 if (adapter_nsrst_assert_width
)
828 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
830 LOG_DEBUG("SRST line released");
831 if (adapter_nsrst_delay
)
832 jtag_add_sleep(adapter_nsrst_delay
* 1000);
836 /* Maybe enter the JTAG TAP_RESET state ...
837 * - using only TMS, TCK, and the JTAG state machine
838 * - or else more directly, using TRST
840 * TAP_RESET should be invisible to non-debug parts of the system.
843 LOG_DEBUG("JTAG reset with TLR instead of TRST");
845 jtag_execute_queue();
847 } else if (jtag_trst
!= new_trst
) {
848 jtag_trst
= new_trst
;
850 LOG_DEBUG("TRST line asserted");
851 tap_set_state(TAP_RESET
);
852 if (jtag_ntrst_assert_width
)
853 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
855 LOG_DEBUG("TRST line released");
856 if (jtag_ntrst_delay
)
857 jtag_add_sleep(jtag_ntrst_delay
* 1000);
859 /* We just asserted nTRST, so we're now in TAP_RESET.
860 * Inform possible listeners about this, now that
861 * JTAG instructions and data can be shifted. This
862 * sequence must match jtag_add_tlr().
864 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
865 jtag_notify_event(JTAG_TRST_ASSERTED
);
870 void jtag_add_sleep(uint32_t us
)
872 /** @todo Here, keep_alive() appears to be a layering violation!!! */
874 jtag_set_error(interface_jtag_add_sleep(us
));
877 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
878 uint8_t *in_check_mask
, int num_bits
)
880 int retval
= ERROR_OK
;
884 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
886 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
888 if (compare_failed
) {
889 char *captured_str
, *in_check_value_str
;
890 int bits
= (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
;
892 /* NOTE: we've lost diagnostic context here -- 'which tap' */
894 captured_str
= buf_to_hex_str(captured
, bits
);
895 in_check_value_str
= buf_to_hex_str(in_check_value
, bits
);
897 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
899 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
902 free(in_check_value_str
);
905 char *in_check_mask_str
;
907 in_check_mask_str
= buf_to_hex_str(in_check_mask
, bits
);
908 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
909 free(in_check_mask_str
);
912 retval
= ERROR_JTAG_QUEUE_FAILED
;
917 void jtag_check_value_mask(struct scan_field
*field
, uint8_t *value
, uint8_t *mask
)
919 assert(field
->in_value
!= NULL
);
922 /* no checking to do */
926 jtag_execute_queue_noclear();
928 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
929 jtag_set_error(retval
);
932 int default_interface_jtag_execute_queue(void)
935 LOG_ERROR("No JTAG interface configured yet. "
936 "Issue 'init' command in startup scripts "
937 "before communicating with targets.");
941 if (!transport_is_jtag()) {
943 * FIXME: This should not happen!
944 * There could be old code that queues jtag commands with non jtag interfaces so, for
945 * the moment simply highlight it by log an error and return on empty execute_queue.
946 * We should fix it quitting with assert(0) because it is an internal error.
947 * The fix can be applied immediately after next release (v0.11.0 ?)
949 LOG_ERROR("JTAG API jtag_execute_queue() called on non JTAG interface");
950 if (!jtag
->jtag_ops
|| !jtag
->jtag_ops
->execute_queue
)
954 int result
= jtag
->jtag_ops
->execute_queue();
956 struct jtag_command
*cmd
= jtag_command_queue
;
957 while (debug_level
>= LOG_LVL_DEBUG_IO
&& cmd
) {
960 LOG_DEBUG_IO("JTAG %s SCAN to %s",
961 cmd
->cmd
.scan
->ir_scan
? "IR" : "DR",
962 tap_state_name(cmd
->cmd
.scan
->end_state
));
963 for (int i
= 0; i
< cmd
->cmd
.scan
->num_fields
; i
++) {
964 struct scan_field
*field
= cmd
->cmd
.scan
->fields
+ i
;
965 if (field
->out_value
) {
966 char *str
= buf_to_hex_str(field
->out_value
, field
->num_bits
);
967 LOG_DEBUG_IO(" %db out: %s", field
->num_bits
, str
);
970 if (field
->in_value
) {
971 char *str
= buf_to_hex_str(field
->in_value
, field
->num_bits
);
972 LOG_DEBUG_IO(" %db in: %s", field
->num_bits
, str
);
978 LOG_DEBUG_IO("JTAG TLR RESET to %s",
979 tap_state_name(cmd
->cmd
.statemove
->end_state
));
982 LOG_DEBUG_IO("JTAG RUNTEST %d cycles to %s",
983 cmd
->cmd
.runtest
->num_cycles
,
984 tap_state_name(cmd
->cmd
.runtest
->end_state
));
988 const char *reset_str
[3] = {
989 "leave", "deassert", "assert"
991 LOG_DEBUG_IO("JTAG RESET %s TRST, %s SRST",
992 reset_str
[cmd
->cmd
.reset
->trst
+ 1],
993 reset_str
[cmd
->cmd
.reset
->srst
+ 1]);
997 LOG_DEBUG_IO("JTAG PATHMOVE (TODO)");
1000 LOG_DEBUG_IO("JTAG SLEEP (TODO)");
1002 case JTAG_STABLECLOCKS
:
1003 LOG_DEBUG_IO("JTAG STABLECLOCKS (TODO)");
1006 LOG_DEBUG_IO("JTAG TMS (TODO)");
1009 LOG_ERROR("Unknown JTAG command: %d", cmd
->type
);
1018 void jtag_execute_queue_noclear(void)
1020 jtag_flush_queue_count
++;
1021 jtag_set_error(interface_jtag_execute_queue());
1023 if (jtag_flush_queue_sleep
> 0) {
1024 /* For debug purposes it can be useful to test performance
1025 * or behavior when delaying after flushing the queue,
1026 * e.g. to simulate long roundtrip times.
1028 usleep(jtag_flush_queue_sleep
* 1000);
1032 int jtag_get_flush_queue_count(void)
1034 return jtag_flush_queue_count
;
1037 int jtag_execute_queue(void)
1039 jtag_execute_queue_noclear();
1040 return jtag_error_clear();
1043 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
1045 struct jtag_tap
*tap
= priv
;
1047 if (event
== JTAG_TRST_ASSERTED
) {
1048 tap
->enabled
= !tap
->disabled_after_reset
;
1050 /* current instruction is either BYPASS or IDCODE */
1051 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1058 /* sleep at least us microseconds. When we sleep more than 1000ms we
1059 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
1060 * GDB if we slept for <1000ms many times.
1062 void jtag_sleep(uint32_t us
)
1067 alive_sleep((us
+999)/1000);
1070 #define JTAG_MAX_AUTO_TAPS 20
1072 #define EXTRACT_JEP106_BANK(X) (((X) & 0xf00) >> 8)
1073 #define EXTRACT_JEP106_ID(X) (((X) & 0xfe) >> 1)
1074 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1075 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1076 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1078 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
1079 * know that no valid TAP will have it as an IDCODE value.
1081 #define END_OF_CHAIN_FLAG 0xffffffff
1083 /* a larger IR length than we ever expect to autoprobe */
1084 #define JTAG_IRLEN_MAX 60
1086 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
1088 struct scan_field field
= {
1089 .num_bits
= num_idcode
* 32,
1090 .out_value
= idcode_buffer
,
1091 .in_value
= idcode_buffer
,
1094 /* initialize to the end of chain ID value */
1095 for (unsigned i
= 0; i
< num_idcode
; i
++)
1096 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
1098 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
1100 return jtag_execute_queue();
1103 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
1105 uint8_t zero_check
= 0x0;
1106 uint8_t one_check
= 0xff;
1108 for (unsigned i
= 0; i
< count
* 4; i
++) {
1109 zero_check
|= idcodes
[i
];
1110 one_check
&= idcodes
[i
];
1113 /* if there wasn't a single non-zero bit or if all bits were one,
1114 * the scan is not valid. We wrote a mix of both values; either
1116 * - There's a hardware issue (almost certainly):
1117 * + all-zeroes can mean a target stuck in JTAG reset
1118 * + all-ones tends to mean no target
1119 * - The scan chain is WAY longer than we can handle, *AND* either
1120 * + there are several hundreds of TAPs in bypass, or
1121 * + at least a few dozen TAPs all have an all-ones IDCODE
1123 if (zero_check
== 0x00 || one_check
== 0xff) {
1124 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
1125 (zero_check
== 0x00) ? "zeroes" : "ones");
1126 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
1132 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
1133 const char *name
, uint32_t idcode
)
1135 log_printf_lf(level
, __FILE__
, __LINE__
, __func__
,
1136 "JTAG tap: %s %16.16s: 0x%08x "
1137 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
1139 (unsigned int)idcode
,
1140 (unsigned int)EXTRACT_MFG(idcode
),
1141 jep106_manufacturer(EXTRACT_JEP106_BANK(idcode
), EXTRACT_JEP106_ID(idcode
)),
1142 (unsigned int)EXTRACT_PART(idcode
),
1143 (unsigned int)EXTRACT_VER(idcode
));
1146 static bool jtag_idcode_is_final(uint32_t idcode
)
1149 * Some devices, such as AVR8, will output all 1's instead
1150 * of TDI input value at end of chain. Allow those values
1151 * instead of failing.
1153 return idcode
== END_OF_CHAIN_FLAG
;
1157 * This helper checks that remaining bits in the examined chain data are
1158 * all as expected, but a single JTAG device requires only 64 bits to be
1159 * read back correctly. This can help identify and diagnose problems
1160 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1161 * Returns TRUE iff garbage was found.
1163 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
1165 bool triggered
= false;
1166 for (; count
< max
- 31; count
+= 32) {
1167 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
1169 /* do not trigger the warning if the data looks good */
1170 if (jtag_idcode_is_final(idcode
))
1172 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1173 count
, (unsigned int)idcode
);
1179 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
1182 if (tap
->expected_ids_cnt
== 0 || !tap
->hasidcode
)
1185 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1186 uint32_t mask
= tap
->ignore_version
? ~(0xfU
<< 28) : ~0U;
1187 uint32_t idcode
= tap
->idcode
& mask
;
1189 /* Loop over the expected identification codes and test for a match */
1190 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1191 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
1193 if (idcode
== expected
)
1196 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1197 if (0 == tap
->expected_ids
[ii
])
1201 /* If none of the expected ids matched, warn */
1202 jtag_examine_chain_display(LOG_LVL_WARNING
, "UNEXPECTED",
1203 tap
->dotted_name
, tap
->idcode
);
1204 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1207 snprintf(msg
, sizeof(msg
), "expected %u of %u", ii
+ 1, tap
->expected_ids_cnt
);
1208 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1209 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1214 /* Try to examine chain layout according to IEEE 1149.1 §12
1215 * This is called a "blind interrogation" of the scan chain.
1217 static int jtag_examine_chain(void)
1220 unsigned max_taps
= jtag_tap_count();
1222 /* Autoprobe up to this many. */
1223 if (max_taps
< JTAG_MAX_AUTO_TAPS
)
1224 max_taps
= JTAG_MAX_AUTO_TAPS
;
1226 /* Add room for end-of-chain marker. */
1229 uint8_t *idcode_buffer
= calloc(4, max_taps
);
1230 if (idcode_buffer
== NULL
)
1231 return ERROR_JTAG_INIT_FAILED
;
1233 /* DR scan to collect BYPASS or IDCODE register contents.
1234 * Then make sure the scan data has both ones and zeroes.
1236 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1237 retval
= jtag_examine_chain_execute(idcode_buffer
, max_taps
);
1238 if (retval
!= ERROR_OK
)
1240 if (!jtag_examine_chain_check(idcode_buffer
, max_taps
)) {
1241 retval
= ERROR_JTAG_INIT_FAILED
;
1245 /* Point at the 1st predefined tap, if any */
1246 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1248 unsigned bit_count
= 0;
1249 unsigned autocount
= 0;
1250 for (unsigned i
= 0; i
< max_taps
; i
++) {
1251 assert(bit_count
< max_taps
* 32);
1252 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1254 /* No predefined TAP? Auto-probe. */
1256 /* Is there another TAP? */
1257 if (jtag_idcode_is_final(idcode
))
1260 /* Default everything in this TAP except IR length.
1262 * REVISIT create a jtag_alloc(chip, tap) routine, and
1263 * share it with jim_newtap_cmd().
1265 tap
= calloc(1, sizeof(*tap
));
1267 retval
= ERROR_FAIL
;
1271 tap
->chip
= alloc_printf("auto%u", autocount
++);
1272 tap
->tapname
= strdup("tap");
1273 tap
->dotted_name
= alloc_printf("%s.%s", tap
->chip
, tap
->tapname
);
1275 tap
->ir_length
= 0; /* ... signifying irlen autoprobe */
1276 tap
->ir_capture_mask
= 0x03;
1277 tap
->ir_capture_value
= 0x01;
1279 tap
->enabled
= true;
1284 if ((idcode
& 1) == 0) {
1285 /* Zero for LSB indicates a device in bypass */
1286 LOG_INFO("TAP %s does not have valid IDCODE (idcode=0x%" PRIx32
")",
1287 tap
->dotted_name
, idcode
);
1288 tap
->hasidcode
= false;
1293 /* Friendly devices support IDCODE */
1294 tap
->hasidcode
= true;
1295 tap
->idcode
= idcode
;
1296 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found", tap
->dotted_name
, idcode
);
1301 /* ensure the TAP ID matches what was expected */
1302 if (!jtag_examine_chain_match_tap(tap
))
1303 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1305 tap
= jtag_tap_next_enabled(tap
);
1308 /* After those IDCODE or BYPASS register values should be
1309 * only the data we fed into the scan chain.
1311 if (jtag_examine_chain_end(idcode_buffer
, bit_count
, max_taps
* 32)) {
1312 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1313 retval
= ERROR_JTAG_INIT_FAILED
;
1317 /* Return success or, for backwards compatibility if only
1318 * some IDCODE values mismatched, a soft/continuable fault.
1321 free(idcode_buffer
);
1326 * Validate the date loaded by entry to the Capture-IR state, to help
1327 * find errors related to scan chain configuration (wrong IR lengths)
1330 * Entry state can be anything. On non-error exit, all TAPs are in
1331 * bypass mode. On error exits, the scan chain is reset.
1333 static int jtag_validate_ircapture(void)
1335 struct jtag_tap
*tap
;
1336 int total_ir_length
= 0;
1337 uint8_t *ir_test
= NULL
;
1338 struct scan_field field
;
1343 /* when autoprobing, accomodate huge IR lengths */
1344 for (tap
= NULL
, total_ir_length
= 0;
1345 (tap
= jtag_tap_next_enabled(tap
)) != NULL
;
1346 total_ir_length
+= tap
->ir_length
) {
1347 if (tap
->ir_length
== 0)
1348 total_ir_length
+= JTAG_IRLEN_MAX
;
1351 /* increase length to add 2 bit sentinel after scan */
1352 total_ir_length
+= 2;
1354 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1355 if (ir_test
== NULL
)
1358 /* after this scan, all TAPs will capture BYPASS instructions */
1359 buf_set_ones(ir_test
, total_ir_length
);
1361 field
.num_bits
= total_ir_length
;
1362 field
.out_value
= ir_test
;
1363 field
.in_value
= ir_test
;
1365 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1367 LOG_DEBUG("IR capture validation scan");
1368 retval
= jtag_execute_queue();
1369 if (retval
!= ERROR_OK
)
1376 tap
= jtag_tap_next_enabled(tap
);
1380 /* If we're autoprobing, guess IR lengths. They must be at
1381 * least two bits. Guessing will fail if (a) any TAP does
1382 * not conform to the JTAG spec; or (b) when the upper bits
1383 * captured from some conforming TAP are nonzero. Or if
1384 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1385 * an implementation limit, which could someday be raised.
1387 * REVISIT optimization: if there's a *single* TAP we can
1388 * lift restrictions (a) and (b) by scanning a recognizable
1389 * pattern before the all-ones BYPASS. Check for where the
1390 * pattern starts in the result, instead of an 0...01 value.
1392 * REVISIT alternative approach: escape to some tcl code
1393 * which could provide more knowledge, based on IDCODE; and
1394 * only guess when that has no success.
1396 if (tap
->ir_length
== 0) {
1398 while ((val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
+ 1)) == 1
1399 && tap
->ir_length
< JTAG_IRLEN_MAX
) {
1402 LOG_WARNING("AUTO %s - use \"jtag newtap %s %s -irlen %d "
1403 "-expected-id 0x%08" PRIx32
"\"",
1404 tap
->dotted_name
, tap
->chip
, tap
->tapname
, tap
->ir_length
, tap
->idcode
);
1407 /* Validate the two LSBs, which must be 01 per JTAG spec.
1409 * Or ... more bits could be provided by TAP declaration.
1410 * Plus, some taps (notably in i.MX series chips) violate
1411 * this part of the JTAG spec, so their capture mask/value
1412 * attributes might disable this test.
1414 val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
);
1415 if ((val
& tap
->ir_capture_mask
) != tap
->ir_capture_value
) {
1416 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64
" not 0x%0*" PRIx32
,
1418 (tap
->ir_length
+ 7) / tap
->ir_length
, val
,
1419 (tap
->ir_length
+ 7) / tap
->ir_length
, tap
->ir_capture_value
);
1421 retval
= ERROR_JTAG_INIT_FAILED
;
1424 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64
, jtag_tap_name(tap
),
1425 (tap
->ir_length
+ 7) / tap
->ir_length
, val
);
1426 chain_pos
+= tap
->ir_length
;
1429 /* verify the '11' sentinel we wrote is returned at the end */
1430 val
= buf_get_u64(ir_test
, chain_pos
, 2);
1432 char *cbuf
= buf_to_hex_str(ir_test
, total_ir_length
);
1434 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1437 retval
= ERROR_JTAG_INIT_FAILED
;
1442 if (retval
!= ERROR_OK
) {
1444 jtag_execute_queue();
1449 void jtag_tap_init(struct jtag_tap
*tap
)
1451 unsigned ir_len_bits
;
1452 unsigned ir_len_bytes
;
1454 /* if we're autoprobing, cope with potentially huge ir_length */
1455 ir_len_bits
= tap
->ir_length
? : JTAG_IRLEN_MAX
;
1456 ir_len_bytes
= DIV_ROUND_UP(ir_len_bits
, 8);
1458 tap
->expected
= calloc(1, ir_len_bytes
);
1459 tap
->expected_mask
= calloc(1, ir_len_bytes
);
1460 tap
->cur_instr
= malloc(ir_len_bytes
);
1462 /** @todo cope better with ir_length bigger than 32 bits */
1463 if (ir_len_bits
> 32)
1466 buf_set_u32(tap
->expected
, 0, ir_len_bits
, tap
->ir_capture_value
);
1467 buf_set_u32(tap
->expected_mask
, 0, ir_len_bits
, tap
->ir_capture_mask
);
1469 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1471 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1473 /* register the reset callback for the TAP */
1474 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1477 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1478 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1479 tap
->abs_chain_position
, tap
->ir_length
,
1480 (unsigned) tap
->ir_capture_value
,
1481 (unsigned) tap
->ir_capture_mask
);
1484 void jtag_tap_free(struct jtag_tap
*tap
)
1486 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1488 struct jtag_tap_event_action
*jteap
= tap
->event_action
;
1490 struct jtag_tap_event_action
*next
= jteap
->next
;
1491 Jim_DecrRefCount(jteap
->interp
, jteap
->body
);
1496 free(tap
->expected
);
1497 free(tap
->expected_mask
);
1498 free(tap
->expected_ids
);
1499 free(tap
->cur_instr
);
1502 free(tap
->dotted_name
);
1507 * Do low-level setup like initializing registers, output signals,
1510 int adapter_init(struct command_context
*cmd_ctx
)
1515 if (!adapter_driver
) {
1516 /* nothing was previously specified by "adapter driver" command */
1517 LOG_ERROR("Debug Adapter has to be specified, "
1518 "see \"adapter driver\" command");
1519 return ERROR_JTAG_INVALID_INTERFACE
;
1523 retval
= adapter_driver
->init();
1524 if (retval
!= ERROR_OK
)
1526 jtag
= adapter_driver
;
1528 if (jtag
->speed
== NULL
) {
1529 LOG_INFO("This adapter doesn't support configurable speed");
1533 if (CLOCK_MODE_UNSELECTED
== clock_mode
) {
1534 LOG_ERROR("An adapter speed is not selected in the init script."
1535 " Insert a call to \"adapter speed\" or \"jtag_rclk\" to proceed.");
1536 return ERROR_JTAG_INIT_FAILED
;
1539 int requested_khz
= jtag_get_speed_khz();
1540 int actual_khz
= requested_khz
;
1541 int jtag_speed_var
= 0;
1542 retval
= jtag_get_speed(&jtag_speed_var
);
1543 if (retval
!= ERROR_OK
)
1545 retval
= jtag
->speed(jtag_speed_var
);
1546 if (retval
!= ERROR_OK
)
1548 retval
= jtag_get_speed_readable(&actual_khz
);
1549 if (ERROR_OK
!= retval
)
1550 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1551 else if (actual_khz
) {
1552 /* Adaptive clocking -- JTAG-specific */
1553 if ((CLOCK_MODE_RCLK
== clock_mode
)
1554 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
)) {
1555 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1558 LOG_INFO("clock speed %d kHz", actual_khz
);
1560 LOG_INFO("RCLK (adaptive clock speed)");
1565 int jtag_init_inner(struct command_context
*cmd_ctx
)
1567 struct jtag_tap
*tap
;
1569 bool issue_setup
= true;
1571 LOG_DEBUG("Init JTAG chain");
1573 tap
= jtag_tap_next_enabled(NULL
);
1575 /* Once JTAG itself is properly set up, and the scan chain
1576 * isn't absurdly large, IDCODE autoprobe should work fine.
1578 * But ... IRLEN autoprobe can fail even on systems which
1579 * are fully conformant to JTAG. Also, JTAG setup can be
1580 * quite finicky on some systems.
1582 * REVISIT: if TAP autoprobe works OK, then in many cases
1583 * we could escape to tcl code and set up targets based on
1584 * the TAP's IDCODE values.
1586 LOG_WARNING("There are no enabled taps. "
1587 "AUTO PROBING MIGHT NOT WORK!!");
1589 /* REVISIT default clock will often be too fast ... */
1593 retval
= jtag_execute_queue();
1594 if (retval
!= ERROR_OK
)
1597 /* Examine DR values first. This discovers problems which will
1598 * prevent communication ... hardware issues like TDO stuck, or
1599 * configuring the wrong number of (enabled) TAPs.
1601 retval
= jtag_examine_chain();
1604 /* complete success */
1607 /* For backward compatibility reasons, try coping with
1608 * configuration errors involving only ID mismatches.
1609 * We might be able to talk to the devices.
1611 * Also the device might be powered down during startup.
1613 * After OpenOCD starts, we can try to power on the device
1616 LOG_ERROR("Trying to use configured scan chain anyway...");
1617 issue_setup
= false;
1621 /* Now look at IR values. Problems here will prevent real
1622 * communication. They mostly mean that the IR length is
1623 * wrong ... or that the IR capture value is wrong. (The
1624 * latter is uncommon, but easily worked around: provide
1625 * ircapture/irmask values during TAP setup.)
1627 retval
= jtag_validate_ircapture();
1628 if (retval
!= ERROR_OK
) {
1629 /* The target might be powered down. The user
1630 * can power it up and reset it after firing
1633 issue_setup
= false;
1637 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1639 LOG_WARNING("Bypassing JTAG setup events due to errors");
1645 int adapter_quit(void)
1647 if (jtag
&& jtag
->quit
) {
1648 /* close the JTAG interface */
1649 int result
= jtag
->quit();
1650 if (ERROR_OK
!= result
)
1651 LOG_ERROR("failed: %d", result
);
1654 struct jtag_tap
*t
= jtag_all_taps();
1656 struct jtag_tap
*n
= t
->next_tap
;
1664 int swd_init_reset(struct command_context
*cmd_ctx
)
1666 int retval
, retval1
;
1668 retval
= adapter_init(cmd_ctx
);
1669 if (retval
!= ERROR_OK
)
1672 LOG_DEBUG("Initializing with hard SRST reset");
1674 if (jtag_reset_config
& RESET_HAS_SRST
)
1675 retval
= adapter_system_reset(1);
1676 retval1
= adapter_system_reset(0);
1678 return (retval
== ERROR_OK
) ? retval1
: retval
;
1681 int jtag_init_reset(struct command_context
*cmd_ctx
)
1683 int retval
= adapter_init(cmd_ctx
);
1684 if (retval
!= ERROR_OK
)
1687 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1690 * This procedure is used by default when OpenOCD triggers a reset.
1691 * It's now done through an overridable Tcl "init_reset" wrapper.
1693 * This started out as a more powerful "get JTAG working" reset than
1694 * jtag_init_inner(), applying TRST because some chips won't activate
1695 * JTAG without a TRST cycle (presumed to be async, though some of
1696 * those chips synchronize JTAG activation using TCK).
1698 * But some chips only activate JTAG as part of an SRST cycle; SRST
1699 * got mixed in. So it became a hard reset routine, which got used
1700 * in more places, and which coped with JTAG reset being forced as
1701 * part of SRST (srst_pulls_trst).
1703 * And even more corner cases started to surface: TRST and/or SRST
1704 * assertion timings matter; some chips need other JTAG operations;
1705 * TRST/SRST sequences can need to be different from these, etc.
1707 * Systems should override that wrapper to support system-specific
1708 * requirements that this not-fully-generic code doesn't handle.
1710 * REVISIT once Tcl code can read the reset_config modes, this won't
1711 * need to be a C routine at all...
1713 if (jtag_reset_config
& RESET_HAS_SRST
) {
1714 jtag_add_reset(1, 1);
1715 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1716 jtag_add_reset(0, 1);
1718 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1721 /* some targets enable us to connect with srst asserted */
1722 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1723 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1724 jtag_add_reset(0, 1);
1726 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1727 jtag_add_reset(0, 0);
1730 jtag_add_reset(0, 0);
1731 retval
= jtag_execute_queue();
1732 if (retval
!= ERROR_OK
)
1735 /* Check that we can communication on the JTAG chain + eventually we want to
1736 * be able to perform enumeration only after OpenOCD has started
1737 * telnet and GDB server
1739 * That would allow users to more easily perform any magic they need to before
1742 return jtag_init_inner(cmd_ctx
);
1745 int jtag_init(struct command_context
*cmd_ctx
)
1747 int retval
= adapter_init(cmd_ctx
);
1748 if (retval
!= ERROR_OK
)
1751 /* guard against oddball hardware: force resets to be inactive */
1752 jtag_add_reset(0, 0);
1754 /* some targets enable us to connect with srst asserted */
1755 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1756 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1757 jtag_add_reset(0, 1);
1759 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1761 retval
= jtag_execute_queue();
1762 if (retval
!= ERROR_OK
)
1765 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1771 unsigned jtag_get_speed_khz(void)
1776 static int adapter_khz_to_speed(unsigned khz
, int *speed
)
1778 LOG_DEBUG("convert khz to interface specific speed value");
1782 LOG_DEBUG("have interface set up");
1784 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1788 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1789 if (ERROR_OK
!= retval
)
1791 *speed
= speed_div1
;
1795 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int *speed
)
1797 int retval
= adapter_khz_to_speed(0, speed
);
1798 if ((ERROR_OK
!= retval
) && fallback_speed_khz
) {
1799 LOG_DEBUG("trying fallback speed...");
1800 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1805 static int jtag_set_speed(int speed
)
1808 /* this command can be called during CONFIG,
1809 * in which case jtag isn't initialized */
1810 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1813 int jtag_config_khz(unsigned khz
)
1815 LOG_DEBUG("handle jtag khz");
1816 clock_mode
= CLOCK_MODE_KHZ
;
1818 int retval
= adapter_khz_to_speed(khz
, &speed
);
1819 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1822 int jtag_config_rclk(unsigned fallback_speed_khz
)
1824 LOG_DEBUG("handle jtag rclk");
1825 clock_mode
= CLOCK_MODE_RCLK
;
1826 rclk_fallback_speed_khz
= fallback_speed_khz
;
1828 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1829 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1832 int jtag_get_speed(int *speed
)
1834 switch (clock_mode
) {
1835 case CLOCK_MODE_KHZ
:
1836 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1838 case CLOCK_MODE_RCLK
:
1839 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1842 LOG_ERROR("BUG: unknown jtag clock mode");
1848 int jtag_get_speed_readable(int *khz
)
1850 int jtag_speed_var
= 0;
1851 int retval
= jtag_get_speed(&jtag_speed_var
);
1852 if (retval
!= ERROR_OK
)
1856 if (!jtag
->speed_div
) {
1857 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1860 return jtag
->speed_div(jtag_speed_var
, khz
);
1863 void jtag_set_verify(bool enable
)
1865 jtag_verify
= enable
;
1868 bool jtag_will_verify(void)
1873 void jtag_set_verify_capture_ir(bool enable
)
1875 jtag_verify_capture_ir
= enable
;
1878 bool jtag_will_verify_capture_ir(void)
1880 return jtag_verify_capture_ir
;
1883 int jtag_power_dropout(int *dropout
)
1886 /* TODO: as the jtag interface is not valid all
1887 * we can do at the moment is exit OpenOCD */
1888 LOG_ERROR("No Valid JTAG Interface Configured.");
1891 if (jtag
->power_dropout
)
1892 return jtag
->power_dropout(dropout
);
1894 *dropout
= 0; /* by default we can't detect power dropout */
1898 int jtag_srst_asserted(int *srst_asserted
)
1900 if (jtag
->srst_asserted
)
1901 return jtag
->srst_asserted(srst_asserted
);
1903 *srst_asserted
= 0; /* by default we can't detect srst asserted */
1907 enum reset_types
jtag_get_reset_config(void)
1909 return jtag_reset_config
;
1911 void jtag_set_reset_config(enum reset_types type
)
1913 jtag_reset_config
= type
;
1916 int jtag_get_trst(void)
1918 return jtag_trst
== 1;
1920 int jtag_get_srst(void)
1922 return jtag_srst
== 1;
1925 void jtag_set_nsrst_delay(unsigned delay
)
1927 adapter_nsrst_delay
= delay
;
1929 unsigned jtag_get_nsrst_delay(void)
1931 return adapter_nsrst_delay
;
1933 void jtag_set_ntrst_delay(unsigned delay
)
1935 jtag_ntrst_delay
= delay
;
1937 unsigned jtag_get_ntrst_delay(void)
1939 return jtag_ntrst_delay
;
1943 void jtag_set_nsrst_assert_width(unsigned delay
)
1945 adapter_nsrst_assert_width
= delay
;
1947 unsigned jtag_get_nsrst_assert_width(void)
1949 return adapter_nsrst_assert_width
;
1951 void jtag_set_ntrst_assert_width(unsigned delay
)
1953 jtag_ntrst_assert_width
= delay
;
1955 unsigned jtag_get_ntrst_assert_width(void)
1957 return jtag_ntrst_assert_width
;
1960 static int jtag_select(struct command_context
*ctx
)
1964 /* NOTE: interface init must already have been done.
1965 * That works with only C code ... no Tcl glue required.
1968 retval
= jtag_register_commands(ctx
);
1970 if (retval
!= ERROR_OK
)
1973 retval
= svf_register_commands(ctx
);
1975 if (retval
!= ERROR_OK
)
1978 return xsvf_register_commands(ctx
);
1981 static struct transport jtag_transport
= {
1983 .select
= jtag_select
,
1987 static void jtag_constructor(void) __attribute__((constructor
));
1988 static void jtag_constructor(void)
1990 transport_register(&jtag_transport
);
1993 /** Returns true if the current debug session
1994 * is using JTAG as its transport.
1996 bool transport_is_jtag(void)
1998 return get_current_transport() == &jtag_transport
;
2001 int adapter_resets(int trst
, int srst
)
2003 if (get_current_transport() == NULL
) {
2004 LOG_ERROR("transport is not selected");
2008 if (transport_is_jtag()) {
2009 if (srst
== SRST_ASSERT
&& !(jtag_reset_config
& RESET_HAS_SRST
)) {
2010 LOG_ERROR("adapter has no srst signal");
2014 /* adapters without trst signal will eventually use tlr sequence */
2015 jtag_add_reset(trst
, srst
);
2017 * The jtag queue is still used for reset by some adapter. Flush it!
2018 * FIXME: To be removed when all adapter drivers will be updated!
2020 jtag_execute_queue();
2022 } else if (transport_is_swd() || transport_is_hla() ||
2023 transport_is_dapdirect_swd() || transport_is_dapdirect_jtag() ||
2024 transport_is_swim()) {
2025 if (trst
== TRST_ASSERT
) {
2026 LOG_ERROR("transport %s has no trst signal",
2027 get_current_transport()->name
);
2031 if (srst
== SRST_ASSERT
&& !(jtag_reset_config
& RESET_HAS_SRST
)) {
2032 LOG_ERROR("adapter has no srst signal");
2035 adapter_system_reset(srst
);
2039 if (trst
== TRST_DEASSERT
&& srst
== SRST_DEASSERT
)
2042 LOG_ERROR("reset is not supported on transport %s",
2043 get_current_transport()->name
);
2048 int adapter_assert_reset(void)
2050 if (transport_is_jtag()) {
2051 if (jtag_reset_config
& RESET_SRST_PULLS_TRST
)
2052 jtag_add_reset(1, 1);
2054 jtag_add_reset(0, 1);
2056 } else if (transport_is_swd() || transport_is_hla() ||
2057 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2058 transport_is_swim())
2059 return adapter_system_reset(1);
2060 else if (get_current_transport() != NULL
)
2061 LOG_ERROR("reset is not supported on %s",
2062 get_current_transport()->name
);
2064 LOG_ERROR("transport is not selected");
2068 int adapter_deassert_reset(void)
2070 if (transport_is_jtag()) {
2071 jtag_add_reset(0, 0);
2073 } else if (transport_is_swd() || transport_is_hla() ||
2074 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2075 transport_is_swim())
2076 return adapter_system_reset(0);
2077 else if (get_current_transport() != NULL
)
2078 LOG_ERROR("reset is not supported on %s",
2079 get_current_transport()->name
);
2081 LOG_ERROR("transport is not selected");
2085 int adapter_config_trace(bool enabled
, enum tpiu_pin_protocol pin_protocol
,
2086 uint32_t port_size
, unsigned int *trace_freq
,
2087 unsigned int traceclkin_freq
, uint16_t *prescaler
)
2089 if (jtag
->config_trace
) {
2090 return jtag
->config_trace(enabled
, pin_protocol
, port_size
, trace_freq
,
2091 traceclkin_freq
, prescaler
);
2092 } else if (enabled
) {
2093 LOG_ERROR("The selected interface does not support tracing");
2100 int adapter_poll_trace(uint8_t *buf
, size_t *size
)
2102 if (jtag
->poll_trace
)
2103 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)