1 /***************************************************************************
2 * Copyright (C) 2009 Zachary T Welch *
3 * zw@superlucidity.net *
5 * Copyright (C) 2007,2008,2009 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2005 by Dominic Rath *
13 * Dominic.Rath@gmx.de *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
27 ***************************************************************************/
35 #include "interface.h"
36 #include <transport/transport.h>
37 #include <helper/jep106.h>
38 #include "helper/system.h"
44 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
46 #include "xsvf/xsvf.h"
48 /* ipdbg are utilities to debug IP-cores. It uses JTAG for transport. */
49 #include "server/ipdbg.h"
51 /** The number of JTAG queue flushes (for profiling and debugging purposes). */
52 static int jtag_flush_queue_count;
54 /* Sleep this # of ms after flushing the queue */
55 static int jtag_flush_queue_sleep;
57 static void jtag_add_scan_check(struct jtag_tap *active,
58 void (*jtag_add_scan)(struct jtag_tap *active,
60 const struct scan_field *in_fields,
62 int in_num_fields, struct scan_field *in_fields, tap_state_t state);
65 * The jtag_error variable is set when an error occurs while executing
66 * the queue. Application code may set this using jtag_set_error(),
67 * when an error occurs during processing that should be reported during
68 * jtag_execute_queue().
70 * The value is set and cleared, but never read by normal application code.
72 * This value is returned (and cleared) by jtag_execute_queue().
74 static int jtag_error = ERROR_OK;
76 static const char *jtag_event_strings[] = {
77 [JTAG_TRST_ASSERTED] = "TAP reset",
78 [JTAG_TAP_EVENT_SETUP] = "TAP setup",
79 [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
80 [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
84 * JTAG adapters must initialize with TRST and SRST de-asserted
85 * (they're negative logic, so that means *high*). But some
86 * hardware doesn't necessarily work that way ... so set things
87 * up so that jtag_init() always forces that state.
89 static int jtag_trst = -1;
90 static int jtag_srst = -1;
93 * List all TAPs that have been created.
95 static struct jtag_tap *__jtag_all_taps;
97 static enum reset_types jtag_reset_config = RESET_NONE;
98 tap_state_t cmd_queue_cur_state = TAP_RESET;
100 static bool jtag_verify_capture_ir = true;
101 static int jtag_verify = 1;
103 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines
104 *deasserted (in ms) */
105 static int adapter_nsrst_delay; /* default to no nSRST delay */
106 static int jtag_ntrst_delay;/* default to no nTRST delay */
107 static int adapter_nsrst_assert_width; /* width of assertion */
108 static int jtag_ntrst_assert_width; /* width of assertion */
111 * Contains a single callback along with a pointer that will be passed
112 * when an event occurs.
114 struct jtag_event_callback {
115 /** a event callback */
116 jtag_event_handler_t callback;
117 /** the private data to pass to the callback */
119 /** the next callback */
120 struct jtag_event_callback *next;
123 /* callbacks to inform high-level handlers about JTAG state changes */
124 static struct jtag_event_callback *jtag_event_callbacks;
127 static int speed_khz;
128 /* speed to fallback to when RCLK is requested but not supported */
129 static int rclk_fallback_speed_khz;
130 static enum {CLOCK_MODE_UNSELECTED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
131 static int jtag_speed;
133 /* FIXME: change name to this variable, it is not anymore JTAG only */
134 static struct adapter_driver *jtag;
136 extern struct adapter_driver *adapter_driver;
138 void jtag_set_flush_queue_sleep(int ms)
140 jtag_flush_queue_sleep = ms;
143 void jtag_set_error(int error)
145 if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
150 int jtag_error_clear(void)
152 int temp = jtag_error;
153 jtag_error = ERROR_OK;
159 static bool jtag_poll = 1;
161 bool is_jtag_poll_safe(void)
163 /* Polling can be disabled explicitly with set_enabled(false).
164 * It is also implicitly disabled while TRST is active and
165 * while SRST is gating the JTAG clock.
167 if (!transport_is_jtag())
170 if (!jtag_poll || jtag_trst != 0)
172 return jtag_srst == 0 || (jtag_reset_config & RESET_SRST_NO_GATING);
175 bool jtag_poll_get_enabled(void)
180 void jtag_poll_set_enabled(bool value)
187 struct jtag_tap *jtag_all_taps(void)
189 return __jtag_all_taps;
192 unsigned jtag_tap_count(void)
194 struct jtag_tap *t = jtag_all_taps();
203 unsigned jtag_tap_count_enabled(void)
205 struct jtag_tap *t = jtag_all_taps();
215 /** Append a new TAP to the chain of all taps. */
216 static void jtag_tap_add(struct jtag_tap *t)
218 unsigned jtag_num_taps = 0;
220 struct jtag_tap **tap = &__jtag_all_taps;
223 tap = &(*tap)->next_tap;
226 t->abs_chain_position = jtag_num_taps;
229 /* returns a pointer to the n-th device in the scan chain */
230 struct jtag_tap *jtag_tap_by_position(unsigned n)
232 struct jtag_tap *t = jtag_all_taps();
240 struct jtag_tap *jtag_tap_by_string(const char *s)
242 /* try by name first */
243 struct jtag_tap *t = jtag_all_taps();
246 if (strcmp(t->dotted_name, s) == 0)
251 /* no tap found by name, so try to parse the name as a number */
253 if (parse_uint(s, &n) != ERROR_OK)
256 /* FIXME remove this numeric fallback code late June 2010, along
257 * with all info in the User's Guide that TAPs have numeric IDs.
258 * Also update "scan_chain" output to not display the numbers.
260 t = jtag_tap_by_position(n);
262 LOG_WARNING("Specify TAP '%s' by name, not number %u",
268 struct jtag_tap *jtag_tap_next_enabled(struct jtag_tap *p)
270 p = p ? p->next_tap : jtag_all_taps();
279 const char *jtag_tap_name(const struct jtag_tap *tap)
281 return (!tap) ? "(unknown)" : tap->dotted_name;
285 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
287 struct jtag_event_callback **callbacks_p = &jtag_event_callbacks;
290 return ERROR_COMMAND_SYNTAX_ERROR;
293 while ((*callbacks_p)->next)
294 callbacks_p = &((*callbacks_p)->next);
295 callbacks_p = &((*callbacks_p)->next);
298 (*callbacks_p) = malloc(sizeof(struct jtag_event_callback));
299 (*callbacks_p)->callback = callback;
300 (*callbacks_p)->priv = priv;
301 (*callbacks_p)->next = NULL;
306 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
308 struct jtag_event_callback **p = &jtag_event_callbacks, *temp;
311 return ERROR_COMMAND_SYNTAX_ERROR;
314 if (((*p)->priv != priv) || ((*p)->callback != callback)) {
327 int jtag_call_event_callbacks(enum jtag_event event)
329 struct jtag_event_callback *callback = jtag_event_callbacks;
331 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
334 struct jtag_event_callback *next;
336 /* callback may remove itself */
337 next = callback->next;
338 callback->callback(event, callback->priv);
345 static void jtag_checks(void)
347 assert(jtag_trst == 0);
350 static void jtag_prelude(tap_state_t state)
354 assert(state != TAP_INVALID);
356 cmd_queue_cur_state = state;
359 void jtag_add_ir_scan_noverify(struct jtag_tap *active, const struct scan_field *in_fields,
364 int retval = interface_jtag_add_ir_scan(active, in_fields, state);
365 jtag_set_error(retval);
368 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap *active,
370 const struct scan_field *in_fields,
373 jtag_add_ir_scan_noverify(active, in_fields, state);
376 /* If fields->in_value is filled out, then the captured IR value will be checked */
377 void jtag_add_ir_scan(struct jtag_tap *active, struct scan_field *in_fields, tap_state_t state)
379 assert(state != TAP_RESET);
381 if (jtag_verify && jtag_verify_capture_ir) {
382 /* 8 x 32 bit id's is enough for all invocations */
384 /* if we are to run a verification of the ir scan, we need to get the input back.
385 * We may have to allocate space if the caller didn't ask for the input back.
387 in_fields->check_value = active->expected;
388 in_fields->check_mask = active->expected_mask;
389 jtag_add_scan_check(active, jtag_add_ir_scan_noverify_callback, 1, in_fields,
392 jtag_add_ir_scan_noverify(active, in_fields, state);
395 void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
399 assert(state != TAP_RESET);
403 int retval = interface_jtag_add_plain_ir_scan(
404 num_bits, out_bits, in_bits, state);
405 jtag_set_error(retval);
408 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
409 uint8_t *in_check_mask, int num_bits);
411 static int jtag_check_value_mask_callback(jtag_callback_data_t data0,
412 jtag_callback_data_t data1,
413 jtag_callback_data_t data2,
414 jtag_callback_data_t data3)
416 return jtag_check_value_inner((uint8_t *)data0,
422 static void jtag_add_scan_check(struct jtag_tap *active, void (*jtag_add_scan)(
423 struct jtag_tap *active,
425 const struct scan_field *in_fields,
427 int in_num_fields, struct scan_field *in_fields, tap_state_t state)
429 jtag_add_scan(active, in_num_fields, in_fields, state);
431 for (int i = 0; i < in_num_fields; i++) {
432 if ((in_fields[i].check_value) && (in_fields[i].in_value)) {
433 jtag_add_callback4(jtag_check_value_mask_callback,
434 (jtag_callback_data_t)in_fields[i].in_value,
435 (jtag_callback_data_t)in_fields[i].check_value,
436 (jtag_callback_data_t)in_fields[i].check_mask,
437 (jtag_callback_data_t)in_fields[i].num_bits);
442 void jtag_add_dr_scan_check(struct jtag_tap *active,
444 struct scan_field *in_fields,
448 jtag_add_scan_check(active, jtag_add_dr_scan, in_num_fields, in_fields, state);
450 jtag_add_dr_scan(active, in_num_fields, in_fields, state);
454 void jtag_add_dr_scan(struct jtag_tap *active,
456 const struct scan_field *in_fields,
459 assert(state != TAP_RESET);
464 retval = interface_jtag_add_dr_scan(active, in_num_fields, in_fields, state);
465 jtag_set_error(retval);
468 void jtag_add_plain_dr_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
472 assert(state != TAP_RESET);
477 retval = interface_jtag_add_plain_dr_scan(num_bits, out_bits, in_bits, state);
478 jtag_set_error(retval);
481 void jtag_add_tlr(void)
483 jtag_prelude(TAP_RESET);
484 jtag_set_error(interface_jtag_add_tlr());
486 /* NOTE: order here matches TRST path in jtag_add_reset() */
487 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
488 jtag_notify_event(JTAG_TRST_ASSERTED);
492 * If supported by the underlying adapter, this clocks a raw bit sequence
493 * onto TMS for switching between JTAG and SWD modes.
495 * DO NOT use this to bypass the integrity checks and logging provided
496 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
498 * @param nbits How many bits to clock out.
499 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
500 * @param state The JTAG tap state to record on completion. Use
501 * TAP_INVALID to represent being in in SWD mode.
503 * @todo Update naming conventions to stop assuming everything is JTAG.
505 int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state state)
509 if (!(jtag->jtag_ops->supported & DEBUG_CAP_TMS_SEQ))
510 return ERROR_JTAG_NOT_IMPLEMENTED;
513 cmd_queue_cur_state = state;
515 retval = interface_add_tms_seq(nbits, seq, state);
516 jtag_set_error(retval);
520 void jtag_add_pathmove(int num_states, const tap_state_t *path)
522 tap_state_t cur_state = cmd_queue_cur_state;
524 /* the last state has to be a stable state */
525 if (!tap_is_state_stable(path[num_states - 1])) {
526 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
527 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
531 for (int i = 0; i < num_states; i++) {
532 if (path[i] == TAP_RESET) {
533 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
534 jtag_set_error(ERROR_JTAG_STATE_INVALID);
538 if (tap_state_transition(cur_state, true) != path[i] &&
539 tap_state_transition(cur_state, false) != path[i]) {
540 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
541 tap_state_name(cur_state), tap_state_name(path[i]));
542 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
550 jtag_set_error(interface_jtag_add_pathmove(num_states, path));
551 cmd_queue_cur_state = path[num_states - 1];
554 int jtag_add_statemove(tap_state_t goal_state)
556 tap_state_t cur_state = cmd_queue_cur_state;
558 if (goal_state != cur_state) {
559 LOG_DEBUG("cur_state=%s goal_state=%s",
560 tap_state_name(cur_state),
561 tap_state_name(goal_state));
564 /* If goal is RESET, be paranoid and force that that transition
565 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
567 if (goal_state == TAP_RESET)
569 else if (goal_state == cur_state)
572 else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state)) {
573 unsigned tms_bits = tap_get_tms_path(cur_state, goal_state);
574 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
575 tap_state_t moves[8];
576 assert(tms_count < ARRAY_SIZE(moves));
578 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1) {
579 bool bit = tms_bits & 1;
581 cur_state = tap_state_transition(cur_state, bit);
582 moves[i] = cur_state;
585 jtag_add_pathmove(tms_count, moves);
586 } else if (tap_state_transition(cur_state, true) == goal_state
587 || tap_state_transition(cur_state, false) == goal_state)
588 jtag_add_pathmove(1, &goal_state);
595 void jtag_add_runtest(int num_cycles, tap_state_t state)
598 jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
602 void jtag_add_clocks(int num_cycles)
604 if (!tap_is_state_stable(cmd_queue_cur_state)) {
605 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
606 tap_state_name(cmd_queue_cur_state));
607 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
611 if (num_cycles > 0) {
613 jtag_set_error(interface_jtag_add_clocks(num_cycles));
617 static int adapter_system_reset(int req_srst)
622 if (!(jtag_reset_config & RESET_HAS_SRST)) {
623 LOG_ERROR("BUG: can't assert SRST");
629 /* Maybe change SRST signal state */
630 if (jtag_srst != req_srst) {
631 retval = jtag->reset(0, req_srst);
632 if (retval != ERROR_OK) {
633 LOG_ERROR("SRST error");
636 jtag_srst = req_srst;
639 LOG_DEBUG("SRST line asserted");
640 if (adapter_nsrst_assert_width)
641 jtag_sleep(adapter_nsrst_assert_width * 1000);
643 LOG_DEBUG("SRST line released");
644 if (adapter_nsrst_delay)
645 jtag_sleep(adapter_nsrst_delay * 1000);
652 static void legacy_jtag_add_reset(int req_tlr_or_trst, int req_srst)
654 int trst_with_tlr = 0;
658 /* Without SRST, we must use target-specific JTAG operations
659 * on each target; callers should not be requesting SRST when
660 * that signal doesn't exist.
662 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
663 * can kick in even if the JTAG adapter can't drive TRST.
666 if (!(jtag_reset_config & RESET_HAS_SRST)) {
667 LOG_ERROR("BUG: can't assert SRST");
668 jtag_set_error(ERROR_FAIL);
671 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
672 && !req_tlr_or_trst) {
673 LOG_ERROR("BUG: can't assert only SRST");
674 jtag_set_error(ERROR_FAIL);
680 /* JTAG reset (entry to TAP_RESET state) can always be achieved
681 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
682 * state first. TRST accelerates it, and bypasses those states.
684 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
685 * can kick in even if the JTAG adapter can't drive SRST.
687 if (req_tlr_or_trst) {
688 if (!(jtag_reset_config & RESET_HAS_TRST))
690 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
697 /* Maybe change TRST and/or SRST signal state */
698 if (jtag_srst != new_srst || jtag_trst != new_trst) {
701 retval = interface_jtag_add_reset(new_trst, new_srst);
702 if (retval != ERROR_OK)
703 jtag_set_error(retval);
705 retval = jtag_execute_queue();
707 if (retval != ERROR_OK) {
708 LOG_ERROR("TRST/SRST error");
713 /* SRST resets everything hooked up to that signal */
714 if (jtag_srst != new_srst) {
715 jtag_srst = new_srst;
717 LOG_DEBUG("SRST line asserted");
718 if (adapter_nsrst_assert_width)
719 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
721 LOG_DEBUG("SRST line released");
722 if (adapter_nsrst_delay)
723 jtag_add_sleep(adapter_nsrst_delay * 1000);
727 /* Maybe enter the JTAG TAP_RESET state ...
728 * - using only TMS, TCK, and the JTAG state machine
729 * - or else more directly, using TRST
731 * TAP_RESET should be invisible to non-debug parts of the system.
734 LOG_DEBUG("JTAG reset with TLR instead of TRST");
737 } else if (jtag_trst != new_trst) {
738 jtag_trst = new_trst;
740 LOG_DEBUG("TRST line asserted");
741 tap_set_state(TAP_RESET);
742 if (jtag_ntrst_assert_width)
743 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
745 LOG_DEBUG("TRST line released");
746 if (jtag_ntrst_delay)
747 jtag_add_sleep(jtag_ntrst_delay * 1000);
749 /* We just asserted nTRST, so we're now in TAP_RESET.
750 * Inform possible listeners about this, now that
751 * JTAG instructions and data can be shifted. This
752 * sequence must match jtag_add_tlr().
754 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
755 jtag_notify_event(JTAG_TRST_ASSERTED);
760 /* FIXME: name is misleading; we do not plan to "add" reset into jtag queue */
761 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
764 int trst_with_tlr = 0;
769 legacy_jtag_add_reset(req_tlr_or_trst, req_srst);
773 /* Without SRST, we must use target-specific JTAG operations
774 * on each target; callers should not be requesting SRST when
775 * that signal doesn't exist.
777 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
778 * can kick in even if the JTAG adapter can't drive TRST.
781 if (!(jtag_reset_config & RESET_HAS_SRST)) {
782 LOG_ERROR("BUG: can't assert SRST");
783 jtag_set_error(ERROR_FAIL);
786 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
787 && !req_tlr_or_trst) {
788 LOG_ERROR("BUG: can't assert only SRST");
789 jtag_set_error(ERROR_FAIL);
795 /* JTAG reset (entry to TAP_RESET state) can always be achieved
796 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
797 * state first. TRST accelerates it, and bypasses those states.
799 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
800 * can kick in even if the JTAG adapter can't drive SRST.
802 if (req_tlr_or_trst) {
803 if (!(jtag_reset_config & RESET_HAS_TRST))
805 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
812 /* Maybe change TRST and/or SRST signal state */
813 if (jtag_srst != new_srst || jtag_trst != new_trst) {
814 /* guarantee jtag queue empty before changing reset status */
815 jtag_execute_queue();
817 retval = jtag->reset(new_trst, new_srst);
818 if (retval != ERROR_OK) {
819 jtag_set_error(retval);
820 LOG_ERROR("TRST/SRST error");
825 /* SRST resets everything hooked up to that signal */
826 if (jtag_srst != new_srst) {
827 jtag_srst = new_srst;
829 LOG_DEBUG("SRST line asserted");
830 if (adapter_nsrst_assert_width)
831 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
833 LOG_DEBUG("SRST line released");
834 if (adapter_nsrst_delay)
835 jtag_add_sleep(adapter_nsrst_delay * 1000);
839 /* Maybe enter the JTAG TAP_RESET state ...
840 * - using only TMS, TCK, and the JTAG state machine
841 * - or else more directly, using TRST
843 * TAP_RESET should be invisible to non-debug parts of the system.
846 LOG_DEBUG("JTAG reset with TLR instead of TRST");
848 jtag_execute_queue();
850 } else if (jtag_trst != new_trst) {
851 jtag_trst = new_trst;
853 LOG_DEBUG("TRST line asserted");
854 tap_set_state(TAP_RESET);
855 if (jtag_ntrst_assert_width)
856 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
858 LOG_DEBUG("TRST line released");
859 if (jtag_ntrst_delay)
860 jtag_add_sleep(jtag_ntrst_delay * 1000);
862 /* We just asserted nTRST, so we're now in TAP_RESET.
863 * Inform possible listeners about this, now that
864 * JTAG instructions and data can be shifted. This
865 * sequence must match jtag_add_tlr().
867 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
868 jtag_notify_event(JTAG_TRST_ASSERTED);
873 void jtag_add_sleep(uint32_t us)
875 /** @todo Here, keep_alive() appears to be a layering violation!!! */
877 jtag_set_error(interface_jtag_add_sleep(us));
880 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
881 uint8_t *in_check_mask, int num_bits)
883 int retval = ERROR_OK;
887 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
889 compare_failed = buf_cmp(captured, in_check_value, num_bits);
891 if (compare_failed) {
892 char *captured_str, *in_check_value_str;
893 int bits = (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits;
895 /* NOTE: we've lost diagnostic context here -- 'which tap' */
897 captured_str = buf_to_hex_str(captured, bits);
898 in_check_value_str = buf_to_hex_str(in_check_value, bits);
900 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
902 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
905 free(in_check_value_str);
908 char *in_check_mask_str;
910 in_check_mask_str = buf_to_hex_str(in_check_mask, bits);
911 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
912 free(in_check_mask_str);
915 retval = ERROR_JTAG_QUEUE_FAILED;
920 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask)
922 assert(field->in_value);
925 /* no checking to do */
929 jtag_execute_queue_noclear();
931 int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
932 jtag_set_error(retval);
935 int default_interface_jtag_execute_queue(void)
938 LOG_ERROR("No JTAG interface configured yet. "
939 "Issue 'init' command in startup scripts "
940 "before communicating with targets.");
944 if (!transport_is_jtag()) {
946 * FIXME: This should not happen!
947 * There could be old code that queues jtag commands with non jtag interfaces so, for
948 * the moment simply highlight it by log an error and return on empty execute_queue.
949 * We should fix it quitting with assert(0) because it is an internal error.
950 * The fix can be applied immediately after next release (v0.11.0 ?)
952 LOG_ERROR("JTAG API jtag_execute_queue() called on non JTAG interface");
953 if (!jtag->jtag_ops || !jtag->jtag_ops->execute_queue)
957 int result = jtag->jtag_ops->execute_queue();
959 struct jtag_command *cmd = jtag_command_queue;
960 while (debug_level >= LOG_LVL_DEBUG_IO && cmd) {
963 LOG_DEBUG_IO("JTAG %s SCAN to %s",
964 cmd->cmd.scan->ir_scan ? "IR" : "DR",
965 tap_state_name(cmd->cmd.scan->end_state));
966 for (int i = 0; i < cmd->cmd.scan->num_fields; i++) {
967 struct scan_field *field = cmd->cmd.scan->fields + i;
968 if (field->out_value) {
969 char *str = buf_to_hex_str(field->out_value, field->num_bits);
970 LOG_DEBUG_IO(" %db out: %s", field->num_bits, str);
973 if (field->in_value) {
974 char *str = buf_to_hex_str(field->in_value, field->num_bits);
975 LOG_DEBUG_IO(" %db in: %s", field->num_bits, str);
981 LOG_DEBUG_IO("JTAG TLR RESET to %s",
982 tap_state_name(cmd->cmd.statemove->end_state));
985 LOG_DEBUG_IO("JTAG RUNTEST %d cycles to %s",
986 cmd->cmd.runtest->num_cycles,
987 tap_state_name(cmd->cmd.runtest->end_state));
991 const char *reset_str[3] = {
992 "leave", "deassert", "assert"
994 LOG_DEBUG_IO("JTAG RESET %s TRST, %s SRST",
995 reset_str[cmd->cmd.reset->trst + 1],
996 reset_str[cmd->cmd.reset->srst + 1]);
1000 LOG_DEBUG_IO("JTAG PATHMOVE (TODO)");
1003 LOG_DEBUG_IO("JTAG SLEEP (TODO)");
1005 case JTAG_STABLECLOCKS:
1006 LOG_DEBUG_IO("JTAG STABLECLOCKS (TODO)");
1009 LOG_DEBUG_IO("JTAG TMS (TODO)");
1012 LOG_ERROR("Unknown JTAG command: %d", cmd->type);
1021 void jtag_execute_queue_noclear(void)
1023 jtag_flush_queue_count++;
1024 jtag_set_error(interface_jtag_execute_queue());
1026 if (jtag_flush_queue_sleep > 0) {
1027 /* For debug purposes it can be useful to test performance
1028 * or behavior when delaying after flushing the queue,
1029 * e.g. to simulate long roundtrip times.
1031 usleep(jtag_flush_queue_sleep * 1000);
1035 int jtag_get_flush_queue_count(void)
1037 return jtag_flush_queue_count;
1040 int jtag_execute_queue(void)
1042 jtag_execute_queue_noclear();
1043 return jtag_error_clear();
1046 static int jtag_reset_callback(enum jtag_event event, void *priv)
1048 struct jtag_tap *tap = priv;
1050 if (event == JTAG_TRST_ASSERTED) {
1051 tap->enabled = !tap->disabled_after_reset;
1053 /* current instruction is either BYPASS or IDCODE */
1054 buf_set_ones(tap->cur_instr, tap->ir_length);
1061 /* sleep at least us microseconds. When we sleep more than 1000ms we
1062 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
1063 * GDB if we slept for <1000ms many times.
1065 void jtag_sleep(uint32_t us)
1070 alive_sleep((us+999)/1000);
1073 #define JTAG_MAX_AUTO_TAPS 20
1075 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1076 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1077 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1079 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
1080 * know that no valid TAP will have it as an IDCODE value.
1082 #define END_OF_CHAIN_FLAG 0xffffffff
1084 /* a larger IR length than we ever expect to autoprobe */
1085 #define JTAG_IRLEN_MAX 60
1087 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
1089 struct scan_field field = {
1090 .num_bits = num_idcode * 32,
1091 .out_value = idcode_buffer,
1092 .in_value = idcode_buffer,
1095 /* initialize to the end of chain ID value */
1096 for (unsigned i = 0; i < num_idcode; i++)
1097 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
1099 jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, TAP_DRPAUSE);
1101 return jtag_execute_queue();
1104 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
1106 uint8_t zero_check = 0x0;
1107 uint8_t one_check = 0xff;
1109 for (unsigned i = 0; i < count * 4; i++) {
1110 zero_check |= idcodes[i];
1111 one_check &= idcodes[i];
1114 /* if there wasn't a single non-zero bit or if all bits were one,
1115 * the scan is not valid. We wrote a mix of both values; either
1117 * - There's a hardware issue (almost certainly):
1118 * + all-zeroes can mean a target stuck in JTAG reset
1119 * + all-ones tends to mean no target
1120 * - The scan chain is WAY longer than we can handle, *AND* either
1121 * + there are several hundreds of TAPs in bypass, or
1122 * + at least a few dozen TAPs all have an all-ones IDCODE
1124 if (zero_check == 0x00 || one_check == 0xff) {
1125 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
1126 (zero_check == 0x00) ? "zeroes" : "ones");
1127 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
1133 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
1134 const char *name, uint32_t idcode)
1136 log_printf_lf(level, __FILE__, __LINE__, __func__,
1137 "JTAG tap: %s %16.16s: 0x%08x "
1138 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
1140 (unsigned int)idcode,
1141 (unsigned int)EXTRACT_MFG(idcode),
1142 jep106_manufacturer(EXTRACT_MFG(idcode)),
1143 (unsigned int)EXTRACT_PART(idcode),
1144 (unsigned int)EXTRACT_VER(idcode));
1147 static bool jtag_idcode_is_final(uint32_t idcode)
1150 * Some devices, such as AVR8, will output all 1's instead
1151 * of TDI input value at end of chain. Allow those values
1152 * instead of failing.
1154 return idcode == END_OF_CHAIN_FLAG;
1158 * This helper checks that remaining bits in the examined chain data are
1159 * all as expected, but a single JTAG device requires only 64 bits to be
1160 * read back correctly. This can help identify and diagnose problems
1161 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1162 * Returns TRUE iff garbage was found.
1164 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
1166 bool triggered = false;
1167 for (; count < max - 31; count += 32) {
1168 uint32_t idcode = buf_get_u32(idcodes, count, 32);
1170 /* do not trigger the warning if the data looks good */
1171 if (jtag_idcode_is_final(idcode))
1173 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1174 count, (unsigned int)idcode);
1180 static bool jtag_examine_chain_match_tap(const struct jtag_tap *tap)
1183 if (tap->expected_ids_cnt == 0 || !tap->hasidcode)
1186 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1187 uint32_t mask = tap->ignore_version ? ~(0xfU << 28) : ~0U;
1188 uint32_t idcode = tap->idcode & mask;
1190 /* Loop over the expected identification codes and test for a match */
1191 for (unsigned ii = 0; ii < tap->expected_ids_cnt; ii++) {
1192 uint32_t expected = tap->expected_ids[ii] & mask;
1194 if (idcode == expected)
1197 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1198 if (tap->expected_ids[ii] == 0)
1202 /* If none of the expected ids matched, warn */
1203 jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
1204 tap->dotted_name, tap->idcode);
1205 for (unsigned ii = 0; ii < tap->expected_ids_cnt; ii++) {
1208 snprintf(msg, sizeof(msg), "expected %u of %u", ii + 1, tap->expected_ids_cnt);
1209 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
1210 tap->dotted_name, tap->expected_ids[ii]);
1215 /* Try to examine chain layout according to IEEE 1149.1 §12
1216 * This is called a "blind interrogation" of the scan chain.
1218 static int jtag_examine_chain(void)
1221 unsigned max_taps = jtag_tap_count();
1223 /* Autoprobe up to this many. */
1224 if (max_taps < JTAG_MAX_AUTO_TAPS)
1225 max_taps = JTAG_MAX_AUTO_TAPS;
1227 /* Add room for end-of-chain marker. */
1230 uint8_t *idcode_buffer = calloc(4, max_taps);
1232 return ERROR_JTAG_INIT_FAILED;
1234 /* DR scan to collect BYPASS or IDCODE register contents.
1235 * Then make sure the scan data has both ones and zeroes.
1237 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1238 retval = jtag_examine_chain_execute(idcode_buffer, max_taps);
1239 if (retval != ERROR_OK)
1241 if (!jtag_examine_chain_check(idcode_buffer, max_taps)) {
1242 retval = ERROR_JTAG_INIT_FAILED;
1246 /* Point at the 1st predefined tap, if any */
1247 struct jtag_tap *tap = jtag_tap_next_enabled(NULL);
1249 unsigned bit_count = 0;
1250 unsigned autocount = 0;
1251 for (unsigned i = 0; i < max_taps; i++) {
1252 assert(bit_count < max_taps * 32);
1253 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1255 /* No predefined TAP? Auto-probe. */
1257 /* Is there another TAP? */
1258 if (jtag_idcode_is_final(idcode))
1261 /* Default everything in this TAP except IR length.
1263 * REVISIT create a jtag_alloc(chip, tap) routine, and
1264 * share it with jim_newtap_cmd().
1266 tap = calloc(1, sizeof(*tap));
1268 retval = ERROR_FAIL;
1272 tap->chip = alloc_printf("auto%u", autocount++);
1273 tap->tapname = strdup("tap");
1274 tap->dotted_name = alloc_printf("%s.%s", tap->chip, tap->tapname);
1276 tap->ir_length = 0; /* ... signifying irlen autoprobe */
1277 tap->ir_capture_mask = 0x03;
1278 tap->ir_capture_value = 0x01;
1280 tap->enabled = true;
1285 if ((idcode & 1) == 0) {
1286 /* Zero for LSB indicates a device in bypass */
1287 LOG_INFO("TAP %s does not have valid IDCODE (idcode=0x%" PRIx32 ")",
1288 tap->dotted_name, idcode);
1289 tap->hasidcode = false;
1294 /* Friendly devices support IDCODE */
1295 tap->hasidcode = true;
1296 tap->idcode = idcode;
1297 jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found", tap->dotted_name, idcode);
1302 /* ensure the TAP ID matches what was expected */
1303 if (!jtag_examine_chain_match_tap(tap))
1304 retval = ERROR_JTAG_INIT_SOFT_FAIL;
1306 tap = jtag_tap_next_enabled(tap);
1309 /* After those IDCODE or BYPASS register values should be
1310 * only the data we fed into the scan chain.
1312 if (jtag_examine_chain_end(idcode_buffer, bit_count, max_taps * 32)) {
1313 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1314 retval = ERROR_JTAG_INIT_FAILED;
1318 /* Return success or, for backwards compatibility if only
1319 * some IDCODE values mismatched, a soft/continuable fault.
1322 free(idcode_buffer);
1327 * Validate the date loaded by entry to the Capture-IR state, to help
1328 * find errors related to scan chain configuration (wrong IR lengths)
1331 * Entry state can be anything. On non-error exit, all TAPs are in
1332 * bypass mode. On error exits, the scan chain is reset.
1334 static int jtag_validate_ircapture(void)
1336 struct jtag_tap *tap;
1337 uint8_t *ir_test = NULL;
1338 struct scan_field field;
1343 /* when autoprobing, accommodate huge IR lengths */
1344 int total_ir_length = 0;
1345 for (tap = jtag_tap_next_enabled(NULL); tap; tap = jtag_tap_next_enabled(tap)) {
1346 if (tap->ir_length == 0)
1347 total_ir_length += JTAG_IRLEN_MAX;
1349 total_ir_length += tap->ir_length;
1352 /* increase length to add 2 bit sentinel after scan */
1353 total_ir_length += 2;
1355 ir_test = malloc(DIV_ROUND_UP(total_ir_length, 8));
1359 /* after this scan, all TAPs will capture BYPASS instructions */
1360 buf_set_ones(ir_test, total_ir_length);
1362 field.num_bits = total_ir_length;
1363 field.out_value = ir_test;
1364 field.in_value = ir_test;
1366 jtag_add_plain_ir_scan(field.num_bits, field.out_value, field.in_value, TAP_IDLE);
1368 LOG_DEBUG("IR capture validation scan");
1369 retval = jtag_execute_queue();
1370 if (retval != ERROR_OK)
1377 tap = jtag_tap_next_enabled(tap);
1381 /* If we're autoprobing, guess IR lengths. They must be at
1382 * least two bits. Guessing will fail if (a) any TAP does
1383 * not conform to the JTAG spec; or (b) when the upper bits
1384 * captured from some conforming TAP are nonzero. Or if
1385 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1386 * an implementation limit, which could someday be raised.
1388 * REVISIT optimization: if there's a *single* TAP we can
1389 * lift restrictions (a) and (b) by scanning a recognizable
1390 * pattern before the all-ones BYPASS. Check for where the
1391 * pattern starts in the result, instead of an 0...01 value.
1393 * REVISIT alternative approach: escape to some tcl code
1394 * which could provide more knowledge, based on IDCODE; and
1395 * only guess when that has no success.
1397 if (tap->ir_length == 0) {
1399 while ((val = buf_get_u64(ir_test, chain_pos, tap->ir_length + 1)) == 1
1400 && tap->ir_length < JTAG_IRLEN_MAX) {
1403 LOG_WARNING("AUTO %s - use \"jtag newtap %s %s -irlen %d "
1404 "-expected-id 0x%08" PRIx32 "\"",
1405 tap->dotted_name, tap->chip, tap->tapname, tap->ir_length, tap->idcode);
1408 /* Validate the two LSBs, which must be 01 per JTAG spec.
1410 * Or ... more bits could be provided by TAP declaration.
1411 * Plus, some taps (notably in i.MX series chips) violate
1412 * this part of the JTAG spec, so their capture mask/value
1413 * attributes might disable this test.
1415 val = buf_get_u64(ir_test, chain_pos, tap->ir_length);
1416 if ((val & tap->ir_capture_mask) != tap->ir_capture_value) {
1417 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64 " not 0x%0*" PRIx32,
1419 (tap->ir_length + 7) / tap->ir_length, val,
1420 (tap->ir_length + 7) / tap->ir_length, tap->ir_capture_value);
1422 retval = ERROR_JTAG_INIT_FAILED;
1425 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64, jtag_tap_name(tap),
1426 (tap->ir_length + 7) / tap->ir_length, val);
1427 chain_pos += tap->ir_length;
1430 /* verify the '11' sentinel we wrote is returned at the end */
1431 val = buf_get_u64(ir_test, chain_pos, 2);
1433 char *cbuf = buf_to_hex_str(ir_test, total_ir_length);
1435 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1438 retval = ERROR_JTAG_INIT_FAILED;
1443 if (retval != ERROR_OK) {
1445 jtag_execute_queue();
1450 void jtag_tap_init(struct jtag_tap *tap)
1452 unsigned ir_len_bits;
1453 unsigned ir_len_bytes;
1455 /* if we're autoprobing, cope with potentially huge ir_length */
1456 ir_len_bits = tap->ir_length ? tap->ir_length : JTAG_IRLEN_MAX;
1457 ir_len_bytes = DIV_ROUND_UP(ir_len_bits, 8);
1459 tap->expected = calloc(1, ir_len_bytes);
1460 tap->expected_mask = calloc(1, ir_len_bytes);
1461 tap->cur_instr = malloc(ir_len_bytes);
1463 /** @todo cope better with ir_length bigger than 32 bits */
1464 if (ir_len_bits > 32)
1467 buf_set_u32(tap->expected, 0, ir_len_bits, tap->ir_capture_value);
1468 buf_set_u32(tap->expected_mask, 0, ir_len_bits, tap->ir_capture_mask);
1470 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1472 buf_set_ones(tap->cur_instr, tap->ir_length);
1474 /* register the reset callback for the TAP */
1475 jtag_register_event_callback(&jtag_reset_callback, tap);
1478 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1479 "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1480 tap->abs_chain_position, tap->ir_length,
1481 (unsigned) tap->ir_capture_value,
1482 (unsigned) tap->ir_capture_mask);
1485 void jtag_tap_free(struct jtag_tap *tap)
1487 jtag_unregister_event_callback(&jtag_reset_callback, tap);
1489 struct jtag_tap_event_action *jteap = tap->event_action;
1491 struct jtag_tap_event_action *next = jteap->next;
1492 Jim_DecrRefCount(jteap->interp, jteap->body);
1497 free(tap->expected);
1498 free(tap->expected_mask);
1499 free(tap->expected_ids);
1500 free(tap->cur_instr);
1503 free(tap->dotted_name);
1508 * Do low-level setup like initializing registers, output signals,
1511 int adapter_init(struct command_context *cmd_ctx)
1516 if (!adapter_driver) {
1517 /* nothing was previously specified by "adapter driver" command */
1518 LOG_ERROR("Debug Adapter has to be specified, "
1519 "see \"adapter driver\" command");
1520 return ERROR_JTAG_INVALID_INTERFACE;
1524 retval = adapter_driver->init();
1525 if (retval != ERROR_OK)
1527 jtag = adapter_driver;
1530 LOG_INFO("This adapter doesn't support configurable speed");
1534 if (clock_mode == CLOCK_MODE_UNSELECTED) {
1535 LOG_ERROR("An adapter speed is not selected in the init script."
1536 " Insert a call to \"adapter speed\" or \"jtag_rclk\" to proceed.");
1537 return ERROR_JTAG_INIT_FAILED;
1540 int requested_khz = jtag_get_speed_khz();
1541 int actual_khz = requested_khz;
1542 int jtag_speed_var = 0;
1543 retval = jtag_get_speed(&jtag_speed_var);
1544 if (retval != ERROR_OK)
1546 retval = jtag->speed(jtag_speed_var);
1547 if (retval != ERROR_OK)
1549 retval = jtag_get_speed_readable(&actual_khz);
1550 if (retval != ERROR_OK)
1551 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var);
1552 else if (actual_khz) {
1553 /* Adaptive clocking -- JTAG-specific */
1554 if ((clock_mode == CLOCK_MODE_RCLK)
1555 || ((clock_mode == CLOCK_MODE_KHZ) && !requested_khz)) {
1556 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1559 LOG_INFO("clock speed %d kHz", actual_khz);
1561 LOG_INFO("RCLK (adaptive clock speed)");
1566 int jtag_init_inner(struct command_context *cmd_ctx)
1568 struct jtag_tap *tap;
1570 bool issue_setup = true;
1572 LOG_DEBUG("Init JTAG chain");
1574 tap = jtag_tap_next_enabled(NULL);
1576 /* Once JTAG itself is properly set up, and the scan chain
1577 * isn't absurdly large, IDCODE autoprobe should work fine.
1579 * But ... IRLEN autoprobe can fail even on systems which
1580 * are fully conformant to JTAG. Also, JTAG setup can be
1581 * quite finicky on some systems.
1583 * REVISIT: if TAP autoprobe works OK, then in many cases
1584 * we could escape to tcl code and set up targets based on
1585 * the TAP's IDCODE values.
1587 LOG_WARNING("There are no enabled taps. "
1588 "AUTO PROBING MIGHT NOT WORK!!");
1590 /* REVISIT default clock will often be too fast ... */
1594 retval = jtag_execute_queue();
1595 if (retval != ERROR_OK)
1598 /* Examine DR values first. This discovers problems which will
1599 * prevent communication ... hardware issues like TDO stuck, or
1600 * configuring the wrong number of (enabled) TAPs.
1602 retval = jtag_examine_chain();
1605 /* complete success */
1608 /* For backward compatibility reasons, try coping with
1609 * configuration errors involving only ID mismatches.
1610 * We might be able to talk to the devices.
1612 * Also the device might be powered down during startup.
1614 * After OpenOCD starts, we can try to power on the device
1617 LOG_ERROR("Trying to use configured scan chain anyway...");
1618 issue_setup = false;
1622 /* Now look at IR values. Problems here will prevent real
1623 * communication. They mostly mean that the IR length is
1624 * wrong ... or that the IR capture value is wrong. (The
1625 * latter is uncommon, but easily worked around: provide
1626 * ircapture/irmask values during TAP setup.)
1628 retval = jtag_validate_ircapture();
1629 if (retval != ERROR_OK) {
1630 /* The target might be powered down. The user
1631 * can power it up and reset it after firing
1634 issue_setup = false;
1638 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1640 LOG_WARNING("Bypassing JTAG setup events due to errors");
1646 int adapter_quit(void)
1648 if (jtag && jtag->quit) {
1649 /* close the JTAG interface */
1650 int result = jtag->quit();
1651 if (result != ERROR_OK)
1652 LOG_ERROR("failed: %d", result);
1655 struct jtag_tap *t = jtag_all_taps();
1657 struct jtag_tap *n = t->next_tap;
1665 int swd_init_reset(struct command_context *cmd_ctx)
1667 int retval, retval1;
1669 retval = adapter_init(cmd_ctx);
1670 if (retval != ERROR_OK)
1673 LOG_DEBUG("Initializing with hard SRST reset");
1675 if (jtag_reset_config & RESET_HAS_SRST)
1676 retval = adapter_system_reset(1);
1677 retval1 = adapter_system_reset(0);
1679 return (retval == ERROR_OK) ? retval1 : retval;
1682 int jtag_init_reset(struct command_context *cmd_ctx)
1684 int retval = adapter_init(cmd_ctx);
1685 if (retval != ERROR_OK)
1688 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1691 * This procedure is used by default when OpenOCD triggers a reset.
1692 * It's now done through an overridable Tcl "init_reset" wrapper.
1694 * This started out as a more powerful "get JTAG working" reset than
1695 * jtag_init_inner(), applying TRST because some chips won't activate
1696 * JTAG without a TRST cycle (presumed to be async, though some of
1697 * those chips synchronize JTAG activation using TCK).
1699 * But some chips only activate JTAG as part of an SRST cycle; SRST
1700 * got mixed in. So it became a hard reset routine, which got used
1701 * in more places, and which coped with JTAG reset being forced as
1702 * part of SRST (srst_pulls_trst).
1704 * And even more corner cases started to surface: TRST and/or SRST
1705 * assertion timings matter; some chips need other JTAG operations;
1706 * TRST/SRST sequences can need to be different from these, etc.
1708 * Systems should override that wrapper to support system-specific
1709 * requirements that this not-fully-generic code doesn't handle.
1711 * REVISIT once Tcl code can read the reset_config modes, this won't
1712 * need to be a C routine at all...
1714 if (jtag_reset_config & RESET_HAS_SRST) {
1715 jtag_add_reset(1, 1);
1716 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1717 jtag_add_reset(0, 1);
1719 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1722 /* some targets enable us to connect with srst asserted */
1723 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
1724 if (jtag_reset_config & RESET_SRST_NO_GATING)
1725 jtag_add_reset(0, 1);
1727 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1728 jtag_add_reset(0, 0);
1731 jtag_add_reset(0, 0);
1732 retval = jtag_execute_queue();
1733 if (retval != ERROR_OK)
1736 /* Check that we can communication on the JTAG chain + eventually we want to
1737 * be able to perform enumeration only after OpenOCD has started
1738 * telnet and GDB server
1740 * That would allow users to more easily perform any magic they need to before
1743 return jtag_init_inner(cmd_ctx);
1746 int jtag_init(struct command_context *cmd_ctx)
1748 int retval = adapter_init(cmd_ctx);
1749 if (retval != ERROR_OK)
1752 /* guard against oddball hardware: force resets to be inactive */
1753 jtag_add_reset(0, 0);
1755 /* some targets enable us to connect with srst asserted */
1756 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
1757 if (jtag_reset_config & RESET_SRST_NO_GATING)
1758 jtag_add_reset(0, 1);
1760 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1762 retval = jtag_execute_queue();
1763 if (retval != ERROR_OK)
1766 if (Jim_Eval_Named(cmd_ctx->interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1772 unsigned jtag_get_speed_khz(void)
1777 static int adapter_khz_to_speed(unsigned khz, int *speed)
1779 LOG_DEBUG("convert khz to interface specific speed value");
1783 LOG_DEBUG("have interface set up");
1785 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1789 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1790 if (retval != ERROR_OK)
1792 *speed = speed_div1;
1796 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int *speed)
1798 int retval = adapter_khz_to_speed(0, speed);
1799 if ((retval != ERROR_OK) && fallback_speed_khz) {
1800 LOG_DEBUG("trying fallback speed...");
1801 retval = adapter_khz_to_speed(fallback_speed_khz, speed);
1806 static int jtag_set_speed(int speed)
1809 /* this command can be called during CONFIG,
1810 * in which case jtag isn't initialized */
1811 return jtag ? jtag->speed(speed) : ERROR_OK;
1814 int jtag_config_khz(unsigned khz)
1816 LOG_DEBUG("handle jtag khz");
1817 clock_mode = CLOCK_MODE_KHZ;
1819 int retval = adapter_khz_to_speed(khz, &speed);
1820 return (retval != ERROR_OK) ? retval : jtag_set_speed(speed);
1823 int jtag_config_rclk(unsigned fallback_speed_khz)
1825 LOG_DEBUG("handle jtag rclk");
1826 clock_mode = CLOCK_MODE_RCLK;
1827 rclk_fallback_speed_khz = fallback_speed_khz;
1829 int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1830 return (retval != ERROR_OK) ? retval : jtag_set_speed(speed);
1833 int jtag_get_speed(int *speed)
1835 switch (clock_mode) {
1836 case CLOCK_MODE_KHZ:
1837 adapter_khz_to_speed(jtag_get_speed_khz(), speed);
1839 case CLOCK_MODE_RCLK:
1840 jtag_rclk_to_speed(rclk_fallback_speed_khz, speed);
1843 LOG_ERROR("BUG: unknown jtag clock mode");
1849 int jtag_get_speed_readable(int *khz)
1851 int jtag_speed_var = 0;
1852 int retval = jtag_get_speed(&jtag_speed_var);
1853 if (retval != ERROR_OK)
1857 if (!jtag->speed_div) {
1858 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1861 return jtag->speed_div(jtag_speed_var, khz);
1864 void jtag_set_verify(bool enable)
1866 jtag_verify = enable;
1869 bool jtag_will_verify(void)
1874 void jtag_set_verify_capture_ir(bool enable)
1876 jtag_verify_capture_ir = enable;
1879 bool jtag_will_verify_capture_ir(void)
1881 return jtag_verify_capture_ir;
1884 int jtag_power_dropout(int *dropout)
1887 /* TODO: as the jtag interface is not valid all
1888 * we can do at the moment is exit OpenOCD */
1889 LOG_ERROR("No Valid JTAG Interface Configured.");
1892 if (jtag->power_dropout)
1893 return jtag->power_dropout(dropout);
1895 *dropout = 0; /* by default we can't detect power dropout */
1899 int jtag_srst_asserted(int *srst_asserted)
1901 if (jtag->srst_asserted)
1902 return jtag->srst_asserted(srst_asserted);
1904 *srst_asserted = 0; /* by default we can't detect srst asserted */
1908 enum reset_types jtag_get_reset_config(void)
1910 return jtag_reset_config;
1912 void jtag_set_reset_config(enum reset_types type)
1914 jtag_reset_config = type;
1917 int jtag_get_trst(void)
1919 return jtag_trst == 1;
1921 int jtag_get_srst(void)
1923 return jtag_srst == 1;
1926 void jtag_set_nsrst_delay(unsigned delay)
1928 adapter_nsrst_delay = delay;
1930 unsigned jtag_get_nsrst_delay(void)
1932 return adapter_nsrst_delay;
1934 void jtag_set_ntrst_delay(unsigned delay)
1936 jtag_ntrst_delay = delay;
1938 unsigned jtag_get_ntrst_delay(void)
1940 return jtag_ntrst_delay;
1944 void jtag_set_nsrst_assert_width(unsigned delay)
1946 adapter_nsrst_assert_width = delay;
1948 unsigned jtag_get_nsrst_assert_width(void)
1950 return adapter_nsrst_assert_width;
1952 void jtag_set_ntrst_assert_width(unsigned delay)
1954 jtag_ntrst_assert_width = delay;
1956 unsigned jtag_get_ntrst_assert_width(void)
1958 return jtag_ntrst_assert_width;
1961 static int jtag_select(struct command_context *ctx)
1965 /* NOTE: interface init must already have been done.
1966 * That works with only C code ... no Tcl glue required.
1969 retval = jtag_register_commands(ctx);
1971 if (retval != ERROR_OK)
1974 retval = svf_register_commands(ctx);
1976 if (retval != ERROR_OK)
1979 retval = xsvf_register_commands(ctx);
1981 if (retval != ERROR_OK)
1984 return ipdbg_register_commands(ctx);
1987 static struct transport jtag_transport = {
1989 .select = jtag_select,
1993 static void jtag_constructor(void) __attribute__((constructor));
1994 static void jtag_constructor(void)
1996 transport_register(&jtag_transport);
1999 /** Returns true if the current debug session
2000 * is using JTAG as its transport.
2002 bool transport_is_jtag(void)
2004 return get_current_transport() == &jtag_transport;
2007 int adapter_resets(int trst, int srst)
2009 if (!get_current_transport()) {
2010 LOG_ERROR("transport is not selected");
2014 if (transport_is_jtag()) {
2015 if (srst == SRST_ASSERT && !(jtag_reset_config & RESET_HAS_SRST)) {
2016 LOG_ERROR("adapter has no srst signal");
2020 /* adapters without trst signal will eventually use tlr sequence */
2021 jtag_add_reset(trst, srst);
2023 * The jtag queue is still used for reset by some adapter. Flush it!
2024 * FIXME: To be removed when all adapter drivers will be updated!
2026 jtag_execute_queue();
2028 } else if (transport_is_swd() || transport_is_hla() ||
2029 transport_is_dapdirect_swd() || transport_is_dapdirect_jtag() ||
2030 transport_is_swim()) {
2031 if (trst == TRST_ASSERT) {
2032 LOG_ERROR("transport %s has no trst signal",
2033 get_current_transport()->name);
2037 if (srst == SRST_ASSERT && !(jtag_reset_config & RESET_HAS_SRST)) {
2038 LOG_ERROR("adapter has no srst signal");
2041 adapter_system_reset(srst);
2045 if (trst == TRST_DEASSERT && srst == SRST_DEASSERT)
2048 LOG_ERROR("reset is not supported on transport %s",
2049 get_current_transport()->name);
2054 int adapter_assert_reset(void)
2056 if (transport_is_jtag()) {
2057 if (jtag_reset_config & RESET_SRST_PULLS_TRST)
2058 jtag_add_reset(1, 1);
2060 jtag_add_reset(0, 1);
2062 } else if (transport_is_swd() || transport_is_hla() ||
2063 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2064 transport_is_swim())
2065 return adapter_system_reset(1);
2066 else if (get_current_transport())
2067 LOG_ERROR("reset is not supported on %s",
2068 get_current_transport()->name);
2070 LOG_ERROR("transport is not selected");
2074 int adapter_deassert_reset(void)
2076 if (transport_is_jtag()) {
2077 jtag_add_reset(0, 0);
2079 } else if (transport_is_swd() || transport_is_hla() ||
2080 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2081 transport_is_swim())
2082 return adapter_system_reset(0);
2083 else if (get_current_transport())
2084 LOG_ERROR("reset is not supported on %s",
2085 get_current_transport()->name);
2087 LOG_ERROR("transport is not selected");
2091 int adapter_config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
2092 uint32_t port_size, unsigned int *trace_freq,
2093 unsigned int traceclkin_freq, uint16_t *prescaler)
2095 if (jtag->config_trace) {
2096 return jtag->config_trace(enabled, pin_protocol, port_size, trace_freq,
2097 traceclkin_freq, prescaler);
2098 } else if (enabled) {
2099 LOG_ERROR("The selected interface does not support tracing");
2106 int adapter_poll_trace(uint8_t *buf, size_t *size)
2108 if (jtag->poll_trace)
2109 return jtag->poll_trace(buf, size);