1 /***************************************************************************
2 * Copyright (C) 2009 Zachary T Welch *
3 * zw@superlucidity.net *
5 * Copyright (C) 2007,2008,2009 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2005 by Dominic Rath *
13 * Dominic.Rath@gmx.de *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
29 ***************************************************************************/
37 #include "interface.h"
38 #include <transport/transport.h>
44 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
46 #include "xsvf/xsvf.h"
48 /** The number of JTAG queue flushes (for profiling and debugging purposes). */
49 static int jtag_flush_queue_count
;
51 /* Sleep this # of ms after flushing the queue */
52 static int jtag_flush_queue_sleep
;
54 static void jtag_add_scan_check(struct jtag_tap
*active
,
55 void (*jtag_add_scan
)(struct jtag_tap
*active
,
57 const struct scan_field
*in_fields
,
59 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
);
62 * The jtag_error variable is set when an error occurs while executing
63 * the queue. Application code may set this using jtag_set_error(),
64 * when an error occurs during processing that should be reported during
65 * jtag_execute_queue().
67 * The value is set and cleared, but never read by normal application code.
69 * This value is returned (and cleared) by jtag_execute_queue().
71 static int jtag_error
= ERROR_OK
;
73 static const char *jtag_event_strings
[] = {
74 [JTAG_TRST_ASSERTED
] = "TAP reset",
75 [JTAG_TAP_EVENT_SETUP
] = "TAP setup",
76 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
77 [JTAG_TAP_EVENT_DISABLE
] = "TAP disabled",
81 * JTAG adapters must initialize with TRST and SRST de-asserted
82 * (they're negative logic, so that means *high*). But some
83 * hardware doesn't necessarily work that way ... so set things
84 * up so that jtag_init() always forces that state.
86 static int jtag_trst
= -1;
87 static int jtag_srst
= -1;
90 * List all TAPs that have been created.
92 static struct jtag_tap
*__jtag_all_taps
;
94 * The number of TAPs in the __jtag_all_taps list, used to track the
95 * assigned chain position to new TAPs
97 static unsigned jtag_num_taps
;
99 static enum reset_types jtag_reset_config
= RESET_NONE
;
100 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
102 static bool jtag_verify_capture_ir
= true;
103 static int jtag_verify
= 1;
105 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines
106 *deasserted (in ms) */
107 static int adapter_nsrst_delay
; /* default to no nSRST delay */
108 static int jtag_ntrst_delay
;/* default to no nTRST delay */
109 static int adapter_nsrst_assert_width
; /* width of assertion */
110 static int jtag_ntrst_assert_width
; /* width of assertion */
113 * Contains a single callback along with a pointer that will be passed
114 * when an event occurs.
116 struct jtag_event_callback
{
117 /** a event callback */
118 jtag_event_handler_t callback
;
119 /** the private data to pass to the callback */
121 /** the next callback */
122 struct jtag_event_callback
*next
;
125 /* callbacks to inform high-level handlers about JTAG state changes */
126 static struct jtag_event_callback
*jtag_event_callbacks
;
129 static int speed_khz
;
130 /* speed to fallback to when RCLK is requested but not supported */
131 static int rclk_fallback_speed_khz
;
132 static enum {CLOCK_MODE_UNSELECTED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
133 static int jtag_speed
;
135 static struct jtag_interface
*jtag
;
137 const struct swd_driver
*swd
;
140 struct jtag_interface
*jtag_interface
;
142 void jtag_set_flush_queue_sleep(int ms
)
144 jtag_flush_queue_sleep
= ms
;
147 void jtag_set_error(int error
)
149 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
154 int jtag_error_clear(void)
156 int temp
= jtag_error
;
157 jtag_error
= ERROR_OK
;
163 static bool jtag_poll
= 1;
165 bool is_jtag_poll_safe(void)
167 /* Polling can be disabled explicitly with set_enabled(false).
168 * It is also implicitly disabled while TRST is active and
169 * while SRST is gating the JTAG clock.
171 if (!jtag_poll
|| jtag_trst
!= 0)
173 return jtag_srst
== 0 || (jtag_reset_config
& RESET_SRST_NO_GATING
);
176 bool jtag_poll_get_enabled(void)
181 void jtag_poll_set_enabled(bool value
)
188 struct jtag_tap
*jtag_all_taps(void)
190 return __jtag_all_taps
;
193 unsigned jtag_tap_count(void)
195 return jtag_num_taps
;
198 unsigned jtag_tap_count_enabled(void)
200 struct jtag_tap
*t
= jtag_all_taps();
210 /** Append a new TAP to the chain of all taps. */
211 void jtag_tap_add(struct jtag_tap
*t
)
213 t
->abs_chain_position
= jtag_num_taps
++;
215 struct jtag_tap
**tap
= &__jtag_all_taps
;
217 tap
= &(*tap
)->next_tap
;
221 /* returns a pointer to the n-th device in the scan chain */
222 struct jtag_tap
*jtag_tap_by_position(unsigned n
)
224 struct jtag_tap
*t
= jtag_all_taps();
232 struct jtag_tap
*jtag_tap_by_string(const char *s
)
234 /* try by name first */
235 struct jtag_tap
*t
= jtag_all_taps();
238 if (0 == strcmp(t
->dotted_name
, s
))
243 /* no tap found by name, so try to parse the name as a number */
245 if (parse_uint(s
, &n
) != ERROR_OK
)
248 /* FIXME remove this numeric fallback code late June 2010, along
249 * with all info in the User's Guide that TAPs have numeric IDs.
250 * Also update "scan_chain" output to not display the numbers.
252 t
= jtag_tap_by_position(n
);
254 LOG_WARNING("Specify TAP '%s' by name, not number %u",
260 struct jtag_tap
*jtag_tap_next_enabled(struct jtag_tap
*p
)
262 p
= p
? p
->next_tap
: jtag_all_taps();
271 const char *jtag_tap_name(const struct jtag_tap
*tap
)
273 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
277 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
279 struct jtag_event_callback
**callbacks_p
= &jtag_event_callbacks
;
281 if (callback
== NULL
)
282 return ERROR_COMMAND_SYNTAX_ERROR
;
285 while ((*callbacks_p
)->next
)
286 callbacks_p
= &((*callbacks_p
)->next
);
287 callbacks_p
= &((*callbacks_p
)->next
);
290 (*callbacks_p
) = malloc(sizeof(struct jtag_event_callback
));
291 (*callbacks_p
)->callback
= callback
;
292 (*callbacks_p
)->priv
= priv
;
293 (*callbacks_p
)->next
= NULL
;
298 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
300 struct jtag_event_callback
**p
= &jtag_event_callbacks
, *temp
;
302 if (callback
== NULL
)
303 return ERROR_COMMAND_SYNTAX_ERROR
;
306 if (((*p
)->priv
!= priv
) || ((*p
)->callback
!= callback
)) {
319 int jtag_call_event_callbacks(enum jtag_event event
)
321 struct jtag_event_callback
*callback
= jtag_event_callbacks
;
323 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
326 struct jtag_event_callback
*next
;
328 /* callback may remove itself */
329 next
= callback
->next
;
330 callback
->callback(event
, callback
->priv
);
337 static void jtag_checks(void)
339 assert(jtag_trst
== 0);
342 static void jtag_prelude(tap_state_t state
)
346 assert(state
!= TAP_INVALID
);
348 cmd_queue_cur_state
= state
;
351 void jtag_add_ir_scan_noverify(struct jtag_tap
*active
, const struct scan_field
*in_fields
,
356 int retval
= interface_jtag_add_ir_scan(active
, in_fields
, state
);
357 jtag_set_error(retval
);
360 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap
*active
,
362 const struct scan_field
*in_fields
,
365 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
368 /* If fields->in_value is filled out, then the captured IR value will be checked */
369 void jtag_add_ir_scan(struct jtag_tap
*active
, struct scan_field
*in_fields
, tap_state_t state
)
371 assert(state
!= TAP_RESET
);
373 if (jtag_verify
&& jtag_verify_capture_ir
) {
374 /* 8 x 32 bit id's is enough for all invocations */
376 /* if we are to run a verification of the ir scan, we need to get the input back.
377 * We may have to allocate space if the caller didn't ask for the input back.
379 in_fields
->check_value
= active
->expected
;
380 in_fields
->check_mask
= active
->expected_mask
;
381 jtag_add_scan_check(active
, jtag_add_ir_scan_noverify_callback
, 1, in_fields
,
384 jtag_add_ir_scan_noverify(active
, in_fields
, state
);
387 void jtag_add_plain_ir_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
390 assert(out_bits
!= NULL
);
391 assert(state
!= TAP_RESET
);
395 int retval
= interface_jtag_add_plain_ir_scan(
396 num_bits
, out_bits
, in_bits
, state
);
397 jtag_set_error(retval
);
400 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
401 uint8_t *in_check_mask
, int num_bits
);
403 static int jtag_check_value_mask_callback(jtag_callback_data_t data0
,
404 jtag_callback_data_t data1
,
405 jtag_callback_data_t data2
,
406 jtag_callback_data_t data3
)
408 return jtag_check_value_inner((uint8_t *)data0
,
414 static void jtag_add_scan_check(struct jtag_tap
*active
, void (*jtag_add_scan
)(
415 struct jtag_tap
*active
,
417 const struct scan_field
*in_fields
,
419 int in_num_fields
, struct scan_field
*in_fields
, tap_state_t state
)
421 jtag_add_scan(active
, in_num_fields
, in_fields
, state
);
423 for (int i
= 0; i
< in_num_fields
; i
++) {
424 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
)) {
425 /* this is synchronous for a minidriver */
426 jtag_add_callback4(jtag_check_value_mask_callback
,
427 (jtag_callback_data_t
)in_fields
[i
].in_value
,
428 (jtag_callback_data_t
)in_fields
[i
].check_value
,
429 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
430 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
435 void jtag_add_dr_scan_check(struct jtag_tap
*active
,
437 struct scan_field
*in_fields
,
441 jtag_add_scan_check(active
, jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
443 jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
447 void jtag_add_dr_scan(struct jtag_tap
*active
,
449 const struct scan_field
*in_fields
,
452 assert(state
!= TAP_RESET
);
457 retval
= interface_jtag_add_dr_scan(active
, in_num_fields
, in_fields
, state
);
458 jtag_set_error(retval
);
461 void jtag_add_plain_dr_scan(int num_bits
, const uint8_t *out_bits
, uint8_t *in_bits
,
464 assert(out_bits
!= NULL
);
465 assert(state
!= TAP_RESET
);
470 retval
= interface_jtag_add_plain_dr_scan(num_bits
, out_bits
, in_bits
, state
);
471 jtag_set_error(retval
);
474 void jtag_add_tlr(void)
476 jtag_prelude(TAP_RESET
);
477 jtag_set_error(interface_jtag_add_tlr());
479 /* NOTE: order here matches TRST path in jtag_add_reset() */
480 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
481 jtag_notify_event(JTAG_TRST_ASSERTED
);
485 * If supported by the underlying adapter, this clocks a raw bit sequence
486 * onto TMS for switching betwen JTAG and SWD modes.
488 * DO NOT use this to bypass the integrity checks and logging provided
489 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
491 * @param nbits How many bits to clock out.
492 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
493 * @param state The JTAG tap state to record on completion. Use
494 * TAP_INVALID to represent being in in SWD mode.
496 * @todo Update naming conventions to stop assuming everything is JTAG.
498 int jtag_add_tms_seq(unsigned nbits
, const uint8_t *seq
, enum tap_state state
)
502 if (!(jtag
->supported
& DEBUG_CAP_TMS_SEQ
))
503 return ERROR_JTAG_NOT_IMPLEMENTED
;
506 cmd_queue_cur_state
= state
;
508 retval
= interface_add_tms_seq(nbits
, seq
, state
);
509 jtag_set_error(retval
);
513 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
515 tap_state_t cur_state
= cmd_queue_cur_state
;
517 /* the last state has to be a stable state */
518 if (!tap_is_state_stable(path
[num_states
- 1])) {
519 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
520 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
524 for (int i
= 0; i
< num_states
; i
++) {
525 if (path
[i
] == TAP_RESET
) {
526 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
527 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
531 if (tap_state_transition(cur_state
, true) != path
[i
] &&
532 tap_state_transition(cur_state
, false) != path
[i
]) {
533 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
534 tap_state_name(cur_state
), tap_state_name(path
[i
]));
535 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
543 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
544 cmd_queue_cur_state
= path
[num_states
- 1];
547 int jtag_add_statemove(tap_state_t goal_state
)
549 tap_state_t cur_state
= cmd_queue_cur_state
;
551 if (goal_state
!= cur_state
) {
552 LOG_DEBUG("cur_state=%s goal_state=%s",
553 tap_state_name(cur_state
),
554 tap_state_name(goal_state
));
557 /* If goal is RESET, be paranoid and force that that transition
558 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
560 if (goal_state
== TAP_RESET
)
562 else if (goal_state
== cur_state
)
565 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
)) {
566 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
567 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
568 tap_state_t moves
[8];
569 assert(tms_count
< ARRAY_SIZE(moves
));
571 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1) {
572 bool bit
= tms_bits
& 1;
574 cur_state
= tap_state_transition(cur_state
, bit
);
575 moves
[i
] = cur_state
;
578 jtag_add_pathmove(tms_count
, moves
);
579 } else if (tap_state_transition(cur_state
, true) == goal_state
580 || tap_state_transition(cur_state
, false) == goal_state
)
581 jtag_add_pathmove(1, &goal_state
);
588 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
591 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
595 void jtag_add_clocks(int num_cycles
)
597 if (!tap_is_state_stable(cmd_queue_cur_state
)) {
598 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
599 tap_state_name(cmd_queue_cur_state
));
600 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
604 if (num_cycles
> 0) {
606 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
610 void swd_add_reset(int req_srst
)
613 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
614 LOG_ERROR("BUG: can't assert SRST");
615 jtag_set_error(ERROR_FAIL
);
621 /* Maybe change SRST signal state */
622 if (jtag_srst
!= req_srst
) {
625 retval
= interface_jtag_add_reset(0, req_srst
);
626 if (retval
!= ERROR_OK
)
627 jtag_set_error(retval
);
629 retval
= jtag_execute_queue();
631 if (retval
!= ERROR_OK
) {
632 LOG_ERROR("TRST/SRST error");
636 /* SRST resets everything hooked up to that signal */
637 jtag_srst
= req_srst
;
639 LOG_DEBUG("SRST line asserted");
640 if (adapter_nsrst_assert_width
)
641 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
643 LOG_DEBUG("SRST line released");
644 if (adapter_nsrst_delay
)
645 jtag_add_sleep(adapter_nsrst_delay
* 1000);
650 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
652 int trst_with_tlr
= 0;
656 /* Without SRST, we must use target-specific JTAG operations
657 * on each target; callers should not be requesting SRST when
658 * that signal doesn't exist.
660 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
661 * can kick in even if the JTAG adapter can't drive TRST.
664 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
665 LOG_ERROR("BUG: can't assert SRST");
666 jtag_set_error(ERROR_FAIL
);
669 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
670 && !req_tlr_or_trst
) {
671 LOG_ERROR("BUG: can't assert only SRST");
672 jtag_set_error(ERROR_FAIL
);
678 /* JTAG reset (entry to TAP_RESET state) can always be achieved
679 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
680 * state first. TRST accelerates it, and bypasses those states.
682 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
683 * can kick in even if the JTAG adapter can't drive SRST.
685 if (req_tlr_or_trst
) {
686 if (!(jtag_reset_config
& RESET_HAS_TRST
))
688 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
695 /* Maybe change TRST and/or SRST signal state */
696 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
699 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
700 if (retval
!= ERROR_OK
)
701 jtag_set_error(retval
);
703 retval
= jtag_execute_queue();
705 if (retval
!= ERROR_OK
) {
706 LOG_ERROR("TRST/SRST error");
711 /* SRST resets everything hooked up to that signal */
712 if (jtag_srst
!= new_srst
) {
713 jtag_srst
= new_srst
;
715 LOG_DEBUG("SRST line asserted");
716 if (adapter_nsrst_assert_width
)
717 jtag_add_sleep(adapter_nsrst_assert_width
* 1000);
719 LOG_DEBUG("SRST line released");
720 if (adapter_nsrst_delay
)
721 jtag_add_sleep(adapter_nsrst_delay
* 1000);
725 /* Maybe enter the JTAG TAP_RESET state ...
726 * - using only TMS, TCK, and the JTAG state machine
727 * - or else more directly, using TRST
729 * TAP_RESET should be invisible to non-debug parts of the system.
732 LOG_DEBUG("JTAG reset with TLR instead of TRST");
735 } else if (jtag_trst
!= new_trst
) {
736 jtag_trst
= new_trst
;
738 LOG_DEBUG("TRST line asserted");
739 tap_set_state(TAP_RESET
);
740 if (jtag_ntrst_assert_width
)
741 jtag_add_sleep(jtag_ntrst_assert_width
* 1000);
743 LOG_DEBUG("TRST line released");
744 if (jtag_ntrst_delay
)
745 jtag_add_sleep(jtag_ntrst_delay
* 1000);
747 /* We just asserted nTRST, so we're now in TAP_RESET.
748 * Inform possible listeners about this, now that
749 * JTAG instructions and data can be shifted. This
750 * sequence must match jtag_add_tlr().
752 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
753 jtag_notify_event(JTAG_TRST_ASSERTED
);
758 void jtag_add_sleep(uint32_t us
)
760 /** @todo Here, keep_alive() appears to be a layering violation!!! */
762 jtag_set_error(interface_jtag_add_sleep(us
));
765 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
766 uint8_t *in_check_mask
, int num_bits
)
768 int retval
= ERROR_OK
;
772 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
774 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
776 if (compare_failed
) {
777 char *captured_str
, *in_check_value_str
;
778 int bits
= (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
;
780 /* NOTE: we've lost diagnostic context here -- 'which tap' */
782 captured_str
= buf_to_str(captured
, bits
, 16);
783 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
785 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
787 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
790 free(in_check_value_str
);
793 char *in_check_mask_str
;
795 in_check_mask_str
= buf_to_str(in_check_mask
, bits
, 16);
796 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
797 free(in_check_mask_str
);
800 retval
= ERROR_JTAG_QUEUE_FAILED
;
805 void jtag_check_value_mask(struct scan_field
*field
, uint8_t *value
, uint8_t *mask
)
807 assert(field
->in_value
!= NULL
);
810 /* no checking to do */
814 jtag_execute_queue_noclear();
816 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
817 jtag_set_error(retval
);
820 int default_interface_jtag_execute_queue(void)
823 LOG_ERROR("No JTAG interface configured yet. "
824 "Issue 'init' command in startup scripts "
825 "before communicating with targets.");
829 return jtag
->execute_queue();
832 void jtag_execute_queue_noclear(void)
834 jtag_flush_queue_count
++;
835 jtag_set_error(interface_jtag_execute_queue());
837 if (jtag_flush_queue_sleep
> 0) {
838 /* For debug purposes it can be useful to test performance
839 * or behavior when delaying after flushing the queue,
840 * e.g. to simulate long roundtrip times.
842 usleep(jtag_flush_queue_sleep
* 1000);
846 int jtag_get_flush_queue_count(void)
848 return jtag_flush_queue_count
;
851 int jtag_execute_queue(void)
853 jtag_execute_queue_noclear();
854 return jtag_error_clear();
857 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
859 struct jtag_tap
*tap
= priv
;
861 if (event
== JTAG_TRST_ASSERTED
) {
862 tap
->enabled
= !tap
->disabled_after_reset
;
864 /* current instruction is either BYPASS or IDCODE */
865 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
872 /* sleep at least us microseconds. When we sleep more than 1000ms we
873 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
874 * GDB if we slept for <1000ms many times.
876 void jtag_sleep(uint32_t us
)
881 alive_sleep((us
+999)/1000);
884 /* Maximum number of enabled JTAG devices we expect in the scan chain,
885 * plus one (to detect garbage at the end). Devices that don't support
886 * IDCODE take up fewer bits, possibly allowing a few more devices.
888 #define JTAG_MAX_CHAIN_SIZE 20
890 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
891 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
892 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
894 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
895 * know that no valid TAP will have it as an IDCODE value.
897 #define END_OF_CHAIN_FLAG 0xffffffff
899 /* a larger IR length than we ever expect to autoprobe */
900 #define JTAG_IRLEN_MAX 60
902 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
904 struct scan_field field
= {
905 .num_bits
= num_idcode
* 32,
906 .out_value
= idcode_buffer
,
907 .in_value
= idcode_buffer
,
910 /* initialize to the end of chain ID value */
911 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
912 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
914 jtag_add_plain_dr_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_DRPAUSE
);
916 return jtag_execute_queue();
919 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
921 uint8_t zero_check
= 0x0;
922 uint8_t one_check
= 0xff;
924 for (unsigned i
= 0; i
< count
* 4; i
++) {
925 zero_check
|= idcodes
[i
];
926 one_check
&= idcodes
[i
];
929 /* if there wasn't a single non-zero bit or if all bits were one,
930 * the scan is not valid. We wrote a mix of both values; either
932 * - There's a hardware issue (almost certainly):
933 * + all-zeroes can mean a target stuck in JTAG reset
934 * + all-ones tends to mean no target
935 * - The scan chain is WAY longer than we can handle, *AND* either
936 * + there are several hundreds of TAPs in bypass, or
937 * + at least a few dozen TAPs all have an all-ones IDCODE
939 if (zero_check
== 0x00 || one_check
== 0xff) {
940 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
941 (zero_check
== 0x00) ? "zeroes" : "ones");
942 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
948 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
949 const char *name
, uint32_t idcode
)
951 log_printf_lf(level
, __FILE__
, __LINE__
, __func__
,
952 "JTAG tap: %s %16.16s: 0x%08x "
953 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
955 (unsigned int)idcode
,
956 (unsigned int)EXTRACT_MFG(idcode
),
957 (unsigned int)EXTRACT_PART(idcode
),
958 (unsigned int)EXTRACT_VER(idcode
));
961 static bool jtag_idcode_is_final(uint32_t idcode
)
964 * Some devices, such as AVR8, will output all 1's instead
965 * of TDI input value at end of chain. Allow those values
966 * instead of failing.
968 return idcode
== END_OF_CHAIN_FLAG
;
972 * This helper checks that remaining bits in the examined chain data are
973 * all as expected, but a single JTAG device requires only 64 bits to be
974 * read back correctly. This can help identify and diagnose problems
975 * with the JTAG chain earlier, gives more helpful/explicit error messages.
976 * Returns TRUE iff garbage was found.
978 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
980 bool triggered
= false;
981 for (; count
< max
- 31; count
+= 32) {
982 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
984 /* do not trigger the warning if the data looks good */
985 if (jtag_idcode_is_final(idcode
))
987 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
988 count
, (unsigned int)idcode
);
994 static bool jtag_examine_chain_match_tap(const struct jtag_tap
*tap
)
996 uint32_t idcode
= tap
->idcode
;
998 /* ignore expected BYPASS codes; warn otherwise */
999 if (0 == tap
->expected_ids_cnt
&& !idcode
)
1002 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1003 uint32_t mask
= tap
->ignore_version
? ~(0xf << 28) : ~0;
1007 /* Loop over the expected identification codes and test for a match */
1008 unsigned ii
, limit
= tap
->expected_ids_cnt
;
1010 for (ii
= 0; ii
< limit
; ii
++) {
1011 uint32_t expected
= tap
->expected_ids
[ii
] & mask
;
1013 if (idcode
== expected
)
1016 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1017 if (0 == tap
->expected_ids
[ii
])
1021 /* If none of the expected ids matched, warn */
1022 jtag_examine_chain_display(LOG_LVL_WARNING
, "UNEXPECTED",
1023 tap
->dotted_name
, tap
->idcode
);
1024 for (ii
= 0; ii
< limit
; ii
++) {
1027 snprintf(msg
, sizeof(msg
), "expected %u of %u", ii
+ 1, limit
);
1028 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1029 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1034 /* Try to examine chain layout according to IEEE 1149.1 §12
1035 * This is called a "blind interrogation" of the scan chain.
1037 static int jtag_examine_chain(void)
1039 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1043 bool autoprobe
= false;
1045 /* DR scan to collect BYPASS or IDCODE register contents.
1046 * Then make sure the scan data has both ones and zeroes.
1048 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1049 retval
= jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1050 if (retval
!= ERROR_OK
)
1052 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1053 return ERROR_JTAG_INIT_FAILED
;
1055 /* point at the 1st tap */
1056 struct jtag_tap
*tap
= jtag_tap_next_enabled(NULL
);
1062 tap
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;
1063 tap
= jtag_tap_next_enabled(tap
)) {
1064 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1066 if ((idcode
& 1) == 0) {
1067 /* Zero for LSB indicates a device in bypass */
1068 LOG_INFO("TAP %s does not have IDCODE",
1071 tap
->hasidcode
= false;
1075 /* Friendly devices support IDCODE */
1076 tap
->hasidcode
= true;
1077 jtag_examine_chain_display(LOG_LVL_INFO
,
1079 tap
->dotted_name
, idcode
);
1083 tap
->idcode
= idcode
;
1085 /* ensure the TAP ID matches what was expected */
1086 if (!jtag_examine_chain_match_tap(tap
))
1087 retval
= ERROR_JTAG_INIT_SOFT_FAIL
;
1090 /* Fail if too many TAPs were enabled for us to verify them all. */
1092 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1094 return ERROR_JTAG_INIT_FAILED
;
1097 /* if autoprobing, the tap list is still empty ... populate it! */
1098 while (autoprobe
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31) {
1102 /* Is there another TAP? */
1103 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1104 if (jtag_idcode_is_final(idcode
))
1107 /* Default everything in this TAP except IR length.
1109 * REVISIT create a jtag_alloc(chip, tap) routine, and
1110 * share it with jim_newtap_cmd().
1112 tap
= calloc(1, sizeof *tap
);
1116 sprintf(buf
, "auto%d", tapcount
++);
1117 tap
->chip
= strdup(buf
);
1118 tap
->tapname
= strdup("tap");
1120 sprintf(buf
, "%s.%s", tap
->chip
, tap
->tapname
);
1121 tap
->dotted_name
= strdup(buf
);
1123 /* tap->ir_length == 0 ... signifying irlen autoprobe */
1124 tap
->ir_capture_mask
= 0x03;
1125 tap
->ir_capture_value
= 0x01;
1127 tap
->enabled
= true;
1129 if ((idcode
& 1) == 0) {
1131 tap
->hasidcode
= false;
1134 tap
->hasidcode
= true;
1135 tap
->idcode
= idcode
;
1137 tap
->expected_ids_cnt
= 1;
1138 tap
->expected_ids
= malloc(sizeof(uint32_t));
1139 tap
->expected_ids
[0] = idcode
;
1142 LOG_WARNING("AUTO %s - use \"jtag newtap "
1143 "%s %s -expected-id 0x%8.8" PRIx32
" ...\"",
1144 tap
->dotted_name
, tap
->chip
, tap
->tapname
,
1150 /* After those IDCODE or BYPASS register values should be
1151 * only the data we fed into the scan chain.
1153 if (jtag_examine_chain_end(idcode_buffer
, bit_count
,
1154 8 * sizeof(idcode_buffer
))) {
1155 LOG_ERROR("double-check your JTAG setup (interface, "
1156 "speed, missing TAPs, ...)");
1157 return ERROR_JTAG_INIT_FAILED
;
1160 /* Return success or, for backwards compatibility if only
1161 * some IDCODE values mismatched, a soft/continuable fault.
1167 * Validate the date loaded by entry to the Capture-IR state, to help
1168 * find errors related to scan chain configuration (wrong IR lengths)
1171 * Entry state can be anything. On non-error exit, all TAPs are in
1172 * bypass mode. On error exits, the scan chain is reset.
1174 static int jtag_validate_ircapture(void)
1176 struct jtag_tap
*tap
;
1177 int total_ir_length
= 0;
1178 uint8_t *ir_test
= NULL
;
1179 struct scan_field field
;
1184 /* when autoprobing, accomodate huge IR lengths */
1185 for (tap
= NULL
, total_ir_length
= 0;
1186 (tap
= jtag_tap_next_enabled(tap
)) != NULL
;
1187 total_ir_length
+= tap
->ir_length
) {
1188 if (tap
->ir_length
== 0)
1189 total_ir_length
+= JTAG_IRLEN_MAX
;
1192 /* increase length to add 2 bit sentinel after scan */
1193 total_ir_length
+= 2;
1195 ir_test
= malloc(DIV_ROUND_UP(total_ir_length
, 8));
1196 if (ir_test
== NULL
)
1199 /* after this scan, all TAPs will capture BYPASS instructions */
1200 buf_set_ones(ir_test
, total_ir_length
);
1202 field
.num_bits
= total_ir_length
;
1203 field
.out_value
= ir_test
;
1204 field
.in_value
= ir_test
;
1206 jtag_add_plain_ir_scan(field
.num_bits
, field
.out_value
, field
.in_value
, TAP_IDLE
);
1208 LOG_DEBUG("IR capture validation scan");
1209 retval
= jtag_execute_queue();
1210 if (retval
!= ERROR_OK
)
1217 tap
= jtag_tap_next_enabled(tap
);
1221 /* If we're autoprobing, guess IR lengths. They must be at
1222 * least two bits. Guessing will fail if (a) any TAP does
1223 * not conform to the JTAG spec; or (b) when the upper bits
1224 * captured from some conforming TAP are nonzero. Or if
1225 * (c) an IR length is longer than 32 bits -- which is only
1226 * an implementation limit, which could someday be raised.
1228 * REVISIT optimization: if there's a *single* TAP we can
1229 * lift restrictions (a) and (b) by scanning a recognizable
1230 * pattern before the all-ones BYPASS. Check for where the
1231 * pattern starts in the result, instead of an 0...01 value.
1233 * REVISIT alternative approach: escape to some tcl code
1234 * which could provide more knowledge, based on IDCODE; and
1235 * only guess when that has no success.
1237 if (tap
->ir_length
== 0) {
1239 while ((val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
+ 1)) == 1
1240 && tap
->ir_length
<= 64) {
1243 LOG_WARNING("AUTO %s - use \"... -irlen %d\"",
1244 jtag_tap_name(tap
), tap
->ir_length
);
1247 /* Validate the two LSBs, which must be 01 per JTAG spec.
1249 * Or ... more bits could be provided by TAP declaration.
1250 * Plus, some taps (notably in i.MX series chips) violate
1251 * this part of the JTAG spec, so their capture mask/value
1252 * attributes might disable this test.
1254 val
= buf_get_u64(ir_test
, chain_pos
, tap
->ir_length
);
1255 if ((val
& tap
->ir_capture_mask
) != tap
->ir_capture_value
) {
1256 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64
" not 0x%0*" PRIx32
,
1258 (tap
->ir_length
+ 7) / tap
->ir_length
, val
,
1259 (tap
->ir_length
+ 7) / tap
->ir_length
, tap
->ir_capture_value
);
1261 retval
= ERROR_JTAG_INIT_FAILED
;
1264 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64
, jtag_tap_name(tap
),
1265 (tap
->ir_length
+ 7) / tap
->ir_length
, val
);
1266 chain_pos
+= tap
->ir_length
;
1269 /* verify the '11' sentinel we wrote is returned at the end */
1270 val
= buf_get_u64(ir_test
, chain_pos
, 2);
1272 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1274 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1277 retval
= ERROR_JTAG_INIT_FAILED
;
1282 if (retval
!= ERROR_OK
) {
1284 jtag_execute_queue();
1289 void jtag_tap_init(struct jtag_tap
*tap
)
1291 unsigned ir_len_bits
;
1292 unsigned ir_len_bytes
;
1294 /* if we're autoprobing, cope with potentially huge ir_length */
1295 ir_len_bits
= tap
->ir_length
? : JTAG_IRLEN_MAX
;
1296 ir_len_bytes
= DIV_ROUND_UP(ir_len_bits
, 8);
1298 tap
->expected
= calloc(1, ir_len_bytes
);
1299 tap
->expected_mask
= calloc(1, ir_len_bytes
);
1300 tap
->cur_instr
= malloc(ir_len_bytes
);
1302 /** @todo cope better with ir_length bigger than 32 bits */
1303 if (ir_len_bits
> 32)
1306 buf_set_u32(tap
->expected
, 0, ir_len_bits
, tap
->ir_capture_value
);
1307 buf_set_u32(tap
->expected_mask
, 0, ir_len_bits
, tap
->ir_capture_mask
);
1309 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1311 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1313 /* register the reset callback for the TAP */
1314 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1317 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1318 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1319 tap
->abs_chain_position
, tap
->ir_length
,
1320 (unsigned) tap
->ir_capture_value
,
1321 (unsigned) tap
->ir_capture_mask
);
1324 void jtag_tap_free(struct jtag_tap
*tap
)
1326 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1328 /** @todo is anything missing? no memory leaks please */
1329 free((void *)tap
->expected
);
1330 free((void *)tap
->expected_ids
);
1331 free((void *)tap
->chip
);
1332 free((void *)tap
->tapname
);
1333 free((void *)tap
->dotted_name
);
1338 * Do low-level setup like initializing registers, output signals,
1341 int adapter_init(struct command_context
*cmd_ctx
)
1346 if (!jtag_interface
) {
1347 /* nothing was previously specified by "interface" command */
1348 LOG_ERROR("Debug Adapter has to be specified, "
1349 "see \"interface\" command");
1350 return ERROR_JTAG_INVALID_INTERFACE
;
1354 retval
= jtag_interface
->init();
1355 if (retval
!= ERROR_OK
)
1357 jtag
= jtag_interface
;
1359 /* LEGACY SUPPORT ... adapter drivers must declare what
1360 * transports they allow. Until they all do so, assume
1361 * the legacy drivers are JTAG-only
1363 if (!transports_are_declared()) {
1364 LOG_ERROR("Adapter driver '%s' did not declare "
1365 "which transports it allows; assuming "
1366 "JTAG-only", jtag
->name
);
1367 retval
= allow_transports(cmd_ctx
, jtag_only
);
1368 if (retval
!= ERROR_OK
)
1372 if (jtag
->speed
== NULL
) {
1373 LOG_INFO("This adapter doesn't support configurable speed");
1377 if (CLOCK_MODE_UNSELECTED
== clock_mode
) {
1378 LOG_ERROR("An adapter speed is not selected in the init script."
1379 " Insert a call to adapter_khz or jtag_rclk to proceed.");
1380 return ERROR_JTAG_INIT_FAILED
;
1383 int requested_khz
= jtag_get_speed_khz();
1384 int actual_khz
= requested_khz
;
1385 int jtag_speed_var
= 0;
1386 retval
= jtag_get_speed(&jtag_speed_var
);
1387 if (retval
!= ERROR_OK
)
1389 retval
= jtag
->speed(jtag_speed_var
);
1390 if (retval
!= ERROR_OK
)
1392 retval
= jtag_get_speed_readable(&actual_khz
);
1393 if (ERROR_OK
!= retval
)
1394 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var
);
1395 else if (actual_khz
) {
1396 /* Adaptive clocking -- JTAG-specific */
1397 if ((CLOCK_MODE_RCLK
== clock_mode
)
1398 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
)) {
1399 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1402 LOG_INFO("clock speed %d kHz", actual_khz
);
1404 LOG_INFO("RCLK (adaptive clock speed)");
1409 int jtag_init_inner(struct command_context
*cmd_ctx
)
1411 struct jtag_tap
*tap
;
1413 bool issue_setup
= true;
1415 LOG_DEBUG("Init JTAG chain");
1417 tap
= jtag_tap_next_enabled(NULL
);
1419 /* Once JTAG itself is properly set up, and the scan chain
1420 * isn't absurdly large, IDCODE autoprobe should work fine.
1422 * But ... IRLEN autoprobe can fail even on systems which
1423 * are fully conformant to JTAG. Also, JTAG setup can be
1424 * quite finicky on some systems.
1426 * REVISIT: if TAP autoprobe works OK, then in many cases
1427 * we could escape to tcl code and set up targets based on
1428 * the TAP's IDCODE values.
1430 LOG_WARNING("There are no enabled taps. "
1431 "AUTO PROBING MIGHT NOT WORK!!");
1433 /* REVISIT default clock will often be too fast ... */
1437 retval
= jtag_execute_queue();
1438 if (retval
!= ERROR_OK
)
1441 /* Examine DR values first. This discovers problems which will
1442 * prevent communication ... hardware issues like TDO stuck, or
1443 * configuring the wrong number of (enabled) TAPs.
1445 retval
= jtag_examine_chain();
1448 /* complete success */
1451 /* For backward compatibility reasons, try coping with
1452 * configuration errors involving only ID mismatches.
1453 * We might be able to talk to the devices.
1455 * Also the device might be powered down during startup.
1457 * After OpenOCD starts, we can try to power on the device
1460 LOG_ERROR("Trying to use configured scan chain anyway...");
1461 issue_setup
= false;
1465 /* Now look at IR values. Problems here will prevent real
1466 * communication. They mostly mean that the IR length is
1467 * wrong ... or that the IR capture value is wrong. (The
1468 * latter is uncommon, but easily worked around: provide
1469 * ircapture/irmask values during TAP setup.)
1471 retval
= jtag_validate_ircapture();
1472 if (retval
!= ERROR_OK
) {
1473 /* The target might be powered down. The user
1474 * can power it up and reset it after firing
1477 issue_setup
= false;
1481 jtag_notify_event(JTAG_TAP_EVENT_SETUP
);
1483 LOG_WARNING("Bypassing JTAG setup events due to errors");
1489 int adapter_quit(void)
1491 if (!jtag
|| !jtag
->quit
)
1494 /* close the JTAG interface */
1495 int result
= jtag
->quit();
1496 if (ERROR_OK
!= result
)
1497 LOG_ERROR("failed: %d", result
);
1502 int swd_init_reset(struct command_context
*cmd_ctx
)
1504 int retval
= adapter_init(cmd_ctx
);
1505 if (retval
!= ERROR_OK
)
1508 LOG_DEBUG("Initializing with hard SRST reset");
1510 if (jtag_reset_config
& RESET_HAS_SRST
)
1513 retval
= jtag_execute_queue();
1517 int jtag_init_reset(struct command_context
*cmd_ctx
)
1519 int retval
= adapter_init(cmd_ctx
);
1520 if (retval
!= ERROR_OK
)
1523 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1526 * This procedure is used by default when OpenOCD triggers a reset.
1527 * It's now done through an overridable Tcl "init_reset" wrapper.
1529 * This started out as a more powerful "get JTAG working" reset than
1530 * jtag_init_inner(), applying TRST because some chips won't activate
1531 * JTAG without a TRST cycle (presumed to be async, though some of
1532 * those chips synchronize JTAG activation using TCK).
1534 * But some chips only activate JTAG as part of an SRST cycle; SRST
1535 * got mixed in. So it became a hard reset routine, which got used
1536 * in more places, and which coped with JTAG reset being forced as
1537 * part of SRST (srst_pulls_trst).
1539 * And even more corner cases started to surface: TRST and/or SRST
1540 * assertion timings matter; some chips need other JTAG operations;
1541 * TRST/SRST sequences can need to be different from these, etc.
1543 * Systems should override that wrapper to support system-specific
1544 * requirements that this not-fully-generic code doesn't handle.
1546 * REVISIT once Tcl code can read the reset_config modes, this won't
1547 * need to be a C routine at all...
1549 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1550 if (jtag_reset_config
& RESET_HAS_SRST
) {
1551 jtag_add_reset(1, 1);
1552 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1553 jtag_add_reset(0, 1);
1556 /* some targets enable us to connect with srst asserted */
1557 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1558 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1559 jtag_add_reset(0, 1);
1561 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1562 jtag_add_reset(0, 0);
1565 jtag_add_reset(0, 0);
1566 retval
= jtag_execute_queue();
1567 if (retval
!= ERROR_OK
)
1570 /* Check that we can communication on the JTAG chain + eventually we want to
1571 * be able to perform enumeration only after OpenOCD has started
1572 * telnet and GDB server
1574 * That would allow users to more easily perform any magic they need to before
1577 return jtag_init_inner(cmd_ctx
);
1580 int jtag_init(struct command_context
*cmd_ctx
)
1582 int retval
= adapter_init(cmd_ctx
);
1583 if (retval
!= ERROR_OK
)
1586 /* guard against oddball hardware: force resets to be inactive */
1587 jtag_add_reset(0, 0);
1589 /* some targets enable us to connect with srst asserted */
1590 if (jtag_reset_config
& RESET_CNCT_UNDER_SRST
) {
1591 if (jtag_reset_config
& RESET_SRST_NO_GATING
)
1592 jtag_add_reset(0, 1);
1594 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1596 retval
= jtag_execute_queue();
1597 if (retval
!= ERROR_OK
)
1600 if (Jim_Eval_Named(cmd_ctx
->interp
, "jtag_init", __FILE__
, __LINE__
) != JIM_OK
)
1606 unsigned jtag_get_speed_khz(void)
1611 static int adapter_khz_to_speed(unsigned khz
, int *speed
)
1613 LOG_DEBUG("convert khz to interface specific speed value");
1616 LOG_DEBUG("have interface set up");
1618 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1619 if (ERROR_OK
!= retval
)
1621 *speed
= speed_div1
;
1626 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int *speed
)
1628 int retval
= adapter_khz_to_speed(0, speed
);
1629 if ((ERROR_OK
!= retval
) && fallback_speed_khz
) {
1630 LOG_DEBUG("trying fallback speed...");
1631 retval
= adapter_khz_to_speed(fallback_speed_khz
, speed
);
1636 static int jtag_set_speed(int speed
)
1639 /* this command can be called during CONFIG,
1640 * in which case jtag isn't initialized */
1641 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1644 int jtag_config_khz(unsigned khz
)
1646 LOG_DEBUG("handle jtag khz");
1647 clock_mode
= CLOCK_MODE_KHZ
;
1649 int retval
= adapter_khz_to_speed(khz
, &speed
);
1650 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1653 int jtag_config_rclk(unsigned fallback_speed_khz
)
1655 LOG_DEBUG("handle jtag rclk");
1656 clock_mode
= CLOCK_MODE_RCLK
;
1657 rclk_fallback_speed_khz
= fallback_speed_khz
;
1659 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1660 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1663 int jtag_get_speed(int *speed
)
1665 switch (clock_mode
) {
1666 case CLOCK_MODE_KHZ
:
1667 adapter_khz_to_speed(jtag_get_speed_khz(), speed
);
1669 case CLOCK_MODE_RCLK
:
1670 jtag_rclk_to_speed(rclk_fallback_speed_khz
, speed
);
1673 LOG_ERROR("BUG: unknown jtag clock mode");
1679 int jtag_get_speed_readable(int *khz
)
1681 int jtag_speed_var
= 0;
1682 int retval
= jtag_get_speed(&jtag_speed_var
);
1683 if (retval
!= ERROR_OK
)
1685 return jtag
? jtag
->speed_div(jtag_speed_var
, khz
) : ERROR_OK
;
1688 void jtag_set_verify(bool enable
)
1690 jtag_verify
= enable
;
1693 bool jtag_will_verify()
1698 void jtag_set_verify_capture_ir(bool enable
)
1700 jtag_verify_capture_ir
= enable
;
1703 bool jtag_will_verify_capture_ir()
1705 return jtag_verify_capture_ir
;
1708 int jtag_power_dropout(int *dropout
)
1711 /* TODO: as the jtag interface is not valid all
1712 * we can do at the moment is exit OpenOCD */
1713 LOG_ERROR("No Valid JTAG Interface Configured.");
1716 return jtag
->power_dropout(dropout
);
1719 int jtag_srst_asserted(int *srst_asserted
)
1721 return jtag
->srst_asserted(srst_asserted
);
1724 enum reset_types
jtag_get_reset_config(void)
1726 return jtag_reset_config
;
1728 void jtag_set_reset_config(enum reset_types type
)
1730 jtag_reset_config
= type
;
1733 int jtag_get_trst(void)
1737 int jtag_get_srst(void)
1742 void jtag_set_nsrst_delay(unsigned delay
)
1744 adapter_nsrst_delay
= delay
;
1746 unsigned jtag_get_nsrst_delay(void)
1748 return adapter_nsrst_delay
;
1750 void jtag_set_ntrst_delay(unsigned delay
)
1752 jtag_ntrst_delay
= delay
;
1754 unsigned jtag_get_ntrst_delay(void)
1756 return jtag_ntrst_delay
;
1760 void jtag_set_nsrst_assert_width(unsigned delay
)
1762 adapter_nsrst_assert_width
= delay
;
1764 unsigned jtag_get_nsrst_assert_width(void)
1766 return adapter_nsrst_assert_width
;
1768 void jtag_set_ntrst_assert_width(unsigned delay
)
1770 jtag_ntrst_assert_width
= delay
;
1772 unsigned jtag_get_ntrst_assert_width(void)
1774 return jtag_ntrst_assert_width
;
1777 static int jtag_select(struct command_context
*ctx
)
1781 /* NOTE: interface init must already have been done.
1782 * That works with only C code ... no Tcl glue required.
1785 retval
= jtag_register_commands(ctx
);
1787 if (retval
!= ERROR_OK
)
1790 retval
= svf_register_commands(ctx
);
1792 if (retval
!= ERROR_OK
)
1795 return xsvf_register_commands(ctx
);
1798 static struct transport jtag_transport
= {
1800 .select
= jtag_select
,
1804 static void jtag_constructor(void) __attribute__((constructor
));
1805 static void jtag_constructor(void)
1807 transport_register(&jtag_transport
);
1810 /** Returns true if the current debug session
1811 * is using JTAG as its transport.
1813 bool transport_is_jtag(void)
1815 return get_current_transport() == &jtag_transport
;
1818 void adapter_assert_reset(void)
1820 if (transport_is_jtag()) {
1821 if (jtag_reset_config
& RESET_SRST_PULLS_TRST
)
1822 jtag_add_reset(1, 1);
1824 jtag_add_reset(0, 1);
1825 } else if (transport_is_swd())
1827 else if (get_current_transport() != NULL
)
1828 LOG_ERROR("reset is not supported on %s",
1829 get_current_transport()->name
);
1831 LOG_ERROR("transport is not selected");
1834 void adapter_deassert_reset(void)
1836 if (transport_is_jtag())
1837 jtag_add_reset(0, 0);
1838 else if (transport_is_swd())
1840 else if (get_current_transport() != NULL
)
1841 LOG_ERROR("reset is not supported on %s",
1842 get_current_transport()->name
);
1844 LOG_ERROR("transport is not selected");
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)