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 static struct jtag_interface
*jtag
;
132 struct jtag_interface
*jtag_interface
;
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 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 /* this is synchronous for a minidriver */
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
->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");
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_str(captured
, bits
, 16);
894 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
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_str(in_check_mask
, bits
, 16);
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 int result
= jtag
->execute_queue();
943 /* Only build this if we use a regular driver with a command queue.
944 * Otherwise jtag_command_queue won't be found at compile/link time. Its
945 * definition is in jtag/commands.c, which is only built/linked by
946 * jtag/Makefile.am if MINIDRIVER_DUMMY || !MINIDRIVER, but those variables
947 * aren't accessible here. */
948 struct jtag_command
*cmd
= jtag_command_queue
;
949 while (debug_level
>= LOG_LVL_DEBUG
&& cmd
) {
952 LOG_DEBUG_IO("JTAG %s SCAN to %s",
953 cmd
->cmd
.scan
->ir_scan
? "IR" : "DR",
954 tap_state_name(cmd
->cmd
.scan
->end_state
));
955 for (int i
= 0; i
< cmd
->cmd
.scan
->num_fields
; i
++) {
956 struct scan_field
*field
= cmd
->cmd
.scan
->fields
+ i
;
957 if (field
->out_value
) {
958 char *str
= buf_to_str(field
->out_value
, field
->num_bits
, 16);
959 LOG_DEBUG_IO(" %db out: %s", field
->num_bits
, str
);
962 if (field
->in_value
) {
963 char *str
= buf_to_str(field
->in_value
, field
->num_bits
, 16);
964 LOG_DEBUG_IO(" %db in: %s", field
->num_bits
, str
);
970 LOG_DEBUG_IO("JTAG TLR RESET to %s",
971 tap_state_name(cmd
->cmd
.statemove
->end_state
));
974 LOG_DEBUG_IO("JTAG RUNTEST %d cycles to %s",
975 cmd
->cmd
.runtest
->num_cycles
,
976 tap_state_name(cmd
->cmd
.runtest
->end_state
));
980 const char *reset_str
[3] = {
981 "leave", "deassert", "assert"
983 LOG_DEBUG_IO("JTAG RESET %s TRST, %s SRST",
984 reset_str
[cmd
->cmd
.reset
->trst
+ 1],
985 reset_str
[cmd
->cmd
.reset
->srst
+ 1]);
989 LOG_DEBUG_IO("JTAG PATHMOVE (TODO)");
992 LOG_DEBUG_IO("JTAG SLEEP (TODO)");
994 case JTAG_STABLECLOCKS
:
995 LOG_DEBUG_IO("JTAG STABLECLOCKS (TODO)");
998 LOG_DEBUG_IO("JTAG TMS (TODO)");
1001 LOG_ERROR("Unknown JTAG command: %d", cmd
->type
);
1011 void jtag_execute_queue_noclear(void)
1013 jtag_flush_queue_count
++;
1014 jtag_set_error(interface_jtag_execute_queue());
1016 if (jtag_flush_queue_sleep
> 0) {
1017 /* For debug purposes it can be useful to test performance
1018 * or behavior when delaying after flushing the queue,
1019 * e.g. to simulate long roundtrip times.
1021 usleep(jtag_flush_queue_sleep
* 1000);
1025 int jtag_get_flush_queue_count(void)
1027 return jtag_flush_queue_count
;
1030 int jtag_execute_queue(void)
1032 jtag_execute_queue_noclear();
1033 return jtag_error_clear();
1036 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
1038 struct jtag_tap
*tap
= priv
;
1040 if (event
== JTAG_TRST_ASSERTED
) {
1041 tap
->enabled
= !tap
->disabled_after_reset
;
1043 /* current instruction is either BYPASS or IDCODE */
1044 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1051 /* sleep at least us microseconds. When we sleep more than 1000ms we
1052 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
1053 * GDB if we slept for <1000ms many times.
1055 void jtag_sleep(uint32_t us
)
1060 alive_sleep((us
+999)/1000);
1063 #define JTAG_MAX_AUTO_TAPS 20
1065 #define EXTRACT_JEP106_BANK(X) (((X) & 0xf00) >> 8)
1066 #define EXTRACT_JEP106_ID(X) (((X) & 0xfe) >> 1)
1067 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1068 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1069 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1071 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
1072 * know that no valid TAP will have it as an IDCODE value.
1074 #define END_OF_CHAIN_FLAG 0xffffffff
1076 /* a larger IR length than we ever expect to autoprobe */
1077 #define JTAG_IRLEN_MAX 60
1079 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
1081 struct scan_field field
= {
1082 .num_bits
= num_idcode
* 32,
1083 .out_value
= idcode_buffer
,
1084 .in_value
= idcode_buffer
,
1087 /* initialize to the end of chain ID value */
1088 for (unsigned i
= 0; i
< num_idcode
; i
++)
1089 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
1091 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
1093 return jtag_execute_queue();
1096 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
1098 uint8_t zero_check
= 0x0;
1099 uint8_t one_check
= 0xff;
1101 for (unsigned i
= 0; i
< count
* 4; i
++) {
1102 zero_check
|= idcodes
[i
];
1103 one_check
&= idcodes
[i
];
1106 /* if there wasn't a single non-zero bit or if all bits were one,
1107 * the scan is not valid. We wrote a mix of both values; either
1109 * - There's a hardware issue (almost certainly):
1110 * + all-zeroes can mean a target stuck in JTAG reset
1111 * + all-ones tends to mean no target
1112 * - The scan chain is WAY longer than we can handle, *AND* either
1113 * + there are several hundreds of TAPs in bypass, or
1114 * + at least a few dozen TAPs all have an all-ones IDCODE
1116 if (zero_check
== 0x00 || one_check
== 0xff) {
1117 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
1118 (zero_check
== 0x00) ? "zeroes" : "ones");
1119 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
1125 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
1126 const char *name
, uint32_t idcode
)
1128 log_printf_lf(level
, __FILE__
, __LINE__
, __func__
,
1129 "JTAG tap: %s %16.16s: 0x%08x "
1130 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
1132 (unsigned int)idcode
,
1133 (unsigned int)EXTRACT_MFG(idcode
),
1134 jep106_manufacturer(EXTRACT_JEP106_BANK(idcode
), EXTRACT_JEP106_ID(idcode
)),
1135 (unsigned int)EXTRACT_PART(idcode
),
1136 (unsigned int)EXTRACT_VER(idcode
));
1139 static bool jtag_idcode_is_final(uint32_t idcode
)
1142 * Some devices, such as AVR8, will output all 1's instead
1143 * of TDI input value at end of chain. Allow those values
1144 * instead of failing.
1146 return idcode
== END_OF_CHAIN_FLAG
;
1150 * This helper checks that remaining bits in the examined chain data are
1151 * all as expected, but a single JTAG device requires only 64 bits to be
1152 * read back correctly. This can help identify and diagnose problems
1153 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1154 * Returns TRUE iff garbage was found.
1156 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
1158 bool triggered
= false;
1159 for (; count
< max
- 31; count
+= 32) {
1160 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
1162 /* do not trigger the warning if the data looks good */
1163 if (jtag_idcode_is_final(idcode
))
1165 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1166 count
, (unsigned int)idcode
);
1172 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
1175 if (tap
->expected_ids_cnt
== 0 || !tap
->hasidcode
)
1178 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1179 uint32_t mask
= tap
->ignore_version
? ~(0xfU
<< 28) : ~0U;
1180 uint32_t idcode
= tap
->idcode
& mask
;
1182 /* Loop over the expected identification codes and test for a match */
1183 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1184 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
1186 if (idcode
== expected
)
1189 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1190 if (0 == tap
->expected_ids
[ii
])
1194 /* If none of the expected ids matched, warn */
1195 jtag_examine_chain_display(LOG_LVL_WARNING
, "UNEXPECTED",
1196 tap
->dotted_name
, tap
->idcode
);
1197 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1200 snprintf(msg
, sizeof(msg
), "expected %u of %u", ii
+ 1, tap
->expected_ids_cnt
);
1201 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1202 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1207 /* Try to examine chain layout according to IEEE 1149.1 §12
1208 * This is called a "blind interrogation" of the scan chain.
1210 static int jtag_examine_chain(void)
1213 unsigned max_taps
= jtag_tap_count();
1215 /* Autoprobe up to this many. */
1216 if (max_taps
< JTAG_MAX_AUTO_TAPS
)
1217 max_taps
= JTAG_MAX_AUTO_TAPS
;
1219 /* Add room for end-of-chain marker. */
1222 uint8_t *idcode_buffer
= malloc(max_taps
* 4);
1223 if (idcode_buffer
== NULL
)
1224 return ERROR_JTAG_INIT_FAILED
;
1226 /* DR scan to collect BYPASS or IDCODE register contents.
1227 * Then make sure the scan data has both ones and zeroes.
1229 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1230 retval
= jtag_examine_chain_execute(idcode_buffer
, max_taps
);
1231 if (retval
!= ERROR_OK
)
1233 if (!jtag_examine_chain_check(idcode_buffer
, max_taps
)) {
1234 retval
= ERROR_JTAG_INIT_FAILED
;
1238 /* Point at the 1st predefined tap, if any */
1239 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1241 unsigned bit_count
= 0;
1242 unsigned autocount
= 0;
1243 for (unsigned i
= 0; i
< max_taps
; i
++) {
1244 assert(bit_count
< max_taps
* 32);
1245 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1247 /* No predefined TAP? Auto-probe. */
1249 /* Is there another TAP? */
1250 if (jtag_idcode_is_final(idcode
))
1253 /* Default everything in this TAP except IR length.
1255 * REVISIT create a jtag_alloc(chip, tap) routine, and
1256 * share it with jim_newtap_cmd().
1258 tap
= calloc(1, sizeof *tap
);
1260 retval
= ERROR_FAIL
;
1264 tap
->chip
= alloc_printf("auto%u", autocount
++);
1265 tap
->tapname
= strdup("tap");
1266 tap
->dotted_name
= alloc_printf("%s.%s", tap
->chip
, tap
->tapname
);
1268 tap
->ir_length
= 0; /* ... signifying irlen autoprobe */
1269 tap
->ir_capture_mask
= 0x03;
1270 tap
->ir_capture_value
= 0x01;
1272 tap
->enabled
= true;
1277 if ((idcode
& 1) == 0) {
1278 /* Zero for LSB indicates a device in bypass */
1279 LOG_INFO("TAP %s does not have valid IDCODE (idcode=0x%x)",
1280 tap
->dotted_name
, idcode
);
1281 tap
->hasidcode
= false;
1286 /* Friendly devices support IDCODE */
1287 tap
->hasidcode
= true;
1288 tap
->idcode
= idcode
;
1289 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found", tap
->dotted_name
, idcode
);
1294 /* ensure the TAP ID matches what was expected */
1295 if (!jtag_examine_chain_match_tap(tap
))
1296 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1298 tap
= jtag_tap_next_enabled(tap
);
1301 /* After those IDCODE or BYPASS register values should be
1302 * only the data we fed into the scan chain.
1304 if (jtag_examine_chain_end(idcode_buffer
, bit_count
, max_taps
* 32)) {
1305 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1306 retval
= ERROR_JTAG_INIT_FAILED
;
1310 /* Return success or, for backwards compatibility if only
1311 * some IDCODE values mismatched, a soft/continuable fault.
1314 free(idcode_buffer
);
1319 * Validate the date loaded by entry to the Capture-IR state, to help
1320 * find errors related to scan chain configuration (wrong IR lengths)
1323 * Entry state can be anything. On non-error exit, all TAPs are in
1324 * bypass mode. On error exits, the scan chain is reset.
1326 static int jtag_validate_ircapture(void)
1328 struct jtag_tap
*tap
;
1329 int total_ir_length
= 0;
1330 uint8_t *ir_test
= NULL
;
1331 struct scan_field field
;
1336 /* when autoprobing, accomodate huge IR lengths */
1337 for (tap
= NULL
, total_ir_length
= 0;
1338 (tap
= jtag_tap_next_enabled(tap
)) != NULL
;
1339 total_ir_length
+= tap
->ir_length
) {
1340 if (tap
->ir_length
== 0)
1341 total_ir_length
+= JTAG_IRLEN_MAX
;
1344 /* increase length to add 2 bit sentinel after scan */
1345 total_ir_length
+= 2;
1347 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1348 if (ir_test
== NULL
)
1351 /* after this scan, all TAPs will capture BYPASS instructions */
1352 buf_set_ones(ir_test
, total_ir_length
);
1354 field
.num_bits
= total_ir_length
;
1355 field
.out_value
= ir_test
;
1356 field
.in_value
= ir_test
;
1358 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1360 LOG_DEBUG("IR capture validation scan");
1361 retval
= jtag_execute_queue();
1362 if (retval
!= ERROR_OK
)
1369 tap
= jtag_tap_next_enabled(tap
);
1373 /* If we're autoprobing, guess IR lengths. They must be at
1374 * least two bits. Guessing will fail if (a) any TAP does
1375 * not conform to the JTAG spec; or (b) when the upper bits
1376 * captured from some conforming TAP are nonzero. Or if
1377 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1378 * an implementation limit, which could someday be raised.
1380 * REVISIT optimization: if there's a *single* TAP we can
1381 * lift restrictions (a) and (b) by scanning a recognizable
1382 * pattern before the all-ones BYPASS. Check for where the
1383 * pattern starts in the result, instead of an 0...01 value.
1385 * REVISIT alternative approach: escape to some tcl code
1386 * which could provide more knowledge, based on IDCODE; and
1387 * only guess when that has no success.
1389 if (tap
->ir_length
== 0) {
1391 while ((val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
+ 1)) == 1
1392 && tap
->ir_length
< JTAG_IRLEN_MAX
) {
1395 LOG_WARNING("AUTO %s - use \"jtag newtap " "%s %s -irlen %d "
1396 "-expected-id 0x%08" PRIx32
"\"",
1397 tap
->dotted_name
, tap
->chip
, tap
->tapname
, tap
->ir_length
, tap
->idcode
);
1400 /* Validate the two LSBs, which must be 01 per JTAG spec.
1402 * Or ... more bits could be provided by TAP declaration.
1403 * Plus, some taps (notably in i.MX series chips) violate
1404 * this part of the JTAG spec, so their capture mask/value
1405 * attributes might disable this test.
1407 val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
);
1408 if ((val
& tap
->ir_capture_mask
) != tap
->ir_capture_value
) {
1409 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64
" not 0x%0*" PRIx32
,
1411 (tap
->ir_length
+ 7) / tap
->ir_length
, val
,
1412 (tap
->ir_length
+ 7) / tap
->ir_length
, tap
->ir_capture_value
);
1414 retval
= ERROR_JTAG_INIT_FAILED
;
1417 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64
, jtag_tap_name(tap
),
1418 (tap
->ir_length
+ 7) / tap
->ir_length
, val
);
1419 chain_pos
+= tap
->ir_length
;
1422 /* verify the '11' sentinel we wrote is returned at the end */
1423 val
= buf_get_u64(ir_test
, chain_pos
, 2);
1425 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1427 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1430 retval
= ERROR_JTAG_INIT_FAILED
;
1435 if (retval
!= ERROR_OK
) {
1437 jtag_execute_queue();
1442 void jtag_tap_init(struct jtag_tap
*tap
)
1444 unsigned ir_len_bits
;
1445 unsigned ir_len_bytes
;
1447 /* if we're autoprobing, cope with potentially huge ir_length */
1448 ir_len_bits
= tap
->ir_length
? : JTAG_IRLEN_MAX
;
1449 ir_len_bytes
= DIV_ROUND_UP(ir_len_bits
, 8);
1451 tap
->expected
= calloc(1, ir_len_bytes
);
1452 tap
->expected_mask
= calloc(1, ir_len_bytes
);
1453 tap
->cur_instr
= malloc(ir_len_bytes
);
1455 /** @todo cope better with ir_length bigger than 32 bits */
1456 if (ir_len_bits
> 32)
1459 buf_set_u32(tap
->expected
, 0, ir_len_bits
, tap
->ir_capture_value
);
1460 buf_set_u32(tap
->expected_mask
, 0, ir_len_bits
, tap
->ir_capture_mask
);
1462 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1464 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1466 /* register the reset callback for the TAP */
1467 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1470 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1471 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1472 tap
->abs_chain_position
, tap
->ir_length
,
1473 (unsigned) tap
->ir_capture_value
,
1474 (unsigned) tap
->ir_capture_mask
);
1477 void jtag_tap_free(struct jtag_tap
*tap
)
1479 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1481 struct jtag_tap_event_action
*jteap
= tap
->event_action
;
1483 struct jtag_tap_event_action
*next
= jteap
->next
;
1484 Jim_DecrRefCount(jteap
->interp
, jteap
->body
);
1489 free(tap
->expected
);
1490 free(tap
->expected_mask
);
1491 free(tap
->expected_ids
);
1492 free(tap
->cur_instr
);
1495 free(tap
->dotted_name
);
1500 * Do low-level setup like initializing registers, output signals,
1503 int adapter_init(struct command_context
*cmd_ctx
)
1508 if (!jtag_interface
) {
1509 /* nothing was previously specified by "interface" command */
1510 LOG_ERROR("Debug Adapter has to be specified, "
1511 "see \"interface\" command");
1512 return ERROR_JTAG_INVALID_INTERFACE
;
1516 retval
= jtag_interface
->init();
1517 if (retval
!= ERROR_OK
)
1519 jtag
= jtag_interface
;
1521 if (jtag
->speed
== NULL
) {
1522 LOG_INFO("This adapter doesn't support configurable speed");
1526 if (CLOCK_MODE_UNSELECTED
== clock_mode
) {
1527 LOG_ERROR("An adapter speed is not selected in the init script."
1528 " Insert a call to adapter_khz or jtag_rclk to proceed.");
1529 return ERROR_JTAG_INIT_FAILED
;
1532 int requested_khz
= jtag_get_speed_khz();
1533 int actual_khz
= requested_khz
;
1534 int jtag_speed_var
= 0;
1535 retval
= jtag_get_speed(&jtag_speed_var
);
1536 if (retval
!= ERROR_OK
)
1538 retval
= jtag
->speed(jtag_speed_var
);
1539 if (retval
!= ERROR_OK
)
1541 retval
= jtag_get_speed_readable(&actual_khz
);
1542 if (ERROR_OK
!= retval
)
1543 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1544 else if (actual_khz
) {
1545 /* Adaptive clocking -- JTAG-specific */
1546 if ((CLOCK_MODE_RCLK
== clock_mode
)
1547 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
)) {
1548 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1551 LOG_INFO("clock speed %d kHz", actual_khz
);
1553 LOG_INFO("RCLK (adaptive clock speed)");
1558 int jtag_init_inner(struct command_context
*cmd_ctx
)
1560 struct jtag_tap
*tap
;
1562 bool issue_setup
= true;
1564 LOG_DEBUG("Init JTAG chain");
1566 tap
= jtag_tap_next_enabled(NULL
);
1568 /* Once JTAG itself is properly set up, and the scan chain
1569 * isn't absurdly large, IDCODE autoprobe should work fine.
1571 * But ... IRLEN autoprobe can fail even on systems which
1572 * are fully conformant to JTAG. Also, JTAG setup can be
1573 * quite finicky on some systems.
1575 * REVISIT: if TAP autoprobe works OK, then in many cases
1576 * we could escape to tcl code and set up targets based on
1577 * the TAP's IDCODE values.
1579 LOG_WARNING("There are no enabled taps. "
1580 "AUTO PROBING MIGHT NOT WORK!!");
1582 /* REVISIT default clock will often be too fast ... */
1586 retval
= jtag_execute_queue();
1587 if (retval
!= ERROR_OK
)
1590 /* Examine DR values first. This discovers problems which will
1591 * prevent communication ... hardware issues like TDO stuck, or
1592 * configuring the wrong number of (enabled) TAPs.
1594 retval
= jtag_examine_chain();
1597 /* complete success */
1600 /* For backward compatibility reasons, try coping with
1601 * configuration errors involving only ID mismatches.
1602 * We might be able to talk to the devices.
1604 * Also the device might be powered down during startup.
1606 * After OpenOCD starts, we can try to power on the device
1609 LOG_ERROR("Trying to use configured scan chain anyway...");
1610 issue_setup
= false;
1614 /* Now look at IR values. Problems here will prevent real
1615 * communication. They mostly mean that the IR length is
1616 * wrong ... or that the IR capture value is wrong. (The
1617 * latter is uncommon, but easily worked around: provide
1618 * ircapture/irmask values during TAP setup.)
1620 retval
= jtag_validate_ircapture();
1621 if (retval
!= ERROR_OK
) {
1622 /* The target might be powered down. The user
1623 * can power it up and reset it after firing
1626 issue_setup
= false;
1630 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1632 LOG_WARNING("Bypassing JTAG setup events due to errors");
1638 int adapter_quit(void)
1640 if (jtag
&& jtag
->quit
) {
1641 /* close the JTAG interface */
1642 int result
= jtag
->quit();
1643 if (ERROR_OK
!= result
)
1644 LOG_ERROR("failed: %d", result
);
1647 struct jtag_tap
*t
= jtag_all_taps();
1649 struct jtag_tap
*n
= t
->next_tap
;
1657 int swd_init_reset(struct command_context
*cmd_ctx
)
1659 int retval
, retval1
;
1661 retval
= adapter_init(cmd_ctx
);
1662 if (retval
!= ERROR_OK
)
1665 LOG_DEBUG("Initializing with hard SRST reset");
1667 if (jtag_reset_config
& RESET_HAS_SRST
)
1668 retval
= adapter_system_reset(1);
1669 retval1
= adapter_system_reset(0);
1671 return (retval
== ERROR_OK
) ? retval1
: retval
;
1674 int jtag_init_reset(struct command_context
*cmd_ctx
)
1676 int retval
= adapter_init(cmd_ctx
);
1677 if (retval
!= ERROR_OK
)
1680 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1683 * This procedure is used by default when OpenOCD triggers a reset.
1684 * It's now done through an overridable Tcl "init_reset" wrapper.
1686 * This started out as a more powerful "get JTAG working" reset than
1687 * jtag_init_inner(), applying TRST because some chips won't activate
1688 * JTAG without a TRST cycle (presumed to be async, though some of
1689 * those chips synchronize JTAG activation using TCK).
1691 * But some chips only activate JTAG as part of an SRST cycle; SRST
1692 * got mixed in. So it became a hard reset routine, which got used
1693 * in more places, and which coped with JTAG reset being forced as
1694 * part of SRST (srst_pulls_trst).
1696 * And even more corner cases started to surface: TRST and/or SRST
1697 * assertion timings matter; some chips need other JTAG operations;
1698 * TRST/SRST sequences can need to be different from these, etc.
1700 * Systems should override that wrapper to support system-specific
1701 * requirements that this not-fully-generic code doesn't handle.
1703 * REVISIT once Tcl code can read the reset_config modes, this won't
1704 * need to be a C routine at all...
1706 if (jtag_reset_config
& RESET_HAS_SRST
) {
1707 jtag_add_reset(1, 1);
1708 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1709 jtag_add_reset(0, 1);
1711 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1714 /* some targets enable us to connect with srst asserted */
1715 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1716 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1717 jtag_add_reset(0, 1);
1719 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1720 jtag_add_reset(0, 0);
1723 jtag_add_reset(0, 0);
1724 retval
= jtag_execute_queue();
1725 if (retval
!= ERROR_OK
)
1728 /* Check that we can communication on the JTAG chain + eventually we want to
1729 * be able to perform enumeration only after OpenOCD has started
1730 * telnet and GDB server
1732 * That would allow users to more easily perform any magic they need to before
1735 return jtag_init_inner(cmd_ctx
);
1738 int jtag_init(struct command_context
*cmd_ctx
)
1740 int retval
= adapter_init(cmd_ctx
);
1741 if (retval
!= ERROR_OK
)
1744 /* guard against oddball hardware: force resets to be inactive */
1745 jtag_add_reset(0, 0);
1747 /* some targets enable us to connect with srst asserted */
1748 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1749 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1750 jtag_add_reset(0, 1);
1752 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1754 retval
= jtag_execute_queue();
1755 if (retval
!= ERROR_OK
)
1758 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1764 unsigned jtag_get_speed_khz(void)
1769 static int adapter_khz_to_speed(unsigned khz
, int *speed
)
1771 LOG_DEBUG("convert khz to interface specific speed value");
1775 LOG_DEBUG("have interface set up");
1777 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1781 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1782 if (ERROR_OK
!= retval
)
1784 *speed
= speed_div1
;
1788 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int *speed
)
1790 int retval
= adapter_khz_to_speed(0, speed
);
1791 if ((ERROR_OK
!= retval
) && fallback_speed_khz
) {
1792 LOG_DEBUG("trying fallback speed...");
1793 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1798 static int jtag_set_speed(int speed
)
1801 /* this command can be called during CONFIG,
1802 * in which case jtag isn't initialized */
1803 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1806 int jtag_config_khz(unsigned khz
)
1808 LOG_DEBUG("handle jtag khz");
1809 clock_mode
= CLOCK_MODE_KHZ
;
1811 int retval
= adapter_khz_to_speed(khz
, &speed
);
1812 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1815 int jtag_config_rclk(unsigned fallback_speed_khz
)
1817 LOG_DEBUG("handle jtag rclk");
1818 clock_mode
= CLOCK_MODE_RCLK
;
1819 rclk_fallback_speed_khz
= fallback_speed_khz
;
1821 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1822 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1825 int jtag_get_speed(int *speed
)
1827 switch (clock_mode
) {
1828 case CLOCK_MODE_KHZ
:
1829 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1831 case CLOCK_MODE_RCLK
:
1832 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1835 LOG_ERROR("BUG: unknown jtag clock mode");
1841 int jtag_get_speed_readable(int *khz
)
1843 int jtag_speed_var
= 0;
1844 int retval
= jtag_get_speed(&jtag_speed_var
);
1845 if (retval
!= ERROR_OK
)
1849 if (!jtag
->speed_div
) {
1850 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1853 return jtag
->speed_div(jtag_speed_var
, khz
);
1856 void jtag_set_verify(bool enable
)
1858 jtag_verify
= enable
;
1861 bool jtag_will_verify()
1866 void jtag_set_verify_capture_ir(bool enable
)
1868 jtag_verify_capture_ir
= enable
;
1871 bool jtag_will_verify_capture_ir()
1873 return jtag_verify_capture_ir
;
1876 int jtag_power_dropout(int *dropout
)
1879 /* TODO: as the jtag interface is not valid all
1880 * we can do at the moment is exit OpenOCD */
1881 LOG_ERROR("No Valid JTAG Interface Configured.");
1884 if (jtag
->power_dropout
)
1885 return jtag
->power_dropout(dropout
);
1887 *dropout
= 0; /* by default we can't detect power dropout */
1891 int jtag_srst_asserted(int *srst_asserted
)
1893 if (jtag
->srst_asserted
)
1894 return jtag
->srst_asserted(srst_asserted
);
1896 *srst_asserted
= 0; /* by default we can't detect srst asserted */
1900 enum reset_types
jtag_get_reset_config(void)
1902 return jtag_reset_config
;
1904 void jtag_set_reset_config(enum reset_types type
)
1906 jtag_reset_config
= type
;
1909 int jtag_get_trst(void)
1911 return jtag_trst
== 1;
1913 int jtag_get_srst(void)
1915 return jtag_srst
== 1;
1918 void jtag_set_nsrst_delay(unsigned delay
)
1920 adapter_nsrst_delay
= delay
;
1922 unsigned jtag_get_nsrst_delay(void)
1924 return adapter_nsrst_delay
;
1926 void jtag_set_ntrst_delay(unsigned delay
)
1928 jtag_ntrst_delay
= delay
;
1930 unsigned jtag_get_ntrst_delay(void)
1932 return jtag_ntrst_delay
;
1936 void jtag_set_nsrst_assert_width(unsigned delay
)
1938 adapter_nsrst_assert_width
= delay
;
1940 unsigned jtag_get_nsrst_assert_width(void)
1942 return adapter_nsrst_assert_width
;
1944 void jtag_set_ntrst_assert_width(unsigned delay
)
1946 jtag_ntrst_assert_width
= delay
;
1948 unsigned jtag_get_ntrst_assert_width(void)
1950 return jtag_ntrst_assert_width
;
1953 static int jtag_select(struct command_context
*ctx
)
1957 /* NOTE: interface init must already have been done.
1958 * That works with only C code ... no Tcl glue required.
1961 retval
= jtag_register_commands(ctx
);
1963 if (retval
!= ERROR_OK
)
1966 retval
= svf_register_commands(ctx
);
1968 if (retval
!= ERROR_OK
)
1971 return xsvf_register_commands(ctx
);
1974 static struct transport jtag_transport
= {
1976 .select
= jtag_select
,
1980 static void jtag_constructor(void) __attribute__((constructor
));
1981 static void jtag_constructor(void)
1983 transport_register(&jtag_transport
);
1986 /** Returns true if the current debug session
1987 * is using JTAG as its transport.
1989 bool transport_is_jtag(void)
1991 return get_current_transport() == &jtag_transport
;
1994 int adapter_resets(int trst
, int srst
)
1996 if (get_current_transport() == NULL
) {
1997 LOG_ERROR("transport is not selected");
2001 if (transport_is_jtag()) {
2002 if (srst
== SRST_ASSERT
&& !(jtag_reset_config
& RESET_HAS_SRST
)) {
2003 LOG_ERROR("adapter has no srst signal");
2007 /* adapters without trst signal will eventually use tlr sequence */
2008 jtag_add_reset(trst
, srst
);
2010 } else if (transport_is_swd() || transport_is_hla()) {
2011 if (trst
== TRST_ASSERT
) {
2012 LOG_ERROR("transport %s has no trst signal",
2013 get_current_transport()->name
);
2017 if (srst
== SRST_ASSERT
&& !(jtag_reset_config
& RESET_HAS_SRST
)) {
2018 LOG_ERROR("adapter has no srst signal");
2021 adapter_system_reset(srst
);
2025 if (trst
== TRST_DEASSERT
&& srst
== SRST_DEASSERT
)
2028 LOG_ERROR("reset is not supported on transport %s",
2029 get_current_transport()->name
);
2034 int adapter_assert_reset(void)
2036 if (transport_is_jtag()) {
2037 if (jtag_reset_config
& RESET_SRST_PULLS_TRST
)
2038 jtag_add_reset(1, 1);
2040 jtag_add_reset(0, 1);
2042 } else if (transport_is_swd() || transport_is_hla())
2043 return adapter_system_reset(1);
2044 else if (get_current_transport() != NULL
)
2045 LOG_ERROR("reset is not supported on %s",
2046 get_current_transport()->name
);
2048 LOG_ERROR("transport is not selected");
2052 int adapter_deassert_reset(void)
2054 if (transport_is_jtag()) {
2055 jtag_add_reset(0, 0);
2057 } else if (transport_is_swd() || transport_is_hla())
2058 return adapter_system_reset(0);
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_config_trace(bool enabled
, enum tpiu_pin_protocol pin_protocol
,
2068 uint32_t port_size
, unsigned int *trace_freq
,
2069 unsigned int traceclkin_freq
, uint16_t *prescaler
)
2071 if (jtag
->config_trace
) {
2072 return jtag
->config_trace(enabled
, pin_protocol
, port_size
, trace_freq
,
2073 traceclkin_freq
, prescaler
);
2074 } else if (enabled
) {
2075 LOG_ERROR("The selected interface does not support tracing");
2082 int adapter_poll_trace(uint8_t *buf
, size_t *size
)
2084 if (jtag
->poll_trace
)
2085 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)