1 /***************************************************************************
2 * Copyright (C) 2009 Zachary T Welch *
3 * zw@superlucidity.net *
5 * Copyright (C) 2007,2008,2009 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2005 by Dominic Rath *
13 * Dominic.Rath@gmx.de *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
27 ***************************************************************************/
35 #include "interface.h"
36 #include <transport/transport.h>
37 #include <helper/jep106.h>
43 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
45 #include "xsvf/xsvf.h"
47 /** The number of JTAG queue flushes (for profiling and debugging purposes). */
48 static int jtag_flush_queue_count;
50 /* Sleep this # of ms after flushing the queue */
51 static int jtag_flush_queue_sleep;
53 static void jtag_add_scan_check(struct jtag_tap *active,
54 void (*jtag_add_scan)(struct jtag_tap *active,
56 const struct scan_field *in_fields,
58 int in_num_fields, struct scan_field *in_fields, tap_state_t state);
61 * The jtag_error variable is set when an error occurs while executing
62 * the queue. Application code may set this using jtag_set_error(),
63 * when an error occurs during processing that should be reported during
64 * jtag_execute_queue().
66 * The value is set and cleared, but never read by normal application code.
68 * This value is returned (and cleared) by jtag_execute_queue().
70 static int jtag_error = ERROR_OK;
72 static const char *jtag_event_strings[] = {
73 [JTAG_TRST_ASSERTED] = "TAP reset",
74 [JTAG_TAP_EVENT_SETUP] = "TAP setup",
75 [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
76 [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
80 * JTAG adapters must initialize with TRST and SRST de-asserted
81 * (they're negative logic, so that means *high*). But some
82 * hardware doesn't necessarily work that way ... so set things
83 * up so that jtag_init() always forces that state.
85 static int jtag_trst = -1;
86 static int jtag_srst = -1;
89 * List all TAPs that have been created.
91 static struct jtag_tap *__jtag_all_taps;
93 static enum reset_types jtag_reset_config = RESET_NONE;
94 tap_state_t cmd_queue_cur_state = TAP_RESET;
96 static bool jtag_verify_capture_ir = true;
97 static int jtag_verify = 1;
99 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines
100 *deasserted (in ms) */
101 static int adapter_nsrst_delay; /* default to no nSRST delay */
102 static int jtag_ntrst_delay;/* default to no nTRST delay */
103 static int adapter_nsrst_assert_width; /* width of assertion */
104 static int jtag_ntrst_assert_width; /* width of assertion */
107 * Contains a single callback along with a pointer that will be passed
108 * when an event occurs.
110 struct jtag_event_callback {
111 /** a event callback */
112 jtag_event_handler_t callback;
113 /** the private data to pass to the callback */
115 /** the next callback */
116 struct jtag_event_callback *next;
119 /* callbacks to inform high-level handlers about JTAG state changes */
120 static struct jtag_event_callback *jtag_event_callbacks;
123 static int speed_khz;
124 /* speed to fallback to when RCLK is requested but not supported */
125 static int rclk_fallback_speed_khz;
126 static enum {CLOCK_MODE_UNSELECTED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
127 static int jtag_speed;
129 /* FIXME: change name to this variable, it is not anymore JTAG only */
130 static struct adapter_driver *jtag;
132 extern struct adapter_driver *adapter_driver;
134 void jtag_set_flush_queue_sleep(int ms)
136 jtag_flush_queue_sleep = ms;
139 void jtag_set_error(int error)
141 if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
146 int jtag_error_clear(void)
148 int temp = jtag_error;
149 jtag_error = ERROR_OK;
155 static bool jtag_poll = 1;
157 bool is_jtag_poll_safe(void)
159 /* Polling can be disabled explicitly with set_enabled(false).
160 * It is also implicitly disabled while TRST is active and
161 * while SRST is gating the JTAG clock.
163 if (!transport_is_jtag())
166 if (!jtag_poll || jtag_trst != 0)
168 return jtag_srst == 0 || (jtag_reset_config & RESET_SRST_NO_GATING);
171 bool jtag_poll_get_enabled(void)
176 void jtag_poll_set_enabled(bool value)
183 struct jtag_tap *jtag_all_taps(void)
185 return __jtag_all_taps;
188 unsigned jtag_tap_count(void)
190 struct jtag_tap *t = jtag_all_taps();
199 unsigned jtag_tap_count_enabled(void)
201 struct jtag_tap *t = jtag_all_taps();
211 /** Append a new TAP to the chain of all taps. */
212 void jtag_tap_add(struct jtag_tap *t)
214 unsigned jtag_num_taps = 0;
216 struct jtag_tap **tap = &__jtag_all_taps;
217 while (*tap != NULL) {
219 tap = &(*tap)->next_tap;
222 t->abs_chain_position = jtag_num_taps;
225 /* returns a pointer to the n-th device in the scan chain */
226 struct jtag_tap *jtag_tap_by_position(unsigned n)
228 struct jtag_tap *t = jtag_all_taps();
236 struct jtag_tap *jtag_tap_by_string(const char *s)
238 /* try by name first */
239 struct jtag_tap *t = jtag_all_taps();
242 if (0 == strcmp(t->dotted_name, s))
247 /* no tap found by name, so try to parse the name as a number */
249 if (parse_uint(s, &n) != ERROR_OK)
252 /* FIXME remove this numeric fallback code late June 2010, along
253 * with all info in the User's Guide that TAPs have numeric IDs.
254 * Also update "scan_chain" output to not display the numbers.
256 t = jtag_tap_by_position(n);
258 LOG_WARNING("Specify TAP '%s' by name, not number %u",
264 struct jtag_tap *jtag_tap_next_enabled(struct jtag_tap *p)
266 p = p ? p->next_tap : jtag_all_taps();
275 const char *jtag_tap_name(const struct jtag_tap *tap)
277 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
281 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
283 struct jtag_event_callback **callbacks_p = &jtag_event_callbacks;
285 if (callback == NULL)
286 return ERROR_COMMAND_SYNTAX_ERROR;
289 while ((*callbacks_p)->next)
290 callbacks_p = &((*callbacks_p)->next);
291 callbacks_p = &((*callbacks_p)->next);
294 (*callbacks_p) = malloc(sizeof(struct jtag_event_callback));
295 (*callbacks_p)->callback = callback;
296 (*callbacks_p)->priv = priv;
297 (*callbacks_p)->next = NULL;
302 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
304 struct jtag_event_callback **p = &jtag_event_callbacks, *temp;
306 if (callback == NULL)
307 return ERROR_COMMAND_SYNTAX_ERROR;
310 if (((*p)->priv != priv) || ((*p)->callback != callback)) {
323 int jtag_call_event_callbacks(enum jtag_event event)
325 struct jtag_event_callback *callback = jtag_event_callbacks;
327 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
330 struct jtag_event_callback *next;
332 /* callback may remove itself */
333 next = callback->next;
334 callback->callback(event, callback->priv);
341 static void jtag_checks(void)
343 assert(jtag_trst == 0);
346 static void jtag_prelude(tap_state_t state)
350 assert(state != TAP_INVALID);
352 cmd_queue_cur_state = state;
355 void jtag_add_ir_scan_noverify(struct jtag_tap *active, const struct scan_field *in_fields,
360 int retval = interface_jtag_add_ir_scan(active, in_fields, state);
361 jtag_set_error(retval);
364 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap *active,
366 const struct scan_field *in_fields,
369 jtag_add_ir_scan_noverify(active, in_fields, state);
372 /* If fields->in_value is filled out, then the captured IR value will be checked */
373 void jtag_add_ir_scan(struct jtag_tap *active, struct scan_field *in_fields, tap_state_t state)
375 assert(state != TAP_RESET);
377 if (jtag_verify && jtag_verify_capture_ir) {
378 /* 8 x 32 bit id's is enough for all invocations */
380 /* if we are to run a verification of the ir scan, we need to get the input back.
381 * We may have to allocate space if the caller didn't ask for the input back.
383 in_fields->check_value = active->expected;
384 in_fields->check_mask = active->expected_mask;
385 jtag_add_scan_check(active, jtag_add_ir_scan_noverify_callback, 1, in_fields,
388 jtag_add_ir_scan_noverify(active, in_fields, state);
391 void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
394 assert(out_bits != NULL);
395 assert(state != TAP_RESET);
399 int retval = interface_jtag_add_plain_ir_scan(
400 num_bits, out_bits, in_bits, state);
401 jtag_set_error(retval);
404 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
405 uint8_t *in_check_mask, int num_bits);
407 static int jtag_check_value_mask_callback(jtag_callback_data_t data0,
408 jtag_callback_data_t data1,
409 jtag_callback_data_t data2,
410 jtag_callback_data_t data3)
412 return jtag_check_value_inner((uint8_t *)data0,
418 static void jtag_add_scan_check(struct jtag_tap *active, void (*jtag_add_scan)(
419 struct jtag_tap *active,
421 const struct scan_field *in_fields,
423 int in_num_fields, struct scan_field *in_fields, tap_state_t state)
425 jtag_add_scan(active, in_num_fields, in_fields, state);
427 for (int i = 0; i < in_num_fields; i++) {
428 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL)) {
429 /* this is synchronous for a minidriver */
430 jtag_add_callback4(jtag_check_value_mask_callback,
431 (jtag_callback_data_t)in_fields[i].in_value,
432 (jtag_callback_data_t)in_fields[i].check_value,
433 (jtag_callback_data_t)in_fields[i].check_mask,
434 (jtag_callback_data_t)in_fields[i].num_bits);
439 void jtag_add_dr_scan_check(struct jtag_tap *active,
441 struct scan_field *in_fields,
445 jtag_add_scan_check(active, jtag_add_dr_scan, in_num_fields, in_fields, state);
447 jtag_add_dr_scan(active, in_num_fields, in_fields, state);
451 void jtag_add_dr_scan(struct jtag_tap *active,
453 const struct scan_field *in_fields,
456 assert(state != TAP_RESET);
461 retval = interface_jtag_add_dr_scan(active, in_num_fields, in_fields, state);
462 jtag_set_error(retval);
465 void jtag_add_plain_dr_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
468 assert(out_bits != NULL);
469 assert(state != TAP_RESET);
474 retval = interface_jtag_add_plain_dr_scan(num_bits, out_bits, in_bits, state);
475 jtag_set_error(retval);
478 void jtag_add_tlr(void)
480 jtag_prelude(TAP_RESET);
481 jtag_set_error(interface_jtag_add_tlr());
483 /* NOTE: order here matches TRST path in jtag_add_reset() */
484 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
485 jtag_notify_event(JTAG_TRST_ASSERTED);
489 * If supported by the underlying adapter, this clocks a raw bit sequence
490 * onto TMS for switching betwen JTAG and SWD modes.
492 * DO NOT use this to bypass the integrity checks and logging provided
493 * by the jtag_add_pathmove() and jtag_add_statemove() calls.
495 * @param nbits How many bits to clock out.
496 * @param seq The bit sequence. The LSB is bit 0 of seq[0].
497 * @param state The JTAG tap state to record on completion. Use
498 * TAP_INVALID to represent being in in SWD mode.
500 * @todo Update naming conventions to stop assuming everything is JTAG.
502 int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state state)
506 if (!(jtag->jtag_ops->supported & DEBUG_CAP_TMS_SEQ))
507 return ERROR_JTAG_NOT_IMPLEMENTED;
510 cmd_queue_cur_state = state;
512 retval = interface_add_tms_seq(nbits, seq, state);
513 jtag_set_error(retval);
517 void jtag_add_pathmove(int num_states, const tap_state_t *path)
519 tap_state_t cur_state = cmd_queue_cur_state;
521 /* the last state has to be a stable state */
522 if (!tap_is_state_stable(path[num_states - 1])) {
523 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
524 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
528 for (int i = 0; i < num_states; i++) {
529 if (path[i] == TAP_RESET) {
530 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
531 jtag_set_error(ERROR_JTAG_STATE_INVALID);
535 if (tap_state_transition(cur_state, true) != path[i] &&
536 tap_state_transition(cur_state, false) != path[i]) {
537 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
538 tap_state_name(cur_state), tap_state_name(path[i]));
539 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
547 jtag_set_error(interface_jtag_add_pathmove(num_states, path));
548 cmd_queue_cur_state = path[num_states - 1];
551 int jtag_add_statemove(tap_state_t goal_state)
553 tap_state_t cur_state = cmd_queue_cur_state;
555 if (goal_state != cur_state) {
556 LOG_DEBUG("cur_state=%s goal_state=%s",
557 tap_state_name(cur_state),
558 tap_state_name(goal_state));
561 /* If goal is RESET, be paranoid and force that that transition
562 * (e.g. five TCK cycles, TMS high). Else trust "cur_state".
564 if (goal_state == TAP_RESET)
566 else if (goal_state == cur_state)
569 else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state)) {
570 unsigned tms_bits = tap_get_tms_path(cur_state, goal_state);
571 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
572 tap_state_t moves[8];
573 assert(tms_count < ARRAY_SIZE(moves));
575 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1) {
576 bool bit = tms_bits & 1;
578 cur_state = tap_state_transition(cur_state, bit);
579 moves[i] = cur_state;
582 jtag_add_pathmove(tms_count, moves);
583 } else if (tap_state_transition(cur_state, true) == goal_state
584 || tap_state_transition(cur_state, false) == goal_state)
585 jtag_add_pathmove(1, &goal_state);
592 void jtag_add_runtest(int num_cycles, tap_state_t state)
595 jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
599 void jtag_add_clocks(int num_cycles)
601 if (!tap_is_state_stable(cmd_queue_cur_state)) {
602 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
603 tap_state_name(cmd_queue_cur_state));
604 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
608 if (num_cycles > 0) {
610 jtag_set_error(interface_jtag_add_clocks(num_cycles));
614 static int adapter_system_reset(int req_srst)
619 if (!(jtag_reset_config & RESET_HAS_SRST)) {
620 LOG_ERROR("BUG: can't assert SRST");
626 /* Maybe change SRST signal state */
627 if (jtag_srst != req_srst) {
628 retval = jtag->reset(0, req_srst);
629 if (retval != ERROR_OK) {
630 LOG_ERROR("SRST error");
633 jtag_srst = req_srst;
636 LOG_DEBUG("SRST line asserted");
637 if (adapter_nsrst_assert_width)
638 jtag_sleep(adapter_nsrst_assert_width * 1000);
640 LOG_DEBUG("SRST line released");
641 if (adapter_nsrst_delay)
642 jtag_sleep(adapter_nsrst_delay * 1000);
649 static void legacy_jtag_add_reset(int req_tlr_or_trst, int req_srst)
651 int trst_with_tlr = 0;
655 /* Without SRST, we must use target-specific JTAG operations
656 * on each target; callers should not be requesting SRST when
657 * that signal doesn't exist.
659 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
660 * can kick in even if the JTAG adapter can't drive TRST.
663 if (!(jtag_reset_config & RESET_HAS_SRST)) {
664 LOG_ERROR("BUG: can't assert SRST");
665 jtag_set_error(ERROR_FAIL);
668 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
669 && !req_tlr_or_trst) {
670 LOG_ERROR("BUG: can't assert only SRST");
671 jtag_set_error(ERROR_FAIL);
677 /* JTAG reset (entry to TAP_RESET state) can always be achieved
678 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
679 * state first. TRST accelerates it, and bypasses those states.
681 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
682 * can kick in even if the JTAG adapter can't drive SRST.
684 if (req_tlr_or_trst) {
685 if (!(jtag_reset_config & RESET_HAS_TRST))
687 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
694 /* Maybe change TRST and/or SRST signal state */
695 if (jtag_srst != new_srst || jtag_trst != new_trst) {
698 retval = interface_jtag_add_reset(new_trst, new_srst);
699 if (retval != ERROR_OK)
700 jtag_set_error(retval);
702 retval = jtag_execute_queue();
704 if (retval != ERROR_OK) {
705 LOG_ERROR("TRST/SRST error");
710 /* SRST resets everything hooked up to that signal */
711 if (jtag_srst != new_srst) {
712 jtag_srst = new_srst;
714 LOG_DEBUG("SRST line asserted");
715 if (adapter_nsrst_assert_width)
716 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
718 LOG_DEBUG("SRST line released");
719 if (adapter_nsrst_delay)
720 jtag_add_sleep(adapter_nsrst_delay * 1000);
724 /* Maybe enter the JTAG TAP_RESET state ...
725 * - using only TMS, TCK, and the JTAG state machine
726 * - or else more directly, using TRST
728 * TAP_RESET should be invisible to non-debug parts of the system.
731 LOG_DEBUG("JTAG reset with TLR instead of TRST");
734 } else if (jtag_trst != new_trst) {
735 jtag_trst = new_trst;
737 LOG_DEBUG("TRST line asserted");
738 tap_set_state(TAP_RESET);
739 if (jtag_ntrst_assert_width)
740 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
742 LOG_DEBUG("TRST line released");
743 if (jtag_ntrst_delay)
744 jtag_add_sleep(jtag_ntrst_delay * 1000);
746 /* We just asserted nTRST, so we're now in TAP_RESET.
747 * Inform possible listeners about this, now that
748 * JTAG instructions and data can be shifted. This
749 * sequence must match jtag_add_tlr().
751 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
752 jtag_notify_event(JTAG_TRST_ASSERTED);
757 /* FIXME: name is misleading; we do not plan to "add" reset into jtag queue */
758 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
761 int trst_with_tlr = 0;
766 legacy_jtag_add_reset(req_tlr_or_trst, req_srst);
770 /* Without SRST, we must use target-specific JTAG operations
771 * on each target; callers should not be requesting SRST when
772 * that signal doesn't exist.
774 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
775 * can kick in even if the JTAG adapter can't drive TRST.
778 if (!(jtag_reset_config & RESET_HAS_SRST)) {
779 LOG_ERROR("BUG: can't assert SRST");
780 jtag_set_error(ERROR_FAIL);
783 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
784 && !req_tlr_or_trst) {
785 LOG_ERROR("BUG: can't assert only SRST");
786 jtag_set_error(ERROR_FAIL);
792 /* JTAG reset (entry to TAP_RESET state) can always be achieved
793 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
794 * state first. TRST accelerates it, and bypasses those states.
796 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
797 * can kick in even if the JTAG adapter can't drive SRST.
799 if (req_tlr_or_trst) {
800 if (!(jtag_reset_config & RESET_HAS_TRST))
802 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
809 /* Maybe change TRST and/or SRST signal state */
810 if (jtag_srst != new_srst || jtag_trst != new_trst) {
811 /* guarantee jtag queue empty before changing reset status */
812 jtag_execute_queue();
814 retval = jtag->reset(new_trst, new_srst);
815 if (retval != ERROR_OK) {
816 jtag_set_error(retval);
817 LOG_ERROR("TRST/SRST error");
822 /* SRST resets everything hooked up to that signal */
823 if (jtag_srst != new_srst) {
824 jtag_srst = new_srst;
826 LOG_DEBUG("SRST line asserted");
827 if (adapter_nsrst_assert_width)
828 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
830 LOG_DEBUG("SRST line released");
831 if (adapter_nsrst_delay)
832 jtag_add_sleep(adapter_nsrst_delay * 1000);
836 /* Maybe enter the JTAG TAP_RESET state ...
837 * - using only TMS, TCK, and the JTAG state machine
838 * - or else more directly, using TRST
840 * TAP_RESET should be invisible to non-debug parts of the system.
843 LOG_DEBUG("JTAG reset with TLR instead of TRST");
845 jtag_execute_queue();
847 } else if (jtag_trst != new_trst) {
848 jtag_trst = new_trst;
850 LOG_DEBUG("TRST line asserted");
851 tap_set_state(TAP_RESET);
852 if (jtag_ntrst_assert_width)
853 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
855 LOG_DEBUG("TRST line released");
856 if (jtag_ntrst_delay)
857 jtag_add_sleep(jtag_ntrst_delay * 1000);
859 /* We just asserted nTRST, so we're now in TAP_RESET.
860 * Inform possible listeners about this, now that
861 * JTAG instructions and data can be shifted. This
862 * sequence must match jtag_add_tlr().
864 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
865 jtag_notify_event(JTAG_TRST_ASSERTED);
870 void jtag_add_sleep(uint32_t us)
872 /** @todo Here, keep_alive() appears to be a layering violation!!! */
874 jtag_set_error(interface_jtag_add_sleep(us));
877 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
878 uint8_t *in_check_mask, int num_bits)
880 int retval = ERROR_OK;
884 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
886 compare_failed = buf_cmp(captured, in_check_value, num_bits);
888 if (compare_failed) {
889 char *captured_str, *in_check_value_str;
890 int bits = (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits;
892 /* NOTE: we've lost diagnostic context here -- 'which tap' */
894 captured_str = buf_to_hex_str(captured, bits);
895 in_check_value_str = buf_to_hex_str(in_check_value, bits);
897 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
899 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
902 free(in_check_value_str);
905 char *in_check_mask_str;
907 in_check_mask_str = buf_to_hex_str(in_check_mask, bits);
908 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
909 free(in_check_mask_str);
912 retval = ERROR_JTAG_QUEUE_FAILED;
917 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask)
919 assert(field->in_value != NULL);
922 /* no checking to do */
926 jtag_execute_queue_noclear();
928 int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
929 jtag_set_error(retval);
932 int default_interface_jtag_execute_queue(void)
935 LOG_ERROR("No JTAG interface configured yet. "
936 "Issue 'init' command in startup scripts "
937 "before communicating with targets.");
941 if (!transport_is_jtag()) {
943 * FIXME: This should not happen!
944 * There could be old code that queues jtag commands with non jtag interfaces so, for
945 * the moment simply highlight it by log an error and return on empty execute_queue.
946 * We should fix it quitting with assert(0) because it is an internal error.
947 * The fix can be applied immediately after next release (v0.11.0 ?)
949 LOG_ERROR("JTAG API jtag_execute_queue() called on non JTAG interface");
950 if (!jtag->jtag_ops || !jtag->jtag_ops->execute_queue)
954 int result = jtag->jtag_ops->execute_queue();
957 /* Only build this if we use a regular driver with a command queue.
958 * Otherwise jtag_command_queue won't be found at compile/link time. Its
959 * definition is in jtag/commands.c, which is only built/linked by
960 * jtag/Makefile.am if MINIDRIVER_DUMMY || !MINIDRIVER, but those variables
961 * aren't accessible here. */
962 struct jtag_command *cmd = jtag_command_queue;
963 while (debug_level >= LOG_LVL_DEBUG_IO && cmd) {
966 LOG_DEBUG_IO("JTAG %s SCAN to %s",
967 cmd->cmd.scan->ir_scan ? "IR" : "DR",
968 tap_state_name(cmd->cmd.scan->end_state));
969 for (int i = 0; i < cmd->cmd.scan->num_fields; i++) {
970 struct scan_field *field = cmd->cmd.scan->fields + i;
971 if (field->out_value) {
972 char *str = buf_to_hex_str(field->out_value, field->num_bits);
973 LOG_DEBUG_IO(" %db out: %s", field->num_bits, str);
976 if (field->in_value) {
977 char *str = buf_to_hex_str(field->in_value, field->num_bits);
978 LOG_DEBUG_IO(" %db in: %s", field->num_bits, str);
984 LOG_DEBUG_IO("JTAG TLR RESET to %s",
985 tap_state_name(cmd->cmd.statemove->end_state));
988 LOG_DEBUG_IO("JTAG RUNTEST %d cycles to %s",
989 cmd->cmd.runtest->num_cycles,
990 tap_state_name(cmd->cmd.runtest->end_state));
994 const char *reset_str[3] = {
995 "leave", "deassert", "assert"
997 LOG_DEBUG_IO("JTAG RESET %s TRST, %s SRST",
998 reset_str[cmd->cmd.reset->trst + 1],
999 reset_str[cmd->cmd.reset->srst + 1]);
1003 LOG_DEBUG_IO("JTAG PATHMOVE (TODO)");
1006 LOG_DEBUG_IO("JTAG SLEEP (TODO)");
1008 case JTAG_STABLECLOCKS:
1009 LOG_DEBUG_IO("JTAG STABLECLOCKS (TODO)");
1012 LOG_DEBUG_IO("JTAG TMS (TODO)");
1015 LOG_ERROR("Unknown JTAG command: %d", cmd->type);
1025 void jtag_execute_queue_noclear(void)
1027 jtag_flush_queue_count++;
1028 jtag_set_error(interface_jtag_execute_queue());
1030 if (jtag_flush_queue_sleep > 0) {
1031 /* For debug purposes it can be useful to test performance
1032 * or behavior when delaying after flushing the queue,
1033 * e.g. to simulate long roundtrip times.
1035 usleep(jtag_flush_queue_sleep * 1000);
1039 int jtag_get_flush_queue_count(void)
1041 return jtag_flush_queue_count;
1044 int jtag_execute_queue(void)
1046 jtag_execute_queue_noclear();
1047 return jtag_error_clear();
1050 static int jtag_reset_callback(enum jtag_event event, void *priv)
1052 struct jtag_tap *tap = priv;
1054 if (event == JTAG_TRST_ASSERTED) {
1055 tap->enabled = !tap->disabled_after_reset;
1057 /* current instruction is either BYPASS or IDCODE */
1058 buf_set_ones(tap->cur_instr, tap->ir_length);
1065 /* sleep at least us microseconds. When we sleep more than 1000ms we
1066 * do an alive sleep, i.e. keep GDB alive. Note that we could starve
1067 * GDB if we slept for <1000ms many times.
1069 void jtag_sleep(uint32_t us)
1074 alive_sleep((us+999)/1000);
1077 #define JTAG_MAX_AUTO_TAPS 20
1079 #define EXTRACT_JEP106_BANK(X) (((X) & 0xf00) >> 8)
1080 #define EXTRACT_JEP106_ID(X) (((X) & 0xfe) >> 1)
1081 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1082 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1083 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1085 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
1086 * know that no valid TAP will have it as an IDCODE value.
1088 #define END_OF_CHAIN_FLAG 0xffffffff
1090 /* a larger IR length than we ever expect to autoprobe */
1091 #define JTAG_IRLEN_MAX 60
1093 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
1095 struct scan_field field = {
1096 .num_bits = num_idcode * 32,
1097 .out_value = idcode_buffer,
1098 .in_value = idcode_buffer,
1101 /* initialize to the end of chain ID value */
1102 for (unsigned i = 0; i < num_idcode; i++)
1103 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
1105 jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, TAP_DRPAUSE);
1107 return jtag_execute_queue();
1110 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
1112 uint8_t zero_check = 0x0;
1113 uint8_t one_check = 0xff;
1115 for (unsigned i = 0; i < count * 4; i++) {
1116 zero_check |= idcodes[i];
1117 one_check &= idcodes[i];
1120 /* if there wasn't a single non-zero bit or if all bits were one,
1121 * the scan is not valid. We wrote a mix of both values; either
1123 * - There's a hardware issue (almost certainly):
1124 * + all-zeroes can mean a target stuck in JTAG reset
1125 * + all-ones tends to mean no target
1126 * - The scan chain is WAY longer than we can handle, *AND* either
1127 * + there are several hundreds of TAPs in bypass, or
1128 * + at least a few dozen TAPs all have an all-ones IDCODE
1130 if (zero_check == 0x00 || one_check == 0xff) {
1131 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
1132 (zero_check == 0x00) ? "zeroes" : "ones");
1133 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
1139 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
1140 const char *name, uint32_t idcode)
1142 log_printf_lf(level, __FILE__, __LINE__, __func__,
1143 "JTAG tap: %s %16.16s: 0x%08x "
1144 "(mfg: 0x%3.3x (%s), part: 0x%4.4x, ver: 0x%1.1x)",
1146 (unsigned int)idcode,
1147 (unsigned int)EXTRACT_MFG(idcode),
1148 jep106_manufacturer(EXTRACT_JEP106_BANK(idcode), EXTRACT_JEP106_ID(idcode)),
1149 (unsigned int)EXTRACT_PART(idcode),
1150 (unsigned int)EXTRACT_VER(idcode));
1153 static bool jtag_idcode_is_final(uint32_t idcode)
1156 * Some devices, such as AVR8, will output all 1's instead
1157 * of TDI input value at end of chain. Allow those values
1158 * instead of failing.
1160 return idcode == END_OF_CHAIN_FLAG;
1164 * This helper checks that remaining bits in the examined chain data are
1165 * all as expected, but a single JTAG device requires only 64 bits to be
1166 * read back correctly. This can help identify and diagnose problems
1167 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1168 * Returns TRUE iff garbage was found.
1170 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
1172 bool triggered = false;
1173 for (; count < max - 31; count += 32) {
1174 uint32_t idcode = buf_get_u32(idcodes, count, 32);
1176 /* do not trigger the warning if the data looks good */
1177 if (jtag_idcode_is_final(idcode))
1179 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1180 count, (unsigned int)idcode);
1186 static bool jtag_examine_chain_match_tap(const struct jtag_tap *tap)
1189 if (tap->expected_ids_cnt == 0 || !tap->hasidcode)
1192 /* optionally ignore the JTAG version field - bits 28-31 of IDCODE */
1193 uint32_t mask = tap->ignore_version ? ~(0xfU << 28) : ~0U;
1194 uint32_t idcode = tap->idcode & mask;
1196 /* Loop over the expected identification codes and test for a match */
1197 for (unsigned ii = 0; ii < tap->expected_ids_cnt; ii++) {
1198 uint32_t expected = tap->expected_ids[ii] & mask;
1200 if (idcode == expected)
1203 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1204 if (0 == tap->expected_ids[ii])
1208 /* If none of the expected ids matched, warn */
1209 jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
1210 tap->dotted_name, tap->idcode);
1211 for (unsigned ii = 0; ii < tap->expected_ids_cnt; ii++) {
1214 snprintf(msg, sizeof(msg), "expected %u of %u", ii + 1, tap->expected_ids_cnt);
1215 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
1216 tap->dotted_name, tap->expected_ids[ii]);
1221 /* Try to examine chain layout according to IEEE 1149.1 §12
1222 * This is called a "blind interrogation" of the scan chain.
1224 static int jtag_examine_chain(void)
1227 unsigned max_taps = jtag_tap_count();
1229 /* Autoprobe up to this many. */
1230 if (max_taps < JTAG_MAX_AUTO_TAPS)
1231 max_taps = JTAG_MAX_AUTO_TAPS;
1233 /* Add room for end-of-chain marker. */
1236 uint8_t *idcode_buffer = calloc(4, max_taps);
1237 if (idcode_buffer == NULL)
1238 return ERROR_JTAG_INIT_FAILED;
1240 /* DR scan to collect BYPASS or IDCODE register contents.
1241 * Then make sure the scan data has both ones and zeroes.
1243 LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1244 retval = jtag_examine_chain_execute(idcode_buffer, max_taps);
1245 if (retval != ERROR_OK)
1247 if (!jtag_examine_chain_check(idcode_buffer, max_taps)) {
1248 retval = ERROR_JTAG_INIT_FAILED;
1252 /* Point at the 1st predefined tap, if any */
1253 struct jtag_tap *tap = jtag_tap_next_enabled(NULL);
1255 unsigned bit_count = 0;
1256 unsigned autocount = 0;
1257 for (unsigned i = 0; i < max_taps; i++) {
1258 assert(bit_count < max_taps * 32);
1259 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1261 /* No predefined TAP? Auto-probe. */
1263 /* Is there another TAP? */
1264 if (jtag_idcode_is_final(idcode))
1267 /* Default everything in this TAP except IR length.
1269 * REVISIT create a jtag_alloc(chip, tap) routine, and
1270 * share it with jim_newtap_cmd().
1272 tap = calloc(1, sizeof(*tap));
1274 retval = ERROR_FAIL;
1278 tap->chip = alloc_printf("auto%u", autocount++);
1279 tap->tapname = strdup("tap");
1280 tap->dotted_name = alloc_printf("%s.%s", tap->chip, tap->tapname);
1282 tap->ir_length = 0; /* ... signifying irlen autoprobe */
1283 tap->ir_capture_mask = 0x03;
1284 tap->ir_capture_value = 0x01;
1286 tap->enabled = true;
1291 if ((idcode & 1) == 0) {
1292 /* Zero for LSB indicates a device in bypass */
1293 LOG_INFO("TAP %s does not have valid IDCODE (idcode=0x%" PRIx32 ")",
1294 tap->dotted_name, idcode);
1295 tap->hasidcode = false;
1300 /* Friendly devices support IDCODE */
1301 tap->hasidcode = true;
1302 tap->idcode = idcode;
1303 jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found", tap->dotted_name, idcode);
1308 /* ensure the TAP ID matches what was expected */
1309 if (!jtag_examine_chain_match_tap(tap))
1310 retval = ERROR_JTAG_INIT_SOFT_FAIL;
1312 tap = jtag_tap_next_enabled(tap);
1315 /* After those IDCODE or BYPASS register values should be
1316 * only the data we fed into the scan chain.
1318 if (jtag_examine_chain_end(idcode_buffer, bit_count, max_taps * 32)) {
1319 LOG_ERROR("double-check your JTAG setup (interface, speed, ...)");
1320 retval = ERROR_JTAG_INIT_FAILED;
1324 /* Return success or, for backwards compatibility if only
1325 * some IDCODE values mismatched, a soft/continuable fault.
1328 free(idcode_buffer);
1333 * Validate the date loaded by entry to the Capture-IR state, to help
1334 * find errors related to scan chain configuration (wrong IR lengths)
1337 * Entry state can be anything. On non-error exit, all TAPs are in
1338 * bypass mode. On error exits, the scan chain is reset.
1340 static int jtag_validate_ircapture(void)
1342 struct jtag_tap *tap;
1343 int total_ir_length = 0;
1344 uint8_t *ir_test = NULL;
1345 struct scan_field field;
1350 /* when autoprobing, accomodate huge IR lengths */
1351 for (tap = NULL, total_ir_length = 0;
1352 (tap = jtag_tap_next_enabled(tap)) != NULL;
1353 total_ir_length += tap->ir_length) {
1354 if (tap->ir_length == 0)
1355 total_ir_length += JTAG_IRLEN_MAX;
1358 /* increase length to add 2 bit sentinel after scan */
1359 total_ir_length += 2;
1361 ir_test = malloc(DIV_ROUND_UP(total_ir_length, 8));
1362 if (ir_test == NULL)
1365 /* after this scan, all TAPs will capture BYPASS instructions */
1366 buf_set_ones(ir_test, total_ir_length);
1368 field.num_bits = total_ir_length;
1369 field.out_value = ir_test;
1370 field.in_value = ir_test;
1372 jtag_add_plain_ir_scan(field.num_bits, field.out_value, field.in_value, TAP_IDLE);
1374 LOG_DEBUG("IR capture validation scan");
1375 retval = jtag_execute_queue();
1376 if (retval != ERROR_OK)
1383 tap = jtag_tap_next_enabled(tap);
1387 /* If we're autoprobing, guess IR lengths. They must be at
1388 * least two bits. Guessing will fail if (a) any TAP does
1389 * not conform to the JTAG spec; or (b) when the upper bits
1390 * captured from some conforming TAP are nonzero. Or if
1391 * (c) an IR length is longer than JTAG_IRLEN_MAX bits,
1392 * an implementation limit, which could someday be raised.
1394 * REVISIT optimization: if there's a *single* TAP we can
1395 * lift restrictions (a) and (b) by scanning a recognizable
1396 * pattern before the all-ones BYPASS. Check for where the
1397 * pattern starts in the result, instead of an 0...01 value.
1399 * REVISIT alternative approach: escape to some tcl code
1400 * which could provide more knowledge, based on IDCODE; and
1401 * only guess when that has no success.
1403 if (tap->ir_length == 0) {
1405 while ((val = buf_get_u64(ir_test, chain_pos, tap->ir_length + 1)) == 1
1406 && tap->ir_length < JTAG_IRLEN_MAX) {
1409 LOG_WARNING("AUTO %s - use \"jtag newtap %s %s -irlen %d "
1410 "-expected-id 0x%08" PRIx32 "\"",
1411 tap->dotted_name, tap->chip, tap->tapname, tap->ir_length, tap->idcode);
1414 /* Validate the two LSBs, which must be 01 per JTAG spec.
1416 * Or ... more bits could be provided by TAP declaration.
1417 * Plus, some taps (notably in i.MX series chips) violate
1418 * this part of the JTAG spec, so their capture mask/value
1419 * attributes might disable this test.
1421 val = buf_get_u64(ir_test, chain_pos, tap->ir_length);
1422 if ((val & tap->ir_capture_mask) != tap->ir_capture_value) {
1423 LOG_ERROR("%s: IR capture error; saw 0x%0*" PRIx64 " not 0x%0*" PRIx32,
1425 (tap->ir_length + 7) / tap->ir_length, val,
1426 (tap->ir_length + 7) / tap->ir_length, tap->ir_capture_value);
1428 retval = ERROR_JTAG_INIT_FAILED;
1431 LOG_DEBUG("%s: IR capture 0x%0*" PRIx64, jtag_tap_name(tap),
1432 (tap->ir_length + 7) / tap->ir_length, val);
1433 chain_pos += tap->ir_length;
1436 /* verify the '11' sentinel we wrote is returned at the end */
1437 val = buf_get_u64(ir_test, chain_pos, 2);
1439 char *cbuf = buf_to_hex_str(ir_test, total_ir_length);
1441 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1444 retval = ERROR_JTAG_INIT_FAILED;
1449 if (retval != ERROR_OK) {
1451 jtag_execute_queue();
1456 void jtag_tap_init(struct jtag_tap *tap)
1458 unsigned ir_len_bits;
1459 unsigned ir_len_bytes;
1461 /* if we're autoprobing, cope with potentially huge ir_length */
1462 ir_len_bits = tap->ir_length ? : JTAG_IRLEN_MAX;
1463 ir_len_bytes = DIV_ROUND_UP(ir_len_bits, 8);
1465 tap->expected = calloc(1, ir_len_bytes);
1466 tap->expected_mask = calloc(1, ir_len_bytes);
1467 tap->cur_instr = malloc(ir_len_bytes);
1469 /** @todo cope better with ir_length bigger than 32 bits */
1470 if (ir_len_bits > 32)
1473 buf_set_u32(tap->expected, 0, ir_len_bits, tap->ir_capture_value);
1474 buf_set_u32(tap->expected_mask, 0, ir_len_bits, tap->ir_capture_mask);
1476 /* TAP will be in bypass mode after jtag_validate_ircapture() */
1478 buf_set_ones(tap->cur_instr, tap->ir_length);
1480 /* register the reset callback for the TAP */
1481 jtag_register_event_callback(&jtag_reset_callback, tap);
1484 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1485 "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1486 tap->abs_chain_position, tap->ir_length,
1487 (unsigned) tap->ir_capture_value,
1488 (unsigned) tap->ir_capture_mask);
1491 void jtag_tap_free(struct jtag_tap *tap)
1493 jtag_unregister_event_callback(&jtag_reset_callback, tap);
1495 struct jtag_tap_event_action *jteap = tap->event_action;
1497 struct jtag_tap_event_action *next = jteap->next;
1498 Jim_DecrRefCount(jteap->interp, jteap->body);
1503 free(tap->expected);
1504 free(tap->expected_mask);
1505 free(tap->expected_ids);
1506 free(tap->cur_instr);
1509 free(tap->dotted_name);
1514 * Do low-level setup like initializing registers, output signals,
1517 int adapter_init(struct command_context *cmd_ctx)
1522 if (!adapter_driver) {
1523 /* nothing was previously specified by "adapter driver" command */
1524 LOG_ERROR("Debug Adapter has to be specified, "
1525 "see \"adapter driver\" command");
1526 return ERROR_JTAG_INVALID_INTERFACE;
1530 retval = adapter_driver->init();
1531 if (retval != ERROR_OK)
1533 jtag = adapter_driver;
1535 if (jtag->speed == NULL) {
1536 LOG_INFO("This adapter doesn't support configurable speed");
1540 if (CLOCK_MODE_UNSELECTED == clock_mode) {
1541 LOG_ERROR("An adapter speed is not selected in the init script."
1542 " Insert a call to \"adapter speed\" or \"jtag_rclk\" to proceed.");
1543 return ERROR_JTAG_INIT_FAILED;
1546 int requested_khz = jtag_get_speed_khz();
1547 int actual_khz = requested_khz;
1548 int jtag_speed_var = 0;
1549 retval = jtag_get_speed(&jtag_speed_var);
1550 if (retval != ERROR_OK)
1552 retval = jtag->speed(jtag_speed_var);
1553 if (retval != ERROR_OK)
1555 retval = jtag_get_speed_readable(&actual_khz);
1556 if (ERROR_OK != retval)
1557 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var);
1558 else if (actual_khz) {
1559 /* Adaptive clocking -- JTAG-specific */
1560 if ((CLOCK_MODE_RCLK == clock_mode)
1561 || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz)) {
1562 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1565 LOG_INFO("clock speed %d kHz", actual_khz);
1567 LOG_INFO("RCLK (adaptive clock speed)");
1572 int jtag_init_inner(struct command_context *cmd_ctx)
1574 struct jtag_tap *tap;
1576 bool issue_setup = true;
1578 LOG_DEBUG("Init JTAG chain");
1580 tap = jtag_tap_next_enabled(NULL);
1582 /* Once JTAG itself is properly set up, and the scan chain
1583 * isn't absurdly large, IDCODE autoprobe should work fine.
1585 * But ... IRLEN autoprobe can fail even on systems which
1586 * are fully conformant to JTAG. Also, JTAG setup can be
1587 * quite finicky on some systems.
1589 * REVISIT: if TAP autoprobe works OK, then in many cases
1590 * we could escape to tcl code and set up targets based on
1591 * the TAP's IDCODE values.
1593 LOG_WARNING("There are no enabled taps. "
1594 "AUTO PROBING MIGHT NOT WORK!!");
1596 /* REVISIT default clock will often be too fast ... */
1600 retval = jtag_execute_queue();
1601 if (retval != ERROR_OK)
1604 /* Examine DR values first. This discovers problems which will
1605 * prevent communication ... hardware issues like TDO stuck, or
1606 * configuring the wrong number of (enabled) TAPs.
1608 retval = jtag_examine_chain();
1611 /* complete success */
1614 /* For backward compatibility reasons, try coping with
1615 * configuration errors involving only ID mismatches.
1616 * We might be able to talk to the devices.
1618 * Also the device might be powered down during startup.
1620 * After OpenOCD starts, we can try to power on the device
1623 LOG_ERROR("Trying to use configured scan chain anyway...");
1624 issue_setup = false;
1628 /* Now look at IR values. Problems here will prevent real
1629 * communication. They mostly mean that the IR length is
1630 * wrong ... or that the IR capture value is wrong. (The
1631 * latter is uncommon, but easily worked around: provide
1632 * ircapture/irmask values during TAP setup.)
1634 retval = jtag_validate_ircapture();
1635 if (retval != ERROR_OK) {
1636 /* The target might be powered down. The user
1637 * can power it up and reset it after firing
1640 issue_setup = false;
1644 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1646 LOG_WARNING("Bypassing JTAG setup events due to errors");
1652 int adapter_quit(void)
1654 if (jtag && jtag->quit) {
1655 /* close the JTAG interface */
1656 int result = jtag->quit();
1657 if (ERROR_OK != result)
1658 LOG_ERROR("failed: %d", result);
1661 struct jtag_tap *t = jtag_all_taps();
1663 struct jtag_tap *n = t->next_tap;
1671 int swd_init_reset(struct command_context *cmd_ctx)
1673 int retval, retval1;
1675 retval = adapter_init(cmd_ctx);
1676 if (retval != ERROR_OK)
1679 LOG_DEBUG("Initializing with hard SRST reset");
1681 if (jtag_reset_config & RESET_HAS_SRST)
1682 retval = adapter_system_reset(1);
1683 retval1 = adapter_system_reset(0);
1685 return (retval == ERROR_OK) ? retval1 : retval;
1688 int jtag_init_reset(struct command_context *cmd_ctx)
1690 int retval = adapter_init(cmd_ctx);
1691 if (retval != ERROR_OK)
1694 LOG_DEBUG("Initializing with hard TRST+SRST reset");
1697 * This procedure is used by default when OpenOCD triggers a reset.
1698 * It's now done through an overridable Tcl "init_reset" wrapper.
1700 * This started out as a more powerful "get JTAG working" reset than
1701 * jtag_init_inner(), applying TRST because some chips won't activate
1702 * JTAG without a TRST cycle (presumed to be async, though some of
1703 * those chips synchronize JTAG activation using TCK).
1705 * But some chips only activate JTAG as part of an SRST cycle; SRST
1706 * got mixed in. So it became a hard reset routine, which got used
1707 * in more places, and which coped with JTAG reset being forced as
1708 * part of SRST (srst_pulls_trst).
1710 * And even more corner cases started to surface: TRST and/or SRST
1711 * assertion timings matter; some chips need other JTAG operations;
1712 * TRST/SRST sequences can need to be different from these, etc.
1714 * Systems should override that wrapper to support system-specific
1715 * requirements that this not-fully-generic code doesn't handle.
1717 * REVISIT once Tcl code can read the reset_config modes, this won't
1718 * need to be a C routine at all...
1720 if (jtag_reset_config & RESET_HAS_SRST) {
1721 jtag_add_reset(1, 1);
1722 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1723 jtag_add_reset(0, 1);
1725 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1728 /* some targets enable us to connect with srst asserted */
1729 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
1730 if (jtag_reset_config & RESET_SRST_NO_GATING)
1731 jtag_add_reset(0, 1);
1733 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1734 jtag_add_reset(0, 0);
1737 jtag_add_reset(0, 0);
1738 retval = jtag_execute_queue();
1739 if (retval != ERROR_OK)
1742 /* Check that we can communication on the JTAG chain + eventually we want to
1743 * be able to perform enumeration only after OpenOCD has started
1744 * telnet and GDB server
1746 * That would allow users to more easily perform any magic they need to before
1749 return jtag_init_inner(cmd_ctx);
1752 int jtag_init(struct command_context *cmd_ctx)
1754 int retval = adapter_init(cmd_ctx);
1755 if (retval != ERROR_OK)
1758 /* guard against oddball hardware: force resets to be inactive */
1759 jtag_add_reset(0, 0);
1761 /* some targets enable us to connect with srst asserted */
1762 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
1763 if (jtag_reset_config & RESET_SRST_NO_GATING)
1764 jtag_add_reset(0, 1);
1766 LOG_WARNING("\'srst_nogate\' reset_config option is required");
1768 retval = jtag_execute_queue();
1769 if (retval != ERROR_OK)
1772 if (Jim_Eval_Named(cmd_ctx->interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1778 unsigned jtag_get_speed_khz(void)
1783 static int adapter_khz_to_speed(unsigned khz, int *speed)
1785 LOG_DEBUG("convert khz to interface specific speed value");
1789 LOG_DEBUG("have interface set up");
1791 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1795 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1796 if (ERROR_OK != retval)
1798 *speed = speed_div1;
1802 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int *speed)
1804 int retval = adapter_khz_to_speed(0, speed);
1805 if ((ERROR_OK != retval) && fallback_speed_khz) {
1806 LOG_DEBUG("trying fallback speed...");
1807 retval = adapter_khz_to_speed(fallback_speed_khz, speed);
1812 static int jtag_set_speed(int speed)
1815 /* this command can be called during CONFIG,
1816 * in which case jtag isn't initialized */
1817 return jtag ? jtag->speed(speed) : ERROR_OK;
1820 int jtag_config_khz(unsigned khz)
1822 LOG_DEBUG("handle jtag khz");
1823 clock_mode = CLOCK_MODE_KHZ;
1825 int retval = adapter_khz_to_speed(khz, &speed);
1826 return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1829 int jtag_config_rclk(unsigned fallback_speed_khz)
1831 LOG_DEBUG("handle jtag rclk");
1832 clock_mode = CLOCK_MODE_RCLK;
1833 rclk_fallback_speed_khz = fallback_speed_khz;
1835 int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1836 return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1839 int jtag_get_speed(int *speed)
1841 switch (clock_mode) {
1842 case CLOCK_MODE_KHZ:
1843 adapter_khz_to_speed(jtag_get_speed_khz(), speed);
1845 case CLOCK_MODE_RCLK:
1846 jtag_rclk_to_speed(rclk_fallback_speed_khz, speed);
1849 LOG_ERROR("BUG: unknown jtag clock mode");
1855 int jtag_get_speed_readable(int *khz)
1857 int jtag_speed_var = 0;
1858 int retval = jtag_get_speed(&jtag_speed_var);
1859 if (retval != ERROR_OK)
1863 if (!jtag->speed_div) {
1864 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1867 return jtag->speed_div(jtag_speed_var, khz);
1870 void jtag_set_verify(bool enable)
1872 jtag_verify = enable;
1875 bool jtag_will_verify(void)
1880 void jtag_set_verify_capture_ir(bool enable)
1882 jtag_verify_capture_ir = enable;
1885 bool jtag_will_verify_capture_ir(void)
1887 return jtag_verify_capture_ir;
1890 int jtag_power_dropout(int *dropout)
1893 /* TODO: as the jtag interface is not valid all
1894 * we can do at the moment is exit OpenOCD */
1895 LOG_ERROR("No Valid JTAG Interface Configured.");
1898 if (jtag->power_dropout)
1899 return jtag->power_dropout(dropout);
1901 *dropout = 0; /* by default we can't detect power dropout */
1905 int jtag_srst_asserted(int *srst_asserted)
1907 if (jtag->srst_asserted)
1908 return jtag->srst_asserted(srst_asserted);
1910 *srst_asserted = 0; /* by default we can't detect srst asserted */
1914 enum reset_types jtag_get_reset_config(void)
1916 return jtag_reset_config;
1918 void jtag_set_reset_config(enum reset_types type)
1920 jtag_reset_config = type;
1923 int jtag_get_trst(void)
1925 return jtag_trst == 1;
1927 int jtag_get_srst(void)
1929 return jtag_srst == 1;
1932 void jtag_set_nsrst_delay(unsigned delay)
1934 adapter_nsrst_delay = delay;
1936 unsigned jtag_get_nsrst_delay(void)
1938 return adapter_nsrst_delay;
1940 void jtag_set_ntrst_delay(unsigned delay)
1942 jtag_ntrst_delay = delay;
1944 unsigned jtag_get_ntrst_delay(void)
1946 return jtag_ntrst_delay;
1950 void jtag_set_nsrst_assert_width(unsigned delay)
1952 adapter_nsrst_assert_width = delay;
1954 unsigned jtag_get_nsrst_assert_width(void)
1956 return adapter_nsrst_assert_width;
1958 void jtag_set_ntrst_assert_width(unsigned delay)
1960 jtag_ntrst_assert_width = delay;
1962 unsigned jtag_get_ntrst_assert_width(void)
1964 return jtag_ntrst_assert_width;
1967 static int jtag_select(struct command_context *ctx)
1971 /* NOTE: interface init must already have been done.
1972 * That works with only C code ... no Tcl glue required.
1975 retval = jtag_register_commands(ctx);
1977 if (retval != ERROR_OK)
1980 retval = svf_register_commands(ctx);
1982 if (retval != ERROR_OK)
1985 return xsvf_register_commands(ctx);
1988 static struct transport jtag_transport = {
1990 .select = jtag_select,
1994 static void jtag_constructor(void) __attribute__((constructor));
1995 static void jtag_constructor(void)
1997 transport_register(&jtag_transport);
2000 /** Returns true if the current debug session
2001 * is using JTAG as its transport.
2003 bool transport_is_jtag(void)
2005 return get_current_transport() == &jtag_transport;
2008 int adapter_resets(int trst, int srst)
2010 if (get_current_transport() == NULL) {
2011 LOG_ERROR("transport is not selected");
2015 if (transport_is_jtag()) {
2016 if (srst == SRST_ASSERT && !(jtag_reset_config & RESET_HAS_SRST)) {
2017 LOG_ERROR("adapter has no srst signal");
2021 /* adapters without trst signal will eventually use tlr sequence */
2022 jtag_add_reset(trst, srst);
2024 * The jtag queue is still used for reset by some adapter. Flush it!
2025 * FIXME: To be removed when all adapter drivers will be updated!
2027 jtag_execute_queue();
2029 } else if (transport_is_swd() || transport_is_hla() ||
2030 transport_is_dapdirect_swd() || transport_is_dapdirect_jtag() ||
2031 transport_is_swim()) {
2032 if (trst == TRST_ASSERT) {
2033 LOG_ERROR("transport %s has no trst signal",
2034 get_current_transport()->name);
2038 if (srst == SRST_ASSERT && !(jtag_reset_config & RESET_HAS_SRST)) {
2039 LOG_ERROR("adapter has no srst signal");
2042 adapter_system_reset(srst);
2046 if (trst == TRST_DEASSERT && srst == SRST_DEASSERT)
2049 LOG_ERROR("reset is not supported on transport %s",
2050 get_current_transport()->name);
2055 int adapter_assert_reset(void)
2057 if (transport_is_jtag()) {
2058 if (jtag_reset_config & RESET_SRST_PULLS_TRST)
2059 jtag_add_reset(1, 1);
2061 jtag_add_reset(0, 1);
2063 } else if (transport_is_swd() || transport_is_hla() ||
2064 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2065 transport_is_swim())
2066 return adapter_system_reset(1);
2067 else if (get_current_transport() != NULL)
2068 LOG_ERROR("reset is not supported on %s",
2069 get_current_transport()->name);
2071 LOG_ERROR("transport is not selected");
2075 int adapter_deassert_reset(void)
2077 if (transport_is_jtag()) {
2078 jtag_add_reset(0, 0);
2080 } else if (transport_is_swd() || transport_is_hla() ||
2081 transport_is_dapdirect_jtag() || transport_is_dapdirect_swd() ||
2082 transport_is_swim())
2083 return adapter_system_reset(0);
2084 else if (get_current_transport() != NULL)
2085 LOG_ERROR("reset is not supported on %s",
2086 get_current_transport()->name);
2088 LOG_ERROR("transport is not selected");
2092 int adapter_config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
2093 uint32_t port_size, unsigned int *trace_freq,
2094 unsigned int traceclkin_freq, uint16_t *prescaler)
2096 if (jtag->config_trace) {
2097 return jtag->config_trace(enabled, pin_protocol, port_size, trace_freq,
2098 traceclkin_freq, prescaler);
2099 } else if (enabled) {
2100 LOG_ERROR("The selected interface does not support tracing");
2107 int adapter_poll_trace(uint8_t *buf, size_t *size)
2109 if (jtag->poll_trace)
2110 return jtag->poll_trace(buf, size);