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;
132 /* FIXME: change name to this variable, it is not anymore JTAG only */
133 static struct adapter_driver *jtag;
135 extern struct adapter_driver *adapter_driver;
137 void jtag_set_flush_queue_sleep(int ms)
139 jtag_flush_queue_sleep = ms;
142 void jtag_set_error(int error)
144 if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
149 int jtag_error_clear(void)
151 int temp = jtag_error;
152 jtag_error = ERROR_OK;
158 static bool jtag_poll = 1;
160 bool is_jtag_poll_safe(void)
162 /* Polling can be disabled explicitly with set_enabled(false).
163 * It is also implicitly disabled while TRST is active and
164 * while SRST is gating the JTAG clock.
166 if (!transport_is_jtag())
169 if (!jtag_poll || jtag_trst != 0)
171 return jtag_srst == 0 || (jtag_reset_config & RESET_SRST_NO_GATING);
174 bool jtag_poll_get_enabled(void)
179 void jtag_poll_set_enabled(bool value)
186 struct jtag_tap *jtag_all_taps(void)
188 return __jtag_all_taps;
191 unsigned jtag_tap_count(void)
193 struct jtag_tap *t = jtag_all_taps();
202 unsigned jtag_tap_count_enabled(void)
204 struct jtag_tap *t = jtag_all_taps();
214 /** Append a new TAP to the chain of all taps. */
215 static void jtag_tap_add(struct jtag_tap *t)
217 unsigned jtag_num_taps = 0;
219 struct jtag_tap **tap = &__jtag_all_taps;
222 tap = &(*tap)->next_tap;
225 t->abs_chain_position = jtag_num_taps;
228 /* returns a pointer to the n-th device in the scan chain */
229 struct jtag_tap *jtag_tap_by_position(unsigned n)
231 struct jtag_tap *t = jtag_all_taps();
239 struct jtag_tap *jtag_tap_by_string(const char *s)
241 /* try by name first */
242 struct jtag_tap *t = jtag_all_taps();
245 if (strcmp(t->dotted_name, s) == 0)
250 /* no tap found by name, so try to parse the name as a number */
252 if (parse_uint(s, &n) != ERROR_OK)
255 /* FIXME remove this numeric fallback code late June 2010, along
256 * with all info in the User's Guide that TAPs have numeric IDs.
257 * Also update "scan_chain" output to not display the numbers.
259 t = jtag_tap_by_position(n);
261 LOG_WARNING("Specify TAP '%s' by name, not number %u",
267 struct jtag_tap *jtag_tap_next_enabled(struct jtag_tap *p)
269 p = p ? p->next_tap : jtag_all_taps();
278 const char *jtag_tap_name(const struct jtag_tap *tap)
280 return (!tap) ? "(unknown)" : tap->dotted_name;
284 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
286 struct jtag_event_callback **callbacks_p = &jtag_event_callbacks;
289 return ERROR_COMMAND_SYNTAX_ERROR;
292 while ((*callbacks_p)->next)
293 callbacks_p = &((*callbacks_p)->next);
294 callbacks_p = &((*callbacks_p)->next);
297 (*callbacks_p) = malloc(sizeof(struct jtag_event_callback));
298 (*callbacks_p)->callback = callback;
299 (*callbacks_p)->priv = priv;
300 (*callbacks_p)->next = NULL;
305 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
307 struct jtag_event_callback **p = &jtag_event_callbacks, *temp;
310 return ERROR_COMMAND_SYNTAX_ERROR;
313 if (((*p)->priv != priv) || ((*p)->callback != callback)) {
326 int jtag_call_event_callbacks(enum jtag_event event)
328 struct jtag_event_callback *callback = jtag_event_callbacks;
330 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
333 struct jtag_event_callback *next;
335 /* callback may remove itself */
336 next = callback->next;
337 callback->callback(event, callback->priv);
344 static void jtag_checks(void)
346 assert(jtag_trst == 0);
349 static void jtag_prelude(tap_state_t state)
353 assert(state != TAP_INVALID);
355 cmd_queue_cur_state = state;
358 void jtag_add_ir_scan_noverify(struct jtag_tap *active, const struct scan_field *in_fields,
363 int retval = interface_jtag_add_ir_scan(active, in_fields, state);
364 jtag_set_error(retval);
367 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap *active,
369 const struct scan_field *in_fields,
372 jtag_add_ir_scan_noverify(active, in_fields, state);
375 /* If fields->in_value is filled out, then the captured IR value will be checked */
376 void jtag_add_ir_scan(struct jtag_tap *active, struct scan_field *in_fields, tap_state_t state)
378 assert(state != TAP_RESET);
380 if (jtag_verify && jtag_verify_capture_ir) {
381 /* 8 x 32 bit id's is enough for all invocations */
383 /* if we are to run a verification of the ir scan, we need to get the input back.
384 * We may have to allocate space if the caller didn't ask for the input back.
386 in_fields->check_value = active->expected;
387 in_fields->check_mask = active->expected_mask;
388 jtag_add_scan_check(active, jtag_add_ir_scan_noverify_callback, 1, in_fields,
391 jtag_add_ir_scan_noverify(active, in_fields, state);
394 void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
398 assert(state != TAP_RESET);
402 int retval = interface_jtag_add_plain_ir_scan(
403 num_bits, out_bits, in_bits, state);
404 jtag_set_error(retval);
407 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
408 uint8_t *in_check_mask, int num_bits);
410 static int jtag_check_value_mask_callback(jtag_callback_data_t data0,
411 jtag_callback_data_t data1,
412 jtag_callback_data_t data2,
413 jtag_callback_data_t data3)
415 return jtag_check_value_inner((uint8_t *)data0,
421 static void jtag_add_scan_check(struct jtag_tap *active, void (*jtag_add_scan)(
422 struct jtag_tap *active,
424 const struct scan_field *in_fields,
426 int in_num_fields, struct scan_field *in_fields, tap_state_t state)
428 jtag_add_scan(active, in_num_fields, in_fields, state);
430 for (int i = 0; i < in_num_fields; i++) {
431 if ((in_fields[i].check_value) && (in_fields[i].in_value)) {
432 jtag_add_callback4(jtag_check_value_mask_callback,
433 (jtag_callback_data_t)in_fields[i].in_value,
434 (jtag_callback_data_t)in_fields[i].check_value,
435 (jtag_callback_data_t)in_fields[i].check_mask,
436 (jtag_callback_data_t)in_fields[i].num_bits);
441 void jtag_add_dr_scan_check(struct jtag_tap *active,
443 struct scan_field *in_fields,
447 jtag_add_scan_check(active, jtag_add_dr_scan, in_num_fields, in_fields, state);
449 jtag_add_dr_scan(active, in_num_fields, in_fields, state);
453 void jtag_add_dr_scan(struct jtag_tap *active,
455 const struct scan_field *in_fields,
458 assert(state != TAP_RESET);
463 retval = interface_jtag_add_dr_scan(active, in_num_fields, in_fields, state);
464 jtag_set_error(retval);
467 void jtag_add_plain_dr_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
471 assert(state != TAP_RESET);
476 retval = interface_jtag_add_plain_dr_scan(num_bits, out_bits, in_bits, state);
477 jtag_set_error(retval);
480 void jtag_add_tlr(void)
482 jtag_prelude(TAP_RESET);
483 jtag_set_error(interface_jtag_add_tlr());
485 /* NOTE: order here matches TRST path in jtag_add_reset() */
486 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
487 jtag_notify_event(JTAG_TRST_ASSERTED);
491 * If supported by the underlying adapter, this clocks a raw bit sequence
492 * onto TMS for switching between JTAG and SWD modes.
494 * DO NOT use this to bypass the integrity checks and logging provided
495 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
497 * @param nbits How many bits to clock out.
498 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
499 * @param state The JTAG tap state to record on completion. Use
500 * TAP_INVALID to represent being in in SWD mode.
502 * @todo Update naming conventions to stop assuming everything is JTAG.
504 int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state state)
508 if (!(jtag->jtag_ops->supported & DEBUG_CAP_TMS_SEQ))
509 return ERROR_JTAG_NOT_IMPLEMENTED;
512 cmd_queue_cur_state = state;
514 retval = interface_add_tms_seq(nbits, seq, state);
515 jtag_set_error(retval);
519 void jtag_add_pathmove(int num_states, const tap_state_t *path)
521 tap_state_t cur_state = cmd_queue_cur_state;
523 /* the last state has to be a stable state */
524 if (!tap_is_state_stable(path[num_states - 1])) {
525 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
526 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
530 for (int i = 0; i < num_states; i++) {
531 if (path[i] == TAP_RESET) {
532 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
533 jtag_set_error(ERROR_JTAG_STATE_INVALID);
537 if (tap_state_transition(cur_state, true) != path[i] &&
538 tap_state_transition(cur_state, false) != path[i]) {
539 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
540 tap_state_name(cur_state), tap_state_name(path[i]));
541 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
549 jtag_set_error(interface_jtag_add_pathmove(num_states, path));
550 cmd_queue_cur_state = path[num_states - 1];
553 int jtag_add_statemove(tap_state_t goal_state)
555 tap_state_t cur_state = cmd_queue_cur_state;
557 if (goal_state != cur_state) {
558 LOG_DEBUG("cur_state=%s goal_state=%s",
559 tap_state_name(cur_state),
560 tap_state_name(goal_state));
563 /* If goal is RESET, be paranoid and force that that transition
564 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
566 if (goal_state == TAP_RESET)
568 else if (goal_state == cur_state)
571 else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state)) {
572 unsigned tms_bits = tap_get_tms_path(cur_state, goal_state);
573 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
574 tap_state_t moves[8];
575 assert(tms_count < ARRAY_SIZE(moves));
577 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1) {
578 bool bit = tms_bits & 1;
580 cur_state = tap_state_transition(cur_state, bit);
581 moves[i] = cur_state;
584 jtag_add_pathmove(tms_count, moves);
585 } else if (tap_state_transition(cur_state, true) == goal_state
586 || tap_state_transition(cur_state, false) == goal_state)
587 jtag_add_pathmove(1, &goal_state);
594 void jtag_add_runtest(int num_cycles, tap_state_t state)
597 jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
601 void jtag_add_clocks(int num_cycles)
603 if (!tap_is_state_stable(cmd_queue_cur_state)) {
604 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
605 tap_state_name(cmd_queue_cur_state));
606 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
610 if (num_cycles > 0) {
612 jtag_set_error(interface_jtag_add_clocks(num_cycles));
616 static int adapter_system_reset(int req_srst)
621 if (!(jtag_reset_config & RESET_HAS_SRST)) {
622 LOG_ERROR("BUG: can't assert SRST");
628 /* Maybe change SRST signal state */
629 if (jtag_srst != req_srst) {
630 retval = jtag->reset(0, req_srst);
631 if (retval != ERROR_OK) {
632 LOG_ERROR("SRST error");
635 jtag_srst = req_srst;
638 LOG_DEBUG("SRST line asserted");
639 if (adapter_nsrst_assert_width)
640 jtag_sleep(adapter_nsrst_assert_width * 1000);
642 LOG_DEBUG("SRST line released");
643 if (adapter_nsrst_delay)
644 jtag_sleep(adapter_nsrst_delay * 1000);
651 static void legacy_jtag_add_reset(int req_tlr_or_trst, int req_srst)
653 int trst_with_tlr = 0;
657 /* Without SRST, we must use target-specific JTAG operations
658 * on each target; callers should not be requesting SRST when
659 * that signal doesn't exist.
661 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
662 * can kick in even if the JTAG adapter can't drive TRST.
665 if (!(jtag_reset_config & RESET_HAS_SRST)) {
666 LOG_ERROR("BUG: can't assert SRST");
667 jtag_set_error(ERROR_FAIL);
670 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
671 && !req_tlr_or_trst) {
672 LOG_ERROR("BUG: can't assert only SRST");
673 jtag_set_error(ERROR_FAIL);
679 /* JTAG reset (entry to TAP_RESET state) can always be achieved
680 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
681 * state first. TRST accelerates it, and bypasses those states.
683 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
684 * can kick in even if the JTAG adapter can't drive SRST.
686 if (req_tlr_or_trst) {
687 if (!(jtag_reset_config & RESET_HAS_TRST))
689 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
696 /* Maybe change TRST and/or SRST signal state */
697 if (jtag_srst != new_srst || jtag_trst != new_trst) {
700 retval = interface_jtag_add_reset(new_trst, new_srst);
701 if (retval != ERROR_OK)
702 jtag_set_error(retval);
704 retval = jtag_execute_queue();
706 if (retval != ERROR_OK) {
707 LOG_ERROR("TRST/SRST error");
712 /* SRST resets everything hooked up to that signal */
713 if (jtag_srst != new_srst) {
714 jtag_srst = new_srst;
716 LOG_DEBUG("SRST line asserted");
717 if (adapter_nsrst_assert_width)
718 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
720 LOG_DEBUG("SRST line released");
721 if (adapter_nsrst_delay)
722 jtag_add_sleep(adapter_nsrst_delay * 1000);
726 /* Maybe enter the JTAG TAP_RESET state ...
727 * - using only TMS, TCK, and the JTAG state machine
728 * - or else more directly, using TRST
730 * TAP_RESET should be invisible to non-debug parts of the system.
733 LOG_DEBUG("JTAG reset with TLR instead of TRST");
736 } else if (jtag_trst != new_trst) {
737 jtag_trst = new_trst;
739 LOG_DEBUG("TRST line asserted");
740 tap_set_state(TAP_RESET);
741 if (jtag_ntrst_assert_width)
742 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
744 LOG_DEBUG("TRST line released");
745 if (jtag_ntrst_delay)
746 jtag_add_sleep(jtag_ntrst_delay * 1000);
748 /* We just asserted nTRST, so we're now in TAP_RESET.
749 * Inform possible listeners about this, now that
750 * JTAG instructions and data can be shifted. This
751 * sequence must match jtag_add_tlr().
753 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
754 jtag_notify_event(JTAG_TRST_ASSERTED);
759 /* FIXME: name is misleading; we do not plan to "add" reset into jtag queue */
760 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
763 int trst_with_tlr = 0;
768 legacy_jtag_add_reset(req_tlr_or_trst, req_srst);
772 /* Without SRST, we must use target-specific JTAG operations
773 * on each target; callers should not be requesting SRST when
774 * that signal doesn't exist.
776 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
777 * can kick in even if the JTAG adapter can't drive TRST.
780 if (!(jtag_reset_config & RESET_HAS_SRST)) {
781 LOG_ERROR("BUG: can't assert SRST");
782 jtag_set_error(ERROR_FAIL);
785 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
786 && !req_tlr_or_trst) {
787 LOG_ERROR("BUG: can't assert only SRST");
788 jtag_set_error(ERROR_FAIL);
794 /* JTAG reset (entry to TAP_RESET state) can always be achieved
795 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
796 * state first. TRST accelerates it, and bypasses those states.
798 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
799 * can kick in even if the JTAG adapter can't drive SRST.
801 if (req_tlr_or_trst) {
802 if (!(jtag_reset_config & RESET_HAS_TRST))
804 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
811 /* Maybe change TRST and/or SRST signal state */
812 if (jtag_srst != new_srst || jtag_trst != new_trst) {
813 /* guarantee jtag queue empty before changing reset status */
814 jtag_execute_queue();
816 retval = jtag->reset(new_trst, new_srst);
817 if (retval != ERROR_OK) {
818 jtag_set_error(retval);
819 LOG_ERROR("TRST/SRST error");
824 /* SRST resets everything hooked up to that signal */
825 if (jtag_srst != new_srst) {
826 jtag_srst = new_srst;
828 LOG_DEBUG("SRST line asserted");
829 if (adapter_nsrst_assert_width)
830 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
832 LOG_DEBUG("SRST line released");
833 if (adapter_nsrst_delay)
834 jtag_add_sleep(adapter_nsrst_delay * 1000);
838 /* Maybe enter the JTAG TAP_RESET state ...
839 * - using only TMS, TCK, and the JTAG state machine
840 * - or else more directly, using TRST
842 * TAP_RESET should be invisible to non-debug parts of the system.
845 LOG_DEBUG("JTAG reset with TLR instead of TRST");
847 jtag_execute_queue();
849 } else if (jtag_trst != new_trst) {
850 jtag_trst = new_trst;
852 LOG_DEBUG("TRST line asserted");
853 tap_set_state(TAP_RESET);
854 if (jtag_ntrst_assert_width)
855 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
857 LOG_DEBUG("TRST line released");
858 if (jtag_ntrst_delay)
859 jtag_add_sleep(jtag_ntrst_delay * 1000);
861 /* We just asserted nTRST, so we're now in TAP_RESET.
862 * Inform possible listeners about this, now that
863 * JTAG instructions and data can be shifted. This
864 * sequence must match jtag_add_tlr().
866 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
867 jtag_notify_event(JTAG_TRST_ASSERTED);
872 void jtag_add_sleep(uint32_t us)
874 /** @todo Here, keep_alive() appears to be a layering violation!!! */
876 jtag_set_error(interface_jtag_add_sleep(us));
879 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
880 uint8_t *in_check_mask, int num_bits)
882 int retval = ERROR_OK;
886 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
888 compare_failed = buf_cmp(captured, in_check_value, num_bits);
890 if (compare_failed) {
891 char *captured_str, *in_check_value_str;
892 int bits = (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits;
894 /* NOTE: we've lost diagnostic context here -- 'which tap' */
896 captured_str = buf_to_hex_str(captured, bits);
897 in_check_value_str = buf_to_hex_str(in_check_value, bits);
899 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
901 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
904 free(in_check_value_str);
907 char *in_check_mask_str;
909 in_check_mask_str = buf_to_hex_str(in_check_mask, bits);
910 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
911 free(in_check_mask_str);
914 retval = ERROR_JTAG_QUEUE_FAILED;
919 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask)
921 assert(field->in_value);
924 /* no checking to do */
928 jtag_execute_queue_noclear();
930 int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
931 jtag_set_error(retval);
934 int default_interface_jtag_execute_queue(void)
937 LOG_ERROR("No JTAG interface configured yet. "
938 "Issue 'init' command in startup scripts "
939 "before communicating with targets.");
943 if (!transport_is_jtag()) {
945 * FIXME: This should not happen!
946 * There could be old code that queues jtag commands with non jtag interfaces so, for
947 * the moment simply highlight it by log an error and return on empty execute_queue.
948 * We should fix it quitting with assert(0) because it is an internal error.
949 * The fix can be applied immediately after next release (v0.11.0 ?)
951 LOG_ERROR("JTAG API jtag_execute_queue() called on non JTAG interface");
952 if (!jtag->jtag_ops || !jtag->jtag_ops->execute_queue)
956 int result = jtag->jtag_ops->execute_queue();
958 struct jtag_command *cmd = jtag_command_queue;
959 while (debug_level >= LOG_LVL_DEBUG_IO && cmd) {
962 LOG_DEBUG_IO("JTAG %s SCAN to %s",
963 cmd->cmd.scan->ir_scan ? "IR" : "DR",
964 tap_state_name(cmd->cmd.scan->end_state));
965 for (int i = 0; i < cmd->cmd.scan->num_fields; i++) {
966 struct scan_field *field = cmd->cmd.scan->fields + i;
967 if (field->out_value) {
968 char *str = buf_to_hex_str(field->out_value, field->num_bits);
969 LOG_DEBUG_IO(" %db out: %s", field->num_bits, str);
972 if (field->in_value) {
973 char *str = buf_to_hex_str(field->in_value, field->num_bits);
974 LOG_DEBUG_IO(" %db in: %s", field->num_bits, str);
980 LOG_DEBUG_IO("JTAG TLR RESET to %s",
981 tap_state_name(cmd->cmd.statemove->end_state));
984 LOG_DEBUG_IO("JTAG RUNTEST %d cycles to %s",
985 cmd->cmd.runtest->num_cycles,
986 tap_state_name(cmd->cmd.runtest->end_state));
990 const char *reset_str[3] = {
991 "leave", "deassert", "assert"
993 LOG_DEBUG_IO("JTAG RESET %s TRST, %s SRST",
994 reset_str[cmd->cmd.reset->trst + 1],
995 reset_str[cmd->cmd.reset->srst + 1]);
999 LOG_DEBUG_IO("JTAG PATHMOVE (TODO)");
1002 LOG_DEBUG_IO("JTAG SLEEP (TODO)");
1004 case JTAG_STABLECLOCKS:
1005 LOG_DEBUG_IO("JTAG STABLECLOCKS (TODO)");
1008 LOG_DEBUG_IO("JTAG TMS (TODO)");
1011 LOG_ERROR("Unknown JTAG command: %d", cmd->type);
1020 void jtag_execute_queue_noclear(void)
1022 jtag_flush_queue_count++;
1023 jtag_set_error(interface_jtag_execute_queue());
1025 if (jtag_flush_queue_sleep > 0) {
1026 /* For debug purposes it can be useful to test performance
1027 * or behavior when delaying after flushing the queue,
1028 * e.g. to simulate long roundtrip times.
1030 usleep(jtag_flush_queue_sleep * 1000);
1034 int jtag_get_flush_queue_count(void)
1036 return jtag_flush_queue_count;
1039 int jtag_execute_queue(void)
1041 jtag_execute_queue_noclear();
1042 return jtag_error_clear();
1045 static int jtag_reset_callback(enum jtag_event event, void *priv)
1047 struct jtag_tap *tap = priv;
1049 if (event == JTAG_TRST_ASSERTED) {
1050 tap->enabled = !tap->disabled_after_reset;
1052 /* current instruction is either BYPASS or IDCODE */
1053 buf_set_ones(tap->cur_instr, tap->ir_length);
1060 /* sleep at least us microseconds. When we sleep more than 1000ms we
1061 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
1062 * GDB if we slept for <1000ms many times.
1064 void jtag_sleep(uint32_t us)
1069 alive_sleep((us+999)/1000);
1072 #define JTAG_MAX_AUTO_TAPS 20
1074 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1075 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1076 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1078 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
1079 * know that no valid TAP will have it as an IDCODE value.
1081 #define END_OF_CHAIN_FLAG 0xffffffff
1083 /* a larger IR length than we ever expect to autoprobe */
1084 #define JTAG_IRLEN_MAX 60
1086 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
1088 struct scan_field field = {
1089 .num_bits = num_idcode * 32,
1090 .out_value = idcode_buffer,
1091 .in_value = idcode_buffer,
1094 /* initialize to the end of chain ID value */
1095 for (unsigned i = 0; i < num_idcode; i++)
1096 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
1098 jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, TAP_DRPAUSE);
1100 return jtag_execute_queue();
1103 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
1105 uint8_t zero_check = 0x0;
1106 uint8_t one_check = 0xff;
1108 for (unsigned i = 0; i < count * 4; i++) {
1109 zero_check |= idcodes[i];
1110 one_check &= idcodes[i];
1113 /* if there wasn't a single non-zero bit or if all bits were one,
1114 * the scan is not valid. We wrote a mix of both values; either
1116 * - There's a hardware issue (almost certainly):
1117 * + all-zeroes can mean a target stuck in JTAG reset
1118 * + all-ones tends to mean no target
1119 * - The scan chain is WAY longer than we can handle, *AND* either
1120 * + there are several hundreds of TAPs in bypass, or
1121 * + at least a few dozen TAPs all have an all-ones IDCODE
1123 if (zero_check == 0x00 || one_check == 0xff) {
1124 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
1125 (zero_check == 0x00) ? "zeroes" : "ones");
1126 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
1132 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
1133 const char *name, uint32_t idcode)
1135 log_printf_lf(level, __FILE__, __LINE__, __func__,
1136 "JTAG tap: %s %16.16s: 0x%08x "
1137 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
1139 (unsigned int)idcode,
1140 (unsigned int)EXTRACT_MFG(idcode),
1141 jep106_manufacturer(EXTRACT_MFG(idcode)),
1142 (unsigned int)EXTRACT_PART(idcode),
1143 (unsigned int)EXTRACT_VER(idcode));
1146 static bool jtag_idcode_is_final(uint32_t idcode)
1149 * Some devices, such as AVR8, will output all 1's instead
1150 * of TDI input value at end of chain. Allow those values
1151 * instead of failing.
1153 return idcode == END_OF_CHAIN_FLAG;
1157 * This helper checks that remaining bits in the examined chain data are
1158 * all as expected, but a single JTAG device requires only 64 bits to be
1159 * read back correctly. This can help identify and diagnose problems
1160 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1161 * Returns TRUE iff garbage was found.
1163 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
1165 bool triggered = false;
1166 for (; count < max - 31; count += 32) {
1167 uint32_t idcode = buf_get_u32(idcodes, count, 32);
1169 /* do not trigger the warning if the data looks good */
1170 if (jtag_idcode_is_final(idcode))
1172 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1173 count, (unsigned int)idcode);
1179 static bool jtag_examine_chain_match_tap(const struct jtag_tap *tap)
1182 if (tap->expected_ids_cnt == 0 || !tap->hasidcode)
1185 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1186 uint32_t mask = tap->ignore_version ? ~(0xfU << 28) : ~0U;
1187 uint32_t idcode = tap->idcode & mask;
1189 /* Loop over the expected identification codes and test for a match */
1190 for (unsigned ii = 0; ii < tap->expected_ids_cnt; ii++) {
1191 uint32_t expected = tap->expected_ids[ii] & mask;
1193 if (idcode == expected)
1196 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1197 if (tap->expected_ids[ii] == 0)
1201 /* If none of the expected ids matched, warn */
1202 jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
1203 tap->dotted_name, tap->idcode);
1204 for (unsigned ii = 0; ii < tap->expected_ids_cnt; ii++) {
1207 snprintf(msg, sizeof(msg), "expected %u of %u", ii + 1, tap->expected_ids_cnt);
1208 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
1209 tap->dotted_name, tap->expected_ids[ii]);
1214 /* Try to examine chain layout according to IEEE 1149.1 §12
1215 * This is called a "blind interrogation" of the scan chain.
1217 static int jtag_examine_chain(void)
1220 unsigned max_taps = jtag_tap_count();
1222 /* Autoprobe up to this many. */
1223 if (max_taps < JTAG_MAX_AUTO_TAPS)
1224 max_taps = JTAG_MAX_AUTO_TAPS;
1226 /* Add room for end-of-chain marker. */
1229 uint8_t *idcode_buffer = calloc(4, max_taps);
1231 return ERROR_JTAG_INIT_FAILED;
1233 /* DR scan to collect BYPASS or IDCODE register contents.
1234 * Then make sure the scan data has both ones and zeroes.
1236 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1237 retval = jtag_examine_chain_execute(idcode_buffer, max_taps);
1238 if (retval != ERROR_OK)
1240 if (!jtag_examine_chain_check(idcode_buffer, max_taps)) {
1241 retval = ERROR_JTAG_INIT_FAILED;
1245 /* Point at the 1st predefined tap, if any */
1246 struct jtag_tap *tap = jtag_tap_next_enabled(NULL);
1248 unsigned bit_count = 0;
1249 unsigned autocount = 0;
1250 for (unsigned i = 0; i < max_taps; i++) {
1251 assert(bit_count < max_taps * 32);
1252 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1254 /* No predefined TAP? Auto-probe. */
1256 /* Is there another TAP? */
1257 if (jtag_idcode_is_final(idcode))
1260 /* Default everything in this TAP except IR length.
1262 * REVISIT create a jtag_alloc(chip, tap) routine, and
1263 * share it with jim_newtap_cmd().
1265 tap = calloc(1, sizeof(*tap));
1267 retval = ERROR_FAIL;
1271 tap->chip = alloc_printf("auto%u", autocount++);
1272 tap->tapname = strdup("tap");
1273 tap->dotted_name = alloc_printf("%s.%s", tap->chip, tap->tapname);
1275 tap->ir_length = 0; /* ... signifying irlen autoprobe */
1276 tap->ir_capture_mask = 0x03;
1277 tap->ir_capture_value = 0x01;
1279 tap->enabled = true;
1284 if ((idcode & 1) == 0) {
1285 /* Zero for LSB indicates a device in bypass */
1286 LOG_INFO("TAP %s does not have valid IDCODE (idcode=0x%" PRIx32 ")",
1287 tap->dotted_name, idcode);
1288 tap->hasidcode = false;
1293 /* Friendly devices support IDCODE */
1294 tap->hasidcode = true;
1295 tap->idcode = idcode;
1296 jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found", tap->dotted_name, idcode);
1301 /* ensure the TAP ID matches what was expected */
1302 if (!jtag_examine_chain_match_tap(tap))
1303 retval = ERROR_JTAG_INIT_SOFT_FAIL;
1305 tap = jtag_tap_next_enabled(tap);
1308 /* After those IDCODE or BYPASS register values should be
1309 * only the data we fed into the scan chain.
1311 if (jtag_examine_chain_end(idcode_buffer, bit_count, max_taps * 32)) {
1312 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1313 retval = ERROR_JTAG_INIT_FAILED;
1317 /* Return success or, for backwards compatibility if only
1318 * some IDCODE values mismatched, a soft/continuable fault.
1321 free(idcode_buffer);
1326 * Validate the date loaded by entry to the Capture-IR state, to help
1327 * find errors related to scan chain configuration (wrong IR lengths)
1330 * Entry state can be anything. On non-error exit, all TAPs are in
1331 * bypass mode. On error exits, the scan chain is reset.
1333 static int jtag_validate_ircapture(void)
1335 struct jtag_tap *tap;
1336 uint8_t *ir_test = NULL;
1337 struct scan_field field;
1341 /* when autoprobing, accommodate huge IR lengths */
1342 int total_ir_length = 0;
1343 for (tap = jtag_tap_next_enabled(NULL); tap; tap = jtag_tap_next_enabled(tap)) {
1344 if (tap->ir_length == 0)
1345 total_ir_length += JTAG_IRLEN_MAX;
1347 total_ir_length += tap->ir_length;
1350 /* increase length to add 2 bit sentinel after scan */
1351 total_ir_length += 2;
1353 ir_test = malloc(DIV_ROUND_UP(total_ir_length, 8));
1357 /* after this scan, all TAPs will capture BYPASS instructions */
1358 buf_set_ones(ir_test, total_ir_length);
1360 field.num_bits = total_ir_length;
1361 field.out_value = ir_test;
1362 field.in_value = ir_test;
1364 jtag_add_plain_ir_scan(field.num_bits, field.out_value, field.in_value, TAP_IDLE);
1366 LOG_DEBUG("IR capture validation scan");
1367 retval = jtag_execute_queue();
1368 if (retval != ERROR_OK)
1375 tap = jtag_tap_next_enabled(tap);
1379 /* If we're autoprobing, guess IR lengths. They must be at
1380 * least two bits. Guessing will fail if (a) any TAP does
1381 * not conform to the JTAG spec; or (b) when the upper bits
1382 * captured from some conforming TAP are nonzero. Or if
1383 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1384 * an implementation limit, which could someday be raised.
1386 * REVISIT optimization: if there's a *single* TAP we can
1387 * lift restrictions (a) and (b) by scanning a recognizable
1388 * pattern before the all-ones BYPASS. Check for where the
1389 * pattern starts in the result, instead of an 0...01 value.
1391 * REVISIT alternative approach: escape to some tcl code
1392 * which could provide more knowledge, based on IDCODE; and
1393 * only guess when that has no success.
1395 if (tap->ir_length == 0) {
1397 while (buf_get_u64(ir_test, chain_pos, tap->ir_length + 1) == 1
1398 && tap->ir_length < JTAG_IRLEN_MAX) {
1401 LOG_WARNING("AUTO %s - use \"jtag newtap %s %s -irlen %d "
1402 "-expected-id 0x%08" PRIx32 "\"",
1403 tap->dotted_name, tap->chip, tap->tapname, tap->ir_length, tap->idcode);
1406 /* Validate the two LSBs, which must be 01 per JTAG spec.
1408 * Or ... more bits could be provided by TAP declaration.
1409 * Plus, some taps (notably in i.MX series chips) violate
1410 * this part of the JTAG spec, so their capture mask/value
1411 * attributes might disable this test.
1413 uint64_t val = buf_get_u64(ir_test, chain_pos, tap->ir_length);
1414 if ((val & tap->ir_capture_mask) != tap->ir_capture_value) {
1415 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64 " not 0x%0*" PRIx32,
1417 (tap->ir_length + 7) / tap->ir_length, val,
1418 (tap->ir_length + 7) / tap->ir_length, tap->ir_capture_value);
1420 retval = ERROR_JTAG_INIT_FAILED;
1423 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64, jtag_tap_name(tap),
1424 (tap->ir_length + 7) / tap->ir_length, val);
1425 chain_pos += tap->ir_length;
1428 /* verify the '11' sentinel we wrote is returned at the end */
1429 uint64_t val = buf_get_u64(ir_test, chain_pos, 2);
1431 char *cbuf = buf_to_hex_str(ir_test, total_ir_length);
1433 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1436 retval = ERROR_JTAG_INIT_FAILED;
1441 if (retval != ERROR_OK) {
1443 jtag_execute_queue();
1448 void jtag_tap_init(struct jtag_tap *tap)
1450 unsigned ir_len_bits;
1451 unsigned ir_len_bytes;
1453 /* if we're autoprobing, cope with potentially huge ir_length */
1454 ir_len_bits = tap->ir_length ? tap->ir_length : JTAG_IRLEN_MAX;
1455 ir_len_bytes = DIV_ROUND_UP(ir_len_bits, 8);
1457 tap->expected = calloc(1, ir_len_bytes);
1458 tap->expected_mask = calloc(1, ir_len_bytes);
1459 tap->cur_instr = malloc(ir_len_bytes);
1461 /** @todo cope better with ir_length bigger than 32 bits */
1462 if (ir_len_bits > 32)
1465 buf_set_u32(tap->expected, 0, ir_len_bits, tap->ir_capture_value);
1466 buf_set_u32(tap->expected_mask, 0, ir_len_bits, tap->ir_capture_mask);
1468 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1470 buf_set_ones(tap->cur_instr, tap->ir_length);
1472 /* register the reset callback for the TAP */
1473 jtag_register_event_callback(&jtag_reset_callback, tap);
1476 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1477 "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1478 tap->abs_chain_position, tap->ir_length,
1479 (unsigned) tap->ir_capture_value,
1480 (unsigned) tap->ir_capture_mask);
1483 void jtag_tap_free(struct jtag_tap *tap)
1485 jtag_unregister_event_callback(&jtag_reset_callback, tap);
1487 struct jtag_tap_event_action *jteap = tap->event_action;
1489 struct jtag_tap_event_action *next = jteap->next;
1490 Jim_DecrRefCount(jteap->interp, jteap->body);
1495 free(tap->expected);
1496 free(tap->expected_mask);
1497 free(tap->expected_ids);
1498 free(tap->cur_instr);
1501 free(tap->dotted_name);
1506 * Do low-level setup like initializing registers, output signals,
1509 int adapter_init(struct command_context *cmd_ctx)
1514 if (!adapter_driver) {
1515 /* nothing was previously specified by "adapter driver" command */
1516 LOG_ERROR("Debug Adapter has to be specified, "
1517 "see \"adapter driver\" command");
1518 return ERROR_JTAG_INVALID_INTERFACE;
1522 retval = adapter_driver->init();
1523 if (retval != ERROR_OK)
1525 jtag = adapter_driver;
1528 LOG_INFO("This adapter doesn't support configurable speed");
1532 if (clock_mode == CLOCK_MODE_UNSELECTED) {
1533 LOG_ERROR("An adapter speed is not selected in the init script."
1534 " Insert a call to \"adapter speed\" or \"jtag_rclk\" to proceed.");
1535 return ERROR_JTAG_INIT_FAILED;
1538 int requested_khz = jtag_get_speed_khz();
1539 int actual_khz = requested_khz;
1540 int jtag_speed_var = 0;
1541 retval = jtag_get_speed(&jtag_speed_var);
1542 if (retval != ERROR_OK)
1544 retval = jtag->speed(jtag_speed_var);
1545 if (retval != ERROR_OK)
1547 retval = jtag_get_speed_readable(&actual_khz);
1548 if (retval != ERROR_OK)
1549 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var);
1550 else if (actual_khz) {
1551 /* Adaptive clocking -- JTAG-specific */
1552 if ((clock_mode == CLOCK_MODE_RCLK)
1553 || ((clock_mode == CLOCK_MODE_KHZ) && !requested_khz)) {
1554 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1557 LOG_INFO("clock speed %d kHz", actual_khz);
1559 LOG_INFO("RCLK (adaptive clock speed)");
1564 int jtag_init_inner(struct command_context *cmd_ctx)
1566 struct jtag_tap *tap;
1568 bool issue_setup = true;
1570 LOG_DEBUG("Init JTAG chain");
1572 tap = jtag_tap_next_enabled(NULL);
1574 /* Once JTAG itself is properly set up, and the scan chain
1575 * isn't absurdly large, IDCODE autoprobe should work fine.
1577 * But ... IRLEN autoprobe can fail even on systems which
1578 * are fully conformant to JTAG. Also, JTAG setup can be
1579 * quite finicky on some systems.
1581 * REVISIT: if TAP autoprobe works OK, then in many cases
1582 * we could escape to tcl code and set up targets based on
1583 * the TAP's IDCODE values.
1585 LOG_WARNING("There are no enabled taps. "
1586 "AUTO PROBING MIGHT NOT WORK!!");
1588 /* REVISIT default clock will often be too fast ... */
1592 retval = jtag_execute_queue();
1593 if (retval != ERROR_OK)
1596 /* Examine DR values first. This discovers problems which will
1597 * prevent communication ... hardware issues like TDO stuck, or
1598 * configuring the wrong number of (enabled) TAPs.
1600 retval = jtag_examine_chain();
1603 /* complete success */
1606 /* For backward compatibility reasons, try coping with
1607 * configuration errors involving only ID mismatches.
1608 * We might be able to talk to the devices.
1610 * Also the device might be powered down during startup.
1612 * After OpenOCD starts, we can try to power on the device
1615 LOG_ERROR("Trying to use configured scan chain anyway...");
1616 issue_setup = false;
1620 /* Now look at IR values. Problems here will prevent real
1621 * communication. They mostly mean that the IR length is
1622 * wrong ... or that the IR capture value is wrong. (The
1623 * latter is uncommon, but easily worked around: provide
1624 * ircapture/irmask values during TAP setup.)
1626 retval = jtag_validate_ircapture();
1627 if (retval != ERROR_OK) {
1628 /* The target might be powered down. The user
1629 * can power it up and reset it after firing
1632 issue_setup = false;
1636 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1638 LOG_WARNING("Bypassing JTAG setup events due to errors");
1644 int adapter_quit(void)
1646 if (jtag && jtag->quit) {
1647 /* close the JTAG interface */
1648 int result = jtag->quit();
1649 if (result != ERROR_OK)
1650 LOG_ERROR("failed: %d", result);
1653 struct jtag_tap *t = jtag_all_taps();
1655 struct jtag_tap *n = t->next_tap;
1663 int swd_init_reset(struct command_context *cmd_ctx)
1665 int retval, retval1;
1667 retval = adapter_init(cmd_ctx);
1668 if (retval != ERROR_OK)
1671 LOG_DEBUG("Initializing with hard SRST reset");
1673 if (jtag_reset_config & RESET_HAS_SRST)
1674 retval = adapter_system_reset(1);
1675 retval1 = adapter_system_reset(0);
1677 return (retval == ERROR_OK) ? retval1 : retval;
1680 int jtag_init_reset(struct command_context *cmd_ctx)
1682 int retval = adapter_init(cmd_ctx);
1683 if (retval != ERROR_OK)
1686 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1689 * This procedure is used by default when OpenOCD triggers a reset.
1690 * It's now done through an overridable Tcl "init_reset" wrapper.
1692 * This started out as a more powerful "get JTAG working" reset than
1693 * jtag_init_inner(), applying TRST because some chips won't activate
1694 * JTAG without a TRST cycle (presumed to be async, though some of
1695 * those chips synchronize JTAG activation using TCK).
1697 * But some chips only activate JTAG as part of an SRST cycle; SRST
1698 * got mixed in. So it became a hard reset routine, which got used
1699 * in more places, and which coped with JTAG reset being forced as
1700 * part of SRST (srst_pulls_trst).
1702 * And even more corner cases started to surface: TRST and/or SRST
1703 * assertion timings matter; some chips need other JTAG operations;
1704 * TRST/SRST sequences can need to be different from these, etc.
1706 * Systems should override that wrapper to support system-specific
1707 * requirements that this not-fully-generic code doesn't handle.
1709 * REVISIT once Tcl code can read the reset_config modes, this won't
1710 * need to be a C routine at all...
1712 if (jtag_reset_config & RESET_HAS_SRST) {
1713 jtag_add_reset(1, 1);
1714 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1715 jtag_add_reset(0, 1);
1717 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1720 /* some targets enable us to connect with srst asserted */
1721 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
1722 if (jtag_reset_config & RESET_SRST_NO_GATING)
1723 jtag_add_reset(0, 1);
1725 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1726 jtag_add_reset(0, 0);
1729 jtag_add_reset(0, 0);
1730 retval = jtag_execute_queue();
1731 if (retval != ERROR_OK)
1734 /* Check that we can communication on the JTAG chain + eventually we want to
1735 * be able to perform enumeration only after OpenOCD has started
1736 * telnet and GDB server
1738 * That would allow users to more easily perform any magic they need to before
1741 return jtag_init_inner(cmd_ctx);
1744 int jtag_init(struct command_context *cmd_ctx)
1746 int retval = adapter_init(cmd_ctx);
1747 if (retval != ERROR_OK)
1750 /* guard against oddball hardware: force resets to be inactive */
1751 jtag_add_reset(0, 0);
1753 /* some targets enable us to connect with srst asserted */
1754 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
1755 if (jtag_reset_config & RESET_SRST_NO_GATING)
1756 jtag_add_reset(0, 1);
1758 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1760 retval = jtag_execute_queue();
1761 if (retval != ERROR_OK)
1764 if (Jim_Eval_Named(cmd_ctx->interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1770 unsigned jtag_get_speed_khz(void)
1775 static int adapter_khz_to_speed(unsigned khz, int *speed)
1777 LOG_DEBUG("convert khz to interface specific speed value");
1781 LOG_DEBUG("have interface set up");
1783 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1787 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1788 if (retval != ERROR_OK)
1790 *speed = speed_div1;
1794 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int *speed)
1796 int retval = adapter_khz_to_speed(0, speed);
1797 if ((retval != ERROR_OK) && fallback_speed_khz) {
1798 LOG_DEBUG("trying fallback speed...");
1799 retval = adapter_khz_to_speed(fallback_speed_khz, speed);
1804 static int jtag_set_speed(int speed)
1806 /* this command can be called during CONFIG,
1807 * in which case jtag isn't initialized */
1808 return jtag ? jtag->speed(speed) : ERROR_OK;
1811 int jtag_config_khz(unsigned khz)
1813 LOG_DEBUG("handle jtag khz");
1814 clock_mode = CLOCK_MODE_KHZ;
1816 int retval = adapter_khz_to_speed(khz, &speed);
1817 return (retval != ERROR_OK) ? retval : jtag_set_speed(speed);
1820 int jtag_config_rclk(unsigned fallback_speed_khz)
1822 LOG_DEBUG("handle jtag rclk");
1823 clock_mode = CLOCK_MODE_RCLK;
1824 rclk_fallback_speed_khz = fallback_speed_khz;
1826 int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1827 return (retval != ERROR_OK) ? retval : jtag_set_speed(speed);
1830 int jtag_get_speed(int *speed)
1832 switch (clock_mode) {
1833 case CLOCK_MODE_KHZ:
1834 adapter_khz_to_speed(jtag_get_speed_khz(), speed);
1836 case CLOCK_MODE_RCLK:
1837 jtag_rclk_to_speed(rclk_fallback_speed_khz, speed);
1840 LOG_ERROR("BUG: unknown jtag clock mode");
1846 int jtag_get_speed_readable(int *khz)
1848 int jtag_speed_var = 0;
1849 int retval = jtag_get_speed(&jtag_speed_var);
1850 if (retval != ERROR_OK)
1854 if (!jtag->speed_div) {
1855 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1858 return jtag->speed_div(jtag_speed_var, khz);
1861 void jtag_set_verify(bool enable)
1863 jtag_verify = enable;
1866 bool jtag_will_verify(void)
1871 void jtag_set_verify_capture_ir(bool enable)
1873 jtag_verify_capture_ir = enable;
1876 bool jtag_will_verify_capture_ir(void)
1878 return jtag_verify_capture_ir;
1881 int jtag_power_dropout(int *dropout)
1884 /* TODO: as the jtag interface is not valid all
1885 * we can do at the moment is exit OpenOCD */
1886 LOG_ERROR("No Valid JTAG Interface Configured.");
1889 if (jtag->power_dropout)
1890 return jtag->power_dropout(dropout);
1892 *dropout = 0; /* by default we can't detect power dropout */
1896 int jtag_srst_asserted(int *srst_asserted)
1898 if (jtag->srst_asserted)
1899 return jtag->srst_asserted(srst_asserted);
1901 *srst_asserted = 0; /* by default we can't detect srst asserted */
1905 enum reset_types jtag_get_reset_config(void)
1907 return jtag_reset_config;
1909 void jtag_set_reset_config(enum reset_types type)
1911 jtag_reset_config = type;
1914 int jtag_get_trst(void)
1916 return jtag_trst == 1;
1918 int jtag_get_srst(void)
1920 return jtag_srst == 1;
1923 void jtag_set_nsrst_delay(unsigned delay)
1925 adapter_nsrst_delay = delay;
1927 unsigned jtag_get_nsrst_delay(void)
1929 return adapter_nsrst_delay;
1931 void jtag_set_ntrst_delay(unsigned delay)
1933 jtag_ntrst_delay = delay;
1935 unsigned jtag_get_ntrst_delay(void)
1937 return jtag_ntrst_delay;
1941 void jtag_set_nsrst_assert_width(unsigned delay)
1943 adapter_nsrst_assert_width = delay;
1945 unsigned jtag_get_nsrst_assert_width(void)
1947 return adapter_nsrst_assert_width;
1949 void jtag_set_ntrst_assert_width(unsigned delay)
1951 jtag_ntrst_assert_width = delay;
1953 unsigned jtag_get_ntrst_assert_width(void)
1955 return jtag_ntrst_assert_width;
1958 static int jtag_select(struct command_context *ctx)
1962 /* NOTE: interface init must already have been done.
1963 * That works with only C code ... no Tcl glue required.
1966 retval = jtag_register_commands(ctx);
1968 if (retval != ERROR_OK)
1971 retval = svf_register_commands(ctx);
1973 if (retval != ERROR_OK)
1976 retval = xsvf_register_commands(ctx);
1978 if (retval != ERROR_OK)
1981 return ipdbg_register_commands(ctx);
1984 static struct transport jtag_transport = {
1986 .select = jtag_select,
1990 static void jtag_constructor(void) __attribute__((constructor));
1991 static void jtag_constructor(void)
1993 transport_register(&jtag_transport);
1996 /** Returns true if the current debug session
1997 * is using JTAG as its transport.
1999 bool transport_is_jtag(void)
2001 return get_current_transport() == &jtag_transport;
2004 int adapter_resets(int trst, int srst)
2006 if (!get_current_transport()) {
2007 LOG_ERROR("transport is not selected");
2011 if (transport_is_jtag()) {
2012 if (srst == SRST_ASSERT && !(jtag_reset_config & RESET_HAS_SRST)) {
2013 LOG_ERROR("adapter has no srst signal");
2017 /* adapters without trst signal will eventually use tlr sequence */
2018 jtag_add_reset(trst, srst);
2020 * The jtag queue is still used for reset by some adapter. Flush it!
2021 * FIXME: To be removed when all adapter drivers will be updated!
2023 jtag_execute_queue();
2025 } else if (transport_is_swd() || transport_is_hla() ||
2026 transport_is_dapdirect_swd() || transport_is_dapdirect_jtag() ||
2027 transport_is_swim()) {
2028 if (trst == TRST_ASSERT) {
2029 LOG_ERROR("transport %s has no trst signal",
2030 get_current_transport()->name);
2034 if (srst == SRST_ASSERT && !(jtag_reset_config & RESET_HAS_SRST)) {
2035 LOG_ERROR("adapter has no srst signal");
2038 adapter_system_reset(srst);
2042 if (trst == TRST_DEASSERT && srst == SRST_DEASSERT)
2045 LOG_ERROR("reset is not supported on transport %s",
2046 get_current_transport()->name);
2051 int adapter_assert_reset(void)
2053 if (transport_is_jtag()) {
2054 if (jtag_reset_config & RESET_SRST_PULLS_TRST)
2055 jtag_add_reset(1, 1);
2057 jtag_add_reset(0, 1);
2059 } else if (transport_is_swd() || transport_is_hla() ||
2060 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2061 transport_is_swim())
2062 return adapter_system_reset(1);
2063 else if (get_current_transport())
2064 LOG_ERROR("reset is not supported on %s",
2065 get_current_transport()->name);
2067 LOG_ERROR("transport is not selected");
2071 int adapter_deassert_reset(void)
2073 if (transport_is_jtag()) {
2074 jtag_add_reset(0, 0);
2076 } else if (transport_is_swd() || transport_is_hla() ||
2077 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2078 transport_is_swim())
2079 return adapter_system_reset(0);
2080 else if (get_current_transport())
2081 LOG_ERROR("reset is not supported on %s",
2082 get_current_transport()->name);
2084 LOG_ERROR("transport is not selected");
2088 int adapter_config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
2089 uint32_t port_size, unsigned int *trace_freq,
2090 unsigned int traceclkin_freq, uint16_t *prescaler)
2092 if (jtag->config_trace) {
2093 return jtag->config_trace(enabled, pin_protocol, port_size, trace_freq,
2094 traceclkin_freq, prescaler);
2095 } else if (enabled) {
2096 LOG_ERROR("The selected interface does not support tracing");
2103 int adapter_poll_trace(uint8_t *buf, size_t *size)
2105 if (jtag->poll_trace)
2106 return jtag->poll_trace(buf, size);