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 void swd_add_reset(int req_srst
)
617 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
618 LOG_ERROR("BUG: can't assert SRST");
619 jtag_set_error(ERROR_FAIL
);
625 /* Maybe change SRST signal state */
626 if (jtag_srst
!= req_srst
) {
629 retval
= interface_jtag_add_reset(0, req_srst
);
630 if (retval
!= ERROR_OK
)
631 jtag_set_error(retval
);
633 retval
= jtag_execute_queue();
635 if (retval
!= ERROR_OK
) {
636 LOG_ERROR("TRST/SRST error");
640 /* SRST resets everything hooked up to that signal */
641 jtag_srst
= req_srst
;
643 LOG_DEBUG("SRST line asserted");
644 if (adapter_nsrst_assert_width
)
645 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
647 LOG_DEBUG("SRST line released");
648 if (adapter_nsrst_delay
)
649 jtag_add_sleep(adapter_nsrst_delay
* 1000);
652 retval
= jtag_execute_queue();
653 if (retval
!= ERROR_OK
) {
654 LOG_ERROR("SRST timings error");
660 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
662 int trst_with_tlr
= 0;
666 /* Without SRST, we must use target-specific JTAG operations
667 * on each target; callers should not be requesting SRST when
668 * that signal doesn't exist.
670 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
671 * can kick in even if the JTAG adapter can't drive TRST.
674 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
675 LOG_ERROR("BUG: can't assert SRST");
676 jtag_set_error(ERROR_FAIL
);
679 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
680 && !req_tlr_or_trst
) {
681 LOG_ERROR("BUG: can't assert only SRST");
682 jtag_set_error(ERROR_FAIL
);
688 /* JTAG reset (entry to TAP_RESET state) can always be achieved
689 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
690 * state first. TRST accelerates it, and bypasses those states.
692 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
693 * can kick in even if the JTAG adapter can't drive SRST.
695 if (req_tlr_or_trst
) {
696 if (!(jtag_reset_config
& RESET_HAS_TRST
))
698 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
705 /* Maybe change TRST and/or SRST signal state */
706 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
709 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
710 if (retval
!= ERROR_OK
)
711 jtag_set_error(retval
);
713 retval
= jtag_execute_queue();
715 if (retval
!= ERROR_OK
) {
716 LOG_ERROR("TRST/SRST error");
721 /* SRST resets everything hooked up to that signal */
722 if (jtag_srst
!= new_srst
) {
723 jtag_srst
= new_srst
;
725 LOG_DEBUG("SRST line asserted");
726 if (adapter_nsrst_assert_width
)
727 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
729 LOG_DEBUG("SRST line released");
730 if (adapter_nsrst_delay
)
731 jtag_add_sleep(adapter_nsrst_delay
* 1000);
735 /* Maybe enter the JTAG TAP_RESET state ...
736 * - using only TMS, TCK, and the JTAG state machine
737 * - or else more directly, using TRST
739 * TAP_RESET should be invisible to non-debug parts of the system.
742 LOG_DEBUG("JTAG reset with TLR instead of TRST");
745 } else if (jtag_trst
!= new_trst
) {
746 jtag_trst
= new_trst
;
748 LOG_DEBUG("TRST line asserted");
749 tap_set_state(TAP_RESET
);
750 if (jtag_ntrst_assert_width
)
751 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
753 LOG_DEBUG("TRST line released");
754 if (jtag_ntrst_delay
)
755 jtag_add_sleep(jtag_ntrst_delay
* 1000);
757 /* We just asserted nTRST, so we're now in TAP_RESET.
758 * Inform possible listeners about this, now that
759 * JTAG instructions and data can be shifted. This
760 * sequence must match jtag_add_tlr().
762 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
763 jtag_notify_event(JTAG_TRST_ASSERTED
);
768 void jtag_add_sleep(uint32_t us
)
770 /** @todo Here, keep_alive() appears to be a layering violation!!! */
772 jtag_set_error(interface_jtag_add_sleep(us
));
775 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
776 uint8_t *in_check_mask
, int num_bits
)
778 int retval
= ERROR_OK
;
782 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
784 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
786 if (compare_failed
) {
787 char *captured_str
, *in_check_value_str
;
788 int bits
= (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
;
790 /* NOTE: we've lost diagnostic context here -- 'which tap' */
792 captured_str
= buf_to_str(captured
, bits
, 16);
793 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
795 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
797 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
800 free(in_check_value_str
);
803 char *in_check_mask_str
;
805 in_check_mask_str
= buf_to_str(in_check_mask
, bits
, 16);
806 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
807 free(in_check_mask_str
);
810 retval
= ERROR_JTAG_QUEUE_FAILED
;
815 void jtag_check_value_mask(struct scan_field
*field
, uint8_t *value
, uint8_t *mask
)
817 assert(field
->in_value
!= NULL
);
820 /* no checking to do */
824 jtag_execute_queue_noclear();
826 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
827 jtag_set_error(retval
);
830 int default_interface_jtag_execute_queue(void)
833 LOG_ERROR("No JTAG interface configured yet. "
834 "Issue 'init' command in startup scripts "
835 "before communicating with targets.");
839 return jtag
->execute_queue();
842 void jtag_execute_queue_noclear(void)
844 jtag_flush_queue_count
++;
845 jtag_set_error(interface_jtag_execute_queue());
847 if (jtag_flush_queue_sleep
> 0) {
848 /* For debug purposes it can be useful to test performance
849 * or behavior when delaying after flushing the queue,
850 * e.g. to simulate long roundtrip times.
852 usleep(jtag_flush_queue_sleep
* 1000);
856 int jtag_get_flush_queue_count(void)
858 return jtag_flush_queue_count
;
861 int jtag_execute_queue(void)
863 jtag_execute_queue_noclear();
864 return jtag_error_clear();
867 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
869 struct jtag_tap
*tap
= priv
;
871 if (event
== JTAG_TRST_ASSERTED
) {
872 tap
->enabled
= !tap
->disabled_after_reset
;
874 /* current instruction is either BYPASS or IDCODE */
875 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
882 /* sleep at least us microseconds. When we sleep more than 1000ms we
883 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
884 * GDB if we slept for <1000ms many times.
886 void jtag_sleep(uint32_t us
)
891 alive_sleep((us
+999)/1000);
894 #define JTAG_MAX_AUTO_TAPS 20
896 #define EXTRACT_JEP106_BANK(X) (((X) & 0xf00) >> 8)
897 #define EXTRACT_JEP106_ID(X) (((X) & 0xfe) >> 1)
898 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
899 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
900 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
902 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
903 * know that no valid TAP will have it as an IDCODE value.
905 #define END_OF_CHAIN_FLAG 0xffffffff
907 /* a larger IR length than we ever expect to autoprobe */
908 #define JTAG_IRLEN_MAX 60
910 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
912 struct scan_field field
= {
913 .num_bits
= num_idcode
* 32,
914 .out_value
= idcode_buffer
,
915 .in_value
= idcode_buffer
,
918 /* initialize to the end of chain ID value */
919 for (unsigned i
= 0; i
< num_idcode
; i
++)
920 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
922 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
924 return jtag_execute_queue();
927 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
929 uint8_t zero_check
= 0x0;
930 uint8_t one_check
= 0xff;
932 for (unsigned i
= 0; i
< count
* 4; i
++) {
933 zero_check
|= idcodes
[i
];
934 one_check
&= idcodes
[i
];
937 /* if there wasn't a single non-zero bit or if all bits were one,
938 * the scan is not valid. We wrote a mix of both values; either
940 * - There's a hardware issue (almost certainly):
941 * + all-zeroes can mean a target stuck in JTAG reset
942 * + all-ones tends to mean no target
943 * - The scan chain is WAY longer than we can handle, *AND* either
944 * + there are several hundreds of TAPs in bypass, or
945 * + at least a few dozen TAPs all have an all-ones IDCODE
947 if (zero_check
== 0x00 || one_check
== 0xff) {
948 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
949 (zero_check
== 0x00) ? "zeroes" : "ones");
950 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
956 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
957 const char *name
, uint32_t idcode
)
959 log_printf_lf(level
, __FILE__
, __LINE__
, __func__
,
960 "JTAG tap: %s %16.16s: 0x%08x "
961 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
963 (unsigned int)idcode
,
964 (unsigned int)EXTRACT_MFG(idcode
),
965 jep106_manufacturer(EXTRACT_JEP106_BANK(idcode
), EXTRACT_JEP106_ID(idcode
)),
966 (unsigned int)EXTRACT_PART(idcode
),
967 (unsigned int)EXTRACT_VER(idcode
));
970 static bool jtag_idcode_is_final(uint32_t idcode
)
973 * Some devices, such as AVR8, will output all 1's instead
974 * of TDI input value at end of chain. Allow those values
975 * instead of failing.
977 return idcode
== END_OF_CHAIN_FLAG
;
981 * This helper checks that remaining bits in the examined chain data are
982 * all as expected, but a single JTAG device requires only 64 bits to be
983 * read back correctly. This can help identify and diagnose problems
984 * with the JTAG chain earlier, gives more helpful/explicit error messages.
985 * Returns TRUE iff garbage was found.
987 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
989 bool triggered
= false;
990 for (; count
< max
- 31; count
+= 32) {
991 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
993 /* do not trigger the warning if the data looks good */
994 if (jtag_idcode_is_final(idcode
))
996 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
997 count
, (unsigned int)idcode
);
1003 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
1006 if (tap
->expected_ids_cnt
== 0 || !tap
->hasidcode
)
1009 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1010 uint32_t mask
= tap
->ignore_version
? ~(0xf << 28) : ~0;
1011 uint32_t idcode
= tap
->idcode
& mask
;
1013 /* Loop over the expected identification codes and test for a match */
1014 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1015 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
1017 if (idcode
== expected
)
1020 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1021 if (0 == tap
->expected_ids
[ii
])
1025 /* If none of the expected ids matched, warn */
1026 jtag_examine_chain_display(LOG_LVL_WARNING
, "UNEXPECTED",
1027 tap
->dotted_name
, tap
->idcode
);
1028 for (unsigned ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1031 snprintf(msg
, sizeof(msg
), "expected %u of %u", ii
+ 1, tap
->expected_ids_cnt
);
1032 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1033 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1038 /* Try to examine chain layout according to IEEE 1149.1 §12
1039 * This is called a "blind interrogation" of the scan chain.
1041 static int jtag_examine_chain(void)
1044 unsigned max_taps
= jtag_tap_count();
1046 /* Autoprobe up to this many. */
1047 if (max_taps
< JTAG_MAX_AUTO_TAPS
)
1048 max_taps
= JTAG_MAX_AUTO_TAPS
;
1050 /* Add room for end-of-chain marker. */
1053 uint8_t *idcode_buffer
= malloc(max_taps
* 4);
1054 if (idcode_buffer
== NULL
)
1055 return ERROR_JTAG_INIT_FAILED
;
1057 /* DR scan to collect BYPASS or IDCODE register contents.
1058 * Then make sure the scan data has both ones and zeroes.
1060 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1061 retval
= jtag_examine_chain_execute(idcode_buffer
, max_taps
);
1062 if (retval
!= ERROR_OK
)
1064 if (!jtag_examine_chain_check(idcode_buffer
, max_taps
)) {
1065 retval
= ERROR_JTAG_INIT_FAILED
;
1069 /* Point at the 1st predefined tap, if any */
1070 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1072 unsigned bit_count
= 0;
1073 unsigned autocount
= 0;
1074 for (unsigned i
= 0; i
< max_taps
; i
++) {
1075 assert(bit_count
< max_taps
* 32);
1076 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1078 /* No predefined TAP? Auto-probe. */
1080 /* Is there another TAP? */
1081 if (jtag_idcode_is_final(idcode
))
1084 /* Default everything in this TAP except IR length.
1086 * REVISIT create a jtag_alloc(chip, tap) routine, and
1087 * share it with jim_newtap_cmd().
1089 tap
= calloc(1, sizeof *tap
);
1091 retval
= ERROR_FAIL
;
1095 tap
->chip
= alloc_printf("auto%u", autocount
++);
1096 tap
->tapname
= strdup("tap");
1097 tap
->dotted_name
= alloc_printf("%s.%s", tap
->chip
, tap
->tapname
);
1099 tap
->ir_length
= 0; /* ... signifying irlen autoprobe */
1100 tap
->ir_capture_mask
= 0x03;
1101 tap
->ir_capture_value
= 0x01;
1103 tap
->enabled
= true;
1108 if ((idcode
& 1) == 0) {
1109 /* Zero for LSB indicates a device in bypass */
1110 LOG_INFO("TAP %s does not have IDCODE", tap
->dotted_name
);
1111 tap
->hasidcode
= false;
1116 /* Friendly devices support IDCODE */
1117 tap
->hasidcode
= true;
1118 tap
->idcode
= idcode
;
1119 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found", tap
->dotted_name
, idcode
);
1124 /* ensure the TAP ID matches what was expected */
1125 if (!jtag_examine_chain_match_tap(tap
))
1126 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1128 tap
= jtag_tap_next_enabled(tap
);
1131 /* After those IDCODE or BYPASS register values should be
1132 * only the data we fed into the scan chain.
1134 if (jtag_examine_chain_end(idcode_buffer
, bit_count
, max_taps
* 32)) {
1135 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1136 retval
= ERROR_JTAG_INIT_FAILED
;
1140 /* Return success or, for backwards compatibility if only
1141 * some IDCODE values mismatched, a soft/continuable fault.
1144 free(idcode_buffer
);
1149 * Validate the date loaded by entry to the Capture-IR state, to help
1150 * find errors related to scan chain configuration (wrong IR lengths)
1153 * Entry state can be anything. On non-error exit, all TAPs are in
1154 * bypass mode. On error exits, the scan chain is reset.
1156 static int jtag_validate_ircapture(void)
1158 struct jtag_tap
*tap
;
1159 int total_ir_length
= 0;
1160 uint8_t *ir_test
= NULL
;
1161 struct scan_field field
;
1166 /* when autoprobing, accomodate huge IR lengths */
1167 for (tap
= NULL
, total_ir_length
= 0;
1168 (tap
= jtag_tap_next_enabled(tap
)) != NULL
;
1169 total_ir_length
+= tap
->ir_length
) {
1170 if (tap
->ir_length
== 0)
1171 total_ir_length
+= JTAG_IRLEN_MAX
;
1174 /* increase length to add 2 bit sentinel after scan */
1175 total_ir_length
+= 2;
1177 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1178 if (ir_test
== NULL
)
1181 /* after this scan, all TAPs will capture BYPASS instructions */
1182 buf_set_ones(ir_test
, total_ir_length
);
1184 field
.num_bits
= total_ir_length
;
1185 field
.out_value
= ir_test
;
1186 field
.in_value
= ir_test
;
1188 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1190 LOG_DEBUG("IR capture validation scan");
1191 retval
= jtag_execute_queue();
1192 if (retval
!= ERROR_OK
)
1199 tap
= jtag_tap_next_enabled(tap
);
1203 /* If we're autoprobing, guess IR lengths. They must be at
1204 * least two bits. Guessing will fail if (a) any TAP does
1205 * not conform to the JTAG spec; or (b) when the upper bits
1206 * captured from some conforming TAP are nonzero. Or if
1207 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1208 * an implementation limit, which could someday be raised.
1210 * REVISIT optimization: if there's a *single* TAP we can
1211 * lift restrictions (a) and (b) by scanning a recognizable
1212 * pattern before the all-ones BYPASS. Check for where the
1213 * pattern starts in the result, instead of an 0...01 value.
1215 * REVISIT alternative approach: escape to some tcl code
1216 * which could provide more knowledge, based on IDCODE; and
1217 * only guess when that has no success.
1219 if (tap
->ir_length
== 0) {
1221 while ((val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
+ 1)) == 1
1222 && tap
->ir_length
< JTAG_IRLEN_MAX
) {
1225 LOG_WARNING("AUTO %s - use \"jtag newtap " "%s %s -irlen %d "
1226 "-expected-id 0x%08" PRIx32
"\"",
1227 tap
->dotted_name
, tap
->chip
, tap
->tapname
, tap
->ir_length
, tap
->idcode
);
1230 /* Validate the two LSBs, which must be 01 per JTAG spec.
1232 * Or ... more bits could be provided by TAP declaration.
1233 * Plus, some taps (notably in i.MX series chips) violate
1234 * this part of the JTAG spec, so their capture mask/value
1235 * attributes might disable this test.
1237 val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
);
1238 if ((val
& tap
->ir_capture_mask
) != tap
->ir_capture_value
) {
1239 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64
" not 0x%0*" PRIx32
,
1241 (tap
->ir_length
+ 7) / tap
->ir_length
, val
,
1242 (tap
->ir_length
+ 7) / tap
->ir_length
, tap
->ir_capture_value
);
1244 retval
= ERROR_JTAG_INIT_FAILED
;
1247 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64
, jtag_tap_name(tap
),
1248 (tap
->ir_length
+ 7) / tap
->ir_length
, val
);
1249 chain_pos
+= tap
->ir_length
;
1252 /* verify the '11' sentinel we wrote is returned at the end */
1253 val
= buf_get_u64(ir_test
, chain_pos
, 2);
1255 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1257 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1260 retval
= ERROR_JTAG_INIT_FAILED
;
1265 if (retval
!= ERROR_OK
) {
1267 jtag_execute_queue();
1272 void jtag_tap_init(struct jtag_tap
*tap
)
1274 unsigned ir_len_bits
;
1275 unsigned ir_len_bytes
;
1277 /* if we're autoprobing, cope with potentially huge ir_length */
1278 ir_len_bits
= tap
->ir_length
? : JTAG_IRLEN_MAX
;
1279 ir_len_bytes
= DIV_ROUND_UP(ir_len_bits
, 8);
1281 tap
->expected
= calloc(1, ir_len_bytes
);
1282 tap
->expected_mask
= calloc(1, ir_len_bytes
);
1283 tap
->cur_instr
= malloc(ir_len_bytes
);
1285 /** @todo cope better with ir_length bigger than 32 bits */
1286 if (ir_len_bits
> 32)
1289 buf_set_u32(tap
->expected
, 0, ir_len_bits
, tap
->ir_capture_value
);
1290 buf_set_u32(tap
->expected_mask
, 0, ir_len_bits
, tap
->ir_capture_mask
);
1292 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1294 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1296 /* register the reset callback for the TAP */
1297 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1300 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1301 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1302 tap
->abs_chain_position
, tap
->ir_length
,
1303 (unsigned) tap
->ir_capture_value
,
1304 (unsigned) tap
->ir_capture_mask
);
1307 void jtag_tap_free(struct jtag_tap
*tap
)
1309 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1311 free(tap
->expected
);
1312 free(tap
->expected_mask
);
1313 free(tap
->expected_ids
);
1314 free(tap
->cur_instr
);
1317 free(tap
->dotted_name
);
1322 * Do low-level setup like initializing registers, output signals,
1325 int adapter_init(struct command_context
*cmd_ctx
)
1330 if (!jtag_interface
) {
1331 /* nothing was previously specified by "interface" command */
1332 LOG_ERROR("Debug Adapter has to be specified, "
1333 "see \"interface\" command");
1334 return ERROR_JTAG_INVALID_INTERFACE
;
1338 retval
= jtag_interface
->init();
1339 if (retval
!= ERROR_OK
)
1341 jtag
= jtag_interface
;
1343 /* LEGACY SUPPORT ... adapter drivers must declare what
1344 * transports they allow. Until they all do so, assume
1345 * the legacy drivers are JTAG-only
1347 if (!transports_are_declared()) {
1348 LOG_ERROR("Adapter driver '%s' did not declare "
1349 "which transports it allows; assuming "
1350 "JTAG-only", jtag
->name
);
1351 retval
= allow_transports(cmd_ctx
, jtag_only
);
1352 if (retval
!= ERROR_OK
)
1356 if (jtag
->speed
== NULL
) {
1357 LOG_INFO("This adapter doesn't support configurable speed");
1361 if (CLOCK_MODE_UNSELECTED
== clock_mode
) {
1362 LOG_ERROR("An adapter speed is not selected in the init script."
1363 " Insert a call to adapter_khz or jtag_rclk to proceed.");
1364 return ERROR_JTAG_INIT_FAILED
;
1367 int requested_khz
= jtag_get_speed_khz();
1368 int actual_khz
= requested_khz
;
1369 int jtag_speed_var
= 0;
1370 retval
= jtag_get_speed(&jtag_speed_var
);
1371 if (retval
!= ERROR_OK
)
1373 retval
= jtag
->speed(jtag_speed_var
);
1374 if (retval
!= ERROR_OK
)
1376 retval
= jtag_get_speed_readable(&actual_khz
);
1377 if (ERROR_OK
!= retval
)
1378 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1379 else if (actual_khz
) {
1380 /* Adaptive clocking -- JTAG-specific */
1381 if ((CLOCK_MODE_RCLK
== clock_mode
)
1382 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
)) {
1383 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1386 LOG_INFO("clock speed %d kHz", actual_khz
);
1388 LOG_INFO("RCLK (adaptive clock speed)");
1393 int jtag_init_inner(struct command_context
*cmd_ctx
)
1395 struct jtag_tap
*tap
;
1397 bool issue_setup
= true;
1399 LOG_DEBUG("Init JTAG chain");
1401 tap
= jtag_tap_next_enabled(NULL
);
1403 /* Once JTAG itself is properly set up, and the scan chain
1404 * isn't absurdly large, IDCODE autoprobe should work fine.
1406 * But ... IRLEN autoprobe can fail even on systems which
1407 * are fully conformant to JTAG. Also, JTAG setup can be
1408 * quite finicky on some systems.
1410 * REVISIT: if TAP autoprobe works OK, then in many cases
1411 * we could escape to tcl code and set up targets based on
1412 * the TAP's IDCODE values.
1414 LOG_WARNING("There are no enabled taps. "
1415 "AUTO PROBING MIGHT NOT WORK!!");
1417 /* REVISIT default clock will often be too fast ... */
1421 retval
= jtag_execute_queue();
1422 if (retval
!= ERROR_OK
)
1425 /* Examine DR values first. This discovers problems which will
1426 * prevent communication ... hardware issues like TDO stuck, or
1427 * configuring the wrong number of (enabled) TAPs.
1429 retval
= jtag_examine_chain();
1432 /* complete success */
1435 /* For backward compatibility reasons, try coping with
1436 * configuration errors involving only ID mismatches.
1437 * We might be able to talk to the devices.
1439 * Also the device might be powered down during startup.
1441 * After OpenOCD starts, we can try to power on the device
1444 LOG_ERROR("Trying to use configured scan chain anyway...");
1445 issue_setup
= false;
1449 /* Now look at IR values. Problems here will prevent real
1450 * communication. They mostly mean that the IR length is
1451 * wrong ... or that the IR capture value is wrong. (The
1452 * latter is uncommon, but easily worked around: provide
1453 * ircapture/irmask values during TAP setup.)
1455 retval
= jtag_validate_ircapture();
1456 if (retval
!= ERROR_OK
) {
1457 /* The target might be powered down. The user
1458 * can power it up and reset it after firing
1461 issue_setup
= false;
1465 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1467 LOG_WARNING("Bypassing JTAG setup events due to errors");
1473 int adapter_quit(void)
1475 if (!jtag
|| !jtag
->quit
)
1478 /* close the JTAG interface */
1479 int result
= jtag
->quit();
1480 if (ERROR_OK
!= result
)
1481 LOG_ERROR("failed: %d", result
);
1486 int swd_init_reset(struct command_context
*cmd_ctx
)
1488 int retval
= adapter_init(cmd_ctx
);
1489 if (retval
!= ERROR_OK
)
1492 LOG_DEBUG("Initializing with hard SRST reset");
1494 if (jtag_reset_config
& RESET_HAS_SRST
)
1497 retval
= jtag_execute_queue();
1501 int jtag_init_reset(struct command_context
*cmd_ctx
)
1503 int retval
= adapter_init(cmd_ctx
);
1504 if (retval
!= ERROR_OK
)
1507 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1510 * This procedure is used by default when OpenOCD triggers a reset.
1511 * It's now done through an overridable Tcl "init_reset" wrapper.
1513 * This started out as a more powerful "get JTAG working" reset than
1514 * jtag_init_inner(), applying TRST because some chips won't activate
1515 * JTAG without a TRST cycle (presumed to be async, though some of
1516 * those chips synchronize JTAG activation using TCK).
1518 * But some chips only activate JTAG as part of an SRST cycle; SRST
1519 * got mixed in. So it became a hard reset routine, which got used
1520 * in more places, and which coped with JTAG reset being forced as
1521 * part of SRST (srst_pulls_trst).
1523 * And even more corner cases started to surface: TRST and/or SRST
1524 * assertion timings matter; some chips need other JTAG operations;
1525 * TRST/SRST sequences can need to be different from these, etc.
1527 * Systems should override that wrapper to support system-specific
1528 * requirements that this not-fully-generic code doesn't handle.
1530 * REVISIT once Tcl code can read the reset_config modes, this won't
1531 * need to be a C routine at all...
1533 if (jtag_reset_config
& RESET_HAS_SRST
) {
1534 jtag_add_reset(1, 1);
1535 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1536 jtag_add_reset(0, 1);
1538 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1541 /* some targets enable us to connect with srst asserted */
1542 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1543 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1544 jtag_add_reset(0, 1);
1546 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1547 jtag_add_reset(0, 0);
1550 jtag_add_reset(0, 0);
1551 retval
= jtag_execute_queue();
1552 if (retval
!= ERROR_OK
)
1555 /* Check that we can communication on the JTAG chain + eventually we want to
1556 * be able to perform enumeration only after OpenOCD has started
1557 * telnet and GDB server
1559 * That would allow users to more easily perform any magic they need to before
1562 return jtag_init_inner(cmd_ctx
);
1565 int jtag_init(struct command_context
*cmd_ctx
)
1567 int retval
= adapter_init(cmd_ctx
);
1568 if (retval
!= ERROR_OK
)
1571 /* guard against oddball hardware: force resets to be inactive */
1572 jtag_add_reset(0, 0);
1574 /* some targets enable us to connect with srst asserted */
1575 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1576 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1577 jtag_add_reset(0, 1);
1579 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1581 retval
= jtag_execute_queue();
1582 if (retval
!= ERROR_OK
)
1585 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1591 unsigned jtag_get_speed_khz(void)
1596 static int adapter_khz_to_speed(unsigned khz
, int *speed
)
1598 LOG_DEBUG("convert khz to interface specific speed value");
1601 LOG_DEBUG("have interface set up");
1603 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1604 if (ERROR_OK
!= retval
)
1606 *speed
= speed_div1
;
1611 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int *speed
)
1613 int retval
= adapter_khz_to_speed(0, speed
);
1614 if ((ERROR_OK
!= retval
) && fallback_speed_khz
) {
1615 LOG_DEBUG("trying fallback speed...");
1616 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1621 static int jtag_set_speed(int speed
)
1624 /* this command can be called during CONFIG,
1625 * in which case jtag isn't initialized */
1626 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1629 int jtag_config_khz(unsigned khz
)
1631 LOG_DEBUG("handle jtag khz");
1632 clock_mode
= CLOCK_MODE_KHZ
;
1634 int retval
= adapter_khz_to_speed(khz
, &speed
);
1635 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1638 int jtag_config_rclk(unsigned fallback_speed_khz
)
1640 LOG_DEBUG("handle jtag rclk");
1641 clock_mode
= CLOCK_MODE_RCLK
;
1642 rclk_fallback_speed_khz
= fallback_speed_khz
;
1644 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1645 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1648 int jtag_get_speed(int *speed
)
1650 switch (clock_mode
) {
1651 case CLOCK_MODE_KHZ
:
1652 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1654 case CLOCK_MODE_RCLK
:
1655 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1658 LOG_ERROR("BUG: unknown jtag clock mode");
1664 int jtag_get_speed_readable(int *khz
)
1666 int jtag_speed_var
= 0;
1667 int retval
= jtag_get_speed(&jtag_speed_var
);
1668 if (retval
!= ERROR_OK
)
1670 return jtag
? jtag
->speed_div(jtag_speed_var
, khz
) : ERROR_OK
;
1673 void jtag_set_verify(bool enable
)
1675 jtag_verify
= enable
;
1678 bool jtag_will_verify()
1683 void jtag_set_verify_capture_ir(bool enable
)
1685 jtag_verify_capture_ir
= enable
;
1688 bool jtag_will_verify_capture_ir()
1690 return jtag_verify_capture_ir
;
1693 int jtag_power_dropout(int *dropout
)
1696 /* TODO: as the jtag interface is not valid all
1697 * we can do at the moment is exit OpenOCD */
1698 LOG_ERROR("No Valid JTAG Interface Configured.");
1701 return jtag
->power_dropout(dropout
);
1704 int jtag_srst_asserted(int *srst_asserted
)
1706 return jtag
->srst_asserted(srst_asserted
);
1709 enum reset_types
jtag_get_reset_config(void)
1711 return jtag_reset_config
;
1713 void jtag_set_reset_config(enum reset_types type
)
1715 jtag_reset_config
= type
;
1718 int jtag_get_trst(void)
1722 int jtag_get_srst(void)
1727 void jtag_set_nsrst_delay(unsigned delay
)
1729 adapter_nsrst_delay
= delay
;
1731 unsigned jtag_get_nsrst_delay(void)
1733 return adapter_nsrst_delay
;
1735 void jtag_set_ntrst_delay(unsigned delay
)
1737 jtag_ntrst_delay
= delay
;
1739 unsigned jtag_get_ntrst_delay(void)
1741 return jtag_ntrst_delay
;
1745 void jtag_set_nsrst_assert_width(unsigned delay
)
1747 adapter_nsrst_assert_width
= delay
;
1749 unsigned jtag_get_nsrst_assert_width(void)
1751 return adapter_nsrst_assert_width
;
1753 void jtag_set_ntrst_assert_width(unsigned delay
)
1755 jtag_ntrst_assert_width
= delay
;
1757 unsigned jtag_get_ntrst_assert_width(void)
1759 return jtag_ntrst_assert_width
;
1762 static int jtag_select(struct command_context
*ctx
)
1766 /* NOTE: interface init must already have been done.
1767 * That works with only C code ... no Tcl glue required.
1770 retval
= jtag_register_commands(ctx
);
1772 if (retval
!= ERROR_OK
)
1775 retval
= svf_register_commands(ctx
);
1777 if (retval
!= ERROR_OK
)
1780 return xsvf_register_commands(ctx
);
1783 static struct transport jtag_transport
= {
1785 .select
= jtag_select
,
1789 static void jtag_constructor(void) __attribute__((constructor
));
1790 static void jtag_constructor(void)
1792 transport_register(&jtag_transport
);
1795 /** Returns true if the current debug session
1796 * is using JTAG as its transport.
1798 bool transport_is_jtag(void)
1800 return get_current_transport() == &jtag_transport
;
1803 void adapter_assert_reset(void)
1805 if (transport_is_jtag()) {
1806 if (jtag_reset_config
& RESET_SRST_PULLS_TRST
)
1807 jtag_add_reset(1, 1);
1809 jtag_add_reset(0, 1);
1810 } else if (transport_is_swd())
1812 else if (get_current_transport() != NULL
)
1813 LOG_ERROR("reset is not supported on %s",
1814 get_current_transport()->name
);
1816 LOG_ERROR("transport is not selected");
1819 void adapter_deassert_reset(void)
1821 if (transport_is_jtag())
1822 jtag_add_reset(0, 0);
1823 else if (transport_is_swd())
1825 else if (get_current_transport() != NULL
)
1826 LOG_ERROR("reset is not supported on %s",
1827 get_current_transport()->name
);
1829 LOG_ERROR("transport is not selected");
1832 int adapter_config_trace(bool enabled
, enum tpio_pin_protocol pin_protocol
,
1833 uint32_t port_size
, unsigned int *trace_freq
)
1835 if (jtag
->config_trace
)
1836 return jtag
->config_trace(enabled
, pin_protocol
, port_size
,
1839 LOG_ERROR("The selected interface does not support tracing");
1846 int adapter_poll_trace(uint8_t *buf
, size_t *size
)
1848 if (jtag
->poll_trace
)
1849 return jtag
->poll_trace(buf
, size
);